---
title: "Get Token Usage"
method: GET
path: "/payment/token-usage"
tags: ["PAYMENT"]
---

# Get Token Usage

`GET /payment/token-usage`

## Request

- Base URL: `https://api.myaltimate.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.myaltimate.com/payment/token-usage`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Token usage for UI progress bar.

## Headers

- `x-tenant` string

## Response `200`

Successful Response

- TokenUsageResponse: Token usage data for UI progress bar + wallet state.
  - `credit_type` string, required
  - `entitlement_type` string
  - `unlimited` boolean
  - `total_tokens` integer
  - `total_consumed` integer
  - `total_remaining` integer
  - `tokens_consumed` integer
  - `tokens_included` integer
  - `tokens_remaining` integer
  - `overage_tokens` integer
  - `overage_rate_cents_per_million` integer
  - `grant_tokens_total` integer
  - `grant_tokens_consumed` integer
  - `grant_tokens_remaining` integer
  - `period_start` string, nullable
  - `period_end` string, nullable
  - `wallet_balance_cents` number
  - `wallet_spend_this_period_cents` number

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-11** `70e0a3e5cb0d`: 1 info
  - added the optional property `entitlement_type` to the response with the `200` status

[Operation history](https://skmtc.dev/myaltimate/apis/myaltimate-api/changes/payment/token-usage/get.md)

---

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