2009

Name-Value Pair API Developer Guide 08 April 2009 107
Recurring Payments and Reference Transactions API Operations
GetRecurringPaymentsProfileDetails API
GetRecurringPaymentsProfileDetails Response Fields
Recurring Payments Profile Details Fields
Field Description
PROFILEID Recurring payments profile ID returned in the
CreateRecurringPaymentsProfile response.
STATUS Status of the recurring payment profile.
z ActiveProfile
z PendingProfile
z CancelledProfile
z SuspendedProfile
z ExpiredProfile
DESC Description of the recurring payment.
Character length and limitations: 127 single-byte alphanumeric characters.
AUTOBILLOUTAMT This field indicates whether you would like PayPal to automatically bill the
outstanding balance amount in the next billing cycle. The outstanding balance is the
total amount of any previously failed scheduled payments that have yet to be
successfully paid.
Valid values: NoAutoBill or AddToNextBilling.
MAXFAILEDPAYMENTS The number of scheduled payments that can fail before the profile is automatically
suspended.
Character length and limitations: Number string representing an integer.
AGGREGATEAMOUNT Total amount collected thus far for scheduled payments.
Character length and limitations: Must not exceed $10,000 USD in any currency. No
currency symbol. Must have two decimal places, decimal separator must be a period
(.), and the optional thousands separator must be a comma (,).
AGGREGATEOPTIONALAM
OUNT
Total amount collected thus far for optional payments.
Character length and limitations: Must not exceed $10,000 USD in any currency. No
currency symbol. Must have two decimal places, decimal separator must be a period
(.), and the optional thousands separator must be a comma (,).
FINALPAYMENTDUEDATE Final scheduled payment due date before the profile expires.
Field Description
SUBSCRIBERNAME Full name of the person receiving the product or service paid for by the recurring
payment.
If not present, the name in the buyer’s PayPal account is used.
Character length and limitations: 32 single-byte characters.
PROFILESTARTDATE The date when billing for this profile begins.
Must be a valid date, in UTC/GMT format.
NOTE: The profile may take up to 24 hours for activation.