2009
Table Of Contents
- Name-Value Pair API Developer Guide
- Preface
- This Document
- Intended Audience
- Revision History
- PayPal NVP API Overview
- Authorization and Capture API Operation Reference
- DoDirectPayment API
- Express Checkout API Operations
- GetTransactionDetails API
- MassPay API
- RefundTransaction API
- TransactionSearch API
- Recurring Payments and Reference Transactions API Operations
- DoNonReferencedCredit API
- ManagePendingTransactionStatu s API
- GetBalance API
- AddressVerify API
- API Error Codes
- General API Errors
- Validation Errors
- Direct Payment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- Mass Pay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Country Codes
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
Name-Value Pair API Developer Guide 08 April 2009 117
Recurring Payments and Reference Transactions API Operations
UpdateRecurringPaymentsProfile API
UpdateRecurringPaymentsProfile Request Fields
Field Description
METHOD (Required) Must be UpdateRecurringPaymentsProfile.
PROFILEID (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 compatability with previous versions of the
PayPal API.
NOTE (Optional) The reason for the update to the recurring payments profile. This message
will be 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.
DESC (Optional) Description of the recurring payment.
Character length and limitations: 127 single-byte alphanumeric characters.
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.
PROFILEREFERENCE (Optional) The merchant’s own unique reference or invoice number.
Character length and limitations: 127 single-byte alphanumeric characters.
ADDITIONALBILLINGCY
CLES
(Optional) The number of additional billing cycles to add to this profile.
AMT (Optional) Billing amount for each cycle in the subscription period, not including
shipping and tax amounts.
NOTE: For recurring payments with Express Checkout, the payment amount can be
increased by no more than 20% every 180 days (starting when the profile is
created).
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
SHIPPINGAMT (Optional) Shipping amount for each billing cycle during the regular payment period.
NOTE: All amounts in the request must have the same currency.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.