---
title: "Get the credit balance for a workspace."
method: GET
path: "/api/external/v1/account/credits"
tags: ["Account"]
---

# Get the credit balance for a workspace.

`GET /api/external/v1/account/credits`

Enrichment and AI generation spend credits, so an integration can check
what is left before starting work that would fail part-way through.

Credits are pooled across an account: `remaining` is what the whole pool
has left, while `workspace_used` and `workspace_limit` describe this one
workspace's share of it. A null `workspace_limit` means uncapped — the
workspace can draw on the whole pool.

## Query parameters

- `workspace_id` integer, required — The workspace to report on.

## Response `200`

- object
  - `plan` string
  - `remaining` integer
  - `workspace_used` integer
  - `workspace_limit` string
  - `renews_at` string

## Other responses

- `403`

## Changes

- **2026-08-17** `dd3f47f72f7a` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/genpage/apis/genpage-external-api-documentation/changes/api/external/v1/account/credits/get.md)

---

[API](https://skmtc.dev/genpage/apis/genpage-external-api-documentation.md) · [All operations](https://skmtc.dev/genpage/apis/genpage-external-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/genpage/genpage-external-api-documentation/revisions/29a37db12acb/schema)