Create An Item

The device from which the customer has made the request

The email address of your customer/user. Use this when the email address has only ASCII characters.

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

The IP address of the customer where the request originated

skip all actions to be done on the events

One ofall-disabled

skip only emails

One ofall-disabled

skip only webhooks

One ofall-disabled

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

The identifier for the item. Must be unique and is immutable once set.

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

The type of the item. \* plan - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \* charge - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge) without being applied to a subscription. \* addon - A recurring component that can be added to a subscription in addition to its plan.

One ofplanaddoncharge

Description of the item. This is visible only in Chargebee and not to customers.

<p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> of the <a href="/docs/api/item_families">Item family</a> that the item belongs to. Is mandatory when <a href="https://www.chargebee.com/docs/2.0/product-families.html" target="_blank">Product Families</a> have been enabled.</p>

Specifies if gift subscriptions can be created for this item.

Default false

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.

Default false

A unique display name for the item.

Allow customers to change their subscription to this plan via the [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html). Applies only for plan-items. This requires the Portal configuration to [allow changing subscriptions](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). Only the in-app version of the Portal is supported for Product Catalog v2.

Default true

<p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">enabled_for_checkout</code> , then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.</p>

Allow the plan to subscribed to via Checkout. Applies only for plan-items. **Note:** Only the in-app layout of Checkout is supported.

Default true

<p class="mb-2">Indicates which addon-items and charge-items can be applied to the item. Only possible 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 <a href="/docs/api/attached_items/create-an-attached-item">Create</a> or <a href="/docs/api/attached_items/update-an-attached-item">Update an attached item</a> API.</p> * all - <p class="mb-2">all addon-items and charge-items are applicable to this plan-item.</p> * restricted - <p class="mb-2">only the addon-items or charge-items provided in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">applicable_items</code> can be applied to this plan-item.</p>

One ofallrestrictedDefault "all"

The list of ids of addon-items and charge-items that can be applied to the plan-item. This parameter can be provided only for plan-items and that too when item_applicability is restricted. Other details of attaching items can be specified using the [Create](/docs/api/attached_items/create-an-attached-item) or [Update an attached item](/docs/api/attached_items/update-an-attached-item) API.

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](/docs/api/hosted_pages) , [invoices](/docs/api/invoices) and [quotes](/docs/api/quotes). Examples follow: * "user" for a cloud-collaboration platform. * "GB" for a data service. * "issue" for a magazine.

The URL to redirect to once the gift has been claimed by the receiver.

<p class="mb-2">The item is included in MRR calculations for your site. This attribute is only applicable for items of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type = charge</code> 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 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code> .</p>

<p class="mb-2">Specifies whether the item undergoes usage-based or metered billing. <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/understanding-usages" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Usage Based Billing</a> or <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Metered Billing</a> must be enabled on your site to set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>.</p> <p class="mb-2"><strong class="font-semibold">Usage Based Billing</strong></p> <p class="mb-2">When Usage Based Billing is enabled, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> is applicable only for items of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon</code>. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, the quantity is calculated from <a href="/docs/api/usage_events/create-a-usage-event" class="text-blue-600 hover:text-blue-800 underline">usage events</a>. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>, you must provide the quantity when adding an <a href="/docs/api/item_prices" class="text-blue-600 hover:text-blue-800 underline">item price</a> that belongs to this item to a subscription (for example, when <a href="/docs/api/subscriptions/create-subscription-for-items#subscription_items_quantity" class="text-blue-600 hover:text-blue-800 underline">creating</a> or <a href="/docs/api/subscriptions/update-subscription-for-items#subscription_items_quantity" class="text-blue-600 hover:text-blue-800 underline">updating</a> the subscription).</p> <p class="mb-2"><strong class="font-semibold">Metered Billing</strong></p> <p class="mb-2">When Metered Billing is enabled, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> is applicable only for items of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon</code>. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, the quantity is calculated from <a href="/docs/api/usages" class="text-blue-600 hover:text-blue-800 underline">usage records</a>. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>, you must provide the quantity when adding an <a href="/docs/api/item_prices" class="text-blue-600 hover:text-blue-800 underline">item price</a> that belongs to this item to a subscription (for example, when <a href="/docs/api/subscriptions/create-subscription-for-items#subscription_items_quantity" class="text-blue-600 hover:text-blue-800 underline">creating</a> or <a href="/docs/api/subscriptions/update-subscription-for-items#subscription_items_quantity" class="text-blue-600 hover:text-blue-800 underline">updating</a> the subscription).</p>

