> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PATCH /api/v1/checkouts/:id

> Atualiza uma sessão de checkout existente

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)

**quantity** `integer`

Quantidade de unidades. Total da cobrança passa a ser `unit_amount × quantity`.

**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

**Propriedades**

**line1** `string`

Logradouro e número

**line2** `string`

Complemento

**city** `string`

Cidade

**state** `string`

Estado (UF)

**postal\_code** `string`

CEP

**country** `string` *required*

País (ex: `BR`)

**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

```bash cURL theme={null}
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": "novo@exemplo.com"
  }'
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const checkout = await chargefy.checkouts.update('chk_1a2b3c4d5e6f', {
  metadata: {
    order_ref: 'pedido-789',
  },
  customerEmail: 'novo@exemplo.com',
});
```

## Resposta de Exemplo

```json theme={null}
{
  "id": "chk_1a2b3c4d5e6f",
  "status": "open",
  "client_secret": "chk_secret_xyz789",
  "product_price_id": "pp_abc123",
  "amount": 9900,
  "currency": "BRL",
  "customer_email": "novo@exemplo.com",
  "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"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.