getTipChoice( )

Retrieves the tip choice that's currently selected by the customer for a specific eCommerce checkout (SDK | REST). If the customer hasn't yet selected a tip choice, the response is empty.

Please refer to the Sample Flows for more information.

Permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
purchaseFlowIdstringRequired

ID of the purchase flow that's associated with the eCommerce order (SDK | REST).

The purchase flow ID is a persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.

Returns
Return Type:Promise<GetTipChoiceResponse>
Errors
404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?