Hoppa till huvudinnehåll

Installation

Go Install

go install github.com/dodopayments/dodopayments-cli/cmd/dodopayments@latest

Från Källkod

git clone https://github.com/dodopayments/dodopayments-cli.git
cd dodopayments-cli
go install ./cmd/dodopayments

Snabbstart

Ställ in din API-nyckel:
export DODO_PAYMENTS_API_KEY=your_api_key_here
Grundläggande kommandostruktur:
dodopayments [resource] [command] [flags]
Skapa en checkout-session:
dodopayments checkout-sessions create \
  --product-cart.product_id prod_123 \
  --product-cart.quantity 1 \
  --return-url https://yourdomain.com/return

Globala Flaggor

FlaggaBeskrivning
--formatUtdataformat: auto, json, yaml, pretty, explore
--transformFiltrera svar med gjson-syntax
--debugAktivera detaljerad loggning
--version, -vVisa CLI-version

Vanliga Kommandon

Betalningar

# 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

Kunder

# 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"

Prenumerationer

# 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

Produkter

# Create product
dodopayments products create \
  --name "Premium Plan" \
  --price.amount 2999 \
  --price.currency USD

# List products
dodopayments products list

Användningsbaserad Fakturering

Ingest Händelser

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

Hantera Mätare

# Create meter
dodopayments meters create \
  --name "API Requests" \
  --event-name api_request \
  --aggregation count

# List meters
dodopayments meters list

Utdataformat

JSON (för skripting)

dodopayments payments list --format json | jq '.data[] | {id, amount}'

Fin (för läsning)

dodopayments payments retrieve pay_123 --format pretty

Interaktiv Utforskning

dodopayments payments list --format explore

Transformera med gjson

# Extract all payment IDs
dodopayments payments list --transform "data.#.id"

# Filter and extract
dodopayments payments list --transform "data.#(amount>5000)#.id"
Använd --format json med jq för kraftfull databehandling i shell-skript.

Skriptexempel

#!/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 Komplettering

Aktivera automatisk komplettering:
# Bash
eval "$(dodopayments completion bash)"

# Zsh
eval "$(dodopayments completion zsh)"

# Fish
dodopayments completion fish | source

Tillgängliga Resurser

CLI tillhandahåller kommandon för 24 resurskategorier:
  • checkout-sessions - Hantering av checkout-sessioner
  • payments - Betalningsoperationer
  • subscriptions - Återkommande fakturering
  • customers - Kundkonton
  • products - Produktkatalog
  • licenses - Programvarulicenser
  • refunds - Betalningsåterbetalningar
  • disputes - Betalningsdispyter
  • webhooks - Händelse-webhooks
  • meters - Användningsmätare
  • usage-events - Användningstracking
  • discounts - Rabattkoder
  • payouts - Säljarpayouts
  • brands - Multi-brand hantering
  • Plus 10 ytterligare resurser
Använd dodopayments --help för att se alla tillgängliga resurser och dodopayments [resource] --help för resurs-specifika kommandon.

Resurser

Support

Behöver du hjälp med CLI?