subscriptionResponse

The subscriptionResponse object contains all the subscription details.

Table 1. The subscriptionResponse object
subscriptionResponse Format
subscriptionId

Subscription reference

string
effectDate

Effective date in the W3C format.

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

The date cannot be in the past.

dateTime

ans..40

cancelDate

Cancellation date of an installment payment.

dateTime

ans..40

initialAmount

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

 
rrule

Description of the subscription rule.

Example:

  • RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=10

    Installment payments set for the 10th day of every month for 12 months.

string
description

Description of the subscription.

string
initialAmountNumber

Installment number of the initial subscription amount.

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

int
pastPaymentsNumber

Number of previous installments.

int
totalPaymentsNumber

Total number of installments.

int
amount

Subscription amount in the smallest currency unit.

n..12
currency

Currency code (ISO 4217 standard code E.g.: 978 for euro (EUR)953 for CFP Franc (XPF)756 for Swiss Franc (CHF)986 for Brazilian Real (BRL)840 for US Dollar (USD)952 for CFA Franc (XOF) or 324 for Guinea Franc (GNF)356 forINR).

n3