selling_plan_price_adjustment

Information about how a selling plan changes the price of a variant for a given period of time.

To learn about how to support selling plans in your theme, refer to Purchase options.

Properties

order_count number: The number of orders that the price adjustment applies to.
position number: The 1-based index of the price adjustment in the selling_plan.price_adjustments array.
value number: The value of the price adjustment as a decimal.

How this value is interpreted depends on the value type of the price adjustment. The following table outlines what the value represents for each value type:

Value type Value
fixed_amount The amount that the original price is being adjusted by, in the currency's subunit.
percentage The percent amount that the original price is being adjusted by.
price The adjusted amount in the currency's subunit.
For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip
Use money filters to output a formatted price.
value_type string from a set of values: The type of price adjustment.

Possible values
percentage
fixed_amount
price

Value type	Value
`fixed_amount`	The amount that the original price is being adjusted by, in the currency's subunit.
`percentage`	The percent amount that the original price is being adjusted by.
`price`	The adjusted amount in the currency's subunit.

{

"order_count": null,

"position": 1,

"value": 10,

"value_type": "percentage"

}

{
  "order_count": null,
  "position": 1,
  "value": 10,
  "value_type": "percentage"
}

Was this section helpful?