Cancel a pending payment
Request cancellation of a payment that is still pending — for example to abort an in-progress checkout before it completes.
Only payments with status PENDING are eligible; any other status (including PAID, FAILED, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, UNPAID, and EXPIRED) returns an error. Currently only Stripe-processed payments are supported — PayPal payments and subscription plan-change payments cannot be cancelled through this endpoint.
This only requests cancellation from the payment processor; it does not mark the payment as cancelled immediately. The payment’s status updates to CANCELLED once the processor confirms the cancellation asynchronously.
Path Parameters
Unique identifier (UUID) of the payment.
Body
PATCH /v0/payments/:paymentId/cancel Request body
The body is of type object.