API Version
Product Catalog
Library

An item price is a price point for an item. It defines the currency, pricing model, price, billing period and other attributes for an item. For example, consider a cloud storage service as an item. Then each of the following defines an item price:

  • The cloud storage sold at USD 10 per month.
  • The same service sold at AUD 100 per year.
  • The service sold at a monthly rate determined by the following stairstep pricing model:
    • 1–10 users for EUR 10
    • 11–25 users for EUR 20
    • 26–50 users for EUR 45
    • 51 and above for EUR 100
The billing period of an item price (only applies to plan-item prices and addon-item prices), is the period of the item price in period_units. An item can have only one item price for a given currency and billing period.

Types of item prices

The type of an item price corresponds to the type of the item that the item price belongs to. In other words, item prices can be of the following types:

  • Plan-item prices
  • Addon-item prices
  • Charge-item prices

Sample item price [ JSON ]

{ "created_at": 1594106928, "currency_code": "USD", "external_name": "silver USD", "free_quantity": 0, "id": "silver-USD-monthly", "is_taxable": true, "item_id": "silver", "item_type": "plan", "name": "silver USD monthly", "object": "item_price", "period": 1, "period_unit": "month", "price": 1000, "pricing_model": "per_unit", "resource_version": 1594106928574, "status": "active", "updated_at": 1594106928 }

API Index URL GET

https://{site}.chargebee.com/api/v2/item_prices

Model Class

id
string, max chars=100
The identifier for the item price. It is unique and immutable.
name
string, max chars=100
A unique display name for the item price in the Chargebee UI. If external_name is not provided, this is also used in customer-facing pages and documents such as invoices and hosted pages.
item_family_id
optional, string, max chars=100
Id of the item_family
item_id
optional, string, max chars=100
The id of the item that the item price belongs to.
description
optional, string, max chars=500
Description of the item price.
Note:
If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.

status
optional, enumerated string
The status of the item price.
Possible values are
activeThe item price can be used in subscriptions.archivedThe 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.deletedIndicates that the item price has been deleted. The id and name can be reused.
Show all values[+]
external_name
optional, string, max chars=100
The name of the item price used in customer-facing pages and documents. These include invoices and hosted pages. If not provided, then name is used
price_variant_id
optional, string, max chars=100

An immutable unique identifier of a price variant.


proration_type
optional, enumerated string
Note

Applicable only for item prices with:

Specifies how to manage charges or credits for the addon item price during a subscription update or estimating a subscription update.

Possible values are
site_defaultUse the site-wide proration setting.partial_termProrate the charges or credits for the rest of the current term.full_termCharge the full price of the addon item price or give the full credit. Don't apply any proration.
Show all values[+]
pricing_model
enumerated string, default=flat_fee

The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.

Possible values are
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThe per unit price is based on the tier that the total quantity falls in.volumeThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
Show all values[+]
price
optional, in cents, min=0
The cost of the item price when the pricing model is flat_fee. When the pricing model is per_unit, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency.
price_in_decimal
optional, string, max chars=39
The price of the item when the pricing_model is flat_fee. When the pricing model is per_unit, 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 multi-decimal pricing is enabled.
period
optional, integer, min=1

  • When the item type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.
  • When item type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.

If subscriptions or invoices exist for this item price, period cannot be changed. The period is mandatory when the item type is plan or addon

currency_code
string, max chars=3
The currency code (ISO 4217 format) for the item price. If subscriptions, invoices or differential prices exist for this item price, currency_code cannot be changed.
period_unit
optional, enumerated string
The unit of time for period. If subscriptions or invoices exist for this item price, period_unit cannot be changed. The period_unit is mandatory when the item type is plan or addon
Possible values are
dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
Show all values[+]
trial_period
optional, integer, min=0
The trial period of the plan in trial_period_units. You can also set trial periods for addons; contact Support to enable that feature.
trial_period_unit
optional, enumerated string
The unit of time for trial_period.
Possible values are
dayA period of 24 hours.monthA period of 1 calendar month.
Show all values[+]
trial_end_action
optional, enumerated string
Applicable only when End-of-trial Action has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type is plan and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level.
Possible values are
site_defaultThe action configured for the site at the time when the trial ends, takes effect.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
Show all values[+]
shipping_period
optional, integer, min=1
Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
shipping_period_unit
optional, enumerated string
Defines the shipping frequency in association with shipping period.
Possible values are
dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
Show all values[+]
billing_cycles
optional, integer, min=1

