Get usage

GET/v1/usage

Returns this month's platform emails, AI credits, API calls and storage against your plan's limits.

The same numbers as Settings > Usage. Platform emails: Free 20 a month, Team 100; your own SMTP is not counted. AI credits: Team gets 1,000 a month (2,000 in the first paid month); Free gets 250 welcome credits in the first month after adding a billing card. Free credits expire at the end of the month they were given; credit pack credits expire 12 months after purchase, and free credits are spent first.

Each meter has a warning flag that turns true at 80%. API calls and storage are fair-use limits. Monthly counters reset on the first of each month and do not roll over. See AI credits.

Permission: settings.view
Type: Read-only. Changes nothing.
Auth: API key, MCP token or signed-in session
Capability: get_usage
CLI: freeinvoiceautomation usage
Available: At launch, 1 January 2027

get_usage

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/usage \
  --header 'Authorization: Bearer <api-key>'

{
  "data": {
    "period": "2027-02-01",
    "plan": "team",
    "platform_emails": {
      "used": 82,
      "quota": 100,
      "warning": true
    },
    "ai_credits": {
      "balance": 1412,
      "free_credits": {
        "kind": "monthly",
        "balance": 412,
        "expires_at": "2027-02-28T23:59:59Z"
      },
      "pack_credits": [
        {
          "credit_pack_purchase_id": "0193f2e8-2b3c-7d4e-8f5a-6b7c8d9e0f12",
          "credits_remaining": 1000,
          "expires_at": "2028-01-20T14:02:00Z"
        }
      ],
      "warning": false
    },
    "api_calls": {
      "used": 4210,
      "limit": 100000,
      "warning": false
    },
    "storage_bytes": {
      "used": 52428800,
      "limit": 10737418240,
      "warning": false
    }
  }
}

Authorizations

Authorizationstringrequired

Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Response

200 - application/json

periodstring<date>

First day of the current month. Monthly counters reset on the first of each month and do not roll over.

planenum<string>

The account's current plan.

Available options: free, team, enterprise

platform_emailsobject

Emails sent through the platform mailer this month. Free includes 20 a month, Team 100. Your own SMTP is unlimited and not counted.

ai_creditsobject

AI credits for the invoice agent. Free credits are spent first, then the oldest pack.

api_callsobject

API calls this month against the fair-use limit.

storage_bytesobject

File storage against the fair-use limit, in bytes.

Suggest edits Raise issue

Create or update a PDF templatePrevious Get settingsNext

get_usage

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/usage \
  --header 'Authorization: Bearer <api-key>'

{
  "data": {
    "period": "2027-02-01",
    "plan": "team",
    "platform_emails": {
      "used": 82,
      "quota": 100,
      "warning": true
    },
    "ai_credits": {
      "balance": 1412,
      "free_credits": {
        "kind": "monthly",
        "balance": 412,
        "expires_at": "2027-02-28T23:59:59Z"
      },
      "pack_credits": [
        {
          "credit_pack_purchase_id": "0193f2e8-2b3c-7d4e-8f5a-6b7c8d9e0f12",
          "credits_remaining": 1000,
          "expires_at": "2028-01-20T14:02:00Z"
        }
      ],
      "warning": false
    },
    "api_calls": {
      "used": 4210,
      "limit": 100000,
      "warning": false
    },
    "storage_bytes": {
      "used": 52428800,
      "limit": 10737418240,
      "warning": false
    }
  }
}