Checkout Coupon

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CheckoutCoupon",
  "title": "Checkout Coupon",
  "required": [
    "code"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The coupon ID."
    },
    "code": {
      "type": "string",
      "description": "the coupon code"
    },
    "displayName": {
      "type": "string",
      "description": "The coupon title based on different types provided in control panel section."
    },
    "couponType": {
      "type": "integer",
      "description": "|Type `int`|Type Name|\n|-|-|\n|`0`|`per_item_discount`|\n|`1`|`percentage_discount`|\n|`2`|`per_total_discount`|\n|`3`|`shipping_discount`|\n|`4`|`free_shipping`|\n|`5`|`promotion`|"
    },
    "discountedAmount": {
      "type": "number",
      "description": "The discounted amount applied within a given context.",
      "format": "double"
    }
  },
  "x-internal": false
}