subscriptionRequest

L'objet subscriptionRequest permet de transmettre des informations liées à l'abonnement.

Il possède les attributs suivants :

Tableau 1. Objet subscriptionRequest
subscriptionRequest
Attribut Requis Format
effectDate

Date d'effet au format W3C.

Exemple : 2016-07-16T19:20Z

La date ne peut pas être dans le passé.

dateTime ans..40
amount

Montant de l'abonnement dans sa plus petite unité monétaire.

n..12
currency

Code de la devise (Code monnaie ISO 4217 Ex : 978 pour l'euro (EUR) ).

n3
initialAmount

Montant des échéances de l’abonnement (dans sa plus petite unité monétaire) pour la ou les premières échéances si ces dernières sont différentes du montant de l'abonnement amount.

n..12
initialAmountNumber

Nombre d’échéances auxquelles il faut appliquer le montant initialAmount.

Cet attribut devient obligatoire si initialAmount est valorisé.

int
rrule

Description de la règle de l'abonnement.

La valeur attendue dans cet attribut est une chaîne de caractères suivant la spécification iCalendar, ou Internet Calendar, décrite dans la RFC5545 (voir http://tools.ietf.org/html/rfc5545).

Pour des raisons techniques, il n’est pas possible de définir des périodes d’abonnement inférieures à une journée.

Les mots clés "SECONDLY" / "MINUTELY" / "HOURLY" ne sont donc pas pris en compte.

Exemples :
  • Pour définir des échéances de paiement ayant lieu le dernier jour de chaque mois, pendant 12 mois, la règle s’écrit :

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

    Cette règle signifie que si le mois courant ne contient pas de 31, alors le moteur prendra en compte le 30. Si le 30 n’existe pas, alors il prendra en compte le 29 et ainsi de suite jusqu’au 28.

    Une autre version de cette règle : RRULE:FREQ=MONTHLY;COUNT=5;BYMONTHDAY=-1

  • Pour définir des échéances de paiement ayant lieu le 10 de chaque mois, pendant 12 mois, alors la règle d’abonnement s’écrit de la manière suivante : RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10

  • Pour définir des échéances de paiement ayant lieu chaque trimestre, jusqu’au 31/12/2016 : RRULE:FREQ=YEARLY;BYMONTHDAY=-1;BYMONTH=1,4,7,10;UNTIL=20161231

    Les échéances auront lieu chaque 1er de janvier, avril, juillet et octobre. Leur nombre total dépend de la date d’effet de l’abonnement (voir paramètre vads_sub_effect_date).

    Pour plus de détails et d'exemples vous pouvez consulter le site http://recurrance.sourceforge.net/.

string
subscriptionId

Identifiant de l'abonnement

  string
description

Description de l'abonnement.

  string