インストール
Goインストール
go install github.com/dodopayments/dodopayments-cli/cmd/dodopayments@latest
ソースから
git clone https://github.com/dodopayments/dodopayments-cli.git
cd dodopayments-cli
go install ./cmd/dodopayments
クイックスタート
APIキーを設定します:
export DODO_PAYMENTS_API_KEY=your_api_key_here
dodopayments [resource] [command] [flags]
dodopayments checkout-sessions create \
--product-cart.product_id prod_123 \
--product-cart.quantity 1 \
--return-url https://yourdomain.com/return
グローバルフラグ
| フラグ | 説明 |
|---|
--format | 出力形式: auto, json, yaml, pretty, explore |
--transform | gjson構文を使用して応答をフィルタリング |
--debug | 詳細なログを有効にする |
--version, -v | CLIバージョンを表示 |
一般的なコマンド
支払い
# 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
# 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"
サブスクリプション
# 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
# Create product
dodopayments products create \
--name "Premium Plan" \
--price.amount 2999 \
--price.currency USD
# List products
dodopayments products list
使用量ベースの請求
イベントの取り込み
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
メーターの管理
# Create meter
dodopayments meters create \
--name "API Requests" \
--event-name api_request \
--aggregation count
# List meters
dodopayments meters list
出力形式
JSON (スクリプト用)
dodopayments payments list --format json | jq '.data[] | {id, amount}'
プレーン (読みやすい)
dodopayments payments retrieve pay_123 --format pretty
インタラクティブエクスプローラー
dodopayments payments list --format explore
gjsonで変換
# Extract all payment IDs
dodopayments payments list --transform "data.#.id"
# Filter and extract
dodopayments payments list --transform "data.#(amount>5000)#.id"
--format jsonをjqと共に使用して、シェルスクリプトで強力なデータ処理を行います。
スクリプト例
#!/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
シェル補完
自動補完を有効にします:
# Bash
eval "$(dodopayments completion bash)"
# Zsh
eval "$(dodopayments completion zsh)"
# Fish
dodopayments completion fish | source
利用可能なリソース
CLIは24のリソースカテゴリに対するコマンドを提供します:
checkout-sessions - チェックアウトセッション管理payments - 支払い操作subscriptions - 定期請求customers - 顧客アカウントproducts - 商品カタログlicenses - ソフトウェアライセンスrefunds - 支払いの返金disputes - 支払いの紛争webhooks - イベントWebhookmeters - 使用量メーターusage-events - 使用量追跡discounts - 割引コードpayouts - 売上の支払いbrands - マルチブランド管理- さらに10のリソース
dodopayments --helpを使用して、すべての利用可能なリソースを確認し、dodopayments [resource] --helpでリソース固有のコマンドを確認してください。
リソース
サポート
CLIに関して助けが必要ですか？
