Booking Policy Object


A booking policy is a set of rules that determine how customers can book a service, including timeframes for booking, canceling, or rescheduling.

Properties
idstringRead-onlyformat GUID

ID of the booking policy.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the booking policy is updated. To prevent conflicting changes, the current revision must be passed when updating the booking policy.


createdDatestringRead-onlyformat date-time

Date and time the booking policy was created in YYYY-MM-DDThh:mm:ss.sssZ format.


updatedDatestringRead-onlyformat date-time

Date and time the booking policy was updated in YYYY-MM-DDThh:mm:ss.sssZ format.


namestringmaxLength 400

Name of the booking policy.


customPolicyDescriptionobject

Custom description for the booking policy and whether it's displayed to the participant.


defaultbooleanRead-only

Whether the booking policy is the default.


limitEarlyBookingPolicyobject

Rule for limiting early bookings.


limitLateBookingPolicyobject

Rule for limiting late bookings. This rule and bookAfterStartPolicy can't be both enabled at the same time.


bookAfterStartPolicyobject

Rule for booking after the start of a session or course. This rule and limitLateBookingPolicy can't be both enabled at the same time.


cancellationPolicyobject

Rule for canceling a booking.


reschedulePolicyobject

Rule for rescheduling a booking.


waitlistPolicyobject

Waitlist rule for the service.


participantsPolicyobject

Rule for participants per booking.


cancellationFeePolicyobject

Rules for cancellation fees.


saveCreditCardPolicyobject

Rule for saving credit card details.


extendedFieldsobject

Extensions enabling users to save custom data related to the booking policies.

Was this helpful?
Yes
No