Tip Object

A tip holds information about how much a customer has tipped, how the tip is distributed among staff, and the associated order’s line item subtotal.

Properties
idstringRead-onlyformat GUID

ID of the tip. Identical to the code of the related order.additionalFee.

lineItemSubtotalstringRead-onlyformat DECIMAL_VALUEdecimalValue {"gte":"0","maxScale":2}

Subtotal of all line items from the eCommerce order (SDK | REST) that's related to the tip. In the response of Preview Tip, there is no related eCommerce order. Then, value of this field corresponds to the sum of all line item prices passed in the request.

amountstringformat DECIMAL_VALUEdecimalValue {"gte":"0","maxScale":2}

Total amount of the tip.

Min: 0.00

distributionsArray <TipDistribution>minItems 0maxItems 50

Details about how the tip is shared among staff. Available only if at least one staff member receives part of the tip, and it's not entirely allocated to the business.

Max: 50 distributions

undistributedAmountstringRead-onlyformat DECIMAL_VALUEdecimalValue {"gt":"0","maxScale":2}

Undistributed tip amount. Calculated as the difference between tip.amount and the sum of all tip.tipDistributions.amount values.

Min: 0.01

Did this help?