SubscriptionItem

A subscription item representing a product/price combination active on the subscription.

  • billing_interval
    Type: stringenum

    Resolved billing interval for this item (e.g. monthly).

    values
    • daily
    • weekly
    • monthly
    • yearly
  • created_at
    Type: stringFormat: date-time

    Timestamp when the item was created.

  • currency
    Type: string | null

    Three-letter ISO 4217 currency code (uppercase). Resolved from item.currency → subscription.currency.

  • id
    Type: string

    Subscription item ID

  • price
    Type: string

    Price ID from the product catalog.

  • product
    Type: string

    Unique identifier for the product.

  • quantity
    Type: integer

    Quantity of the subscription item.

  • recurring
    Type: object

    Recurring billing configuration.

    • interval
      Type: stringenum
      required

      Billing frequency. Both lowercase and uppercase are accepted; the API normalizes internally.

      • hourly — every hour
      • daily — every day
      • weekly — every week
      • monthly — every month
      • yearly — every year
      values
      • daily
      • weekly
      • monthly
      • quarterly
      • 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

    Unit price in the smallest currency unit (e.g. cents).

  • updated_at
    Type: stringFormat: date-time

    Timestamp when the item was last updated.