Cancel order

⚠️ We no longer recommend using the Orders API. Please refer to the Payments API instead.

An open order may be canceled if it does not have any open payments yet, and while its status is either created, authorized, or shipping.

If the order was already authorized, the authorization will be released.

For an order with status shipping, only the order lines that were still pending will be canceled if possible. If a payment method was used that does not support authorizations, cancelation is no longer possible. You will have to issue a refund instead.

Access with

API key

Organization access token with orders.write

OAuth access with orders.write

Path Params
string
required

Provide the ID of the related order.

Query Params
boolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Responses

Language
Credentials
Request
Response
Choose an example:
application/hal+json