1. Billing
  2. Ramps
  3. Ramp item tiers

Ramp item tiers

ramp_item_tiers
copy
Click to Copy
Note

This table is relevant only when both of the following conditions are met:

  • Price overriding is enabled on the site.
  • The pricing_model of the item price is tiered, volume, or stairstep.

This table captures the item_tiers associated with specific item_prices in the context of a ramp.

Columns

No match found
ramp_id string, not null
Foreign Key ramps.id
A unique and immutable identifier for the ramp.
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 quantity value in this tier. Not applicable to the highest tier. For all other tiers, this must equal the starting_unit_in_decimal of the next higher tier. Returned only when the pricing_model is tiered, volume, or stairstep and multi-decimal pricing is enabled.
index not null
Reserved field with no current functional use.
package_size null
The number of units that make up one package for the tier. Applicable when the pricing type is package. For example, if one package contains 1,000 units, the package size is set to 1,000.
price long, not null, default=0
The per-unit price for the tier when pricing_model is tiered or volume. The total price for the tier when pricing_model is stairstep. The value is in minor currency units.
price_in_decimal string, null
The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. For stairstep, it represents the total price. The value is in major currency units. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
pricing_type string, null
The pricing type for the tier. Possible values are:
  • flat_fee: A flat fee applied to the entire tier regardless of units consumed. For the stairstep pricing model, this is the default.
  • package: Pricing based on blocks or packages of units. For example, if 100 units cost $20 per package, consuming 400 units results in a charge of $80 (4 × $20).
  • per_unit: Pricing based on individual units. For example, at $2 per unit, 150 units cost $300 (150 × $2).
starting_unit not null
The lowest value in the quantity tier.
starting_unit_in_decimal string, null
The decimal representation of the lowest quantity in this tier. For the first tier, this is zero. For subsequent tiers, it equals the ending_unit_in_decimal of the previous tier. Returned when pricing_model is tiered, volume, or stairstep and multi-decimal pricing is enabled.