PT EN

Subscription

Eventos de Subscription: 3 no total. Ver o envelope comum.

platform_invoice.issued

The platform issued an invoice for the utility's subscription.

Recurso: platform_invoice

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_QAAR5qDEipugGWXyrjpvut8ZPiQ",
  "type": "platform_invoice.issued",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "platform_invoice",
    "resource": {
      "type": "platform_invoice",
      "sequence": 1
    }
  }
}

platform_invoice.paid

The utility's subscription invoice was paid.

Recurso: platform_invoice

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_QAAR5qDEipugGWXyrJECdTDtkrj",
  "type": "platform_invoice.paid",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "platform_invoice",
    "resource": {
      "type": "platform_invoice",
      "sequence": 1
    }
  }
}

subscription.plan_changed

The utility's subscription plan changed.

Recurso: subscription

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_b64FRiRyZEWdg94v7w56kpAy4ta",
  "type": "subscription.plan_changed",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "subscription",
    "resource_id": "sub_b64FRiRyZEWdqGXVqUqkpaLWXWC",
    "resource": {
      "type": "subscription",
      "id": "sub_b64FRiRyZEWdqGXVqUqkpaLWXWC",
      "sequence": 1
    }
  }
}

Receber estes eventos

O seu endpoint de webhook recebe cada um destes eventos num POST com o envelope comum, descrito na tabela abaixo. Verifique a assinatura antes de agir, responda depressa com um código 2xx e faça o trabalho depois: uma resposta lenta ou falhada é enviada outra vez. O mesmo evento pode chegar mais de uma vez, por isso use o seu id para ignorar repetições.

CampoTipoSignificado
idstringIdentificador do evento; o mesmo em todas as tentativas de entrega.
typestringO nome do evento, por exemplo invoice.issued.
api_versionstringA versão da API em que o corpo é escrito.
tenant_idstringA empresa (espaço de trabalho) onde o evento aconteceu.
created_atstring (RFC 3339)Quando o evento foi registado.
request_idstringO pedido à API que causou a mudança, quando houve um; liga ao registo de pedidos.
data.resource_typestringO tipo do recurso que mudou.
data.resource_idstringO identificador desse recurso, para o ler na API.
data.attributesobjectCampos próprios de cada evento; podem não existir. Leia o recurso na API para o estado completo.
data.resource.sequenceintegerConta os eventos do mesmo recurso; ignore um evento que não seja mais recente do que o último que aplicou.

Outras categorias de eventos