Skip to main content
GET
Get the credit balance of the calling principal

Get credit balance

GET /v1/credits Returns the current balance for the API key’s account or organization. This endpoint has no parameters and requires Authorization: Bearer YOUR_API_KEY.
A missing or expired API key returns 401 with the standard ErrorBody — see Errors and recovery.

Authorizations

Authorization
string
header
required

Server-side SDK clients use a project API key. Remote MCP clients use an OAuth access token. Never expose a project API key in browser code.

Headers

X-Request-Id
string

Optional caller-supplied correlation ID, up to 128 characters. The service returns the effective value in the response header for tracing and support.

Required string length: 1 - 128
X-Viggle-Source
string

Optional source-channel label, up to 128 characters, used to attribute traffic to an SDK, integration, product surface, or internal workflow.

Required string length: 1 - 128

Response

The one canonical balance value.

balance
number
required

Current spendable credit balance for the authenticated project or OAuth principal.