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

# Get credit balance

`GET /api/credits/balance`

## Request

- Base URL: `https://api.zvid.io`
- URL: `https://api.zvid.io/api/credits/balance`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Retrieve the authenticated user's current credit balance

## Response `200`

Credit balance retrieved successfully

- CreditBalance
  - `balance` integer, required: Total available credits from subscription and add-on pools
  - `subscriptionCredits` integer, required: Credits remaining in the current subscription period
  - `addonCredits` object, required: Add-on credit pool and historical add-on totals
    - `balance` integer, required: Available add-on credits
    - `totalEarned` integer, required: Total add-on credits earned over all time
    - `totalSpent` integer, required: Total add-on credits spent over all time

## Other responses

- `401`: Unauthorized
- `500`: Internal server error

---

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