# BAUpdate API Operation (SOAP) (/api/nvp-soap/ba-update-soap)



> **Note:** **Important:** NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, [we recommend our latest solutions](/).

> **Note:** **Note:** Contact [PayPal customer service](https://www.paypal.com/contactus) to request permission to use this API operation.

Updates or deletes a billing agreement.

## BAUpdate Request Message [#baupdate-request-message]

![BAUpdate,SOAP,request,object,diagram](https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/BAUpdateRequestType1.gif)

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

### BAUpdate Request Fields [#baupdate-request-fields]

| Field<br />                         | Description<br />                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ReferenceID`<br />                 | `xs:string`<br /&#x3E; &#x2A;(Required)* An ID, such as a billing agreement ID or a reference transaction ID that is associated with a billing agreement.<br />                                                                                                                                                                                                                                                                                              |
| `BillingAgreementStatus`<br />      | `ebl:MerchantPullStatusCodeType`<br /&#x3E; &#x2A;(Optional)* Use to cancel a billing agreement. To cancel a billing agreement, pass the value `Canceled`.<br /> > **Note:** &#x2A;*Note:** If you do not pass the value `Canceled`, `BAUpdate` returns the buyer's latest billing address.                                                                                                                                                                  |
| `BillingAgreementDescription`<br /> | `xs:string`<br /&#x3E; &#x2A;(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."<br /> Character length and limitations: 127 single-byte alphanumeric characters<br /> |
| `BillingAgreementCustom`<br />      | `xs:string`<br /&#x3E; &#x2A;(Optional)* Custom annotation field for your own use.<br /> > **Note:** &#x2A;*Note:** For recurring payments, this field is ignored. Character length and limitations: 256 single-byte alphanumeric characters<br />                                                                                                                                                                                                           |

## BAUpdate Response Message [#baupdate-response-message]

### BAUpdate Response Fields [#baupdate-response-fields]

| Field<br />                         | Description<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `BillingAgreementID`<br />          | `xs:string`<br />  Identification number of the billing agreement. When the buyer approves the billing agreement, it remains valid until canceled by the buyer.<br /><br />                  > **Note:** &#x2A;*Note:** For [reference transactions](/docs/archive/express-checkout/integration-guide/ECReferenceTxns/), 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 references a billing agreement. <br /><br />Character length and limitations: 19 single-byte alphanumeric characters                                                                                                                                                                                                                                                                |
| `BillingAgreementDescription`<br /> | `xs:string`<br />                  Description of goods or services associated with the billing agreement. This field is required for each recurring payment billing agreement.<br />                  Character length and limitations: 127 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `BillingAgreementCustom`<br />      | `xs:string`<br />                  Custom annotation field for your own use.<br />                  Character length and limitations: 256 single-byte alphanumeric characters<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `BillingAgreementStatus`<br />      | `ebl:MerchantPullStatusCodeType`<br />                  One of the following values:<br />                  `Active``Canceled`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `BillingAgreementMax`<br />         | `cc:BasicAmountType`<br />                  Maximum amount for this billing agreement.<br />                   > **Note:** &#x2A;*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](/api/nvp-soap/currency-codes/). 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](/api/nvp-soap/currency-codes/).<br /> |
| `PayerInfo`<br />                   | [`ns:PayerInfoType`](#payerinfotype-fields)<br />                  Information about the buyer such as the buyer's name, email address, and country of residence. See [PayerInfoType](#payerinfotype-fields).<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `BillingAddress`<br />              | [`ns:AddressType`](#addresstype-fields)<br />                  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](#addresstype-fields).<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `PayeeInfo`<br />                   | [`ns:PayeeInfoType`](#payeeinfotype-fields)<br />                  Information about the merchant or the owner of the billing agreement. See [PayeeInfoType](#payeeinfotype-fields).<br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

### PayerInfoType Fields [#payerinfotype-fields]

| Field                 | Description                                                                                                                                                                                                                                                           |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Payer`<br />         | `ns:EmailAddressType`<br />                  Email address of buyer.<br />                  Character length and limitations: 127 single-byte characters<br />                                                                                                        |
| `PayerID`<br />       | `ns:UserIDType`<br />                  Unique PayPal Customer Account identification number.<br />                  Character length and limitations: 17 single-byte alphanumeric characters<br />                                                                    |
| `PayerStatus`<br />   | `ebl:PayPalUserStatusCodeType`<br />                  Status of buyer's PayPal account. It is one of the following values:<br />                  `verified``unverified`                 Character length and limitations: 10 single-byte alphabetic characters<br /> |
| `PayerName`<br />     | [`ebl:PersonNameType`](#personnametype-fields)<br />                  First and last name of buyer. See [PersonNameType](#personnametype-fields).<br />                                                                                                               |
| `PayerCountry`<br />  | `ns:CountryCodeType`<br />                  Buyer's country of residence in the form of [ISO standard 3166 2-character country codes](/docs/nvp-soap-api/country-codes/).<br />                  Character length and limitations: 2 single-byte characters<br />     |
| `PayerBusiness`<br /> | `xs:string`<br />                  Buyer's business name.<br />                  Character length and limitations: 127 single-byte characters<br />                                                                                                                   |
| `Address`<br />       | `[ns:AddressType](#addresstype-fields)`<br />                  Buyer's shipping address information. See [AddressType](#addresstype-fields).<br />                                                                                                                    |

### PersonNameType Fields [#personnametype-fields]

| Field              | Description                                                                                                            |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| `Salutation`<br /> | `xs:string`<br /> Buyer's salutation.<br /> Character length and limitations: 20 single-byte characters<br />          |
| `FirstName`<br />  | `ebl:PersonNameType`<br /> Buyer's first name.<br /> Character length and limitations: 64 single-byte characters<br /> |
| `MiddleName`<br /> | `ebl:NameUser`<br /> Buyer's middle name.<br /> Character length and limitations: 64 single-byte characters<br />      |
| `LastName`<br />   | `ebl:NameType`<br /> Buyer's last name.<br /> Character length and limitations: 64 single-byte characters<br />        |
| `Suffix`<br />     | `ebl:SuffixType`<br /> Buyer's suffix.<br /> Character length and limitations: 12 single-byte characters<br />         |

### AddressType Fields [#addresstype-fields]

| Field                   | Description                                                                                                                                            |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Name`<br />            | `xs:string`<br /> Billing name associated with this billing address.<br /> Character length and limitations: 32 single-byte characters<br />           |
| `Street1`<br />         | `xs:string`<br /> First billing street address.<br /> Character length and limitations: 100 single-byte characters<br />                               |
| `Street2`<br />         | `xs:string`<br /> Second billing street address.<br /> Character length and limitations: 100 single-byte characters<br />                              |
| `CityName`<br />        | `xs:string`<br /> Name of billing city.<br /> Character length and limitations: 40 single-byte characters<br />                                        |
| `StateOrProvince`<br /> | `xs:string`<br /> Billing state or province. Required for U.S. addresses only.<br /> Character length and limitations: 40 single-byte characters<br /> |
| `PostalCode`<br />      | `xs:string`<br /> U.S. billing ZIP code or other country-specific postal code.<br /> Character length and limitations: 20 single-byte characters<br /> |
| `Country`<br />         | `ebl:CountryCode`<br /> Billing country code.<br /> Character length and limitations: 2 single-byte characters<br />                                   |

### PayeeInfoType Fields [#payeeinfotype-fields]

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

| Field              | Description                                                                                                                                                           |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PayeeEmail`<br /> | `ns:EmailAddressType`<br /> Email address of the merchant or owner of the billing agreement.<br /> Character length and limitations: 127 single-byte characters<br /> |
| `PayeeID`<br />    | `ns:UserIDType`<br /> Unique merchant account identification number.<br /> Character length and limitations: 17 single-byte alphanumeric characters<br />             |

## Additional information [#additional-information]

* [API error codes](/api/nvp-soap/errors/)
