Release Billing Hold
POST/api/sales-orders/:salesOrder/release-billing-hold
Releases an order held by its payment term's release gate ("Release anyway"). Orders whose payment term requires payment before release sit in Reserved with billing_hold_status: "pending" until the gate is met (paid in full, a percentage paid, or the scheduled pre-release payments received) — at which point they release themselves. This endpoint releases the hold early with a required reason: it records the releasing user, timestamp and reason (billing_hold_released_at, billing_hold_release_reason) and opens the order for fulfillment unless another hold (credit, payment-pending or sales channel tag) still parks it, in which case the order stays reserved and the response message says so. A manually released order is not re-held by later refunds.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token with the orders scope (write).
Request body:
- reason (required, string, max 255): why the hold is being released.
Path parameters:
- salesOrder (required): Sales order ID.
Errors:
- 400 when the order is not currently held by its payment term.
- 422 when
reasonis missing or longer than 255 characters.
Requires permission: sales_orders.release_billing_hold
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Bad Request
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.