Cancel Subscription

Cancels a subscription immediately. The buyer is not charged again.

The status becomes CANCELLED and the subscription-status-changed webhook event
(/reference/subscription-status-changed) is sent. Nothing is refunded; refund past billing cycles with Refund
Checkout Transaction on the cycle's checkout. Buyers can also cancel their own subscriptions from the buyer portal.

A subscription still in CREATING is cancelled by expiring the buyer's sign-up checkout. If that checkout is being
charged at that moment, the cancellation fails; read the subscription again and retry once it has left CREATING.

Permission: Merchant User Config.

Errors

  • 404 NOT_FOUND: the subscription does not exist.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The subscription ID (R-…).

Responses
204

The operation succeeded. The response has no body.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json