Can I use Zuora as a CLI?

Yes. KosmoKrator exposes a Zuora CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Zuora through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Zuora tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Zuora credentials stored?

Zuora credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Zuora MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

billing

Zuora CLI for AI Agents

Use the Zuora CLI from KosmoKrator to call Zuora tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 7 read 0 write Manual OAuth token auth

Submit Zuora feedback View package source

Zuora CLI Setup

Zuora can be configured headlessly with `kosmokrator integrations:configure zuora`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure zuora --set access_token="$ZUORA_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor zuora --json
kosmokrator integrations:status --json

Credentials

Authentication type: Manual OAuth token oauth2_manual_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`access_token`	`ZUORA_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`base_url`	`ZUORA_BASE_URL`	URL `url`	no	API Base URL

Call Zuora Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call zuora.zuora_list_accounts '{
  "page_size": 1,
  "cursor": "example_cursor",
  "filter": "example_filter"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:zuora zuora_list_accounts '{
  "page_size": 1,
  "cursor": "example_cursor",
  "filter": "example_filter"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs zuora --json
kosmo integrations:docs zuora.zuora_list_accounts --json
kosmo integrations:schema zuora.zuora_list_accounts --json
kosmo integrations:search "Zuora" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Zuora.

`zuora.zuora_list_accounts`

Read read

List Zuora customer accounts. Returns account IDs, names, numbers, and status. Supports filtering and pagination.

Parameters: page_size, cursor, filter

Generic CLI call

kosmo integrations:call zuora.zuora_list_accounts '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

Provider shortcut

kosmo integrations:zuora zuora_list_accounts '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

`zuora.zuora_get_account`

Read read

Get details of a specific Zuora account by its ID. Returns account name, number, status, balance, and billing information.

Parameters: account_id

Generic CLI call

kosmo integrations:call zuora.zuora_get_account '{"account_id":"example_account_id"}' --json

Provider shortcut

kosmo integrations:zuora zuora_get_account '{"account_id":"example_account_id"}' --json

`zuora.zuora_list_subscriptions`

Read read

List Zuora subscriptions. Returns subscription IDs, numbers, status, and key dates. Supports filtering by account, status, and more.

Parameters: page_size, cursor, filter

Generic CLI call

kosmo integrations:call zuora.zuora_list_subscriptions '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

Provider shortcut

kosmo integrations:zuora zuora_list_subscriptions '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

`zuora.zuora_get_subscription`

Read read

Get details of a specific Zuora subscription by its ID. Returns subscription status, rate plans, charges, and key dates.

Parameters: subscription_id

Generic CLI call

kosmo integrations:call zuora.zuora_get_subscription '{"subscription_id":"example_subscription_id"}' --json

Provider shortcut

kosmo integrations:zuora zuora_get_subscription '{"subscription_id":"example_subscription_id"}' --json

`zuora.zuora_list_invoices`

Read read

List Zuora invoices. Returns invoice IDs, numbers, amounts, status, and dates. Supports filtering by account, status, and date.

Parameters: page_size, cursor, filter

Generic CLI call

kosmo integrations:call zuora.zuora_list_invoices '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

Provider shortcut

kosmo integrations:zuora zuora_list_invoices '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

`zuora.zuora_list_payments`

Read read

List Zuora payments. Returns payment IDs, numbers, amounts, status, and methods. Supports filtering by account, status, and date.

Parameters: page_size, cursor, filter

Generic CLI call

kosmo integrations:call zuora.zuora_list_payments '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

Provider shortcut

kosmo integrations:zuora zuora_list_payments '{"page_size":1,"cursor":"example_cursor","filter":"example_filter"}' --json

`zuora.zuora_get_current_user`

Read read

Get the profile of the currently authenticated Zuora user. Returns user name, email, and tenant information.

Parameters: none

Generic CLI call

kosmo integrations:call zuora.zuora_get_current_user '{}' --json

Provider shortcut

kosmo integrations:zuora zuora_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`zuora.zuora_list_accounts`

List Zuora customer accounts. Returns account IDs, names, numbers, and status. Supports filtering and pagination.

Operation: Read read
Schema command: kosmo integrations:schema zuora.zuora_list_accounts --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of results per page (default: 20, max: 100).
`cursor`	string	no	Pagination cursor from a previous response to get the next page.
`filter`	string	no	Filter expression, e.g. "name.EQ:Acme" or "status.EQ:Active".

`zuora.zuora_get_account`

Get details of a specific Zuora account by its ID. Returns account name, number, status, balance, and billing information.

Operation: Read read
Schema command: kosmo integrations:schema zuora.zuora_get_account --json

Parameter	Type	Required	Description
`account_id`	string	yes	The Zuora account ID (e.g., "8a90b89a8a...").

`zuora.zuora_list_subscriptions`

List Zuora subscriptions. Returns subscription IDs, numbers, status, and key dates. Supports filtering by account, status, and more.

Operation: Read read
Schema command: kosmo integrations:schema zuora.zuora_list_subscriptions --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of results per page (default: 20, max: 100).
`cursor`	string	no	Pagination cursor from a previous response to get the next page.
`filter`	string	no	Filter expression, e.g. "status.EQ:Active" or "account_id.EQ:8a90b89a...".

`zuora.zuora_get_subscription`

Get details of a specific Zuora subscription by its ID. Returns subscription status, rate plans, charges, and key dates.

Operation: Read read
Schema command: kosmo integrations:schema zuora.zuora_get_subscription --json

Parameter	Type	Required	Description
`subscription_id`	string	yes	The Zuora subscription ID (e.g., "8a90b89a8a...").

`zuora.zuora_list_invoices`

List Zuora invoices. Returns invoice IDs, numbers, amounts, status, and dates. Supports filtering by account, status, and date.

Operation: Read read
Schema command: kosmo integrations:schema zuora.zuora_list_invoices --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of results per page (default: 20, max: 100).
`cursor`	string	no	Pagination cursor from a previous response to get the next page.
`filter`	string	no	Filter expression, e.g. "status.EQ:Posted" or "account_id.EQ:8a90b89a...".

`zuora.zuora_list_payments`

List Zuora payments. Returns payment IDs, numbers, amounts, status, and methods. Supports filtering by account, status, and date.

Operation: Read read
Schema command: kosmo integrations:schema zuora.zuora_list_payments --json

Parameter	Type	Required	Description
`page_size`	integer	no	Number of results per page (default: 20, max: 100).
`cursor`	string	no	Pagination cursor from a previous response to get the next page.
`filter`	string	no	Filter expression, e.g. "status.EQ:Processed" or "account_id.EQ:8a90b89a...".

`zuora.zuora_get_current_user`

Get the profile of the currently authenticated Zuora user. Returns user name, email, and tenant information.

Operation: Read read
Schema command: kosmo integrations:schema zuora.zuora_get_current_user --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.