Uso
Sintaxis
kobana <producto> <recurso> <metodo> [flags]
<producto>—banking,finance,billingoinbox.<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
| Recurso | Descripción |
|---|---|
plans | Planes |
plan-groups | Grupos de planes |
products | Productos |
product-groups | Grupos de productos |
service-items | Ítems de servicio |
subscriptions | Suscripciones |
subscription-changes | Cambios de suscripción |
subscription-item-changes | Cambios de ítems |
plan-changes | Cambios de plan |
billing-accounts | Cuentas de cobro |
invoices | Facturas |
payments | Pagos |
payment-methods | Medios de pago |
credits | Créditos |
withholdings | Retenciones |
coupons | Cupones |
customers | Clientes |
companies | Empresas |
organization | Organización |
proposals | Propuestas |
proposal-templates | Plantillas de propuesta |
nfes | Notas fiscales |
tax-rules | Reglas de impuesto |
tax-periods | Períodos fiscales |
certificates | Certificados digitales |
usage | Consumo |
dashboard-users | Usuarios del panel |
team-roles | Roles 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
- Introspección de schema — inspecciona parámetros y cuerpo de cualquier endpoint.
- Flags globales — todas las flags que acepta un comando.
- Helpers — atajos
+verbopara flujos comunes. - Recursos — el catálogo completo, recurso por recurso.