الانتقال إلى المحتوى الرئيسي

التثبيت

تثبيت 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 - أحداث الويب هوك
  • meters - عدادات الاستخدام
  • usage-events - تتبع الاستخدام
  • discounts - رموز الخصم
  • payouts - مدفوعات البائع
  • brands - إدارة متعددة العلامات التجارية
  • بالإضافة إلى 10 موارد إضافية
استخدم dodopayments --help لرؤية جميع الموارد المتاحة و dodopayments [resource] --help لأوامر محددة بالموارد.

الموارد

الدعم

تحتاج إلى مساعدة بشأن CLI؟