prepare_subscription_cancellation
This tool does not cancel the subscription. Cancellation happens only in the Checkout Page dashboard. The tool fetches the subscription, works out whether it can be canceled and what canceling changes, and returns the dashboard URL where a person performs the cancellation.
Returns:
The full subscription record (status, customer, amount, interval, current period dates).
guidance.eligible- whether cancellation can proceed (false for already-canceled or expired subscriptions).guidance.options.timing- available timing choices (immediately,at_period_end,custom_date). Fixed-term plans (planIterations > 0) only supportimmediately.guidance.options.currentPeriodEnd- the end of the current billing period, useful when choosingat_period_end.guidance.sideEffects- plain-language consequences of canceling (the Stripe subscription ends and no further invoices generate; whether a cancellation is already scheduled).
Use list_subscriptions first to find a subscription ID, or get_subscription to view the full record without the cancellation guidance overlay.
Example uses:
"I want to cancel this customer's subscription - what should I know first?"
"Can subscription 6812fe6e9f39b6760576f01c still be canceled at the end of the period?"
"What changes if I cancel this subscription now?"
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subscriptionId | Yes | The ID of the subscription you intend to cancel. This tool returns eligibility, side effects, and a dashboard link — it does NOT perform the cancellation. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| guidance | Yes |