Cancel a subscription (now, or at the end of the current period)
cancel_subscriptionCancel a subscription immediately or schedule cancellation at the end of the current billing period by setting at_period_end to true.
Instructions
Cancel a subscription (now, or at the end of the current period).
Cancel a subscription now, or at the end of the current period with at_period_end: true. Canceling an already canceled subscription returns 409 subscription_canceled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The subscription id (`sbs_…`). | |
| reason | No | ||
| at_period_end | No | Cancel when the current period ends instead of now |