---
title: "Get your balance"
method: GET
path: "/v1/credits"
tags: ["Account"]
---

# Get your balance

`GET /v1/credits`

## Request

- Base URL: `https://platform.detectif.ai`
- URL: `https://platform.detectif.ai/v1/credits`
- Auth: HTTP bearer

Returns your plan, your available credits and the credits held by checks that are still running. On the unlimited plan `unlimited` is true and `available` is null. Requires scope `credits:read`.

## Response `200`

Success.

- CreditsObject
  - `request_id` string, required
  - `object` 'credits', required
  - `plan` 'free' | 'unlimited', required: Your plan.
  - `unlimited` boolean, required: true on the unlimited plan: checks use no credits and `available` is null.
  - `available` integer, nullable, required: Credits you can use; null on the unlimited plan.
  - `reserved` integer, required: Credits held by checks that are still running.
  - `price_per_operation` integer, required: Credits one completed check uses (0 on the unlimited plan).

## Other responses

- `401`: The API key is missing, invalid or revoked.
- `403`: The key lacks the required scope, the email address is not verified, or the account is suspended.
- `429`: Too many requests or too many operations at the same time. Wait for the number of seconds in Retry-After.
- `500`: Something went wrong on our side. No credits were used.

---

[API](https://skmtc.dev/detectif/apis/detectifai-developer-api.md) · [All operations](https://skmtc.dev/detectif/apis/detectifai-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/detectif/apis/detectifai-developer-api/revisions/24295482ed77?raw)