Excluir um link de pagamento

curl -X DELETE "https://api.chargefy.io/v1/payment-links/plink_pFMEaXeHJWHCA7Fg" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "plink_pFMEaXeHJWHCA7Fg",
  "object": "payment_link",
  "deleted": true
}

{
  "id": "plink_pFMEaXeHJWHCA7Fg",
  "object": "payment_link",
  "allow_discount_codes": false,
  "cancel_url": null,
  "checkout_experience": {
    "banner": null,
    "confirmation_message": null,
    "cover_image_url": null,
    "footer_expanded": false,
    "funnel": null,
    "header_shows_logo": null,
    "installment_teaser_mode": null,
    "order_summary_mode": null,
    "product_description_mode": null,
    "product_image_mode": null,
    "product_subtitle_source": null,
    "require_billing_address": null,
    "require_document": null,
    "require_phone": null,
    "show_compare_at_amount": false,
    "summary_style": null,
    "tracking": {
      "destinations": [],
      "mode": "inherit"
    }
  },
  "created_at": "2026-05-16T14:09:27Z",
  "discount": null,
  "has_surcharge": false,
  "is_active": false,
  "label": "Bio Instagram",
  "line_items": [],
  "livemode": true,
  "metadata": {},
  "optional_items": [],
  "payment_method_collection": "always",
  "payment_method_options": null,
  "payment_method_types": null,
  "subscription_data": {},
  "success_url": "https://meusite.com/sucesso",
  "template": null,
  "updated_at": "2026-05-16T15:02:10Z",
  "url": "https://pay.chargefy.io/link/9a1bc3..."
}

Remove um payment_link quando ele ainda não materializou nenhuma checkout.session. A remoção leva junto os itens (line_items, optional_items) e os order bumps configurados no link; nada que já foi vendido é tocado. Se o link já foi usado, ou se algum vínculo impedir a remoção, 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

string

obrigatório

ID do payment link.

curl -X DELETE "https://api.chargefy.io/v1/payment-links/plink_pFMEaXeHJWHCA7Fg" \
  -H "Authorization: Bearer {{API_KEY}}"

Respostas

Quando o link pôde ser removido de verdade (nenhuma checkout.session criada a partir dele):

{
  "id": "plink_pFMEaXeHJWHCA7Fg",
  "object": "payment_link",
  "deleted": true
}

{
  "id": "plink_pFMEaXeHJWHCA7Fg",
  "object": "payment_link",
  "allow_discount_codes": false,
  "cancel_url": null,
  "checkout_experience": {
    "banner": null,
    "confirmation_message": null,
    "cover_image_url": null,
    "footer_expanded": false,
    "funnel": null,
    "header_shows_logo": null,
    "installment_teaser_mode": null,
    "order_summary_mode": null,
    "product_description_mode": null,
    "product_image_mode": null,
    "product_subtitle_source": null,
    "require_billing_address": null,
    "require_document": null,
    "require_phone": null,
    "show_compare_at_amount": false,
    "summary_style": null,
    "tracking": {
      "destinations": [],
      "mode": "inherit"
    }
  },
  "created_at": "2026-05-16T14:09:27Z",
  "discount": null,
  "has_surcharge": false,
  "is_active": false,
  "label": "Bio Instagram",
  "line_items": [],
  "livemode": true,
  "metadata": {},
  "optional_items": [],
  "payment_method_collection": "always",
  "payment_method_options": null,
  "payment_method_types": null,
  "subscription_data": {},
  "success_url": "https://meusite.com/sucesso",
  "template": null,
  "updated_at": "2026-05-16T15:02:10Z",
  "url": "https://pay.chargefy.io/link/9a1bc3..."
}

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 o link é removido de verdade, a resposta direta já confirma { deleted: true }.

curl -X DELETE "https://api.chargefy.io/v1/payment-links/plink_pFMEaXeHJWHCA7Fg" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "plink_pFMEaXeHJWHCA7Fg",
  "object": "payment_link",
  "deleted": true
}

{
  "id": "plink_pFMEaXeHJWHCA7Fg",
  "object": "payment_link",
  "allow_discount_codes": false,
  "cancel_url": null,
  "checkout_experience": {
    "banner": null,
    "confirmation_message": null,
    "cover_image_url": null,
    "footer_expanded": false,
    "funnel": null,
    "header_shows_logo": null,
    "installment_teaser_mode": null,
    "order_summary_mode": null,
    "product_description_mode": null,
    "product_image_mode": null,
    "product_subtitle_source": null,
    "require_billing_address": null,
    "require_document": null,
    "require_phone": null,
    "show_compare_at_amount": false,
    "summary_style": null,
    "tracking": {
      "destinations": [],
      "mode": "inherit"
    }
  },
  "created_at": "2026-05-16T14:09:27Z",
  "discount": null,
  "has_surcharge": false,
  "is_active": false,
  "label": "Bio Instagram",
  "line_items": [],
  "livemode": true,
  "metadata": {},
  "optional_items": [],
  "payment_method_collection": "always",
  "payment_method_options": null,
  "payment_method_types": null,
  "subscription_data": {},
  "success_url": "https://meusite.com/sucesso",
  "template": null,
  "updated_at": "2026-05-16T15:02:10Z",
  "url": "https://pay.chargefy.io/link/9a1bc3..."
}

Fundamentos da API

MCP

Objetos de sistema

Webhooks e eventos

SDKs

Excluir um link de pagamento

Autenticação

Parâmetros de caminho

Respostas

Webhook

​Autenticação

​Parâmetros de caminho

​Respostas

​Webhook

Autenticação

Parâmetros de caminho

Respostas

Webhook