On this page
No Headings
CreateBillingAgreement API Operation (SOAP)
Last updated: June 12, 2026
API
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.
Creates a billing agreement with a PayPal account holder. Valid for reference transactions only.
CreateBillingAgreement Request Message
Note: Only the fields described in this documentation are available for use.
CreateBillingAgreement Request Fields
| Field | Description |
|---|---|
Token | xs:string(Required) The time-stamped token returned in the SetExpressCheckout response. Note: The token expires after three hours. |
CreateBillingAgreement API Response Message
Note: Only the fields described in this documentation are available for use.
CreateBillingAgreement Response Fields
| Field | Description |
|---|---|
BillingAgreementID | xs:stringIdentification number of the billing agreement. When the buyer approves the billing agreement, it remains valid until 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 references a billing agreement. Character length and limitations: 19 single-byte alphanumeric characters |