POST /differential_prices/{differential-price-id}
Update a differential price using a differential_price_id
and item_price_id
.
Servers
- {protocol}://{site}.{environment}:{port}/api/v2
- {protocol}://{site}-test.{environment}:{port}/api/v2
Path parameters
Name | Type | Required | Description |
---|---|---|---|
differential-price-id |
String | Yes |
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 |
---|---|---|---|
price_in_decimal |
String | No |
The price of the item when the pricing_model is |
price |
Integer | No |
The differential price. If the pricing model of the |
tiers |
Object | No |
Parameters for tiers |
tiers.starting_unit_in_decimal[] |
Array | No |
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as |
tiers.price_in_decimal[] |
Array | No |
The decimal representation of the per-unit price for the tier when the |
tiers.package_size[] |
Array | No |
Package size for the tier when pricing type is |
tiers.price[] |
Array | No |
The per-unit price for the tier when the |
tiers.ending_unit[] |
Array | No |
The upper limit of a range of units for the tier |
tiers.pricing_type[] |
Array | No | |
tiers.starting_unit[] |
Array | No |
The lower limit of a range of units for the tier |
tiers.ending_unit_in_decimal[] |
Array | No |
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the |
item_price_id |
String | Yes |
The id of the item price ( |
parent_periods |
Object | No |
Parameters for parent_periods |
parent_periods.period_unit[] |
Array | Yes | |
parent_periods.period[] |
Array | No |
The billing period of the plan in For a charge-item price,
|
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.