Default false

<p class="mb-2">How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code>. This value overrides the one <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing" target="_blank" rel="noopener noreferrer">set at the site level</a>. .</p> * sum_of_usages - <p class="mb-2">the net quantity is the sum of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> of all usages for the current term.</p> * last_usage - <p class="mb-2">from among the usage records for the <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_price_id">item price</a> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">usage_date</code> within the relevant billing period, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> of the usage record with the most recent <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">usage_date</code> is taken as the net quantity consumed.</p> * max_usage - <p class="mb-2">from among the usage records for the <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_price_id">item price</a> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">usage_date</code> within the relevant billing period, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> of the usage record with the maximum value is taken as the net quantity consumed.</p>

One ofsum_of_usageslast_usagemax_usage

Default false

A collection of key-value pairs that provides extra information about the item. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/advanced-features#metadata).

<p class="mb-2">The unique ID of the <a href="/docs/api/business_entities">business entity</a> for this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item</code>. This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">business_entity_id</code> will not be included in the API response.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong> An alternative way of passing this parameter is by means of a <a href="/docs/api/advanced-features#mbe-header-main">custom HTTP header</a>.</p></div> <span featureId="cb-mbe" isMicro="true"></span>

<p class="mb-2">Parameters of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bundle_configuration</code></p>

<p class="mb-2">Type of the bundle</p> * fixed - <p class="mb-2">Fixed <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bundle_configuration.type</code> appears when you create a <a href="https://www.chargebee.com/docs/2.0/product-bundling-overview.html">bundle plan</a> that cannot be updated during checkout or subscription creation.</p>

One offixed

<p class="mb-2">Parameters for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bundle_items_to_add</code></p>

<p class="mb-2"><a href="/docs/api/items/item-object#id"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_id</code></a> that needs to be added to the bundle. <strong class="font-semibold">Note:</strong> This parameter is only applicable when the <a href="/docs/api/items/item-object#type"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_type</code></a> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code> .</p>

Quantity of the item(plan, addon, and charge) associated with the bundle.

Price allocation of the item(plan, addon, and charge) associated with the bundle.

