• France
status page
Demo shops
assistance
FAQContact support
Search
Categories
Tags
Europe (English)
France
Spain
Europe (English)
India
Homepage
Use cases
Create a payment
Create an installment payment
Create a multi-card (split) payment
Create a payment by Alias (Token)
Create a payment link
Create a recurring payment
Manage subscriptions
Manage your transactions (refund, cancel...)
Analyze your reports
API docs
Embedded Form
REST API
Hosted payment
Mobile payment
File exchange
SDD mandates by REST API
Snippets
Payment methods
Plugins
Marketplace
Guides
Merchant Back Office
Back Office Expert
Functional guides

Examples of recurrence rules

  • For defining payment due dates that occur on the last day of each month for 12 months, the rule is:
{ "rrule" : "RRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1;COUNT=12" }

This rule means that if the current month does not contain a 31, then the engine will take into account the 30. If the 30 does not exist, then it will take into account the 29 and so on until the 28.

Another version of this rule:

{ "rrule" : "RRULE:FREQ=MONTHLY;COUNT=5;BYMONTHDAY=-1" }
  • For defining payment due dates that occur on the 10th of each month for 12 months, the recurrence rule is:
{ "rrule" : "RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10" }
  • To schedule installment payments to occur every three months ending December 31st, 2022:
{ "rrule" : "RRULE:FREQ=YEARLY;BYMONTHDAY=-1;BYMONTH=1,4,7,10;UNTIL=20221231" }

The deadlines will occur every 1st of January, April, July and October. Their total number depends on the effective date of the subscription (see parameter vads_sub_effect_date).

  • In order to define a weekly recurring payment to be made every Monday:
{ "rrule" : "RRULE:FREQ=WEEKLY;BYDAY=MO" }

The installments will be made every Monday.Attention, the first due date will be on the following Monday.

  • In order to define a weekly recurring payment:
{ "rrule" : "RRULE:FREQ=WEEKLY" }

The installments will occur on the same day if the due date is set to “today”, then every 7 days.

  • In order to define a recurring payment every two weeks on Monday, with maximum 4 installments:
{ "rrule" : "RRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=4;BYDAY=MO" }
  • In order to define a recurring payment every two weeks, on the same day and every 7 days:
{ "rrule" : "RRULE:FREQ=WEEKLY;INTERVAL=2;" }
Jobs
Legal
GDPR
25.20-1.11