Settings
Configure SDK
Differential prices
Differential pricing helps implement a pricing strategy for addons and charges based on the plans they're purchased with. A differential price a specific price for an addon- or charge-item price when purchased along with a particular plan.
Differential pricing for addons
Consider an addon called 24x7 Customer Support provided with a cloud storage service. You can configure differential prices for each of the addon-item prices based on the plan they are purchased with, as follows:
| Addon item price | Price when applied to Standard Plan | Price when applied to Enterprise Plan | |
| 1 | 24x7 Customer Support, USD, Monthly, Flat fee, $100 | $90 | $150 |
| 2 | 24x7 Customer Support, USD, Yearly, Flat fee, $1000 | $900 | $1500 |
Differential pricing for charges
Consider a charge, called Setup fee, for installing and configuring a cloud-based project management platform. There are two modes in which you can set up differential pricing for a charge:
Mode A: One charge differential price per plan-item
This mode is used to specify one differential price for the charge-item price per plan-item it is applied to.
| Charge-item price | Price when applied to Standard plan | Price when applied to Enterprise plan |
| Setup fee, USD, Flat fee $500 | $400 | $700 |
Mode B: Multiple charge differential prices per plan item
This mode is used to specify multiple differential prices for the charge per plan-item, based on the plan period.
| Charge-item price | Price when applied to Standard plan, 6 months | Price when applied to Standard plan, yearly |
| Setup fee, USD, Flat fee $500 | $400 | $300 |
In the above example, even if the "6 month" or "yearly" plan-item prices do not exist, the differential prices for the charge can still be created. They take effect whenever the plan-item prices are eventually created and used in subscriptions.
Sample differential price [ JSON ]
{
"created_at": 1594110587,
"currency_code": "USD",
"id": "1b53489f-d5b7-45e3-a010-b11ca19cbc27",
"item_price_id": "day-pass-USD",
"object": "differential_price",
"parent_item_id": "basic",
"price": 100,
"resource_version": 1594110587730,
"status": "active",
"updated_at": 1594110587
}API Index URL
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. The unique ID of the business entity of this subscription. This is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
List of quantity-based pricing tiers for the differential price. Applicable only for
tiered, volume, and stairstep pricing_model s. The tiers are exactly the same as those set for the item price. Only the price attribute for the various tiers can be overridden for the differential price.When
item_price_id is a charge-item, you can specify the plan period for which the price applies. Although an array, currently you can specify only one period. In other words, only index 0 is allowed. Create another differential price to specify another period. Is permitted only when item_price_id is a charge-item.Create a differential price ¶
Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
Sample Response [ JSON ]
URL Format POST
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. 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.
.pass parameters as tiers[<param name>][<idx:0..n>]
Returns
Resource object representing differential_price
Retrieve a differential price ¶
Retrieve a differential price using a differential_price_id
and item_price_id
.
Sample Response [ JSON ]
URL Format GET
Input Parameters
Returns
Resource object representing differential_price
Update a differential price ¶
Update a differential price using a differential_price_id
and item_price_id
.
Sample Response [ JSON ]
URL Format POST
Input Parameters
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. pass parameters as tiers[<param name>][<idx:0..n>]
Returns
Resource object representing differential_price
Delete a differential price ¶
Delete a differential price using a differential_price_id
and item_price_id
.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Resource object representing differential_price
List 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).
Sample Response [ JSON ]
URL Format GET
Input Parameters
Filter Params
For operator usages, see the Pagination and Filtering section.
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.
Supported operators : is, is_not, starts_with, in, not_in
Example → parent_item_id[is] = "basic"
Returns
Resource object representing differential_price
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.