A pass is a wellness-access package that grants a client the right to visit a set of providers over a defined period. Passes are the foundation of the business model — before a client can book a session or generate a check-in code, they must hold a valid issued pass.What you can do#
List all pass packages available to your business account
Update the expiry date of an issued pass
Retrieve a single issued pass
Key concepts#
Pass packages vs issued passesA pass package is the product definition — it describes what the pass covers, how many visits it includes, and which provider category it applies to. An issued pass is a specific instance of that package assigned to a named client. You browse packages, then issue one to a client.An issued pass moves through the following states:| State | Meaning |
|---|
active | The pass is valid and the client can use it |
expired | The pass has passed its expiry date or all visits have been consumed |
cancelled | The pass was manually cancelled before expiry |
Each pass package is linked to a set of eligible providers. A client can only visit providers that are covered by their active pass. Use GET /passes/{id}/providers to see which providers a given pass unlocks before presenting options to a client.Some passes are visit-capped (e.g. 10 visits per month). Others are unlimited for the duration of their validity window. The pass package details indicate the visit model.Providers — list and filter the providers a client can visit under their pass
Access Codes — generate a QR check-in token for a client visit
Bookings — book a spa or class appointment for a client with an active pass
Modified at 2026-05-19 11:15:28
