Navigation: Schema: Items > Tables

Items

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 Items are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
archived_at	datetime	Archived at	☐	Timestamp indicating when this item was archived.
channel	string(30)		☐	The subscription channel this object originated from and is maintained in. Possible values are: web, app_store or play_store.
description	string(500)	Description	☐	Description of the item. This is visible only in Chargebee and not to customers.
enabled_for_checkout	boolean		☐	Allow the plan to subscribed to via Checkout. Applies only for plan-items. Note: Only the in-app version of Checkout is supported for Product Catalog v2.
enabled_in_portal	boolean	Enabled in Portal	☐	Allow customers to change their subscription to this plan via the Self-Serve Portal. Applies only for plan-items. This requires the Portal configuration to allow changing subscriptions.
external_name	string(100)		☐	A unique display name for the item.
gift_claim_redirect_url	string(500)		☐	The URL to redirect to once the gift has been claimed by the receiver.
id	string(100)	ID	☑	The identifier for the item. It is unique and immutable.
included_in_mrr	boolean	Included in MRR	☐	The item is included in MRR calculations for your site. This attribute is only applicable for items of type = charge and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude charge-items from MRR calculations, this value is always returned false.
is_giftable	boolean		☐	Specifies if gift subscriptions can be created for this item.
is_shippable	boolean	Is Shippable	☐	Indicates that the item is a physical product. If Orders are enabled in Chargebee, subscriptions created for this item will have orders associated with them.
item_applicability	string(30)		☐	Indicates which addon-items and charge-items can be applied to the item. Only meant for plan-items. Other details of attaching items such as whether to attach as a mandatory item or to attach on a certain event, can be specified using the Create or Update an attached item API. Possible values: all or restricted.
item_family_id	string(100)		☐	The id of the Item family that the item belongs to. Is mandatory when Product Families have been enabled.
metadata	string		☐	A collection of key-value pairs that provides extra information about the item.
metered	boolean		☐	Specifies whether the item undergoes metered billing. When true, the quantity is calculated from usage records. When false, the quantity is as determined while adding an item price to the subscription. Applicable only for items of type plan or addon and when Metered Billing is enabled. The value of this attribute cannot be changed.
name	string(100)	Name	☐	A unique display name for the item. This is visible only in Chargebee and not to customers.
redirect_url	string(500)	Redirect URL	☐	If enabled_for_checkout, then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
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.
status	string	Status	☐	The status of the item. Possible values: active, archived or deleted.
type	string(30)	Type	☐	The type of the item. Possible values: plan, addon or charge.
unit	string(30)	Unit	☐	The unit of measure for a quantity-based item. This is displayed on the Chargebee UI and on customer facing documents/pages. The latter includes hosted pages, invoices and quotes.
updated_at	datetime	Updated at	☐
usage_calculation	string(30)		☐	How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is metered. This value overrides the one set at the site level. Possible values are: sum_of_usages, last_usage or max_usage.

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

Items

Table Columns

Important Safety and Usage Information