POST /exports/differential_prices

This API triggers export of differential price data. The exported zip file contains CSV files with differential price-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: `"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 Possible 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 Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`differential_price`	Object	No	Parameters for differential_price
`differential_price.id`	Object	No	A unique and immutable id for the differential price. It is auto-generated when the differential price is created.
`differential_price.id.not_in`	String	No
`differential_price.id.starts_with`	String	No
`differential_price.id.in`	String	No
`differential_price.id.is_not`	String	No
`differential_price.id.is`	String	No
`differential_price.parent_item_id`	Object	No	The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the Standard or Enterprise plans-items mentioned in the [examples above](./differential_prices?prod_cat_ver=2).
`differential_price.parent_item_id.not_in`	String	No
`differential_price.parent_item_id.starts_with`	String	No
`differential_price.parent_item_id.in`	String	No
`differential_price.parent_item_id.is_not`	String	No
`differential_price.parent_item_id.is`	String	No
`differential_price.item_price_id`	Object	No	The id of the item price (`addon` or `charge`) whose price should change according to the plan-item it is applied to.
`differential_price.item_price_id.not_in`	String	No
`differential_price.item_price_id.starts_with`	String	No
`differential_price.item_price_id.in`	String	No
`differential_price.item_price_id.is_not`	String	No
`differential_price.item_price_id.is`	String	No
`item_id`	Object	No	optional, string filter Item Id of Addon / Charge item price for which differential pricing is applied to. Supported operators : is, is_not, starts_with, in, not_in Example → item_id\[is\] = "day-pass"
`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

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.