GET /differential_prices
Returns a list of differential prices satisfying all the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
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 |
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-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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Object | No |
optional, string filterA unique and immutable id for the differential price. It is auto-generated when the differential price is created.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "defcc4f1-f21f-47f4-8019-beddb9beab5f" |
parent_item_id |
Object | No |
optional, string filterThe 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.Supported operators : is, is_not, starts_with, in, not_inExample → parent_item_id[is_not] = "basic" |
limit |
Integer | No |
The number of resources to be returned. Default value: 10 |
item_price_id |
Object | No |
optional, string filterThe id of the item price ( |
item_id |
Object | No |
optional, string filterItem Id of Addon / Charge item price for which differential pricing is applied to.Supported operators : is, is_not, starts_with, in, not_inExample → item_id[is] = "day-pass" |
offset |
String | No |
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set |
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.