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
bookAfterStartPolicyBookAfterStartPolicy

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


cancellationFeePolicyCancellationFeePolicy

Rules for cancellation fees.


cancellationPolicyCancellationPolicy

Rule for canceling a booking.


createdDatestringRead-onlyformat date-time

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


customPolicyDescriptionCustomPolicyDescription

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


defaultbooleanRead-only

Whether the booking policy is the default.


extendedFieldsExtendedFields

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


idstringRead-onlyformat GUID

ID of the booking policy.


limitEarlyBookingPolicyLimitEarlyBookingPolicy

Rule for limiting early bookings.


limitLateBookingPolicyLimitLateBookingPolicy

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


namestringmaxLength 400

Name of the booking policy.


participantsPolicyParticipantsPolicy

Rule for participants per booking.


reschedulePolicyReschedulePolicy

Rule for rescheduling a booking.


revisionstringRead-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.


saveCreditCardPolicySaveCreditCardPolicy

Rule for saving credit card details.


updatedDatestringRead-onlyformat date-time

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


waitlistPolicyWaitlistPolicy

Waitlist rule for the service.

Did this help?