---
title: "Check your plan and remaining credits"
method: GET
path: "/status"
tags: ["Account"]
---

# Check your plan and remaining credits

`GET /status`

## Request

- Base URL: `https://api.cofferdock.com`
- URL: `https://api.cofferdock.com/status`
- Auth: API key in header `x-api-key`

Returns your plan, the monthly limit, how many credits you have used and how many are left. Free: does not cost a credit. Useful at the start of a workflow to decide whether to continue. Customers who have been subscribed for a few months get a loyalty bonus: it is already included in the limit, and shown separately in loyalty.

## Response `200`

Usage status.

- object
  - `plan` 'free' | 'pro' | 'business' | 'scale'
  - `limit` integer, nullable
  - `unlimited` boolean
  - `used` integer
  - `remaining` integer, nullable
  - `loyalty` object: Loyalty bonus for long-time subscribers. bonus = extra credits per month already counted in limit.
    - `pct` integer
    - `bonus` integer
  - `reset` string

## Other responses

- `401`: Missing or invalid API key.

---

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