Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
Prerequisites & Constraints
- Either
priceorprice_in_decimalis required when the parent item price uses theflat_feeorper_unitpricing model and multi-decimal pricing is enabled. - Multi-decimal pricing must be enabled for your site to set decimal tier fields (
tiers[price_in_decimal],tiers[starting_unit_in_decimal],tiers[ending_unit_in_decimal]).
Sample Request
Sample Result[JSON]
URL Format
Input Parameters
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 .
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.
- Multi-decimal pricing must be enabled for your site to set
price_in_decimal. price_in_decimalmust be a number.
The unique ID of the business entity for this differential_price. This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id will not be included in the API response.
Note: An alternative way of passing this parameter is by using a custom HTTP header or query string parameter.
- When multiple business entities are active for Product Catalog,
business_entity_idmust reference a business entity accessible to your API key.