The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.

Addons can also have billing cycles. However, you must contact Support to enable that. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.

If subscriptions, invoices or differential prices exist for this item price, billing_cycles cannot be changed.

free_quantity
integer, default=0, min=0
Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
free_quantity_in_decimal
optional, string, max chars=33
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 is enabled.
channel
optional, enumerated string
The subscription channel this object originated from and is maintained in.
Possible values are
webThe object was created (and is maintained) for the web channel directly in Chargebee via API or UI.app_storeThe object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.play_storeThe object data is synchronized with data from in-app subscription(s) 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 for more information.
Show all values[+]
resource_version
optional, long
Version number of this resource. The resource_version 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.
updated_at
optional, timestamp(UTC) in seconds
Timestamp indicating when this item price was last updated
created_at
timestamp(UTC) in seconds
Timestamp indicating when this item price was created
archived_at
optional, timestamp(UTC) in seconds
Timestamp indicating when this item price was archived.
invoice_notes
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
is_taxable
optional, boolean, default=true
Specifies whether taxes apply to this item price. This value is set and returned even if Taxes have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
metadata
optional, jsonobject
A collection of key-value pairs that provides extra information about the item price. Learn more.
item_type
optional, enumerated string
Type of item.
Possible values are
planAn 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.addonA recurring component that can be added to a subscription in addition to its plan.chargeA 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.
Show all values[+]
show_description_in_invoices
optional, boolean
Whether the item price's description should be shown on invoice PDFs. If this Boolean is changed, only invoices generated (or regenerated) after the change are affected; past invoices are not.
show_description_in_quotes
optional, boolean
Whether the item price's description should be shown on quote PDFs. If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
optional, list of tier
List of quantity-based pricing tiers for the item price. Applicable only for tiered, volume, and stairstep pricing_models.
optional, tax_detail
The tax details for the item price. Includes those details relevant for third-party integrations.
accounting_detail
Show attributes [+]
optional, accounting_detail
Accounting integration details. The values are typically dependent on the accounting integration used.
id id
string, max chars=100
The identifier for the item price. It is unique and immutable.
name name
string, max chars=100
A unique display name for the item price in the Chargebee UI. If external_name is not provided, this is also used in customer-facing pages and documents such as invoices and hosted pages.
item_family_id item_family_id
optional, string, max chars=100
Id of the item_family
item_id item_id
optional, string, max chars=100
The id of the item that the item price belongs to.
description description
optional, string, max chars=500
Description of the item price.
Note:
If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.

status status
optional, enumerated string
The status of the item price.
external_name external_name
optional, string, max chars=100
The name of the item price used in customer-facing pages and documents. These include invoices and hosted pages. If not provided, then name is used
price_variant_id price_variant_id
optional, string, max chars=100

An immutable unique identifier of a price variant.


proration_type proration_type
optional, enumerated string
Note

Applicable only for item prices with:

Specifies how to manage charges or credits for the addon item price during a subscription update or estimating a subscription update.

pricing_model pricing_model
enumerated string, default=flat_fee

The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.

price price
optional, in cents, min=0
The cost of the item price when the pricing model is flat_fee. When the pricing model is per_unit, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency.
price_in_decimal price_in_decimal
optional, string, max chars=39
The price of the item when the pricing_model is flat_fee. When the pricing model is per_unit, 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 multi-decimal pricing is enabled.
period period
optional, integer, min=1

  • When the item type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.
  • When item type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.

If subscriptions or invoices exist for this item price, period cannot be changed. The period is mandatory when the item type is plan or addon

currency_code currency_code
string, max chars=3
The currency code (ISO 4217 format) for the item price. If subscriptions, invoices or differential prices exist for this item price, currency_code cannot be changed.
period_unit period_unit
optional, enumerated string
The unit of time for period. If subscriptions or invoices exist for this item price, period_unit cannot be changed. The period_unit is mandatory when the item type is plan or addon
trial_period trial_period
optional, integer, min=0
The trial period of the plan in trial_period_units. You can also set trial periods for addons; contact Support to enable that feature.
trial_period_unit trial_period_unit
optional, enumerated string
The unit of time for trial_period.
trial_end_action trial_end_action
optional, enumerated string
Applicable only when End-of-trial Action has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type is plan and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level.
shipping_period shipping_period
optional, integer, min=1
Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
shipping_period_unit shipping_period_unit
optional, enumerated string
Defines the shipping frequency in association with shipping period.
billing_cycles billing_cycles
optional, integer, min=1

The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.

Addons can also have billing cycles. However, you must contact Support to enable that. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.

If subscriptions, invoices or differential prices exist for this item price, billing_cycles cannot be changed.

free_quantity free_quantity
integer, default=0, min=0
Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
free_quantity_in_decimal free_quantity_in_decimal
optional, string, max chars=33
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 is enabled.
channel channel
optional, enumerated string
The subscription channel this object originated from and is maintained in.
resource_version resource_version
optional, long
Version number of this resource. The resource_version 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.
updated_at updated_at
optional, timestamp(UTC) in seconds
Timestamp indicating when this item price was last updated
created_at created_at
timestamp(UTC) in seconds
Timestamp indicating when this item price was created
archived_at archived_at
optional, timestamp(UTC) in seconds
Timestamp indicating when this item price was archived.
invoice_notes invoice_notes
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
is_taxable is_taxable
optional, boolean, default=true
Specifies whether taxes apply to this item price. This value is set and returned even if Taxes have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
metadata
optional, jsonobject
A collection of key-value pairs that provides extra information about the item price. Learn more.
item_type item_type
optional, enumerated string
Type of item.
show_description_in_invoices show_description_in_invoices
optional, boolean
Whether the item price's description should be shown on invoice PDFs. If this Boolean is changed, only invoices generated (or regenerated) after the change are affected; past invoices are not.
show_description_in_quotes show_description_in_quotes
optional, boolean
Whether the item price's description should be shown on quote PDFs. If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
tiers
optional, list of tier
List of quantity-based pricing tiers for the item price. Applicable only for tiered, volume, and stairstep pricing_models.
tax_detail
optional, tax_detail
The tax details for the item price. Includes those details relevant for third-party integrations.
accounting_detail
optional, accounting_detail
Accounting integration details. The values are typically dependent on the accounting integration used.

This API creates an item price (a price point) for an item.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/item_prices \
     -u {site_api_key}:\
     -d id="silver-USD-monthly" \
     -d item_id="silver" \
     -d name="silver USD monthly" \
     -d pricing_model="PER_UNIT" \
     -d price=1000 \
     -d external_name="silver USD" \
     -d period_unit="MONTH" \
     -d period=1
