data
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.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: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
api_key | RECURLY_API_KEY | Secret secret | yes | API Key |
subdomain | RECURLY_SUBDOMAIN | Text text | no | Subdomain |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call recurly.recurly_list_accounts '{"limit":1,"cursor":"example_cursor","email":"example_email","state":"example_state"}' --json kosmo integrations:recurly recurly_list_accounts '{"limit":1,"cursor":"example_cursor","email":"example_email","state":"example_state"}' --json Discovery
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 Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
recurly.recurly_list_accounts
List billing accounts from Recurly. Supports filtering by email and state, with cursor-based pagination.
read - Parameters
- limit, cursor, email, state
kosmo integrations:call recurly.recurly_list_accounts '{"limit":1,"cursor":"example_cursor","email":"example_email","state":"example_state"}' --json kosmo integrations:recurly recurly_list_accounts '{"limit":1,"cursor":"example_cursor","email":"example_email","state":"example_state"}' --json recurly.recurly_get_account
Get details of a specific Recurly billing account by its ID or account code.
read - Parameters
- id
kosmo integrations:call recurly.recurly_get_account '{"id":"example_id"}' --json kosmo integrations:recurly recurly_get_account '{"id":"example_id"}' --json recurly.recurly_create_account
Create a new billing account in Recurly with a unique account code, email, and name.
write - Parameters
- code, email, first_name, last_name
kosmo integrations:call recurly.recurly_create_account '{"code":"example_code","email":"example_email","first_name":"example_first_name","last_name":"example_last_name"}' --json 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
List subscriptions from Recurly. Supports filtering by account and state, with cursor-based pagination.
read - Parameters
- limit, cursor, account_id, state
kosmo integrations:call recurly.recurly_list_subscriptions '{"limit":1,"cursor":"example_cursor","account_id":"example_account_id","state":"example_state"}' --json kosmo integrations:recurly recurly_list_subscriptions '{"limit":1,"cursor":"example_cursor","account_id":"example_account_id","state":"example_state"}' --json recurly.recurly_get_subscription
Get details of a specific Recurly subscription by its UUID.
read - Parameters
- id
kosmo integrations:call recurly.recurly_get_subscription '{"id":"example_id"}' --json kosmo integrations:recurly recurly_get_subscription '{"id":"example_id"}' --json recurly.recurly_list_plans
List billing plans from Recurly. Supports cursor-based pagination.
read - Parameters
- limit, cursor
kosmo integrations:call recurly.recurly_list_plans '{"limit":1,"cursor":"example_cursor"}' --json kosmo integrations:recurly recurly_list_plans '{"limit":1,"cursor":"example_cursor"}' --json recurly.recurly_get_current_user
Verify the Recurly API connection by fetching the first account. Useful as a health check.
read - Parameters
- none
kosmo integrations:call recurly.recurly_get_current_user '{}' --json 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 4 parameters
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 1 parameters
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 4 parameters
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 4 parameters
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 1 parameters
kosmo integrations:schema recurly.recurly_get_subscription --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The subscription UUID. |
recurly.recurly_list_plans 2 parameters
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 0 parameters
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.