1. Billing
  2. Subscriptions
  3. Subscription item tiers

Subscription item tiers

subscription_item_tiers
copy
Click to Copy
The `subscription_item_tiers` table defines the pricing details for `subscription_items` that use a `tiered`, `volume`, or `stairstep` pricing model.

Columns

No match found
subscription_id string, not null
Foreign Key subscriptions.id
The unique ID of the subscription this record belongs to.
item_price_id string, not null
Foreign Key item_prices.id
The ID of the item price to which this tier belongs.
ending_unit null
The highest value in the quantity tier.
ending_unit_in_decimal string, null
The decimal representation of the highest value of quantity in this tier. This field is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal` of the next higher tier. This is returned only when the pricing_model is `tiered`, `volume` or `stairstep` and multi-decimal pricing is enabled.
index not null
The index number of the subscription to which the item price is added. This is a unique number between `0` and `4` (inclusive) for each subscription that is created.
price long, not null, default=0
The per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. The total cost for the item price when the `pricing_model` is `stairstep`. The value is in the minor unit of the currency.
price_in_decimal string, null
The decimal representation of the per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. When the `pricing_model` is `stairstep`, it is the decimal representation of the total price for the item. The value is in major units of the currency. This is returned when the plan is quantity-based and multi-decimal pricing is enabled.
starting_unit not null
The lowest value in the quantity tier.
starting_unit_in_decimal string, null
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal` of the next lower tier. This is returned only when the pricing_model is `tiered`, `volume` or `stairstep` and multi-decimal pricing is enabled.