List Item Prices

The number of resources to be returned.

Default 10

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

optional, string filter Filter item prices based on their [id](/docs/api/item_prices) . **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *id\[is\] = "basic_USD"*

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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> s. <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">name[is] = &quot;basic USD&quot;</em></p>

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">pricing_model</code>. Possible values are : flat_fee, per_unit, tiered, volume, stairstep.</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">pricing_model[is] = &quot;flat_fee&quot;</em></p>

\* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.

One offlat_feeper_unittieredvolumestairstep

\* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.

One offlat_feeper_unittieredvolumestairstep

\* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.

One offlat_feeper_unittieredvolumestairstep

\* \`flat_fee\` - A fixed price that is not quantity-based. \* \`per_unit\` - A fixed price per unit quantity. \* \`tiered\` - The per unit price is based on the tier that the total quantity falls in. \* \`volume\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* \`stairstep\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.

One offlat_feeper_unittieredvolumestairstep

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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> . <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_id[is] = &quot;basic&quot;</em></p>

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">Filter item prices 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>

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter item prices 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_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">item_type[is_not] = &quot;plan&quot;</em></p>

\* \`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

\* \`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

\* \`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

\* \`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

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">currency_code</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">currency_code[is_not] = &quot;USD&quot;</em></p>

<dfn class="text-muted"><p class="mb-2">optional, string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">price_variant_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">price_variant_id[is] = &quot;tamilNadu-India&quot;</em></p>

<dfn class="text-muted"><p class="mb-2">optional, integer filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">trial_period</code> . <strong class="font-semibold">Supported operators :</strong> is, is_not, lt, lte, gt, gte, between</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">trial_period[is] = &quot;14&quot;</em></p>

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">trial_period_unit</code>. Possible values are : day, month.</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">trial_period_unit[is] = &quot;day&quot;</em></p>

\* \`day\` - A period of 24 hours. \* \`month\` - A period of 1 calendar month.

One ofdaymonth

\* \`day\` - A period of 24 hours. \* \`month\` - A period of 1 calendar month.

One ofdaymonth

\* \`day\` - A period of 24 hours. \* \`month\` - A period of 1 calendar month.

One ofdaymonth

\* \`day\` - A period of 24 hours. \* \`month\` - A period of 1 calendar month.

One ofdaymonth

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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>

* `active` - The item price can be used in subscriptions. * `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price. * `deleted` - Indicates that the item price has been deleted. The <code>id</code> and <code>name</code> can be reused.

One ofactivearchiveddeleted

* `active` - The item price can be used in subscriptions. * `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price. * `deleted` - Indicates that the item price has been deleted. The <code>id</code> and <code>name</code> can be reused.

One ofactivearchiveddeleted

* `active` - The item price can be used in subscriptions. * `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price. * `deleted` - Indicates that the item price has been deleted. The <code>id</code> and <code>name</code> can be reused.

One ofactivearchiveddeleted

* `active` - The item price can be used in subscriptions. * `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price. * `deleted` - Indicates that the item price has been deleted. The <code>id</code> and <code>name</code> can be reused.

One ofactivearchiveddeleted

<dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">updated_at</code> . <strong class="font-semibold">Supported operators :</strong> after, before, on, between</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">updated_at[after] = &quot;1243545465&quot;</em></p>

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

One oftruefalse

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

One oftruefalse

<dfn class="text-muted"><p class="mb-2">optional, enumerated string filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">period_unit</code>. Possible values are : day, week, month, year.</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">period_unit[is] = &quot;month&quot;</em></p>

\* \`day\` - A period of 24 hours. \* \`week\` - A period of 7 days. \* \`month\` - A period of 1 calendar month. \* \`year\` - A period of 1 calendar year.

One ofdayweekmonthyear

\* \`day\` - A period of 24 hours. \* \`week\` - A period of 7 days. \* \`month\` - A period of 1 calendar month. \* \`year\` - A period of 1 calendar year.

One ofdayweekmonthyear

\* \`day\` - A period of 24 hours. \* \`week\` - A period of 7 days. \* \`month\` - A period of 1 calendar month. \* \`year\` - A period of 1 calendar year.

One ofdayweekmonthyear

\* \`day\` - A period of 24 hours. \* \`week\` - A period of 7 days. \* \`month\` - A period of 1 calendar month. \* \`year\` - A period of 1 calendar year.

One ofdayweekmonthyear

<dfn class="text-muted"><p class="mb-2">optional, integer filter</p></dfn> <p class="mb-2">Filter item prices based on their <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">period</code> . <strong class="font-semibold">Supported operators :</strong> is, is_not, lt, lte, gt, gte, between</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">period[is] = &quot;3&quot;</em></p>

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

\* \`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

\* \`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

\* \`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

\* \`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

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.

One ofnameidupdated_at

One ofnameidupdated_at

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

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.

<div class="api-description"><p class="mb-2">An item price is a price point for an item. It defines the currency, pricing model, price, billing period and other attributes for an <a href="/docs/api/items">item</a>. For example, consider a cloud storage service as an item. Then each of the following defines an item price:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"> <p class="mb-2">The cloud storage sold at USD 10 per month.</p> </li> <li class="text-base leading-relaxed"> <p class="mb-2">The same service sold at AUD 100 per year.</p> </li> <li class="text-base leading-relaxed"> <p class="mb-2">The service sold at a monthly rate determined by the following <a href="https://www.chargebee.com/docs/2.0/plans.html#pricing-models" target="_blank">stairstep</a> pricing model:</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">1-10 users for EUR 10</li> <li class="text-base leading-relaxed">11-25 users for EUR 20</li> <li class="text-base leading-relaxed">26-50 users for EUR 45</li> <li class="text-base leading-relaxed">51 and above for EUR 100</li> </ul> </li> </ul><h2>Types of item prices</h2><p class="mb-2">The type of an item price corresponds to the <a href="/docs/api/items">type of the item</a> that the item price belongs to. In other words, item prices can be of the following types:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Plan-item prices</li> <li class="text-base leading-relaxed">Addon-item prices</li> <li class="text-base leading-relaxed">Charge-item prices</li> </ul><h2>Billing periods for item prices</h2><p class="mb-2">The <strong class="font-semibold">billing period</strong> of an item price (applicable only to plan-item prices and addon-item prices) is the <a href="/docs/api/item_prices/item-price-object#period" class="text-blue-600 hover:text-blue-800 underline"><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">period</code></a> of the item price in <a href="/docs/api/item_prices/item-price-object#period_unit" class="text-blue-600 hover:text-blue-800 underline"><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">period_unit</code></a>s.</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">When <a href="/docs/api/price_variants" class="text-blue-600 hover:text-blue-800 underline">price variants</a> are <strong class="font-semibold">not</strong> enabled, an item can have only one item price for a given currency and billing period.</li> <li class="text-base leading-relaxed">When price variants <strong class="font-semibold">are</strong> enabled, an item can have multiple item prices for the same currency and billing period, as long as each has a distinct <a href="/docs/api/item_prices/item-price-object#price_variant_id" class="text-blue-600 hover:text-blue-800 underline"><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">price_variant_id</code></a>. An item price created without a <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">price_variant_id</code> is treated as the default (&quot;no variant&quot;), and only one such default item price can exist for a given currency and billing period.</li> </ul></div>

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