Skip to main content
GET
/
api
/
credits
Get Credit Balance
curl --request GET \
  --url https://apis.viggle.ai/api/credits \
  --header 'Authorization: Bearer <token>'
{
  "user_id": "usr_550e8400e29b41d4",
  "organization_id": "<string>",
  "credits_available": 250,
  "contract_id": "<string>"
}
Retrieve the current credit balance for your account.

​
Example

import requests

url = "https://apis.viggle.ai/api/credits"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

response = requests.get(url, headers=headers)
result = response.json()

if result.get("error_code"):
    print(f"Error: {result['error_code']} - {result.get('message')}")
else:
    print(f"Credit balance: {result['data']['balance']}")

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Response

Credit balance

​
user_id
string
Example:

"usr_550e8400e29b41d4"

​
organization_id
string | null

Organization ID if the API key belongs to an organization

​
credits_available
number
Example:

250

​
contract_id
string | null

Contract ID if the user has a contract-based pricing plan