Can I use Recurly as a CLI?

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

Can I expose Recurly through MCP?

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

Where are Recurly credentials stored?

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

Can I deny write access for Recurly MCP tools?

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

other

Recurly CLI for AI Agents

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

7 functions 6 read 1 write API key auth

Submit Recurly feedback View package source

Recurly CLI Setup

Recurly can be configured headlessly with `kosmokrator integrations:configure recurly`.

# 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 recurly --set api_key="$RECURLY_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor recurly --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. 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
`api_key`	`RECURLY_API_KEY`	Secret `secret`	yes	API Key
`subdomain`	`RECURLY_SUBDOMAIN`	Text `text`	no	Subdomain

Call Recurly Headlessly

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

kosmo integrations:call recurly.recurly_list_accounts '{
  "limit": 1,
  "cursor": "example_cursor",
  "email": "example_email",
  "state": "example_state"
}' --json

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

kosmo integrations:recurly recurly_list_accounts '{
  "limit": 1,
  "cursor": "example_cursor",
  "email": "example_email",
  "state": "example_state"
}' --json

Agent Discovery Commands

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

kosmo integrations:docs recurly --json
kosmo integrations:docs recurly.recurly_list_accounts --json
kosmo integrations:schema recurly.recurly_list_accounts --json
kosmo integrations:search "Recurly" --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 Recurly.

`recurly.recurly_list_accounts`

Read read

List billing accounts from Recurly. Supports filtering by email and state, with cursor-based pagination.

Parameters: limit, cursor, email, state

Generic CLI call

kosmo integrations:call recurly.recurly_list_accounts '{"limit":1,"cursor":"example_cursor","email":"example_email","state":"example_state"}' --json

Provider shortcut

kosmo integrations:recurly recurly_list_accounts '{"limit":1,"cursor":"example_cursor","email":"example_email","state":"example_state"}' --json

`recurly.recurly_get_account`

Read read

Get details of a specific Recurly billing account by its ID or account code.

Parameters: id

Generic CLI call

kosmo integrations:call recurly.recurly_get_account '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:recurly recurly_get_account '{"id":"example_id"}' --json

`recurly.recurly_create_account`

Write write

Create a new billing account in Recurly with a unique account code, email, and name.

Parameters: code, email, first_name, last_name

Generic CLI call

kosmo integrations:call recurly.recurly_create_account '{"code":"example_code","email":"example_email","first_name":"example_first_name","last_name":"example_last_name"}' --json

Provider shortcut

kosmo integrations:recurly recurly_create_account '{"code":"example_code","email":"example_email","first_name":"example_first_name","last_name":"example_last_name"}' --json

`recurly.recurly_list_subscriptions`

Read read

List subscriptions from Recurly. Supports filtering by account and state, with cursor-based pagination.

Parameters: limit, cursor, account_id, state

Generic CLI call

kosmo integrations:call recurly.recurly_list_subscriptions '{"limit":1,"cursor":"example_cursor","account_id":"example_account_id","state":"example_state"}' --json

Provider shortcut

kosmo integrations:recurly recurly_list_subscriptions '{"limit":1,"cursor":"example_cursor","account_id":"example_account_id","state":"example_state"}' --json

`recurly.recurly_get_subscription`

Read read

Get details of a specific Recurly subscription by its UUID.

Parameters: id

Generic CLI call

kosmo integrations:call recurly.recurly_get_subscription '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:recurly recurly_get_subscription '{"id":"example_id"}' --json

`recurly.recurly_list_plans`

Read read

List billing plans from Recurly. Supports cursor-based pagination.

Parameters: limit, cursor

Generic CLI call

kosmo integrations:call recurly.recurly_list_plans '{"limit":1,"cursor":"example_cursor"}' --json

Provider shortcut

kosmo integrations:recurly recurly_list_plans '{"limit":1,"cursor":"example_cursor"}' --json

`recurly.recurly_get_current_user`

Read read

Verify the Recurly API connection by fetching the first account. Useful as a health check.

Parameters: none

Generic CLI call

kosmo integrations:call recurly.recurly_get_current_user '{}' --json

Provider shortcut

kosmo integrations:recurly recurly_get_current_user '{}' --json

Function Schemas

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

`recurly.recurly_list_accounts`

List billing accounts from Recurly. Supports filtering by email and state, with cursor-based pagination.

Operation: Read read
Schema command: kosmo integrations:schema recurly.recurly_list_accounts --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of accounts to return (default: 20, max: 200).
`cursor`	string	no	Cursor for pagination — pass the value from a previous response to get the next page.
`email`	string	no	Filter accounts by email address.
`state`	string	no	Filter by account state: "active", "closed", or "inactive".

`recurly.recurly_get_account`

Get details of a specific Recurly billing account by its ID or account code.

Operation: Read read
Schema command: kosmo integrations:schema recurly.recurly_get_account --json

Parameter	Type	Required	Description
`id`	string	yes	The account ID or account code (e.g., "code-123" or a UUID).

`recurly.recurly_create_account`

Create a new billing account in Recurly with a unique account code, email, and name.

Operation: Write write
Schema command: kosmo integrations:schema recurly.recurly_create_account --json

Parameter	Type	Required	Description
`code`	string	yes	A unique identifier for the account (e.g., "cust-001").
`email`	string	no	The account email address.
`first_name`	string	no	The account holder's first name.
`last_name`	string	no	The account holder's last name.

`recurly.recurly_list_subscriptions`

List subscriptions from Recurly. Supports filtering by account and state, with cursor-based pagination.

Operation: Read read
Schema command: kosmo integrations:schema recurly.recurly_list_subscriptions --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of subscriptions to return (default: 20, max: 200).
`cursor`	string	no	Cursor for pagination — pass the value from a previous response to get the next page.
`account_id`	string	no	Filter subscriptions by account ID or account code.
`state`	string	no	Filter by subscription state: "active", "canceled", "expired", "future", "paused", or "trial".

`recurly.recurly_get_subscription`

Get details of a specific Recurly subscription by its UUID.

Operation: Read read
Schema command: kosmo integrations:schema recurly.recurly_get_subscription --json

Parameter	Type	Required	Description
`id`	string	yes	The subscription UUID.

`recurly.recurly_list_plans`

List billing plans from Recurly. Supports cursor-based pagination.

Operation: Read read
Schema command: kosmo integrations:schema recurly.recurly_list_plans --json

Parameter	Type	Required	Description
`limit`	integer	no	Maximum number of plans to return (default: 20, max: 200).
`cursor`	string	no	Cursor for pagination — pass the value from a previous response to get the next page.

`recurly.recurly_get_current_user`

Verify the Recurly API connection by fetching the first account. Useful as a health check.

Operation: Read read
Schema command: kosmo integrations:schema recurly.recurly_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.