CoworkerBookingCredits
Get one CoworkerBookingCredit
Retrieve a single CoworkerBookingCredit record by its Id.
GET
Get one CoworkerBookingCredit
A booking credit (internally CoworkerBookingCredit) is a monetary balance assigned to a customer that can pay for bookings, event sign-ups, or, when universal credit is enabled, products, plans, passes, and selected one-off charges. It can be created manually or released from a plan or product benefit, and its availability can be limited by eligibility and a validity period.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerBookingCredit-Read role.Path Parameters
Code Examples
Response
200
List of resource-type IDs this credit can pay for when CaneBeUsedForBookings is true; an empty list allows every resource type.
List of product IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every product.
List of plan IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every plan.
Read-only monetary amount still available; the system initializes it from TotalCredit and changes it through credit use or an adjustment.
Total monetary amount assigned when this credit is created; it sets the initial RemainingCredit.
Optional UTC date and time when this credit becomes usable; blank means it is usable immediately.
Optional UTC date and time when this credit stops being usable; blank means no expiry, and when set it must be later than ValidFrom.
Whether this credit can pay for bookings; use ElegibleResourceTypes to limit eligible resource types.
Whether this credit can pay for event sign-ups; use EventCategories to limit eligible event categories.
List of event-category IDs this credit can pay for when CaneBeUsedForEvents is true; an empty list allows every event category.
Whether this credit can pay for products, plans, passes, and eligible charges; use the eligibility lists and AppliesToCharges to restrict those uses.
System-calculated flag indicating whether any eligible resource type has a booking rate with a credit price.
List of pass IDs this universal credit can pay for; when IsUniversalCredit is true, an empty list allows every pass.
Whether this universal credit can pay for one-off charges in addition to products, plans, and passes.
Example Response