Cancel a subscription. The subscription will stop generating new invoices and will not renew.
Path Parameters
| Parameter | Type | Required | Description |
|---|
| id | string | Yes | The rootfi_id or platform_id of the subscription |
Query Parameters
| Parameter | Type | Required | Description |
|---|
| cancel_at_period_end | boolean | No | If true, cancels at end of current period (default: true) |
| prorate | boolean | No | If true, issues prorated credit for unused time |
Behavior
- Immediate cancellation: Subscription ends immediately, may generate prorated credit
- End of period: Subscription remains active until current billing period ends
Cancelling a subscription does not automatically refund previous payments. Use the Transactions API to process refunds if needed.
