Skip to main content
POST
Create a checkout session from a payment link (by slug)

Path Parameters

companySlug
string
required
Example:

"minha-empresa"

Example:

"curso-premium"

Body

application/json
full_name
string
required
Example:

"Maria Silva"

email
string<email>
required
Example:

"maria.silva@example.com"

cpf_cnpj
string
required

CPF (11 dígitos) ou CNPJ (14 dígitos)

Example:

"12345678909"

coupon_code
string | null

Só se aplica a links de assinatura.

Response

Sessão de checkout criada — use o token como X-Checkout-Token

token
string
Example:

"cs_live_a1b2c3..."

type
enum<string>
Available options:
one_time,
subscription
plan_id
integer | null
amount
integer | null

Nulo em sessões de link de assinatura — o valor vem do plano.

Example:

29900

currency
string
Example:

"BRL"

merchant_order_id
string

Gerado automaticamente (pl_…) quando a sessão nasce de um link de pagamento.

Example:

"pl_6a1f2c3d"

payment_method
enum<string> | null
Available options:
card,
pix
gateway_first_try
string | null
metadata
object | null
success_url
string<uri> | null
cancel_url
string<uri> | null
expires_at
string<date-time>
saved_cards
object[]

Sempre vazio em links de pagamento — a página pública nunca expõe cartões salvos.