Metrics
BETA
Billing
Invoicing
Payments
Subscription items
subscription_items
copy
Click to Copy
Details of individual item prices that are part of this subscription.
Columns
subscription_id string, not null
Foreign Key
subscriptions.id
The unique ID of the subscription this record belongs to.
amount long, null
The total amount for the item as determined from `unit_price`, `free_quantity`, `quantity`, and `item_tiers` as applicable. The value depends on the type of currency.
amount_in_decimal string, null
The decimal representation of the total amount for the item, in major units of the currency. This is always returned when multi-decimal pricing is enabled.
billing_cycles null
For the plan-item price:
the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used.
For addon-item prices:
If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used.
For addon-item prices:
If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
billing_period null
billing_period_unit string, null
charge_on_event string, null
When the `charge_on_option` is set to `on_event`, this field specifies the event at which the charge-item is applied to the subscription. This field only applies to charge-items.
charge_on_option string, null
Indicates when the charge-item is charged. This field only applies to charge-items.
charge_once boolean, null
Indicates if the charge-item is charged only once or each time the `charge_on_event` occurs. This field only applies to charge-items.
free_quantity null
The `free_quantity` of the plan-item as specified for the item price.
free_quantity_in_decimal string, null
The `free_quantity_in_decimal` as set for the item price. This is returned for quantity-based item prices when multi-decimal pricing is enabled.
item_type string, not null
The type of item. There is one and only one item of type `plan` in this list.
proration_type string, null
Specifies how to manage charges or credits for the addon during a subscription update.
You cannot modify this field's value within the current term. Moreover, it is removed from the subscription records when the next term starts.
You cannot modify this field's value within the current term. Moreover, it is removed from the subscription records when the next term starts.
quantity null
The quantity of the item purchased.
quantity_in_decimal string, null
The decimal representation of the quantity of the item purchased. This can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.
service_period_days null
The service period of the item in days from the day of charge.
trial_end timestamp, null
The date/time when the trial period of the item ends. This applies to plan-items and—when enabled—addon-items as well.
unit_price long, null
The price/per unit price of the item. If not provided, the value set for the item price is used. This is only applicable when the `pricing_model` of the item price is `flat_fee` or `per_unit`. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at` is in the past and a `unit_price` is not passed, then the item price’s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
unit_price_in_decimal string, null
The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. This is always returned when multi-decimal pricing is enabled.