Models

All service methods return DomainrobotResponse where data contains typed model instances. Every model extends Model and captures unknown API fields in extra.

result = client.domain.info("example.com")
domain = result.data[0]

# Typed attributes with IDE autocompletion
print(domain.name)            # "example.com"
print(domain.registryStatus)  # "ACTIVE"
print(domain.expire)          # "2026-01-01T00:00:00.000+0000"

# Unknown/new fields preserved
print(domain.extra)           # {"someFutureField": "value"}

Base

class domainrobot.models._base.Model(extra=<factory>)[source]

Base for all API resource models.

Unknown API fields are captured in extra so the client stays forward-compatible when the API adds new fields.

Fields typed as datetime are automatically parsed from ISO-8601 strings returned by the API.

Parameters:

extra (dict[str, Any])

extra: dict[str, Any]
classmethod from_dict(data)[source]

Create a model instance from an API response dict.

Known fields are set as attributes; everything else goes into extra. Datetime strings are auto-parsed.

Parameters:

data (dict[str, Any])

Return type:

T

Resource models

class domainrobot.models.resources.Domain(extra=<factory>, name=None, idn=None, ownerc=None, adminc=None, techc=None, zonec=None, nameServers=None, nameServerEntries=None, period=None, registryStatus=None, registrarStatus=None, autoRenewStatus=None, cancelationStatus=None, dnssec=None, autoDnssec=None, dnssecData=None, privacy=None, trustee=None, domainsafe=None, parking=None, authinfo=None, authinfoExpire=None, expire=None, payable=None, action=None, comment=None, priceClass=None, priceClassRenew=None, nicMemberLabel=None, domainCreated=None, created=None, updated=None, owner=None, updater=None)[source]

A domain object.

Parameters:
name: str | None = None

The name of the domain.

idn: str | None = None

The unicode domain name

ownerc: dict[str, Any] | None = None

The owner contact.

adminc: dict[str, Any] | None = None

The administrative contact.

techc: dict[str, Any] | None = None

The technical contact reference.

zonec: dict[str, Any] | None = None

The dns contact.

nameServers: list[dict[str, Any]] | None = None

The nameservers.

nameServerEntries: list[str] | None = None

NSentry is only be provided for .DE. If NSentry is used, nameServers is not allowed.

period: dict[str, Any] | None = None

The period in years, depends on the requested action

registryStatus: str | None = None

The registry status.

registrarStatus: str | None = None

The registrar status.

autoRenewStatus: str | None = None

The autorenew status.

cancelationStatus: str | None = None

The cancelation status.

dnssec: bool | None = None

Indicates whether DNSSEC is enabled for the domain or not.

autoDnssec: bool | None = None

Enables or disables automatic DNSSEC for certain name servers (e.g. NodeSecure).

dnssecData: list[dict[str, Any]] | None = None

Submits the key material to the registry. If the list is empty, the key material is deleted at the registry. If the key is omitted during an update, the data is retained.

privacy: bool | None = None

Enable privacy service for the domain.

trustee: bool | None = None

Enable trustee service for the domain.

domainsafe: bool | None = None

Enable domainsafe.

parking: str | None = None

The parking provider.

authinfo: str | None = None

The authinfo.

authinfoExpire: datetime | None = None

The expire date of the authinfo.

expire: datetime | None = None

The expire date of the domain.

payable: datetime | None = None

The payable date of the domain.

action: str | None = None

The last action.

comment: str | None = None

A custom field. Can only be updated via PUT /domain/{name}/_comment. Requires appropriate ACLs.

priceClass: str | None = None

The priceclass for the registration of the domain.

priceClassRenew: str | None = None

The priceclass for the renew of the domain.

nicMemberLabel: str | None = None

The nic member label.

domainCreated: datetime | None = None

The domain creation of the domain at the registry.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.DomainRestore(extra=<factory>, name=None, idn=None, deleted=None, restorePhaseEnd=None, expire=None, registryStatus=None, created=None, updated=None, owner=None, updater=None)[source]

A restorable domain object.

Parameters:
name: str | None = None

The name of the domain.

idn: str | None = None

The unicode domain name

deleted: datetime | None = None

The date at deletion of the domain

restorePhaseEnd: datetime | None = None

