Retrieve An Item Price

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>

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

<p class="mb-2">A unique display name for the item price in the Chargebee UI. 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">external_name</code> is not provided, this is also used in customer-facing pages and documents such as <a href="/docs/api/invoices">invoices</a> and <a href="/docs/api/hosted_pages">hosted pages</a> .</p>

Id of the item_family

The id of the item that the item price belongs to.

<p class="mb-2">Description of the item price.</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 price.</p> * archived - <p class="mb-2">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.</p> * active - <p class="mb-2">The item price can be used in subscriptions.</p> * deleted - <p class="mb-2">Indicates that the item price has been deleted. 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.</p>

One ofactivearchiveddeleted

<p class="mb-2">The name of the item price used in customer-facing pages and documents. These include <a href="/docs/api/invoices">invoices</a> and <a href="/docs/api/hosted_pages">hosted pages</a>. If not provided, then <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> is used</p>

An immutable unique identifier of a [price variant](/docs/api/price_variants).

<div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong> Applicable only for item prices with:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code><a href="/docs/api/item_prices/item_price-object#item_type">item_type</a></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>.</li> <li class="text-base leading-relaxed"><code><a href="/docs/api/item_prices/item_price-object#pricing_model">pricing_model</a></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">per_unit</code>.</li> </ul></div> <p class="mb-2">Specifies how to manage charges or credits for the addon item price during a <a href="/docs/api/subscriptions/update-subscription-for-items">subscription update</a> or <a href="/docs/api/estimates/estimate-for-updating-a-subscription">estimating</a> a subscription update.</p> * site_default - <p class="mb-2">Use the <a href="https://www.chargebee.com/docs/2.0/proration.html#proration-for-subscription-change" target="_blank">site-wide proration setting</a> .</p> * partial_term - <p class="mb-2">Prorate the charges or credits for the rest of the current term.</p> * full_term - <p class="mb-2">Charge the full price of the addon item price or give the full credit. Don&#x27;t apply any proration.</p>

One ofsite_defaultpartial_termfull_term

<p class="mb-2">The <a href="https://www.chargebee.com/docs/2.0/plans.html#pricing-models" target="_blank">pricing scheme</a> for this item price. If subscriptions, invoices or <a href="/docs/api/differential_prices">differential prices</a> exist for this item price, <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> cannot be changed.</p> * tiered - <p class="mb-2">There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.</p> * per_unit - <p class="mb-2">A fixed price per unit quantity.</p> * flat_fee - <p class="mb-2">A fixed price that is not quantity-based.</p> * volume - <p class="mb-2">The per unit price is based on the tier that the total quantity falls in.</p> * stairstep - <p class="mb-2">A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.</p>

One offlat_feeper_unittieredvolumestairstepDefault "flat_fee"

<p class="mb-2">The cost of the item price when the pricing model 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">flat_fee</code>. When the pricing model 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">per_unit</code> , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the <a href="/docs/api/currencies">minor unit of the currency</a> .</p>

<p class="mb-2">The price of the item when the pricing_model 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">flat_fee</code>. When the pricing model 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">per_unit</code> , it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when <a href="/docs/api/currencies" target="_blank">multi-decimal pricing</a> is enabled.</p>

<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">When the 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> 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>: The billing period of the plan 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">period_unit</code>s. For example, create a 6 month plan by providing <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> as 6 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">period_unit</code> as month.</li> <li class="text-base leading-relaxed">When 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> 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">addon</code>: The period of the addon 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">period_unit</code>s. For example, create an addon with a 2 month <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> by providing period as 2 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">period_unit</code> as <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">month</code>. The period of an addon is the duration for which its <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</code> applies. When attached to a plan, the addon is billed for the billing period of the plan. <a href="https://www.chargebee.com/docs/2.0/addons-billingcycle.html" target="_blank">Learn more.</a></li> </ul> <p class="mb-2">If subscriptions or invoices exist for this item price, <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> cannot be changed. 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">period</code> is mandatory when the 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> 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> 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></p>

<p class="mb-2">The currency code (<a href="https://www.chargebee.com/docs/2.0/supported-currencies.html" target="_blank">ISO 4217 format</a> ) for the item price. If subscriptions, invoices or <a href="/docs/api/differential_prices">differential prices</a> exist for this item price, <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> cannot be changed.</p>

<p class="mb-2">The unit of time 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">period</code>. If subscriptions or invoices exist for this item price, <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> cannot be changed. 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">period_unit</code> is mandatory when the 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> 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> 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></p> * month - <p class="mb-2">A period of 1 calendar month.</p> * day - <p class="mb-2">A period of 24 hours.</p> * week - <p class="mb-2">A period of 7 days.</p> * year - <p class="mb-2">A period of 1 calendar year.</p>

