Synup
Create a key
v1Resources/Credits/getGet the credit balance

Get the credit balance

Returns the workspace's credits for the current period: what the plan gives, what was used and what remains. Credits and a period only; no ledger or costs.

get/api/v1/credits/balance
credits:read
Response
dataobjectoptional
usedThisPeriodnumberoptional
Credits used in the current period.
planLimitnumberoptional
Credits the plan gives for the period.
planUsednumberoptional
Credits used from the plan's own allowance.
remainingnumberoptional
Credits left.
topUpRemainingnumberoptional
Credits left from top-ups.
percentOfPlanUsedintegeroptional
How much of the plan's allowance is used, as a percentage.
periodStartstringoptional
When the period began.
periodEndstringoptional
When it ends.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/credits/balance
Your API key
{
  "data": {
    "usedThisPeriod": 1240.5,
    "planLimit": 5000,
    "planUsed": 1240.5,
    "remaining": 3759.5,
    "topUpRemaining": 0,
    "percentOfPlanUsed": 25,
    "periodStart": "2026-10-01T00:00:00.000Z",
    "periodEnd": "2026-11-01T00:00:00.000Z"
  }
}

New to the Synup API?