Skip to main content
POST
POST
Sets the subscription to cancel at the end of the current billing period. The organisation retains full access until the period ends. This action does not immediately terminate the subscription.
After cancellation is scheduled, status in subscription details will show cancel_at_period_end: true. Users can re-subscribe before the period ends to reverse the cancellation.

​
Response

​
boolean
true when the cancellation has been scheduled.
​
string
ISO 8601 timestamp of when the subscription will be canceled.

Authorizations

​
Authorization
string
header
required

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

Response

200

Subscription will cancel at period end