selling_plan_allocation オブジェクト

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "line_item",
        "property": "selling_plan_allocation"
      },
      {
        "object": "variant",
        "property": "selling_plan_allocations"
      },
      {
        "object": "product",
        "property": "selected_selling_plan_allocation"
      },
      {
        "object": "product",
        "property": "selected_or_first_available_selling_plan_allocation"
      },
      {
        "object": "variant",
        "property": "selected_selling_plan_allocation"
      },
      {
        "object": "remote_product",
        "property": "selected_selling_plan_allocation"
      },
      {
        "object": "remote_product",
        "property": "selected_or_first_available_selling_plan_allocation"
      }
    ],
    "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": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The price of the selling plan allocation in the currency's subunit.",
      "name": "price"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The value of the **compare at** price is the line item's price without the selling plan applied.\n\nThe value is output in the customer's local (presentment) currency.\n\nFor 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.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The **compare at** price of the selling plan allocation in the currency's subunit.",
      "name": "compare_at_price"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The maximum length of the array is two. If the associated selling plan doesn't create any price adjustments, then the\narray is empty.\n\nEach `selling_plan_allocation_price_adjustment` maps to a [`selling_plan_price_adjustment`](/docs/api/liquid/objects/selling_plan_price_adjustment)\nin the [`selling_plan.price_adjustments` array](/docs/api/liquid/objects/selling_plan#selling_plan-price_adjustments). The\n`selling_plan.price_adjustments` array contains the intent of the selling plan, and the\n`selling_plan_allocation.price_adjustments` array contains the resulting money amounts.",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "selling_plan_allocation_price_adjustment"
        }
      ],
      "summary": "The selling plan allocation price adjustments.",
      "name": "price_adjustments"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If the variant doesn't have a unit price, then `nil` is returned.\n\nThe value is output in the customer's local (presentment) currency.\n\nFor 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.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The [unit price](/docs/api/liquid/objects/variant#variant-unit_price) of the variant associated with the selling plan, in the currency's subunit.",
      "name": "unit_price"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If a selling plan includes multiple deliveries, then the `per_delivery_price` is the `price` divided by the number of\ndeliveries.\n\nThe value is output in the customer's local (presentment) currency.\n\nFor 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.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The price for each delivery in the selling plan in the currency's subunit.",
      "name": "per_delivery_price"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "selling_plan",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The selling plan that created the allocation.",
      "name": "selling_plan"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "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 of the allocation belongs to.",
      "name": "selling_plan_group_id"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The value is output in the customer's local (presentment) currency.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The amount that the customer will be charged at checkout in the currency's subunit.",
      "name": "checkout_charge_amount"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The value is output in the customer's local (presentment) currency.\n\nFor 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.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted price.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The remaining amount for the customer to pay, in the currency's subunit.",
      "name": "remaining_balance_charge_amount"
    }
  ],
  "summary": "Information about how a specific [selling plan](/apps/subscriptions/selling-plans) affects a line item.",
  "name": "selling_plan_allocation",
  "examples": [],
  "json_data": {
    "path": "/products/health-potion?variant=39897499828289&selling_plan=2595487809",
    "handle": "product.selected_selling_plan_allocation",
    "data_from_file": ""
  },
  "return_type": []
}