POST /differential_prices/{differential-price-id}

Update a differential price using a differential_price_id and item_price_id.

Servers

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:

  • "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
price_in_decimal String No

The price of the item when the pricing_model is flat_fee. When the pricing model is per_unit, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing is enabled.

price Integer No

The differential price. If the pricing model of the item_price_id is tiered, volume, or stairstep, pass tiers instead of this.

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 ending_unit_in_decimal of the next lower tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.

tiers.price_in_decimal[] Array No

The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.

tiers.package_size[] Array No

Package size for the tier when pricing type is package. Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.

tiers.price[] Array No

The per-unit price for the tier when the pricing_model is tiered or volume; the total cost for the item price when the pricing_model is stairstep. The value is in the minor unit of the currency.

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 starting_unit_in_decimal of the next higher tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.

item_price_id String Yes

The id of the item price (addon or charge) whose price should change according to the plan-item it is applied to.

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 period_units. For example, a 6 month plan has period as 6 and period_unit as month.
Note

For a charge-item price,

  • When parent_periods[period_unit] and parent_periods[period] values are passed , then the price is applied to a specific billing frequency of the plan-item.
  • When parent_periods[period_unit] and parent_periods[period] values are not passed , then the price is applied to all billing frequencies of the plan-item.
  • When parent_periods[period_unit] is passed (eg. month) and the parent_periods[period] value is not passed , then the price is applied to all parent_periods[period_unit] (eg. monthly) frequencies of the plan-item. Updating or deleting the price after creation will impact all of its related plan-item frequencies.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.