younifyd
Menu

List External Subscription External Payment Phases

List the external payment phases on an external subscription

GET/external_subscriptions/{external_subscription_id}/external_payment_phases

Use it in a workflow

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

Request

Path parameters

external_subscription_idstringrequired

External subscription id

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"

limitinteger

Limit number of records 1-200.

Default 20

orderstring

Sort order.

One ofascdescDefault "desc"

Response

Returns 200 with an object. Read it in later steps with {{listExternalSubscriptionExternalPaymentPhases.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 payment phase ID, e.g. `e28zov4fw0v2`.

objectstring
started_atstring (date-time)
ends_atstring (date-time)
starting_billing_period_indexinteger
ending_billing_period_indexinteger
offer_typestring

Type of discount offer given, e.g. "FREE_TRIAL"

offer_namestring

Name of the discount offer given, e.g. "introductory"

period_countinteger

Number of billing periods

period_lengthstring

Billing cycle length

amountstring (decimal)

Allows up to 9 decimal places

currencystring

3-letter ISO 4217 currency code.

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",
      "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"
    }
  ]
}

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