setBookingAsPaid( )


Marks a booking as fully paid.

The setBookingAsPaid() function returns a Promise that resolves when the booking is set as fully paid.

When the business has received full payment from the customer, the booking can be marked as fully paid.

When a booking is set as paid, the following events occur:

  • The paymentDetails.state status changes to "COMPLETE".
  • The amountReceived value is updated to the finalPrice.amount value.

You cannot mark a booking as paid if the booking status is "PENDING_APPROVAL".

Note: Only users with Bookings Admin permissions can mark a booking as paid. You can override the permissions by setting the suppressAuth options to true.

Method Declaration
Copy
Method Parameters
bookingIdstringRequired

Booking ID to update as paid.


optionsOptions

An object representing the available options for setting a booking as paid.

Returns
Return Type:Promise<Booking>
Was this helpful?
Yes
No