2013

Recurring Payments and Reference Transactions API Operations
CreateRecurringPaymentsProfile API Operation
12
192 February 01, 2013 SOAP API Developer Reference
ScheduleDetailsType Fields
Field Description
Description xs:string
(Required) Description of the recurring payment.
NOTE: You must ensure that this field matches the corresponding billing agreement
description included in the
SetExpressCheckout request.
Character length and limitations: 127 single-byte alphanumeric characters
ActivationDetails ns:ActivationDetailsType
(Optional) Information about activating a profile, such as whether there is an initial
non-recurring payment amount immediately due upon profile creation and how to
override a pending profile PayPal suspends when the initial payment amount fails.
TrialPeriod ns:BillingPeriodDetailsType
(Optional) Trial period for this schedule.
PaymentPeriod ns:BillingPeriodDetailsType
(Required) Regular payment period for this schedule.
MaxFailedPayments xs:int
(Optional) Number of scheduled payments that can fail before the profile is
automatically suspended. An IPN message is sent to the merchant when the specified
number of failed payments is reached.
Character length and limitations: Number string representing an integer
AutoBillOutstanding
Amount
ns:AutoBillType
(Optional) 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.
 AddToNextBilling – PayPal automatically bills the outstanding balance.