Object Index
You are viewing an old version of the API
OrderLineItemDiscount
Object Index
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 |
---|---|
uid
Beta
|
A unique ID that identifies the discount only within this order. |
catalog_
|
The catalog object ID referencing CatalogDiscount. |
catalog_
|
The version of the catalog object that this discount references. |
name
|
The discount's name. |
type
|
The type of the discount. Discounts that do not reference a catalog object ID must have a type of
|
percentage
|
The percentage of the discount, as a string representation of a decimal number.
A value of
|
amount_
|
The total declared monetary amount of the discount.
|
applied_
|
The amount of discount actually applied to the line item. The amount 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 |
metadata
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 (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set
Values have a maximum length of 255 characters. An application can 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. For more information, see Metadata. |
scope
|
Indicates the level at which the discount applies. For This field is immutable. To change the scope of a discount, you must delete the discount and re-add it as a new discount. |
reward_
Beta
|
Read only The reward IDs corresponding to this discount. The application and
specification of discounts that have |
pricing_
|
Read only The object ID of a pricing rule to be applied
automatically to this discount. The specification and application of the discounts, to
which a |