PATCH /api/v1/checkout-links/:id

Atualiza um link de checkout existente

Atualiza os campos de um link de checkout. Apenas os campos enviados serão atualizados.

Autenticação

Requer Organization Access Token (OAT) via header Authorization: Bearer.

Parâmetros de Path

id · string · required

ID único do checkout link

Corpo da Requisição

Todos os campos são opcionais. Apenas os campos enviados serão atualizados.

success_url · string

URL de redirecionamento após pagamento bem-sucedido.

cancel_url · string

URL de redirecionamento quando o comprador abandona ou cancela o checkout. Envie null para remover.

label · string

Nome identificador do link (visível apenas para a organização).

products · array

Lista de IDs de produtos a associar ao link. Substitui a lista atual.

allow_discount_codes · boolean

Permite que o comprador insira cupons de desconto no checkout.

discount_id · string

ID do desconto a aplicar automaticamente. Envie null para remover.

require_billing_address · boolean

Quando true, torna o endereço de cobrança obrigatório durante o checkout.

no_fees_installments · boolean

Quando true, as parcelas são oferecidas sem juros ao comprador.

custom_price_amount · number

Valor personalizado em centavos. Substitui o preço padrão do produto. Envie null para restaurar o preço original.

payment_processor · string

Identificador do processador de pagamento (valor conforme contrato da API no ambiente).

metadata · object

Metadados personalizados em formato chave-valor.

Exemplo

cURL

curl -X PATCH https://api.chargefy.io/api/v1/checkout-links/clink_def456 \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Link Plano Pro - Atualizado",
    "success_url": "https://meusite.com/nova-pagina"
  }'

Resposta de Exemplo

{
  "id": "clink_def456",
  "label": "Link Plano Pro - Atualizado",
  "url": "https://pay.chargefy.io/clink_def456",
  "product_ids": ["prod_123"],
  "discount_id": "disc_abc",
  "success_url": "https://meusite.com/nova-pagina",
  "metadata": {
    "source": "email-marketing"
  },
  "allow_discount_codes": true,
  "created_at": "2026-03-12T10:00:00Z",
  "updated_at": "2026-03-12T11:00:00Z"
}