Dunning actions

Dunning is the process of retrying payment attempts and sending payment reminders to customers when a payment gets rejected. With Cleeng you can configure payment retries at intervals to ensure payment will be recovered and subscription can continue its cycles. Cleeng allows to setup retries and notifications in terms of subscription due to date, they can be set before and after up to what is your retries strategy. Cleeng as default gives you a smart retries setup that can guarantee an efficient recovery process.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Important

Dunning action settings are configured automatically by Cleeng when creating a new payment method.

If you use Cleeng Merchant, Dunning actions settings configured by Cleeng should remain default values, except otherwise agreed with your account manager.

If you operate for the web the Merchant of Record (hence, when you do NOT use Merchant), dunning actions settings are allowed to be adjusted.

🆕 You can check the setup of your dunning actions easily by visiting the Cleeng Dashboard -> Admin ->Dunning Actions. See this article for more details.

Setup introduction

You can setup dunning actions based on the offer types your service provides. For each offer type configure payment attempts so as to receive events in provided timeframes. Your endpoint should listen to the subscriptionReadyForPaymentCapture or/and subscriptionReadyForPaymentAuthorisation event. To make sure it will be sent to a proper endpoint, please register in the Cleeng Webhooks Service.

Grace period

Grace period allows you to keep the subscription active after the subscription expiration date has been reached (even if a payment issue has ocurred). It gives an additional time to process payments or restore a cancelled subscription before it terminates.

❗️

Production change while the publisher has active subscribers!

When updating the dunning action settings in the production environment while the publisher has active subscribers, it's advised to turn off the new emails temporarily. Otherwise, the new dunning action settings updated on the production environment will trigger the system to send renewal emails to all subscribers including new and existing active subscribers.

Path Params
string
required

Indicates in what subscription cycle, dunning actions will be applied. Possible values: weekly, monthly, 3-months, 6-months, annual, seasonal.

Body Params
boolean
required

Indicates if payment authorization should be done first. If a true, Cleeng will send subscriptionReadyForPaymentAuthorisation event at defined attempts time and at due to date of subscription, subscriptionReadyForPaymentCapture event. If a false, Cleeng will send subscriptionReadyForPaymentCapture at defined attempts time.

paymentAttempts
array of int32s
required

Set of hours in terms of due to date of subscription when payment attempt should be triggered. For recommended values, see Default Dunning Settings.

paymentAttempts*
int32
required

The identifier of Cleeng Payment Method Settings. Provided by Cleeng Team.

int32
required

Hours after subscription due to date till subscription will be active. Once the specified hour is reached out, Cleeng will send subscriptionReadyForTermination event. For recommended values, see Default Dunning Settings.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json