Cancel a subscription
shop.subscription.cancelCancel a paid subscription by ID; access continues until the current period ends, and no further renewal quotes are issued. Idempotent.
Instructions
Cancel a subscription you pay for. The period already paid runs to current_period_end (access_until); no further renewal quotes are issued. Idempotent. Another identity's subscription is 404.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | ||
| subscription_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sku | Yes | ||
| status | Yes | ||
| period_no | Yes | ||
| pull_mode | Yes | ||
| canceled_at | No | ||
| max_periods | Yes | ||
| renewal_key | No | ||
| access_until | No | ||
| status_reason | Yes | ||
| next_charge_at | Yes | ||
| subscription_id | Yes | ||
| current_period_end | Yes | ||
| preauthorized_periods | No |