selling_plan_allocation

Properties

Anchor to

checkout_charge_amount

number

The amount that the customer will be charged at checkout in the currency's subunit.

The value is output in the customer's local (presentment) currency.

Tip

Use money filters to output a formatted price.

Anchor to

compare_at_price

number

The compare at price of the selling plan allocation in the currency's subunit.

The value of the compare at price is the line item's price without the selling plan applied.

The value is output in the customer's local (presentment) currency.

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

per_delivery_price

number

The price for each delivery in the selling plan in the currency's subunit.

If a selling plan includes multiple deliveries, then the per_delivery_price is the price divided by the number of deliveries.

The value is output in the customer's local (presentment) currency.

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

price

number

The price of the selling plan allocation in the currency's subunit.

The value is output in the customer's local (presentment) currency.

Tip

Use money filters to output a formatted price.

Anchor to

price_adjustments

array of selling_plan_allocation_price_adjustment

The selling plan allocation price adjustments.

The maximum length of the array is two. If the associated selling plan doesn't create any price adjustments, then the array is empty.

Each selling_plan_allocation_price_adjustment maps to a selling_plan_price_adjustment in the selling_plan.price_adjustments array. The selling_plan.price_adjustments array contains the intent of the selling plan, and the selling_plan_allocation.price_adjustments array contains the resulting money amounts.

Anchor to

remaining_balance_charge_amount

number

The remaining amount for the customer to pay, in the currency's subunit.

The value is output in the customer's local (presentment) currency.

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

selling_plan

selling_plan

The selling plan that created the allocation.

Anchor to

selling_plan_group_id

string

The ID of the selling_plan_group that the selling plan of the allocation belongs to.

Anchor to

unit_price

number

The unit price of the variant associated with the selling plan, in the currency's subunit.

If the variant doesn't have a unit price, then nil is returned.

The value is output in the customer's local (presentment) currency.

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.