younifyd
Menu

Get External Subscription External Payment Phase

Fetch an external payment phase

GET/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}

Use it in a workflow

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

Request

Path parameters

external_subscription_idstringrequired

External subscription id

external_payment_phase_idstringrequired

External payment phase ID, e.g. `a34ypb2ef9w1`.

Response

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

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
{
  "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.