Get Membership Plan

This endpoint returns one plan of the company's catalog, with the services each group
includes.

Important Notes

  • Unlike GET /v3/memberships, which lists only the plans on sale, the detail also returns
    inactive plans (active: false): a plan a client bought may have been deactivated
    afterwards.
  • A plan of another company answers 404, like an unknown id.
  • Requires memberships:read scope.

Errors Dictionary

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks memberships:read scope.
404membership_catalog_not_found—The plan does not exist or belongs to another company.
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

Membership plan (catalog) identifier.

Responses

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