This is a staging build of the docs
We've reorganized our products to make building with Codat easier than ever
Skip to main content

Use the Recurly integration

When an SMB user has linked their Recurly account, access their subscriptions and billing data by making proxy requests to the Recurly API

The Recurly integration doesn't yet expose standardized data types or provide any data visualization or metrics (for example, in Lending).

Instead, when an SMB customer (a company) has linked their Recurly account, you can access their subscriptions and billing data through the proxy endpoint in the Codat API. Only GET requests are currently supported.

By default, Codat disables users from making proxy requests. To enable proxy for Recurly, contact your account manager or support.

Send a proxy request

To proxy to the Recurly API, send a GET request to the proxy endpoint:

GET /companies/{companyId}/connections/{connectionId}/data/proxy?endpoint=RECURLY_ENDPOINT

Replace RECURLY_ENDPOINT with the desired Recurly API object, which must be URL encoded.

For example, to query a company's list of accounts in Recurly, send the following request:

GET /companies/{companyId}/connections/{connectionId}/data/proxy?endpoint=/accounts

To view a list of all available endpoints, see the Recurly Developer Hub.


Was this page useful?
❤️
👍
🤔
👎
😭