---
title: "Read plan and remaining usage"
method: GET
path: "/account"
tags: ["Account"]
---

# Read plan and remaining usage

`GET /account`

## Request

- Base URL: `https://vaneform.com/api/v1`
- URL: `https://vaneform.com/api/v1/account`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Response `200`

Plan, website lookup allowance, and credit balance. This request spends 0 credits.

- AccountResource
  - `plan` string
  - `access_tier` string
  - `lookup` QuotaResource
    - `used` integer, required
    - `limit` integer, nullable, required: Null means this plan has no daily website lookup cap.
    - `remaining` integer, nullable, required
    - `resets_at` string, date-time, required
  - `credits` CreditsResource
    - `used` integer, required: Subscription credits used in the current UTC month.
    - `limit` integer, required: Monthly credits included with the plan.
    - `remaining` integer, required: All active credits, including future top-ups.
    - `top_up_remaining` integer, required
    - `resets_at` string, date-time, required

## Other responses

- `401`: Missing or invalid bearer key.
- `429`: Credits or per-key rate limit (60/minute, 5,000/day).
- `500`: Unexpected server failure.

---

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