Browse the documentation
Get Plan and Usage
Show the workspace's plan, credit balance, how much of each limit is used, the AI platforms the plan allows, and each paid agent's price. Call it before adding prompts, competitors or brands, or spending credits.
GET
/account
Example request
curl -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
"https://api.mentionbird.ai/api/v1/account"
Example response
Recorded from a live call against a demo workspace, so the shape is exactly what the endpoint returns.
{
"agents": {
"ranking_advice": {
"allowed": true,
"credits_per_run": 5
},
"youtube": {
"allowed": true,
"max_credits": 24,
"minutes_per_credit": 5,
"pricing": "1 credit per 5 minutes of video, rounded up, at most 24 credits; free for a brand that already has a summary of the video"
}
},
"allowed_providers": [
{
"display_name": "Grok",
"provider": "grok"
}
],
"cadence_days": 1,
"can_write": true,
"competitors_per_brand": [
{
"brand": "Acme",
"limit": 20,
"remaining": 19,
"used": 1
}
],
"credits": {
"balance": 0,
"monthly_grant": 2000
},
"plan": {
"code": "pro",
"name": "Pro"
},
"prompt_runs": {
"limit": 500,
"remaining": 499,
"used": 1
},
"tracked_brands": {
"limit": 10,
"remaining": 9,
"used": 1
},
"workspace": "Test Corp"
}
Responses
- 200
- Plan and usage. prompt_runs counts one prompt on one AI platform as one run, in one pool shared by every brand. allowed_providers are the slugs to pass as llms.
- 400
- Validation error — check the message in `error.message`.
- 401
- Unauthorized — missing, invalid or revoked bearer token.
- 403
- Forbidden — the plan lacks API access, the key is read-only, or addTrackedBrand would pass the tracked-brand limit.
- 404
- Not found — the brand, prompt or resource does not exist.
- 405
- Method not allowed.
- 429
- Too many requests — over the key's per-minute or per-day limit. Wait the seconds in the `Retry-After` header, then retry.
- 500
- Internal error — logged; retry is safe for reads.