previewTip( )

Previews a tip for a list of line items.

If you provide the Wix Bookings app ID (SDK | REST) as lineItemInfo.catalogReference.appId, the response includes tip distributions for each associated Bookings staff member (SDK | REST).

If you don't provide a tipSettingsId, the staffDistributionMethod is based on the site's default tip settings.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
lineItemInfoArray<LineItemInfo>Required

Information about the line items to preview the tip for.

Min: 1 line item Max: 50 line items

optionsPreviewTipOptions

Options to use when previewing a tip.

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

There are 2 errors with this status code.

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

Did this help?