Resources
Every billing resource below is generated from the same OpenAPI spec documented in the API Reference — the CLI dispatches to the exact same endpoints, so filters, validation and delete behaviour are identical. Reach for schema introspection whenever a command's exact parameters aren't obvious from the examples here.
kobana billing <resource> <method> [flags]
How to read these pages
--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference. See Authentication for the billing product's own credentials.
The catalogue
| Resource | Command | Methods |
|---|---|---|
| Plans | plans | list, create, get, update, delete, duplicate, bulk-archive create, bulk-delete create, bulk-move-group create, items get, items update |
| Plan groups | plan-groups | list, create, get, update, delete, archive, reorder create |
| Products | 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 |
| Product groups | product-groups | list, create, get, update, delete, archive create, archive delete, reorder create, reorder update |
| Service items | service-items | list, create, get, update, delete |
| Subscriptions | subscriptions | list, create, get, update, delete, activate, cancel, change-plan, create-invoice, items, pause, resume, revert-to-confirmed, sync-plan-items |
| Subscription changes | subscription-changes | config list, config update |
| Subscription item changes | subscription-item-changes | list, get |
| Plan changes | plan-changes | list, create, get, config list, config update, rules list, rules create, rules get, rules update, rules delete, stats list |
| Billing accounts | billing-accounts | list, create, get, update, delete, close, credits, entitlements, invoices, reactivate, subscriptions, suspend |
| Invoices | 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 |
| Payments | payments | list, create, get, delete, cancel, change-card, change-due-date, refund, retry, send-email, sync, bulk-update-invoice create |
| Payment methods | payment-methods | list, create, get, update, delete, set-default |
| Credits | credits | list, create, get, update, delete |
| Withholdings | withholdings | list, get, convert-to-credit, convert-to-credits create |
| Coupons | coupons | list, create, get, update, delete, deactivate, redemptions |
| Customers | 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 |
| Companies | companies | list, create, get, update, delete, deactivate, reactivate, set-default, fiscal get, fiscal update, fiscal-profile get, fiscal-profile update, matriz list |
| Organization | organization | list, update |
| Proposals | 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 |
| Proposal templates | proposal-templates | list, create, get, update, delete, activate, deactivate, duplicate, set-default |
| Invoices (NF-e) | 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 |
| Tax rules | tax-rules | list, create, get, update, delete |
| Tax periods | tax-periods | list, create, get, update, delete |
| Digital certificates | certificates | list, create, get, delete |
| Usage | usage | list, create, snapshots daily list, snapshots daily create, snapshots monthly list, snapshots monthly create, summary list |
| Dashboard users | dashboard-users | list, create, get, update, delete |
| Team roles | team-roles | list, create, get, update, delete |