Create Schedule
Creates a multi-phase subscription schedule for a customer. The first phase starts immediately and subsequent phases automatically transition at their scheduled start times.
Use this endpoint to schedule future plan changes (e.g. switch from a trial plan to a paid plan on a specific date) or to define a sequence of plans that should activate over time.
Body Parameters
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
The ID of the customer to create the schedule for.
Ordered phase definitions for the schedule.
Optional entity ID for an entity-scoped schedule.
Free trial configuration applied to every plan in the immediate phase.
Three-letter Stripe-supported currency code used to bill the immediate phase (for example, 'usd').
3Invoice mode creates and sends an invoice instead of charging the customer's payment method immediately for the first phase.
List of discounts to apply to the immediate phase. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.
URL to redirect to after successful checkout.
Additional parameters to pass into the creation of the Stripe checkout session.
Controls when to return a checkout URL for the immediate phase. 'always' forces a confirmation or checkout flow, 'if_required' only redirects when needed, and 'never' disables redirects.
always, if_required, never Whether to prorate the immediate phase. 'none' skips proration charges and credits.
prorate_immediately, none Pass 'now' to reset the billing cycle anchor of the immediate phase to the current time.
If true, the immediate-phase cusProducts are activated immediately (and scheduled-phase cusProducts pre-inserted) even when payment is pending via Stripe checkout. The Autumn schedule rows are persisted on checkout.session.completed.
If true, active recurring add-ons in scopes represented by the phase plans are retained.
Response
OK
The ID of the customer.
The entity ID for the schedule, or null when customer-level.
Whether the schedule is fully created or waiting for payment or confirmation to complete.
created, pending_payment The ID of the created schedule. Null when the schedule is waiting on Autumn checkout confirmation.
Persisted phases in ascending starts_at order. Empty when waiting on Autumn checkout confirmation.
URL to redirect the customer to complete payment. Null if no payment action is required.
Invoice details if an invoice was created. Only present when a charge was made.