1. Billing
  2. Ramps
  3. Ramp items to add

Ramp items to add

ramp_items_to_add
copy
Click to Copy
Details about the item prices associated with the subscription in the 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 unique identifier of the item price.
amount long, null
The total amount for the item, calculated from unit_price, free_quantity, quantity, and item_tiers as applicable. The value depends on the currency type.
amount_in_decimal string, null
The decimal representation of the item's total amount, in major currency units. Returned when multi-decimal pricing is enabled.
billing_cycles null
For a plan-item price:
the number of billing cycles before the subscription auto-cancels. If not specified, the value from the plan-item price is used.

For addon-item prices:
if addon billing cycles are enabled, this field represents how long the addon applies. If not specified, the value from the attached addon or addon-item price is used.
free_quantity null
The quantity of the item that is available for free. Only the quantity above this threshold is billable. This is equivalent to item_price.free_quantity.
free_quantity_in_decimal string, null
The decimal representation of free_quantity as configured in the item price. Returned for quantity-based item prices when multi-decimal pricing is enabled.
item_type string, not null
The type of item. The list must include exactly one item of type plan. Possible values are:
  • addon: Addon
  • charge: Charge
  • plan: Plan
metered_quantity string, null
The number of units recorded against this item during the current subscription term.
quantity null
The quantity of the item purchased.
quantity_in_decimal string, null
The decimal representation of the quantity purchased. Available only for quantity-based item prices when multi-decimal pricing is enabled.
service_period_days null
The duration of service in days, beginning from the charge date.
unit_price long, null
The price or per-unit price of the item. If not specified, the value from the item price is used. Applicable when the pricing_model is flat_fee or per_unit. Also relevant only when price overriding is enabled. The value depends on the currency type.
unit_price_in_decimal string, null
The decimal representation of the price or per-unit price of the item, in major currency units. Returned when multi-decimal pricing is enabled.