Skip to main content

​
O modelo em uma frase

Um produto é vendido por meio de uma oferta, exibida em um checkout. Cada compra gera um pedido — e, se o produto for recorrente, também uma assinatura.
Criar um produto já cria a oferta padrão, o checkout e o link de pagamento. Não existe endpoint separado de “criar checkout” — veja Criar um checkout.

​
Termos

O item que você vende. Tem name, description, price, salesPage e um type:Cada produto tem um id (UUID) e um short_id (identificador curto).Referência: Produtos
A condição comercial sob a qual o produto é vendido — preço e configuração. Um produto pode ter várias ofertas (por exemplo, preço cheio e preço promocional).O link público de pagamento é derivado da oferta:
Referência: Ofertas
A página onde o comprador finaliza a compra. Um produto pode ter vários checkouts, mas sempre existe um checkout padrão (default: true) — não é possível deletá-lo nem desmarcá-lo sem promover outro no lugar.A aparência e o comportamento são controlados pelo campo config.Referência: Checkouts
Produto complementar oferecido dentro do mesmo checkout, que o comprador adiciona com um clique antes de pagar. É a forma de vender mais de um item num único fechamento.Referência: Order Bumps
O registro de uma compra: quem comprou, o que comprou, por quanto e em que status. É o pedido que dispara os eventos de venda para seus webhooks.Referência: Pedidos
A recorrência criada a partir de um pedido pai. Cada renovação gera um novo ciclo de cobrança, e cada ciclo pode ter várias tentativas de cobrança.Os estados e as transições suportadas estão em Estados da Assinatura.Referência: Assinaturas
O comprador. É identificado por documento (docNumber) e e-mail, e é reaproveitado entre pedidos.Referência: Clientes

​
Próximos passos

Criar um checkout

O fluxo completo, do produto ao link de pagamento

Webhooks

Receba os eventos de venda na sua aplicação