Account

Get account credits

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

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

Headers

authorizationstring nullable

Response

Current account credit balance.

balanceCentsinteger required

Total spendable account balance in credits/cents.

balanceMicrocreditsstring required

Exact spendable balance in millionths of one credit.

ledgerUnitVersioninteger required

Authoritative account-ledger unit version.

balanceDollarsnumber required

Total spendable balance in USD dollars.

paygBalanceCentsinteger required

Purchased pay-as-you-go balance in credits/cents.

paygBalanceMicrocreditsstring required

paygBalanceDollarsnumber required

Purchased pay-as-you-go balance in USD dollars.

subscriptionBalanceCentsinteger required

Included subscription balance in credits/cents.

subscriptionBalanceMicrocreditsstring required

subscriptionBalanceDollarsnumber required

Included subscription balance in USD dollars.

subscriptionMonthlyGrantCentsinteger required

Monthly subscription credit grant in credits/cents.

subscriptionMonthlyGrantMicrocreditsstring required

subscriptionRolloverCapCentsinteger required

Maximum subscription rollover balance in credits/cents.

subscriptionRolloverCapMicrocreditsstring required

managedProviderReceivableMicrocreditsstring required

Outstanding provider cost that must be repaid before new managed work.

subscriptionPlanTierstring nullable

Current subscription plan tier, when available.

subscriptionPeriodEndstring date-time nullable

Current subscription period end, when available.

updatedAtstring date-time nullable

Timestamp when the balance record was last updated.

Example response

{
  "balanceCents": 1250,
  "balanceDollars": 12.5,
  "balanceMicrocredits": "1250110000",
  "ledgerUnitVersion": 2,
  "managedProviderReceivableMicrocredits": "0",
  "paygBalanceCents": 750,
  "paygBalanceDollars": 7.5,
  "paygBalanceMicrocredits": "750110000",
  "subscriptionBalanceCents": 500,
  "subscriptionBalanceDollars": 5,
  "subscriptionBalanceMicrocredits": "500000000",
  "subscriptionMonthlyGrantCents": 1000,
  "subscriptionMonthlyGrantMicrocredits": "1000000000",
  "subscriptionPeriodEnd": "2026-06-30T00:00:00Z",
  "subscriptionPlanTier": "pro",
  "subscriptionRolloverCapCents": 2000,
  "subscriptionRolloverCapMicrocredits": "2000000000",
  "updatedAt": "2026-06-09T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.