Account
Your key, team, plan, and usage.
Retrieve your account
GET /api/v1/me returns the account associated with your bearer API key: its team, key metadata, API plan, and monthly lookup usage. It takes no parameters.
Use it to verify a new integration or check how many lookups remain. The selected key determines the team, not your browser's current session.
This endpoint has no request parameters.
Authentication and limits
Send Authorization: Bearer YOUR_API_KEY. A missing, invalid, or revoked key returns HTTP 401 with a JSON message and a WWW-Authenticate: Bearer header.
No paid plan is required. Requests do not consume your monthly lookup quota. This endpoint has its own request-rate limit; excessive requests return HTTP 429.
Response fields
- Name
data- Type
- object
- Description
The account associated with the bearer API key.
- Name
data.team- Type
- object
- Description
The team that owns the key.
- Name
data.team.name- Type
- string
- Description
Team display name.
- Name
data.team.slug- Type
- string
- Description
Team URL identifier.
- Name
data.api_key- Type
- object
- Description
Metadata for the key used to authenticate this request. Never includes its secret.
- Name
data.api_key.name- Type
- string
- Description
The label assigned when the key was created.
- Name
data.api_key.prefix- Type
- string
- Description
The identifying prefix of the key.
- Name
data.api_key.created_at- Type
- string | null · ISO 8601
- Description
Key creation timestamp, or null if unavailable.
- Name
data.plan- Type
- object | null
- Description
The active API plan. Null when there is no active plan.
- Name
data.plan.id- Type
- string · try | scale
- Description
Plan identifier. Present when plan is not null.
- Name
data.plan.name- Type
- string
- Description
Plan display name. Present when plan is not null.
- Name
data.plan.monthly_lookups- Type
- integer
- Description
Monthly lookup allowance. Present when plan is not null.
- Name
data.plan.requests_per_minute- Type
- integer
- Description
Shared data endpoint request limit per minute. Present when plan is not null.
- Name
data.usage- Type
- object
- Description
Lookup usage for the current billing period, which runs from one renewal date to the next.
- Name
data.usage.period- Type
- string · YYYY-MM-DD
- Description
The date the current billing period started, which identifies it.
- Name
data.usage.started_at- Type
- string · ISO 8601
- Description
When the current billing period started.
- Name
data.usage.lookups- Type
- integer
- Description
Lookups consumed this billing period. Calling /me does not increase this count.
- Name
data.usage.remaining- Type
- integer | null
- Description
Remaining allowance, never below zero. Null without an active plan.
- Name
data.usage.resets_at- Type
- string · ISO 8601
- Description
When the plan next renews and the allowance resets.
Response behavior and edge cases
The response is wrapped in a data object.
Every field below uses its full JSON path. Fields within plan are present only when the team has an active plan. The example response alongside this reference is illustrative and available without signing in.
Usage
Calling this endpoint does not consume lookup quota. Successful rate lookups do, including responses where an amount is unavailable. Usage resets when the current billing period renews. The response includes the period start and resets_at timestamp.
The example shows a team with no active plan, so plan and usage.remaining are null. Run a request to see the actual plan and usage for your selected key.
Request
curl -G 'https://feebase.co/api/v1/me' \
-H 'Authorization: Bearer YOUR_API_KEY'Response
{
"data": {
"team": {
"name": "Example practice",
"slug": "example-practice"
},
"api_key": {
"name": "Development",
"prefix": "fb_example",
"created_at": "2026-10-06T12:00:00+00:00"
},
"plan": null,
"usage": {
"period": "2026-10-06",
"started_at": "2026-10-06T12:00:00+00:00",
"lookups": 0,
"remaining": null,
"resets_at": "2026-11-06T12:00:00+00:00"
}
}
}Illustrative response. Values and release IDs are examples.
Try this endpoint with your API key
Request
curl --get 'https://feebase.co/api/v1/me' \
--header "Authorization: Bearer $FEEBASE_API_KEY" \
--header 'Accept: application/json'Example response · 200
{
"data": {
"team": {
"name": "Example practice",
"slug": "example-practice"
},
"api_key": {
"name": "Development",
"prefix": "fb_example",
"created_at": "2026-10-06T12:00:00+00:00"
},
"plan": null,
"usage": {
"period": "2026-10-06",
"started_at": "2026-10-06T12:00:00+00:00",
"lookups": 0,
"remaining": null,
"resets_at": "2026-11-06T12:00:00+00:00"
}
}
}Illustrative account without an active plan. This example does not change with the form. Run a request to see your actual response below.
Included requests and additional usage
Try it includes 500 successful metered requests each billing period, then $0.20 per additional request. Scale includes 100,000, then $0.02 per additional request. Errors and this account endpoint do not count. A successful batch request counts as one request.
The billing object includes enabled, included_requests, stop_at_included_requests, overage_cents, additional_requests, and accrued_cents. Accrued charges preserve the rate in effect when usage occurred, including before an upgrade.
The team owner can turn on Stop at included requests in Plan & billing. It is off by default. When enabled, new metered calls return 429 after the included allowance is exhausted. Requests already in progress and accrued charges are unaffected. Turning it off resumes additional usage; rate limits still apply.