Credit Balance

Read the current Credit Ledger balance for an API key account

GET /v1/credits

Read the current Credit Ledger balance snapshot for the account associated with the API key.

Endpoint

GET https://api.gtmapis.com/v1/credits

Headers

Header	Required	Description
X-API-Key	Yes	Your GTMAPIs API key. Scoped keys require credits:read.

Example Request

cURL

curl https://api.gtmapis.com/v1/credits \
  -H "X-API-Key: gtm_test_1234567890abcdef1234567890abcdef"

Example Response

{
  "balance": 12345,
  "total_purchased": 25000,
  "total_consumed": 12655
}

Notes

• The Product Control Plane owns API-key authentication, credits:read scope enforcement, Credit Ledger Balance Reader access, response shape, and rate limiting.
• If api.gtmapis.com is served by the Go Validation Engine, GET /v1/credits should only be a forwarding shim to the Product Control Plane-owned handler.