ProductBookingCredits
Search ProductBookingCredits
Search and list ProductBookingCredit records with filtering, sorting, and pagination.
GET
A ProductBookingCredit represents an amount of credit linked to a
Product. When a customer purchases the product, the credit is automatically released as a CoworkerBookingCredit on the customer’s account.
Credit can be configured for two primary uses:
- Bookings — set
CaneBeUsedForBookingsto allow the credit to pay for bookings. UseElegibleResourceTypesto restrict the credit to specific resource types; if left empty the credit is valid for all resource types. - Events — set
CaneBeUsedForEventsto allow the credit to pay for event sign-ups. UseEventCategoriesto restrict to specific event categories; if left empty the credit is valid for all events.
IsUniversalCredit enables the credit for products, time passes, and other charges. Use ElegibleProducts, ElegiblePasses, and AppliesToCharges to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.
Use ExpirationType and ExpiresIn to control when the released credit expires.
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 ProductBookingCredit-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by credit name.
Filter by Product Id.
Filter by product name.
Filter by product business currency code.
Filter by credit amount.
Filter by Expire Time In Months.
Filter by Expire Time In Weeks.
Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with
ElegibleResourceTypes.Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with
EventCategories.Filter by expiration type.
Filter by number of periods (of
ExpirationType) until the released credit expires.Filter by whether this is a universal credit applicable to products, time passes and other charges. Restrict with
ElegibleProducts, ElegiblePasses and AppliesToCharges; if all are empty the credit applies to all products, passes and charges.Filter by whether this universal credit applies to other charges.
Range Filters
Filter by credit amount greater than or equal to this value.
Filter by credit amount less than or equal to this value.
Filter by expire time in months greater than or equal to this value.
Filter by expire time in months less than or equal to this value.
Filter by expire time in weeks greater than or equal to this value.
Filter by expire time in weeks less than or equal to this value.
Filter by number of periods (of
ExpirationType) until the released credit expires greater than or equal to this value.Filter by number of periods (of
ExpirationType) until the released credit expires less than or equal to this value.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of ProductBookingCredit records matching the query. See the Get one ProductBookingCredit endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response