SAP Open Connectors

Recurly Authenticate a Connector Instance

You can authenticate with Recurly to create your own instance of the Recurly connector through the UI or through APIs. Once authenticated, you can use the connector instance to access the different functionality offered by the Recurly platform.

Authenticate Through the UI

Use the UI to authenticate with Recurly and create a connector instance as described in Authenticate a Connector Instance (UI). You will need the subdomain and Recurly API key values that you identified in Recurly API Provider Setup.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a common resource, or use it in a formula template.

Authenticate Through API

Send a request to our /instances endpoint to authenticate a connector instance. When finished note the token and id.

To authenticate a connector instance:

  1. Construct a JSON body as shown below (see Parameters):

      "element": {
        "key": "recurly"
      "configuration": {
        "subdomain": "<INSERT_SUBDOMAIN>",
        "ApiVersion": "<INSERT_APIVERSION>",
        "recurly.api.key": "<INSERT_RECURLY_API_KEY>"
      "tags": [
      "name": "<INSTANCE_NAME>"
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.
  3. Locate the token and id in the response and save them for all future requests using the connector instance.

Example cURL

curl -X POST \ \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "recurly"
  "configuration": {
    "subdomain": "<INSERT_SUBDOMAIN>",
    "ApiVersion": "<INSERT_APIVERSION>",
    "recurly.api.key": "<INSERT_RECURLY_API_KEY>"
  "tags": [
  "name": "<INSTANCE_NAME>"


API parameters not shown in SAP Open Connectors are in code formatting.

Note: Event-related parameters are described in Recurly Events.
ParameterDescriptionData Type
keyThe connector key.
The name of the connector instance created during authentication.string
Your account's Recurly subdomain, which you noted in Recurly API Provider Setup.
Recurly API Key
The private API key generated and noted during Recurly API Provider Setup.string
API Version
The version of the Recurly API you want to set. The default value is 2.5; use that value unless you have a specific use case to do so.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response for an Authenticated Connector Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

  "id": 12345,
  "name": "My Cool Instance",
  "createdDate": "2019-10-17T22:31:01Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",
  "elementId": 3128,
  "tags": [
    "My Cool Instance"
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {},
  "authenticationType": "custom",
  "eventsEnabled": false,
  "cachingEnabled": false,
  "externalAuthentication": "none",
  "traceLoggingEnabled": false,
  "organizationId": 12345,
  "accountId": 123456,
  "userId": 123456,
  "element": {
    "id": 3128,
    "name": "Recurly",
    "key": "recurly",
    "description": "Add a Recurly Instance to connect your existing Recurly account to the Billing Hub, allowing you to manage customers, invoices, and transactions across multiple Elements. You will need your Recurly account to add an instance.",
    "image": "",
    "logo": "recurly",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": [],
    "objects": [],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": true,
    "extendable": false,
    "beta": false,
    "authentication": {
      "type": "custom"
    "extended": false,
    "useModelsForMetadata": true,
    "hub": "billing",
    "protocolType": "http",
    "parameters": [],
    "private": false
  "user": {
    "id": 184978