---
title: "List credits"
method: GET
path: "/credits"
tags: ["Credits"]
---

# List credits

`GET /credits`

## Request

- Base URL: `https://api.togai.com`
- URL: `https://api.togai.com/credits`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/togaihq/apis/togai-apis/docs/credits/get.ts> (a function with typed inputs; its response is checked against the schema)

Get all credits

## Query parameters

- `nextToken` string
- `status` string
- `account_id` string
- `id` string
- `pageSize` integer

## Response `200`

Response for Get invoice requests

- ListCreditsResponse: List credits response
  - `data` Credit[], required
    - `accountId` string, required
    - `purpose` string, required
    - `applicableEntityIds` string[]: List of entity ids for which the credit is applicable. If null or empty, the credit is applicable to all ids. This list can accept special values like: - ALL_USAGE_METER_RATE_CARDS: To apply the credit to all usage meter rate cards - ALL_FIXED_FEE_RATE_CARDS: To apply the credit to all fixed fee rate cards
    - `effectiveFrom` string, date, required
    - `effectiveUntil` string, date
    - `creditAmount` number
    - `priority` integer, required
    - `grantorId` string: The entity through which the credit has been granted
    - `idempotencyKey` string: The idempotency key for uniqueness of the credit record
    - `id` string, required: Identifier of credits
    - `customerId` string, required
    - `status` 'ACTIVE' | 'CONSUMED' | 'EXPIRED' | 'VOIDED', required
    - `creditUnit` string
    - `holdAmount` number
    - `consumedAmount` number
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time
  - `nextToken` string

## Other responses

- `400`: Error response
- `401`: Error response
- `403`: Error response
- `404`: Error response
- `429`: Error response
- `default`: Error response

## Changes

- **2023-11-30** `b3351be4b462`: 1 breaking
  - the response property `data/items/allOf[#/components/schemas/CreditRequest]/creditAmount` became optional for the status `200`
- **2023-09-25** `ae3b70608528`: 1 info
  - added the optional property `data/items/allOf[#/components/schemas/CreditRequest]/idempotencyKey` to the response with the `200` status
- **2023-09-07** `cfabb13f9886`: 2 info
  - added `#/components/schemas/CreditRequest` to the `data/items/` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/CreateCreditRequest` from the `data/items/` response property `allOf` list for the response status `200`
- **2023-09-02** `6b13f6f47735`: 2 info
  - added `#/components/schemas/CreateCreditRequest` to the `data/items/` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/CreditRequest` from the `data/items/` response property `allOf` list for the response status `200`

[Operation history](https://skmtc.dev/togaihq/apis/togai-apis/changes/credits/get.md)

---

[API](https://skmtc.dev/togaihq/apis/togai-apis.md) - [All operations](https://skmtc.dev/togaihq/apis/togai-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/togaihq/apis/togai-apis/revisions/442f5d8f4aa0?raw)