Toast · JSON Structure

Orders Applied Discount Reason Structure

AppliedDiscountReason schema from Toast API

Type: object Properties: 4 Required: 1
Food ServicePoint of SaleRestaurantsHospitality

AppliedDiscountReason is a JSON Structure definition published by Toast, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name description comment discountReason

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-structure/orders-applied-discount-reason-structure.json",
  "name": "AppliedDiscountReason",
  "description": "AppliedDiscountReason schema from Toast API",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the reason for the applied discount."
    },
    "description": {
      "type": "string",
      "description": "An optional description for the reason for the applied discount."
    },
    "comment": {
      "type": "string",
      "description": "An optional comment on the reason for the applied discount."
    },
    "discountReason": {
      "type": "object",
      "description": "A ToastReference object that contains the GUID for the discount reason configured for the discount.",
      "$ref": "#/definitions/ToastReference"
    }
  }
}