numberOfPayments
The numberOfPayments element has multiple uses depending upon if it associated with recurring payments or enchancedData.
numberOfPayments as a child of subscription or createPlan
In this use, the numberOfPayments element is defines the number of payments in a recurring billing plan including the initial payment. The planCode element defines the timing of subsequent charges. This element is an optional child of both the subscription, and createPlan elements. When submitted as a child of the subscription element, the value overrides the default value defined in the Plan.
For an open-ended Plan, please omit the optional numberOfPayments element in createPlan.
For an open-ended subscription, please omit the optional numberOfPayments element in subscription and reference an open-ended Plan.
Type = Integer; minLength = 1; maxLength = 99
Parent Elements:
Attributes:
None
Child Elements:
None
numberOfPayments as a child of enhancedData
In this use, an optional child of the enhancedData element, the numberOfPayments element is defines the number of partial payments.
Type = String (Enum); minLength = N/A; maxLength = N/A
Enumerations:
| Enum Value | Description |
|---|---|
| 1 or space (" ") | Paid in full (i.e., single payment) |
| 2 through 9 | Number of additional payments |
| + (i.e., plus sign) | The number of payments is greater than 9 |
Parent Elements:
Attributes:
None
Child Elements:
None