GET /v1/usage

Usage.

Get your current billing period usage, remaining quota, and plan details. Useful for monitoring consumption in CI/CD pipelines.

Authentication

Requires a valid API key. Returns usage for the organization associated with the key.

Response

{
  "tier": "PRO",
  "billing_period": {
    "start": "2026-03-01T00:00:00Z",
    "end": "2026-03-31T23:59:59Z"
  },
  "scans": {
    "used": 142,
    "limit": 200,
    "remaining": 58
  },
  "rate_limit": {
    "requests_per_minute": 60,
    "concurrent_scans": 10
  }
}

Response fields

Field	Type	Description
`billing_mode`	string	Your billing mode: `free`, `packs`, or `metered`.
`free_scans.used`	integer	Free scans used this month.
`free_scans.limit`	integer	Free scan allowance (5/month + bonus).
`free_scans.remaining`	integer	Free scans remaining this month.
`credits_balance`	integer	Remaining purchased credits (from credit packs).
`rate_limit.requests_per_minute`	integer	API rate limit (10 free, 60 paid).
`metered`	object \| null	Metered usage info (only for auto-billing users).

Credit system

Everyone gets 5 free scans per month. Need more? Buy credit packs, credits never expire. For heavy usage, switch to auto-billing with volume discounts.

Pack	Credits	Price	Per scan
Micro	5	$5	$1.00
Starter	12	$10	$0.83
Growth	35	$25	$0.71
Pro	80	$50	$0.63
Business	200	$100	$0.50

Code example

curl https://appvet.dev/v1/usage \
  -H "Authorization: Bearer avk_live_your_key_here"

Error responses

Status	Code	Description
401	`UNAUTHORIZED`	Missing or invalid API key.