Clientes, produtos e preços

Prepare o catálogo da sua conta conectada antes de abrir um checkout.

O checkout utiliza preços que pertencem à conta conectada da organização. Um produto descreve o que você vende; um preço define a moeda, o valor e, quando necessário, a recorrência.

Antes de começar

Instale o SDK e configure o client e o organizationId conforme o guia de primeira integração. Sua API key precisa de products:write para criar produtos e preços. Para consultar o catálogo, use products:read.

Use uma instalação de teste. Produtos e preços de uma conta ou ambiente não podem ser usados em outro. Persista uma chave de idempotência por operação de criação e reutilize-a nas novas tentativas. Substitua as chaves de exemplo por chaves próprias da sua aplicação.

Crie o produto

Cadastrar um produto
const product = await client.products.create({
  organizationId,
  "idempotency-key": "produto-plano-001",
  name: "Plano da aplicação",
  description: "Acesso ao produto",
});

Guarde o id do produto retornado. Os próximos exemplos usam prod_EXEMPLO; substitua pelo identificador real da sua conta.

Defina o preço

Valores em brl usam centavos: 4990 representa R$ 49,90. Para uma assinatura mensal, inclua recurring:

Criar um preço mensal
const price = await client.prices.create({
  organizationId,
  "idempotency-key": "preco-mensal-001",
  product: "prod_EXEMPLO",
  currency: "brl",
  unit_amount: 4990,
  recurring: { interval: "month" },
});

Para pagamento único, omita recurring. Guarde o id do preço retornado, como price_EXEMPLO, para enviar em line_items do checkout.

Use o preço no checkout

Abra uma sessão com mode: "subscription" para um preço recorrente ou mode: "payment" para pagamento único. Consulte Checkout e assinaturas para preparar a sessão e encaminhar o cliente ao pagamento.

Clientes

Um cliente reúne os dados de uma pessoa ou empresa na conta conectada. Use o id retornado ao criar ou consultar clientes para associá-lo a uma sessão de checkout, quando necessário.

Não reutilize identificadores de outra organização. Clientes, produtos e preços sempre pertencem ao escopo da conta conectada autorizada.

Nesta página