2013

Recurring Payments and Reference Transactions API Operations
CreateRecurringPaymentsProfile API Operation
12
138 February 01, 2013 Name-Value Pair API Developer Guide
Recurring Payments Profile Details Fields
Schedule Details Fields
TOKEN A timestamped token, the value of which was returned in the response to the first call
to SetExpressCheckout. You can also use the token returned in the
SetCustomerBillingAgreement response. Either this token or a credit card
number is required. If you include both token and credit card number, the token is
used and credit card number is ignored Call CreateRecurringPaymentsProfile
once for each billing agreement included in SetExpressCheckout request and use
the same token for each call. Each CreateRecurringPaymentsProfile request
creates a single recurring payments profile.
NOTE: Tokens expire after approximately 3 hours.
Field Description
SUBSCRIBERNAME (Optional) 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 (Required) The date when billing for this profile begins.
NOTE: The profile may take up to 24 hours for activation.
Character length and limitations: Must be a valid date, in UTC/GMT format
PROFILEREFERENCE (Optional) The merchant’s own unique reference or invoice number.
Character length and limitations: 127 single-byte alphanumeric characters
Field Description
DESC (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
MAXFAILEDPAYMENTS (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
AUTOBILLOUTAMT (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.
Field Description