Recursos
Todo recurso de billing abaixo é gerado a partir da mesma spec OpenAPI documentada na Referência da API — o CLI chama exatamente os mesmos endpoints, então filtros, validação e comportamento de exclusão são idênticos. Recorra à introspecção de schema sempre que os parâmetros exatos de um comando não estiverem óbvios nos exemplos destas páginas.
kobana billing <recurso> <metodo> [flags]
Como ler estas páginas
--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa. Veja Autenticação para as credenciais próprias do billing.
O catálogo
| Recurso | Comando | Métodos |
|---|---|---|
| Planos | plans | list, create, get, update, delete, duplicate, bulk-archive create, bulk-delete create, bulk-move-group create, items get, items update |
| Grupos de planos | plan-groups | list, create, get, update, delete, archive, reorder create |
| Produtos | products | list, create, get, update, delete, archive, publish, restore, bulk-archive create, bulk-change-company create, bulk-delete create, bulk-move-group create, bulk-visibility create, reorder create, reorder update |
| Grupos de produtos | product-groups | list, create, get, update, delete, archive create, archive delete, reorder create, reorder update |
| Itens de serviço | service-items | list, create, get, update, delete |
| Assinaturas | subscriptions | list, create, get, update, delete, activate, cancel, change-plan, create-invoice, items, pause, resume, revert-to-confirmed, sync-plan-items |
| Mudanças de assinatura | subscription-changes | config list, config update |
| Mudanças de itens | subscription-item-changes | list, get |
| Mudanças de plano | plan-changes | list, create, get, config list, config update, rules list, rules create, rules get, rules update, rules delete, stats list |
| Contas de cobrança | billing-accounts | list, create, get, update, delete, close, credits, entitlements, invoices, reactivate, subscriptions, suspend |
| Faturas | invoices | list, create, get, update, delete, apply-credits, finalize, issue-nfe, pay, payment-methods, pdf, remove-credits, send-reminder, undo-payment, void, installments get, installments create, installments mark-paid, installments pay, pending-nfe list, pending-payment list |
| Pagamentos | payments | list, create, get, delete, cancel, change-card, change-due-date, refund, retry, send-email, sync, bulk-update-invoice create |
| Meios de pagamento | payment-methods | list, create, get, update, delete, set-default |
| Créditos | credits | list, create, get, update, delete |
| Retenções | withholdings | list, get, convert-to-credit, convert-to-credits create |
| Cupons | coupons | list, create, get, update, delete, deactivate, redemptions |
| Clientes | customers | list, create, get, update, delete, recalculate-mrr, statement get, statement sync create, users get, users create, users update, users delete, users email-preview, users resend, users invite create |
| Empresas | companies | list, create, get, update, delete, deactivate, reactivate, set-default, fiscal get, fiscal update, fiscal-profile get, fiscal-profile update, matriz list |
| Organização | organization | list, update |
| Propostas | proposals | list, create, get, update, delete, accept, cancel, duplicate, generate-pdf, json, pricing, publish, send, undo-accept, unpublish, bulk-cancel create, bulk-delete create, bulk-send create, items get, items create, items update, items delete, stats list |
| Modelos de proposta | proposal-templates | list, create, get, update, delete, activate, deactivate, duplicate, set-default |
| Notas fiscais | nfes | list, create, get, update, delete, cancel, issue, pdf, retry-cancel, validate-barueri, xml, bulk create, bulk-delete create, fetch-barueri create, fetch-from-sefaz create, import-barueri create, request-tries list, request-tries get, requests get, sync create |
| Regras de imposto | tax-rules | list, create, get, update, delete |
| Períodos fiscais | tax-periods | list, create, get, update, delete |
| Certificados digitais | certificates | list, create, get, delete |
| Consumo | usage | list, create, snapshots daily list, snapshots daily create, snapshots monthly list, snapshots monthly create, summary list |
| Usuários do painel | dashboard-users | list, create, get, update, delete |
| Papéis de equipe | team-roles | list, create, get, update, delete |