Saltar al contenido principal
GET
Obtener estado de facturación
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

string
El estado de la cuenta de facturación: ACTIVE, PAST_DUE, UNPAID o SUSPENDED.
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
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.
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.

Plazo de gracia

Las ventanas de gracia predeterminadas para el modo de contrato Estándar son: 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 para obtener más detalles.
Consulte fallos de pago y períodos de gracia para un desglose completo del flujo de trabajo de acceso gradual.

Autorizaciones

X-API-Key
string
header
requerido

Clave API para autenticación máquina a máquina

Respuesta

Estado de facturación

plan
string
status
string
trial_ends_at
string | null