2009

Name-Value Pair API Developer Guide 08 April 2009 131
Recurring Payments and Reference Transactions API Operations
BAUpdate API
BAUpdate Request
Update Billing Agreement Request Fields
BAUpdateResponseDetails Response
z GetBillingAgreementCustomerDetails Response Fields
z Payer Information Fields
z Payer Name Fields
z Ship To Address 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) Type of billing agreement.
The current status of the billing agreement, which is one of the following values:
z Active - the billing agreement is currently active
z Canceled - the billing agreement has been cancelled
L_BILLINGAGREEMENTD
ESCRIPTIONn
(Optional) Description of goods or services associated with the billing agreement,
which 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, customer will be billed at “9.99 per
month for 2 years”.
Character length and limitations: 127 single-byte alphanumeric bytes.
L_CUSTOMn (Optional) Custom annotation field for your own use.
NOTE: For recurring payments, this field is ignored.
Character length and limitations: 256 single-byte alphanumeric bytes.