Cleeng-Managed Recurring Billing

👍

Check our Reference Materials for more details about a payment connector.

This tutorial describes how to implement a recurring billing process for subscriptions using the Cleeng Payment API and a payment gateway.

Cleeng-Managed Recurring Billing is the recurring billing flow where Cleeng manages when an authorisation/ capture/ termination is made.

It can be integrated in two ways:

  1. Split Authorise & Charge Integration
  2. Basic Direct Charge Integration

First, make sure the basic requirements below are in place:

Basic Requirements

To start with this process, make sure that the following are in place:

1. Webhooks - to learn more about how to configure and use Cleeng Webhooks, please click here. You can also find the list of available webhook topics here.

For recurring billing, you will need to subscribe to the following:
- subscriptionReadyForPaymentCapture (mandatory)
- subscriptionReadyForPaymentAuthorisation (recommended)

To find out more about subscribing to webhook events, refer to the Webhook - Subscription Topics section.

Please note that responses to webhooks need to return “200” response code. If they don’t respond with “200”, webhooks will be resent.

2. Dunning Action Settings - to find out more see here.
Dunning is the process of retrying payment attempts and sending payment reminders to customers when a payment gets rejected.

You can set up dunning actions based on the offer types your service provides. For each offer type and payment method Id configure payment attempts 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.

To decide if the recurring billing should be a one-step (only capture) or two-step process (authorisation and capture), you need to configure authorizedFirst parameter in Dunning Actions.

Select your integration

  • If you choose Split Authorise & Charge Integration, continue to the next step for detailed instructions.
  • If the other option is your preferred method, go straight to Basic Direct Charge Integration.

Did this page help you?