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

# Get Credits Balance

`GET /credits/balance`

## Request

- Base URL: `https://api.framesail.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.framesail.com/credits/balance`
- Auth: HTTP bearer

Returns the user's current credit balance, subscription details, and channel usage.

## Response `200`

Successful Response

- BalanceResponse
  - `credits_remaining` integer, required
  - `held_credits` integer, required
  - `monthly_allowance` integer, required
  - `subscription_status` string, required
  - `plan_id` string, required
  - `current_period_end` string, required
  - `max_channels` integer, nullable, required
  - `channels_used` integer, required
  - `cancel_at_period_end` boolean, required
  - `ended_at` string, nullable, required
  - `expiring_amount` integer, nullable, required
  - `expiring_at` string, nullable, required
  - `upgrade_plan_id` string, nullable, required

---

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