2012

Recurring Payments and Reference Transactions API Operations
BAUpdate API Operation
12
168 August 2012 Name-Value Pair API Developer Guide
BAUpdate API Operation
The BAUpdate API operation updates or deletes a billing agreement.
BAUpdate Request Message
BAUpdate Request Fields
BAUpdate Response Message
BAUpdate Response Fields
Field Description
METHOD (Required) Must be BillAgreementUpdate.
REFERENCEID (Required) An ID, such as a billing agreement ID or a reference transaction ID that is
associated with a billing agreement.
BILLINGAGREEMENTSTA
TUS
(Optional) Use to cancel a billing agreement. To cancel a billing agreement, pass the
value Canceled.
NOTE: If you do not pass the value Canceled, BAUpdate returns the buyer’s latest
billing address.
L_BILLINGAGREEMENTD
ESCRIPTIONn
(Optional) Description of goods or services associated with the billing agreement.
This field is required for each recurring payment billing agreement. PayPal
recommends that the description contain a brief summary of the billing agreement
terms and conditions. For example, buyer will be billed at “9.99 per month for 2
years”.
Character length and limitations: 127 single-byte alphanumeric characters
L_BILLINGAGREEMENTC
USTOMn
(Optional) Custom annotation field for your own use.
NOTE: For recurring payments, this field is ignored.
Character length and limitations: 256 single-byte alphanumeric characters
Field Description
L_BILLINGTYPE
n Type of billing agreement.
L_BILLINGAGREEMENTD
ESCRIPTION
n
Description of goods or services associated with the billing agreement. This field is
required for each recurring payment billing agreement.
Character length and limitations: 127 single-byte alphanumeric characters