Get the authenticated caller
Returns the authenticated caller: stable id, display name, plan tier, personal credit balance, and entitlement keys. The subject is always the credential holder - this endpoint accepts no user id, owner id, or impersonation parameter of any kind, so a key can only ever read its own owner. credits.balance is the caller's personal ledger; a call billed to an organization draws on a pool this number does not describe. Gate on tier != "free" for "does this caller hold a paid plan (own or org seat)" and on subscription.price_id for which product - the basic/pro rungs come from an internal plan ladder and do not track a plan's marketing name. An org seat (a Team plan held by the caller's organization) confers that org plan's tier and subscription, even when the caller pays nothing personally, so tier != "free" does not by itself mean the caller is billed. Responses are never cacheable. Authenticate with an API key (b4m_live_) carrying me:read, or a JWT.
Request
- Base URL: https://your-deployment.example.com
- URL: https://your-deployment.example.com/api/v1/me
- Auth: one of:
- HTTP bearer
- API key in header x-api-key
Response
The caller, their tier, their personal credit balance, and their entitlement keys.
Example response
{
"id": "507f1f77bcf86cd799439011",
"name": "Ada Lovelace",
"tier": "basic",
"subscription": {
"plan_name": "Professional",
"price_id": "price_123",
"interval": "monthly",
"current_period_ends_at": "2026-10-18T00:00:00.000Z"
},
"credits": {
"balance": 31667
},
"entitlements": [
"base"
]
}Changes
No recorded changes to this operation across all 1 revision of this API.