url para compartilhar. Cada compra inicia uma sessão de checkout.
Estrutura
checkoutLayout, product, price) e trazem o UUID.
Atributos
amount
amount
Soma dos totais dos itens ativos, em centavos. Bumps não entram na soma.
url
url
URL pública do checkout do link. Pode vir
null se a URL de checkout não estiver configurada no ambiente.paymentMethods
paymentMethods
Lista com
pix e/ou card (mínimo 1). Padrão: ["pix", "card"].billingAddressCollection
billingAddressCollection
auto (padrão), required ou none.couponEnabled / active
couponEnabled / active
couponEnabled (padrão false) permite o comprador aplicar cupons. active (padrão true): link inativo recusa novas compras (410, PAYMENT_LINK_INACTIVE).items
items
Preços vendidos pelo link:
id, product, price, quantity e amount (preço × quantidade, em centavos). Mínimo 1 item; o mesmo preço não pode repetir.bumps
bumps
Ofertas adicionais (order bump):
id, product, price, quantity, amount (centavos), title e description.subscriptionData / paymentMethodCollection
subscriptionData / paymentMethodCollection
Configuração de período de teste (trial) das assinaturas criadas pelos itens recorrentes.
trial é { interval: "day" | "week" | "month", intervalCount } (até 730 dias: day ≤ 730, week ≤ 104, month ≤ 24) ou null. trialSettings.endBehavior.missingPaymentMethod: create_invoice (padrão; cobra o primeiro período por Pix) ou cancel. paymentMethodCollection: always (padrão; exige método de pagamento mesmo sem cobrar hoje) ou if_required. Veja Teste grátis.Regras de consistência
- Todos os preços (itens e bumps) devem ter a mesma moeda —
PAYMENT_LINK_CURRENCY_MISMATCH. - Itens recorrentes devem ter o mesmo
intervaleintervalCount—PAYMENT_LINK_RECURRING_INTERVAL_MISMATCH. - Não repita o mesmo preço em itens —
PAYMENT_LINK_DUPLICATE_PRICE. - Um trial exige pelo menos um item recorrente —
PAYMENT_LINK_TRIAL_REQUIRES_RECURRING_ITEM. - Com trial e
paymentMethodCollection: "always",cardprecisa estar empaymentMethods—PAYMENT_LINK_TRIAL_REQUIRES_CARD.
400.
Endpoints
- Criar link
- Listar links
- Obter link
- Atualizar link
- Itens: adicionar, atualizar, remover
- Bumps: adicionar, atualizar, remover
sk_). Não há endpoint para excluir um link; desative-o com active: false.