> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtener uso

> Devuelve los contadores de uso del ciclo de facturación actual para el inquilino autenticado.

```http theme={null}
GET /v1/billing/usage
```

Devuelve los contadores de uso medido para el período de facturación actual. Cada contador rastrea un recurso facturable y muestra cuánto ha consumido en relación con el límite de su plan.

## Respuesta

Devuelve una matriz de objetos de contador de uso.

**metric** `string`

El identificador de la métrica de uso (por ejemplo, `attestations.mint`, `verifications_monthly`, `storage_bytes`).

**used** `integer`

Cantidad consumida en el período de facturación actual.

**limit** `integer`

Máximo permitido para esta métrica bajo su plan. Un valor de `-1` denota que no hay cuota configurada para esta métrica; los límites de servicio y de tasa aún se aplican.

**period** `string`

Período de facturación para este contador: `monthly` o `total`.

**unit** `string`

Unidad de medida: `count` o `bytes`.

**allowed** `boolean`

Si el inquilino tiene permitido actualmente consumir más de esta métrica. Devuelve `false` cuando se ha alcanzado el límite. Solo se incluye cuando es relevante.

**delta** `integer`

Cambio en el uso desde la última consulta. Solo se incluye cuando el servidor rastrea actualizaciones incrementales.

### Métricas rastreadas

El endpoint de uso devuelve hasta 16 métricas organizadas por grupo de productos. Las métricas que aparecen dependen de su plan y de las funciones activas.

#### Núcleo

| Métrica | Descripción | Unidad |
| - | - | - |
| `attestations.mint` | Atestaciones acuñadas | `count` |
| `verifications_monthly` | Verificaciones realizadas | `count` |
| `storage_bytes` | Almacenamiento total consumido | `bytes` |
| `proof_bundles` | Paquetes de prueba generados | `count` |
| `webhook_endpoints` | Puntos finales de webhook activos | `count` |
| `webhook_deliveries` | Entregas de webhook enviadas | `count` |
| `seats` | Puestos de miembros del equipo | `count` |

#### MAIP (Identidad de máquina)

| Métrica | Descripción | Unidad |
| - | - | - |
| `maip.agents` | Agentes de máquina registrados | `count` |
| `maip.sessions` | Sesiones de agente creadas | `count` |
| `maip.trust_computes` | Cálculos de puntuación de confianza | `count` |
| `maip.compliance_checks` | Solicitudes de verificación de cumplimiento | `count` |

#### IA

| Métrica | Descripción | Unidad |
| - | - | - |
| `ai.dataset_attestations` | Conjuntos de datos atestiguados para linaje | `count` |
| `ai.model_attestations` | Modelos atestiguados para la procedencia | `count` |

#### Antifraude

| Métrica | Descripción | Unidad |
| - | - | - |
| `antifraud.risk_signals` | Señales de riesgo ingeridas o generadas | `count` |
| `antifraud.deepfake_scans` | Solicitudes de escaneo de deepfake | `count` |
| `antifraud.velocity_records` | Registros de puntuación de velocidad | `count` |

> [!TIP]
>
> Para comprobar si una operación específica está permitida antes de realizarla, utilice el [punto final de derechos](https://docs.truthlocks.com/es/api-reference/billing/entitlements.md) para verificar sus cuotas.

## Panel de control de Console

También puede ver el uso visualmente en la consola en **Configuración > Facturación > Uso**. El panel muestra las 16 métricas organizadas por grupo de productos (Core, MAIP, AI y Antifraude), cada una mostrada como una barra de progreso contra el límite de su plan. Se calcula un costo mensual proyectado en función de su consumo actual y las tarifas efectivas por unidad.


## OpenAPI

````yaml es/mint-openapi.yaml GET /v1/billing/usage
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks es una infraestructura de verificación universal para documentos,
    credenciales y activos digitales.

    Esta especificación define la API canónica para interactuar con los
    servicios de Truthlocks.


    ## URLs Base

    - **Producción**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticación

    - **Claves API**: Use el encabezado `X-API-Key` para operaciones máquina a
    máquina

    - **Tokens Bearer**: Use `Authorization: Bearer <jwt>` para operaciones
    iniciadas por el usuario


    ## Identidad del Inquilino

    En producción, la identidad del inquilino se deriva del contexto autenticado
    (clave API o JWT).

    El encabezado `X-Tenant-ID` se ignora en producción para evitar la
    suplantación de identidad.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de producción
  - url: https://sandbox-api.truthlocks.com
    description: Entorno Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestión de claves y tokens de API
  - name: Issuers
    description: Registro del emisor y gestión de la confianza
  - name: Keys
    description: Gestión de claves criptográficas para emisores
  - name: Attestations
    description: Ciclo de vida de la atestación (acuñar, revocar, reemplazar)
  - name: Verification
    description: Verificación de atestación y paquetes de prueba
  - name: Governance
    description: Flujos de trabajo de gobernanza del emisor (solo administrador)
  - name: Identity
    description: Gestión de organización, usuarios y roles
  - name: Audit
    description: Consultas de eventos de auditoría
  - name: Tenant Console
    description: Puntos finales de perfil y ciclo de vida del inquilino
  - name: Health
    description: Endpoints de estado y preparación del servicio
  - name: Risk
    description: Ingesta de señales de riesgo y detección de fraude
  - name: Risk Enforcement
    description: >-
      Acciones de aplicación de riesgos: bloqueo, desafío, cuarentena y
      configuración
  - name: Billing
    description: Gestión de facturación, suscripciones y complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidad de Agente de Máquina (MAIP) — registro de agentes,
      sesiones, confianza, testigo, cumplimiento, orquestación y observabilidad
externalDocs:
  description: API de transparencia de solo lectura (especificación de servicio separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/usage:
    get:
      tags:
        - Billing
      summary: Obtener uso de facturación
      description: Devuelve el uso medido para el período de facturación actual.
      operationId: billing.usage
      parameters:
        - name: period
          in: query
          schema:
            type: string
          description: Período de facturación (ej. "2026-04")
      responses:
        '200':
          description: Datos de uso
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: string
                  usage:
                    type: object
                    additionalProperties: true
        '401':
          description: Autenticación requerida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Código de error legible por máquina
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Mensaje de error legible por humanos
        http_status:
          type: integer
          description: Código de estado HTTP
        retry_after_ms:
          type: integer
          description: Milisegundos a esperar antes de reintentar (para límites de tasa)
        details:
          type: object
          description: Contexto de error adicional
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clave API para autenticación máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operaciones iniciadas por el usuario

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.