Items - Chargebee Data Catalog

This table represents entities made available for sale, such as plans, addons, or charges in your product catalog. It includes both non-metered items, which are charged upfront, and metered items, which are charged at the end of the billing cycle based on usage.

Related Tables

Tables referencing items.id

item_custom_fields item_prices

Columns

id string, not null

Primary Key

A unique and immutable identifier for the item.

item_family_id string, null

Foreign Key item_families.id

The id of the Item family to which the item belongs. This field is mandatory when Product Families are enabled.

archived_at timestamp, null

Timestamp indicating when this item was archived.

channel string, null

The subscription channel from which this field originated and where it is maintained.

description string, null

A short description of the item. This field is visible only within Chargebee and not to customers.

enabled_for_checkout boolean, not null, default=true

Indicates whether the plan can be subscribed to via Checkout. Applies only to plan-items.
Note: Only the in-app version of Checkout is supported for Product Catalog v2.

enabled_in_portal boolean, not null, default=true

Allows 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, null

A unique display name for the item.

gift_claim_redirect_url string, null

The URL to which the recipient is redirected after claiming the gift.

included_in_mrr boolean, null

Indicates whether the item is included in MRR calculations for your site. This attribute applies only to items of type = charge and when the feature is enabled in Chargebee. If the site-level setting excludes charge-items from MRR calculations, this value is always false.

is_giftable boolean, not null, default=false

Specifies if gift subscriptions can be created for this item.

is_shippable boolean, null, default=false

Indicates whether 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, null, default=all

Indicates which addon-items and charge-items can be applied to the item. This field applies only to plan-items. Details such as mandatory attachment or event-based application are stored in related fields.

metadata string, null

metered boolean, not null, default=false

Indicates whether the item table uses metered billing. When true, the quantity is calculated from usage records. When false, the quantity is set during item price assignment. This field applies only to items of type plan or addon, and only when Metered Billing is enabled. The value of this field cannot be changed.

name string, not null

A unique display name for the item in the table. This is visible only in Chargebee and not to customers.

redirect_url string, null

If enabled_for_checkout, then the URL to be redirected to once the checkout is complete. This field is only available for plan-items.

resource_version long, null

The version number of this table. For every change made to the table, resource_version is updated with a new timestamp in milliseconds.

status string, null

The status of the item.

type string, not null

The type of the item.

unit string, null

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. Examples follow:

“user“ for a cloud-collaboration platform.
“GB“ for a data service.
“issue“ for a magazine.

updated_at timestamp, null

Timestamp indicating when the item was last updated.

usage_calculation string, null

Specifies how the quantity is calculated from usage data for item prices associated with this item. Applicable only when the item is metered. This field overrides the value set at the site level.