Balance API

Check how many credits you can spend, and how many of them expire at the next monthly refresh.

GET/openapi/v1/balance

Get the balance

Returns the credit balance of the account that owns the API key. On a team with a shared credit pool, the values are those of the pool. Calling this endpoint is free.

Request

GET

/openapi/v1/balance

curl https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "balance": 1000,
  "monthly_credits": 600,
  "permanent_credits": 400,
  "monthly_resets_at": 1793491200000
}

Returns

Name
balance
Type
integer
Description
Number of credits you can spend. It's usually monthly_credits plus permanent_credits.
It can be lower when a member credit limit or an Enterprise workspace credit limit applies to you. Team owners and admins have no such limit.
Name
monthly_credits
Type
integer
Description
Number of remaining credits that expire at the next monthly refresh, at monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Number of credits that don't expire, for example from credit packs you bought and from rewards.
Name
monthly_resets_at
Type
timestamp
Description
Time of the next monthly credit refresh, in Unix milliseconds. At that time, the remaining monthly credits expire, and an active subscription refills them. null when no refresh is scheduled.

Failure modes

Name
401 - Unauthorized
Description
The API key is missing or invalid. Check the Authorization header.
Name
429 - Too Many Requests
Description
You sent too many requests. Wait the number of seconds in Retry-After, then retry.