> ## 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 estado de facturación

> Devuelve el estado de facturación actual, el modo de características y el período de gracia para el inquilino autenticado.

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

Devuelve el estado de facturación actual de su inquilino. Utilice este endpoint en su integración para detectar problemas de pago temprano y mostrar avisos a sus usuarios antes de que se restrinja el acceso.

Cuando todos los pagos están al día, `feature_mode` es `NORMAL` y `grace_until` es `null`. Si un pago falla, la cuenta entra en un flujo de trabajo de acceso gradual —Degradado, Restringido y luego Suspendido— con un período de gracia en cada etapa.

## Respuesta

**status** `string`

El estado de la cuenta de facturación: `ACTIVE`, `PAST_DUE`, `UNPAID` o `SUSPENDED`.

**feature\_mode** `string`

El nivel actual de capacidad de características:

* `NORMAL` — todas las funciones disponibles
* `DEGRADED` — el pago falló; todas las funciones siguen funcionando durante el período de gracia
* `RESTRICTED` — el período de gracia está a punto de expirar; las operaciones de escritura (acuñación, creación de claves) están deshabilitadas
* `SUSPENDED` — el período de gracia ha expirado; todo el acceso a la API está deshabilitado hasta que se resuelva el pago

**grace\_until** `string | null`

Marca de tiempo ISO 8601 de cuándo finaliza el período de gracia actual, o `null` si la cuenta está al día.

**banner** `string | null`

Un mensaje legible que describe la acción requerida, o `null` cuando no se necesita ninguna acción.

## Cuándo usar este endpoint

Use `GET /v1/billing/status` para:

* **Mostrar avisos de pago** — verifique `feature_mode` al iniciar la aplicación o iniciar sesión y muestre un banner cuando el valor sea diferente de `NORMAL`.
* **Proteger operaciones de escritura** — antes de acuñar o crear claves, verifique que `feature_mode` no sea `RESTRICTED` o `SUSPENDED`.
* **Seguimiento de plazos de gracia** — lea `grace_until` para mostrar a sus usuarios exactamente cuánto tiempo tienen para resolver un problema de pago.

```javascript theme={null}
const res = await fetch("https://api.truthlocks.com/v1/billing/status", {
  headers: { "X-API-Key": "tl_live_..." },
});
const { feature_mode, grace_until } = await res.json();

if (feature_mode !== "NORMAL") {
  showPaymentBanner(feature_mode, grace_until);
}
```

## Plazo de gracia

Las ventanas de gracia predeterminadas para el modo de contrato Estándar son:

| Transición | Ventana de gracia | Notificaciones |
| :- | :- | :- |
| NORMAL → DEGRADADO | 7 días | Recordatorios a T+24h, T+48h, T+72h |
| DEGRADADO → RESTRINGIDO | 14 días | Recordatorios en T+24h, T+48h, T+72h |
| RESTRINGIDO → SUSPENDIDO | Inmediato | Aviso final de suspensión |

Los contratos empresariales añaden 14 días adicionales a cada ventana. Los contratos gubernamentales utilizan un período de gracia fijo de 90 días sin suspensión automática. Consulte [modos de contrato](https://docs.truthlocks.com/es/billing/overview.md#contract-modes) para obtener más detalles.

> [!TIP]
>
> Consulte [fallos de pago y períodos de gracia](https://docs.truthlocks.com/es/billing/overview.md#payment-failures-and-grace-periods) para un desglose completo del flujo de trabajo de acceso gradual.


## OpenAPI

````yaml es/mint-openapi.yaml GET /v1/billing/status
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/status:
    get:
      tags:
        - Billing
      summary: Obtener estado de facturación
      description: >-
        Devuelve el estado de facturación, el plan actual y las banderas de
        características para el inquilino autenticado.
      operationId: billing.status
      responses:
        '200':
          description: Estado de facturación
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                  status:
                    type: string
                  trial_ends_at:
                    nullable: true
                    type: string
        '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.