GetBillingAgreementCustomerDetails API Operation (SOAP)

Shows information about a billing agreement's PayPal account holder.

This API operation has been deprecated starting with API version 54.0 or later.

Important: If you use Express Checkout with API version 54.0 or later, do not use the SetCustomerBillingAgreement and GetBillingAgreementCustomerDetails API operations for billing agreements. Instead, to set up a billing agreement, use the SetExpressCheckout (NVP, SOAP) API operation and set the amount to zero. Call the GetExpressCheckoutDetails (NVP, SOAP) API operation to obtain information about the buyer and the buyer's checkout status. Then use the CreateBillingAgreement (NVP, SOAP) API operation to create the billing agreement. See Billing agreements.

GetBillingAgreementCustomerDetails Request Message

GetBillingAgreementCustomerDetailsRequestType Diagram

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

GetBillingAgreementCustomerDetails Request Fields

Field Description

Token

xs:string

(Required) The time-stamped token returned in the SetCustomerBillingAgreement response.

Note: The token expires after three hours.

Character length and limitations: 20 single-byte characters

GetBillingAgreementCustomerDetails Response Message

GetBillingAgreementCustomerDetailsResponseType Diagram

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

GetBillingAgreementCustomerDetailsResponseDetailsType Diagram

Note: Not all fields shown are available for use. Only use fields described in the documentation.

PayerInfoType Diagram

Note: Not all fields shown are available for use. Only use fields described in the documentation.

GetBillingAgreementCustomerDetails Response Fields

Field Description

PayerInfo

ns:PayerInfoType

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

PayerInfoType Fields

Field Description

Payer

ebl:EmailAddressType

Email address of buyer.

Character length and limitations: 127 single-byte characters

PayerID

ebl:UserIDType

Unique PayPal Customer Account identification number.

Character length and limitations:13 single-byte alphanumeric characters

PayerStatus

ebl:PayPalUserStatusCodeType

Status of buyer. Value is:

  • verified

  • unverified

Character length and limitations: 10 single-byte alphabetic characters

PayerName

ebl:PersonNameType

First and last name of buyer.

PayerCountry

ebl: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

Buyer's shipping address information.

PayerNameType 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: 25 single-byte characters

MiddleName

ebl:NameUser

Buyer's middle name.

Character length and limitations: 25 single-byte characters

LastName

ebl:NameType

Buyer's last name.

Character length and limitations: 25 single-byte characters

Suffix

ebl:SuffixType

Buyer's suffix.

Character length and limitations: 12 single-byte characters

AddressType Fields

Field Description

addressStatus

ebl:addressStatusTypeCode

Status of street address on file with PayPal. Value is:

  • none

  • Confirmed

  • Unconfirmed

Name

xs:string

Person's name associated with this address.

Character length and limitations: 32 single-byte characters

Street1

xs:string

First street address.

Character length and limitations: 100 single-byte characters

Street2

xs:string

Second street address.

Character length and limitations: 100 single-byte characters

CityName

xs:string

Name of city.

Character length and limitations: 40 single-byte characters

StateOrProvince

xs:string

State or province.
It is required if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand, USA.

Character length and limitations: 40 single-byte characters

PostalCode

xs:string

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

Character length and limitations: 20 single-byte characters

Country

ebl:CountryCode

Country code.

Character length and limitations: 2 single-byte characters

Additional information

Feedback