Get Client Membership

This endpoint returns one plan the client bought, with the sessions used and remaining per
group and per service at date.

Important Notes

  • Requires memberships:read scope.
  • Answers 404 when the client does not exist or belongs to another company, and when the plan
    does not exist or was bought by another client.

Errors Dictionary

StatusErrorDetailDescription
400invalid_date—date is not a valid date.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks memberships:read scope.
404client_not_found—The client does not exist or belongs to another company.
404membership_not_found—The plan does not exist, or it was bought by another client.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Client unique identifier.

int64
required
≥ 1

Purchased membership plan identifier.

Query Params
date

Date (YYYY-MM-DD) at which usage and remaining sessions are computed. Defaults to today.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json