POST /exports/attached_items
This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.
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 |
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 Possible values:
|
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 Possible values:
|
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-event-email |
String | No |
skip only emails Possible values:
|
Request body fields
Name | Type | Required | Description |
---|---|---|---|
attached_item |
Object | No |
Parameters for attached_item |
attached_item.id |
Object | No |
Filter attached items based on their id. |
attached_item.id.not_in |
String | No | |
attached_item.id.starts_with |
String | No | |
attached_item.id.in |
String | No | |
attached_item.id.is_not |
String | No | |
attached_item.id.is |
String | No | |
attached_item.charge_on_event |
Object | No |
Indicates when the item is charged. This attribute only applies to charge-items. |
attached_item.charge_on_event.not_in |
String | No | |
attached_item.charge_on_event.in |
String | No | |
attached_item.charge_on_event.is_not |
String | No |
* `subscription_creation` - the time of creation of the subscription. * `subscription_trial_start` - the time when the trial period of the subscription begins. * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. * `subscription_activation` - the moment a subscription enters an Possible values:
|
attached_item.charge_on_event.is |
String | No |
* `subscription_creation` - the time of creation of the subscription. * `subscription_trial_start` - the time when the trial period of the subscription begins. * `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. * `subscription_activation` - the moment a subscription enters an Possible values:
|
attached_item.parent_item_id |
Object | No |
The id of the plan-item to which the item is attached. |
attached_item.parent_item_id.not_in |
String | No | |
attached_item.parent_item_id.starts_with |
String | No | |
attached_item.parent_item_id.in |
String | No | |
attached_item.parent_item_id.is_not |
String | No | |
attached_item.parent_item_id.is |
String | No | |
attached_item.type |
Object | No |
Filter attached items based on the `type` of attached item. Possible values are : `recommended`, `mandatory`, `optional`. |
attached_item.type.not_in |
String | No | |
attached_item.type.in |
String | No | |
attached_item.type.is_not |
String | No |
* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal. * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API. * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a Possible values:
|
attached_item.type.is |
String | No |
* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal. * `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API. * `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a Possible values:
|
attached_item.item_id |
Object | No |
Filter attached items based on the `item_id` of the item being attached. |
attached_item.item_id.not_in |
String | No | |
attached_item.item_id.starts_with |
String | No | |
attached_item.item_id.in |
String | No | |
attached_item.item_id.is_not |
String | No | |
attached_item.item_id.is |
String | No | |
attached_item.updated_at |
Object | No |
Filter attached items based on when the attached items were last updated. |
attached_item.updated_at.on |
String | No | |
attached_item.updated_at.after |
String | No | |
attached_item.updated_at.between |
String | No | |
attached_item.updated_at.before |
String | No | |
item_type |
Object | No |
optional, enumerated string filter To filter based on the type of of the attached item. Possible values are : `addon`, `charge`. Possible values are : plan, addon, charge. **Supported operators :** is, is_not, in, not_in **Example →** *item_type\[is_not\] = "plan"* |
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. Possible values:
|
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. Possible values:
|
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.