GET /item_prices

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.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	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.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	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.

Query parameters

Name	Type	Required	Description
`trial_period_unit`	Object	No	optional, enumerated string filterFilter item prices based on their `trial_period_unit`. Possible values are : day, month.Supported operators : is, is_not, in, not_inExample → trial_period_unit[is] = "day"
`pricing_model`	Object	No	optional, enumerated string filterFilter item prices based on their `pricing_model`. Possible values are : flat_fee, per_unit, tiered, volume, stairstep.Supported operators : is, is_not, in, not_inExample → pricing_model[is] = "flat_fee"
`currency_code`	Object	No	optional, string filterFilter item prices based on their `currency_code`.Supported operators : is, is_not, starts_with, in, not_inExample → currency_code[is_not] = "USD"
`price_variant_id`	Object	No	optional, string filterFilter item prices based on their `price_variant_id`.Supported operators : is, is_not, starts_with, in, not_inExample → price_variant_id[is] = "tamilNadu-India"
`trial_period`	Object	No	optional, integer filterFilter item prices based on their `trial_period`.Supported operators : is, is_not, lt, lte, gt, gte, betweenExample → trial_period[is] = "14"
`business_entity_id`	Object	No	optional, string filterThe unique ID of the business entity of this `item_price`. Learn more about all the scenarios before using this filter. Supported operators : is, is_presentExample → business_entity_id[is_present] = "true"
`status`	Object	No	optional, enumerated string filterFilter item prices based on their `status`. Possible values are : active, archived, deleted.Supported operators : is, is_not, in, not_inExample → status[is] = "active"
`updated_at`	Object	No	optional, timestamp(UTC) in seconds filterFilter item prices based on their `updated_at`.Supported operators : after, before, on, betweenExample → updated_at[after] = "1243545465"
`id`	Object	No	optional, string filterFilter item prices based on their id.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "basic_USD"
`period_unit`	Object	No	optional, enumerated string filterFilter item prices based on their `period_unit`. Possible values are : day, week, month, year.Supported operators : is, is_not, in, not_inExample → period_unit[is] = "month"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`name`	Object	No	optional, string filterFilter item prices based on their `name`s.Supported operators : is, is_not, starts_with, in, not_inExample → name[is] = "basic USD"
`channel`	Object	No	optional, enumerated string filterThe 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_inExample → channel[is] = "APP STORE"
`period`	Object	No	optional, integer filterFilter item prices based on their `period`.Supported operators : is, is_not, lt, lte, gt, gte, betweenExample → period[is] = "3"
`include_site_level_resources`	Object	No	optional, boolean filter Default value is `true` . To exclude site-level resources in specific cases, set this parameter to `false`. Possible values are : true, falseSupported operators : isExample → include_site_level_resources[is] = "null"
`item_type`	Object	No	optional, enumerated string filterFilter item prices based on `item_type`. Possible values are : plan, addon, charge.Supported operators : is, is_not, in, not_inExample → item_type[is_not] = "plan"
`item_family_id`	Object	No	optional, string filterFilter item prices based on `item_family_id`.Supported operators : is, is_not, starts_with, in, not_inExample → item_family_id[is] = "Acme"
`item_id`	Object	No	optional, string filterFilter item prices based on their `item_id`.Supported operators : is, is_not, starts_with, in, not_inExample → item_id[is] = "basic"
`sort_by`	Object	No	optional, string filterSorts based on the specified attribute. Supported attributes : name, id, updated_atSupported sort-orders : asc, descExample → sort_by[asc] = "name"This will sort the result based on the 'name' attribute in ascending(earliest first) order.
`offset`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.