younifyd
Menu

List Items

List items

GET/items

Use it in a workflow

  1. Add a step and choose the Chargebee connector.
  2. Pick the List Items action (under Chargebee API).
  3. Fill in the fields below, then reference the result from later steps as {{listItems.response.data}}.

Request

Query parameters

limitinteger (int32)

The number of resources to be returned.

Default 10

offsetstring

<p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always 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">offset</code> to the value 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">next_offset</code> obtained in the previous iteration of the API call.</p>

idobject

optional, string filter Filter items based on item id. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *id\[is\] = "basic"*

isstring
is_notstring
starts_withstring
instring
not_instring
item_family_idobject

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">Filter items based on <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_family_id</code> . <strong class="font-semibold">Supported operators :</strong> is, is_not, starts_with, in, not_in</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">item_family_id[is] = &quot;acme&quot;</em></p>

isstring
is_notstring
starts_withstring
instring
not_instring
typeobject

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter items based on item <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>. Possible values are : plan, addon, charge.</p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is, is_not, in, not_in</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">type[is] = &quot;plan&quot;</em></p>

isstring

\* \`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. \* \`addon\` - A recurring component that can be added to a subscription in addition to its plan. \* \`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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.

One ofplanaddoncharge

is_notstring

\* \`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. \* \`addon\` - A recurring component that can be added to a subscription in addition to its plan. \* \`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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.

One ofplanaddoncharge

instring

\* \`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. \* \`addon\` - A recurring component that can be added to a subscription in addition to its plan. \* \`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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.

One ofplanaddoncharge

not_instring

\* \`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. \* \`addon\` - A recurring component that can be added to a subscription in addition to its plan. \* \`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](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.

One ofplanaddoncharge

nameobject

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">Filter items based on item <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> . <strong class="font-semibold">Supported operators :</strong> is, is_not, starts_with</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">name[is_not] = &quot;basic&quot;</em></p>

isstring
is_notstring
starts_withstring
item_applicabilityobject

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter items based on <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>. Possible values are : all, restricted.</p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is, is_not, in, not_in</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">item_applicability[is_not] = &quot;all&quot;</em></p>

isstring

* `all` - all addon-items and charge-items are applicable to this plan-item. * `restricted` - only the addon-items or charge-items provided in <code>applicable_items</code> can be applied to this plan-item.

One ofallrestricted

is_notstring

* `all` - all addon-items and charge-items are applicable to this plan-item. * `restricted` - only the addon-items or charge-items provided in <code>applicable_items</code> can be applied to this plan-item.

One ofallrestricted

instring

* `all` - all addon-items and charge-items are applicable to this plan-item. * `restricted` - only the addon-items or charge-items provided in <code>applicable_items</code> can be applied to this plan-item.

One ofallrestricted

not_instring

* `all` - all addon-items and charge-items are applicable to this plan-item. * `restricted` - only the addon-items or charge-items provided in <code>applicable_items</code> can be applied to this plan-item.

One ofallrestricted

statusobject

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter items based on item <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">status</code>. Possible values are : active, archived.</p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is, is_not, in, not_in</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">status[is] = &quot;active&quot;</em></p>

isstring

* `active` - The item can be used to create new item prices. * `archived` - The item is no longer active and no new item prices can be created * `deleted` - Indicates that the item has been <a href="./items?prod_cat_ver=2#delete_an_item">deleted</a>. The <code>id</code> and <code>name</code> can be reused. Deleted items can be retrieved using <a href="./items?prod_cat_ver=2#list_items">List items</a>.

One ofactivearchiveddeleted

is_notstring

* `active` - The item can be used to create new item prices. * `archived` - The item is no longer active and no new item prices can be created * `deleted` - Indicates that the item has been <a href="./items?prod_cat_ver=2#delete_an_item">deleted</a>. The <code>id</code> and <code>name</code> can be reused. Deleted items can be retrieved using <a href="./items?prod_cat_ver=2#list_items">List items</a>.

One ofactivearchiveddeleted

instring

* `active` - The item can be used to create new item prices. * `archived` - The item is no longer active and no new item prices can be created * `deleted` - Indicates that the item has been <a href="./items?prod_cat_ver=2#delete_an_item">deleted</a>. The <code>id</code> and <code>name</code> can be reused. Deleted items can be retrieved using <a href="./items?prod_cat_ver=2#list_items">List items</a>.

One ofactivearchiveddeleted

not_instring

* `active` - The item can be used to create new item prices. * `archived` - The item is no longer active and no new item prices can be created * `deleted` - Indicates that the item has been <a href="./items?prod_cat_ver=2#delete_an_item">deleted</a>. The <code>id</code> and <code>name</code> can be reused. Deleted items can be retrieved using <a href="./items?prod_cat_ver=2#list_items">List items</a>.

One ofactivearchiveddeleted

is_giftableobject

optional, boolean filter Specifies if gift subscriptions can be created for this item. Possible values are : *true, false* **Supported operators :** is **Example →** *is_giftable\[is\] = "true"*

isstring (boolean)

One oftruefalse

updated_atobject

optional, timestamp(UTC) in seconds filter Filter items based on when the items were last updated. **Supported operators :** after, before, on, between **Example →** *updated_at\[after\] = "1243545465"*

afterstring (unix-time)
beforestring (unix-time)
onstring (unix-time)
betweenstring
enabled_for_checkoutobject

optional, boolean filter Allow the plan to subscribed to via Checkout. Applies only for plan-items. **Note:** Only the in-app layout of Checkout is supported. Possible values are : *true, false* **Supported operators :** is **Example →** *enabled_for_checkout\[is\] = "null"*

isstring (boolean)

One oftruefalse

enabled_in_portalobject

optional, boolean filter 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). Possible values are : *true, false* **Supported operators :** is **Example →** *enabled_in_portal\[is\] = "null"*

isstring (boolean)

One oftruefalse

meteredobject

<dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn> <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. Possible values are : <em class="italic">true, false</em></p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">metered[is] = &quot;true&quot;</em></p>

isstring (boolean)

One oftruefalse

usage_calculationobject

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <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>. Possible values are : sum_of_usages, last_usage, max_usage.</p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is, is_not, in, not_in</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">usage_calculation[is_not] = &quot;SUM_OF_USAGES&quot;</em></p>

isstring

* `sum_of_usages` - the net quantity is the sum of the <code>quantity</code> of all usages for the current term. * `last_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the most recent <code>usage_date</code> is taken as the net quantity consumed. * `max_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the maximum value is taken as the net quantity consumed.

One ofsum_of_usageslast_usagemax_usage

is_notstring

* `sum_of_usages` - the net quantity is the sum of the <code>quantity</code> of all usages for the current term. * `last_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the most recent <code>usage_date</code> is taken as the net quantity consumed. * `max_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the maximum value is taken as the net quantity consumed.

One ofsum_of_usageslast_usagemax_usage

instring

* `sum_of_usages` - the net quantity is the sum of the <code>quantity</code> of all usages for the current term. * `last_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the most recent <code>usage_date</code> is taken as the net quantity consumed. * `max_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the maximum value is taken as the net quantity consumed.

One ofsum_of_usageslast_usagemax_usage

not_instring

* `sum_of_usages` - the net quantity is the sum of the <code>quantity</code> of all usages for the current term. * `last_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the most recent <code>usage_date</code> is taken as the net quantity consumed. * `max_usage` - from among the usage records for the <a href="/docs/api/subscriptions?prod_cat_ver=2#subscription_subscription_items_item_price_id">item price</a> with <code>usage_date</code> within the relevant billing period, the <code>quantity</code> of the usage record with the maximum value is taken as the net quantity consumed.

