Evento payment.link.updated

Evento `payment.link.updated`

Disparado quando um payment link muda via POST /v1/payment-links/:id ou quando DELETE /v1/payment-links/:id vira desativação. Use este evento para manter a sua cópia do link alinhada depois de alterações na configuração ou no estado ativo. Atualizações afetam cliques futuros; sessões de checkout já materializadas mantêm as regras copiadas no momento do clique. data.object carrega o payment_link no estado atual. data.previous_attributes traz apenas os campos que mudaram, com os valores anteriores.

Quando is_active vira false, o link deixa de aceitar novos cliques. Isso não cancelará sessões de checkout que já foram criadas a partir do link.

Quando acontece

Situação	Como aparece no payload
Link editado	`data.object` vem atualizado e `previous_attributes` lista os campos alterados.
Link desativado por update	`data.object.is_active: false` e `previous_attributes.is_active: true`.
Link desativado por delete seguro	Mesmo shape de desativação: `is_active` muda para `false`.
Link reativado	`data.object.is_active: true` e `previous_attributes.is_active: false`.
Metadata substituída	`previous_attributes.metadata` mostra o objeto anterior.

Como processar

Registre o id do evento (evt_*) para processar o webhook de forma idempotente.
Use data.object.id (plink_*) como chave do payment link no seu sistema.
Atualize o registro local usando o data.object completo.
Use data.previous_attributes para auditoria e notificações condicionais.
Quando is_active for false, pare de exibir ou compartilhar o link para novos compradores.
Não altere sessões já criadas a partir do link; acompanhe essas sessões pelos eventos próprios de checkout e cobrança.

Campos importantes

Campo	O que observar
`data.object.is_active`	Define se o link aceita novos cliques.
`data.previous_attributes`	Valores anteriores dos campos públicos que mudaram.
`metadata`	Metadata atual do link; quando muda, o valor anterior fica no diff.
`updated_at`	Momento da alteração.
`organization`	Organização que originou o evento.

Variações de configuração e desativação

Variação	O que muda
Edição de oferta ou retorno	Mudanças no link valem para cliques futuros.
Troca de itens do link	Novos cliques usam os novos itens; sessões já materializadas preservam os itens antigos.
Desativação segura	Um `DELETE` pode virar `is_active=false` quando o link precisa permanecer auditável. Esse caminho emite `payment.link.updated`.
Remoção real	Quando o link pôde ser removido de verdade, a resposta direta do delete confirma `{ deleted: true }`; este evento cobre o caminho de atualização/desativação.

Exemplo de payload

{
  "id": "evt_3iTEpAag1LGBqrwe",
  "object": "event",
  "created_at": "2026-05-16T15:02:10Z",
  "data": {
    "object": {
      "id": "plink_zEeXtizG2A6woMaA",
      "object": "payment_link",
      "allow_discount_codes": false,
      "cancel_url": null,
      "created_at": "2026-05-16T14:09:27Z",
      "discount": null,
      "has_surcharge": false,
      "is_active": false,
      "label": "Plano Pro",
      "line_items": [
        {
          "id": "pli_QhEkGU3SD4FNcm9B",
          "adjustable_quantity": {
            "enabled": false,
            "maximum": null,
            "minimum": null
          },
          "amount_discount": 0,
          "amount_subtotal": 19990,
          "amount_tax": 0,
          "amount_total": 19990,
          "currency": "brl",
          "description": "Plano Pro",
          "metadata": {},
          "position": 0,
          "price": "price_7FQKZs7uJsprK6xj",
          "price_data": null,
          "product": "prod_9JBDjz1rFEUFiCAh",
          "quantity": 1,
          "recurring_interval": "month",
          "recurring_interval_count": 1,
          "unit_amount": 19990
        }
      ],
      "livemode": true,
      "metadata": {},
      "payment_method_collection": "always",
      "subscription_data": {},
      "success_url": "https://meusite.com/sucesso",
      "updated_at": "2026-05-16T15:02:10Z",
      "url": "https://pay.chargefy.io/link/9a1bc3d2e4f5..."
    },
    "previous_attributes": {
      "is_active": true
    }
  },
  "livemode": true,
  "organization": "org_iYUSJnXKi86czQmS",
  "request": {
    "id": null
  },
  "type": "payment.link.updated"
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Evento payment.link.updated