> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Recurly

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

![Recurly logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/recurly.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=681e28a2ce049b597652c5bae955206b)

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

## Tools

> [accordion] 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
>
> **account\_id** `string` *required*
>
> Opaque account ID, or code-\<account\_code> to look up by code. The code- prefix is required for account codes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **item\_id** `string` *required*
>
> Opaque item ID, or code-\<item\_code> to look up by code. The code- prefix is required for codes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **plan\_id** `string` *required*
>
> Opaque plan ID, or code-\<plan\_code> to look up by code. The code- prefix is required for codes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **email** `string`
>
> Exact email address to match. Multiple accounts can share an email.
>
> **limit** `integer`
>
> Maximum accounts to return in this page (1-200).
>
> **past\_due** `boolean`
>
> Set true to return only accounts with a past-due invoice.
>
> **subscriber** `boolean`
>
> Filter by whether the account has an active, canceled, or future subscription.
>
> **next\_cursor** `string`
>
> Opaque continuation value returned by the previous call. Omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum invoices to return in this page (1-200).
>
> **state** `string ("pending" | "processing" | "past_due" | "paid" | "failed" | "open" | "closed" | "voided")`
>
> Return only invoices in this state. Omit to include all states.
>
> **next\_cursor** `string`
>
> 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")`
>
> Filter invoice kind. non-legacy includes charge and credit invoices.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum items to return in this page (1-200).
>
> **state** `string ("active" | "inactive")`
>
> Return only items in this state.
>
> **next\_cursor** `string`
>
> Opaque continuation value returned by the previous call. Omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Plans
>
> **Slug:** `RECURLY_LIST_PLANS`
>
> List subscription plans and their pricing configuration on the connected Recurly site.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum plans to return in this page (1-200).
>
> **state** `string ("active" | "inactive")`
>
> Return only plans in this state.
>
> **next\_cursor** `string`
>
> Opaque continuation value returned by the previous call. Omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum sites to return in this page (1-200).
>
> **state** `string ("active" | "inactive")`
>
> Return only sites in this state.
>
> **next\_cursor** `string`
>
> Opaque continuation value returned by the previous call. Omit for the first page and pass it back unchanged to fetch the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscriptions
>
> **Slug:** `RECURLY_LIST_SUBSCRIPTIONS`
>
> List subscriptions and filter by lifecycle state without creating, changing, pausing, canceling, or billing a subscription.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum subscriptions to return in this page (1-200).
>
> **state** `string ("active" | "canceled" | "expired" | "future" | "in_trial" | "live")`
>
> Filter by lifecycle state. live includes active, canceled, future, and currently in-trial subscriptions.
>
> **next\_cursor** `string`
>
> Opaque continuation value returned by the previous call. Omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum transactions to return in this page (1-200).
>
> **success** `boolean`
>
> Set true to return only successful transactions. Omit to include all outcomes.
>
> **next\_cursor** `string`
>
> 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")`
>
> Filter by transaction type; payment includes purchase and capture transactions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
