Skip to main content
POST
This endpoint cancels a subscription. You can choose to cancel immediately or at the end of the current billing period.

Authentication

This endpoint requires a valid API key with subscriptions:write permissions.

Path Parameters

id
string
required
The unique identifier of the subscription to cancel

Request Body

cancel_at_period_end
boolean
If true, cancel at end of current period. If false, cancel immediately (default: true)
reason
string
Cancellation reason: “too_expensive”, “missing_features”, “not_using”, “switching_provider”, “other”
feedback
string
Additional feedback about cancellation
cancel_immediately
boolean
Override to cancel immediately regardless of period

Response

Returns the cancelled subscription object.