Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Gerencie seus recursos do Dodo Payments, crie sessões de checkout e teste webhooks diretamente no terminal. Criado para desenvolvedores que preferem a linha de comando.

​
Instalação

npm install -g dodopayments-cli

​
Instalação Manual

  1. Baixe a versão mais recente em GitHub Releases para o seu sistema
  2. Extraia e renomeie o binário para dodo
  3. Mova para um diretório no seu PATH:
sudo mv ./dodo /usr/local/bin/

​
Autenticação

Antes de usar a CLI, autentique-se com sua chave de API: 
dodo login
Isso irá:
  1. Abrir o navegador na página de Chaves de API do Dodo Payments
  2. Solicitar que você insira sua chave de API
  3. Pedir que você selecione o ambiente (Modo de Teste ou Modo ao Vivo)
  4. Armazenar suas credenciais localmente em ~/.dodopayments/api-key
A CLI suporta armazenar uma chave de API por ambiente. Se as chaves dos modos de teste e ao vivo estiverem configuradas, você será solicitado a escolher qual ambiente usar na sessão atual.

​
Uso

A sintaxe geral é: 
dodo ‹category› ‹sub-command›
Executar dodo sem argumentos exibe todas as categorias disponíveis. Executar dodo <category> sem subcomando mostra os subcomandos disponíveis para essa categoria.

​
Produtos

Gerencie seu catálogo de produtos.
CommandDescription
dodo products listListar todos os produtos (paginados)
dodo products createAbrir o painel para criar um produto
dodo products infoVer detalhes de um produto específico

​
Pagamentos

Visualize as transações de pagamento.
CommandDescription
dodo payments listListar todos os pagamentos (paginados)
dodo payments infoObter informações sobre um pagamento específico

​
Clientes

Gerencie sua base de clientes.
CommandDescription
dodo customers listListar todos os clientes (paginados)
dodo customers createCriar um novo perfil de cliente
dodo customers updateAtualizar os dados de um cliente existente

​
Descontos

Gerencie cupons e descontos.
CommandDescription
dodo discounts listListar todos os descontos (paginados)
dodo discounts createCriar um novo desconto baseado em porcentagem
dodo discounts deleteRemover um desconto por ID

​
Licenças

Gerencie licenças de software.
CommandDescription
dodo licences listListar todas as chaves de licença (paginadas)

​
Complementos

Gerencie complementos de produtos.
CommandDescription
dodo addons listListar todos os complementos (paginados)
dodo addons createAbrir o painel para criar um complemento
dodo addons infoVer detalhes de um complemento específico

​
Reembolsos

Visualize informações de reembolso.
CommandDescription
dodo refund listListar todos os reembolsos (paginados)
dodo refund infoVer detalhes de um reembolso específico

​
Checkout

Crie sessões de checkout.
CommandDescription
dodo checkout newCriar uma nova sessão de checkout e obter a URL do checkout
O comando checkout suporta opções avançadas, incluindo coleta mínima de endereço, URL de retorno, aplicação de 3D Secure, códigos de desconto e metadados.

​
Teste de Webhooks

A CLI inclui duas ferramentas poderosas para testar webhooks durante o desenvolvimento: um listener que encaminha webhooks de teste ao vivo para seu servidor local e um trigger que envia cargas úteis simuladas para qualquer endpoint.

​
Ouvir Webhooks

Encaminhe webhooks da Dodo Payments diretamente para seu servidor de desenvolvimento local em tempo real. 
dodo wh listen
1

Enter your local endpoint URL

Forneça a URL local onde deseja receber webhooks (por exemplo, http://localhost:3000/webhook).
2

Automatic setup

A CLI cria automaticamente um endpoint de webhook na sua conta do Dodo Payments se ainda não existir, e então abre uma conexão WebSocket para receber eventos em tempo real.
3

Receive and forward

Quando um evento de webhook é disparado (a partir de um pagamento de teste, alteração de assinatura, etc.), a CLI o recebe, registra o tipo de evento e encaminha a solicitação completa com cabeçalhos e corpo para seu endpoint local. A resposta do seu endpoint é registrada e enviada de volta.
O listener de webhook funciona apenas com uma chave de API de modo de teste. Certifique-se de estar logado com uma chave de modo de teste antes de usar dodo wh listen.
O listener preserva os cabeçalhos originais do webhook (webhook-id, webhook-signature, webhook-timestamp) ao encaminhar para seu endpoint local, para que você possa testar sua lógica de verificação de assinatura.

​
Acionar Webhooks de Teste

Envie cargas úteis simuladas para qualquer endpoint para testes rápidos sem precisar criar transações reais. 
dodo wh trigger
Isso orienta você por:
  1. Definir a URL de endpoint de destino
  2. Opcionalmente configurar ID do Negócio, ID do Produto e Metadados
  3. Selecionar um evento específico para acionar em um menu interativo
  4. Enviar a carga útil simulada e visualizar a resposta
Após cada evento, você pode selecionar outro evento para acionar ou sair — tornando fácil testar múltiplos manipuladores de evento em uma única sessão.
O trigger envia cargas simuladas sem assinaturas de webhook. Desative a verificação de assinatura durante os testes usando unsafe_unwrap() em vez de unwrap() no seu manipulador de webhook.

​
Eventos de Webhook Suportados

CategoryEvents
Subscriptionsubscription.active, subscription.updated, subscription.on_hold, subscription.renewed, subscription.plan_changed, subscription.cancelled, subscription.failed, subscription.expired
Paymentpayment.success, payment.failed, payment.processing, payment.cancelled
Refundrefund.success, refund.failed
Disputedispute.opened, dispute.expired, dispute.accepted, dispute.cancelled, dispute.challenged, dispute.won, dispute.lost
Licenselicence.created

​
Variáveis de Ambiente

VariableDescription
DODO_WH_TEST_SERVER_URLSubstituir a URL padrão do servidor de retransmissão de webhook usada pelo dodo wh listen

​
Recursos

GitHub Repository

Visualize o código-fonte e as versões

npm Package

Visualize no registro npm

​
Suporte

Last modified on February 27, 2026