BAUpdate API Operation (SOAP)

Note: Contact PayPal customer service to request permission to use this API operation.

Updates or deletes a billing agreement.

BAUpdate Request Message

BAUpdate SOAP request object diagram

Note: Only the fields described in this documentation are available for use.

BAUpdate Request Fields

Field

Description

ReferenceID

xs:string

(Required) An ID, such as a billing agreement ID or a reference transaction ID that is associated with a billing agreement.

BillingAgreementStatus

ebl:MerchantPullStatusCodeType

(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.

BillingAgreementDescription

xs:string

(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

BillingAgreementCustom

xs:string

(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

BAUpdate Response Message

BAUpdate Response Fields

Field

Description

BillingAgreementID

xs:string

Identification number of the billing agreement. When the buyer approves the billing agreement, it becomes valid and remains valid until it is canceled by the buyer.

Note: For reference transactions, you can pass a billing agreement ID in the ReferenceID request field; also, a billing agreement ID is returned in the transaction response when the transaction referenced is a billing agreement.

Character length and limitations: 19 single-byte alphanumeric characters

BillingAgreementDescription

xs:string

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

BillingAgreementCustom

xs:string

Custom annotation field for your own use.

Character length and limitations: 256 single-byte alphanumeric characters

BillingAgreementStatus

ebl:MerchantPullStatusCodeType

One of the following values:

  • Active
  • Canceled

BillingAgreementMax

cc:BasicAmountType

Maximum amount for this billing agreement.

Note: This field only has a value if the buyer signed up for PayPal using Preapproved Payments; it is included for backwards compatibility with deprecated systems.

Character length and limitations:

Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

PayerInfo

ns:PayerInfoType

Information about the buyer such as the buyer's name, email address, and country of residence. See PayerInfoType.

BillingAddress

ns:AddressType

Customer's billing address. If the customer has stored a credit card in his/her account then the billing address of the credit card is returned; otherwise the customer's primary address is returned. See AddressType.

PayeeInfo

ns:PayeeInfoType

Information about the merchant or the owner of the billing agreement. See PayeeInfoType.

PayerInfoType Fields

Field Description

Payer

ns:EmailAddressType

Email address of buyer.

Character length and limitations: 127 single-byte characters

PayerID

ns:UserIDType

Unique PayPal Customer Account identification number.

Character length and limitations: 17 single-byte alphanumeric characters

PayerStatus

ebl:PayPalUserStatusCodeType

Status of buyer's PayPal account. It is one of the following values:

  • verified
  • unverified

Character length and limitations: 10 single-byte alphabetic characters

PayerName

ebl:PersonNameType

First and last name of buyer. See PersonNameType.

PayerCountry

ns:CountryCodeType

Buyer's country of residence in the form of ISO standard 3166 2-character country codes.

Character length and limitations: 2 single-byte characters

PayerBusiness

xs:string

Buyer's business name.

Character length and limitations: 127 single-byte characters

Address

[ns:AddressType](#addresstype)

Buyer's shipping address information. See AddressType.

PersonNameType Fields

Field Description

Salutation

xs:string

Buyer's salutation.

Character length and limitations: 20 single-byte characters

FirstName

ebl:PersonNameType

Buyer's first name.

Character length and limitations: 64 single-byte characters

MiddleName

ebl:NameUser

Buyer's middle name.

Character length and limitations: 64 single-byte characters

LastName

ebl:NameType

Buyer's last name.

Character length and limitations: 64 single-byte characters

Suffix

ebl:SuffixType

Buyer's suffix.

Character length and limitations: 12 single-byte characters

AddressType Fields

Field Description

Name

xs:string

Billing name associated with this billing address.

Character length and limitations: 32 single-byte characters

Street1

xs:string

First billing street address.

Character length and limitations: 100 single-byte characters

Street2

xs:string

Second billing street address.

Character length and limitations: 100 single-byte characters

CityName

xs:string

Name of billing city.

Character length and limitations: 40 single-byte characters

StateOrProvince

xs:string

Billing state or province. Required for U.S. addresses only.

Character length and limitations: 40 single-byte characters

PostalCode

xs:string

U.S. billing ZIP code or other country-specific postal code.

Character length and limitations: 20 single-byte characters

Country

ebl:CountryCode

Billing country code.

Character length and limitations: 2 single-byte characters

PayeeInfoType Fields

Information about the merchant or the owner of the billing agreement.

Field Description

PayeeEmail

ns:EmailAddressType

Email address of the merchant or owner of the billing agreement.

Character length and limitations: 127 single-byte characters

PayeeID

ns:UserIDType

Unique merchant account identification number.

Character length and limitations: 17 single-byte alphanumeric characters

Additional information