---
title: "Get Credits Ledger Readiness"
method: GET
path: "/auth/credits/ledger-readiness"
tags: ["Account"]
---

# Get Credits Ledger Readiness

`GET /auth/credits/ledger-readiness`

## Request

- Base URL: `https://qveris.ai/api/v1`
- URL: `https://qveris.ai/api/v1/auth/credits/ledger-readiness`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/login`)

Check whether this user's account history can safely switch to credits_ledger.

## Query parameters

- `start_date` string, nullable: 开始日期 (YYYY-MM-DD)
- `end_date` string, nullable: 结束日期 (YYYY-MM-DD)

## Response `200`

Successful Response

- APIResponseCreditsLedgerReadinessResponse
  - `status` string, required
  - `message` string, required
  - `status_code` integer
  - `data` CreditsLedgerReadinessResponse
    - `checked_at` string, date-time, required
    - `start_date` string, date-time, nullable
    - `end_date` string, date-time, nullable
    - `scope` string, required
    - `recommended_read_mode` string, required
    - `ready` boolean, required
    - `legacy_total_count` integer, required
    - `legacy_total_amount_credits` number, required
    - `ledger_total_count` integer, required
    - `ledger_total_amount_credits` number, required
    - `entities` CreditsLedgerReadinessEntity[], required
      - `entity_type` string, required
      - `legacy_count` integer, required
      - `legacy_amount_credits` number, required
      - `ledger_count` integer, required
      - `ledger_amount_credits` number, required
      - `missing_count` integer, required
      - `extra_count` integer, required
      - `amount_delta_credits` number, required
      - `ready` boolean, required
  - `message_key` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/qveris/apis/qveris-public-rest-api.md) · [All operations](https://skmtc.dev/qveris/apis/qveris-public-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/qveris/apis/qveris-public-rest-api/revisions/7b78aeef092a?raw)