SchedulePhaseItemWithPriceData

Phase item with inline pricing.

One-time charge: omit recurring at both the item level and inside price_data.

  • price_data
    required

    Inline pricing for a schedule phase item. Like PriceData but recurring is optional — omit it (or set null) to make the item a one-time charge within the phase.

    • unit_amount
      Type: integer | null
      min:  
      0
      required

      Amount in the smallest currency unit (e.g. cents).

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

      Three-letter ISO currency code.

    • product
      Type: string

      Product ID from your catalog.

    • recurring
      Type: object · RecurringConfig

      Recurring billing configuration.

    • unit_amount_decimal
      Type: string | null Pattern: ^\d+(?:\.0+)?$

      Amount as a decimal string (for high precision).

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

    Currency override at item root level (optional when price_data.currency is set).

  • metadata
    Type: object | null

    Arbitrary key-value pairs for this item.

    • propertyName
      Type: anything
  • quantity
    Type: integer
    min:  
    1

    Quantity of this item.

  • recurring
    Type: object · RecurringConfig

    Recurring billing configuration.

    • interval
      Type: stringenum
      required

      Billing frequency (uppercase):

      • daily — every day
      • weekly — every week
      • monthly — every month
      • yearly — every year
      values
      • daily
      • weekly
      • monthly
      • yearly
    • interval_count
      Type: integer
      min:  
      1

      Number of intervals between billings. For example, interval=monthly and interval_count=3 bills every 3 months.

    • interval_total_cycles
      Type: integer | null
      min:  
      1

      Total number of billing cycles before the subscription ends. Null means unlimited.

    • usage_type
      Type: stringenum

      Usage type for billing:

      • licensed — a fixed recurring charge per billing cycle
      • metered — charge based on reported usage
      values
      • licensed
      • metered
  • unit_amount
    Type: number | null
    min:  
    0

    Unit amount override in cents.