Instalação
go install github.com/dodopayments/dodopayments-cli/cmd/dodopayments@latest
A partir do Código Fonte
git clone https://github.com/dodopayments/dodopayments-cli.git
cd dodopayments-cli
go install ./cmd/dodopayments
Início Rápido
Defina sua chave de API:
export DODO_PAYMENTS_API_KEY=your_api_key_here
Estrutura básica do comando:
dodopayments [resource] [command] [flags]
Crie uma sessão de checkout:
dodopayments checkout-sessions create \
--product-cart.product_id prod_123 \
--product-cart.quantity 1 \
--return-url https://yourdomain.com/return
Flags Globais
| Flag | Descrição |
|---|
--format | Formato de saída: auto, json, yaml, pretty, explore |
--transform | Filtrar resposta usando a sintaxe gjson |
--debug | Habilitar registro detalhado |
--version, -v | Exibir versão do CLI |
Comandos Comuns
Pagamentos
# List payments
dodopayments payments list --limit 20 --format json
# Retrieve payment
dodopayments payments retrieve pay_123
# Get line items
dodopayments payments line-items pay_123
Clientes
# Create customer
dodopayments customers create \
--email [email protected] \
--name "John Doe"
# List customers
dodopayments customers list
# Update customer
dodopayments customers update cus_123 --name "Jane Doe"
Assinaturas
# Create subscription
dodopayments subscriptions create \
--customer-id cus_123 \
--product-id prod_456
# List subscriptions
dodopayments subscriptions list
# Get usage history
dodopayments subscriptions usage-history sub_123
Produtos
# Create product
dodopayments products create \
--name "Premium Plan" \
--price.amount 2999 \
--price.currency USD
# List products
dodopayments products list
Cobrança Baseada em Uso
Ingestão de Eventos
dodopayments usage-events ingest \
--events.event_id api_call_12345 \
--events.customer_id cus_abc123 \
--events.event_name api_request \
--events.timestamp 2024-01-15T10:30:00Z \
--events.metadata.endpoint /api/v1/users
Gerenciar Medidores
# Create meter
dodopayments meters create \
--name "API Requests" \
--event-name api_request \
--aggregation count
# List meters
dodopayments meters list
JSON (para scripts)
dodopayments payments list --format json | jq '.data[] | {id, amount}'
Bonito (para leitura)
dodopayments payments retrieve pay_123 --format pretty
Exploração Interativa
dodopayments payments list --format explore
# Extract all payment IDs
dodopayments payments list --transform "data.#.id"
# Filter and extract
dodopayments payments list --transform "data.#(amount>5000)#.id"
Use --format json com jq para processamento de dados poderoso em scripts de shell.
Exemplo de Script
#!/bin/bash
# Export all payments to CSV
dodopayments payments list --format json | \
jq -r '.data[] | [.id, .amount, .currency, .status] | @csv' > payments.csv
# Create customers from file
while IFS=',' read -r email name; do
dodopayments customers create \
--email "$email" \
--name "$name" \
--format json
done < customers.csv
Conclusão de Shell
Habilitar auto-completar:
# Bash
eval "$(dodopayments completion bash)"
# Zsh
eval "$(dodopayments completion zsh)"
# Fish
dodopayments completion fish | source
Recursos Disponíveis
O CLI fornece comandos para 24 categorias de recursos:
checkout-sessions - Gerenciamento de sessão de checkout
payments - Operações de pagamento
subscriptions - Cobrança recorrente
customers - Contas de clientes
products - Catálogo de produtos
licenses - Licenciamento de software
refunds - Reembolsos de pagamento
disputes - Disputas de pagamento
webhooks - Webhooks de eventos
meters - Medidores de uso
usage-events - Rastreamento de uso
discounts - Códigos de desconto
payouts - Pagamentos a vendedores
brands - Gerenciamento multi-marca
- Mais 10 recursos adicionais
Use dodopayments --help para ver todos os recursos disponíveis e dodopayments [resource] --help para comandos específicos de recursos.
Recursos
Suporte
Precisa de ajuda com o CLI?