Réponse Subscription
Objet contenant les informations relatives à un abonnement.
Référence de la réponse
subscriptionId
Identifiant de l'abonnement.
Format
shopId
Identifiant de la boutique.
Format
paymentMethodToken
Alias (ou token) associé à un moyen de paiement.
Format
orderId
Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.
Format
metadata
Valeurs personnalisées rattachées à la transaction, au format JSON.
Exemple d'appel
Par exemple, pour passer une valeur personnalisée, ajoutez à votre requête :
{
"metadata": {
"MyValueKey": "1234"
}
}Cette valeur sera retournée dans l'objet Transaction nouvellement créé.
Vous pouvez aussi utiliser les metadatas "orderInfo", "orderInfo2" et "orderInfo3" pour transmettre des informations additionnelles sur la commande.
Ces données seront ensuite visibles dans l'onglet **Extra** du détail de la transaction depuis votre
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é.
Format
cancelDate
Date de résiliation de l'abonnement.
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
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: "XPF" pour le franc CFP.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| Devise | CODIFICATION ISO 4217 | Unité fractionnaire |
|---|---|---|
| Franc CFP (953) | XPF |
Format
pastPaymentsNumber
Nombre de versements échus.
Format
totalPaymentsNumber
Nombre total de paiements.
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:
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
description
Description associée à l'abonnement.