2013

SOAP API Developer Reference February 01, 2013 191
Recurring Payments and Reference Transactions API Operations
CreateRecurringPaymentsProfile API Operation
12
RecurringPaymentsProfileDetailsType Fields
CreditCard ns:CreditCardDetailsType
Credit card information for recurring payments using direct payments. Either a 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.
RecurringPayments
ProfileDetails
ns:RecurringPaymentsProfileDetails
(Required) You can include up to 10 recurring payments profiles per request. The
order of the profile details must match the order of the billing agreement details
specified in the SetExpressCheckout request.
ScheduleDetails ns:ScheduleDetailsType
(Required) Describes the recurring payments schedule, including the regular payment
period, whether there is a trial period, and the number of payments that can fail before
a profile is suspended.
Field Description
SubscriberName xs:string
(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
SubscriberShipping
Address
ns:AddressType
(Optional) The subscriber’s shipping address associated with this profile, if
applicable. If not specified, the ship-to address from buyer’s PayPal account is used.
NOTE: Shipping Address is optional, but if you include it, certain fields are required.
BillingStartdate xs:dateTime
(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 xs:string
(Optional) The merchant’s own unique reference or invoice number.
Character length and limitations: 127 single-byte alphanumeric characters
Field Description