Object Index / Definition

You are viewing an old version of the API
Order​Line​Item​Discount

Represents a discount that applies to one or more line items in an order

Fixed-amount, order-scoped discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount contributed by the item to the order subtotal.

Properties

Name Description
amount_money
Money

The total declared monetary amount of the discount.

amount_money is not set for percentage-based discounts.

applied_money
Money

The amount of discount actually applied to the line item.

Represents the amount of money applied as a line item-scoped discount. When an amount-based discount is scoped to the entire order, the value of applied_money is different from amount_money because the total amount of the discount is distributed across all line items.

catalog_object_id
string

The catalog object id referencing CatalogDiscount.

Max Length 192
metadata
object

Beta

Application-defined data attached to this discount. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.).

Keys written by applications must be 60 characters or less and must be in the character set [a-zA-Z0-9_-]. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.

Values have a max length of 255 characters.

An application may have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

See Metadata for more information.

name
string

The discount's name.

Max Length 255
percentage
string

The percentage of the discount, as a string representation of a decimal number. A value of 7.25 corresponds to a percentage of 7.25%.

percentage is not set for amount-based discounts.

Max Length 10
scope
string

Indicates the level at which the discount applies. For ORDER scoped discounts, Square generates references in applied_discounts on all order line items that do not have them. For LINE_ITEM scoped discounts, the discount only applies to line items with a discount reference in their applied_discounts field.

This field is immutable. To change the scope of a discount you must delete the discount and re-add it as a new discount.

type
string

The type of the discount.

Discounts that don't reference a catalog object ID must have a type of FIXED_PERCENTAGE or FIXED_AMOUNT.

uid
string

Beta

Unique ID that identifies the discount only within this order.

Max Length 60

Share Feedback

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