Dunning Action Settings

Dunning actions settings specify when Cleeng should emit the events mentioned in the Webhooks section. They must be set up for all your payment method Ids and all subscription cycle durations (weekly, monthly, 3-months, 6-months, annual).

Please note that apart from subscriptions (recurring payments), you should also set up dunning action settings for passes.

You can set them up by calling this endpoint.

Example:
Let’s imagine you have 2 payment methods 123 and 456. You offer your subscribers 2 types of subscriptionsmonthly and annual. In this case, you would have to create settings for the following method-cycle combinations:

  • payment method 123 and cycle monthly
  • payment method 123 and cycle annual
  • payment method 456 and cycle monthly
  • payment method 456 and cycle annual

📘

This minimal configuration will suffice, but we strongly suggest creating dunning action settings for all the supported cycle durations, as it is easy to forget to create this setting when a subscription with a previously unsupported cycle is added.

❗️

Important for PayPal

Dunning actions settings for PayPal payment method require the authorizedFirst property to be set to true.

Recommended Dunning Settings

If you are not going for custom dunning action settings, please use our recommended dunning action settings for the respective billing cycles.

Dunning Action Period

Authorized First

Payment Attempts (Hrs)

GracePeriod (Hrs)

Weekly

1

[72, 48, 24, 0]

2

Monthly

1

[72, 48, 24, 0]

2

3 Months

1

[72, 48, 24, 0]

2

6 Months

1

[72, 48, 24, 0]

2

Annual

1

[72, 48, 24, 0]

2

Please note that Payment Attempts values should be negative (below zero) if you want dunning actions to take place at certain intervals during the grace period.


Did this page help you?