Address

Representation of an address.

Fields

addressLine1String

The first line of the street address, such as street number, street name.

addressLine2String

Extended address information, such as an apartment number or suite number.

adminArea1String

Highest level subdivision, such as state, province, or ISO-3166-2 subdivison.

adminArea2String

A city, town, or village.

companyString

Company name.

countryCodeCountryCode

Country code for the address.

fullNameString

Full name.

phonePhone

Phone number.

postalCodeString

Postal code, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code.

extendedAddressStringDeprecatedsince 2020-11-18

Use addressLine2 instead.

Extended address information, such as an apartment or suite number.

firstNameStringDeprecatedsince 2020-02-26

Use fullName instead.

First name.

lastNameStringDeprecatedsince 2020-02-26

Use fullName instead.

Last name.

localityStringDeprecatedsince 2020-11-18

Use adminArea2 instead.

Locality/city.

phoneNumberStringDeprecatedsince 2024-12-17

Use phone instead

Phone number.

regionStringDeprecatedsince 2020-11-18

Use adminArea1 instead.

State or province.

streetAddressStringDeprecatedsince 2020-11-18

Use addressLine1 instead.

The street address.

Used by

Direct references from GraphQL types, queries, and mutations.

CreditCardDetailsObjectbillingAddress PayPalAccountDetailsObjectbillingAddressshippingAddress TransactionObjectbillingAddressmerchantAddress TransactionShippingObjectshippingAddress UpdateCreditCardBillingAddressPayloadObjectbillingAddress VenmoPayerInfoObjectbillingAddressshippingAddress

GraphQL definition

Address schema definition

type Address {
  company: String
  streetAddress: String @deprecated(reason: "Use `addressLine1` instead.")
  addressLine1: String
  extendedAddress: String @deprecated(reason: "Use `addressLine2` instead.")
  addressLine2: String
  firstName: String @deprecated(reason: "Use `fullName` instead.")
  lastName: String @deprecated(reason: "Use `fullName` instead.")
  fullName: String
  locality: String @deprecated(reason: "Use `adminArea2` instead.")
  adminArea2: String
  region: String @deprecated(reason: "Use `adminArea1` instead.")
  adminArea1: String
  postalCode: String
  countryCode: CountryCode
  phoneNumber: String @deprecated(reason: "Use `phone` instead")
  phone: Phone
}

type Address { company: String streetAddress: String @deprecated(reason: "Use `addressLine1` instead.") addressLine1: String extendedAddress: String @deprecated(reason: "Use `addressLine2` instead.") addressLine2: String firstName: String @deprecated(reason: "Use `fullName` instead.") lastName: String @deprecated(reason: "Use `fullName` instead.") fullName: String locality: String @deprecated(reason: "Use `adminArea2` instead.") adminArea2: String region: String @deprecated(reason: "Use `adminArea1` instead.") adminArea1: String postalCode: String countryCode: CountryCode phoneNumber: String @deprecated(reason: "Use `phone` instead") phone: Phone }

Fields

Used by

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Fields

Used by