> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/recurly.md).

# Recurly

Integration with Recurly subscription billing for reading accounts and invoices.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Recurly   | API Key        |

### Recurly

Connect to Recurly subscription billing with an API key. Reads accounts and invoices from your Recurly site.

#### Set up in Recurly

1. Sign in to Recurly with a user whose role includes the Integration permission.
2. Go to Integrations → API Credentials and scroll to the bottom, then select Add Private API Key.
3. Give the key a clear name (Recurly recommends a read-only key for this read-only integration) and create it.
4. Copy the private API key and treat it like a password.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Recurly**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                            |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Recurly API key. Create one under Integrations > API Credentials in the Recurly admin. It is sent as the username in HTTP Basic auth with an empty password. [Provider instructions](https://docs.recurly.com/recurly-subscriptions/docs/api-keys). |

**Provider documentation:** [Setup reference](https://docs.recurly.com/docs/api-keys).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Recurly** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Accounts

List accounts in your Recurly site.

#### Inputs

| Field | Type    | Required | Description                                   |
| ----- | ------- | -------- | --------------------------------------------- |
| Limit | integer | No       | Maximum number of accounts to return (1-200). |

#### Outputs

| Field       | Type    | Description                               |
| ----------- | ------- | ----------------------------------------- |
| Accounts    | array   | Array of Recurly account objects.         |
| Account IDs | array   | IDs of the returned accounts.             |
| Emails      | array   | Email addresses of the returned accounts. |
| Count       | integer | Number of accounts returned.              |

### List Invoices

List invoices in your Recurly site.

#### Inputs

| Field | Type    | Required | Description                                   |
| ----- | ------- | -------- | --------------------------------------------- |
| Limit | integer | No       | Maximum number of invoices to return (1-200). |

#### Outputs

| Field       | Type    | Description                       |
| ----------- | ------- | --------------------------------- |
| Invoices    | array   | Array of Recurly invoice objects. |
| Invoice IDs | array   | IDs of the returned invoices.     |
| States      | array   | States of the returned invoices.  |
| Count       | integer | Number of invoices returned.      |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/recurly.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
