Saltar al contenido principal

Uso

Sintaxis​

kobana <producto> <recurso> <metodo> [flags]
  • <producto> — banking, finance, billing o inbox.
  • <recurso> — puede ser anidado: subscriptions, invoices installments, customers users.
  • <metodo> — la acción: list, get, create, update, delete, o una acción específica del recurso.

La versión de la API nunca entra en el comando — el CLI resuelve la URL a partir de la spec OpenAPI embebida.

Los parámetros de URL y de query van en --params; el cuerpo de la solicitud va en --json.

Toda la superficie se descubre con --help, en cualquier nivel:

kobana --help # productos
kobana billing --help # recursos de Facturación Automática
kobana billing plans --help # métodos de un recurso

Recursos de billing​

RecursoDescripción
plansPlanes
plan-groupsGrupos de planes
productsProductos
product-groupsGrupos de productos
service-itemsÍtems de servicio
subscriptionsSuscripciones
subscription-changesCambios de suscripción
subscription-item-changesCambios de ítems
plan-changesCambios de plan
billing-accountsCuentas de cobro
invoicesFacturas
paymentsPagos
payment-methodsMedios de pago
creditsCréditos
withholdingsRetenciones
couponsCupones
customersClientes
companiesEmpresas
organizationOrganización
proposalsPropuestas
proposal-templatesPlantillas de propuesta
nfesNotas fiscales
tax-rulesReglas de impuesto
tax-periodsPeríodos fiscales
certificatesCertificados digitales
usageConsumo
dashboard-usersUsuarios del panel
team-rolesRoles de equipo

Cada recurso tiene su propia página, con la tabla completa de comandos y ejemplos — mira el catálogo.

Ejemplos​

# Suscripciones activas
kobana billing subscriptions list \
--params '{"status": "active"}' \
--fields "id,status,plan_id,next_billing_at"

# Pausar y reanudar una suscripción
kobana billing subscriptions pause --params '{"id": "SUBSCRIPTION_ID"}'
kobana billing subscriptions resume --params '{"id": "SUBSCRIPTION_ID"}'

# Cerrar una factura y emitir la NF-e
kobana billing invoices finalize --dry-run --params '{"id": "INVOICE_ID"}'
kobana billing invoices issue-nfe --dry-run --params '{"id": "INVOICE_ID"}'

# Crear un plan
kobana billing plans create --json '{"name": "Pro", "slug": "pro"}'

# Listar con paginación automática (NDJSON)
kobana billing invoices list --page-all --fields "id,status,total"

# Salida en tabla
kobana billing plans list --output-format table

# Guardar la respuesta en un archivo
kobana billing invoices get --params '{"id": "INVOICE_ID"}' --output fatura.json

Próximos pasos​