Creates a new item.
Sample Request
URL Format
Input Parameters
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.
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.
A recurring component that can be added to a subscription in addition to its plan.
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 without being applied to a subscription.
Description of the item. This is visible only in Chargebee and not to customers.
Note:
- The description field supports up to 2000 characters, including HTML tags. The inner text (excluding HTML tags) must not exceed 500 characters.
For example:
- testing - desc.
Total with tags: 38 characters,
inner text: 'testing desc' (12 characters). - 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.
The id
of the Item family
that the item belongs to. Is mandatory when Product Families
have been enabled.
Specifies if gift subscriptions can be created for this item.
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.
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. Only the in-app version of the Portal is supported for Product Catalog v2.
If enabled_for_checkout
, then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
Allow the plan to subscribed to via Checkout. Applies only for plan-items. Note: Only the in-app layout of Checkout is supported.
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 Create or Update an attached item API.
all addon-items and charge-items are applicable to this plan-item.
only the addon-items or charge-items provided in applicable_items
can be applied to this plan-item.
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 or 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 , invoices and 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.
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
.
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.
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.
.
the net quantity is the sum of the quantity
of all usages for the current term.
from among the usage records for the item price
with usage_date
within the relevant billing period, the quantity
of the usage record with the most recent usage_date
is taken as the net quantity consumed.
from among the usage records for the item price
with usage_date
within the relevant billing period, the quantity
of the usage record with the maximum value is taken as the net quantity consumed.
A collection of key-value pairs that provides extra information about the item.
Note: There's a character limit of 65,535.
The unique ID of the business entity
for this item.
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 business_entity_id
will not be included in the API response.
Note An alternative way of passing this parameter is by means of a custom HTTP header.
Returns
Resource object representing item