subscriptionRequest

The subscriptionRequest object allows to transmit subscription details.

It has the following attributes:

Attribute Required Format
effectDate

Effective date in the W3C format.

Example: 2016-07-16T19:20:00Z

The date cannot be in the past.

dateTime ans..40
amount

Subscription amount in the smallest currency unit.

n..12
currency

Currency code (ISO 4217 standard code E.g.: 978 for euro (EUR)).

n3
initialAmount

Amount of the first installments (in the smallest currency unit) if different from the amount attribute.

n..12
initialAmountNumber

Installment number applied to initialAmount.

This attribute becomes mandatory if the attribute value of initialAmount is set.

int
rrule

Description of the subscription rule.

The expected value for this parameter is a chain of characters that respect the iCalendar (Internet Calendar) specification, described in RFC5545 (see http://tools.ietf.org/html/rfc5545).

For technical reasons, it is not possible to define subscription periods that are shorter than one day.

The keywords "SECONDLY" / "MINUTELY" / "HOURLY" are not taken into account.

Examples:
  • To program installment payments taking place on the last day of each month for 12 months, the rule is:

    RRULE:FREQ=MONTHLY;BYMONTHDAY=28,29,30,31;BYSETPOS=-1;COUNT=12

    This rule means that if the current month does not have 31 days, the machine will take the 30th into account. If the 30th does not exist, the machine will take the 29th into account, and so on until the 28th.

    Another version of this rule: RRULE:FREQ=MONTHLY;COUNT=5;BYMONTHDAY=-1

  • To program installment payments on the 10th of each month for 12 months, the rule is: RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10

  • To program installment payments every three months up to December 31st, 2016. RRULE:FREQ=YEARLY;BYMONTHDAY=-1;BYMONTH=1,4,7,10;UNTIL=20161231

    The installment payments will be due on the first day of January, April, July and October each year. The total number of installments depends on the subscription start date (see vads_sub_effect_date parameter).

    For more information and examples, visit http://recurrance.sourceforge.net/.

string
subscriptionId

Subscription reference

  string
description

Description of the subscription.

  string