Saltar al contenido principal

Instalación

Instalar Go

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

Desde el código fuente

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

Inicio Rápido

Configura tu clave API:
export DODO_PAYMENTS_API_KEY=your_api_key_here
Estructura básica del comando:
dodopayments [resource] [command] [flags]
Crea una sesión de pago:
dodopayments checkout-sessions create \
  --product-cart.product_id prod_123 \
  --product-cart.quantity 1 \
  --return-url https://yourdomain.com/return

Flags Globales

FlagDescripción
--formatFormato de salida: auto, json, yaml, pretty, explore
--transformFiltrar respuesta usando la sintaxis gjson
--debugHabilitar registro detallado
--version, -vMostrar versión de la CLI

Comandos Comunes

Pagos

# 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

Clientes

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

Suscripciones

# 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

Productos

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

# List products
dodopayments products list

Facturación Basada en Uso

Ingestar Eventos

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

Gestionar Medidores

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

# List meters
dodopayments meters list

Formatos de Salida

JSON (para scripting)

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

Bonito (para lectura)

dodopayments payments retrieve pay_123 --format pretty

Exploración Interactiva

dodopayments payments list --format explore

Transformar con gjson

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

# Filter and extract
dodopayments payments list --transform "data.#(amount>5000)#.id"
Usa --format json con jq para un procesamiento de datos potente en scripts de shell.

Ejemplo de Scripting

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

Compleción de Shell

Habilitar auto-completado:
# Bash
eval "$(dodopayments completion bash)"

# Zsh
eval "$(dodopayments completion zsh)"

# Fish
dodopayments completion fish | source

Recursos Disponibles

La CLI proporciona comandos para 24 categorías de recursos:
  • checkout-sessions - Gestión de sesiones de pago
  • payments - Operaciones de pago
  • subscriptions - Facturación recurrente
  • customers - Cuentas de clientes
  • products - Catálogo de productos
  • licenses - Licencias de software
  • refunds - Reembolsos de pago
  • disputes - Disputas de pago
  • webhooks - Webhooks de eventos
  • meters - Medidores de uso
  • usage-events - Seguimiento de uso
  • discounts - Códigos de descuento
  • payouts - Pagos a vendedores
  • brands - Gestión de múltiples marcas
  • Más 10 recursos adicionales
Usa dodopayments --help para ver todos los recursos disponibles y dodopayments [resource] --help para comandos específicos de recursos.

Recursos

Soporte

¿Necesitas ayuda con la CLI?