Skip to main content

Recurring Payment Configuration (Subscription based)

Subscriptions enable the automated execution of recurring payments based on a configurable schedule. You can specify interval settings and define retry logic to handle failed payment attempts.

Configuring the Recurring Payment Interval​

To create a subscription, specify the time interval (e.g., month), how often it recurs (the frequency), and when it should begin. This provides full flexibility in setting up recurring billing.

Here’s how to set it:

  • Interval – choose from Day, Week, Month, or Year
  • Frequency – how many of the selected interval to wait between charges (default is 1)
  • StartDate – when the subscription should begin (defaults to today’s date)

Illustrative Recurrence Scenarios​

If the subscription is created with:

  • Interval : Month
  • Frequency : 1
  • StartDate : 2025-01-01 (assuming today is 2024-01-01)

The first 3 scheduled payments will be:

  • 2025-01-01
  • 2025-02-01
  • 2025-03-01

If the subscription is configured with:

  • Interval : Week
  • Frequency : 4
  • StartDate : 2025-01-01 (assuming today is 2024-01-01)

The first 3 payments will occur on:

  • 2025-01-01
  • 2025-01-28
  • 2025-02-25

If the configuration is:

  • Interval : Day
  • Frequency : 2
  • StartDate : not specified (defaults to 2024-01-01)

The initial 3 payments will be:

  • 2024-01-01
  • 2024-01-03
  • 2024-01-05

Subscription Termination Criteria​

You can let a subscription continue indefinitely, or define end conditions such as:

  • A total amount – the subscription stops once this total is reached
  • Count – the number of successful transactions before ending
  • Date – the last date on which a payment should be processed

Configuring Retry Logic for Failed Transactions​

You can also define retry behavior for failed payment attempts. When setting up retries, you specify:

  • the retry interval (e.g., Hour or Day)
  • how often to retry (frequency)
  • how many retry attempts (maximum)

Sample Retry Configurations​

For a retry rule of:

  • interval : day
  • frequency : 2
  • maximum : 1

The failed transaction will be attempted again:

  • 2 days after the failure

For a retry rule of:

  • interval : hour
  • frequency : 4
  • maximum : 3

The failed transaction will be retried:

  • after 4 hours
  • after 8 hours
  • after 12 hours

Webhooks​

If webhook settings are defined, every transaction attempt—successful or not—will trigger a webhook event notification.