Skip to main content
POST
Cancel a checkout

Authorizations

X-Suby-Api-Key
string
header
required

API key authentication

Path Parameters

paymentId
string
required

Body

application/json
reason
string

Optional. Stored on the payment and returned on subsequent reads.

Maximum string length: 500
Example:

"Replaced by a checkout with an updated prorated discount"

Response

Checkout canceled

success
boolean
Example:

true

data
object