Public endpoint
/v1/credits
Returns the current credit balance snapshot for the API-key account.
All guides
Billing model
Shared credit wallet
How the GTMAPIs credit ledger supports product-backed API workflows through one account balance.
The Credit Ledger is the persisted balance and transaction history for credits; Product Control Plane modules own balance reads, grants, reservations, refunds, consumption, and cache invalidation.
Required scope
credits:read
Scoped API keys must include credits:read to inspect balances.
One ledger, product-specific policies
The Credit Ledger persists account balance and transaction history. Billing/Credit Policy owns plan catalog, credit amounts, validation charge policy, auto-topup settings, and product bonus credit amounts.
Balance reads stay behind an interface
The Credit Ledger Balance Reader keeps table shape and cache keys out of route handlers, access checks, and API-key credit balance endpoints.
Public balance endpoint
GET https://api.gtmapis.com/v1/credits returns the current Credit Ledger balance snapshot for the account associated with the API key, with Product Control Plane owning authentication and scope enforcement.
Related resources
Common questions
Does the shared wallet make future products public?
No. Product availability still comes from the Public Product Availability Catalog and publish gates.
Can API keys read credit balances?
Yes, when the key has the credits:read scope and belongs to the account whose balance is being read.