---
canonical_url: "https://docs.composio.dev/toolkits/recurly"
markdown_url: "https://docs.composio.dev/toolkits/recurly.md"
product: "platform"
version: null
last_updated: null
---

# Recurly

Recurly is a subscription management and recurring billing platform for managing customers, plans, subscriptions, invoices, payments, and revenue operations.

- **Category:** payment processing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `RECURLY`
- **Version:** 00000000_00

## Tools

### Get Account

**Slug:** `RECURLY_GET_ACCOUNT`

Fetch one Recurly customer account by opaque ID or account code. Prefix an account code with code-, for example code-customer_123; do not prefix an opaque ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Opaque account ID, or code-<account_code> to look up by code. The code- prefix is required for account codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item

**Slug:** `RECURLY_GET_ITEM`

Fetch one Recurly catalog item by opaque ID or item code. Prefix a code with code-, for example code-red; do not prefix an opaque ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | Opaque item ID, or code-<item_code> to look up by code. The code- prefix is required for codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Plan

**Slug:** `RECURLY_GET_PLAN`

Fetch one Recurly subscription plan by opaque ID or plan code. Prefix a code with code-, for example code-gold; do not prefix an opaque ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `plan_id` | string | Yes | Opaque plan ID, or code-<plan_code> to look up by code. The code- prefix is required for codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounts

**Slug:** `RECURLY_LIST_ACCOUNTS`

Find customer accounts on the Recurly site by email or subscription and past-due status. Returns one page and account identifiers that other tools can consume.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Exact email address to match. Multiple accounts can share an email. |
| `limit` | integer | No | Maximum accounts to return in this page (1-200). |
| `past_due` | boolean | No | Set true to return only accounts with a past-due invoice. |
| `subscriber` | boolean | No | Filter by whether the account has an active, canceled, or future subscription. |
| `next_cursor` | string | No | Opaque continuation value returned by the previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoices

**Slug:** `RECURLY_LIST_INVOICES`

List invoices by state or invoice type to inspect billed amounts, balances, and account or subscription references without changing invoice state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum invoices to return in this page (1-200). |
| `state` | string ("pending" | "processing" | "past_due" | "paid" | "failed" | "open" | "closed" | "voided") | No | Return only invoices in this state. Omit to include all states. |
| `next_cursor` | string | No | Opaque continuation value returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page. |
| `invoice_type` | string ("charge" | "credit" | "legacy" | "non-legacy") | No | Filter invoice kind. non-legacy includes charge and credit invoices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items

**Slug:** `RECURLY_LIST_ITEMS`

List reusable catalog items on the connected Recurly site, including codes, state, tax settings, and currency pricing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items to return in this page (1-200). |
| `state` | string ("active" | "inactive") | No | Return only items in this state. |
| `next_cursor` | string | No | Opaque continuation value returned by the previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Plans

**Slug:** `RECURLY_LIST_PLANS`

List subscription plans and their pricing configuration on the connected Recurly site.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum plans to return in this page (1-200). |
| `state` | string ("active" | "inactive") | No | Return only plans in this state. |
| `next_cursor` | string | No | Opaque continuation value returned by the previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sites

**Slug:** `RECURLY_LIST_SITES`

List Recurly sites visible to the connected private API key, including each site's ID, subdomain, mode, currencies, and enabled features. Use this first to confirm sandbox versus production context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum sites to return in this page (1-200). |
| `state` | string ("active" | "inactive") | No | Return only sites in this state. |
| `next_cursor` | string | No | Opaque continuation value returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscriptions

**Slug:** `RECURLY_LIST_SUBSCRIPTIONS`

List subscriptions and filter by lifecycle state without creating, changing, pausing, canceling, or billing a subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum subscriptions to return in this page (1-200). |
| `state` | string ("active" | "canceled" | "expired" | "future" | "in_trial" | "live") | No | Filter by lifecycle state. live includes active, canceled, future, and currently in-trial subscriptions. |
| `next_cursor` | string | No | Opaque continuation value returned by the previous call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transactions

**Slug:** `RECURLY_LIST_TRANSACTIONS`

List payment transactions by type and success status for read-only payment investigation. This tool never authorizes, captures, purchases, cancels, or refunds funds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum transactions to return in this page (1-200). |
| `success` | boolean | No | Set true to return only successful transactions. Omit to include all outcomes. |
| `next_cursor` | string | No | Opaque continuation value returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page. |
| `transaction_type` | string ("authorization" | "capture" | "payment" | "purchase" | "refund" | "verify") | No | Filter by transaction type; payment includes purchase and capture transactions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |