The Price object 

Attributes

• idstring

  Unique identifier for the object.

• activeboolean

  Whether the price can be used for new purchases.

• currencyenum

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

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• nicknamenullable string

  A brief description of the price, hidden from customers.

• productstringExpandable

  The ID of the product this price is associated with.

• recurringnullable object

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

  Hide child attributes

  • recurring.intervalenum

    The frequency at which a subscription is billed. One of day, week, month or year.

  • recurring.interval_countinteger

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

  • recurring.meternullable string

    The meter tracking the usage of a metered price

  • recurring.usage_typeenum

    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.

• tax_behaviornullable enum

  Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

  Possible enum values

  exclusive

  inclusive

  unspecified

• typeenum

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

  Possible enum values

  one_time

  recurring

• unit_amountnullable integer

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

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• billing_schemeenum

  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.

  Possible enum values

  per_unit

  tiered

• createdtimestamp

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

• currency_optionsnullable objectExpandable

  Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

  Hide child attributes

  • currency_options.<currency>.custom_unit_amountnullable object

    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

    Hide child attributes

    • currency_options.<currency>.custom_unit_amount.maximumnullable integer

      The maximum unit amount the customer can specify for this item.

    • currency_options.<currency>.custom_unit_amount.minimumnullable integer

      The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

    • currency_options.<currency>.custom_unit_amount.presetnullable integer

      The starting unit amount which can be updated by the customer.

  • currency_options.<currency>.tax_behaviornullable enum

    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

    Possible enum values

    exclusive

    inclusive

    unspecified

  • currency_options.<currency>.tiersnullable array of objectsExpandable

    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

    Hide child attributes

    • currency_options.<currency>.tiers.flat_amountnullable integer

      Price for the entire tier.

    • currency_options.<currency>.tiers.flat_amount_decimalnullable decimal string

      Same as flat_amount, but contains a decimal value with at most 12 decimal places.

    • currency_options.<currency>.tiers.unit_amountnullable integer

      Per unit price for units relevant to the tier.

    • currency_options.<currency>.tiers.unit_amount_decimalnullable decimal string

      Same as unit_amount, but contains a decimal value with at most 12 decimal places.

    • currency_options.<currency>.tiers.up_tonullable integer

      Up to and including to this quantity will be contained in the tier.

  • currency_options.<currency>.unit_amountnullable integer

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

  • currency_options.<currency>.unit_amount_decimalnullable decimal string

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

• custom_unit_amountnullable object

  When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

  Hide child attributes

  • custom_unit_amount.maximumnullable integer

    The maximum unit amount the customer can specify for this item.

  • custom_unit_amount.minimumnullable integer

    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

  • custom_unit_amount.presetnullable integer

    The starting unit amount which can be updated by the customer.

• livemodeboolean

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

• lookup_keynullable string

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

• tiersnullable array of objectsExpandable

  Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

  Hide child attributes

  • tiers.flat_amountnullable integer

    Price for the entire tier.

  • tiers.flat_amount_decimalnullable decimal string

    Same as flat_amount, but contains a decimal value with at most 12 decimal places.

  • tiers.unit_amountnullable integer

    Per unit price for units relevant to the tier.

  • tiers.unit_amount_decimalnullable decimal string

    Same as unit_amount, but contains a decimal value with at most 12 decimal places.

  • tiers.up_tonullable integer

    Up to and including to this quantity will be contained in the tier.

• tiers_modenullable enum

  Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.

  Possible enum values

  graduated

  volume

• transform_quantitynullable object

  Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.

  Hide child attributes

  • transform_quantity.divide_byinteger

    Divide usage by this number.

  • transform_quantity.roundenum

    After division, either round the result up or down.

• unit_amount_decimalnullable decimal string

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