younifyd
Menu

Get Dunning Campaign

Fetch a dunning campaign

GET/dunning_campaigns/{dunning_campaign_id}

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the Get Dunning Campaign action (under dunning_campaigns).
  3. Fill in the fields below, then reference the result from later steps as {{getDunningCampaign.response.data}}.

Request

Path parameters

dunning_campaign_idstringrequired

Dunning Campaign ID, e.g. `e28zov4fw0v2`.

Response

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

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>

Dunning Cycle settings.

typestring

The type of invoice this cycle applies to.

One ofautomaticmanualtrial

applies_to_manual_trialboolean

Whether the dunning settings will be applied to manual trials. Only applies to trial cycles.

first_communication_intervalinteger

The number of days after a transaction failure before the first dunning email is sent.

send_immediately_on_hard_declineboolean

Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.

intervalsarray<object>2 fields

Dunning intervals.

expire_subscriptionboolean

Whether the subscription(s) should be cancelled at the end of the dunning cycle.

fail_invoiceboolean

Whether the invoice should be failed at the end of the dunning cycle.

total_dunning_daysinteger

The number of days between the first dunning email being sent and the end of the dunning cycle.

total_recycling_daysinteger

The number of days between a transaction failure and the end of the dunning cycle.

versioninteger

Current campaign version.

created_atstring (date-time)

When the current settings were created in Recurly.

updated_atstring (date-time)

When the current settings were updated in Recurly.

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
{
  "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": 0,
          "email_template": "string"
        }
      ],
      "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.