2013

SOAP API Developer Reference February 01, 2013 223
Recurring Payments and Reference Transactions API Operations
UpdateRecurringPaymentsProfile API Operation
12
UpdateRecurringPaymentsProfile Request Fields
Field Description
ProfileID xs:string
(Required) Recurring payments profile ID returned in the
CreateRecurringPaymentsProfile response.
Character length and limitations: 14 single-byte alphanumeric characters. 19
character profile IDs are supported for compatibility with previous versions of the
PayPal API.
Note xs:string
(Optional) The reason for the update to the recurring payments profile. This message
is included in the email notification to the buyer for the recurring payments profile
update. This note can also be seen by both you and the buyer on the Status History
page of the PayPal account.
Description xs:string
(Optional) Description of the recurring payment.
Character length and limitations: 127 single-byte alphanumeric characters
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 you do not specify it, the ship-to address from buyer’s PayPal account is
used.
NOTE: Shipping Address is optional, but if you update any of the address fields, you
must enter all of them. For example, if you want to update the subsriber’s
street address, you must specify all of the fields listed in
ShipTo:
AddressType, not just the field for the street address.
ProfileReference xs:string
(Optional) The merchant’s own unique reference or invoice number.
Character length and limitations: 127 single-byte alphanumeric characters
AdditionalBilling
Cycles
xs:int
(Optional) The number of additional billing cycles to add to this profile.