> ## 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.

# GET /api/v1/checkout-links/:id

> Retorna os detalhes de um link de checkout específico

Recupera as informações completas de um link de checkout pelo ID.

## Autenticação

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

## Parâmetros de Path

**id** `string` *required*

ID único do checkout link

## Resposta

**id** `string`

ID único do checkout link.

**label** `string`

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

**url** `string`

URL compartilhável do checkout link.

**client\_secret** `string`

Segredo do cliente para acesso ao link de redirecionamento público.

**products** `array`

Lista de produtos associados ao link.

**products\[]**

**id** `string`

ID do produto.

**name** `string`

Nome do produto.

**description** `string`

Descrição do produto.

**organization\_id** `string`

ID da organização dona do produto.

**is\_archived** `boolean`

Se o produto está arquivado.

**discount\_id** `string`

ID do desconto aplicado automaticamente (se configurado).

**discount** `object`

Objeto do desconto populado via join (se houver).

**allow\_discount\_codes** `boolean`

Se o comprador pode inserir cupons de desconto.

**success\_url** `string`

URL de redirecionamento após pagamento bem-sucedido.

**cancel\_url** `string`

URL de cancelamento/abandono do checkout.

**require\_billing\_address** `boolean`

Se o endereço de cobrança é obrigatório no checkout.

**no\_fees\_installments** `boolean`

Se as parcelas são oferecidas sem juros ao comprador.

**custom\_price\_amount** `number`

Valor personalizado em centavos. Quando definido, substitui o preço padrão do produto.

**metadata** `object`

Metadados personalizados em formato chave-valor.

**organization\_id** `string`

ID da organização dona do link.

**payment\_processor** `string`

Processador de pagamento configurado (identificador conforme ambiente).

**created\_at** `string`

Data/hora de criação no formato ISO 8601.

**modified\_at** `string`

Data/hora da última modificação no formato ISO 8601.

## Exemplo

```bash cURL theme={null}
curl -X GET https://api.chargefy.io/api/v1/checkout-links/clink_def456 \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"
```

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

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

const link = await chargefy.checkoutLinks.get('clink_def456');
```

## Resposta de Exemplo

```json theme={null}
{
  "id": "clink_def456",
  "label": "Link Plano Pro - Campanha Março",
  "url": "https://pay.chargefy.io/clink_def456",
  "client_secret": "cs_live_abc123",
  "products": [
    {
      "id": "prod_123",
      "name": "Plano Pro",
      "description": "Acesso completo à plataforma",
      "organization_id": "org_xyz",
      "is_archived": false
    }
  ],
  "discount_id": "disc_abc",
  "allow_discount_codes": true,
  "success_url": "https://meusite.com/obrigado",
  "require_billing_address": false,
  "no_fees_installments": false,
  "custom_price_amount": null,
  "metadata": {
    "source": "email-marketing"
  },
  "organization_id": "org_xyz",
  "payment_processor": "default",
  "created_at": "2026-03-12T10:00:00Z",
  "modified_at": "2026-03-12T10:00:00Z"
}
```


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