Skip to main content
Atualiza campos de um checkout que ainda está com status open. Checkouts confirmados ou expirados não podem ser atualizados.

​
Autenticação

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

​
Parâmetros de Path

​
id
string
required
ID único do checkout

​
Corpo da Requisição

Todos os campos são opcionais — apenas os campos enviados serão atualizados.
​
product_id
string
Alterar o produto associado ao checkout
​
product_price_id
string
ID do preço do produto (obsoleto — prefira product_id)
​
amount
integer
Novo valor em centavos (somente para checkouts com preço customizável)
​
seats
integer
Número de assentos (para produtos com precificação por assento)
​
discount_id
string
Aplicar ou alterar desconto pelo ID
​
discount_code
string
Aplicar desconto pelo código de cupom
​
allow_discount_codes
boolean
Permitir ou bloquear inserção de cupons pelo comprador
​
is_business_customer
boolean
Indica se o comprador é pessoa jurídica
​
customer_name
string
Nome completo do comprador
​
customer_email
string
Atualizar o e-mail do cliente
​
customer_billing_name
string
Nome de cobrança do cliente
​
customer_billing_address
object
Endereço de cobrança do cliente
​
customer_tax_id
string
CPF ou CNPJ do cliente
​
customer_ip_address
string
Endereço IP do cliente (para antifraude)
​
customer_metadata
object
Metadados do cliente em formato chave-valor
​
trial_interval
string
Unidade do período de trial (ex: day, month)
​
trial_interval_count
integer
Quantidade de unidades do período de trial
​
require_billing_address
boolean
Exigir que o comprador preencha o endereço de cobrança
​
success_url
string
Atualizar a URL de redirecionamento após sucesso
​
cancel_url
string
Atualizar a URL de redirecionamento quando o comprador abandona o checkout
​
embed_origin
string
Origem permitida para checkout embutido via iframe
​
metadata
object
Metadados personalizados em formato chave-valor

​
Resposta

Retorna o objeto de checkout atualizado.

​
Exemplo

curl -X PATCH https://api.chargefy.io/api/v1/checkouts/chk_1a2b3c4d5e6f \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "order_ref": "pedido-789"
    },
    "customer_email": "[email protected]"
  }'

​
Resposta de Exemplo

{
  "id": "chk_1a2b3c4d5e6f",
  "status": "open",
  "client_secret": "chk_secret_xyz789",
  "product_price_id": "pp_abc123",
  "amount": 9900,
  "currency": "BRL",
  "customer_email": "[email protected]",
  "success_url": "https://meusite.com/sucesso",
  "metadata": {
    "order_ref": "pedido-789"
  },
  "created_at": "2026-03-12T10:00:00Z",
  "updated_at": "2026-03-12T10:05:00Z",
  "expires_at": "2026-03-12T10:30:00Z"
}