The end of current restore phase

expire: datetime | None = None

The expire date of the domain.

registryStatus: str | None = None

The registry status.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.DomainCancelation(extra=<factory>, domain=None, type=None, execution=None, registryWhen=None, gainingRegistrar=None, disconnect=None, notice=None, registryStatus=None, status=None, created=None, updated=None, owner=None, updater=None)[source]

A domain cancelation object.

Parameters:
domain: str | None = None

Domain to be cancelled.

type: str | None = None

The cancelation type. TRANSIT is only possible for certain TLDs.

execution: str | None = None

Date and Time at which the domain is to be canceled.

registryWhen: datetime | None = None

The date on which the registry should perform the domain cancelation. Only necessary when ExecutionType equals DATE.

gainingRegistrar: str | None = None

The registrar to which the domain is to be transferred. Only possible with preack, for which it is required. accept_all = All registrars are accepted Designated registrar (e.g. DENIC-104). Ask the registry for the provider ID of your reseller. The transfer is then only possible to the selected registrar.

disconnect: bool | None = None

Specifies whether the domain is disconnected during a transit. Only possible with transit, for which it is necessary. Default value = false

notice: str | None = None

Some remarks

registryStatus: str | None = None
status: str | None = None

Status of the cancelation request.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.Contact(extra=<factory>, id=None, type=None, alias=None, fname=None, lname=None, organization=None, title=None, address=None, pcode=None, city=None, state=None, country=None, email=None, phone=None, fax=None, sip=None, protection=None, domainsafe=None, comment=None, verification=None, extensions=None, created=None, updated=None, owner=None, updater=None)[source]

A domain contact object.

Parameters:
id: int | None = None

The unique identifier of the contact

type: str | None = None

Domain contact type

alias: str | None = None

A string that is either automatically generated when an alias is not sent or a self-defined string that can be set by the user for the purpose of identifying the domain contact.

fname: str | None = None

First name

lname: str | None = None

Last name

organization: str | None = None

The name of the organization

title: str | None = None

A prefix to a person’s name.

address: list[str] | None = None

Street or post box. Depending on the registry, up to 65,536 characters may be possible.

pcode: str | None = None

The postal code (“zip-code”) of the contact. For countries Canada, Norway, Poland and Spain the format of the postal code is checked for validity. Canada (ca): Six characters in the following format ‘LNL NLN’, where ‘L’ represents a letter and ‘N’ represents a number. Norway (co): Four characters between 0001 and 9990. Poland (pl): Consists of five digits, with a hyphen (‘-’) between the second and third digits. Spain (es): Consisting of exactly five digits. No letters or special characters, only numbers. Each of the five positions can be any digit from 0 to 9.

city: str | None = None

The city of the contact

state: str | None = None

The local country state of the contact

country: str | None = None

Country (ISO 3166-1 alpha-2). Country Code. Certain strings, such as “Germany”, are mapped to DE.

email: str | None = None

Email address

phone: str | None = None

The phone number of the contact

fax: str | None = None

The fax number of the contact

sip: str | None = None

The sip of the contact

protection: str | None = None

The protection of the contact

domainsafe: bool | None = None

Indicates whether the domain contact is in the DomainSafe.

comment: str | None = None

A freely definable text that can be set for a contact. May only be composed of ASCII characters.

verification: str | None = None

The status of domain contact verification.

extensions: dict[str, Any] | None = None

Additional data for contacts required by certain TLDs.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.Certificate(extra=<factory>, id=None, name=None, product=None, certificateType=None, csr=None, server=None, serialNumber=None, signatureHashAlgorithm=None, expire=None, payable=None, lifetime=None, orderId=None, partnerOrderId=None, adminContact=None, technicalContact=None, authentication=None, certificationAuthority=None, subjectAlternativeNames=None, histories=None, software=None, comment=None, certificateTransparency=None, domain=None, created=None, updated=None, owner=None, updater=None)[source]

An SSL certificate object.

Parameters:
id: int | None = None

The ID of the certificate

name: str | None = None

The name of the certificate

product: str | None = None

The ordered product

certificateType: str | None = None

The type of the certificate

csr: str | None = None

CSR - Key (Certificate Signing Request)

server: str | None = None

The certificate

serialNumber: str | None = None

Serial number of the certificate

signatureHashAlgorithm: str | None = None

The signature hash algorithm which was used

expire: datetime | None = None

The notAfter date of the certificate

payable: datetime | None = None

The payable date for the certificate. Indicates when a runtime renewal must take place.

lifetime: dict[str, Any] | None = None

The certificate term in months

orderId: str | None = None

The unique certificate order number

partnerOrderId: str | None = None

The order number of the related request

adminContact: dict[str, Any] | None = None

The administrative contact

technicalContact: dict[str, Any] | None = None

The technical contact

authentication: dict[str, Any] | None = None

The authentication of the certificate

certificationAuthority: list[dict[str, Any]] | None = None

The certificate authority chain

subjectAlternativeNames: list[dict[str, Any]] | None = None

Subject Alternative Names (SANs)

histories: list[dict[str, Any]] | None = None

The history of the certificate (old certificate versions)

software: str | None = None

The webserver software in use, relevant values: ‘II5’ for Mircosoft, ‘APACHE2’ for Linux

comment: str | None = None

A custom field. Can only be updated via PUT /certificate/{id}/_comment. Requires appropriate ACLs.

certificateTransparency: bool | None = None

Activates the certificate transparency for a certificate. Default is “True”.

domain: str | None = None

The domain, which the redirect belongs.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.CertificateData(extra=<factory>, plain=None, name=None, keySize=None, countryCode=None, state=None, city=None, organization=None, organizationUnit=None, email=None, product=None, authentication=None, algorithm=None, signatureHashAlgorithm=None, subjectAlternativeNames=None, certificate=None)[source]

Certificate preparation data (from prepareOrder).

Parameters:

  • extra (dict[str, Any])

  • plain (str | None)

  • name (str | None)

  • keySize (int | None)

  • countryCode (str | None)

  • state (str | None)

  • city (str | None)

  • organization (str | None)

  • organizationUnit (str | None)

  • email (str | None)

  • product (str | None)

  • authentication (list[dict[str, Any]] | None)

  • algorithm (str | None)

  • signatureHashAlgorithm (str | None)

  • subjectAlternativeNames (list[dict[str, Any]] | None)

  • certificate (dict[str, Any] | None)

plain: str | None = None

The CSR key as a string.

name: str | None = None

The name of the certificate which is contained within the CSR key.

keySize: int | None = None

The key length of the CSR key.

countryCode: str | None = None

The country code which is contained within the CSR key.

state: str | None = None

The state defined in the csr.

city: str | None = None

The city contained within the CSR key.

organization: str | None = None

The organisation contained within the CSR key.

organizationUnit: str | None = None

The organisation contained within the CSR key.

email: str | None = None

The email address contained within the CSR key.

product: str | None = None

The SSL product.

authentication: list[dict[str, Any]] | None = None

The generated authentication data.

algorithm: str | None = None

The algorithm used in the CSR key.

signatureHashAlgorithm: str | None = None

The hash algorithm which was used for the CSR.

subjectAlternativeNames: list[dict[str, Any]] | None = None

The SubjectAlternativeNames contained within the CSR key.

certificate: dict[str, Any] | None = None

The certificate.

class domainrobot.models.resources.SslContact(extra=<factory>, id=None, fname=None, lname=None, organization=None, title=None, address=None, pcode=None, city=None, state=None, country=None, email=None, phone=None, fax=None, extensions=None, created=None, updated=None, owner=None, updater=None)[source]

An SSL contact object.

Parameters:
id: int | None = None

Unique identifier of the object

fname: str | None = None

The first name of the contact

lname: str | None = None

The last name of the contact

organization: str | None = None

The name of organisation of the contact.

title: str | None = None

The title of the contact

address: list[str] | None = None

The address of the contact.

pcode: str | None = None

The postal code of the contact.

city: str | None = None

The city of the contact

state: str | None = None

The local country state of the contact

country: str | None = None

The country of the contact

email: str | None = None

The email address of the contact.

phone: str | None = None

The phone number of the contact

fax: str | None = None

The fax number of the contact

extensions: dict[str, Any] | None = None

The contact extensions

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The owner of the object

updater: dict[str, Any] | None = None

