selling_plan_price_adjustment オブジェクト

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "selling_plan_allocation",
        "property": "price_adjustments"
      }
    ],
    "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 number of orders that the price adjustment applies to.",
      "name": "order_count"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The 1-based index of the price adjustment in the [`selling_plan.price_adjustments` array](/docs/api/liquid/objects/selling_plan#selling_plan-price_adjustments).",
      "name": "position"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "percentage",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "fixed_amount",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "price",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The type of price adjustment.",
      "name": "value_type"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "How this value is interpreted depends on the [value type](/docs/api/liquid/objects/selling_plan_price_adjustment#selling_plan_price_adjustment-value_type) of\nthe price adjustment. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount that the original price is being adjusted by, in the currency's subunit. |\n| `percentage` | The percent amount that the original price is being adjusted by. |\n| `price` | The adjusted amount in the currency's subunit. |\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 value of the price adjustment as a decimal.",
      "name": "value"
    }
  ],
  "summary": "Information about how a selling plan changes the price of a variant for a given period of time.",
  "name": "selling_plan_price_adjustment",
  "examples": [],
  "json_data": {
    "path": "/products/health-potion?selling_plan=2595487809",
    "handle": "product.selected_selling_plan.price_adjustments[0]",
    "data_from_file": ""
  },
  "return_type": []
}