BigCommerce · Schema

Applied Coupon

|Type `int`|Type Name| |-|-| |`0`|`per_item_discount`| |`1`|`percentage_discount`| |`2`|`per_total_discount`| |`3`|`shipping_discount`| |`4`|`free_shipping`| |`5`|`promotion`|

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
code string The coupon code.
id string The coupon ID. (read-only)
coupon_type string Key name to identify the type of coupon. type 0: per_item_discount type 1: percentage_discount type 2: per_total_discount type 3: shipping_discount type 4: free_shipping type 5: promotion
discounted_amount number The discounted amount applied within a given context.
View JSON Schema on GitHub

JSON Schema

bigcommerce-appliedcoupon-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AppliedCoupon",
  "title": "Applied Coupon",
  "type": "object",
  "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`|",
  "x-internal": false,
  "properties": {
    "code": {
      "description": "The coupon code.",
      "type": "string"
    },
    "id": {
      "description": "The coupon ID. (read-only)",
      "type": "string",
      "readOnly": true
    },
    "coupon_type": {
      "description": "Key name to identify the type of coupon.\n\ntype 0: per_item_discount\ntype 1: percentage_discount\ntype 2: per_total_discount\ntype 3: shipping_discount\ntype 4: free_shipping\ntype 5: promotion",
      "type": "string",
      "enum": [
        "0",
        "1",
        "2",
        "3",
        "4",
        "5"
      ],
      "readOnly": true
    },
    "discounted_amount": {
      "description": "The discounted amount applied within a given context.",
      "type": "number",
      "format": "double",
      "readOnly": true
    }
  },
  "required": [
    "code"
  ]
}