Recurring

  • interval
    Type: string enum
    required

    The frequency at which a subscription is billed. One of daily, weekly, monthly, quarterly, or yearly.

    values
    • daily
    • weekly
    • monthly
    • quarterly
    • yearly
  • interval_count
    Type: integer
    required

    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=monthly and interval_count=3 bills every 3 months.

  • usage_type
    Type: string enum
    required

    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

    values
    • licensed
    • metered
  • meter
    Type: string | null
    max length:  
    5000

    The meter tracking the usage of a metered price