selling_plan

Information about the intent of how a specific selling plan affects a line item.

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

Properties

checkout_charge selling_plan_checkout_charge: The checkout charge of the selling plan.
description string: The description of the selling plan.
group_id string: The ID of the selling_plan_group that the selling plan belongs to.

Note
The name is shown at checkout with the line item summary.
id number: The ID of the selling plan.
name string: The name of the selling plan.

Note
The name is shown at checkout with the line item summary.
options array of selling_plan_option: The selling plan options.
price_adjustments array of selling_plan_price_adjustment: The selling plan price adjustments.

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

Each selling_plan_price_adjustment maps to a selling_plan_allocation_price_adjustment in the selling_plan_allocation.price_adjustments array. The selling_plan.price_adjustments array contains the intent of the selling plan, and the selling_plan_allocation.price_adjustments contains the resulting money amounts.
recurring_deliveries boolean: Returns true if the selling plan includes multiple deliveries. Returns false if not.
selected boolean: Returns true if the selling plan is currently selected. Returns false if not.

Note
The selected selling plan is determined by the selling_plan URL parameter.

{

"checkout_charge": {},

"description": null,

"group_id": "f6f782040b07aa2353008932051a8d9bef0536d0",

"id": 610435137,

"name": "Delivery every 1 Week",

"options": [],

"price_adjustments": [],

"recurring_deliveries": true,

"selected": true

}

{
  "checkout_charge": {},
  "description": null,
  "group_id": "f6f782040b07aa2353008932051a8d9bef0536d0",
  "id": 610435137,
  "name": "Delivery every 1 Week",
  "options": [],
  "price_adjustments": [],
  "recurring_deliveries": true,
  "selected": true
}

Was this section helpful?