<div class="api-description"><p class="mb-2">When offering subscriptions of products or services, each entity that is made available for sale is represented by an &quot;item&quot; object. Items therefore represent the various plans, addons or charges that you offer as part of your product catalog. Non-<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> items are charged upfront in Chargebee, while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> items are charged at the end of the billing cycle, based on usage.</p><h3>Types of Items</h3><p class="mb-2">There are three types of items and they&#x27;re listed and explained here. Examples for each type are provided in the table that follows.</p><h4>Plan-items or Plans</h4><p class="mb-2">Plan-items are items that have a recurring charge and are an essential component of any <a href="/docs/api/subscriptions">subscription</a>. Typically, plans represent a principal or key product or service in your catalog. They are charged at recurring intervals and often have other products or services offered along with them as addons and charges.</p><h4>Addon-items or Addons</h4><p class="mb-2">Addon-items are items that are sold along with a plan and are charged for at recurring intervals.</p><h4>Charge-items or Charges</h4><p class="mb-2">Charge-items are items that are sold along with a plan but charged once (or each time) a specified event occurs. A charge can also be <a href="/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge">applied to a customer</a> without attaching to a subscription.</p><h4>Examples</h4><p class="mb-2">To help understand each type of item better, listed below are some examples of items from different business domains:</p><h5>Non-Metered (SaaS)</h5><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><strong class="font-semibold">Item Family:</strong> A project management solution.</li> <li class="text-base leading-relaxed"><strong class="font-semibold">Plans:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">A &quot;basic&quot; plan offering a small set of features.</li> <li class="text-base leading-relaxed">A &quot;business&quot; plan offering a larger set of features.</li> </ul> </li> <li class="text-base leading-relaxed"><strong class="font-semibold">Addons:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">An analytics plugin that is available only with the &quot;business&quot; plan.</li> <li class="text-base leading-relaxed">A reporting plugin, available with both the above plans.</li> </ul> </li> <li class="text-base leading-relaxed"><strong class="font-semibold">Charges:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Implementation charges.</li> <li class="text-base leading-relaxed">Trial charges.</li> </ul> </li> </ul><h5>Non-Metered (E-commerce)</h5><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><strong class="font-semibold">Item Family:</strong> A printed news magazine.</li> <li class="text-base leading-relaxed"><strong class="font-semibold">Plans:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Periodic issues of the magazine.</li> <li class="text-base leading-relaxed">Periodic issues of the magazine, with digital content.</li> </ul> </li> <li class="text-base leading-relaxed"><strong class="font-semibold">Addons:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Supplementary online content.</li> <li class="text-base leading-relaxed">Access to a year&#x27;s worth of back issues.</li> <li class="text-base leading-relaxed">Searchable access to all back issues.</li> </ul> </li> <li class="text-base leading-relaxed"><strong class="font-semibold">Charges:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Special edition books that are published every so often.</li> </ul> </li> </ul><h5>Metered</h5><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><strong class="font-semibold">Item Family:</strong> SMS delivery services.</li> <li class="text-base leading-relaxed"><strong class="font-semibold">Plans:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">A basic plan of up to 100K messages @ $0.03 per message.</li> <li class="text-base leading-relaxed">A volume plan of 2M messages @ $0.01 per message.</li> </ul> </li> <li class="text-base leading-relaxed"><strong class="font-semibold">Addons:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">An addon of 50K MMS messages @ $0.1 per message.</li> <li class="text-base leading-relaxed">Instant messaging.</li> </ul> </li> <li class="text-base leading-relaxed"><strong class="font-semibold">Charges:</strong> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Automated Metered Billing is not applicable for charges.</li> </ul> </li> </ul></div>

The identifier for the item. It is unique and immutable.

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

A unique display name for the item.

<p class="mb-2">Description of the item. This is visible only in Chargebee and not to customers.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The description field supports up to 2000 characters, including HTML tags. The inner text (excluding HTML tags) must not exceed 500 characters. For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">- testing - desc </code>. Total with tags: 38 characters, inner text: &#x27;testing desc&#x27; (12 characters).</li> <li class="text-base leading-relaxed">If your input includes characters requiring sanitization, such as incomplete HTML tags, the sanitization process may alter the input and increase its length. If the sanitized content exceeds the allowed limit, the request will be rejected.</li> </ul></div>

<p class="mb-2">The status of the item.</p> * archived - <p class="mb-2">The item is no longer active and no new item prices can be created</p> * active - <p class="mb-2">The item can be used to create new item prices.</p> * deleted - <p class="mb-2">Indicates that the item has been <a href="/docs/api/items/delete-an-item">deleted</a>. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">name</code> can be reused. Deleted items can be retrieved using <a href="/docs/api/items/list-items">List items</a> .</p>

One ofactivearchiveddeleted

<p class="mb-2">The version number of this resource. For every change made to the resource, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> is updated with a new timestamp in milliseconds.</p>

Timestamp indicating when the item was last updated.

<p class="mb-2">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> of the <a href="/docs/api/item_families">Item family</a> that the item belongs to. Is mandatory when <a href="https://www.chargebee.com/docs/2.0/product-families.html" target="_blank">Product Families</a> have been enabled.</p>

