Navigation: Schema: Items > Tables

ItemPrices

Catalog: Chargebee

Schema: Items

Primary Keys: id

This is a read-only table. The Chargebee API may not support changing the data or the Invantive UniversalSQL driver for Chargebee does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Chargebee API.

Table Columns

The columns of the table ItemPrices are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
accounting_detail_accounting_category1	string(100)		☐
accounting_detail_accounting_category2	string(100)		☐
accounting_detail_accounting_category3	string(100)		☐
accounting_detail_accounting_category4	string(100)		☐
accounting_detail_accounting_code	string(100)		☐	The identifier of the chart of accounts under which the item price falls in the accounting system.
accounting_detail_sku	string(100)		☐	This maps to the sku or product name in the accounting integration.
archived_at	datetime	Archived at	☐	Timestamp indicating when this item was archived.
billing_cycles	int32	Billing Cycles	☐	The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.
channel	string(30)		☐	The subscription channel this object originated from and is maintained in. Possible values are: web, app_store or play_store.
created_at	datetime	Created at	☐
currency_code	string(3)	Currency Code	☐	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(500)	Description	☐	Description of the item price.
external_name	string(100)		☐	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_in_decimal	decimal	Free Quantity in Decimal	☐	The quantity of the item that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when multi-decimal pricing is enabled.
free_quantity	int32	Free Quantity	☐	Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
id	string(100)	ID	☑	The identifier for the item price. It is unique and immutable.
invoice_notes	string(2000)	Invoice Notes	☐	A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
is_taxable	boolean		☐	Specifies whether taxes apply to this item price. This value is set and returned even if Taxes have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
item_family_id	string(100)		☐	The id of the Item family that the item price belongs to.
item_id	string(100)		☐	The id of the Item that the item price belongs to.
item_type	string(30)		☐	Type of item. Possible values are: plan, addon or charge.
metadata	string		☐	A collection of key-value pairs that provides extra information about the item.
name	string(100)	Name	☐	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_unit	string(30)	Period Unit	☐	The unit of time for period. If subscriptions or invoices exist for this item price, period_unit cannot be changed. The period_unit is mandatory when the item type is plan or addon. Possible values are: day, week, month or year.
period	int32	Period	☐	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.
price_in_decimal	decimal	Price in Decimal	☐	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(100)		☐	An immutable unique identifier of a price variant.
pricing_model	string(30)	Pricing Model	☐	The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed. Possible values are: flat_fee, per_unit, tiered, volume or stairstep.
proration_type	string(30)		☐	Specifies how to manage charges or credits for the addon item price during a subscription update or estimating a subscription update. Possible values are: site_default, partial_term or full_term.
resource_version	int64	Resource Version	☐	The version number of this resource. For every change made to the resource, resource_version is updated with a new timestamp in milliseconds.
shipping_period_unit	string(30)		☐	Defines the shipping frequency in association with shipping period. Possible values are: day, week, month or year.
shipping_period	int32		☐	Defines the shipping frequency.
show_description_in_invoices	boolean	Show Description in Invoices	☐	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	Show Description in Quotes	☐	Whether the item price's description should be shown on quote PDFs. If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
status	string	Status	☐	The status of the item price. Possible values: active, archived or deleted.
tax_detail_avalara_sale_type	string(30)		☐	Indicates the Avalara sale type for the item price. Applicable only if you use the AvaTax for Communications integration. Possible values are: wholesale, retail, consumed or vendor_use.
tax_detail_avalara_service_type	int32		☐	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(50)		☐	The Avalara tax codes for the item price. Applicable only if you use AvaTax for Sales integration.
tax_detail_avalara_transaction_type	int32		☐	Indicates the Avalara transaction type for the item price. Applicable only if you use the AvaTax for Communications integration.
tax_detail_hsn_code	string(50)		☐	The HSN code to which the item is mapped for calculating the customer’s tax in India.
tax_detail_tax_profile_id	string(50)		☐	The tax profile of the item price.
tax_detail_taxjar_product_code	string(50)		☐	The TaxJar product code for the item price. Applicable only if you use TaxJar integration.
trial_end_action	string(30)		☐	Applicable only when End-of-trial Action has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type is plan and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level. Possible values are: site_default, activate_subscription or cancel_subscription.
trial_period_unit	string(30)	Trial Period Unit	☐	The unit of time for trial_period. Possible values are: day or month.
trial_period	int32	Trial Period	☐	The trial period of the plan in trial_period_units. You can also set trial periods for addons; contact Support to enable that feature.
updated_at	datetime	Updated at	☐

10-06-2024 18:44 Version 24.1.3-BETA+4689

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Chargebee API Data Model

ItemPrices

Table Columns

Important Safety and Usage Information