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.

Show 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

cURL

curl -X GET https://api.chargefy.io/api/v1/checkout-links/clink_def456 \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "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"
}