provider POST /v1/subscription_schedules
@utdk/stripe /v1/subscription_schedules
Create a schedule
<p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p>

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.

postsubscriptionschedules
POST/v1/subscription_schedules
<p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p>

Input

Controls how prorations and invoices for subscriptions are calculated and orchestrated.

The identifier of the customer to create the subscription schedule for.

The identifier of the account to create the subscription schedule for.

Object representing the subscription schedule's default settings.

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.

Specifies which fields in the response should be expanded.

Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.

Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.

When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.

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.postsubscriptionschedules()