One ofdayweekmonthyear

<p class="mb-2">The trial period of the plan 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">trial_period_unit</code> s. You can also set <a href="https://www.chargebee.com/docs/2.0/addons-trial.html">trial periods for addons</a> ; contact <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Support</a> to enable that feature.</p>

<p class="mb-2">The unit of time 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">trial_period</code> .</p> * month - <p class="mb-2">A period of 1 calendar month.</p> * day - <p class="mb-2">A period of 24 hours.</p>

One ofdaymonth

<p class="mb-2">Applicable only when <a href="https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">End-of-trial Action</a> has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever 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">item.type</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">plan</code> and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the <a href="/docs/api/subscriptions/subscription-object#trial_end_action">subscription-level</a> .</p> * cancel_subscription - <p class="mb-2">The subscription cancels.</p> * activate_subscription - <p class="mb-2">The subscription activates and charges are raised for non-metered items.</p> * site_default - <p class="mb-2">The action <a href="https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions" target="_blank">configured for the site</a> at the time when the trial ends, takes effect.</p>

One ofsite_defaultactivate_subscriptioncancel_subscription

Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.

Defines the shipping frequency in association with shipping period. \* year - A period of 1 calendar year. \* day - A period of 24 hours. \* week - A period of 7 days. \* month - A period of 1 calendar month.

One ofdayweekmonthyear

<p class="mb-2">The default number of billing cycles a subscription to the plan must run. Can be <a href="/docs/api/subscriptions">overridden</a> for a subscription. Addons can also <a href="https://www.chargebee.com/docs/2.0/addons-billingcycle.html" target="_blank">have billing cycles</a>. Also, for addons, you can <a href="/docs/api/attached_items">override this</a> while attaching it to a plan. However, if you provide the value while <a href="/docs/api/subscriptions/subscription-object#subscription_items_item_type">applying the addon to a subscription</a>, then that value takes still higher precedence. If subscriptions, invoices or <a href="/docs/api/differential_prices">differential prices</a> exist for this item price, <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">billing_cycles</code> cannot be changed.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> If you want to change 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">billing_cycles</code> to unlimited renewals, enter an empty string. This value can only be updated if 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">item_price</code> is not attached to a subscription or invoice. If no <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">billing_cycles</code> value is entered, then by default the value will be set as unlimited <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">billing_cycles</code> renewals.</p></div>

<p class="mb-2">Free quantity the subscriptions of this <strong class="font-semibold">plan</strong> <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> will have. Only the quantity exceeding this value will be charged in the subscription.</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"><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">free_quantity</code> is currently supported only for <a href="/docs/api/items/item-object#type" class="text-blue-600 hover:text-blue-800 underline">plan</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">item_price</code>.</li> <li class="text-base leading-relaxed"><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">free_quantity</code> is not supported for the <a href="https://www.chargebee.com/docs/2.0/understanding-usages.html">Usage-Based Billing</a> (UBB). All included or free quantities should be configured exclusively through <a href="/docs/api/entitlements">entitlements</a> .</li> </ul></div>

Default 0

The quantity of the item that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/currencies) is enabled.

The subscription channel this object originated from and is maintained in. \* 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)](/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)](/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

<p class="mb-2">Version number of this resource. 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">resource_version</code> is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>

Timestamp indicating when this item price was last updated

Timestamp indicating when this item price was created

<p class="mb-2">Specifies the frequency at which the usage counter needs to be reset.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> Changes to 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">usage_accumulation_reset_frequency</code> parameter 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">item_price</code> is not allowed if 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">item</code> is already linked to a subscription.</p></div> * never - <p class="mb-2">Accumulates usage without ever resetting it.</p> * subscription_billing_frequency - <p class="mb-2">Accumulates usage until the subscription&#x27;s billing frequency ends.</p>

One ofneversubscription_billing_frequency

Timestamp indicating when this item price was archived.

A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes) displayed on the invoice PDF.

Specifies whether taxes apply to this item price. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html) have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.

Default true

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

Type of item. \* 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. \* 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.

One ofplanaddoncharge

Whether the item price's description should be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf). If this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice) ) after the change are affected; past invoices are not.

Whether the item price's description should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf). If this Boolean is changed, only quotes created after the change are affected; past quotes are not.

Indicates whether the item price has been deleted ot not.

<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_family</code>. 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> <span featureId="cb-mbe" isMicro="true"></span>

<p class="mb-2">List of quantity-based pricing tiers for the item price. Applicable only 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">tiered</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">volume</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">stairstep</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">pricing_models</code> .</p>

The tax details for the item price. Includes those details relevant for third-party integrations.

List of vendor specific tax related information.