List Dunning Campaigns

List the dunning campaigns for a site

GET/dunning_campaigns

Use it in a workflow

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

objectstring

codestring

Campaign code.

namestring

Campaign name.

descriptionstring

Campaign description.

default_campaignboolean

Whether or not this is the default campaign for accounts or plans without an assigned dunning campaign.

dunning_cyclesarray<object>12 fields

Dunning Cycle settings.

created_atstring (date-time)

When the current campaign was created in Recurly.

updated_atstring (date-time)

When the current campaign was updated in Recurly.

deleted_atstring (date-time)

When the current campaign was deleted in Recurly.

json

{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "id": "string",
      "object": "string",
      "code": "string",
      "name": "string",
      "description": "string",
      "default_campaign": false,
      "dunning_cycles": [
        {
          "type": "automatic",
          "applies_to_manual_trial": false,
          "first_communication_interval": 0,
          "send_immediately_on_hard_decline": false,
          "intervals": [
            {
              "days": null,
              "email_template": null
            }
          ],
          "expire_subscription": false,
          "fail_invoice": false,
          "total_dunning_days": 0,
          "total_recycling_days": 0,
          "version": 0,
          "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",
      "deleted_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?