An entity representing a scheduled appointment, class session, or course.
Booking ID.
Additional custom fields submitted with the booking form.
Booking status. A booking is automatically confirmed if the service allows it and an eCommerce order is created. It is automatically declined if there is a double booking and the customer hasn't paid or is eligible for an automatic refund. Currently, only payments with pricing plans are automatically refundable.
Payment option selected by the customer. If the customer hasn't completed their
checkout, they may still change the payment method. Must be one of the payment
options offered by the service (SDK | REST),
unless skipSelectedPaymentOptionValidation
is true
.
When undefined during an
eCommerce checkout (SDK | REST),
Wix Bookings uses the service's default payment option
Date and time the booking was created in YYYY-MM-DDThh:mm:ss.sssZ
format.
External user ID that you can provide.
Revision number to be used when updating, rescheduling, or cancelling the booking. Increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes, the current revision must be specified when updating the booking.
ID of the creator of the booking.
If appId
and another ID are present, the other ID takes precedence.
The start date of the booking in YYYY-MM-DDThh:mm:ss.sssZ
format.
For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.
The end date of the booking in YYYY-MM-DDThh:mm:ss.sssZ
format.
For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.
Date and time the booking was updated in YYYY-MM-DDThh:mm:ss.sssZ
format.
Custom field data for this object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Whether this booking overlaps with another confirmed booking. Returned
only if set to true
.