SchedulePhaseItems

  • Type: array 1…

    Items active during a phase. At least one item is required per phase. Items without recurring are one-time charges (captured at phase creation, excluded from all future billing cycles).

    For the terminal phase with end_behavior: CANCEL, repeat the previous phase's items. The subscription is canceled immediately when the last phase is applied, so the repeated items are never charged again.

    • Phase item referencing an existing catalog price.

      One-time charge: omit recurring (or set null) — the item is charged once on phase creation and excluded from all future billing cycles.

      • price
        Type: string
        required

        Price ID from your product catalog.

      • currency
        Type: string | null
        min length:  
        3
        max length:  
        3

        Currency override. Falls back to schedule default_settings or subscription currency.

      • metadata
        Type: object | null

        Arbitrary key-value pairs for this item.

      • quantity
        Type: integer
        min:  
        1

        Quantity of this item.

      • recurring
        Type: object · RecurringConfig

        Recurring billing config. Omit or null for a one-time phase charge.

      • unit_amount
        Type: number | null
        min:  
        0

        Unit amount override in cents. Falls back to the catalog price if omitted.