Recurly API Documentation

This is the complete API documentation for connecting to the Recurly API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Recurly: Subscription billing and recurring revenue platform for managing accounts, subscriptions, invoices, transactions, plans, and pricing. Keep reading to get started.

Quickstart

Before you run your first Recurly request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Recurly connection — create or choose one in Connections. Note its connectionId.

Every Recurly action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/recurly/actions/{actionSlug}/run

You need a MindCloud API Key and a Recurly connection. Then call an action such as List Sites:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/recurly/actions/list-sites/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Recurly account. See Recurly API Authentication for the full flow and how to get your connection credentials.

Recurly actions

All 23 published actions for this Recurly version. Each page documents the endpoint, arguments, and response controls.

• PUTCancel Subscription
• POSTCreate Account
• POSTCreate Subscription
• DELETEDeactivate Account
• GETFetch Account
• GETFetch Account Balance
• GETFetch Invoice
• GETFetch Plan
• GETFetch Preview Renewal
• GETFetch Subscription
• GETFetch Transaction
• GETList Account Subscriptions
• GETList Accounts
• GETList Invoices
• GETList Plans
• GETList Sites
• GETList Subscriptions
• GETList Transactions
• PUTPause Subscription
• PUTReactivate Account
• PUTReactivate Subscription
• PUTUpdate Account
• PUTUpdate Subscription

Related apps

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareXeroThinkificWhopGumroadEcwid