Skip to content
einvoicing.dev

API/Account

Get usage for the current billing period

GET/v1/usage· API key

How much of the plan's allowance has been used this period. Lets a client, or an agent, check headroom before a batch rather than find out from a 402. Reading usage is not itself metered.

Request
curl https://api.einvoicing.dev/v1/usage \  -H "Authorization: Bearer $EINVOICING_API_KEY"

Response

200

Usage for the current billing period.

FieldTypeDescription
datarequiredUsageUsage in the current billing period.
Example responseapplication/json
{  "data": {    "plan": "developer",    "period_start": "2026-09-01T00:00:00.000Z",    "period_end": "2026-10-01T00:00:00.000Z",    "documents": {      "used": 1412,      "included": 2000,      "overage": 0    },    "lookups": {      "used": 380,      "included": 5000,      "overage": 0    }  }}

Errors

Every error is application/problem+json (RFC 9457). Branch on type, which is stable, never on title or detail.

StatusWhen
401

No key, or a key that is unknown or revoked. Problem type is unauthenticated.

/problems/unauthenticated

429

Too many requests in a short window. Slow down and retry after the number of seconds in Retry-After. Problem type is rate-limited.

/problems/rate-limited

Schemas

Usage

Usage in the current billing period.

FieldTypeDescription
planrequiredstring

freedeveloperpro

period_startrequiredTimestamp · date-timeRFC 3339, UTC, millisecond precision.
period_endrequiredTimestamp · date-timeRFC 3339, UTC, millisecond precision.
documentsrequiredMeterOne metered allowance. documents counts validations and conversions together; lookups counts participant lookups.
lookupsrequiredMeterOne metered allowance. documents counts validations and conversions together; lookups counts participant lookups.