Integration Guide

Express Checkout Integration Guide May 2010 115
Handling Recurring Payments
Options for Creating a Recurring Payments Profile
11
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
Payment amount The amount to be paid by the buyer for each billing cycle.
Outstanding balance If a payment fails for any reason, that amount is added to the profile’s
outstanding balance.
Profile ID An alphanumeric string (generated by PayPal) that uniquely identifies a
recurring profile.
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.BillingFreque
ncy
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.
Term Definition