API reference/20 of 24

Usage

Plan meters for the authenticated key.

GET/usage

Your plan, what you've used this billing period, and what your plan allows. On self-serve accounts the count is shared between the website and the API. Images come from your monthly allowance first, then from packs, then (when overage is enabled) as extra images billed per 1,000. White-label partners see the same shape with their negotiated limits.

curl https://api.comprestack.com/api/v1/usage \
  -H "Authorization: Bearer $COMPRESTACK_API_KEY"

Response

{
  "object": "usage",
  "plan": "pro",
  "images_used": 1285,
  "images_limit": 2500,
  "pack_images": 500,
  "remaining": 1215,
  "overage_allowed": true,
  "overage_images": 0,
  "overage_cap": null,
  "overage_per_thousand_usd": 3.5,
  "overage_cost_usd": 0,
  "max_file_size_mb": 25,
  "batch_limit": 10,
  "lossless": true,
  "custom_quality": true,
  "rate_limit_per_minute": 60,
  "period_start": "2026-10-01T00:00:00.000Z",
  "resets_at": "2026-11-01T00:00:00.000Z",
  "files_expire_after_seconds": 3600
}