Skip to main content
POST
Cancel a subscription at period end
Authenticate with an API key that belongs to the target organization and has Full access or the sales:subscriptions:write permission.
  • Cancels at the end of the current billing period. The buyer keeps access until currentPeriodEnd, and cancelAtPeriodEnd becomes true.
  • Anyway emails the buyer the cancellation confirmation and sends the usual subscription Webhook. You do not need to send anything.
  • Safe to retry: calling it again on a subscription already set to cancel returns 200 with the same body.
  • The response is the same subscription object as Get a subscription record.

Authorizations

X-API-Key
string
header
required

Merchant API key (format: ak_BASE64)

Path Parameters

id
string
required

Subscription ID

Response

OK

data
object
error
object
message
string
success
boolean