2013

Recurring Payments and Reference Transactions API Operations
GetRecurringPaymentsProfileDetails API Operation
12
208 February 01, 2013 SOAP API Developer Reference
AutoBillOutstanding
Amount
ns:AutoBillType
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. It is one
of the following values:
 NoAutoBill – PayPal does not automatically bill the outstanding balance
amount.
 AddToNextBilling – PayPal automatically bills the outstanding balance amount.
MaxFailedPayments xs:int
Number of scheduled payments that can fail before the profile is automatically
suspended.
Character length and limitations: Number string representing an integer
RecurringPayments
ProfileDetails
ns:RecurringPaymentsProfileDetailsType
Buyer information for this recurring payments profile.
CurrentRecurring
PaymentsPeriod
ns:BillingPeriodDetailsType
Details of the current subscription period. This field is not returned if the profile is
canceled or expired.
RecurringPayments
Summary
ns:RecurringPaymentsSummaryDetailsType
Payment summary for this recurring payments profile.
AggregateAmount ns:AmountType
Total amount collected thus far for scheduled payments.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal
places, the decimal separator must be a period (.), and the optional thousands
separator must be a comma (,).
AggregateOptionalAm
ount
ns:AmountType
Total amount collected thus far for optional payments.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal
places, the decimal separator must be a period (.), and the optional thousands
separator must be a comma (,).
FinalPaymentDueDate ns:DateTime
Final scheduled payment due date before the profile expires.
CreditCard ns:CreditCardDetailsType
If this is a recurring payments profile using direct payments, this field contains the
credit card information for this profile.
NOTE: Only the last 4 digits of the credit card account number are returned. The
CVV2 value is not returned.
Field Description