Saltar al contenido
Documentación para desarrolladoresReferencia de la APICuenta

Consultar el saldo

Créditos disponibles, del plan, comprados y reservados.

GEThttps://runner.cargoduo.com/v1/balance

Autenticación

Clave de API Bearer con el permisoaccount:readMás información

Ejemplo de solicitud

curl -X GET "https://runner.cargoduo.com/v1/balance" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

Ejemplo de respuesta

200 OK · Balance
{
  "available_credits": 147.75,
  "subscription_credits": 98.5,
  "subscription_expires_at": "2026-11-07T00:00:00Z",
  "purchased_credits": 50,
  "reserved_credits": 0.75
}

Respuestas

  • 200OKSaldo.
    NombreTipoObligatorioDescripción
    available_creditsnumber · credits
    number · credits
    No

    Lo que pueden usar los trabajos nuevos (suscripción + comprados − reservados).

    subscription_creditsnumber · credits
    number · credits
    No

    Créditos mensuales de la suscripción que quedan (se gastan primero; caducan en subscription_expires_at).

    subscription_expires_atstring | null
    string | null
    No

    Cuándo caducan los créditos mensuales (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    No

    Créditos de recargas (no caducan).

    reserved_creditsnumber · credits
    number · credits
    No

    Retenidos por trabajos en cola o en curso.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedClave de API ausente, mal formada o desconocida.
    • key_revokedLa clave se ha revocado.
    • key_expiredLa clave ha superado su fecha de caducidad.
    NombreTipoObligatorioDescripción
    errorErrorBodyobligatorio
    ErrorBody
    Sí
    Todos los códigos de error
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedLa IP de origen no está en la lista de IP permitidas de la clave.
    • subscription_inactiveLa organización no tiene ninguna suscripción activa que incluya la API.
    • account_inactiveLa organización está suspendida o no tiene ningún propietario con la cuenta activa.
    • scope_missingA la clave le falta un permiso que requiere este endpoint.
    NombreTipoObligatorioDescripción
    errorErrorBodyobligatorio
    ErrorBody
    Sí
    Todos los códigos de error
  • 429Too many requestsrate_limited
    • rate_limitedDemasiadas solicitudes en el minuto, la hora o el día en curso (por clave o por organización), o más de 60 autenticaciones fallidas por minuto desde tu dirección IP.
    NombreTipoObligatorioDescripción
    errorErrorBodyobligatorio
    ErrorBody
    Sí
    Todos los códigos de error
  • 500Internal server errorinternal_error
    • internal_errorAlgo ha fallado por nuestra parte.
    NombreTipoObligatorioDescripción
    errorErrorBodyobligatorio
    ErrorBody
    Sí
    Todos los códigos de error
  • 503Service unavailableapi_disabled
    • api_disabledLa API está desactivada temporalmente (mantenimiento) o deshabilitada para la organización.
    NombreTipoObligatorioDescripción
    errorErrorBodyobligatorio
    ErrorBody
    Sí
    Todos los códigos de error