Skip to content

Consultar Eventos del Tenant

Devuelve tu registro de auditoría completo a nivel de tenant — verificación de correo, suscripción, pago y eventos del ciclo de vida de cambios de plan/intervalo de facturación — en orden cronológico (del más antiguo al más reciente).

GET /v1/tenants/events

Autenticación

Authorization: Bearer <api-key>

Cuándo llamar a este endpoint

Este es el único lugar que muestra la secuencia completa de cambios en tu suscripción a lo largo del tiempo — por ejemplo, que comenzó como una suscripción GROWTH mensual y luego cambió a STARTER anual. GET /v1/subscriptions/me y GET /v1/tenants/me solo muestran el estado actual; este endpoint muestra cómo se llegó a él.

Respuesta

200 OK

json
{
  "ok": true,
  "events": [
    {
      "id": "00000000-0000-0000-0000-000000000101",
      "eventType": "EMAIL_VERIFIED",
      "detail": null,
      "createdAt": "2026-06-01T10:00:00.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000118",
      "eventType": "SUBSCRIPTION_CREATED",
      "detail": { "subscriptionId": "00000000-0000-0000-0000-000000000012", "tier": "GROWTH", "billingInterval": "MONTHLY" },
      "createdAt": "2026-06-01T10:05:00.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000119",
      "eventType": "SUBSCRIPTION_ACTIVATED",
      "detail": { "subscriptionId": "00000000-0000-0000-0000-000000000012", "tier": "GROWTH" },
      "createdAt": "2026-06-01T10:20:00.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000205",
      "eventType": "TIER_CHANGE_REQUESTED",
      "detail": {
        "subscriptionId": "00000000-0000-0000-0000-000000000012",
        "fromTier": "GROWTH",
        "toTier": "STARTER",
        "fromBillingInterval": "MONTHLY",
        "toBillingInterval": "YEARLY",
        "totalAmount": 200,
        "effectiveAt": "2026-07-01T10:20:00.000Z"
      },
      "createdAt": "2026-06-25T09:00:00.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000212",
      "eventType": "TIER_CHANGE_SCHEDULED",
      "detail": {
        "subscriptionId": "00000000-0000-0000-0000-000000000012",
        "fromTier": "GROWTH",
        "toTier": "STARTER",
        "fromBillingInterval": "MONTHLY",
        "toBillingInterval": "YEARLY",
        "effectiveAt": "2026-07-01T10:20:00.000Z",
        "paymentId": "00000000-0000-0000-0000-000000000040"
      },
      "createdAt": "2026-06-27T14:10:00.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000230",
      "eventType": "TIER_CHANGED",
      "detail": {
        "subscriptionId": "00000000-0000-0000-0000-000000000012",
        "fromTier": "GROWTH",
        "toTier": "STARTER",
        "fromBillingInterval": "MONTHLY",
        "toBillingInterval": "YEARLY"
      },
      "createdAt": "2026-07-01T10:20:00.000Z"
    }
  ]
}

detail es un objeto de forma libre específico de cada eventType (o null para eventos sin contexto adicional) — los campos mostrados arriba coinciden con lo que cada tipo de evento lleva actualmente, pero trata los campos desconocidos como adiciones compatibles hacia adelante, no como un esquema fijo.

Tipos de evento

EventoSignificado
VERIFICATION_EMAIL_SENT / VERIFICATION_EMAIL_FAILED / VERIFICATION_EMAIL_DELIVERED / VERIFICATION_EMAIL_TEMP_FAILED / VERIFICATION_EMAIL_COMPLAINEDEstado de entrega del correo de verificación de registro
EMAIL_VERIFIEDEl correo del tenant fue verificado
SUBSCRIPTION_CREATEDSe inició una suscripción (POST /v1/subscriptions o en la promoción)
PAYMENT_REPORTEDSe envió el comprobante de transferencia para un pago
PAYMENT_VERIFIED / PAYMENT_REJECTEDEl proveedor revisó el comprobante de un pago
INVOICE_LINKEDSe vinculó una factura autofacturada a una suscripción o pago
SUBSCRIPTION_ACTIVATEDLa suscripción alcanzó el estado ACTIVE (se abrió el primer periodo de facturación)
TIER_CHANGE_REQUESTEDCambiar de Plan creó un pago (mejora en el mismo intervalo, o cualquier cambio de intervalo de facturación)
TIER_CHANGE_SCHEDULEDSe programó un cambio de plan/intervalo para aplicarse en current_period_end — ya sea una degradación gratuita en el mismo intervalo (de inmediato, al momento de la solicitud) o un cambio de intervalo de facturación pagado (una vez que la factura de su pago se autoriza)
TIER_CHANGEDUn cambio de plan y/o intervalo de facturación realmente tomó efecto
SUBSCRIPTION_CANCELLATION_SCHEDULEDDELETE /v1/subscriptions programó una cancelación al final del periodo
SUBSCRIPTION_CANCELLEDLa suscripción alcanzó el estado CANCELLED (se aplicó la cancelación programada, o hubo intervención administrativa)
RENEWAL_DUESe abrió un pago de renovación antes de current_period_end
SUBSCRIPTION_RENEWEDLa factura de un pago de renovación fue autorizada, extendiendo el periodo de facturación
SUBSCRIPTION_EXPIREDLa suscripción superó su periodo de gracia de renovación sin ningún pago y fue degradada a FREE

Errores

Estado HTTPCódigoCuándo ocurre
401UNAUTHORIZEDAPI key faltante o inválida
404NOT_FOUNDNo se pudo resolver el tenant (normalmente no debería ocurrir en una solicitud autenticada)
429TOO_MANY_REQUESTSLímite de tasa excedido

Notas

  • Devuelve un arreglo vacío si aún no ha ocurrido nada más allá del registro.
  • No está paginado — se devuelve el historial completo cada vez. Es suficiente para el volumen típico de vida útil de un tenant; si en algún momento se necesita paginación, ?sinceId= (siguiendo el patrón de Notificaciones) sería la adición natural.

Documentación de la API de Comprobify