Skip to main content
Schema2020-08-27object

subscription_schedule

A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: [Subscription Schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

SubscriptionSchedulesResourceDefaultSettings

object
application_fee_percent number
optionalnullable

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule.

billing_cycle_anchor string
required

Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).

billing_thresholds
optionalnullable

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

collection_method string
optionalnullable

Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.

default_payment_method
optionalnullable

ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

invoice_settings
optionalnullable

The subscription schedule's default invoice settings.

transfer_data
optionalnullable

The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.