AddressInput

Input fields for an Address.

Fields

addressLine1String

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

addressLine2String

Extended address information, such as apartment number or suite number. 255 character maximum.

adminArea1String

Highest level subdivision, such as state, province or ISO-3166-2 subdivision. 255 character maximum.

adminArea2String

A city, town or village. 255 character maximum.

companyString

Company name. 255 character maximum.

countryCodeCountryCode

Country code for the address.

Required in the shipping address for Level 3 processing.

extendedAddressString

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

firstNameString

First name. 255 character maximum.

lastNameString

Last name. 255 character maximum.

localityString

Locality/city. 255 character maximum.

phonePhoneInput

Phone associated with the address.

postalCodeString

Postal code in any country's format, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code. Nine alphanumeric characters maximum, may also contain spaces and hyphens.

Required in the shipping address for Level 3 processing.

regionString

State or province. 255 character maximum.

streetAddressString

The street address. 255 character maximum.

countryCodeAlpha2StringDeprecatedsince 2017-11-14

This field is included for supporting legacy clients. Please use countryCode instead.

Country code for the address in ISO 3166-1 alpha-2 format.

countryCodeAlpha3StringDeprecatedsince 2017-12-04

This field is included for supporting legacy clients. Please use countryCode instead.

Country code for the address in ISO 3166-1 alpha-3 format.

countryCodeNumericStringDeprecatedsince 2017-11-14

This field is included for supporting legacy clients. Please use countryCode instead.

Country code for the address in ISO 3166-1 numeric format.

countryNameStringDeprecatedsince 2017-11-14

This field is included for supporting legacy clients. Please use countryCode instead.

Country name for the address.

Used by

Direct references from GraphQL types, queries, and mutations.

CreatePayPalBillingAgreementInputInputshippingAddress CreatePayPalOneTimePaymentInputInputshippingAddress CreditCardInputInputbillingAddress CreditCardTransactionOptionsInputInputbillingAddress IndustryFlightInputInputticketIssuerAddress SubMerchantDetailsInputInputaddress TransactionRiskEvaluateInputInputbillingAddressshippingAddress TransactionShippingInputInputshippingAddress UpdateCreditCardBillingAddressInputInputbillingAddress UpdatePayPalOneTimePaymentInputInputshippingAddress VaultCreditCardInputInputbillingAddress

GraphQL definition

AddressInput schema definition

input AddressInput {
  company: String
  streetAddress: String
  addressLine1: String
  extendedAddress: String
  addressLine2: String
  firstName: String
  lastName: String
  locality: String
  adminArea2: String
  region: String
  adminArea1: String
  postalCode: String
  countryCode: CountryCode
  phone: PhoneInput
  countryCodeAlpha3: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.")
  countryCodeAlpha2: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.")
  countryCodeNumeric: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.")
  countryName: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.")
}

input AddressInput { company: String streetAddress: String addressLine1: String extendedAddress: String addressLine2: String firstName: String lastName: String locality: String adminArea2: String region: String adminArea1: String postalCode: String countryCode: CountryCode phone: PhoneInput countryCodeAlpha3: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.") countryCodeAlpha2: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.") countryCodeNumeric: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.") countryName: String @deprecated(reason: "This field is included for supporting legacy clients. Please use `countryCode` instead.") }

Fields

Used by

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Fields

Used by