One ofsum_of_usageslast_usagemax_usage

channelobject

optional, enumerated string filter The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store. **Supported operators :** is, is_not, in, not_in **Example →** *channel\[is\] = "APP STORE"*

isstring

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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

is_notstring

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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

instring

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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

not_instring

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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

business_entity_idobject

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">The unique ID of the <a href="/docs/api/business_entities">business entity</a> of 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>. <a href="/docs/api/using_business_entity_filters_in_product_catalog_list_apis">Learn more</a> about all the scenarios before using this filter.</p> <span featureId="cb-mbe" isMicro="true"></span> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is, is_present</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">business_entity_id[is_present] = &quot;true&quot;</em></p>

isstring
is_presentstring (boolean)

One oftruefalse

include_site_level_resourcesobject

<dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn> <p class="mb-2">Default value 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">true</code> . To exclude site-level resources in <a href="" target="_blank">specific cases</a>, set this parameter 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">false</code>. Possible values are : <em class="italic">true, false</em></p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">include_site_level_resources[is] = &quot;null&quot;</em></p>

isstring (boolean)

One oftruefalse

sort_byobject

optional, string filter Sorts based on the specified attribute. **Supported attributes :** name, id, updated_at **Supported sort-orders :** asc, desc **Example →** *sort_by\[asc\] = "name"* This will sort the result based on the 'name' attribute in ascending(earliest first) order.

ascstring

One ofnameidupdated_at

descstring

One ofnameidupdated_at

bundle_configurationobject

<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>

typeobject4 fields

Type of the bundle

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

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

chargebee-request-origin-user-encodedstring (email)

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.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

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.

Response

Returns 200 with an object. Read it in later steps with {{listItems.response.data.<field>}}.

listarray<object>
itemobjectrequired29 fields

<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>

next_offsetstring

<p class="mb-2">This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <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">offset</code>.</p>

json
{
  "list": null,
  "next_offset": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.