Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 1.94 KB

CatalogDiscount.md

File metadata and controls

16 lines (12 loc) · 1.94 KB

CatalogDiscount

Properties

Name Getter Setter Type Description Notes
name getName() setName($value) string The discount's name. Searchable. [optional]
discount_type getDiscountType() setDiscountType($value) string Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See CatalogDiscountType for all possible values. [optional]
percentage getPercentage() setPercentage($value) 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]
amount_money getAmountMoney() setAmountMoney($value) \SquareConnect\Model\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]
pin_required getPinRequired() setPinRequired($value) bool 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]
label_color getLabelColor() setLabelColor($value) string The color of the discount's display label in the Square Point of Sale app. [optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]