Synup
Créer une clé
v1Ressources/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
Réponse
dataobjectfacultatif
usedThisPeriodnumberfacultatif
Credits used in the current period.
planLimitnumberfacultatif
Credits the plan gives for the period.
planUsednumberfacultatif
Credits used from the plan's own allowance.
remainingnumberfacultatif
Credits left.
topUpRemainingnumberfacultatif
Credits left from top-ups.
percentOfPlanUsedintegerfacultatif
How much of the plan's allowance is used, as a percentage.
periodStartstringfacultatif
When the period began.
periodEndstringfacultatif
When it ends.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/credits/balance
Votre clé API
{
  "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"
  }
}

Vous débutez avec l'API Synup ?