Skip to main content

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

domainId
integer<int64>
read-only

Unique identifier of the domain

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.

renewStatus
enum<string>

Whether the domain can be renewed now.

  • renewable — the subscription is active and the domain expires in 1 to 45 days.
  • inProgress — a renewal has been requested and is being processed.
  • nonRenewable — any other case, including when domain renewal is not available for your team.
Available options:
nonRenewable,
renewable,
inProgress