Documentation

Mistake on this page? Email us

This object represents an account in requests and responses.

Index

Type aliases

MfaStatusEnum

MfaStatusEnum: "enforced" | "optional"

ObjectEnum

ObjectEnum: "account"

StatusEnum

StatusEnum: "ENROLLING" | "ACTIVE" | "RESTRICTED" | "SUSPENDED"

Properties

address_line1

address_line1: string

Postal address line 1.

address_line2

address_line2: string

Postal address line 2.

aliases

aliases: Array<string>

An array of aliases.

city

city: string

The city part of the postal address.

company

company: string

The name of the company.

contact

contact: string

The name of the contact person for this account.

contract_number

contract_number: string

Contract number of the customer.

country

country: string

The country part of the postal address.

created_at

created_at: Date

Creation UTC time RFC3339.

custom_fields

custom_fields: object

Account's custom properties as key-value pairs.

Type declaration

  • [key: string]: string

customer_number

customer_number: string

Customer number of the customer.

display_name

display_name: string

The display name for the account.

email

email: string

The company email address for this account.

end_market

end_market: string

Account end market.

etag

etag: string

API resource entity version.

expiration_warning_threshold

expiration_warning_threshold: string

Indicates how many days (1-180) before account expiration a notification email should be sent.

id

id: string

Account ID.

idle_timeout

idle_timeout: string

The reference token expiration time in minutes for this account.

limits

limits: object

List of limits as key-value pairs if requested.

Type declaration

  • [key: string]: string

mfa_status

mfa_status: MfaStatusEnum

The enforcement status of the multi-factor authentication, either 'enforced' or 'optional'.

notification_emails

notification_emails: Array<string>

A list of notification email addresses.

object

object: ObjectEnum

Entity name: always 'account'

parent_id

parent_id: string

The ID of the parent account, if it has any.

password_policy

password_policy: PasswordPolicy

The password policy for this account.

phone_number

phone_number: string

The phone number of a representative of the company.

policies

policies: Array<FeaturePolicy>

List of policies if requested.

postal_code

postal_code: string

The postal code part of the postal address.

reason

reason: string

A reason note for updating the status of the account

reference_note

reference_note: string

A reference note for updating the status of the account

sales_contact

sales_contact: string

Email address of the sales contact.

state

state: string

The state part of the postal address.

status

status: StatusEnum

The status of the account.

sub_accounts

sub_accounts: Array<AccountInfo>

List of sub accounts. Not available for developer users.

template_id

template_id: string

Account template ID.

tier

tier: string

The tier level of the account; '0': free tier, '1': commercial account, '2': partner tier. Other values are reserved for the future.

updated_at

updated_at: Date

Last update UTC time RFC3339.

upgraded_at

upgraded_at: Date

Time when upgraded to commercial account in UTC format RFC3339.