Model MatchHelp

Me

Get the caller's current plan

getapi.modelmatch.com/v1/me/plan

The active organization's resolved plan (with its limit map), the subscription status backing it, and the plan grants attached to the organization and to the user.

plan is null when the workspace has no active, trialing, or past-due subscription. No billing details (invoices, payment methods) are exposed.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Responses

200objectThe caller's plan
Show attributes
grantsobjectrequired
Show child attributes
organizationobject[]required
Show child attributes
additiveboolean | null
planIdstringrequired
userobject[]required
Show child attributes
planIdstringrequired
organizationIdstringrequired
planobject | nullrequired
Show child attributes
displayNamestring | null
groupstring | null
idstringrequired
limitsobjectrequired

Plan limit map as configured in auth (free-form)

Show child attributes
[key: string]null
namestringrequired
subscriptionobject | nullrequired
Show child attributes
planNamestring | null
statusstringrequired

active | trialing | past_due

400objectValidation error
401objectUnauthorized
403objectForbidden (authenticated, but missing required context — e.g. no active organization)
404objectNot found
413objectResponse payload too large — detail endpoint capped to fit Lambda response limits
502objectAccount service unavailable
503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.