updateTipChoice( )

Updates the tip choice that's currently selected by the customer for a specific eCommerce checkout (SDK | REST).

Please refer to the Sample Flows for more information.

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

Tip choice to select for the purchase flow. The call fails if you provide a value for tipChoice.tipType that doesn't match the relevant tip settings configuration. For example:

  • AMOUNT when tipSettings.tipType isn't AMOUNT.
  • PERCENTAGE when tipSettings.tipType isn't PERCENTAGE.
  • CUSTOM when tipSettings.allowCustomTip is false.
optionsUpdateTipChoiceOptionsRequired

Options to use when updating a tip choice.

Returns
Return Type:Promise<UpdateTipChoiceResponse>
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?