provider POST /v1/subscription_schedules/{schedule}/cancel
@utdk/stripe /v1/subscription_schedules/{schedule}/cancel
Cancel a schedule
<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>
schedule path required
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postsubscriptionschedulesschedulecancel
POST/v1/subscription_schedules/{schedule}/cancel
<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>

Parameters

required

Input

Specifies which fields in the response should be expanded.

If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.

If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postsubscriptionschedulesschedulecancel()