Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!


Home > Aria Crescendo Documentation > Configuration > Dunning > Manage Dunning Processes > Create a Dunning Process

Create a Dunning Process

This article applies to:Aria Crescendo


You can create a new dunning process to associate with a plan(s) or dunning group by following the steps below.

Creating a Dunning Process

Getting Here: Click Configuration > Payments > Dunning Processes

  1. Click New.

The Create New Dunning Process screen displays.

Full Create Dunning Process3v2.png

  1. In the Process Name field, enter a descriptive name for the dunning process.

The Client Defined Identifier field below automatically populates, based on the value entered in the Process Name field.

  1. If applicable, enter a different, unique identifier for this dunning process in the Client Defined Identifier field.
  2. In the Description field, enter an explanation of the dunning process.
  3. From the Payment Types list, select each payment method to which this dunning process should apply.

The dunning process will apply to customers who use the selected payment method(s) (i.e. the payment method(s) that display in the right column of the Payment Types section).

create new dunning processv2.png

Note: If you do not select a payment method, then this dunning process will apply to all customers who are subscribed to your specified plan(s), regardless of their payment method.

  1. In the Plan Selection section, filter your list of plans by entering or selecting options from the drop-downs for the Plan Name, Currency, or Status fields and click Filter. In the list of available plans (left column), click each plan for which this dunning process should apply.

Your chosen plan(s) will be displayed in the list of selected plans (right column). To remove a plan from the dunning process, click the plan in the list of selected plans.

create new dunning process 2v2.png

  1. In the Dunning Steps section, select an email template from the Template drop-down that Aria should use to email a customer in the corresponding dunning step.

You can choose one of Aria's default dunning templates, one of your own custom templates, or Do Not Send Emails.

Note: Do Not Send Emails supports your own handling of Dunning communications outside of Aria.

  1. In the Step Duration field, enter the number of days before the next step in the dunning process should begin.
  1. From the Email Contact drop-down, select one of the following customer email address(es) to which the dunning message should be sent.
  • Default
  • Account Only
  • Billing Only
  • Statement Only
  • Account + Billing
  • Account + Statement
  • Billing + Statement
  • Account + Billing + Statement
  1. If customers should be charged a fee when this step is performed, select one of the following fees from the Fee Type drop-down.
  • Flat Fee: The customer will be charged a specified flat amount when the next dunning step is performed.
  • Percentage Fee: The customer will be charged a specified percentage of the past due amount. Any fee charged in a dunning step will be added to the fee charged in additional dunning steps. For example, if a customer owes $100 and the fee is 10% at Step 1 and 20% at Step 2, then the customer will be charged as follows:

Step 1: 10% of $100 = $10. Total charges = $110

Step 2: 20% of $100 = $20. Total charges = $110 + $20 = $130

Note: Dunning fees are assessed based on the balance at the Stack level (the Master Plan Instance and all associated supplemental plan instances).

  1. If you chose to add a fee from the Fee Type drop-down, click the Add Currency hyperlink to enter the flat amount or percentage that customers should be charged when this step is performed.

A separate window opens in which you can enter the amount or percentage for each of your currencies.

add currencyv2.png

  1. Click Add Step to include additional steps in this dunning process, then enter the information as described in the preceding steps.

You can specify up to eight dunning steps in a dunning process, in addition to the final step. You can click the red "X" in the right column at any time to delete the corresponding step from the dunning process.

  1. From the Final Notification Template drop-down, select the email template (either an Aria default template, your own custom template, or Do Not Send Emails) to use when the final dunning step is reached.

Note: Do Not Send Emails supports your own handling of Dunning communications outside of Aria.

When the final dunning step is reached, the dunning process will be marked as "Complete" and the Master Plan Instance will be marked as "Suspended."

All other Master Plan Instances associated with the same dunning group will be treated as if they have also reached the final step. The dunning state for these Master Plan Instances will be changed to "Complete" and the status for all associated Master Plan Instances will be changed to "Suspended."

create new dunning process 3v2.png

  1. Click Save.

Aria will apply this dunning process to the applicable past due Master Plan Instances the next time the dunning batch job runs.

Last modified



This page has no classifications.