SubscriptionScheduleListResponse

Paginated list of subscription schedules.

items
Type: array object[] · SubscriptionSchedule[]
required
A subscription schedule manages the lifecycle of a subscription through a series of phases, allowing you to configure billing changes at specific future dates.
- created
  Type: stringFormat: date-time
  required
  
  Time at which the schedule was created.
- current_phase_index
  Type: integer
  required
  
  Zero-based index of the currently active phase.
- customer
  Type: string
  required
  
  ID of the customer this schedule belongs to.
- end_behavior
  Type: stringenum
  required
  
  What happens when the last phase ends:
  
  RELEASE — schedule becomes RELEASED; the subscription continues billing on its own cadence
  
  CANCEL — the subscription is immediately canceled; schedule becomes COMPLETED
  
  NONE — no action taken; schedule remains active
  
  values
  RELEASE
  CANCEL
  NONE
- id
  Type: string
  required
  
  Unique identifier for the subscription schedule (ULID).
- livemode
  Type: boolean
  required
  
  Whether this schedule exists in live mode (true) or test mode (false).
- phases
  Type: array object[] · SchedulePhase[] 1…20
  required
  
  Ordered list of schedule phases. Applied sequentially by the workflow. The first phase's start_date determines when the subscription is created.
  
  A single phase in a subscription schedule. Phases are applied sequentially. When a phase is applied, subscription items are updated to match the phase's items.
- start_date
  Type: stringFormat: date-time
  required
  
  Derived from phases[0].start_date. When the workflow begins watching.
- status
  Type: stringenum
  required
  
  Current lifecycle state of a subscription schedule:
  
  NOT_STARTED — created but waiting for the first phase start date
  
  ACTIVE — currently running; a phase is active
  
  COMPLETED — all phases have ended (via end_behavior: CANCEL)
  
  CANCELED — manually canceled before completion
  
  RELEASED — released from the subscription; billing continues independently
  
  values
  NOT_STARTED
  ACTIVE
  COMPLETED
  CANCELED
  RELEASED
- updated_at
  Type: stringFormat: date-time
  required
  
  Time at which the schedule was last updated.
- account
  Type: string
  
  Merchant account ID.
- application
  Type: string | null
  
  Application ID if created via a connected application.
- billing_mode
  Type: object | null
  
  coming soon — Reserved for future billing mode configuration. Currently accepted and stored but has no effect on billing behavior.
- canceled_at
  Type: string | nullFormat: date-time
  
  If the schedule was canceled, the date of cancellation.
- completed_at
  Type: string | nullFormat: date-time
  
  If the schedule completed (all phases ended), the completion date.
- current_phase
  Type: object | null
  
  Summary snapshot of the currently active phase (id, phase_index, start_date, end_at).
- customer_account
  Type: string | null
  
  Customer account ID for connected account scenarios.
- default_settings
  Type: object
  
  Default settings applied to the subscription created by this schedule.
- metadata
  Type: object | null
  
  Set of key-value pairs attached to the schedule.
- next_action_at
  Type: string | nullFormat: date-time
  
  When the workflow will next fire (next phase transition or schedule end).
- released_at
  Type: string | nullFormat: date-time
  
  If the schedule was released, the date of release.
- released_subscription
  Type: string | null
  
  ID of the subscription that was released from this schedule.
- subscription
  Type: string | null
  
  ID of the subscription created when the schedule was activated. Null until the first phase is applied.
last_key
Type: string | null

Cursor for the next page in format: {ISO_timestamp}_{ULID}. Pass as last_key in the next request. Null when there are no further pages.