---
title: "Get credit balance"
method: GET
path: "/workspaces/{workspace_id}/credits"
tags: ["Credits"]
---

# Get credit balance

`GET /workspaces/{workspace_id}/credits`

## Request

- Base URL: `https://api.compelling.ai/v1`
- URL: `https://api.compelling.ai/v1/workspaces/{workspace_id}/credits`
- Auth: HTTP bearer

Returns the current credit balance and a usage summary for the billing period.

## Response `200`

OK

- CreditBalance
  - `balance` integer: Remaining credits.
  - `used_this_period` integer
  - `total_this_period` integer
  - `resets_at` string, date-time

---

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