selling_plan オブジェクト

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "line_item",
        "property": "selling_plan_allocation"
      },
      {
        "object": "variant",
        "property": "selling_plan_allocations"
      },
      {
        "object": "product",
        "property": "selected_selling_plan"
      },
      {
        "object": "remote_product",
        "property": "selected_selling_plan"
      },
      {
        "object": "selling_plan_allocation",
        "property": "selling_plan"
      }
    ],
    "template": []
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "To 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": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The ID of the selling plan.",
      "name": "id"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> The name is shown at checkout with the line item summary.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The name of the selling plan.",
      "name": "name"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The description of the selling plan.",
      "name": "description"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> The name is shown at checkout with the line item summary.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The ID of the [`selling_plan_group`](/docs/api/liquid/objects/selling_plan_group) that the selling plan belongs to.",
      "name": "group_id"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "boolean",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "Returns `true` if the selling plan includes multiple deliveries. Returns `false` if not.",
      "name": "recurring_deliveries"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "selling_plan_option"
        }
      ],
      "summary": "The selling plan options.",
      "name": "options"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The maximum length of the array is two. If the selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_price_adjustment` maps to a [`selling_plan_allocation_price_adjustment`](/docs/api/liquid/objects/selling_plan_allocation_price_adjustment)\nin the [`selling_plan_allocation.price_adjustments` array](/docs/api/liquid/objects/selling_plan_allocation#selling_plan_allocation-price_adjustments).\nThe `selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` contains the resulting money amounts.",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "selling_plan_price_adjustment"
        }
      ],
      "summary": "The selling plan price adjustments.",
      "name": "price_adjustments"
    },
    {
      "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 selling plan is currently selected. Returns `false` if not.",
      "name": "selected"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "selling_plan_checkout_charge",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The checkout charge of the selling plan.",
      "name": "checkout_charge"
    }
  ],
  "summary": "Information about the intent of how a specific [selling plan](/apps/subscriptions/selling-plans) affects a line item.",
  "name": "selling_plan",
  "examples": [],
  "json_data": {
    "path": "/products/health-potion?selling_plan=2595487809",
    "handle": "product.selected_selling_plan",
    "data_from_file": ""
  },
  "return_type": []
}