Integration Guide

Table Of Contents
Handling Recurring Payments
Options for Creating a Recurring Payments Profile
10
96 October 2009 Express Checkout Integration Guide
Required fields for specifying a regular payment period
You can optionally include a value for TOTALBILLINGCYCLES (SOAP field
ScheduleDetails.PaymentPeriod.TotalBillingCycles), which specifies the total
number of billing cycles in the regular payment period. If no value is specified or if the value
is 0, the payments continue until the profile is canceled or suspended. If the value is greater
than 0, the regular payment period will continue for the specified number of billing cycles.
You can also specify an optional shipping amount or tax amount for the regular payment
period.
Including an Optional Trial Period
You can optionally include a trial period in the profile by specifying the following fields in the
CreateRecurringPaymentsProfile request. The following table lists the required fields
for creating an optional trial period.
NVP SOAP Description
PROFILESTARTDATE RecurringPaymentsProfileDet
ails. BillingStartDate
The date when billing for this profile
begins.
NOTE: The profile may take up to 24
hours for activation.
BILLINGPERIOD ScheduleDetails.
PaymentPeriod.
BillingPeriod
The unit of measure for the billing cycle.
Must be one of:
z Day
z Week
z SemiMonth
z Month
z Year
BILLINGFREQUENCY ScheduleDetails.
PaymentPeriod.
BillingFrequency
Number of billing periods that make up
one billing cycle.
NOTE: The combination of billing
frequency and billing period must
be less than or equal to one year.
NOTE: If the billing period is
SemiMonth., the billing
frequency must be 1.
AMT ScheduleDetails.
PaymentPeriod. Amount
Amount to bill for each billing cycle.