support
Retour à la documentation
Rechercher
Catégories
Tags
Paramètres principauxtout montrer
subscriptionId
rrule
amount
currency
effectDate
initialAmount
initialAmountNumber
Testez moi
Documentation

Réponse SubscriptionCreated

l'objet SubscriptionCreated est la réponse du web service Charge/CreateSubscription.

Référence de la réponse

subscriptionId

Identifiant de l'abonnement.

Format

rrule

Description de la règle de l'abonnement sous forme de rrule (RFC-5545).

Pour plus d'informations sur comment générer une RRULE:

  • Specification d'une RRULE
  • Générateur de RRULE
  • Exemples de règles de récurrence

Pour des raisons techniques, il est impossible 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.

Format

amount

Montant des échéances de l’abonnement, hormis celles éventuellement définies par initilAmount.

La valeur doit être exprimée dans la plus petite unité de la devise.

Format

currency

Devise utilisée pour le paiement des échéances d'un abonnement. Code alphabétique en majuscule selon la norme ISO 4217 alpha-3.

Exemple: "EUR" pour l'euro.

Valeurs possibles

Les valeurs possibles sont les suivantes:

Devise CODIFICATION ISO 4217 Unité fractionnaire
Dollar australien (036) AUD
Riel Cambodgien (116) KHR 0
Dollar canadien (124) CAD 2
Renminbi yuan chinois (156) CNY 1
Couronne tchèque (203) CZK 2
Couronne danoise (208) DKK 2
Dollar de Hong Kong (344) HKD 2
Forint hongrois (348) HUF 2
Roupie Indienne (356) INR 2
Roupie indonésienne (360) IDR 2
Yen (392) JPY 0
Won Sud Coréen (410) KRW 0
Ringgit malais (458) MYR 2
Peso mexicain (484) MXN 2
Dollar néo-zélandais (554) NZD 2
Couronne norvégienne (578) NOK 2
Peso philippin (608) PHP 2
Rouble russe (643) RUB 2
Dollar de Singapour (702) SGD 2
Rand sud-africain (710) ZAR 2
Couronne suédoise (752) SEK 2
Franc suisse (756) CHF 2
Baht thailandais (764) THB 2
Livre Sterling (826) GBP 2
Dollar des États-Unis (840) USD 2
Nouveau dollar de Taïwan (901) TWD 2
Lire turque (949) TRY 2
Franc CFP (953) XPF 0
Euro (978) EUR 2
Zloty polonais (985) PLN 2
Real du Brésil (986) BRL 2

Format

effectDate

Date de début de l’abonnement au format ISO 8601.

Il est recommandé de transmettre une valeur dans le fuseau UTC. L'heure doit être fixée à "00:00:00".

Exemple : 2025-01-14T00:00:00+00:00

La valeur de effectDate ne doit pas être dans le passé.

Ce paramètre ne coïncide pas systématiquement avec la date de la première échéance, qui dépend uniquement du paramètre rrule.

Format

initialAmount

Montant des premières échéances. Sa valeur doit être un entier positif (ex: 1234 pour 12.34 EUR).

Format

initialAmountNumber

Nombre d'échéances auxquelles appliquer le montant défini dans initalAmount.

Format