---
title: "Current-period usage and quota"
method: GET
path: "/api/v1/account/usage"
tags: ["Account"]
---

# Current-period usage and quota

`GET /api/v1/account/usage`

## Request

- Base URL: `https://propraven.com`
- URL: `https://propraven.com/api/v1/account/usage`
- Auth: HTTP bearer

Returns the calling key's current-period API usage, included allotment, remaining calls, configured per-minute and per-day rate limits, and the hard-cap status. Per-user (all of a user's API keys roll up to the same monthly counter, since they share a Stripe subscription). `lookups` reports the account's monthly lookup cap (record views and people data), a separate counter from API calls.

## Response `200`

Usage report.

- AccountUsage
  - `tier` 'free' | 'starter' | 'pro' | 'scale' | 'api_100k', required
  - `period` string, required
  - `period_start` string, required
  - `period_end` string, required
  - `calls_used` integer, required
  - `calls_included` integer, required: Plan allotment for the current period.
  - `calls_remaining` integer, required
  - `rate_limit` object, required
    - `per_minute` number, required
    - `per_day` number, required
  - `hard_cap_enabled` boolean, required
  - `auth_source` string, required
  - `hard_capped` boolean: Whether further calls will be hard-rejected vs allowed-and-billed.
  - `lookups` object, nullable: The account's monthly LOOKUP cap — a separate counter from API calls. A record view and each people-data response (owner card, /owner, permits carrying owner/applicant names or contacts, tax-delinquency records, person licensees) spends one lookup for an account without a paid entitlement; a paid plan includes them. `limit: null` = unlimited. Null when the counter could not be read (never reported as 0).
    - `used` integer, required
    - `limit` integer, nullable, required
    - `remaining` integer, nullable, required
    - `plan` string, required

## Other responses

- `401`: Missing, malformed or invalid credential.
- `405`: The endpoint exists but does not support this method. `Allow` lists the methods it does.
- `429`: Rate limit exceeded.
- `500`: Unexpected server error. The body never carries database or driver text.

---

[API](https://skmtc.dev/propraven/apis/propraven-api.md) · [All operations](https://skmtc.dev/propraven/apis/propraven-api/llms.txt) · [OpenAPI document](https://skmtc.dev/propraven/apis/propraven-api/revisions/37f8158c4eda?raw)