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.

data

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.

Zuora CLI Setup

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

Install, configure, and verify

# 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 reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

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

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

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

Discovery

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

Discovery commands

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

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`zuora.zuora_list_accounts`

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

Read read

Parameters: page_size, cursor, filter

Generic call

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

Shortcut

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

`zuora.zuora_get_account`

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

Read read

Parameters: account_id

Generic call

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

Shortcut

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

`zuora.zuora_list_subscriptions`

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

Read read

Parameters: page_size, cursor, filter

Generic call

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

Shortcut

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

`zuora.zuora_get_subscription`

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

Read read

Parameters: subscription_id

Generic call

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

Shortcut

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

`zuora.zuora_list_invoices`

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

Read read

Parameters: page_size, cursor, filter

Generic call

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

Shortcut

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

`zuora.zuora_list_payments`

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

Read read

Parameters: page_size, cursor, filter

Generic call

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

Shortcut

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

`zuora.zuora_get_current_user`

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

Read read

Parameters: none

Generic call

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

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 3 parameters

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 1 parameters

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 3 parameters

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 1 parameters

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 3 parameters

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 3 parameters

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 0 parameters

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.