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

# Get credit balance

`GET /v1/credits`

## Request

- Base URL: `https://voice-api.kata.ai`
- URL: `https://voice-api.kata.ai/v1/credits`
- Auth: API key in header `X-Partner-Key`
- TypeScript: <https://skmtc.dev/kata/apis/kata-voice-api/docs/v1/credits/get.ts> (a function with typed inputs; its response is checked against the schema)

Read-only. Returns `metered=false` and nothing else when your tenant is not on a prepaid credit balance.

## Response `200`

Balance

- Credits
  - `metered` boolean
  - `credit` number
  - `credit_expire` string
  - `free_credit` number
  - `free_credit_expire` string
  - `remaining` number
  - `credits_per_block` number
  - `billing_block_seconds` integer
  - `estimated_minutes_remaining` number

## Other responses

- `401`: Missing, unknown or revoked partner key
- `503`: A platform dependency is unavailable or the credit check could not run; nothing was placed

---

[API](https://skmtc.dev/kata/apis/kata-voice-api.md) - [All operations](https://skmtc.dev/kata/apis/kata-voice-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kata/apis/kata-voice-api/revisions/dacd1e44eb3f?raw)