Price

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

  • Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

    • active
      Type: boolean

      Whether the price can be used for new purchases.

    • billing_scheme
      Type: "per_unit" or "tiered"enum

      Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.

    • created
      Type: numberFormat: date-time

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • currency
      Type: stringFormat: currency

      Three-letter ISO currency code, in uppercase. Must be a supported currency.

    • livemode
      Type: boolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • lookup_key
      Type: string | null
      max length:  
      5000

      A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

    • product

      The ID of the product this price is associated with.

      • Type: ProductId
        max length:  
        100

        The ID of the product this price is associated with.

    • product_data
      Type: Product

      These fields can be used to create a new product that this price will belong to.

      Properties: 5
    • recurring
      Type: Recurring

      The recurring components of a price such as interval and usage_type.

      Properties: 4
    • type
      Type: "one_time" or "recurring"enum

      One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

    • unit_amount
      Type: integer | null

      The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

    • unit_amount_decimal
      Type: string | nullFormat: decimal

      The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

    • id
      Type: string
      max length:  
      5000

      Unique identifier for the object.