The type of the item. \* plan - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \* charge - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge) without being applied to a subscription. \* addon - A recurring component that can be added to a subscription in addition to its plan.

One ofplanaddoncharge

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.

Default false

Specifies if gift subscriptions can be created for this item.

Default false

<p class="mb-2">If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">enabled_for_checkout</code> , then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.</p>

Allow the plan to subscribed to via Checkout. Applies only for plan-items. **Note:** Only the in-app layout of Checkout is supported.

Default true

Allow customers to change their subscription to this plan via the [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html). Applies only for plan-items. This requires the Portal configuration to [allow changing subscriptions](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription) .

Default true

<p class="mb-2">The item is included in MRR calculations for your site. This attribute is only applicable for items of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type = charge</code> 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 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code> .</p>

<p class="mb-2">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 <a href="/docs/api/attached_items/create-an-attached-item">Create</a> or <a href="/docs/api/attached_items/update-an-attached-item">Update an attached item</a> API.</p> * all - <p class="mb-2">all addon-items and charge-items are applicable to this plan-item.</p> * restricted - <p class="mb-2">only the addon-items or charge-items provided in <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">applicable_items</code> can be applied to this plan-item.</p>

One ofallrestrictedDefault "all"

The URL to redirect to once the gift has been claimed by the receiver.

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](/docs/api/hosted_pages) , [invoices](/docs/api/invoices) and [quotes](/docs/api/quotes). Examples follow: * "user" for a cloud-collaboration platform. * "GB" for a data service. * "issue" for a magazine.

<p class="mb-2">Specifies whether the item undergoes metered billing. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, the quantity is calculated from <a href="/docs/api/usages" class="text-blue-600 hover:text-blue-800 underline">usage records</a>. When <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> is as determined while adding an item price to the subscription. Applicable only for items of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon</code> and when <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Metered Billing</a> is enabled. The value of this attribute cannot be changed.</p>

Default false

<p class="mb-2">How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code>. This value overrides the one <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing" target="_blank" rel="noopener noreferrer">set at the site level</a> .</p> * sum_of_usages - <p class="mb-2">the net quantity is the sum of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> of all usages for the current term.</p> * last_usage - <p class="mb-2">from among the usage records for the <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_price_id">item price</a> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">usage_date</code> within the relevant billing period, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> of the usage record with the most recent <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">usage_date</code> is taken as the net quantity consumed.</p> * max_usage - <p class="mb-2">from among the usage records for the <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_price_id">item price</a> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">usage_date</code> within the relevant billing period, the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">quantity</code> of the usage record with the maximum value is taken as the net quantity consumed.</p>

One ofsum_of_usageslast_usagemax_usage

Default false

Timestamp indicating when this item was archived.

The subscription channel this object originated from and is maintained in. \* app_store - The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* web - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* play_store - The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.

One ofwebapp_storeplay_store

A collection of key-value pairs that provides extra information about the item. \[Learn more\](/docs/api/advanced-features#metadata) .

Indicates whether the item has been deleted or not.

The unique ID of the [business entity](/docs/api/business_entities) of this item. This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.

<p class="mb-2">The list of addons and charges that are allowed to be applied to the plan. This attribute is applicable only for plan-items and that too when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_applicability</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">restricted</code> .</p> <p class="mb-2">Other details of attaching items can be specified using the <a href="/docs/api/attached_items/create-an-attached-item">Create</a> or <a href="/docs/api/attached_items/update-an-attached-item">Update an attached item</a> API.</p>

<p class="mb-2">The list of items(plans, addons, and charges) added to the bundle plan. This attribute is only available when the <a href="/docs/api/items/item-object#type">item_type</a> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code> .</p>

<p class="mb-2">This attribute holds additional information about the bundle item. This attribute is only available when the <a href="/docs/api/items/item-object#type">item_type</a> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code> .</p>