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

# Get credits balance

`GET /api/v1/credits`

Get credits balance.

## 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.

---

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