---
title: "Get Credits Overview Route"
method: GET
path: "/api/v1/billing/credits/overview"
tags: ["billing"]
---

# Get Credits Overview Route

`GET /api/v1/billing/credits/overview`

## Request

- Base URL: `https://api.aws.cognee.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.aws.cognee.ai/api/v1/billing/credits/overview`
- Auth: API key in header `X-Api-Key`

Return the authenticated user's prepaid credit balance and per-tenant spend.

## Response `200`

Successful Response

- CreditsOverviewResponse
  - `budget` CreditsBudget, required
    - `totalUsd` number, required
    - `spentUsd` number, nullable
    - `remainingUsd` number, nullable
    - `spentPct` number, nullable
    - `tenantsUnreadable` integer, required
  - `tenants` TenantSpend[], required
    - `tenantId` string, uuid, required
    - `tenantName` string, required
    - `spentUsd` number, nullable
    - `maxBudgetUsd` number, nullable
    - `remainingUsd` number, nullable
    - `purchasedUsd` number
    - `initialBudgetUsd` number, nullable
  - `purchases` CreditPurchase[], required
    - `id` string, uuid, required
    - `tenantId` string, uuid, required
    - `tokensPurchased` integer, required
    - `amountPaidUsd` number, required
    - `currency` string, required
    - `createdAt` string, date-time, required
    - `invoiceUrl` string, nullable

---

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