---
title: "Oauth Credits Ledger"
method: GET
path: "/oauth/credits_ledger"
tags: ["Authentication"]
---

# Oauth Credits Ledger

`GET /oauth/credits_ledger`

## Request

- Base URL: `https://qveris.ai/api/v1`
- URL: `https://qveris.ai/api/v1/oauth/credits_ledger`
- Auth: HTTP bearer

Requires an Account Resource access token with the `credits_ledger` scope.

## Query parameters

- `start_date` string, nullable: 开始日期 (YYYY-MM-DD)
- `end_date` string, nullable: 结束日期 (YYYY-MM-DD)
- `entry_type` string, nullable: 账本事件类型
- `scope` string, nullable: 预定义账本范围，例如 account_history
- `page` integer: 页码
- `page_size` integer: 每页数量
- `min_credits` number, nullable
- `max_credits` number, nullable
- `direction` string
- `bucket` string, nullable
- `summary` boolean
- `limit` integer, nullable: 摘要模式最多返回条数

## Response `200`

Successful Response

- APIResponseCreditsLedgerResponse
  - `status` string, required
  - `message` string, required
  - `status_code` integer
  - `data` CreditsLedgerResponse
    - `items` CreditsLedgerItem[], required
      - `id` string, required
      - `entry_type` string, required
      - `amount_credits` number, required
      - `source_system` string, required
      - `source_ref_type` string, nullable
      - `source_ref_id` string, nullable
      - `execution_id` string, nullable
      - `pre_settlement_bill` object, nullable
      - `settlement_result` object, nullable
      - `balance_before` object, nullable
      - `balance_after` object, nullable
      - `ledger_metadata` object, nullable
      - `description` string, nullable
      - `created_at` string, date-time, required
    - `total` integer, required
    - `page` integer, required
    - `page_size` integer, required
    - `summary` CreditsLedgerSummary
      - `start_date` string, date-time, nullable
      - `end_date` string, date-time, nullable
      - `bucket` string, required
      - `total_entries` integer, required
      - `consume_count` integer, required
      - `grant_count` integer, required
      - `consumed_credits` number, required
      - `granted_credits` number, required
      - `net_amount_credits` number, required
      - `max_amount_items` CreditsLedgerItem[], required
        - `id` string, required
        - `entry_type` string, required
        - `amount_credits` number, required
        - `source_system` string, required
        - `source_ref_type` string, nullable
        - `source_ref_id` string, nullable
        - `execution_id` string, nullable
        - `pre_settlement_bill` object, nullable
        - `settlement_result` object, nullable
        - `balance_before` object, nullable
        - `balance_after` object, nullable
        - `ledger_metadata` object, nullable
        - `description` string, nullable
        - `created_at` string, date-time, required
      - `buckets` CreditsLedgerSummaryBucket[], required
        - `bucket_start` string, date-time, required
        - `entry_count` integer, required
        - `consume_count` integer, required
        - `grant_count` integer, required
        - `consumed_credits` number, required
        - `granted_credits` number, required
        - `net_amount_credits` number, 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)