v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

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.

put/dunning_actions_settings/{dunning_actions_settings_type}

Path parameters

dunning_actions_settings_typestring required

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

Request body

authorizedFirstboolean 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.

paymentAttemptsinteger[] 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.

paymentMethodIdinteger required

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

gracePeriodinteger 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

200

successboolean

messagestring

Example response

{
  "success": true,
  "dunningActionsSetting": {
    "paymentMethodId": 123456789,
    "dunningActionsSettingType": "monthly",
    "authorizedFirst": true,
    "gracePeriod": 360
  },
  "message": "Dunning Actions settings created successfully"
}