V1Discount

April 10, 2019 ยท View on GitHub

squareconnect.models.v1_discount

Description

V1Discount

Properties

NameTypeDescriptionNotes
idstrThe discount's unique ID.[optional]
namestrThe discount's name.[optional]
ratestrThe 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_moneyV1MoneyThe 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_typestrIndicates whether the discount is a FIXED value or entered at the time of sale. See V1DiscountDiscountType for possible values[optional]
pin_requiredboolIndicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.[optional]
colorstrThe color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See V1DiscountColor for possible values[optional]
v2_idstrThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]

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