Skip to main content
GET
/
api
/
v1
/
credits
/
balance
Get Credit Balance
curl --request GET \
  --url https://api.example.com/api/v1/credits/balance \
  --header 'Authorization: Bearer <token>'
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_credits": 1,
  "used_credits": 1,
  "available_credits": 1,
  "tier": "free"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

User credit balance response model.

​
user_id
string<uuid>
required

User ID

​
total_credits
integer
required

Total credits available

Required range: x >= 0
​
used_credits
integer
required

Credits used

Required range: x >= 0
​
available_credits
integer
required

Credits available for use

Required range: x >= 0
​
tier
string
default:free

User's current tier