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

# GET /api/v1/credits

`GET /api/v1/credits`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/credits`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

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_stopped` boolean, required: Whether declined charges stopped automatic top-up while it is enabled. It stops after 3 declines in a row on 1 card. A paid top-up, a paid plan renewal, or the next automatic top-up on a new card clears it.
  - `auto_topup_threshold` string, required: Credit balance threshold that triggers automatic top-up when enabled, as a bigint string.
  - `balance` string, required: Current credit balance as a bigint string, which keeps 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`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `4XX`: Client error. The error code says what to fix.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 10 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `4XX`
  - …6 more

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

---

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