---
title: "Get credits balance"
method: GET
path: "/api/v1/credits"
tags: ["Subscribe"]
---

# Get credits balance

`GET /api/v1/credits`

Returns the account credit balance and usage context.

## Response `200`

Credits balance and usage

- object
  - `auto_topup_amount_dollars` number, required — Configured dollar amount for each automatic top-up.
  - `auto_topup_enabled` boolean, required
  - `auto_topup_threshold` string, required — Credit balance threshold that triggers automatic top-up when enabled, represented as a bigint string.
  - `balance` string, required — Current credit balance as a bigint string to preserve precision above Number.MAX_SAFE_INTEGER.
  - `lifetime_purchased` string, required — Lifetime purchased credits as a bigint string.
  - `lifetime_used` string, required — Lifetime consumed credits as a bigint string.

## Other responses

- `401` — Unauthenticated
- `429` — Xquik tier rate limit exceeded. The response includes a `Retry-After` header with the number of seconds to wait before retrying.
- `default` — Unexpected error.

## Changes

- **2026-08-12** `5d4938bb7de3` — 54 warning
  - added the new `closed` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `closed` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `closed` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - added the new `closed` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `default`
  - …50 more
- **2026-08-12** `4da209b29df8` — 18 warning
  - added the new `coverage_cursor_gone` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `coverage_cursor_gone` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `coverage_cursor_gone` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - added the new `coverage_cursor_gone` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `default`
  - …14 more

[Change history](https://skmtc.dev/xquik-dev/apis/xquik-api-2/changes/api/v1/credits/get.md)

---

[API](https://skmtc.dev/xquik-dev/apis/xquik-api-2.md) · [All operations](https://skmtc.dev/xquik-dev/apis/xquik-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xquik-dev/xquik-api-2/revisions/834c16fa45e8/schema)