Pular para o conteúdo
Sursa Developers

Eventos · Faturamento

invoice.paid

Fatura paga

Uma fatura foi paga.

Tipo de objeto
invoice
Entregue a
Webhooks com a função admin

Payload

Objeto: EventInvoicePaid

  • idstringobrigatório

    ID do evento (evt_…), também enviado como cabeçalho webhook-id. Use-o para descartar entregas duplicadas.

  • typestringobrigatório

    Valores permitidos: invoice.paid

  • created_atstring (date-time)obrigatório

    Quando a alteração aconteceu (UTC).

  • org_idintegerobrigatório
  • api_versionstringobrigatório

    Versão do contrato do esquema data.

  • sequenceinteger

    Número de sequência da entrega dentro do webhook (ausente em um evento de teste).

  • objectWebhookEventObjectobrigatório
  • payloadstringobrigatório

    thin significa sem data: leia o objeto pela API.

    Valores permitidos: fullthin

  • dataobject
    Campos
    • invoiceEventInvoiceobrigatório
    • actor_idinteger | nullobrigatório

      O usuário que realizou a ação; null para uma chave de API da organização ou a própria plataforma.

  • testbooleanobrigatório

    Um evento de teste enviado por POST /v1/webhooks/{webhook_id}/test.

Exemplo de entrega

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "invoice.paid",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "invoice",
    "id": "301"
  },
  "payload": "full",
  "data": {
    "invoice": {
      "id": 301,
      "number": "INV-2026-000301",
      "amount": 1250,
      "currency": "EUR",
      "status": "paid",
      "period_start": "2026-10-01T00:00:00Z",
      "period_end": "2026-11-01T00:00:00Z",
      "issued_at": "2026-10-24T10:00:00Z",
      "due_at": "2026-11-07T10:00:00Z",
      "paid_at": "2026-10-25T09:00:00Z"
    },
    "actor_id": null
  },
  "test": false
}

Recebimento de eventos

Cada entrega é uma requisição POST com este corpo JSON para a URL do seu webhook. Verifique o cabeçalho webhook-signature (Standard Webhooks) antes de confiar no corpo, responda com um status 2xx em poucos segundos e faça o processamento depois. As entregas a um mesmo webhook mantêm a ordem dos eventos; uma entrega com falha é tentada de novo, com pausas cada vez maiores.

Novos tipos de evento e novos campos podem aparecer a qualquer momento: ignore os tipos e campos que você não conhece.

Os mesmos eventos ficam no feed de eventos por 30 dias →