Skip to main content
Um payment_link (link de pagamento) é uma página de checkout pública hospedada pela Chargefy que permite vender produtos e serviços de forma rápida e segura sem precisar integrar um formulário de pagamento no seu próprio site. Ele centraliza as regras de negócio do checkout — como exigência de endereço, telefone ou documento do comprador, permissão para cupons de desconto, parcelamento sem juros e URLs de redirecionamento após a conclusão ou cancelamento. Ele é criado dinamicamente a partir de um conjunto de itens de preço (line_items) e permanece ativo enquanto is_active for true. Qualquer pessoa com acesso à URL do link pode preencher os dados de pagamento e concluir a compra, o que gera uma checkout_session correspondente para cada tentativa de finalização. Payment links não representam faturas existentes. Para cobrar ou exibir uma invoice já criada, use invoice.hosted_invoice_url, que pertence a uma única invoice e permanece apontando para ela depois do pagamento ou cancelamento. Este é o formato completo retornado em create, get, update, itens de list e em data.object dos webhooks payment.link.*. 
{
  "id": "plink_123",
  "object": "payment_link",
  "allow_discount_codes": true,
  "cancel_url": "https://example.com/cancel",
  "created_at": "2026-05-19T18:00:00Z",
  "discount": null,
  "is_active": true,
  "label": "Curso de Programação",
  "line_items": [
    {
      "id": "pli_123",
      "amount_discount": 0,
      "amount_subtotal": 9990,
      "amount_tax": 0,
      "amount_total": 9990,
      "currency": "brl",
      "description": "Mensalidade do Curso",
      "metadata": {},
      "position": 0,
      "price": "price_123",
      "price_data": null,
      "product": "prod_123",
      "quantity": 1,
      "recurring_interval": "month",
      "recurring_interval_count": 1,
      "unit_amount": 9990
    }
  ],
  "livemode": true,
  "metadata": {},
  "payment_method_options": {
    "credit_card": {
      "installments": {
        "has_interest": true,
        "max_count": 12
      }
    }
  },
  "require_billing_address": false,
  "require_document": true,
  "require_phone": true,
  "success_url": "https://example.com/success",
  "updated_at": "2026-05-19T18:00:00Z",
  "url": "https://pay.chargefy.io/l/plink_123_abc"
}
​
id
string
Identificador único do link de pagamento. Usa o prefixo plink_*.
​
object
string
Sempre "payment_link".
​
allow_discount_codes
boolean
Define se cupons de desconto podem ser aplicados pelo comprador na página do checkout.
​
cancel_url
string | null
A URL para onde o cliente será redirecionado se desistir da compra.
​
created_at
string
Data de criação em formato ISO 8601.
​
discount
string | null
ID do desconto (dsct_*) fixado no link de pagamento, se houver.
​
is_active
boolean
Define se o link de pagamento está ativo e aceitando novas transações.
​
label
string | null
Rótulo amigável/título exibido no topo da página de checkout.
​
line_items
array
Lista de itens de preço que compõem o valor cobrado neste link.
​
livemode
boolean
true se gerado em produção; false se em testes.
​
metadata
object
Metadados customizados vinculados ao link. Retorna {} quando vazio.
​
payment_method_options
object
Opções por método de pagamento oferecidas no checkout.
​
require_billing_address
boolean
Se true, exige que o comprador preencha um endereço de cobrança completo.
​
require_document
boolean
Se true, exige o preenchimento de CPF ou CNPJ pelo comprador.
​
require_phone
boolean
Se true, exige o preenchimento do telefone de contato do comprador.
​
success_url
string | null
A URL para onde o cliente será redirecionado após o pagamento ser concluído com sucesso.
​
updated_at
string | null
Data da última atualização em formato ISO 8601.
​
url
string
A URL pública compartilhável do checkout hospedado da Chargefy.

​
Operações

​
Webhooks

Mudanças nesse objeto disparam os seguintes eventos de webhook: O payload carrega o objeto payment_link completo em data.object.