Skip to main content

Check

POST 

/registration_eligibility/check

This endpoint helps you understand a customer's options for completing a registration action on either a new or existing customer membership.

The presence of any global_restrictions means the action is impossible. The customer's active memberships are listed in membership_options, and each includes applicable restrictions and prerequisites, along with the on-allotment price for completing the registration with it.

Error Code Overview

CodeReasonsProvider ApplicabilityCustomer Applicability
age_restrictedAge requirement not met.-appointment, class, room_rental
already_attendingThe customer is already attending.appointment, class, room_rentalappointment, class, room_rental
appointment_slot_unavailableThis appointment slot is not availableappointment, room_rentalappointment, room_rental
customer_registration_blockYou are unable to register for events. Please contact us for more information.-appointment, class, room_rental
event_cancelledThis event is not activeappointment, class, room_rentalappointment, class, room_rental
event_fullThe event is full.appointment, classappointment, class, room_rental
invalid_slotinvalid_slotappointment, room_rentalappointment, room_rental
max_daily_checkinsThe customer has reached the daily checkin limit.checkincheckin
maximum_daily_registrationsMaximum registrations reached. Cannot join waitlist because maximum registrations reached.appointmentappointment, class, room_rental
maximum_daily_waitlistsMaximum waitlists reached.-class
maximum_weekly_registrationsMaximum registrations reached. Cannot join waitlist because maximum registrations reached.appointmentappointment, class, room_rental
membership_blocked_after_failed_paymentThe membership is blocked due to failed payments.appointment, checkin, room_rentalappointment, checkin, class, room_rental
membership_blocked_manuallyThe membership has been manually blocked.appointment, checkin, room_rentalappointment, checkin, class, room_rental
membership_completedThe membership is not active because it has been completed.appointment, checkin, room_rentalappointment, checkin, class, room_rental
membership_expiredThe membership is not active on this date because it has expired.appointment, checkin, room_rentalappointment, checkin, class, room_rental
membership_not_applicableThis membership does not apply to this registration.appointment, checkin, room_rentalappointment, checkin, class, room_rental
membership_on_holdThe membership is not active because it is on hold.appointment, checkin, room_rentalappointment, checkin, class, room_rental
membership_pendingThe membership is not active because it has not started yet.appointment, checkin, room_rentalappointment, checkin, class, room_rental
membership_usage_restrictedThe membership's usage limits have been met.appointment, checkin, room_rentalappointment, checkin, class, room_rental
registrations_closedRegistrations closed.appointmentappointment, class, room_rental
registrations_not_openRegistrations not open yet.appointmentappointment, class, room_rental

Providers

  • Any provider can perform this action.

Customers

  • Any customer can perform this action.

Unregistered Customers

  • No access.

Request

Responses