List External Invoices

List the external invoices on a site

GET/external_invoices

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the List External Invoices action (under external_invoices).
Fill in the fields below, then reference the result from later steps as {{listExternalInvoices.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"

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 {{listExternalInvoices.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 invoice ID, e.g. `e28zov4fw0v2`.

objectstring

accountobject10 fields

external_subscriptionobject22 fields

Subscription from an external resource such as Apple App Store or Google Play Store.

external_idstring

An identifier which associates the external invoice to a corresponding object in an external platform.

statestring

One ofpaid

totalstring (decimal)

currencystring

3-letter ISO 4217 currency code.

line_itemsarray<object>10 fields

purchased_atstring (date-time)

When the invoice was created in the external platform.

created_atstring (date-time)

When the external invoice was created in Recurly.

updated_atstring (date-time)

When the external invoice 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_subscription": {
        "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
      },
      "external_id": "string",
      "state": "paid",
      "total": "string",
      "currency": "string",
      "line_items": [
        {
          "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"
          },
          "currency": "string",
          "unit_amount": "string",
          "quantity": 0,
          "description": "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"
          },
          "created_at": "2025-01-01T00:00:00Z",
          "updated_at": "2025-01-01T00:00:00Z"
        }
      ],
      "purchased_at": "2025-01-01T00:00:00Z",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

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

Was this page helpful?