POST /exports/items

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-disabled"

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.

skip all actions to be done on the events

Possible values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

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.

skip only emails

Possible values:

• "all-disabled"

optional, string filter The unique ID of the [business entity](/docs/api/business_entities) of this `item`. [Learn more](using_business_entity_filters_in_product_catalog_list_apis) about all the scenarios before using this filter. **Supported operators :** is, is_present **Example →** *business_entity_id\[is_present\] = "true"*

null

Possible values:

• "false"
• "true"

Parameters for item

Specifies if gift subscriptions can be created for this item.

Possible values:

• "false"
• "true"

Filter items based on item `status`.

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

Possible values:

• "active"
• "deleted"
• "archived"

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

Possible values:

• "active"
• "deleted"
• "archived"

Filter items based on when the items were last updated.

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.

Possible values:

• "false"
• "true"

Specifies whether the item undergoes metered billing. When `true`, the quantity is calculated from [usage records](/docs/api/usages?prod_cat_ver=2). 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](https://www.chargebee.com/docs/2.0/metered_billing.html) is enabled. The value of this attribute cannot be changed.

Possible values:

• "false"
• "true"

Filter items based on item id.

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](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing).

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

Possible values:

• "max_usage"
• "sum_of_usages"
• "last_usage"

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

Possible values:

• "max_usage"
• "sum_of_usages"
• "last_usage"

Filter items based on item `name`.

The subscription channel this object originated from and is maintained in.

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

Possible values:

• "web"
• "play_store"
• "app_store"

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

Possible values:

• "web"
• "play_store"
• "app_store"

Filter items based on item `type`.

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

Possible values:

• "plan"
• "charge"
• "addon"

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

Possible values:

• "plan"
• "charge"
• "addon"

Filter items based on `item_applicability`.

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

Possible values:

• "restricted"
• "all"

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

Possible values:

• "restricted"
• "all"

Filter items based on `item_family_id`.

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

Possible values:

• "false"
• "true"

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"*

Possible values:

• "false"
• "true"