1. Product Catalog
  2. Item prices

Item prices

item_prices
copy
Click to Copy

An item price is a price point for an item. It defines the currency, pricing model, price, billing period and other attributes for an item

Related Tables

Tables referencing item_prices.id
subscription_discounts subscription_charged_items ramp_item_tiers subscription_item_tiers ramp_items_to_add item_price_tiers subscription_items ramp_discounts_to_add ramp_items_to_update item_price_custom_fields

Columns

No match found
id string, not null
Primary Key
A unique and immutable identifier for the item price.
item_id string, null
Foreign Key items.id
The id of the item that the item price belongs to.
item_family_id string, null
Foreign Key item_families.id
Id of the item_family
accounting_detail_accounting_category1 string, null
Used exclusively with the following accounting integrations
  • Xero: If you’ve categorized your products in Xero, provide the category name and option. Use the format: <category-name>: <option>. For example:Location: Singapore.
  • QuickBooks: If you’ve categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: <parent class>:<sub-class-1>:<sub-class-2>...
  • NetSuite: If you’ve categorized your products in NetSuite under Classes, provide the class name here. Use the following format: <parent class>: <sub-class-1>: <sub-class2>.... For example: Services: Plan.
  • Intacct: If you’ve classified your products in Intacct under Locations, provide the name of the Location here.
accounting_detail_accounting_category2 string, null
Used exclusively with the following accounting integrations
  • Xero: If you’ve categorized your products in Xero, then provide the second category name and option here. Use the format: <category-name>: <option>.... For example, Region: South
  • QuickBooks: If you’ve categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format: <parent-location>:<sub-location-1>:<sub-location-2>.... For example: Location: North America: Canada
  • NetSuite: If you’ve categorized your products in NetSuite under Locations, provide the location name here. Use the following format <parent-location> : <sub-location-1>: <sub-location-2>.... For example: NA:US:CA
  • Intacct: If you’ve classified your products in Intacct under Dimensions, provide the value of the Dimension here.
accounting_detail_accounting_category3 string, null
Used exclusively with the following accounting integrations
  • NetSuite: If you’ve categorized your products in NetSuite under Departments, pass the department name here. Use the following format: <parent-department> : <sub-department-1>: <sub-department-2>.... For example: Production: Assembly.
  • Intacct: If you’ve classified your products in Intacct under multiple dimensions, provide the value of the second dimension here.
accounting_detail_accounting_category4 string, null
Used exclusively with the following accounting integrations
  • NetSuite: Provide the “Revenue Recognition Rule Id” for the product from NetSuite.
  • Intacct: If you have configured “Revenue Recognition Templates” for products in Intacct, provide the template ID for the product.
accounting_detail_accounting_code string, null
The identifier of the chart of accounts under which the item price is categorized in the accounting system.
accounting_detail_sku string, null
The SKU or product name mapped from the accounting integration.
archived_at timestamp, null
Timestamp indicating when this item price was archived.
billing_cycles null

The default number of billing cycles a subscription to the plan runs for. This value can vary across subscriptions.

Addons can also have billing cycles. For addons, this value may differ depending on how the addon is associated with a plan or subscription.

If subscriptions, invoices, or differential prices exist for the item price, the billing_cycles field remains fixed and cannot be updated.

channel string, null
The subscription channel from which the item price data originated and is maintained.
created_at timestamp, not null
Timestamp indicating when this item price was created.
currency_code string, not null
The currency code (ISO 4217 format) for the item price. If subscriptions, invoices or differential prices exist for this item price, currency_code cannot be changed.
description string, null
A description of the item price.
Note:
If the value contains characters that require sanitization (such as incomplete HTML tags), the sanitization process may increase its length. If the sanitized content exceeds the character limit, it will not be stored.
external_name string, null
The name of the item price used in customer-facing pages and documents. These include invoices and hosted pages. If not provided, then name is used
free_quantity not null, default=0
The quantity included for free in subscriptions using this item price. Only the quantity exceeding this value is chargeable.
free_quantity_in_decimal string, null
The quantity of the item available free of charge, represented as a decimal value. Only the quantity exceeding this value is chargeable. This field applies to quantity-based plans and is available only when multi-decimal pricing is enabled.
invoice_notes string, null
A customer-facing note associated with all invoices generated for this item price. This note appears alongside other notes on the invoice PDF.
is_taxable boolean, null, default=true
Indicates whether taxes apply to this item price. This field is populated regardless of whether Taxes are enabled in Chargebee, but it is effective only when Taxes are enabled.
item_type string, null
Type of item.
metadata string, null
name string, not null
A unique display name for the item price in the Chargebee UI. If external_name is not provided, this is also used in customer-facing pages and documents such as invoices and hosted pages.
period null

  • When the item type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.
  • When item type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.

If subscriptions or invoices exist for this item price, period cannot be changed. The period is mandatory when the item type is plan or addon
period_unit string, null
The unit of time used to define the period for the item price. This field is required when the item type is plan or addon. If subscriptions or invoices exist for the item price, the period_unit value cannot be changed.
price long, null
The cost of the item price when the pricing_model is flat_fee. When the pricing_model is per_unit, this represents the price per unit quantity. This field is not applicable for other pricing models. The value is stored in the minor unit of the currency.
price_in_decimal string, null
The price of the item when the pricing_model is flat_fee. When the pricing model is per_unit, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing is enabled.
price_variant_id string, null

An immutable unique identifier of a price variant.

pricing_model string, not null, default=flat_fee

The pricing scheme applied to this item price. If subscriptions, invoices, or differential prices exist for this item price, the value of pricing_model is fixed and cannot be changed.

proration_type string, null
Specifies how charges or credits are handled for the addon item price during a subscription update or an estimate calculation.
resource_version long, null
Version number of this table. The resource_version is updated with a new timestamp in milliseconds for every change made to the table. This field will be present only if the table has been updated after 2016-09-28.
shipping_period null
Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
shipping_period_unit string, null
Defines the shipping frequency based on the value of the shipping_period field.
show_description_in_invoices boolean, null
Whether the item price's description should be shown on invoice PDFs. If this Boolean is changed, only invoices generated (or regenerated) after the change are affected; past invoices are not.
show_description_in_quotes boolean, null
Indicates whether the item price description is included in quote PDFs. This setting applies only to quotes created after the field value is updated; existing quotes are not affected.
status string, null
The current status of the item price.
tax_detail_avalara_sale_type string, null
Indicates the Avalara sale type for the item price. Applicable only if you use the AvaTax for Communications integration.
tax_detail_avalara_service_type null
Indicates the Avalara service type for the item price. Applicable only if you use the AvaTax for Communications integration.
tax_detail_avalara_tax_code string, null
The Avalara tax codes for the item price. Applicable only if you use AvaTax for Sales integration.
tax_detail_avalara_transaction_type null
Indicates the Avalara transaction type for the item price. Applicable only if you use the AvaTax for Communications integration.
tax_detail_hsn_code string, null
The HSN code to which the item is mapped for calculating the customer’s tax in India. Applicable only when both of the following conditions are true:
tax_detail_tax_profile_id string, null
The tax profile of the item price.
tax_detail_taxjar_product_code string, null
The TaxJar product code associated with the item price. This field is applicable only if the TaxJar integration is enabled.
trial_end_action string, null
Specifies the action to be taken for the subscription when the trial ends. Applicable only when End-of-trial Action is enabled for the site. This field appears when item.type is plan and a trial period is defined for the item price. The value may differ at the subscription level.
trial_period null
The trial period of the plan in trial_period_units. You can also set trial periods for addons; contact Support to enable this feature.
trial_period_unit string, null
The unit of time used to define the trial_period.
updated_at timestamp, null
Timestamp indicating when this item price was last updated