APIDocumentation

2.6. Customer
Prev	Chapter 2. Methods	Next

2.6.1. customer.accounts

Get your sub-accounts.

2.6.1.1. Input

Table 2.70. Parameters

Parameter	Description	Type	Required	Default
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	false	0

2.6.1.2. Output

Table 2.71. Parameters

Parameter	Description	Type
accounts	List of accounts	array
... id	Account ID.	int
... username	Account username.	text64
... active	Account is active or not.	boolean

2.6.2. customer.delete

Delete a customer.

2.6.2.1. Input

Table 2.72. Parameters

Parameter	Description	Type	Required	Default
kdnr	KDNR 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.73. Parameters

Parameter	Description	Type	Required	Default
extData	The name of the extData value to retrieve.	customerExtData	true

2.6.3.2. Output

Table 2.74. Parameters

Parameter	Description	Type	Optional
extData	Array of all requested extData keys and values	customerExtData

2.6.4. customer.info

Get customer information.

2.6.4.1. Input

Table 2.75. Parameters

Parameter	Description	Type	Required	Default
getAccountInfo	Also retrieve details of the primary account.	boolean	false	false

2.6.4.2. Output

Table 2.76. Parameters

Parameter	Description	Type
customerId	Customer ID.	int
customerNo	Your unique Customer number	int
accountId	ID of the primary account.	int
crDate	Date the customer was created.	datetime
secureMode	Customer secure mode.	boolean
summaryInvoice	Customer receives summary invoice.	boolean
mailListIds	List of subscribed newsletters / mailing list.	array
notificationEmail	Customer receives notification emails.	boolean
notificationQueue	Customer uses notification queue.	boolean
emailBilling	Customer billing email address.	email
emailAutomated	Customer email address for automated mails.	email
lowBalance	Customer low balance notification value.	float
paymentType	Customer type of payment	paymenttype
bankAccHolder	Name of bank account holder.	token255
bankName	Name of bank.	token255
bankCode	Bank code (BIC).	token255
bankAccHolderNo	Bank account number (IBAN).	text64
vat	Customer VAT.	int
vatNo	Customer company VAT id.	vatno
whoisProvider	Default whois provider for customer.	token255
whoisUrl	Default whois URL.	token255
verification	Customer verification pending flag.	int
currency	Customer currency.	customercurrency
username	Account username.	text64
title	Salutation title.	adresstitle
firstname	Customer first name.	text64
lastname	Customer last name.	text64
org	Customer organisation/company.	text064
street	Customer address, street.	text64
pc	Customer postal code.	text10
city	Customer city.	text64
cc	Customer country code.	country
voice	Customer phone number.	phone
fax	Customer fax number.	phoneoptional
www	Customer web address.	text0255
email	Customer email address.	email
language	Customer language.	language
servicePin	Account service pin.	int
defaultRegistrant	Default registrant contact handle.	int
defaultAdmin	Default Admin-C contact handle.	int
defaultTech	Default Tech-C contact handle.	int
defaultBilling	Default billing contact handle.	int
defaultNsSet	Default nameserver set.	int
defaultWeb	Default web nameserver entry.	ip_host
defaultMail	Default mail nameserver entry.	ip_host
defaultImportNs	Import NS in case of domain transfer.	boolean
lastLogin	Date and time of last login.	dateTime
loginCount	Count of logins.	int
tfa	2-factor-authentication method.	tfaMethod
lastIp	Last accessed from IP.	ip
accountActive	Account active flag.	int
accountVerification	Account verification pending flag.	int

2.6.5. customer.listdownloads

List downloadable file tokens for the given customer.

2.6.5.1. Input

Table 2.77. Parameters

Parameter	Description	Type	Required	Default
type	Type of download to search for, e.g. 'gdpr'. If omitted, all downloads are returned.	text64	false

2.6.5.2. Output

Table 2.78. Parameters

Parameter	Description	Type
downloads
... token	Download token	text64
... created	Creation date of this download	datetime
... downloads	Amount 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.79. Parameters

Parameter	Description	Type	Required
kdnr	If given, update this customer and not yourself.	int	false
summaryInvoice	Customer receives summary invoice.	boolean	false
notificationEmail	Customer receives notification emails.	boolean	false
notificationQueue	Customer uses notification queue.	boolean	false
emailBilling	Customer billing email address.	email	false
emailAutomated	Customer email address for automated mails.	email	false
lowBalance	Customer low balance notification value.	float	false
bankAccHolder	Name of bank account holder.	token255	false
bankName	Name of bank.	token255	false
bankCode	Bank code (BIC).	token255	false
bankAccHolderNo	Bank account number (IBAN).	text64	false
vatNo	Customer company VAT id.	vatNo	false
whoisProvider	Default whois provider for customer.	token255	false
whoisUrl	Default whois URL.	token255	false