POST
https://api.nue.io/cpq/orders/{orderId}:cancel
Cancels an activated order, unwinding its subscriptions, assets and entitlements to their previous version and reversing their daily and monthly ARR records.
This is irreversible. A canceled order cannot be reactivated.
Key behaviors:
- Only Activated orders can be canceled. A Draft order has provisioned nothing — delete it instead
- The
CancelOrder permission and the bundle-child dependency check are enforced server-side
- An order with dependent orders, a split order, or one with superseding changes is refused with 400
- Salesforce-origin orders only
- Takes no request body and returns no content on success
- A 504 means the outcome could not be confirmed, not that the cancel failed — read the order's status before retrying
To check eligibility first, call POST /orders/cancelable on the order service; note it reports only that no active invoice blocks the order, and does not check order status or dependent orders.
Apex equivalent: Ruby.GlobalOrderService.cancelActiveOrders(List<Id> orderIds).
orderIdstringThe id of the activated order to cancel.
acceptstringGenerated from available response content types
200The order was canceled. No response body.
400<p>Business refusal — the order has dependent orders, is already canceled, was never activated, or the caller lacks the CancelOrder permission.</p>
409Cancel via Apex is not enabled for this tenant.
504<p>The cancel outcome could not be confirmed. The order may or may not have been canceled — read its status before retrying.</p>
curl --request POST \
--url https://api.nue.io/cpq/orders/{orderId}:cancel \
--header 'accept: application/json'