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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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?