subscriptions_cancel - Charter Docs

DELETE

stripe_subscriptions_cancel.py

import asyncio

from charter.packs import stripe

result = asyncio.run(stripe.subscriptions_cancel.ainvoke({"subscription": ...}))

With stripe.RESTRICTED_KEY, requires subscription_write.

Path parameters

Field	Type	Description
`subscription` *	`string`	The ID of the subscription to cancel.

Field	Type	Description
`invoiceNow`	`boolean`	Whether to invoice now for un-invoiced metered usage and pending proration items. Absent, Stripe does not.
`prorate`	`boolean`	Whether to credit the unused time remaining in the period. Absent, Stripe does not.
`cancellationDetails`	CancellationDetails	Why the subscription was cancelled.