Usage

Syntax

kobana <product> <resource> <method> [flags]

• <product> — banking, finance, billing or inbox.
• <resource> — can be nested: subscriptions, invoices installments, customers users.
• <method> — the action: list, get, create, update, delete, or an action specific to the resource.

The API version never appears in the command — the CLI resolves the URL from the embedded OpenAPI spec.

URL and query parameters go in --params; the request body goes in --json.

The whole surface is discoverable through --help, at every level:

kobana --help                # products
kobana billing --help        # Automatic Billing resources
kobana billing plans --help  # a resource's methods

billing resources

Resource	Description
plans	Plans
plan-groups	Plan groups
products	Products
product-groups	Product groups
service-items	Service items
subscriptions	Subscriptions
subscription-changes	Subscription changes
subscription-item-changes	Subscription item changes
plan-changes	Plan changes
billing-accounts	Billing accounts
invoices	Invoices
payments	Payments
payment-methods	Payment methods
credits	Credits
withholdings	Withholdings
coupons	Coupons
customers	Customers
companies	Companies
organization	Organization
proposals	Proposals
proposal-templates	Proposal templates
nfes	Invoices (NF-e)
tax-rules	Tax rules
tax-periods	Tax periods
certificates	Digital certificates
usage	Usage
dashboard-users	Dashboard users
team-roles	Team roles

Each resource has a page of its own, with the full command table and examples — see the catalogue.

Examples

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

# Pause and resume a subscription
kobana billing subscriptions pause --params '{"id": "SUBSCRIPTION_ID"}'
kobana billing subscriptions resume --params '{"id": "SUBSCRIPTION_ID"}'

# Finalize an invoice and issue its NF-e
kobana billing invoices finalize --dry-run --params '{"id": "INVOICE_ID"}'
kobana billing invoices issue-nfe --dry-run --params '{"id": "INVOICE_ID"}'

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

# List with automatic pagination (NDJSON)
kobana billing invoices list --page-all --fields "id,status,total"

# Table output
kobana billing plans list --output-format table

# Save the response to a file
kobana billing invoices get --params '{"id": "INVOICE_ID"}' --output fatura.json

Next steps

• Schema introspection — inspect any endpoint's parameters and body.
• Global flags — every flag a command accepts.
• Helpers — +verb shortcuts for common workflows.
• Resources — the full catalogue, resource by resource.