API reference Checkout sessions Cancel a checkout session

Cancel a checkout session

POST methodhttps://api.anyshop.io/v1/checkout_sessions/{id}/cancel

The payment waiting on the buyer is cancelled and the keys go back to stock. A paid session cannot be cancelled: refund its order.

Scope checkouts:write
Idempotent with Idempotency-Key
403 store_suspended while suspended

Path parameters

idstring required

Headers

Idempotency-Keystring Up to 255 characters. A retry with the same key and request gets the first answer, without running twice (24 hours).

Example

as_live_ or as_test_

curl -X POST \
  https://api.anyshop.io/v1/checkout_sessions/id_example/cancel \
  -H "Authorization: Bearer $ANYSHOP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "object": "checkout_session",
  "id": "",
  "livemode": false,
  "status": "open",
  "url": "",
  "expires_at": "2026-10-02T14:21:07.000Z",
  "amount": 0,
  "currency": "",
  "payment_method": null,
  "order": null,
  "success_url": "",
  "cancel_url": "",
  "metadata": {},
  "created_at": "2026-10-02T14:21:07.000Z"
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

The checkout_session object.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After