A co-pay is an additional fee a client pays to access a gym or spa that their current pass does not cover. The Co-pay section lets you discover available co-pay options for a provider, get an exact quote before purchase, and complete a co-pay transaction on behalf of a client.What you can do#
List co-pay options for a gym a client's pass does not cover
Get a co-pay quote for a spa service the client's pass does not cover
Purchase a co-pay package for a client to unlock access
Key concepts#
Co-pay is only relevant when a client wants to visit a provider that their pass does not give access to. If the client's pass already covers the provider, no co-pay is needed.A provider's available co-pay options indicate that the provider can be accessed via co-pay for clients whose passes do not include it. If a provider has no co-pay options, it can only be accessed by clients whose pass already covers it.| Type | How it works |
|---|
| Gym co-pay | Fixed options listed per provider. Browse with GET /providers/{providerBranchId}/gym-copay-options. |
| Spa co-pay | Amount varies by service and client. Get an exact figure with POST /providers/{id}/spa-copay-quote before charging the client. |
Always retrieve a spa co-pay quote immediately before presenting the charge to the client — quotes reflect real-time pricing and may change.1.
Retrieve co-pay options or request a quote for the specific service
2.
Present the amount to the client for confirmation
3.
Call POST /copay_purchases with the client ID, provider ID, and the co-pay option or quote reference
4.
Proceed to booking once the purchase is confirmed
copay_purchase_id that can be referenced in support queries.Include an Idempotency-Key on co-pay purchase requests. A duplicate purchase for the same visit is difficult to reverse, and a network timeout on this endpoint can leave the charge state ambiguous.Providers — list co-pay options and request quotes before purchase
Bookings — complete the booking after the co-pay is confirmed
Modified at 2026-05-15 09:38:50
