Object Index
You are viewing an old version of the API
CatalogDiscount
Object Index
A discount applicable to items.
Properties
Name | Description |
---|---|
name
|
The discount name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. |
discount_
|
Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. |
percentage
|
The percentage of the discount as a string representation of a decimal number, using a Do not use this field for amount-based or variable discounts. |
amount_
|
The amount of the discount. Specify an amount of Do not use this field for percentage-based or variable discounts. |
pin_
|
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. |
label_
|
The color of the discount display label in the Square Point of Sale app. This must be a valid hex color code. |
modify_
|
Indicates whether this discount should reduce the price used to calculate tax. Most discounts should use If you are unsure whether you need to use this field, consult your tax professional. |
maximum_
|
For a percentage discount, the maximum absolute value of the discount. For example, if a
50% discount has a |