---
title: "Get the credit balance"
method: GET
path: "/credits"
tags: ["Credits"]
---

# Get the credit balance

`GET /credits`

## Request

- Base URL: `https://seogeoaeo.ai/api/v1`
- URL: `https://seogeoaeo.ai/api/v1/credits`
- Auth: HTTP bearer

## Response `200`

Current balance.

- object
  - `balance` CreditBalance
    - `monthly` integer: Monthly plan credits left this cycle.
    - `purchased` integer: Top-up credits held by the workspace.
    - `locked` integer: Top-up credits that unlock when a paid plan is active.
    - `total` integer: Credits a run can spend now.
    - `planActive` boolean

## Other responses

- `401`: Error envelope.
- `429`: Error envelope.

---

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