Saltar al contenido
Vintu API
Tema de la documentación
Ir a la app

Ver la cuenta, sus límites y su uso

GET /v1/cuenta

Sirve cualquier clave válida, tenga los permisos que tenga. Úsala para comprobar una clave nueva y para conocer los límites que aplican a tu cuenta.

Permiso

Cualquier clave válida, tenga los permisos que tenga. Ver Autenticación y claves.

Petición

La clave se lee de la variable de entorno VINTU_API_KEY. Ver Inicio rápido.

curl "https://api.vintu.io/v1/cuenta" \
  -H "Authorization: Bearer $VINTU_API_KEY"

Respuesta

200 · Correcto.

Cabecera Descripción
X-Request-ID Identificador de la petición; cítalo al pedir soporte.
X-Vintu-Mode lectura_degradada cuando la coordinación no responde y los límites se aplican por réplica.
RateLimit-Limit Peticiones por minuto admitidas.
RateLimit-Remaining Peticiones que quedan en la ventana.
RateLimit-Reset Segundos hasta que se recupera el cupo.

Campos

Campo Tipo Descripción
id string · uuid Identificador público de la cuenta.
plan string Plan contratado.
limites object Límites vigentes para esta cuenta.
limites.api_rpm integer Peticiones por minuto que admite la cuenta.
limites.concurrency integer Operaciones simultáneas por clave.
limites.max_api_keys integer Claves activas que admite la cuenta.
limites.max_webhooks integer Destinos de webhook que admitirá la cuenta cuando existan.
uso object
uso.solicitudes integer Peticiones del mes en curso (UTC).
uso.errores integer Peticiones con error del mes en curso (UTC).
uso.subidas integer Comprobantes subidos por API este mes.
cuota_documentos object | null
cuota_documentos.limite integer | null Nulo si no hay límite.
cuota_documentos.usados integer
cuota_documentos.disponibles integer | null Nulo si no hay límite.
cuota_documentos.renueva_en string · date-time | null Próxima renovación.
creditos object | null
creditos.limite integer | null Nulo si no hay límite.
creditos.usados integer
creditos.disponibles integer | null Nulo si no hay límite.
creditos.renueva_en string · date-time | null Próxima renovación.

Cifras de una cuenta de ejemplo

Los valores de limites de este ejemplo son de una cuenta ficticia, no de un plan. Los de tu cuenta los devuelve esta misma operación.

Ejemplo con datos ficticiosJSON
{
  "id": "00000000-0000-4000-8000-0000000000a1",
  "plan": "contador",
  "limites": {
    "api_rpm": 100,
    "concurrency": 5,
    "max_api_keys": 3,
    "max_webhooks": 3
  },
  "uso": {
    "solicitudes": 1520,
    "errores": 4,
    "subidas": 0
  }
}

Errores

Todos con el cuerpo {"error": {"codigo", "mensaje", "id_peticion"}}. Compara contra codigo; el mensaje puede cambiar. Ver Errores.

Estado Códigos Cuándo
401 INVALID_API_KEY Clave ausente, mal formada, inexistente o revocada (INVALID_API_KEY).
403 SCOPE_REQUIREDAPI_PLAN_REQUIREDACCESS_DENIED La clave no tiene el permiso de la operación (SCOPE_REQUIRED), el plan no incluye la API (API_PLAN_REQUIRED) o la cuenta no tiene acceso activo (ACCESS_DENIED).
429 RATE_LIMITED Se superó el límite de peticiones (RATE_LIMITED). Espera lo que indica Retry-After.
503 DEPENDENCY_UNAVAILABLELOCAL_CAPACITY Servicio no disponible temporalmente (DEPENDENCY_UNAVAILABLE o LOCAL_CAPACITY). Reintenta tras Retry-After.