---
title: "Get account credits"
method: GET
path: "/api/v1/account/credits"
tags: ["Account"]
---

# Get account credits

`GET /api/v1/account/credits`

## Request

- Base URL: `https://api.studio.kaitoi.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.studio.kaitoi.io/api/v1/account/credits`
- Auth: HTTP bearer

Returns the authenticated user's current spendable account credit balance and PAYG/subscription breakdown. Requires the `account_credits:read` scope.

## Headers

- `authorization` string, nullable

## Response `200`

Current account credit balance.

- PublicAccountCredits
  - `balanceCents` integer, required: Total spendable account balance in credits/cents.
  - `balanceMicrocredits` string, required: Exact spendable balance in millionths of one credit.
  - `ledgerUnitVersion` integer, required: Authoritative account-ledger unit version.
  - `balanceDollars` number, required: Total spendable balance in USD dollars.
  - `paygBalanceCents` integer, required: Purchased pay-as-you-go balance in credits/cents.
  - `paygBalanceMicrocredits` string, required
  - `paygBalanceDollars` number, required: Purchased pay-as-you-go balance in USD dollars.
  - `subscriptionBalanceCents` integer, required: Included subscription balance in credits/cents.
  - `subscriptionBalanceMicrocredits` string, required
  - `subscriptionBalanceDollars` number, required: Included subscription balance in USD dollars.
  - `subscriptionMonthlyGrantCents` integer, required: Monthly subscription credit grant in credits/cents.
  - `subscriptionMonthlyGrantMicrocredits` string, required
  - `subscriptionRolloverCapCents` integer, required: Maximum subscription rollover balance in credits/cents.
  - `subscriptionRolloverCapMicrocredits` string, required
  - `managedProviderReceivableMicrocredits` string, required: Outstanding provider cost that must be repaid before new managed work.
  - `subscriptionPlanTier` string, nullable: Current subscription plan tier, when available.
  - `subscriptionPeriodEnd` string, date-time, nullable: Current subscription period end, when available.
  - `updatedAt` string, date-time, nullable: Timestamp when the balance record was last updated.

## Other responses

- `401`: Authentication is required.
- `403`: The API key is missing the required scope.
- `422`: Validation Error
- `503`: Managed billing is not enabled.

---

[API](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api.md) · [All operations](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api/revisions/239a74aa2c64?raw)