kobana-billing

Files (1)

• SKILL.md

SKILL.md (first lines)

# billing — Faturamento Automático

> **PREREQUISITE:** Read `../kobana-shared/SKILL.md` for auth, global flags, and security rules.

```bash
kobana billing <resource> <method> [flags]
```

Billing is its own API (`api.billing.kobana.com.br`) and does not share
credentials with the banking product. `KOBANA_BILLING_TOKEN` — or the credentials saved by `kobana billing auth login` — must hold an RS256 access
token issued by the Kobana Authorization Server (`account.kobana.com.br`) with
`aud=https://api.billing.kobana.com.br`. Scopes have two axes: `billing/{resource}` limits what the token reaches, and an
access level says what it may do there — `GET` needs `read`, `write` or `all`;
`DELETE` (bulk included) needs `delete` or `all`; bulk imports need `import`
and bulk exports `export` (or `all`); every other method needs `write` or
`all`. One level never stands in for another.

## API Resources

### Recurring billing
- `subscriptions` — `list`, `create`, `get`, `update`, `delete`, plus `activate`,
  `pause`, `resume`, `cancel`, `change-plan`, `change-anniversary`, `create-invoice`, `items`,
  `revert-to-confirmed`, `sync-plan-items`
- `subscription-changes config`, `subscription-item-changes list|get|cancel`
- `plans` — CRUD plus `archive`, `duplicate`, `items`, `bulk-archive`, `bulk delete`, `bulk-move-group`
- `plan-groups` — CRUD plus `archive`, `reorder`
- `plan-changes` — `list`, `create`, `get`, `config`, `rules`, `stats`

### Catalog
- `products` — CRUD plus `archive`, `publish`, `restore`, `reorder`, and the
  `bulk-*` operations
- `product-groups` — CRUD plus `archive`, `unarchive`, `reorder`
- `service-items` — CRUD

### Invoicing
- `invoices` — CRUD plus `finalize`, `pay`, `undo-payment`, `void`,
  `apply-credits`, `remove-credits`, `send-reminder`, `issue-nfe`, `pdf`,
  `installments`, `payment-methods`, `pending-nfe`, `pending-payment`
- `nfes` — CRUD plus `issue`, `cancel`, `retry-cancel`, `validate-barueri`,
  `import-barueri`, `fetch-barueri`, `fetch-from-sefaz`, `sync`, `pdf`, `xml`
- `payments` — `list`, `create`, `get`, `delete`, plus `cancel`, `refund`,
  `retry`, `change-card`, `change-due-date`, `send-email`, `sync`
- `payment-methods` — CRUD plus `set-default`
- `late-fee-policies` — CRUD plus `default`, `simulate`
- `bank-accounts`, `pix-keys` — CRUD
- `banks list` — the banks the bank accounts may use
- `holidays` — CRUD plus `sync`

### Accounts & customers
- `billing-accounts` — CRUD plus `close`, `suspend`, `reactivate`, `credits`,
  `entitlements`, `invoices`, `subscriptions`
- `customers` — CRUD plus `recalculate-mrr`, `statement`, `users`
- `companies` — CRUD plus `deactivate`, `reactivate`, `set-default`, `fiscal`,
  `fiscal-profile`, `matriz`
- `organization get|update` — the token's own organization (no id, no listing);
  `update` changes `addresses` and `custom_metadata` only
- `dashboard-users`, `team-roles`, `portal-users list`
- `me get` — the organization and scopes behind the token

### Proposals, credits and taxes
- `proposals` — CRUD plus `send`, `accept`, `undo-accept`, `publish`,
  `unpublish`, `cancel`, `duplicate`, `generate-pdf`, `items`, `pricing`, `stats`
- `proposal-templates` — CRUD plus `activate`, `deactivate`, `duplicate`
- `coupons` — CRUD plus `deactivate`, `redemptions`
- `credits`, `withholdings` (`convert-to-credits`), `tax-rules`, `tax-periods`
- `certificates` (`create` uploads with `--file file=…` / `cert_file=…` / `key_file=…`), `usage` (`summary`, `snapshots`, `credits`), `credit-purchases create`

## Examples

```bash
kobana billing subscriptions list --params '{"status": "active", "per_page": 25}' \
  --fields "id,status,plan_id,next_billing_at"

# Mutations: always dry-run first
kobana billing subscriptions pause --dry-run --params '{"id": "SUBSCRIPTION_ID"}'
kobana billing invoices finalize --dry-run --params '{"id": "INVOICE_ID"}'
```

## Discovering Commands

```bash
kobana billing --help
kobana billing subscriptions --help
kobana schema billing.subscriptions.create
```

From universokobana/kobana-cli, MIT.

More from universokobana/kobana-cli