The address object

The address object is located within the user object and represents the user's postal address information. This is usually also the billing address.

Important

If the address object is specified, then it must include at least one of the following key/value pairs.

The following table lists the attributes of the address object:

Name

Type

Description

address_line_1

string

Optional.

User address line one.

address_line_2

string

Optional.

User address line two.

state

string

Optional.

Two-letter code if in the US.

zip

string

Optional.

Five-digit zip code if in the US.

country

string

Optional.

Two-letter country code as defined by ISO Alpha 2. Defaults to "US"

To preserve users' privacy, all personally identifiable information, such as an email address, is encrypted. Additionally, address information is geocoded up to a precision of a 3-mile (approximately 5-kilometer) radius, so users' physical addresses cannot be pinpointed.

Do you have some feedback for us?

If you have suggestions for improving this article,