Uso

Sintaxe

kobana <produto> <recurso> <metodo> [flags]

• <produto> — banking, finance, billing ou inbox.
• <recurso> — pode ser aninhado: subscriptions, invoices installments, customers users.
• <metodo> — a ação: list, get, create, update, delete, ou uma ação específica do recurso.

A versão da API nunca entra no comando — o CLI resolve a URL a partir da spec OpenAPI embutida.

Parâmetros de URL e de query vão em --params; o corpo da requisição vai em --json.

Toda a superfície é descoberta pelo --help, em qualquer nível:

kobana --help                # produtos
kobana billing --help        # recursos do Faturamento Automático
kobana billing plans --help  # métodos de um recurso

Recursos de billing

Recurso	Descrição
plans	Planos
plan-groups	Grupos de planos
products	Produtos
product-groups	Grupos de produtos
service-items	Itens de serviço
subscriptions	Assinaturas
subscription-changes	Mudanças de assinatura
subscription-item-changes	Mudanças de itens
plan-changes	Mudanças de plano
billing-accounts	Contas de cobrança
invoices	Faturas
payments	Pagamentos
payment-methods	Meios de pagamento
credits	Créditos
withholdings	Retenções
coupons	Cupons
customers	Clientes
companies	Empresas
organization	Organização
proposals	Propostas
proposal-templates	Modelos de proposta
nfes	Notas fiscais
tax-rules	Regras de imposto
tax-periods	Períodos fiscais
certificates	Certificados digitais
usage	Consumo
dashboard-users	Usuários do painel
team-roles	Papéis de equipe

Cada recurso tem a sua própria página, com a tabela completa de comandos e exemplos — veja o catálogo.

Exemplos

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

# Pausar e retomar uma assinatura
kobana billing subscriptions pause --params '{"id": "SUBSCRIPTION_ID"}'
kobana billing subscriptions resume --params '{"id": "SUBSCRIPTION_ID"}'

# Fechar uma fatura e emitir a NF-e
kobana billing invoices finalize --dry-run --params '{"id": "INVOICE_ID"}'
kobana billing invoices issue-nfe --dry-run --params '{"id": "INVOICE_ID"}'

# Criar um plano
kobana billing plans create --json '{"name": "Pro", "slug": "pro"}'

# Listar com paginação automática (NDJSON)
kobana billing invoices list --page-all --fields "id,status,total"

# Saída em tabela
kobana billing plans list --output-format table

# Salvar a resposta em arquivo
kobana billing invoices get --params '{"id": "INVOICE_ID"}' --output fatura.json

Próximos passos

• Introspecção de schema — inspecione parâmetros e corpo de qualquer endpoint.
• Flags globais — todas as flags que um comando aceita.
• Helpers — atalhos +verbo para fluxos comuns.
• Recursos — o catálogo completo, recurso a recurso.