# create an addon item price with tiered pricing model
curl  https://{site}.chargebee.com/api/v2/item_prices \
     -u {site_api_key}:\
     -d id="day-pass-USD-monthly" \
     -d name="Day Pass USD Monthly" \
     -d item_id="day-pass" \
     -d period=1 \
     -d period_unit="MONTH" \
     -d pricing_model="TIERED" \
     -d tiers[starting_unit][0]=1 \
     -d tiers[ending_unit][0]=10 \
     -d tiers[price][0]=100 \
     -d tiers[starting_unit][1]=11 \
     -d tiers[ending_unit][1]=20 \
     -d tiers[price][1]=300 \
     -d tiers[starting_unit][2]=21 \
     -d tiers[price][2]=500 
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "item_price": {
        "created_at": 1594106928,
        "currency_code": "USD",
        "external_name": "silver USD",
        "free_quantity": 0,
        "id": "silver-USD-monthly",
        "is_taxable": true,
        "item_id": "silver",
        "item_type": "plan",
        "name": "silver USD monthly",
        "object": "item_price",
        "period": 1,
        "period_unit": "month",
        "price": 1000,
        "pricing_model": "per_unit",
        "resource_version": 1594106928574,
        "status": "active",
        "updated_at": 1594106928
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/item_prices

Method

id[]
required, string, max chars=100
The identifier for the item price. It is unique and immutable.
name[]
required, string, max chars=100
A unique display name for the item price in the Chargebee UI. If external_name is not provided, this is also used in customer-facing pages and documents such as invoices and hosted pages.
description[]
optional, string, max chars=500
Description of the item price.
Note:
If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
item_id[]
required, string, max chars=100
The id of the item that the item price belongs to.
invoice_notes[]
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
proration_type[]
optional, enumerated string
Note

Applicable only for item prices with:

Specifies how to manage charges or credits for the addon item price during a subscription update or estimating a subscription update.
Possible values are
site_defaultUse the site-wide proration setting.partial_termProrate the charges or credits for the rest of the current term.full_termCharge the full price of the addon item price or give the full credit. Don't apply any proration.
Show all values[+]
external_name[]
optional, string, max chars=100
The name of the item price used in customer-facing pages and documents. These include invoices and hosted pages. If not provided, then name is used.
currency_code[]
optional, string, max chars=3
The currency code (ISO 4217 format) for the item price. Is required when multiple currencies have been enabled.
price_variant_id[]
optional, string, max chars=100

An immutable unique identifier of a price variant.

is_taxable[]
optional, boolean, default=true
Specifies whether taxes apply to this item price. This value is set and returned even if Taxes have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
free_quantity[]
optional, integer, default=0, min=0
Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
free_quantity_in_decimal[]
optional, string, max chars=33
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 is enabled.
metadata[]
optional, jsonobject
A collection of key-value pairs that provides extra information about the item price.
Note: There's a character limit of 65,535.
Learn more.
show_description_in_invoices[]
optional, boolean, default=false
Whether the item price's description should be shown on invoice PDFs. If this Boolean is changed, only invoices generated (or regenerated) after the change are affected; past invoices are not.
show_description_in_quotes[]
optional, boolean, default=false
Whether the item price's description should be shown on quote PDFs. If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
pricing_model[]
optional, enumerated string, default=flat_fee

The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.

Possible values are
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThe per unit price is based on the tier that the total quantity falls in.volumeThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
Show all values[+]
price[]
optional, in cents, min=0
The cost of the item price when the pricing model is flat_fee. When the pricing model is per_unit, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency.
price_in_decimal[]
optional, string, max chars=39
The price of the item when the pricing_model is flat_fee. When the pricing model is per_unit, 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 multi-decimal pricing is enabled.
period_unit[]
optional, enumerated string
The unit of time for period. If subscriptions or invoices exist for this item price, period_unit cannot be changed. The period_unit is mandatory when the item type is plan or addon.
Possible values are
dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
Show all values[+]
period[]
optional, integer, min=1

  • When the item type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.
  • When item type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.

If subscriptions or invoices exist for this item price, period cannot be changed. The period is mandatory when the item type is plan or addon.
trial_period_unit[]
optional, enumerated string
The unit of time for trial_period.
Possible values are
dayA period of 24 hours.monthA period of 1 calendar month.
Show all values[+]
trial_period[]
optional, integer, min=0
The trial period of the plan in trial_period_units. You can also set trial periods for addons; contact Support to enable that feature.
shipping_period[]
optional, integer, min=1
Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
shipping_period_unit[]
optional, enumerated string
Defines the shipping frequency in association with shipping period.
Possible values are
dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
Show all values[+]
billing_cycles[]
optional, integer, min=1

The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.

Addons can also have billing cycles. However, you must contact Support to enable that. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.

If subscriptions, invoices or differential prices exist for this item price, billing_cycles cannot be changed.
trial_end_action[]
optional, enumerated string
Applicable only when End-of-trial Action has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type is plan and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level.
Possible values are
site_defaultThe action configured for the site at the time when the trial ends, takes effect.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
Show all values[+]
tax_detail[tax_profile_id]
optional, string, max chars=50
tax_detail[avalara_tax_code]
optional, string, max chars=50
tax_detail[hsn_code]
optional, string, max chars=50
tax_detail[avalara_sale_type]
optional, enumerated string
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
Show all values[+]
tax_detail[avalara_transaction_type]
optional, integer
tax_detail[avalara_service_type]
optional, integer
tax_detail[taxjar_product_code]
optional, string, max chars=50
accounting_detail[sku]
optional, string, max chars=100
accounting_detail[accounting_code]
optional, string, max chars=100
accounting_detail[accounting_category1]
optional, string, max chars=100
accounting_detail[accounting_category2]
optional, string, max chars=100
accounting_detail[accounting_category3]
optional, string, max chars=100
accounting_detail[accounting_category4]
optional, string, max chars=100
tiers[starting_unit][0..n]
optional, integer, min=1
tiers[ending_unit][0..n]
optional, integer
tiers[price][0..n]
optional, in cents, default=0, min=0
tiers[starting_unit_in_decimal][0..n]
optional, string, max chars=33
tiers[ending_unit_in_decimal][0..n]
optional, string, max chars=33
tiers[price_in_decimal][0..n]
optional, string, max chars=39
item_price item_price
always returned
Resource object representing item_price

Sample admin console URL

https://{site}.chargebee.com/admin-console/item_prices/123x

This API retrieves a specific item price using the id.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/item_prices/basic-USD-monthly \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "item_price": {
        "created_at": 1594106945,
        "currency_code": "USD",
        "external_name": "basic USD",
        "free_quantity": 0,
        "id": "basic-USD-monthly",
        "is_taxable": true,
        "item_id": "basic",
        "item_type": "plan",
        "name": "basic USD monthly",
        "object": "item_price",
        "period": 1,
        "period_unit": "month",
        "price": 1000,
        "pricing_model": "per_unit",
        "resource_version": 1594106945077,
        "status": "active",
        "updated_at": 1594106945
    }
}

