Installation
Go Install
go install github.com/dodopayments/dodopayments-cli/cmd/dodopayments@latest
Aus Quelle
git clone https://github.com/dodopayments/dodopayments-cli.git
cd dodopayments-cli
go install ./cmd/dodopayments
Schnellstart
Setzen Sie Ihren API-Schlüssel:
export DODO_PAYMENTS_API_KEY=your_api_key_here
Grundstruktur des Befehls:
dodopayments [resource] [command] [flags]
Erstellen Sie eine Checkout-Sitzung:
dodopayments checkout-sessions create \
--product-cart.product_id prod_123 \
--product-cart.quantity 1 \
--return-url https://yourdomain.com/return
Globale Flags
| Flag | Beschreibung |
|---|
--format | Ausgabeformat: auto, json, yaml, pretty, explore |
--transform | Antwort mit gjson-Syntax filtern |
--debug | Verbose Protokollierung aktivieren |
--version, -v | CLI-Version anzeigen |
Häufige Befehle
Zahlungen
# 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
Kunden
# 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
Produkte
# Create product
dodopayments products create \
--name "Premium Plan" \
--price.amount 2999 \
--price.currency USD
# List products
dodopayments products list
Nutzungsbasierte Abrechnung
Ereignisse erfassen
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
Zähler verwalten
# Create meter
dodopayments meters create \
--name "API Requests" \
--event-name api_request \
--aggregation count
# List meters
dodopayments meters list
JSON (für Skripting)
dodopayments payments list --format json | jq '.data[] | {id, amount}'
Schön (zum Lesen)
dodopayments payments retrieve pay_123 --format pretty
Interaktive Erkundung
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"
Verwenden Sie --format json mit jq für leistungsstarke Datenverarbeitung in Shell-Skripten.
Skriptbeispiel
#!/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
Shell-Vervollständigung
Auto-Vervollständigung aktivieren:
# Bash
eval "$(dodopayments completion bash)"
# Zsh
eval "$(dodopayments completion zsh)"
# Fish
dodopayments completion fish | source
Verfügbare Ressourcen
Die CLI bietet Befehle für 24 Ressourcenkategorien:
checkout-sessions - Verwaltung von Checkout-Sitzungen
payments - Zahlungsoperationen
subscriptions - Wiederkehrende Abrechnung
customers - Kundenkonten
products - Produktkatalog
licenses - Softwarelizenzierung
refunds - Zahlungsrückerstattungen
disputes - Zahlungsstreitigkeiten
webhooks - Ereignis-Webhooks
meters - Nutzungszähler
usage-events - Nutzungstracking
discounts - Rabattcodes
payouts - Verkäuferauszahlungen
brands - Multi-Brand-Management
- Plus 10 zusätzliche Ressourcen
Verwenden Sie dodopayments --help, um alle verfügbaren Ressourcen anzuzeigen, und dodopayments [resource] --help für ressourcenspezifische Befehle.
Ressourcen
Unterstützung
Brauchen Sie Hilfe mit der CLI?