Skip to main content
GET
Get Credit Balance

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