GET /items

Returns a list of items satisfying all the conditions specified in the filter parameters below. The list is sorted by 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
`is_giftable`	Object	No	optional, boolean filterSpecifies if gift subscriptions can be created for this item. Possible values are : true, false Supported operators : isExample → is_giftable[is] = "true"
`business_entity_id`	Object	No	optional, string filterThe unique ID of the business entity of this `item`. 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 items based on item `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 items based on when the items were last updated.Supported operators : after, before, on, betweenExample → updated_at[after] = "1243545465"
`enabled_for_checkout`	Object	No	optional, boolean filterAllow the plan to subscribed to via Checkout. Applies only for plan-items. Note: Only the in-app version of Checkout is supported for Product Catalog v2. Possible values are : true, false Supported operators : isExample → enabled_for_checkout[is] = "null"
`metered`	Object	No	optional, boolean filterSpecifies whether the item undergoes metered billing. When `true`, the quantity is calculated from usage records. When `false`, the `quantity` is as determined while adding an item price to the subscription. Applicable only for items of `type` `plan` or `addon` and when Metered Billing is enabled. The value of this attribute cannot be changed. Possible values are : true, falseSupported operators : isExample → metered[is] = "true"
`id`	Object	No	optional, string filterFilter items based on item id.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "basic"
`usage_calculation`	Object	No	optional, enumerated string filterHow the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is `metered`. This value overrides the one set at the site level. . Possible values are : sum_of_usages, last_usage, max_usage.Supported operators : is, is_not, in, not_inExample → usage_calculation[is_not] = "SUM_OF_USAGES"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`name`	Object	No	optional, string filterFilter items based on item `name`.Supported operators : is, is_not, starts_withExample → name[is_not] = "basic"
`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"
`bundle_configuration`	Object	No	Parameters of `bundle_configuration`
`type`	Object	No	optional, enumerated string filterFilter items based on item `type`. Possible values are : plan, addon, charge.Supported operators : is, is_not, in, not_inExample → type[is] = "plan"
`item_applicability`	Object	No	optional, enumerated string filterFilter items based on `item_applicability`. Possible values are : all, restricted.Supported operators : is, is_not, in, not_inExample → item_applicability[is_not] = "all"
`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_family_id`	Object	No	optional, string filterFilter items based on `item_family_id`.Supported operators : is, is_not, starts_with, in, not_inExample → item_family_id[is] = "acme"
`enabled_in_portal`	Object	No	optional, boolean filterAllow customers to change their subscription to this plan via the Self-Serve Portal. Applies only for plan-items. This requires the Portal configuration to allow changing subscriptions. Possible values are : true, false Supported operators : isExample → enabled_in_portal[is] = "null"
`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.