StripeKit - Cancel Subscription

`kit.subscriptions.cancel()`

Cancels a subscription, either immediately or at the end of the current billing period.

Signature

Parameters

Field	Type	Required	Description
`subscriptionId`	`string`	Yes	The subscription to cancel.
`atPeriodEnd`	`boolean`	No, defaults to `false`	If `true`, the subscription keeps running until the current period ends, then cancels (`cancel_at_period_end`). If `false`, it is cancelled immediately.
`cancellationReason`	`string`	No	Stored as a comment on Stripe's cancellation details.

Example request — cancel at period end

Example response

Note status stays 'active' and canceledAtUtc stays null when cancelling at period end, only cancelAtPeriodEnd flips to true. If atPeriodEnd is false instead, status becomes 'canceled' immediately and canceledAtUtc is set.

Errors

Exception	When
`StripeOperationError`	The subscription ID does not exist, or is already cancelled.

Notes

If a storage adapter is configured, the record is persisted via saveSubscription() immediately.

To undo a scheduled atPeriodEnd cancellation before the period actually ends, use resume().

Cancel

kit.subscriptions.cancel()#

Signature#

Parameters#

Example request — cancel at period end#

Example response#

Errors#