V1Discount

November 20, 2019 ยท View on GitHub

Description

V1Discount Note: This model is deprecated.

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe discount's unique ID.[optional]
namegetName()setName($value)stringThe discount's name.[optional]
rategetRate()setRate($value)stringThe rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE.[optional]
amount_moneygetAmountMoney()setAmountMoney($value)\SquareConnect\Model\V1MoneyThe amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts.[optional]
discount_typegetDiscountType()setDiscountType($value)stringIndicates whether the discount is a FIXED value or entered at the time of sale. See V1DiscountDiscountType for possible values[optional]
pin_requiredgetPinRequired()setPinRequired($value)boolIndicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.[optional]
colorgetColor()setColor($value)stringThe color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See V1DiscountColor for possible values[optional]
v2_idgetV2Id()setV2Id($value)stringThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]

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

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