Balance API

The Balance API allows you to retrieve the current credit balance for your account. This endpoint provides a simple way to check your available credits, which are used for various Meshy services.

GET/openapi/v1/balance

Get Balance

This endpoint retrieves the current credit balance for the authenticated user.

Returns

Returns an object containing the current credit balance. For team members, these values reflect the team's shared credit pool.

Name
balance
Type
integer
Description
The number of credits currently available in your account.
Name
monthly_credits
Type
integer
Description
The number of remaining credits that expire at the next monthly refresh, as specified by monthly_resets_at.
Name
permanent_credits
Type
integer
Description
The number of credits that do not expire, such as credits from purchased credit packs or earned rewards.
Name
monthly_resets_at
Type
timestamp
Description
The time of the next monthly credit refresh, expressed as a Unix timestamp in milliseconds. At this time, the current monthly credits expire and are replenished, provided the subscription is active. Returns null if no refresh is scheduled.

Normally, balance equals monthly_credits + permanent_credits. If a member or workspace credit limit applies to the caller, balance may be lower.

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
}