younifyd
Menu

List External Subscriptions

List the external subscriptions on a site

GET/external_subscriptions

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List External Subscriptions action (under external_subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{listExternalSubscriptions.response.data}}.

Request

Query parameters

sortstring

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

One ofcreated_atupdated_atDefault "created_at"

Response

Returns 200 with an object. Read it in later steps with {{listExternalSubscriptions.response.data.<field>}}.

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>
idstring

System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.

objectstring
accountobject10 fields
external_product_referenceobject6 fields

External Product Reference details

external_payment_phasesarray<object>14 fields

The phases of the external subscription payment lifecycle.

external_idstring

The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.

uuidstring

Universally Unique Identifier created automatically.

last_purchasedstring (date-time)

When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.

auto_renewboolean

An indication of whether or not the external subscription will auto-renew at the expiration date.

Default false

in_grace_periodboolean

An indication of whether or not the external subscription is in a grace period.

Default false

app_identifierstring

Identifier of the app that generated the external subscription.

quantityinteger

An indication of the quantity of a subscribed item's quantity.

Default 1

statestring

External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.

Default "active"

activated_atstring (date-time)

When the external subscription was activated in the external platform.

canceled_atstring (date-time)

When the external subscription was canceled in the external platform.

expires_atstring (date-time)

When the external subscription expires in the external platform.

trial_started_atstring (date-time)

When the external subscription trial period started in the external platform.

trial_ends_atstring (date-time)

When the external subscription trial period ends in the external platform.

testboolean

An indication of whether or not the external subscription was purchased in a sandbox environment.

Default false

importedboolean

An indication of whether or not the external subscription was created by a historical data import.

Default false

created_atstring (date-time)

When the external subscription was created in Recurly.

updated_atstring (date-time)

When the external subscription was updated in Recurly.

json
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "id": "string",
      "object": "string",
      "account": {
        "id": "string",
        "object": "string",
        "code": "string",
        "email": "name@example.com",
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "parent_account_id": "string",
        "bill_to": "string",
        "dunning_campaign_id": "string"
      },
      "external_product_reference": {
        "id": "string",
        "object": "string",
        "reference_code": "string",
        "external_connection_type": "string",
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-01-01T00:00:00Z"
      },
      "external_payment_phases": [
        {
          "id": "string",
          "object": "string",
          "started_at": "2025-01-01T00:00:00Z",
          "ends_at": "2025-01-01T00:00:00Z",
          "starting_billing_period_index": 0,
          "ending_billing_period_index": 0,
          "offer_type": "string",
          "offer_name": "string",
          "period_count": 0,
          "period_length": "string",
          "amount": "string",
          "currency": "string"
        }
      ],
      "external_id": "string",
      "uuid": "string",
      "last_purchased": "2025-01-01T00:00:00Z",
      "auto_renew": false,
      "in_grace_period": false,
      "app_identifier": "string",
      "quantity": 1
    }
  ]
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.