Skip to main content
Manja / Stripe
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

SubscriptionSchedule

object

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

canceled_at integer (unix-time)
optionalnullable

Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

completed_at integer (unix-time)
optionalnullable

Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

current_phase
optionalnullable

Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.

customer
required

ID of the customer who owns the subscription schedule.

end_behavior string
required

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.

Allowed: "cancel""none""release""renew"

id string
required

Unique identifier for the object.

maxLength:5000

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata object
optionalnullable

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

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "subscription_schedule"

phases array
required

Configuration for the subscription schedule's phases.

released_at integer (unix-time)
optionalnullable

Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

released_subscription string
optionalnullable

ID of the subscription once managed by the subscription schedule (if it is released).

maxLength:5000

status string
required

The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).

Allowed: "active""canceled""completed""not_started""released"

subscription
optionalnullable

ID of the subscription managed by the subscription schedule.