ItemWithPriceData

Subscription item with inline pricing. Use this to create subscription-specific pricing without a pre-existing catalog price.

  • price_data
    required

    Inline pricing details for a subscription item. Use this when you want to specify custom pricing directly rather than referencing an existing catalog price. Either unit_amount or unit_amount_decimal is required.

    Note: currency is required when using price_data for inline pricing.

    Inline pricing details for a subscription item. Use this when you want to specify custom pricing directly rather than referencing an existing catalog price. Either unit_amount or unit_amount_decimal is required.

    Note: currency is required when using price_data for inline pricing.

    • unit_amount
      Type: integer | null
      min:  
      0
      required

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

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

      Three-letter ISO currency code (e.g. usd, eur). Required for inline pricing.

    • product
      Type: string

      Product ID from your catalog.

    • recurring
      Type: object

      Recurring billing configuration.

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

      Amount as a decimal string for high-precision pricing.

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

    Three-letter ISO currency code (optional at root level when price_data is provided).

  • quantity
    Type: integer
    min:  
    1

    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