Cancel a checkout
Invalidates a checkout that has not settled yet. The payment moves to CANCELED, the payment link
stops loading, and no further attempt can revive it — so a superseded checkout can never be paid
alongside its replacement.
Only payments in INITIATED or PENDING can be canceled. PROCESSING is refused (a worker is
settling it), as is anything already settled, refunded or charged back — use
POST /api/refund/{paymentId} for those.
The call is idempotent: cancelling an already-canceled payment returns 200 with the original
canceledAt.
Card checkouts already handed off to the payment provider (status
PENDING) keep a live session upstream. If the buyer completes it after you cancel, Suby refuses to credit the payment and it staysCANCELED— the charge then has to be refunded on the provider side. Cancel as early as possible, ideally while the checkout is stillINITIATED.
Emits a CHECKOUT_CANCELED webhook.
Authorizations
API key authentication
Path Parameters
Body
Optional. Stored on the payment and returned on subsequent reads.
500"Replaced by a checkout with an updated prorated discount"

