Synup
Schlüssel erstellen
v1Ressourcen/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
Antwort
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.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/credits/balance
Ihr API-Schlüssel
{
  "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"
  }
}

Neu bei der Synup-API?