Introducing the Better Auth Chargebee plugin: Use it to handle subscriptions, billing, and auth seamlessly.
Chargebeechargebee API

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

Use Cases

Sample Request

Sample Result[JSON]

URL Format

GET https://[site].chargebee.com/api/v2/item_prices

Input Parameters

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

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 . Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "basic_USD"

Supported operators: is, is_not, starts_with, in, not_in
Example → basic_USD
name[<operator>]

optional, string filter

Filter item prices based on their name s. Supported operators : is, is_not, starts_with, in, not_in

Example → name[is] = "basic USD"

Supported operators: is, is_not, starts_with, in, not_in
Example → basic USD
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"

Supported operators: is, is_not, in, not_in
Example → flat_fee
item_id[<operator>]

optional, string filter

Filter item prices based on their item_id . Supported operators : is, is_not, starts_with, in, not_in

Example → item_id[is] = "basic"

Supported operators: is, is_not, starts_with, in, not_in
Example → basic
item_family_id[<operator>]

optional, string filter

Filter item prices based on item_family_id . Supported operators : is, is_not, starts_with, in, not_in

Example → item_family_id[is] = "Acme"

Supported operators: is, is_not, starts_with, in, not_in
Example → Acme
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_not] = "plan"

Supported operators: is, is_not, in, not_in
Example → plan
currency_code[<operator>]

optional, string filter

Filter item prices based on their currency_code . Supported operators : is, is_not, starts_with, in, not_in

Example → currency_code[is_not] = "USD"

Supported operators: is, is_not, starts_with, in, not_in
Example → USD
price_variant_id[<operator>]

optional, string filter

Filter item prices based on their price_variant_id . Supported operators : is, is_not, starts_with, in, not_in

Example → price_variant_id[is] = "tamilNadu-India"

Supported operators: is, is_not, starts_with, in, not_in
Example → tamilNadu-India
trial_period[<operator>]

optional, integer filter

Filter item prices based on their trial_period . Supported operators : is, is_not, lt, lte, gt, gte, between

Example → trial_period[is] = "14"

Supported operators: is, is_not, lt, lte, gt, gte, between
Example → 14
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"

Supported operators: is, is_not, in, not_in
Example → day
status[<operator>]

optional, enumerated string filter

Filter item prices based on their status. Possible values are : active, archived.

Supported operators : is, is_not, in, not_in

Example → status[is] = "active"

Supported operators: is, is_not, in, not_in
Example → active
updated_at[<operator>]

optional, timestamp(UTC) in seconds filter

Filter item prices based on their updated_at . Supported operators : after, before, on, between

Example → updated_at[after] = "1243545465"

Supported operators: after, before, on, between
Example → 1243545465
business_entity_id[<operator>]

optional, string filter

The unique ID of the business entity of this item_price. Learn more about all the scenarios before using this filter.

Supported operators : is, is_present

Example → business_entity_id[is_present] = "true"

Supported operators: is, is_present
Example → business_entity_id
include_site_level_resources[<operator>]

optional, boolean filter

Default value is true . To exclude site-level resources in specific cases, set this parameter to false. Possible values are : true, false

Supported operators : is

Example → include_site_level_resources[is] = "null"

Supported operators: is
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"

Supported operators: is, is_not, in, not_in
Example → month
period[<operator>]

optional, integer filter

Filter item prices based on their period . Supported operators : is, is_not, lt, lte, gt, gte, between

Example → period[is] = "3"

Supported operators: is, is_not, lt, lte, gt, gte, between
Example → 3
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"

Supported operators: is, is_not, in, not_in
Example → APP STORE

Returns

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.

item_price
Item price object
Resource object representing item_price