Account

Get your current usage and quota

Check how many API calls you've used this month and how many remain.

Returns your current plan, calls used, monthly limit, and the UTC timestamp when your counter resets (the 1st of next month).

This call is free - it does not consume a credit.

Tip: Every API response also includes credits_remaining in the JSON body and X-RateLimit-Remaining / X-RateLimit-Reset in the response headers, so you can monitor usage inline without making a separate request.

get/v1/usage

Request

  • Base URL: https://api.registrum.co.uk
  • URL: https://api.registrum.co.uk/v1/usage
  • Auth: API key in header X-API-Key

Response

Usage stats for the authenticated key.

statusstring required

Always 'success'.

planstring required

Your current plan tier (free, web, pro, enterprise).

calls_usedinteger required

API calls made in the current billing month.

calls_limitinteger nullable required

Total calls allowed in the current billing month. null = no monthly cap.

credits_remaininginteger nullable required

Calls remaining before your monthly quota is exhausted. null = no monthly cap.

reset_atstring required

ISO 8601 UTC timestamp when your monthly counter resets.

Example response

{
  "calls_limit": 2000,
  "calls_used": 142,
  "credits_remaining": 1858,
  "plan": "pro",
  "reset_at": "2026-05-01T00:00:00+00:00",
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.