selling_plan_group オブジェクト

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "product",
        "property": ""
      }
    ],
    "template": []
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "Selling plans are grouped based on shared [selling plan option names](/docs/api/liquid/objects/selling_plan_option#selling_plan_option-name).\n\nTo learn about how to support selling plans in your theme, refer to [Purchase options](/themes/pricing-payments/purchase-options).",
  "properties": [
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "selling_plan"
        }
      ],
      "summary": "The selling plans in the group.",
      "name": "selling_plans"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The ID of the selling plan group.",
      "name": "id"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The name of the selling plan group.",
      "name": "name"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If the app doesn't provide a value, then `nil` is returned.\n\n> Tip:\n> You can use this property, with the [`where` filter](/docs/api/liquid/filters/where), to filter the\n> [`product.selling_plan_groups` array](/docs/api/liquid/objects/product#product-selling_plan_groups) for all selling plan groups\n> from a specific app.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "An optional string provided by an app to identify selling plan groups created by that app.",
      "name": "app_id"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "selling_plan_group_option"
        }
      ],
      "summary": "The selling plan group options.",
      "name": "options"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> The selected selling plan is determined by the `selling_plan` URL parameter.",
      "examples": [],
      "return_type": [
        {
          "type": "boolean",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "Returns `true` if the currently selected selling plan is part of the selling plan group. Returns `false` if not.",
      "name": "selling_plan_selected"
    }
  ],
  "summary": "Information about a specific group of [selling plans](/apps/subscriptions/selling-plans) that include any of a\nproduct's variants.",
  "name": "selling_plan_group",
  "examples": [],
  "json_data": {
    "path": "/products/health-potion",
    "handle": "product.selling_plan_groups[0]",
    "data_from_file": ""
  },
  "return_type": []
}