PromoCode

Information about a promotion, associated with a discount.

• code:
  string

  The identifier of the promotion. Guests enter the code to apply the discount.

• entityType required:
  string

  The type of object this is.

• guid required:
  string

  The GUID maintained by the Toast POS.

• name:
  string

  The human-readable name of the promotion.

• usageType:
  string

  Indicates how the promo code can be used.

  • SINGLE_USE_PHONE - the promo code can only be used once per phone number. Some promotional discounts require a guest's phone number when applying the promo code.
  • SINGLE_USE_UNIQUE_CODE - the promo code is a unique code that can only be used once.
  • MULTI_USE - the promo code can be used multiple times.

  Enum: "SINGLE_USE_PHONE" "SINGLE_USE_UNIQUE_CODE" "MULTI_USE"

{
  "guid": "string",
  "entityType": "string",
  "code": "string",
  "name": "string",
  "usageType": "SINGLE_USE_PHONE"
}