SquareConnect::CatalogDiscount

March 27, 2019 ยท View on GitHub

Description

A discount in the Catalog object model.

Properties

NameTypeDescriptionNotes
nameStringThe discount's name. Searchable. This field has max length of 255 Unicode code points.[optional]
discount_typeStringIndicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See CatalogDiscountType for possible values[optional]
percentageStringThe percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not include this field for amount-based or variable discounts.[optional]
amount_moneyMoneyThe amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. Do not include this field for percentage-based or variable discounts.[optional]
pin_requiredBOOLEANIndicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.[optional]
label_colorStringThe color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code.[optional]