URL Format GET

https://{site}.chargebee.com/api/v2/item_prices/{item-price-id}

Method

item_price item_price
always returned
Resource object representing item_price

Sample admin console URL

https://{site}.chargebee.com/admin-console/item_prices/123x

Updates an item price with the changes specified. Unspecified item price attributes are not modified.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/item_prices/scale-USD \
     -u {site_api_key}:\
     -d name="scale USD Yearly" \
     -d price=10000 \
     -d period=1 \
     -d period_unit="YEAR"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "item_price": {
        "created_at": 1594106949,
        "currency_code": "USD",
        "external_name": "scale USD",
        "free_quantity": 0,
        "id": "scale-USD",
        "is_taxable": true,
        "item_id": "scale",
        "item_type": "plan",
        "name": "scale USD Yearly",
        "object": "item_price",
        "period": 1,
        "period_unit": "year",
        "price": 10000,
        "pricing_model": "flat_fee",
        "resource_version": 1594106954802,
        "status": "active",
        "updated_at": 1594106954
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/item_prices/{item-price-id}

Method

name[]
optional, string, max chars=100
A unique display name for the item price in the Chargebee UI. If external_name is not provided, this is also used in customer-facing pages and documents such as invoices and hosted pages.
description[]
optional, string, max chars=500
Description of the item price.
Note:
If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
proration_type[]
optional, enumerated string
Note

Applicable only for item prices with:

Specifies how to manage charges or credits for the addon item price during a subscription update or estimating a subscription update.
Possible values are
site_defaultUse the site-wide proration setting.partial_termProrate the charges or credits for the rest of the current term.full_termCharge the full price of the addon item price or give the full credit. Don't apply any proration.
Show all values[+]
price_variant_id[]
optional, string, max chars=100

An immutable unique identifier of a price variant.

status[]
optional, enumerated string
The status of the item price.
Possible values are
activeThe item price can be used in subscriptions.archivedThe 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.
Show all values[+]
external_name[]
optional, string, max chars=100
The name of the item price used in customer-facing pages and documents. These include invoices and hosted pages. If not provided, then name is used.
currency_code[]
optional, string, max chars=3
The currency code (ISO 4217 format) for the item price. If subscriptions, invoices or differential prices exist for this item price, currency_code cannot be changed.
invoice_notes[]
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
is_taxable[]
optional, boolean, default=true
Specifies whether taxes apply to this item price. This value is set and returned even if Taxes have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
free_quantity[]
optional, integer, default=0, min=0
Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
free_quantity_in_decimal[]
optional, string, max chars=33
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 is enabled.
metadata[]
optional, jsonobject
A collection of key-value pairs that provides extra information about the item price.
Note: There's a character limit of 65,535.
Learn more.
pricing_model[]
optional, enumerated string, default=flat_fee

The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.

Possible values are
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThe per unit price is based on the tier that the total quantity falls in.volumeThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
Show all values[+]
price[]
optional, in cents, min=0
The cost of the item price when the pricing model is flat_fee. When the pricing model is per_unit, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency.
price_in_decimal[]
optional, string, max chars=39
The price of the item when the pricing_model is flat_fee. When the pricing model is per_unit, 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 multi-decimal pricing is enabled.
period_unit[]
optional, enumerated string
The unit of time for period. If subscriptions or invoices exist for this item price, period_unit cannot be changed. The period_unit is mandatory when the item type is plan or addon.
Possible values are
dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
Show all values[+]
period[]
optional, integer, min=1

  • When the item type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.
  • When item type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.

If subscriptions or invoices exist for this item price, period cannot be changed. The period is mandatory when the item type is plan or addon.
trial_period_unit[]
optional, enumerated string
The unit of time for trial_period.
Possible values are
dayA period of 24 hours.monthA period of 1 calendar month.
Show all values[+]
trial_period[]
optional, integer, min=0
The trial period of the plan in trial_period_units. You can also set trial periods for addons; contact Support to enable that feature.
shipping_period[]
optional, integer, min=1
Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
shipping_period_unit[]
optional, enumerated string
Defines the shipping frequency in association with shipping period.
Possible values are
dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
Show all values[+]
billing_cycles[]
optional, integer, min=1

The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.

Addons can also have billing cycles. However, you must contact Support to enable that. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.

If subscriptions, invoices or differential prices exist for this item price, billing_cycles cannot be changed.
trial_end_action[]
optional, enumerated string
Applicable only when End-of-trial Action has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type is plan and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level.
Possible values are
site_defaultThe action configured for the site at the time when the trial ends, takes effect.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
Show all values[+]
show_description_in_invoices[]
optional, boolean
Whether the item price's description should be shown on invoice PDFs. If this Boolean is changed, only invoices generated (or regenerated) after the change are affected; past invoices are not.
show_description_in_quotes[]
optional, boolean
Whether the item price's description should be shown on quote PDFs. If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
tax_detail[tax_profile_id]
optional, string, max chars=50
tax_detail[avalara_tax_code]
optional, string, max chars=50
tax_detail[hsn_code]
optional, string, max chars=50
tax_detail[avalara_sale_type]
optional, enumerated string
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
Show all values[+]
tax_detail[avalara_transaction_type]
optional, integer
tax_detail[avalara_service_type]
optional, integer
tax_detail[taxjar_product_code]
optional, string, max chars=50
accounting_detail[sku]
optional, string, max chars=100
accounting_detail[accounting_code]
optional, string, max chars=100
accounting_detail[accounting_category1]
optional, string, max chars=100
accounting_detail[accounting_category2]
optional, string, max chars=100
accounting_detail[accounting_category3]
optional, string, max chars=100
accounting_detail[accounting_category4]
optional, string, max chars=100
tiers[starting_unit][0..n]
optional, integer, min=1
tiers[ending_unit][0..n]
optional, integer
tiers[price][0..n]
optional, in cents, default=0, min=0
tiers[starting_unit_in_decimal][0..n]
optional, string, max chars=33
tiers[ending_unit_in_decimal][0..n]
optional, string, max chars=33
tiers[price_in_decimal][0..n]
optional, string, max chars=39
item_price item_price
always returned
Resource object representing item_price

Sample admin console URL

https://{site}.chargebee.com/admin-console/item_prices/123x

Returns a list of item prices satisfying all the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/item_prices \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "list": [
        {
            "item_price": {
                "created_at": 1594106932,
                "currency_code": "USD",
                "external_name": "Day Pass USD Monthly",
                "free_quantity": 0,
                "id": "day-pass-USD-monthly",
                "is_taxable": true,
                "item_id": "day-pass",
                "item_type": "addon",
                "name": "Day Pass USD Monthly",
                "object": "item_price",
                "period": 1,
                "period_unit": "month",
                "pricing_model": "tiered",
                "resource_version": 1594106932518,
                "status": "active",
                "tiers": [
                    {
                        "ending_unit": 10,
                        "price": 100,
                        "starting_unit": 1
                    },
                    {..}
                ],
                "updated_at": 1594106932
            }
        },
        {..}
    ]
}

