Skip to main content
GET
Subject overview (account, user, entitlement, billing, usage)

Authorizations

Authorization
string
header
required

Clerk dashboard session JWT. Used on dashboard, billing, playground, and admin console routes only:

These are human-session credentials, not API keys. The dashboard frontend must never send authoritative account IDs, plan values, quota counters, Stripe IDs, or API-key actor fields — the server derives ownership from the session. Admin console routes additionally require the custom admin_role claim (admin or support) on the same verified session JWT; writes require admin.

Path Parameters

accountID
string
required

Response

Subject overview.

Support subject overview. billing and usage reuse the dashboard BillingSummary / UsageSummaryResponse shapes computed for the target account; both are null when unavailable (never partially invented).

account
object
required
user
object | null
required

PII-free user view. It NEVER includes email fields — no address and no hash; the users table stores keyed hashes only and email lookup is resolved server-side.

entitlement
object | null
required

DIRECT-007 entitlement snapshot view. The snapshot — not the Stripe status — is the runtime plan authority.

billing
object | null
required
usage
object | null
required
api_key_count
integer
required
manual_grant_warning
boolean
required

True when the current entitlement is a manual grant that a Stripe webhook or reconciler pass may overwrite (DIRECT-007).