The updating using of the object

class domainrobot.models.resources.Zone(extra=<factory>, origin=None, idn=None, virtualNameServer=None, soa=None, main=None, resourceRecords=None, nameServers=None, nameServerGroup=None, dnssec=None, allowTransfer=None, domainsafe=None, comment=None, action=None, grants=None, created=None, updated=None, owner=None, updater=None)[source]

A DNS zone object.

Parameters:
origin: str | None = None

Zone name

idn: str | None = None

Punycode version of the origin.

virtualNameServer: str | None = None

The first nameserver managed by the system

soa: dict[str, Any] | None = None

Only for ns_action: “primary” and “complete”

main: dict[str, Any] | None = None

Main IP address of the zone. Required for ns_action “primary” and “complete”.

resourceRecords: list[dict[str, Any]] | None = None

The resource records.

nameServers: list[dict[str, Any]] | None = None

List of hostnames to be used as name severs.

nameServerGroup: str | None = None

Name of the nameserver group.

dnssec: bool | None = None

If true dnssec signing for the zone is active.

allowTransfer: bool | None = None

Allow zone transfer for the defined zone grants

domainsafe: bool | None = None

Denotes of the zone is present in the DomainSafe service.

comment: str | None = None

A custom field. Can only be updated via PUT /zone/{name}/{nameserver}/_comment. Requires appropriate ACLs.

action: str | None = None

Additional nameserver check is proceeded.

grants: list[str] | None = None

A list of IP addresses from which a zone transfer (AXFR) by be started from for this zone.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

Owner of the zone object

updater: dict[str, Any] | None = None

User who last updated the zone.

class domainrobot.models.resources.Job(extra=<factory>, id=None, status=None, subStatus=None, action=None, subType=None, execution=None, events=None, created=None, updated=None, owner=None, updater=None)[source]

An asynchronous job object.

Many operations (domain create, transfer, certificate order) are asynchronous and return a Job instead of the final resource.

Parameters:
id: int | None = None

The job id.

status: str | None = None

Defines the status of a job.

subStatus: str | None = None

Substatus of the job. Substatuses exist depending on the job.

action: str | None = None

The action, which the job is supposed to do.

subType: str | None = None

The job subtype.

execution: datetime | None = None

The date on which the job will be processed by the system.

events: list[dict[str, Any]] | None = None

The workflow events generated by the job.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.ObjectJob(extra=<factory>, job=None, object=None, authentication=None, niccomLogs=None)[source]

A job with its related object (from job info/list).

Parameters:
job: dict[str, Any] | None = None

The related job.

object: dict[str, Any] | None = None

The object of the job or notify.

authentication: list[dict[str, Any]] | None = None

The overall authentication status for a certificate request.

niccomLogs: list[dict[str, Any]] | None = None

The niccom logs.

class domainrobot.models.resources.PollMessage(extra=<factory>, id=None, stid=None, ctid=None, job=None, notify=None, messages=None, flags=None, notice=None, object=None, owner=None, created=None)[source]

A poll message object.

Parameters:
id: int | None = None

Message ID. Required for confirming with Poll Confirm.

stid: str | None = None

The server transaction ID.

ctid: str | None = None

The custom transaction ID.

job: dict[str, Any] | None = None

The job data. Available if the message is a job message

notify: dict[str, Any] | None = None

The notification data. Available if the message is a notification message

messages: list[dict[str, Any]] | None = None

System messages.

flags: str | None = None

Optional message flags.

notice: str | None = None

Optional notice.

object: dict[str, Any] | None = None

“Response” object like “domain”. Object type depends on the request.

owner: dict[str, Any] | None = None

The object owner.

created: datetime | None = None

Date of creation.

class domainrobot.models.resources.User(extra=<factory>, user=None, context=None, defaultEmail=None, status=None, substatus=None, authType=None, language=None, details=None, lock=None, parent=None, directCustomer=None, customer=None, acls=None, profiles=None, subscriptions=None, nameServerGroups=None, created=None, updated=None)[source]

A user object.

Parameters:
user: str | None = None

The user name.

context: int | None = None

The context. A separated section.

defaultEmail: str | None = None

The default email.

status: int | None = None

User status.

