Skip to main content
curl -X DELETE "https://api.chargefy.io/v1/payment-links/plink_123" \
  -H "Authorization: Bearer {{API_KEY}}"
{
  "id": "plink_123",
  "object": "payment_link",
  "deleted": true
}
Remove um payment_link quando ele ainda não materializou nenhuma checkout.session. Se o link já foi usado, a Chargefy desativa automaticamente com is_active=false e retorna o objeto completo atualizado.

Autenticação

Mesmo contrato de POST /v1/payment-links: API key da organização com escopo de escrita, ou API key da plataforma com header Organization.

Parâmetros de caminho

id
string
required
ID do payment link.
curl -X DELETE "https://api.chargefy.io/v1/payment-links/plink_123" \
  -H "Authorization: Bearer {{API_KEY}}"

Respostas

Quando a row pôde ser removida:
{
  "id": "plink_123",
  "object": "payment_link",
  "deleted": true
}

Webhook

Quando o DELETE vira desativação, emite payment.link.updated com data.object.is_active=false e data.previous_attributes.is_active=true. Quando a row é removida de verdade, a resposta direta já confirma { deleted: true }.