Skip to main content
GET
Get usage stats

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Response

200 response

Current-cycle usage counters and plan limits.

plan
string | null
required

Current subscription plan (e.g. Free_trial, Pro_v3, Enterprise). null if no active plan / free trial expired. The *.limit numbers below already reflect this plan.

Example:

"Pro_v3"

mentions
object
required
keywords
object
required
searches
object

Lifetime on-demand search allowance. Only present on the Agents plan (the only plan with a lifetime search cap). Numbers come from the canonical quota read — identical to the X-Octolens-Searches-Remaining header on /api/v2/search* responses.

flex
object

Flex (usage-based) pricing state. Only present when flex pricing is enabled for the org.