selling_plan_group

Information about a specific group of selling plans that include any of a product's variants.

Selling plans are grouped based on shared selling plan option names.

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

Properties

app_id string: An optional string provided by an app to identify selling plan groups created by that app.

If the app doesn't provide a value, then nil is returned.

Tip
You can use this property, with the where filter, to filter the product.selling_plan_groups array for all selling plan groups from a specific app.
id number: The ID of the selling plan group.
name string: The name of the selling plan group.
options array of selling_plan_group_option: The selling plan group options.
selling_plan_selected boolean: Returns true if the currently selected selling plan is part of the selling plan group. Returns false if not.

Note
The selected selling plan is determined by the selling_plan URL parameter.
selling_plans array of selling_plan: The selling plans in the group.

{

"app_id": "294517",

"id": "7e5d71161bec5331c43c232131698d7d1e7e832e",

"name": "Health potion",

"options": [],

"selling_plan_selected": false,

"selling_plans": []

}

{
  "app_id": "294517",
  "id": "7e5d71161bec5331c43c232131698d7d1e7e832e",
  "name": "Health potion",
  "options": [],
  "selling_plan_selected": false,
  "selling_plans": []
}

Was this section helpful?