Synup
Crear clave
v1Recursos/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
Respuesta
dataobjectopcional
usedThisPeriodnumberopcional
Credits used in the current period.
planLimitnumberopcional
Credits the plan gives for the period.
planUsednumberopcional
Credits used from the plan's own allowance.
remainingnumberopcional
Credits left.
topUpRemainingnumberopcional
Credits left from top-ups.
percentOfPlanUsedintegeropcional
How much of the plan's allowance is used, as a percentage.
periodStartstringopcional
When the period began.
periodEndstringopcional
When it ends.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/credits/balance
Su clave de 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"
  }
}

¿Nuevo en la API de Synup?