Clientes
O cliente agrupa as compras de uma pessoa na sua base Korbit (e-mail como identificador natural):- E-mail duplicado retorna
409 CUSTOMER_EMAIL_TAKEN. - Arquivar (
POST /v1/customers/{id}/archive) remove o cliente das listagens sem quebrar o histórico de pedidos.
Pedidos
Cada venda — por link de pagamento, sessão de checkout ou assinatura — gera um pedido:- Paginação por cursor (
cursor+limit); cursor inválido retorna400 INVALID_PAYOUT_CURSORnas rotas de saque e equivalente nas demais. - Para exportação em massa use export.csv.
Atividade
GET /v1/activity retorna o feed de atividade da conta (pagamentos, refunds, saques, mudanças de status) — base leve para notificações internas e auditoria de integração.
Portal do cliente
O portal é a área self-service do comprador (assinar, cancelar, trocar de plano, pedir refund). Você cria sessões de portal por cliente viaPOST /v1/customer-portal-sessions e pode revogá-las — veja o fluxo em Assinaturas → Portal do cliente.