Adds support for scheduling Subscription cancellation as part of pending update

What’s new

You can now cancel a Subscription at the end of a billing period as part of a pending update that applies when payment on an Invoice succeeds.

The cancel_at_period_end property is a nullable Boolean added to pending_update for a Subscription. It indicates whether the subscription will cancel at the end of the current billing period when the pending update applies.

Impact

You can now pass cancel_at_period_end when you update a subscription with payment_behavior set to pending_if_incomplete. This combination previously returned an error. If a subsequent update includes a conflicting cancel_at_period_end value, Stripe expires the existing pending update.

If the payment fails or requires customer action, Stripe stores the setting in the pending_update hash. After successfully applying the update, Stripe cancels the subscription after the period ends.

Changes

Upgrade