Skip to main content

A pre-warmed domain your team bought through mailbox procurement, with its subscription and setup state.

domainId
integer<int64>
read-only

Unique identifier of the domain. Shares one id space with the purchased domains from GET /v3/email-accounts/procurement/domains; the two lists never overlap.

domainName
string

Fully qualified domain name

serviceProvider
enum<string>

Mail provider that hosts the domain's mailboxes

Available options:
google,
microsoft
subscriptionStatus
enum<string>

State of the domain's subscription

Available options:
provisioning,
active,
provisioningFailed,
cancelled,
expired
availabilityStatus
enum<string>

Setup state of the domain at the mail provider. active once the provider has confirmed the domain.

Available options:
pending,
active,
failedToConfigure,
locked
expireOn
string<date-time> | null

When the domain registration expires (UTC). null while the domain is still being provisioned.