Advanced Features Guide

Express Checkout Advanced Features Guide April 2012 45
Handling Recurring Payments
Options for Creating a Recurring Payments Profile
3
Options for Creating a Recurring Payments Profile
You can create a recurring payments profile that allows a regular payment period, an optional
trial period, an initial payment, and other options.
Specifying the Regular Payment Period
Each recurring payments profile has a regular payment period that defines the amount and
frequency of the payment. The following table lists the required fields for specifying the
regular payment period.
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 you either do not specify a value or
specify the value 0, the payments continue until PayPal (or the buyer) cancels or suspends the
profile. If the value is greater than 0, the regular payment period continues for the specified
number of billing cycles.
You can also specify an optional shipping amount or tax amount for the regular payment
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 the following:
 Day
 Week
 SemiMonth
 Month
 Year
BILLINGFREQUENCY ScheduleDetails.
PaymentPeriod.BillingFreque
ncy
The number of billing periods that make
up one billing cycle. 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.