Skip to main content
GET
/
api
/
v2
/
org
/
usage
Get usage stats
curl --request GET \
  --url https://app.octolens.com/api/v2/org/usage \
  --header 'Authorization: Bearer <token>'
{
  "plan": "Pro_v3",
  "mentions": {
    "count": 0,
    "limit": 0,
    "resetAt": "2023-11-07T05:31:56Z"
  },
  "keywords": {
    "count": 0,
    "limit": 0
  },
  "flex": {
    "enabled": true,
    "budgetCents": 0,
    "used": 0,
    "resetAt": "2023-11-07T05:31:56Z"
  }
}

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
​
flex
object

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