Skip to main content

selling_plan_checkout_charge

Information about how a specific selling plan affects the amount that a customer needs to pay for a line item at checkout.

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

Properties

The value of the checkout charge.

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

Value typeValue
percentageThe percent amount of the original price that the customer needs to pay.

For example, if the value is 50, then the customer needs to pay 50% of the original price.
priceThe amount that the customer needs to pay 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.

Anchor to
value_type
string from a set of values

The value type of the checkout charge.

Possible values
percentage
price
{
"value": 100,
"value_type": "percentage"
}
Was this section helpful?