URL Format GET

https://{site}.chargebee.com/api/v2/item_prices

Method

limit[]
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
offset[]
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
sort_by[<sort-order>]
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.
Filter Params
For operator usages, see the Pagination and Filtering section.
id[<operator>]
optional, string filter
Filter item prices based on their id. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example id[is] = "basic_USD"
id[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
id[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
id[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
id[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
id[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
name[<operator>]
optional, string filter
Filter item prices based on their names. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example name[is] = "basic USD"
name[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
name[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
name[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
name[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
name[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
pricing_model[<operator>]
optional, enumerated string filter
Filter item prices based on their pricing_model. Possible values are : flat_fee, per_unit, tiered, volume, stairstep
Supported operators : is, is_not, in, not_in

Example pricing_model[is] = "flat_fee"
pricing_model[is][operator]
optional, enumerated string filter
Possible values are : flat_fee, per_unit, tiered, volume, stairstep
Supported operators :

Example
pricing_model[is_not][operator]
optional, enumerated string filter
Possible values are : flat_fee, per_unit, tiered, volume, stairstep
Supported operators :

Example
pricing_model[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
pricing_model[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
item_id[<operator>]
optional, string filter
Filter item prices based on their item_id. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example item_id[is] = "basic"
item_id[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
item_id[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
item_id[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
item_id[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
item_id[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
item_family_id[<operator>]
optional, string filter
Filter item prices based on item_family_id. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example item_family_id[is] = "Acme"
item_family_id[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
item_family_id[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
item_family_id[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
item_family_id[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
item_family_id[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
item_type[<operator>]
optional, enumerated string filter
Filter item prices based on item_type. Possible values are : plan, addon, charge
Supported operators : is, is_not, in, not_in

Example item_type[is] = "plan"
item_type[is][operator]
optional, enumerated string filter
Possible values are : plan, addon, charge
Supported operators :

Example
item_type[is_not][operator]
optional, enumerated string filter
Possible values are : plan, addon, charge
Supported operators :

Example
item_type[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
item_type[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
currency_code[<operator>]
optional, string filter
Filter item prices based on their currency_code. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example currency_code[is] = "USD"
currency_code[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
currency_code[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
currency_code[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
currency_code[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
currency_code[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
price_variant_id[<operator>]
optional, string filter
Filter item prices based on their price_variant_id. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example price_variant_id[is] = "tamilNadu-India"
price_variant_id[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
price_variant_id[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
price_variant_id[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
price_variant_id[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
price_variant_id[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
trial_period[<operator>]
optional, number filter
Filter item prices based on their trial_period. Possible values are :
Supported operators : is, is_not, lt, lte, gt, gte, between

Example trial_period[is] = "14"
trial_period[is][operator]
optional, number filter
Possible values are :
Supported operators :

Example
trial_period[is_not][operator]
optional, number filter
Possible values are :
Supported operators :

Example
trial_period[lt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
trial_period[lte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
trial_period[gt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
trial_period[gte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
trial_period[between][operator]
optional, string filter
Possible values are :
Supported operators :

Example
trial_period_unit[<operator>]
optional, enumerated string filter
Filter item prices based on their trial_period_unit. Possible values are : day, month
Supported operators : is, is_not, in, not_in

Example trial_period_unit[is] = "day"
trial_period_unit[is][operator]
optional, enumerated string filter
Possible values are : day, month
Supported operators :

Example
trial_period_unit[is_not][operator]
optional, enumerated string filter
Possible values are : day, month
Supported operators :

Example
trial_period_unit[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
trial_period_unit[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
status[<operator>]
optional, enumerated string filter
Filter item prices based on their status. Possible values are : active, archived, deleted
Supported operators : is, is_not, in, not_in

Example status[is] = "active"
status[is][operator]
optional, enumerated string filter
Possible values are : active, archived, deleted
Supported operators :

Example
status[is_not][operator]
optional, enumerated string filter
Possible values are : active, archived, deleted
Supported operators :

Example
status[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
status[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
updated_at[<operator>]
optional, timestamp(UTC) in seconds filter
Filter item prices based on their updated_at. Possible values are :
Supported operators : after, before, on, between

Example updated_at[after] = "1243545465"
updated_at[after][operator]
optional, timestamp(UTC) in seconds filter
Possible values are :
Supported operators :

Example
updated_at[before][operator]
optional, timestamp(UTC) in seconds filter
Possible values are :
Supported operators :

Example
updated_at[on][operator]
optional, timestamp(UTC) in seconds filter
Possible values are :
Supported operators :

Example
updated_at[between][operator]
optional, string filter
Possible values are :
Supported operators :

Example
period_unit[<operator>]
optional, enumerated string filter
Filter item prices based on their period_unit. Possible values are : day, week, month, year
Supported operators : is, is_not, in, not_in

Example period_unit[is] = "month"
period_unit[is][operator]
optional, enumerated string filter
Possible values are : day, week, month, year
Supported operators :

Example
period_unit[is_not][operator]
optional, enumerated string filter
Possible values are : day, week, month, year
Supported operators :

Example
period_unit[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
period_unit[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
period[<operator>]
optional, number filter
Filter item prices based on their period. Possible values are :
Supported operators : is, is_not, lt, lte, gt, gte, between

Example period[is] = "3"
period[is][operator]
optional, number filter
Possible values are :
Supported operators :

Example
period[is_not][operator]
optional, number filter
Possible values are :
Supported operators :

Example
period[lt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
period[lte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
period[gt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
period[gte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
period[between][operator]
optional, string filter
Possible values are :
Supported operators :

Example
channel[<operator>]
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"
channel[is][operator]
optional, enumerated string filter
Possible values are : web, app_store, play_store
Supported operators :

Example
channel[is_not][operator]
optional, enumerated string filter
Possible values are : web, app_store, play_store
Supported operators :

Example
channel[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
channel[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
item_price item_price
always returned
Resource object representing item_price
next_offset next_offset
optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

Sample admin console URL

https://{site}.chargebee.com/admin-console/item_prices/123x

Deletes an item price, marking its status as deleted. If it is part of a subscription or invoice, the item price status is marked archived instead. Once deleted, the id and name of the item price can be reused to create a new item price.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/item_prices/delete-sample/delete \
     -X POST  \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "item_price": {
        "created_at": 1594106936,
        "currency_code": "USD",
        "external_name": "delete sample USD",
        "free_quantity": 0,
        "id": "delete-sample",
        "is_taxable": true,
        "item_id": "scale-test",
        "item_type": "plan",
        "name": "delete sample",
        "object": "item_price",
        "period": 1,
        "period_unit": "month",
        "price": 1000,
        "pricing_model": "per_unit",
        "resource_version": 1594106939944,
        "status": "deleted",
        "updated_at": 1594106939
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/item_prices/{item-price-id}/delete

Method

item_price item_price
always returned
Resource object representing item_price

Sample admin console URL

https://{site}.chargebee.com/admin-console/item_prices/123x
Returns the set of all applicable addon-items for a specific plan-item price. This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the item_applicability and applicable_items defined for the parent item of the plan-item price.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/item_prices/basic-USD-weekly/applicable_items \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "list": [
        {
            "item": {
                "applicable_items": [
                    {
                        "id": "basic"
                    },
                    {..}
                ],
                "enabled_for_checkout": true,
                "enabled_in_portal": true,
                "id": "extra-sms-addon",
                "is_giftable": false,
                "is_shippable": false,
                "item_applicability": "restricted",
                "name": "Extra SMS addon",
                "object": "item",
                "resource_version": 1599817250235,
                "status": "active",
                "type": "addon",
                "updated_at": 1599817250
            }
        },
        {..}
    ]
}

URL Format GET

https://{site}.chargebee.com/api/v2/item_prices/{item-price-id}/applicable_items

Method

limit[]
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
offset[]
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
sort_by[<sort-order>]
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.
item item
always returned
Resource object representing item
next_offset next_offset
optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

Sample admin console URL

https://{site}.chargebee.com/admin-console/item_prices/123x
Returns the set of all applicable addon-item prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:

Note

If an addon-item price has differential pricing defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/item_prices/basic-USD-weekly/applicable_item_prices \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "list": [
        {
            "item_price": {
                "id": "extra-sms-USD-daily",
                "name": "Extra SMS USD Daily",
                "item_family_id": "Product-Family",
                "item_id": "extra-sms-addon",
                "status": "active",
                "external_name": "Extra SMS USD Daily",
                "pricing_model": "flat_fee",
                "price": 2000,
                "period": 1,
                "currency_code": "USD",
                "period_unit": "day",
                "free_quantity": 0,
                "channel": "web",
                "resource_version": 1634889942715,
                "updated_at": 1634889942,
                "created_at": 1634889942,
                "is_taxable": true,
                "item_type": "addon",
                "show_description_in_invoices": false,
                "show_description_in_quotes": false,
                "object": "item_price"
            }
        },
        {..}
    ]
}

URL Format GET

https://{site}.chargebee.com/api/v2/item_prices/{item-price-id}/applicable_item_prices

Method

limit[]
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
offset[]
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
item_id[]
optional, string, max chars=100
The id of the item that the item price belongs to.
sort_by[<sort-order>]
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.
item_price item_price
always returned
Resource object representing item_price
next_offset next_offset
optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

Sample admin console URL

https://{site}.chargebee.com/admin-console/item_prices/123x