Interface DomesticAddressInput

A US domestic address, as entered as input to the API

interface DomesticAddressInput {
    city: string;
    residential?: null | boolean;
    state: StateCode;
    street: GraphqlList<string>;
    urbanization_code?: null | string;
    zip_code: string;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

city residential? state street urbanization_code? zip_code

Properties

city

city: string

The city the address is in.

Optionalresidential

residential?: null | boolean

Whether the address is residential or commercial

state

state: StateCode

The two-letter state code

street

street: GraphqlList<string>

The street address. Note that most carriers will only accept the first two lines.

Optionalurbanization_code

urbanization_code?: null | string

The urbanization code, if applicable. Only relevant for Puerto Rico addresses.

zip_code

zip_code: string

The ZIP Code, as assigned by the US Postal Service

Settings

Member Visibility

On This Page

Properties