Integration Guide

Table Of Contents
Handling Recurring Payments
Recurring Payments Profile Status
11
122 May 2010 Express Checkout Integration Guide
Recurring Payments Profile Status
The recurring payments actions you may take, depend on the status of the profile.
A recurring payments profile can have one of the following status values:
z ActiveProfile
z PendingProfile
z ExpiredProfile
z SuspendedProfile
z CancelledProfile
If the profile is successfully created, it has an ActiveProfile status. However, if a non-
recurring initial payment fails and FAILEDINITAMTACTION is set to CancelOnFailure in
the CreateRecurringPaymentsProfile request, the profile is created with a status of
PendingProfile until the initial payment either completes successfully or fails.
A profile has a status of ExpiredProfile when both the total billing cycles for both the
optional trial period and the regular payment period have been completed.
You can suspend or cancel a profile by using the
ManageRecurringPaymentsProfileStatus API. You can also reactivate a suspended
profile. If the maximum number of failed payments has already been reached, however, you
will need to increase the number of failed payments before reactivating the profile.
NOTE: You can also suspend, cancel, or reactive a recurring payments profile through the
PayPal website.
For recurring payments profiles created with Express Checkout, the buyer receives an email
about the change in status of their recurring payment.
Getting Recurring Payments Profile Information
Use the GetRecurringPaymentsProfileDetails API to get information about a profile.
NOTE: You can also get information about recurring payments profiles from the PayPal
website.
Along with the information that you specified in the CreateRecurringPaymentsProfile
request, GetRecurringPaymentsProfileDetails also returns the following summary
information about the profile:
z Profile status
z Next scheduled billing date
z Number of billing cycles completed in the active subscription period
z Number of billing cycles remaining in the active subscription period
z Current outstanding balance