POST /exports/price_variants

This API triggers export of price variant data. The exported zip file contains CSV files with price variant-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 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 `price_variant`. 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
`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"`
`price_variant`	Object	No	Parameters for price_variant
`price_variant.id`	Object	No	Filter variant based on their [id](#).
`price_variant.id.not_in`	String	No
`price_variant.id.starts_with`	String	No
`price_variant.id.in`	String	No
`price_variant.id.is_not`	String	No
`price_variant.id.is`	String	No
`price_variant.name`	Object	No	Filter variant based on their `name`s.
`price_variant.name.not_in`	String	No
`price_variant.name.starts_with`	String	No
`price_variant.name.in`	String	No
`price_variant.name.is_not`	String	No
`price_variant.name.is`	String	No
`price_variant.status`	Object	No	Filter variant based on their `status`.
`price_variant.status.not_in`	String	No
`price_variant.status.in`	String	No
`price_variant.status.is_not`	String	No	* `active` - Active * `archived` - Archived Valid values: `"active"` `"archived"`
`price_variant.status.is`	String	No	* `active` - Active * `archived` - Archived Valid values: `"active"` `"archived"`
`price_variant.created_at`	Object	No	Filter product based on their `created time`.
`price_variant.created_at.on`	String	No
`price_variant.created_at.after`	String	No
`price_variant.created_at.between`	String	No
`price_variant.created_at.before`	String	No
`price_variant.updated_at`	Object	No	Filter product based on their `updated time`.
`price_variant.updated_at.on`	String	No
`price_variant.updated_at.after`	String	No
`price_variant.updated_at.between`	String	No
`price_variant.updated_at.before`	String	No

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.