Skip to main content
POST
Cancel subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
immediate
boolean
default:false

If true, revokes immediately; otherwise cancels at period end.

reason
string

Response

200 - application/json

Subscription cancelled or scheduled for cancellation

ok
boolean
Example:

true

cancelled
boolean
Example:

true

status
string
Example:

"ACTIVE"

cancelAtPeriodEnd
boolean
Example:

true

currentPeriodEnd
string<date-time>
Last modified on September 19, 2026