Object Index
/ Definition
You are viewing an old version of the API
Discount
V1
Object Index / Definition
Note We recommend using the Square API (V2) for all new development when possible.
V1Discount
Properties
| Name | Description |
|---|---|
id
|
The discount's unique ID. |
name
|
The discount's name. |
rate
|
The 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 discounttype is VARIABLEPERCENTAGE. |
amount_money
|
The amount of the discount. This amount is 0 if discounttype is VARIABLEAMOUNT. This field is not included for rate-based discounts. |
discount_type
|
Indicates whether the discount is a FIXED value or entered at the time of sale. See V1DiscountDiscountType for possible values |
pin_required
|
Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment. |
color
|
The 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 |
v2_id
|
The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. |