discount オブジェクト

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "cart",
        "property": "discounts"
      },
      {
        "object": "line_item",
        "property": "discounts"
      },
      {
        "object": "order",
        "property": "discounts"
      },
      {
        "object": "checkout",
        "property": "discount"
      }
    ],
    "template": []
  },
  "deprecated": true,
  "deprecation_reason": "Deprecated because not all discount types and details are captured.\n\nThe `discount` object has been replaced by the [`discount_allocation`](/docs/api/liquid/objects/discount_allocation) and\n[`discount_application`](/docs/api/liquid/objects/discount_application) objects.",
  "description": "",
  "properties": [
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> This is the same value as [`discount.total_amount`](/docs/api/liquid/objects/discount#discount-total_amount).\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 amount.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The amount of the discount in the currency's subunit.",
      "name": "amount"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> This is the same value as [`discount.amount`](/docs/api/liquid/objects/discount#discount-amount).\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 amount.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The amount of the discount in the currency's subunit.",
      "name": "total_amount"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> This is the same value as [`discount.title`](/docs/api/liquid/objects/discount#discount-title).",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The customer-facing name of the discount.",
      "name": "code"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> This is the same value as [`discount.code`](/docs/api/liquid/objects/discount#discount-code).",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The customer-facing name of the discount.",
      "name": "title"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "FixedAmountDiscount",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "PercentageDiscount",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "ShippingDiscount",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The type of the discount.",
      "name": "type"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> This is the same value as [`discount.total_savings`](/docs/api/liquid/objects/discount#discount-total_savings).\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 amount.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The amount of the discount as a negative value, in the currency's subunit.",
      "name": "savings"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> This is the same value as [`discount.savings`](/docs/api/liquid/objects/discount#discount-savings).\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 amount.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The amount of the discount as a negative value, in the currency's subunit.",
      "name": "total_savings"
    }
  ],
  "summary": "A discount applied to a cart, line item, or order.",
  "name": "discount",
  "examples": [],
  "json_data": {
    "path": "/",
    "handle": "customer.orders[2].discounts[0]",
    "data_from_file": ""
  },
  "return_type": []
}