Get usage

Your plan, allowance, records used and reset date. Free.

Returns the plan your key is on and how much of its allowance is left. The same figures come back in the X-Records-* headers of every response, so you only need this endpoint for a standalone check.

Free: uses no records.

• Access: All plans, including the free demo.
• Records: free, uses none.
• MCP: the get_usage tool calls this endpoint. See MCP for developers.

Parameters

None.

Example request

curl "https://planningsignal.co.uk/api/v1/usage" \
  -H "Authorization: Bearer ps_live_your_key_here"

Example response

{
  "data": {
    "plan": "starter",
    "allowance": 2500,
    "used": 812,
    "remaining": 1688,
    "resets": "2026-11-01T00:00:00.000Z",
    "contact_fields": false,
    "conditions": false
  }
}

Errors

Every error has the same JSON shape: { "error": "...", "code": "..." }, with extra fields on some codes. Full bodies are on rate limits and errors.