OrderLineItemDiscount

squareconnect.models.order_line_item_discount

Description

Represents a discount that applies to one or more line items in an order. Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal.

Properties

Name	Type	Description	Notes
uid	str	Unique ID that identifies the discount only within this order. This field is read-only.	[optional]
catalog_object_id	str	The catalog object id referencing CatalogDiscount.	[optional]
name	str	The discount's name.	[optional]
type	str	The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See OrderLineItemDiscountType for possible values	[optional]
percentage	str	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%. The percentage won't be set for an amount-based discount.	[optional]
amount_money	Money	The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount. The amount_money won't be set for a percentage-based discount.	[optional]
applied_money	Money	The amount of discount actually applied to this line item. Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items.	[optional]
scope	str	Indicates the level at which the discount applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See OrderLineItemDiscountScope for possible values	[optional]

[Back to Model list] [Back to API list] [Back to README]