Pricing Templates
Log in Sign up
Integrations / Chargebee Product / ...

POST /exports/items

This API triggers export of item data. The exported zip file contains CSV files with item-related data.

Servers

Request headers

Name Type Required Description
chargebee-request-origin-device String No

The device from which the customer has made the request
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"
chargebee-event-webhook String No

skip only webhooks

Valid values:

  • "all-disabled"
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-event-actions String No

skip all actions to be done on the events

Valid values:

  • "all-disabled"
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.
chargebee-event-email String No

skip only emails

Valid values:

  • "all-disabled"

Request body fields

Name Type Required Description
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"
business_entity_id.is_present String No

null

Valid values:

  • "false"
  • "true"
business_entity_id.is String No
item Object No

Parameters for item
item.is_giftable Object No

Specifies if gift subscriptions can be created for this item.
item.is_giftable.is String No

Valid values:

  • "false"
  • "true"
item.status Object No

Filter items based on item status.
item.status.not_in String No
item.status.in String No
item.status.is_not String No
  • active - The item can be used to create new item prices.
  • archived - The item is no longer active and no new item prices can be created
  • deleted - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.

Valid values:

  • "active"
  • "deleted"
  • "archived"
item.status.is String No
  • active - The item can be used to create new item prices.
  • archived - The item is no longer active and no new item prices can be created
  • deleted - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.

Valid values:

  • "active"
  • "deleted"
  • "archived"
item.updated_at Object No

Filter items based on when the items were last updated.
item.updated_at.on String No
item.updated_at.after String No
item.updated_at.between String No
item.updated_at.before String No
item.enabled_for_checkout Object No

Allow 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.
item.enabled_for_checkout.is String No

Valid values:

  • "false"
  • "true"
item.metered Object No

Specifies 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.
item.metered.is String No

Valid values:

  • "false"
  • "true"
item.id Object No

Filter items based on item id.
item.id.not_in String No
item.id.starts_with String No
item.id.in String No
item.id.is_not String No
item.id.is String No
item.usage_calculation Object No

How 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.
item.usage_calculation.not_in String No
item.usage_calculation.in String No
item.usage_calculation.is_not String No
  • sum_of_usages - the net quantity is the sum of the quantity of all usages for the current term.
  • last_usage - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.
  • max_usage - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.

Valid values:

  • "max_usage"
  • "sum_of_usages"
  • "last_usage"
item.usage_calculation.is String No
  • sum_of_usages - the net quantity is the sum of the quantity of all usages for the current term.
  • last_usage - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.
  • max_usage - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.

Valid values:

  • "max_usage"
  • "sum_of_usages"
  • "last_usage"
item.name Object No

Filter items based on item name.
item.name.starts_with String No
item.name.is_not String No
item.name.is String No
item.channel Object No

The subscription channel this object originated from and is maintained in.
item.channel.not_in String No
item.channel.in String No
item.channel.is_not String No

* `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) 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) 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.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
item.channel.is String No

* `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) 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) 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.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
item.type Object No

Filter items based on item type.
item.type.not_in String No
item.type.in String No
item.type.is_not String No

* `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. * `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 without being applied to a subscription.

Valid values:

  • "plan"
  • "charge"
  • "addon"
item.type.is String No

* `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. * `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 without being applied to a subscription.

Valid values:

  • "plan"
  • "charge"
  • "addon"
item.item_applicability Object No

Filter items based on item_applicability.
item.item_applicability.not_in String No
item.item_applicability.in String No
item.item_applicability.is_not String No
  • all - all addon-items and charge-items are applicable to this plan-item.
  • restricted - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.

Valid values:

  • "restricted"
  • "all"
item.item_applicability.is String No
  • all - all addon-items and charge-items are applicable to this plan-item.
  • restricted - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.

Valid values:

  • "restricted"
  • "all"
item.item_family_id Object No

Filter items based on item_family_id.
item.item_family_id.not_in String No
item.item_family_id.starts_with String No
item.item_family_id.in String No
item.item_family_id.is_not String No
item.item_family_id.is String No
item.enabled_in_portal Object No

Allow customers to change their subscription to this plan via the [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html). Applies only for plan-items. This requires the Portal configuration to [allow changing subscriptions](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).
item.enabled_in_portal.is String No

Valid values:

  • "false"
  • "true"
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"
include_site_level_resources.is String No

Valid values:

  • "false"
  • "true"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy