Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
19 lines (12 loc) · 1.52 KB

CatalogDiscount.md

File metadata and controls

19 lines (12 loc) · 1.52 KB

CatalogDiscount

Description

A discount in the Catalog object model.

Properties

Name Type Description Notes
name String The discount's name. Searchable. This field has max length of 255 Unicode code points. [optional]
discountType String Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See CatalogDiscountType for possible values [optional]
percentage String The 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]
amountMoney Money The 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]
pinRequired Boolean Indicates 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]
labelColor String The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. [optional]