Attributes

Attribute

Description

id int

Unique identifier for the object.

user_id string

ID of the customer who is related to the object

first_name string

The customer’s first name.

last_name string

The customer’s last name.

type enum

The address type, can be shipping or billing. Can be (1) for shipping, or (2) for billing.

title string

The address nature, for example home or business.

line1 string

The first line of the address.

line 2 string

The second line of the address.

city string

The name of a city, town, village, etc.

state string

The two-letter code of the state, region, or province. Learn more here.

country string

Two-letter country code, capitalized. Valid two-letter country codes are specified by ISO3166 alpha-2. Learn more here.

postal_code string

Postal code or zip associated with the address.

phone string

Numeric phone number associated with the address.

is_default bool

Whether this address is flagged as the default.