OrderReturnBeta

The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.

Link to section

Properties

Link to section

uid

string

A unique ID that identifies the return only within this order.

Max Length

Link to section

source_order_id

string

An order that contains the original sale of these return line items. This is unset for unlinked returns.

Link to section

return_line_items

OrderReturnLineItem[ ]

A collection of line items that are being returned.

Show attributes

Link to section

return_service_charges

OrderReturnServiceCharge[ ]

A collection of service charges that are being returned.

Show attributes

Link to section

return_taxes

OrderReturnTax[ ]

A collection of references to taxes being returned for an order, including the total applied tax amount to be returned. The taxes must reference a top-level tax ID from the source order.

Show attributes

Link to section

return_discounts

OrderReturnDiscount[ ]

A collection of references to discounts being returned for an order, including the total applied discount amount to be returned. The discounts must reference a top-level discount ID from the source order.

Show attributes

Link to section

return_tips

OrderReturnTip[ ]

A collection of references to tips being returned for an order.

Show attributes

Link to section

rounding_adjustment

OrderRoundingAdjustment

A positive or negative rounding adjustment to the total value being returned. Adjustments are commonly used to apply cash rounding when the minimum unit of the account is smaller than the lowest physical denomination of the currency.

Show attributes

Link to section

return_amounts

OrderMoneyAmounts

An aggregate monetary value being returned by this return entry.

Show attributes