• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index
You are viewing an old version of the API
OrderReturnDiscount BETA

Represents a discount being returned that applies to one or more return line items in an order.

Fixed-amount, order-scoped discounts are distributed across all non-zero return line item totals. The amount distributed to each return line item is relative to that item’s contribution to the order subtotal.

Properties
Name Description
uid
string

A unique ID that identifies the returned discount only within this order.

Max Length 60
source_discount_uid
string

The discount uid from the order that contains the original application of this discount.

Max Length 60
catalog_object_id
string

The catalog object ID referencing CatalogDiscount.

Max Length 192
name
string

The discount's name.

Max Length 255
type
string

The type of the discount. If it is created by the API, it is FIXED_PERCENTAGE or FIXED_AMOUNT.

Discounts that do not reference a catalog object ID must have a type of FIXED_PERCENTAGE or FIXED_AMOUNT.
percentage
string

The percentage of the tax, 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
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 this line item. When an amount-based discount is at the order level, this value is different from amount_money because the discount is distributed across the line items.
scope
string

Indicates the level at which the OrderReturnDiscount applies. For ORDER scoped discounts, the server generates references in applied_discounts on all OrderReturnLineItems. For LINE_ITEM scoped discounts, the discount is only applied to OrderReturnLineItems with references in their applied_discounts field.

Share Feedback

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