Answer Subscription
Object containing recurring payment details.
Response reference
subscriptionId
Recurring payment identifier.
Format
shopId
Shop ID.
Format
paymentMethodToken
Token associated with a payment method.
Format
orderId
Order reference defined by the Merchant.Does not support UTF-8 characters.
Format
metadata
Custom values linked to the transaction, in JSON format.
Example of a call
For example, to pass a custom value, add the following to your query:
{
"metadata": {
"MyValueKey": "1234"
}
}This value will be returned in the newly created transaction object.
You can also use the metadata “ orderInfo1 ”, “ orderInfo2 ” and “ orderInfo3 ” to send complementary information about the order.
This data can be found later in the Extra tab of the transaction details via your
Format
effectDate
Recurring payment start date in ISO 8601 format defined by W3C.
Format
cancelDate
Recurring payment termination date.
Format
initialAmount
Amount of the first installments. Its value must be a positive integer (e.g.: 1234 for 12.34 EUR).
Format
initialAmountNumber
Number of installments for applying the amount specified in initalAmount.
Format
amount
Amount of subscription installments, excluding those possibly defined by initialAmount.
The value must be expressed in the smallest unit of the currency.
Format
currency
Currency used for the payment of subscription installments. Alphabetical code in upper case according to the ISO 4217 alpha-3 standard.
Eg: "EUR" for the euro.
Possible values
. The possible values are:
| Currency | ISO 4217 ENCODING | Fractional unit |
|---|---|---|
| Dollar australien (036) | AUD | |
| Cambodian riel (116) | KHR | 0 |
| Canadian dollar (124) | CAD | 2 |
| Chinese renminbi (156) | CNY | 1 |
| Czech koruna (203) | CZK | 2 |
| Danish crown (208) | DKK | 2 |
| Hong Kong dollar (344) | HKD | 2 |
| Hungarian forint (348) | HUF | 2 |
| Indian rupee (356) | INR | 2 |
| Indonesian rupiah (360) | IDR | 2 |
| Japanese yen (392) | JPY | 0 |
| South Korean won (410) | KRW | 0 |
| Malaysian ringgit (458) | MYR | 2 |
| Mexican peso (484) | MXN | 2 |
| New Zealand dollar (554) | NZD | 2 |
| Norwegian crown (578) | NOK | 2 |
| Philippine peso (608) | PHP | 2 |
| Russian ruble (643) | RUB | 2 |
| Singapore dollar (702) | SGD | 2 |
| South African rand (710) | ZAR | 2 |
| Swedish krona (752) | SEK | 2 |
| Swiss franc (756) | CHF | 2 |
| Thai baht (764) | THB | 2 |
| Pound Sterling (826) | GBP | 2 |
| US dollar (840) | USD | 2 |
| New Taiwan dollar (901) | TWD | 2 |
| Turkish lira (949) | TRY | 2 |
| CFP Franc (953) | XPF | 0 |
| Euro (978) | EUR | 2 |
| Polish zloty (985) | PLN | 2 |
| Brazilian real (986) | BRL | 2 |
Format
pastPaymentsNumber
Number of past installments.
Format
totalPaymentsNumber
Total number of installments.
Format
rrule
Description of the recurring payment rule in the form of a rrule (RFC-5545).
For more information on how to generate a 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 associated with the subscription.