substatus: int | None = None

User substatus of the User.

authType: str | None = None

Authentication type, e.g. password or TOTP.

language: str | None = None

The language for the user. The setting affects the user interface language and system messages. Possible values: de en es.

details: dict[str, Any] | None = None

The user details.

lock: str | None = None

Defines the type of user lock.

parent: dict[str, Any] | None = None

Parent user.

directCustomer: bool | None = None

Specifies whether the user is a direct customer of the user. false = No direct customer true = direct customer Default value = false For XML, 0 (false) and 1 (true) can also be used.

customer: dict[str, Any] | None = None

Customer to which this user belongs.

acls: dict[str, Any] | None = None

User privileges.

profiles: dict[str, Any] | None = None

User profile.

subscriptions: list[dict[str, Any]] | None = None

Different subscriptions of the users.

nameServerGroups: list[dict[str, Any]] | None = None

The available name server groups

created: datetime | None = None

The user created date.

updated: datetime | None = None

The user updated date.

class domainrobot.models.resources.TransferOut(extra=<factory>, domain=None, gainingRegistrar=None, loosingRegistrar=None, start=None, reminder=None, autoAck=None, autoNack=None, end=None, autoAnswer=None, recipient=None, type=None, nackReason=None, transaction=None, created=None, updated=None, owner=None, updater=None)[source]

A transfer-out request object.

Parameters:
domain: str | None = None

The domain name.

gainingRegistrar: str | None = None

The gaining registrar.

loosingRegistrar: str | None = None

The loosing registrar.

start: datetime | None = None

Date on which the transfer started.

reminder: datetime | None = None

Date on which the transfer reminder mail is sent.

autoAck: datetime | None = None

Date of the automatic ACK on which the transfer is confirmed.

autoNack: datetime | None = None

Date of the automatic NACK on which the transfer is rejected.

end: datetime | None = None

Date on which the transfer process ends.

autoAnswer: bool | None = None

Automatic response to the transfer request. false = not active true = active Default value = false For XML, 0 (false) and 1 (true) can also be used.

recipient: str | None = None

Receiver of the reminder email.

type: str | None = None

The type of the transfer.

nackReason: int | None = None

Reason for rejection. Only for type “nack”, mandatory here.

transaction: str | None = None

The ctid.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.Account(extra=<factory>, currentAccountBalance=None, runningTotal=None, creditLimit=None, currency=None, minRunningTotalNotification=None, minRunningTotalNotificationEmail=None, customer=None, created=None, updated=None)[source]

A customer account object.

Parameters:

  • extra (dict[str, Any])

  • currentAccountBalance (float | None)

  • runningTotal (float | None)

  • creditLimit (float | None)

  • currency (str | None)

  • minRunningTotalNotification (float | None)

  • minRunningTotalNotificationEmail (str | None)

  • customer (dict[str, Any] | None)

  • created (datetime | None)

  • updated (datetime | None)

currentAccountBalance: float | None = None

The current account balance

runningTotal: float | None = None

The current total, the amount of all finished and unfinished transactions.

creditLimit: float | None = None

The credit limit of the account.

currency: str | None = None

Currency in which the account is held.

minRunningTotalNotification: float | None = None

The minimum account balance at which a notification should be sent.

minRunningTotalNotificationEmail: str | None = None

Email address for notification. A notification is sent when the minimum account balance has been reached (minRunningTotalNotification).

customer: dict[str, Any] | None = None

The customer object.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

The date of the last update.

class domainrobot.models.resources.BackupMx(extra=<factory>, domain=None, idn=None, created=None, updated=None, owner=None, updater=None)[source]

A BackupMX record object.

Parameters:
domain: str | None = None

Domain name for which the BackupMX Record is to be created.

idn: str | None = None

IDN version of the domain name written in Punycode.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.MailProxy(extra=<factory>, domain=None, idn=None, target=None, admin=None, protection=None, greylisting=None, virus=None, bannedFiles=None, header=None, spam=None, whitelist=None, blacklist=None, excludelist=None, created=None, updated=None, owner=None, updater=None)[source]

A mail proxy object.

Parameters:
domain: str | None = None

Domain name for which the BackupMX Record is to be created.

idn: str | None = None

