Object Index / Definition

You are viewing an old version of the API
Discount
V1

Note We recommend using the Square API (V2) for all new development when possible.

Deprecated

V1Discount

Properties

Name Description
id
string

The discount's unique ID.

amount_money
V1​Money

The amount of the discount. This amount is 0 if discounttype is VARIABLEAMOUNT. This field is not included for rate-based discounts.

color
string

The color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6.

discount_type
string

Indicates whether the discount is a FIXED value or entered at the time of sale.

name
string

The discount's name.

pin_required
boolean

Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.

rate
string

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.

v2_id
string

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?