Installation
Installation Go
go install github.com/dodopayments/dodopayments-cli/cmd/dodopayments@latest
À partir de la source
git clone https://github.com/dodopayments/dodopayments-cli.git
cd dodopayments-cli
go install ./cmd/dodopayments
Démarrage rapide
Définissez votre clé API :
export DODO_PAYMENTS_API_KEY=your_api_key_here
Structure de commande de base :
dodopayments [resource] [command] [flags]
Créer une session de paiement :
dodopayments checkout-sessions create \
--product-cart.product_id prod_123 \
--product-cart.quantity 1 \
--return-url https://yourdomain.com/return
Drapeaux globaux
| Drapeau | Description |
|---|
--format | Format de sortie : auto, json, yaml, pretty, explore |
--transform | Filtrer la réponse en utilisant la syntaxe gjson |
--debug | Activer la journalisation détaillée |
--version, -v | Afficher la version du CLI |
Commandes courantes
Paiements
# 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
Clients
# 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"
Abonnements
# 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
Produits
# Create product
dodopayments products create \
--name "Premium Plan" \
--price.amount 2999 \
--price.currency USD
# List products
dodopayments products list
Facturation basée sur l’utilisation
Ingest Events
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
Gérer les compteurs
# Create meter
dodopayments meters create \
--name "API Requests" \
--event-name api_request \
--aggregation count
# List meters
dodopayments meters list
JSON (pour le scripting)
dodopayments payments list --format json | jq '.data[] | {id, amount}'
Lisible (pour la lecture)
dodopayments payments retrieve pay_123 --format pretty
Exploration interactive
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"
Utilisez --format json avec jq pour un traitement de données puissant dans les scripts shell.
Exemple 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
Complétion Shell
Activer l’auto-complétion :
# Bash
eval "$(dodopayments completion bash)"
# Zsh
eval "$(dodopayments completion zsh)"
# Fish
dodopayments completion fish | source
Ressources disponibles
Le CLI fournit des commandes pour 24 catégories de ressources :
checkout-sessions - Gestion des sessions de paiement
payments - Opérations de paiement
subscriptions - Facturation récurrente
customers - Comptes clients
products - Catalogue de produits
licenses - Licences logicielles
refunds - Remboursements de paiement
disputes - Litiges de paiement
webhooks - Webhooks d’événements
meters - Compteurs d’utilisation
usage-events - Suivi de l’utilisation
discounts - Codes de réduction
payouts - Paiements aux vendeurs
brands - Gestion multi-marques
- Plus 10 ressources supplémentaires
Utilisez dodopayments --help pour voir toutes les ressources disponibles et dodopayments [resource] --help pour les commandes spécifiques aux ressources.
Ressources
Support
Besoin d’aide avec le CLI ?