Your browser don't permit web-fonts to be installed. Our websites use web-fonts based icons. For a better experience please allow your browser to use web-fonts.
We are hiring!
Deutsch | English | Español

2.6. Customer

The customer object provides methods to manage common properties for all your accounts.

2.6.1. customer.accounts

Get your sub-accounts.

2.6.1.1. Input

Table 2.64. Parameters

ParameterDescriptionTypeRequiredDefault
detail Level of detail to retrieve: 0: Retrieves only the account id and the isPrimary flag. 1: Retrieves basic account information (fields username, language, servicePin, crDate, org, title, firstname, lastname, street, pc, city, cc). 2: Retrieves all non-technical account information, i.e. no DNS handle defaults etc. 3: Retrieves all account fields. Defaults to 0. int  0

2.6.1.2. Output

Table 2.65. Parameters

ParameterDescriptionTypeOptional
accountsList of accounts array  
... idAccount ID. int  
... usernameAccount username. text64  
... activeAccount is active or not. boolean  

2.6.2. customer.delete

Delete a customer.

2.6.2.1. Input

Table 2.66. Parameters

ParameterDescriptionTypeRequiredDefault
kdnrKDNR of the customer to delete. int true 

2.6.2.2. Output

No additional return parameters

2.6.3. customer.getExtData

Get customer extra data.

2.6.3.1. Input

Table 2.67. Parameters

ParameterDescriptionTypeRequiredDefault
extDataThe name of the extData value to retrieve. customerExtData true 

2.6.3.2. Output

Table 2.68. Parameters

ParameterDescriptionTypeOptional
extDataArray of all requested extData keys and values customerExtData  

2.6.4. customer.info

Get customer information.

2.6.4.1. Input

Table 2.69. Parameters

ParameterDescriptionTypeRequiredDefault
getAccountInfoAlso retrieve details of the primary account. boolean falsefalse

2.6.4.2. Output

Table 2.70. Parameters

ParameterDescriptionTypeOptional
customerIdCustomer ID. int  
accountIdID of the primary account. int  
crDateDate the customer was created. datetime  
secureModeCustomer secure mode. boolean  
summaryInvoiceCustomer receives summary invoice. boolean  
mailListIdsList of subscribed newsletters / mailing list. array  
notificationEmailCustomer receives notification emails. boolean  
notificationQueueCustomer uses notification queue. boolean  
emailBillingCustomer billing email address. email  
emailAutomatedCustomer email address for automated mails. email  
lowBalanceCustomer low balance notification value. float  
paymentTypeCustomer type of payment paymenttype  
bankAccHolderName of bank account holder. token255  
bankNameName of bank. token255  
bankCodeBank code (BIC). token255  
bankAccHolderNoBank account number (IBAN). text64  
vatCustomer VAT. int  
vatNoCustomer company VAT id. vatno  
whoisProviderDefault whois provider for customer. token255  
whoisUrlDefault whois URL. token255  
verificationCustomer verification pending flag. int  
currencyCustomer currency. customercurrency  
usernameAccount username. text64  
titleSalutation title. adresstitle  
firstnameCustomer first name. text64  
lastnameCustomer last name. text64  
orgCustomer organisation/company. text064  
streetCustomer address, street. text64  
pcCustomer postal code. text10  
cityCustomer city. text64  
ccCustomer country code. country  
voiceCustomer phone number. phone  
faxCustomer fax number. phoneoptional  
wwwCustomer web address. text0255  
emailCustomer email address. email  
languageCustomer language. language  
servicePinAccount service pin. int  
defaultRegistrantDefault registrant contact handle. int  
defaultAdminDefault Admin-C contact handle. int  
defaultTechDefault Tech-C contact handle. int  
defaultBillingDefault billing contact handle. int  
defaultNsSetDefault nameserver set. int  
defaultWebDefault web nameserver entry. ip_host  
defaultMailDefault mail nameserver entry. ip_host  
defaultImportNsImport NS in case of domain transfer. boolean  
lastLoginDate and time of last login. dateTime  
loginCountCount of logins. int  
tfa2-factor-authentication method. tfaMethod  
lastIpLast accessed from IP. ip  
accountActiveAccount active flag. int  
accountVerificationAccount verification pending flag. int  

2.6.5. customer.listdownloads

List downloadable file tokens for the given customer.

2.6.5.1. Input

Table 2.71. Parameters

ParameterDescriptionTypeRequiredDefault
typeType of download to search for, e.g. 'gdpr'. If omitted, all downloads are returned. text64 false 

2.6.5.2. Output

Table 2.72. Parameters

ParameterDescriptionTypeOptional
downloads   
... tokenDownload token text64  
... createdCreation date of this download datetime  
... downloadsAmount of times this file has been downloaded int  

2.6.6. customer.requestdataexport

Request a customer data export.

2.6.6.1. Input

No parameters allowed

2.6.6.2. Output

No additional return parameters

2.6.7. customer.update

Update customer information.

2.6.7.1. Input

Table 2.73. Parameters

ParameterDescriptionTypeRequiredDefault
kdnrIf given, update this customer and not yourself. int false 
summaryInvoiceCustomer receives summary invoice. boolean false 
notificationEmailCustomer receives notification emails. boolean false 
notificationQueueCustomer uses notification queue. boolean false 
emailBillingCustomer billing email address. email false 
emailAutomatedCustomer email address for automated mails. email false 
lowBalanceCustomer low balance notification value. float false 
bankAccHolderName of bank account holder. token255 false 
bankNameName of bank. token255 false 
bankCodeBank code (BIC). token255 false 
bankAccHolderNoBank account number (IBAN). text64 false 
vatNoCustomer company VAT id. vatNo false 
whoisProviderDefault whois provider for customer. token255 false 
whoisUrlDefault whois URL. token255 false 

2.6.7.2. Output

No additional return parameters