ItemWithPrice

Subscription item referencing an existing price from your product catalog.

Currency Handling:

  • currency is optional at item level
  • Falls back to the subscription-level currency if not provided
  • At least one of item.currency or subscription.currency must be set
  • price
    Type: string
    required

    Price ID from your product catalog (ULID format).

  • recurring
    Type: object · RecurringConfig
    required

    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
  • currency
    Type: string
    min length:  
    3
    max length:  
    3

    Three-letter ISO currency code (e.g. usd). Optional — falls back to subscription.currency if not provided.

  • quantity
    Type: integer
    min:  
    1

    Quantity of the subscription item.

  • unit_amount
    Type: number | null
    min:  
    0

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