Change whether this order may ship before it is paid

PUT /orders/{orderId}/payment-terms

Change whether this order may ship before it is paid — a person's credit decision on one order: on-account lets its parcels leave unpaid (a trusted customer's bank transfer, terms agreed by phone), prepaid holds them until the order is paid in full.

Every order settles its terms when it is created — what its creator said, else on account for a company on trade terms, else the organization's default — and paymentTermsBy says which; after a change it reads changed. Releasing a held order lets its parcels go: when shipping is automatic every packed parcel ships in the same transaction (fulfillment.dispatched × lines and fulfillment.shipment-shipped, plus fulfillment.invoice-issued when invoicing is), commanding the inventory service as a ship does. A cancelled order is 409 OrderNotOpen. Appends fulfillment.payment-terms-changed. Idempotent by content: a retry, or any request for the terms the order already has, appends nothing.

Access

Requires payments:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: a retry, or any request for the terms the order already has, appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.dispatched(only when that step is automatic)
fulfillment.shipment-shipped(only when that step is automatic)
fulfillment.invoice-issued(only when that step is automatic)
fulfillment.payment-terms-changed

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_set_payment_terms (Fulfillment: Set payment terms), in the fulfillment toolset.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://fulfillment.getmanifold.io/orders/ord_01a158e0-8b90-7ca1-9db2-1b2c3d4e5f60/payment-terms' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "paymentTerms": "prepaid"
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/orders/ord_01a158e0-8b90-7ca1-9db2-1b2c3d4e5f60/payment-terms", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "paymentTerms": "prepaid"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "paymentTerms": "prepaid"
}

Response · 200 · application/json

{
  "id": "ord_01a158e0-8b90-7ca1-9db2-1b2c3d4e5f60",
  "reference": "PO-7795",
  "source": {
    "kind": "api"
  },
  "customer": {
    "companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
    "shippingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
    "billingAddressId": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e"
  },
  "party": {
    "companyId": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
    "name": "Harbour Ceramics Pty Ltd",
    "paymentTermsDays": 30,
    "shipTo": {
      "id": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
      "label": "Fremantle warehouse",
      "address": {
        "firstName": "Receiving",
        "lastName": "Dock",
        "company": "Harbour Ceramics",
        "address1": "14 Kiln Street",
        "city": "Fremantle",
        "province": "Western Australia",
        "provinceCode": "WA",
        "country": "Australia",
        "countryCode": "AU",
        "zip": "6160"
      }
    },
    "billTo": {
      "id": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
      "label": "Fremantle warehouse",
      "address": {
        "company": "Harbour Ceramics Pty Ltd",
        "address1": "PO Box 412",
        "city": "Fremantle",
        "provinceCode": "WA",
        "countryCode": "AU",
        "zip": "6959"
      }
    }
  },
  "catalogIds": [
    "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
  ],
  "currency": "AUD",
  "fx": {
    "currency": "AUD",
    "home": "AUD",
    "rate": 1,
    "rateDate": "2026-10-20",
    "source": "same"
  },
  "convention": "exclusive",
  "shippingTaxBasis": {
    "_tag": "calculated",
    "treatment": "domestic",
    "country": "AU",
    "class": "follows-goods",
    "rateBps": 1000
  },
  "number": "SO-01043",
  "serial": 1043,
  "status": "open",
  "lines": [
    {
      "id": "lin_01a158e0-8b90-7ca1-9db2-2c3d4e5f6071",
      "sku": "MUG-SPECKLE",
      "name": "Speckled stoneware mug",
      "ordered": 6,
      "removed": false,
      "catalogId": "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e",
      "discountCents": 0,
      "allocated": 6,
      "picked": 0,
      "packed": 0,
      "dispatched": 0,
      "invoiced": 0,
      "returned": 0,
      "unitPriceCents": 2400,
      "listPriceCents": 2400,
      "inclusive": false,
      "taxBasis": {
        "_tag": "calculated",
        "treatment": "domestic",
        "country": "AU",
        "parts": [
          {
            "class": "standard",
            "rateBps": 1000,
            "weight": 1
          }
        ]
      },
      "orderDiscountCents": 0,
      "tax": {
        "inclusive": false,
        "amountCents": 14400,
        "entries": [
          {
            "class": "standard",
            "treatment": "domestic",
            "country": "AU",
            "rateBps": 1000,
            "netCents": 14400,
            "taxCents": 1440,
            "source": "manifold"
          }
        ],
        "netCents": 14400,
        "taxCents": 1440,
        "grossCents": 15840
      }
    }
  ],
  "workflow": {
    "paymentTerms": "prepaid",
    "pick": "manual",
    "pack": "manual",
    "ship": "manual",
    "invoice": "manual",
    "shortfall": "wait",
    "allocation": "single-site-preferred",
    "routing": {
      "order": "rank",
      "decider": "manifold",
      "priority": []
    },
    "routingByCatalog": {}
  },
  "paymentTermsBy": "changed",
  "createdSequence": 4131,
  "shipments": [
    {
      "id": "shp_01a158e0-8b90-7ca1-9db2-4e5f60718293",
      "number": "SH-01060",
      "reference": "auto:ord_01a158e0-8b90-7ca1-9db2-1b2c3d4e5f60:1",
      "status": "pending",
      "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
      "lines": [
        {
          "lineId": "lin_01a158e0-8b90-7ca1-9db2-2c3d4e5f6071",
          "sku": "MUG-SPECKLE",
          "quantity": 6
        }
      ],
      "cartons": [],
      "createdAt": "2026-10-20T05:10:03.447Z",
      "updatedAt": "2026-10-20T05:10:03.447Z"
    }
  ],
  "invoices": [],
  "refunds": [],
  "payments": [],
  "notes": [],
  "edits": [],
  "consignments": [],
  "money": {
    "subtotalCents": 14400,
    "charges": {
      "shippingCents": 0,
      "shippingDiscountCents": 0,
      "discountCents": 0
    },
    "discountCents": 0,
    "tax": {
      "netCents": 14400,
      "taxCents": 1440,
      "grossCents": 15840,
      "breakdown": [
        {
          "class": "standard",
          "treatment": "domestic",
          "country": "AU",
          "rateBps": 1000,
          "exempt": false,
          "taxableCents": 14400,
          "taxCents": 1440
        }
      ]
    },
    "totalCents": 15840,
    "paidCents": 0,
    "refundedCents": 0,
    "balanceCents": 15840,
    "refundOwedCents": 0,
    "status": "unpaid"
  },
  "discounts": [],
  "shortfalls": [],
  "createdAt": "2026-10-20T05:10:03.447Z",
  "updatedAt": "2026-10-20T05:14:22.019Z"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: fulfillment-manager.openapi.json. Base URL https://fulfillment.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`404`

Refusal	What it means	What to do
`FulfillmentOrderNotFound` orderId	No such record in this organization.	Check the id in the path or the body.
`ItemNotFound` sku	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`OrderNotOpen` orderId, status	The order is cancelled, closed or still a quote, so it takes no more of this. `status` says which.	Read the order before doing anything else.
`InsufficientStock` sku, available, requested, locationId	Fewer units are free than the call needs. `available` and `requested` say how many.	Receive or move stock in first, or ask for fewer.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`422`

Refusal	What it means	What to do
`MissingUnitPrice` orderId, lineId, sku	A line on the order has no sales price. `lineId` names it. Orders made today always carry one.	Nothing in this request can fix it: contact Manifold support about the order.

`502`

Refusal	What it means	What to do
`InventoryUnavailable` reason	The inventory service did not answer, so nothing changed.	Send the same request again shortly.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.