Share via

AddressDetails Class

Address details.

All required parameters must be populated in order to send to server.

Constructor

AddressDetails(*, address_line1: str, country: str, address_line2: str | None = None, address_line3: str | None = None, city: str | None = None, company_name: str | None = None, district: str | None = None, email: str | None = None, first_name: str | None = None, last_name: str | None = None, middle_name: str | None = None, phone_number: str | None = None, postal_code: str | None = None, region: str | None = None, is_valid_address: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
address_line1
str

Address line 1. Required.
address_line2
str

Address line 2.

Default value: None
address_line3
str

Address line 3.

Default value: None
city
str

Address city.

Default value: None
company_name
str

Company name. Optional for MCA Individual (Pay-as-you-go).

Default value: None
country
str

Country code uses ISO 3166-1 Alpha-2 format. Required.
district
str

Address district.

Default value: None
email
str

Email address.

Default value: None
first_name
str

First name. Optional for MCA Enterprise.

Default value: None
last_name
str

Last name. Optional for MCA Enterprise.

Default value: None
middle_name
str

Middle name.

Default value: None
phone_number
str

Phone number.

Default value: None
postal_code
str

Postal code.

Default value: None
region
str

Address region.

Default value: None
is_valid_address
bool

Indicates if the address is incomplete.

Default value: None

Variables

Name Description
address_line1
str

Address line 1. Required.
address_line2
str

Address line 2.
address_line3
str

Address line 3.
city
str

Address city.
company_name
str

Company name. Optional for MCA Individual (Pay-as-you-go).
country
str

Country code uses ISO 3166-1 Alpha-2 format. Required.
district
str

Address district.
email
str

Email address.
first_name
str

First name. Optional for MCA Enterprise.
last_name
str

Last name. Optional for MCA Enterprise.
middle_name
str

Middle name.
phone_number
str

Phone number.
postal_code
str

Postal code.
region
str

Address region.
is_valid_address
bool

Indicates if the address is incomplete.