GetBillingAgreementCustomerDetails API Operation (NVP)

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

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

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

GetBillingAgreementCustomerDetails Request Fields

Field Description

METHOD

(Required) Must be GetBillingAgreementCustomerDetails.

TOKEN

(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

Payer Information Fields

Field Description

EMAIL

Email address of buyer.

Character length and limitations: 127 single-byte characters

PAYERID

Unique PayPal Customer Account identification number.

Character length and limitations:13 single-byte alphanumeric characters

PAYERSTATUS

Status of buyer. Value is:

  • verified

  • unverified

Character length and limitations: 10 single-byte alphabetic characters

COUNTRYCODE

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

Buyer's business name.

Character length and limitations: 127 single-byte characters

PayerNameType Fields

Field Description

SALUTATION

Buyer's salutation.

Character length and limitations: 20 single-byte characters

FIRSTNAME

Buyer's first name.

Character length and limitations: 25 single-byte characters

MIDDLENAME

Buyer's middle name.

Character length and limitations: 25 single-byte characters

LASTNAME

Buyer's last name.

Character length and limitations: 25 single-byte characters

SUFFIX

Buyer's suffix.

Character length and limitations: 12 single-byte characters

Address Fields

Field Description

ADDRESSSTATUS

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

  • none

  • Confirmed

  • Unconfirmed

SHIPTONAME

Person's name associated with this address.

Character length and limitations: 32 single-byte characters

SHIPTOSTREET

First street address.

Character length and limitations: 100 single-byte characters

SHIPTOSTREET2

Second street address.

Character length and limitations: 100 single-byte characters

SHIPTOCITY

Name of city.

Character length and limitations: 40 single-byte characters

SHIPTOSTATE

State or province.

It is required for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal State codes.

Character length and limitations: 40 single-byte characters

SHIPTOZIP

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

Character length and limitations: 20 single-byte characters

SHIPTOCOUNTRYCODE

Country code.

Character length and limitations: 2 single-byte characters

Additional information

Feedback