subscription
The subscription element has two uses.
subscription as a child of recurringRequest
The subscription element is a required child of the recurringRequest element and the parent of several child element that define information about the recurring transaction stream to be handled by the Recurring Engine.
Parent Elements:
Attributes:
None
Child Elements (required):
Child Elements (optional):
numberOfPayments, startDate, amount, createDiscount, createAddOn
If you include the numberOfPayments child element, the value submitted overrides the default value defined in the Plan.
Example: subscription Structure as a child of recurringRequest
<subscription>
<planCode>Plan Reference Code</planCode>
<numberOfPayments>1 to 99</numberOfRemianingPayments>
<startDate>Start Date of recurring Cycle</startDate>
<amount>Amount of Recurring Payment</amount>
<createDiscount>
<discountCode>Discount Reference Code</addOnCode>
<name>Name of Discount</name>
<amount>Amount of Discount</amount>
<startDate>Start Date of Discount</startDate>
<endDate>End Date of Discount</endDate>
</createDiscount>
<createAddOn>
<addOnCode>Add On Reference Code</addOnCode>
<name>Name of Add On</name>
<amount>Amount of Add On</amount>
<startDate>Start Date of Add On Charge</startDate>
<endDate>End Date of Add On Charge</endDate>
</createAddOn>
</subscription>
subscription as a child of lineItemData
The subscription element is an optional child of the lineItemData element and the parent of several child element that define information used by the Guaranteed Payments service.
Parent Elements:
Attributes:
None
Child Elements (all optional):
subscriptionId, nextDeliveryDate, periodUnit, numberOfPeriods, regularItemPrice, currentPeriod
Example: subscription Structure as a child of recurringRequest
<subscription>
<subscriptionId>Merchant assigned subscription Id</subscriptionId>
<nextDeliveryDate>Next delivery date</nextDeliveryDate>
<periodUnit>WEEK, MONTH, QUARTER, YEAR</periodUnit>
<numberOfPeriods>Number of Periods</numberOfPeriods>
<regularItemPrice>Regular price of item</regularItemPrice>
<currentPeriod>Current period in sequence</currentPeriod>
</subscription>