The Plan object 

Attributes

• idstring

  Unique identifier for the object.

• activeboolean

  Whether the plan can be used for new purchases.

• amountnullable integer

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

• currencyenum

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

• intervalenum

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

• metadatanullable object

  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 plan, hidden from customers.

• productnullable stringExpandable

  The product whose pricing this plan determines.

More attributes

Collapse all

• objectstring

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

• 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.

• billing_schemeenum

  Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in amount) will be charged per unit in quantity (for plans with usage_type=licensed), or per unit of total usage (for plans 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.

• 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.

• livemodeboolean

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

• meternullable string

  The meter tracking the usage of a metered price

• 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_usagenullable 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_usage.divide_byinteger

    Divide usage by this number.

  • transform_usage.roundenum

    After division, either round the result up or down.

• trial_period_daysnullable integer

  Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

• 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.