IDN version of the domain name written in Punycode.

target: str | None = None

Mail server to which the MailProxy should forward the emails. Note that the MX record of your mail server must be removed from the zone.

admin: str | None = None

Email address of the administrator to whom notifications are sent to.

protection: str | None = None

Security settings for handling infected mails.

greylisting: str | None = None

If greylisting is activated, the first email from an unknown sender is rejected at first. Mails from this sender will only be accepted after a further delayed delivery attempt.

virus: str | None = None

Defines whether to check for viruses and how to deal with detected viruses.

bannedFiles: str | None = None

Defines whether files should be checked and how banned files should be avoided.

header: str | None = None

Defines whether headers are to be checked and how banned headers are to be handled.

spam: dict[str, Any] | None = None

The spam policy options.

whitelist: dict[str, Any] | None = None

Define email addresses whose mails should be trusted and never marked as spam.

blacklist: dict[str, Any] | None = None

Specification of email addresses whose mails are always to be marked as spam.

excludelist: dict[str, Any] | None = None

Definition of administrative addresses that should never be ignored by spam filters. An example of this is the “Hostmaster” addresses, e.g. hostmaster@example.com.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.Redirect(extra=<factory>, source=None, target=None, type=None, mode=None, domain=None, title=None, backups=None, sourceIdn=None, targetIdn=None, created=None, updated=None, owner=None, updater=None)[source]

A redirect object.

Parameters:
source: str | None = None

Domain that is to be redirected, e.g. test.example.com.

target: str | None = None

The URL of the target domain. Enter the domain without “https://”.

type: str | None = None

The type of redirect.

mode: str | None = None

The redirect mode of domain and email forwarding.

domain: str | None = None

Domain that is to be redirected, e.g. example.com.

title: str | None = None

Only for the ‘frame’ mode. Page title to be displayed in the browser title bar.

backups: list[str] | None = None

Backup destinations for the redirects. If the first destination cannot be reached, the domain is automatically redirected to the substitute destination (domain redirection, frame redirect).

sourceIdn: str | None = None

The IDN version of the domain name. Domains can be entered with or without “www”.

targetIdn: str | None = None

The Punycode syntax (IDN) version of the target domain URL. Enter the domain without “https://”.

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.Subscription(extra=<factory>, id=None, status=None, object=None, description=None, articleLabel=None, articleTypeLabel=None, period=None, expire=None, payable=None, cancelation=None, canceled=None, cancelationTerm=None, businessCase=None, item=None, created=None, updated=None, owner=None, updater=None)[source]

A subscription contract object.

Parameters:
id: int | None = None

The unique identifier of the periodic

status: str | None = None

Billing status of the subscription.

object: str | None = None

Name of the subscription or the contract number.

description: str | None = None

The human readable name of the subscription, e.g. the name of a package

articleLabel: str | None = None

The article label of the subscription, e.g. backup_mx

articleTypeLabel: str | None = None

The article type label of the subscription, e.g. domain

period: dict[str, Any] | None = None

The period used by the subscription, e.g. 1 month

expire: datetime | None = None

The expiration date of the subscription.

payable: datetime | None = None

The date then the event should be billed.

cancelation: datetime | None = None

The cancelation date of the subscription.

canceled: datetime | None = None

The canceled date.

cancelationTerm: dict[str, Any] | None = None

cancelationTerm of the subscription..

businessCase: str | None = None

The businessCase of the subscription, e.g. create

item: list[dict[str, Any]] | None = None

The items of the subscription

created: datetime | None = None

Date of creation.

updated: datetime | None = None

Date of the last update.

owner: dict[str, Any] | None = None

The object owner.

updater: dict[str, Any] | None = None

User who performed the last update.

class domainrobot.models.resources.DomainEnvelope(extra=<factory>, domain=None, idn=None, tld=None, subTld=None, source=None, services=None, portfolio=None)[source]

A DomainStudio search result.

Parameters:
domain: str | None = None

The domain

idn: str | None = None

The unicode domain name

tld: str | None = None

The tld for the given domain name

subTld: str | None = None

The subTld for the given domain name

source: str | None = None

Source

services: dict[str, Any] | None = None

Source

portfolio: bool | None = None

Defines if the user already owns this domain.