Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Atualiza campos de um payment link. Apenas os campos enviados são modificados — o resto permanece intacto. Importante: atualizações afetam apenas cliques futuros. Sessões já materializadas a partir de cliques anteriores guardam os line_items que tinham no momento do clique — é cópia, não referência. Trocar o preço hoje não muda nada do que já está em cobrança; só novos cliques a partir de agora veem o novo preço.

​
Autenticação

Mesmo contrato de POST /v1/payment-links — Org API key (write ou admin) ou Platform API key (platform_admin) com header Organization.

​
Parâmetros de Path

​
id
string
required
ID do payment link, prefixo plink_.

​
Corpo da Requisição

Todos os campos são opcionais. Apenas o que for enviado é atualizado.
​
label
string
Nome interno. Envie null pra remover.
​
success_url
string
Envie null pra remover.
​
cancel_url
string
Envie null pra remover.
​
allow_discount_codes
boolean
Permite cupom no checkout.
​
discount_id
string
Desconto auto-aplicado. null remove.
​
require_billing_address
boolean
Endereço de cobrança obrigatório.
​
no_fees_installments
boolean
Parcelas sem juros.
​
metadata
object
Substitui o objeto inteiro. Pra preservar chaves existentes, busque o link primeiro e envie o merge.
​
line_items
array
Substitui completamente os line items do link. Mesma forma de envio do POST. Os antigos são arquivados (cliques futuros não os enxergam mais); sessões já materializadas mantêm os antigos.

​
Resposta

200 OK com o objeto canônico do payment link. Mesma forma da resposta de POST /v1/payment-links.

​
Exemplo

cURL
curl -X PATCH "https://api.chargefy.io/v1/payment-links/plink_demo_z2kkA78c" \
  -H "Authorization: Bearer $CHARGEFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Bio Instagram - Atualizado",
    "success_url": "https://meusite.com/nova-pagina",
    "metadata": { "campaign": "spring2026", "channel": "instagram" }
  }'
cURL
curl -X PATCH "https://api.chargefy.io/v1/payment-links/plink_demo_z2kkA78c" \
  -H "Authorization: Bearer $CHARGEFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "line_items": [{ "price_id": "price_demo_pro_yearly", "quantity": 1 }]
  }'
A partir desse momento, novos cliques abrem checkout com o novo preço. Cliques anteriores (sessões já criadas) seguem com o preço antigo até concluírem ou expirarem.

​
Erros comuns

HTTPRazão
404id não existe ou já está arquivado.
400line_items enviado mas vazio ou inválido.
403Sem permissão na org dona do link.