Cancel order lines

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

Cancel one or more order lines that were previously authorized. To cancel the entire order, please refer to the Cancel order endpoint instead.

Canceling or partially canceling an order line will immediately release the authorization held for that amount. You should cancel an order line if you do not intend to (fully) ship it.

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

For an order line with status shipping, the authorization for the quantity that is still pending will be released.

Afterwards, the order line will be marked completed.

If the order line is paid or already completed, you can create a refund using the Create order refund endpoint 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.

Body Params
lines
array of objects
required
lines*
boolean | null

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode 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