Schemas

Download schema

GenericResponse

message

string

path

string

status

integer · int32

customLogMessage

UpdateCustomerRequest

Modifies the Account details of the specified Customer.

username

string · minLength: 1 · required

Username for the Customer account. Username should be an email address.

name

string · minLength: 1 · required

Name of the Customer

company

string · minLength: 1 · required

Company name of the Customer

languagePreference

string · minLength: 1 · required

Language Code as per ISO

addressLine1

string · minLength: 1 · required

Address line 1 of the Customer's address

city

string · minLength: 1 · required

City

state

string · minLength: 1 · required

State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable .

country

string · minLength: 1 · required

Country Code as per ISO 3166-1 alpha-2

zipcode

string · minLength: 1 · required

ZIP code

phoneCountryCode

string · minLength: 1 · required

Phone number Country Code

phone

string · minLength: 1 · required

Phone number

addressLine2

string

Address line 2 of the customer's address

addressLine3

string

Address line 3 of the Customer's address

otherState

string

This parameter needs to be included if the State information is not available. Mention an appropriate value for this parameter.

altPhoneCountryCode

string

Alternate phone Country Code

altPhone

string

Alternate phone number

faxCountryCode

string

Fax number Country Code

fax

string

Fax number

mobileCountryCode

string

Mobile country code

mobile

string

Mobile number

vatId

string

VAT ID for EU VAT

indianServiceTaxId

string

Indian Service Tax Id.

indianGstId

string

GST ID for Indian customer

russiaVatId

string

VAT ID for Russian customer

australiaGstId

string

GST ID for Australia customer

newzealandGstId

string

GST ID for New Zealand customer

singaporeGstId

string

GST ID for Singapore customer

smsConsent

boolean

Boolean. SMS consent. Possible values are true or false.

UpdateCustomerSuspensionRequest

Suspends or unsuspends a customer account.

suspended

boolean · required

When true, suspends the customer; when false, unsuspends.

reason

string

Suspension reason (required when suspended is true).

CreateCustomerRequest

Creates a Customer Account using the details provided.

username

string · minLength: 1 · required

Username for the Customer Account. Username should be an email address.

password

string · minLength: 1 · required

Password for the Customer Account. Note Password related information

name

string · minLength: 1 · required

Name of the Customer

company

string · minLength: 1 · required

Name of the Customer's company

addressLine1

string · minLength: 1 · required

Address line 1 of the Customer's address

city

string · minLength: 1 · required

City

state

string · minLength: 1 · required

State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable .

country

string · minLength: 1 · required

Country Code as per ISO 3166-1 alpha-2

zipcode

string · minLength: 1 · required

ZIP code

phoneCountryCode

string · minLength: 1 · required

Telephone number Country Code

phone

string · minLength: 1 · required

Phone number

addressLine2

string

Address line 2 of the Customer's address

addressLine3

string

Address line 3 of the Customer's address

otherState

string

This parameter needs to be included if the State information is not available. Mention an appropriate value for this parameter.

altPhoneCountryCode

string

Alternate phone country code

altPhone

string

Alternate phone number

faxCountryCode

string

Fax number country code

fax

string

Fax number

languagePreference

string

Language Code as per ISO

mobileCountryCode

string

Mobile country code

mobile

string

Mobile number

vatId

string

VAT ID for EU VAT

indianServiceTaxId

string

Indian Service Tax Id.

indianGstId

string

Indian Gst Id.

salesTaxExemptionId

string

Sales Tax Exemption Id.

russiaVatId

string

Russia Vat Id.

australiaGstId

string

Australia Gst Id.

newzealandGstId

string

Newzealand Gst Id.

singaporeGstId

string

Singapore Gst Id.

paraguayTaxId

string

Paraguay Tax Id.

dontSendSignupEmail

boolean

Boolean. Dont Send Signup Email. Possible values are true or false.

smsConsent

boolean

Boolean. In case of a US based customer, consent is required to receive renewal reminder SMSes. Possible values are true or false.

acceptPolicy

boolean

Boolean. Accept Terms and Conditions and Privacy Policy to create an account. Possible values are true or false.

marketingEmailConsent

boolean

Boolean. In case of EEA (European Economic Area) countries capture consent to receive marketing emails. Possible values are true or false.

ChangeCustomerPasswordRequest

Changes the password for the specified Customer.

newPassword

string · minLength: 8 · maxLength: 15 · required

Must be 8-15 characters and contain at least one letter and one digit. Symbols are permitted.

CustomerSearchResultDto

Customer summary in search results.

customerId

string

Customer identifier

username

string

Username

name

string

Name

company

string

Company

email

string

city

string

City

country

string

Country

customerStatus

string

Customer status

totalReceipts

string

Total receipts

phone

string

phoneCountryCode

string

resellerId

string

websiteCount

string

CustomerProfileDto

Customer profile fields.

customerId

string

Customer identifier

username

string

Customer username (email)

resellerId

string

Reseller identifier

parentId

string

Parent customer identifier

name

string

Customer name

company

string

Company name

email

string

Email address

phoneCountryCode

string

Phone country code

phone

string

Phone number

mobileCountryCode

string

Mobile country code

mobile

string

Mobile number

altPhoneCountryCode

string

Alternate phone country code

altPhone

string

Alternate phone number

faxCountryCode

string

Fax number country code

fax

string

Fax number

indianGstId

string

Indian GST identification number

addressLine1

string

Address line 1

addressLine2

string

Address line 2

addressLine3

string

Address line 3

city

string

City

state

string

State or province

stateId

string

State identifier

country

string

Country code

zipcode

string

Postal or ZIP code

pin

string

PIN code

creationDate

string

Account creation date

customerStatus

string

Customer account status

salesContactId

string

Sales contact identifier

salesRepresentative

string

Sales representative display name

languagePreference

string

Language preference

totalReceipts

string

Total receipts amount

isDominicanTaxConfiguredByParent

boolean

Boolean. Whether Dominican tax is configured by the parent reseller. Possible values are true or false.

vatId

string

VAT or tax identification number for the customer

otherState

string

Alternate or supplemental state/province value in responses

CustomerSalesPersonDto[]

Sales persons associated with the customer account

rncId

string

ncfType

string

dominicanRepublicTaxDisplayName

string

CustomerSalesPersonDto

Sales person entry associated with a customer account.

salesPersonId

string

Sales person identifier

name

string

Sales person display name

CustomerOrderSummaryDto

Order summary in customer order list.

orderId

string

Order identifier

customerId

string

Customer identifier

resellerId

string

Reseller identifier

entityTypeId

string

Entity type identifier

entityTypeKey

string

Entity type key

entityTypeName

string

Entity type display name

productKey

string

Product key

productCategory

string

Product category code

productCategoryLabel

string

Product category display label

domainName

string

Domain name associated with the order

domainNameUnicode

string

Unicode domain name

status

string

Current order status

creationDate

string

Order creation time

endTime

string

Order end time

deletionTime

string

Scheduled deletion time

daysToExpiry

string

Days until expiry

daysToDeletion

string

Days until deletion

parentKey

string

Parent key

tenureOfLastActionPerformed

string

Tenure of the last action performed

recurring

boolean

Boolean. Whether the order is recurring. Possible values are true or false.

ChangeCustomerPasswordResponse

Indicates whether the customer password was changed successfully.

success

boolean

Whether the password was changed

CreateCustomerResponse

Returns the identifier of the newly created customer account.

customerId

string

Newly created customer identifier

DeleteCustomerResponse

Returns the result of deleting the customer account, including action tracking metadata.

actionStatus

string

Action status

actionStatusDesc

string

Action status description

actionTypeDesc

string

Action type description

entityId

string

Entity identifier

eaqId

string

Action queue identifier

actionType

string

Action type

value

string

GetCustomerResponse

Returns the customer profile for the requested account.

CustomerProfileDto

Customer profile

passwordExpired

boolean

Boolean. Whether the password has expired. Possible values are true or false.

twoFactorAuthEnabled

boolean

Boolean. Whether two-factor authentication is enabled. Possible values are true or false.

twoFactorGoogleAuthEnabled

boolean

Boolean. Whether Google two-factor authentication is enabled. Possible values are true or false.

twoFactorSmsAuthEnabled

boolean

Boolean. Whether SMS two-factor authentication is enabled. Possible values are true or false.

actionStatus

string

Action status

actionStatusDesc

string

Action status description

actionTypeDesc

string

Action type description

entityId

string

Entity identifier

eaqId

string

Action queue identifier

actionType

string

Action type

status

string

Operation status

message

string

Status message

ListCustomerOrdersResponse

Returns orders for the customer, with pagination.

totalItems

integer · int32

Total matching records

totalPages

integer · int32

Total number of pages

itemsOnPage

integer · int32

Records on this page

CustomerOrderSummaryDto[]

Customer orders

status

string

Operation status

message

string

Status message

SearchCustomersResponse

Returns customers matching the search criteria, with pagination.

totalItems

integer · int32

Total matching records

itemsOnPage

integer · int32

Records on this page

CustomerSearchResultDto[]

Customer search results

UpdateCustomerResponse

Returns the result of updating the customer profile, including action tracking metadata.

success

boolean

Status of the operation

UpdateCustomerSuspensionResponse

Result of suspending or unsuspending a customer account.

success

boolean

Status

UpdateCustomerRequest

Modifies the Account details of the specified Customer.

username

string · minLength: 1 · required

Username for the Customer account. Username should be an email address.

name

string · minLength: 1 · required

Name of the Customer

company

string · minLength: 1 · required

Company name of the Customer

languagePreference

string · minLength: 1 · required

Language Code as per ISO

addressLine1

string · minLength: 1 · required

Address line 1 of the Customer's address

city

string · minLength: 1 · required

City

state

string · minLength: 1 · required

State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable .

country

string · minLength: 1 · required

Country Code as per ISO 3166-1 alpha-2

zipcode

string · minLength: 1 · required

ZIP code

phoneCountryCode

string · minLength: 1 · required

Phone number Country Code

phone

string · minLength: 1 · required

Phone number

addressLine2

string

Address line 2 of the customer's address

addressLine3

string

Address line 3 of the Customer's address

otherState

string

This parameter needs to be included if the State information is not available. Mention an appropriate value for this parameter.

altPhoneCountryCode

string

Alternate phone Country Code

altPhone

string

Alternate phone number

faxCountryCode

string

Fax number Country Code

fax

string

Fax number

mobileCountryCode

string

Mobile country code

mobile

string

Mobile number

vatId

string

VAT ID for EU VAT

indianServiceTaxId

string

Indian Service Tax Id.

indianGstId

string

GST ID for Indian customer

russiaVatId

string

VAT ID for Russian customer

australiaGstId

string

GST ID for Australia customer

newzealandGstId

string

GST ID for New Zealand customer

singaporeGstId

string

GST ID for Singapore customer

smsConsent

boolean

Boolean. SMS consent. Possible values are true or false.

CreateCustomerRequest

Creates a Customer Account using the details provided.

username

string · minLength: 1 · required

Username for the Customer Account. Username should be an email address.

password

string · minLength: 1 · required

Password for the Customer Account. Note Password related information

name

string · minLength: 1 · required

Name of the Customer

company

string · minLength: 1 · required

Name of the Customer's company

addressLine1

string · minLength: 1 · required

Address line 1 of the Customer's address

city

string · minLength: 1 · required

City

state

string · minLength: 1 · required

State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable .

country

string · minLength: 1 · required

Country Code as per ISO 3166-1 alpha-2

zipcode

string · minLength: 1 · required

ZIP code

phoneCountryCode

string · minLength: 1 · required

Telephone number Country Code

phone

string · minLength: 1 · required

Phone number

addressLine2

string

Address line 2 of the Customer's address

addressLine3

string

Address line 3 of the Customer's address

otherState

string

This parameter needs to be included if the State information is not available. Mention an appropriate value for this parameter.

altPhoneCountryCode

string

Alternate phone country code

altPhone

string

Alternate phone number

faxCountryCode

string

Fax number country code

fax

string

Fax number

languagePreference

string

Language Code as per ISO

mobileCountryCode

string

Mobile country code

mobile

string

Mobile number

vatId

string

VAT ID for EU VAT

indianServiceTaxId

string

Indian Service Tax Id.

indianGstId

string

Indian Gst Id.

salesTaxExemptionId

string

Sales Tax Exemption Id.

russiaVatId

string

Russia Vat Id.

australiaGstId

string

Australia Gst Id.

newzealandGstId

string

Newzealand Gst Id.

singaporeGstId

string

Singapore Gst Id.

paraguayTaxId

string

Paraguay Tax Id.

dontSendSignupEmail

boolean

Boolean. Dont Send Signup Email. Possible values are true or false.

smsConsent

boolean

Boolean. In case of a US based customer, consent is required to receive renewal reminder SMSes. Possible values are true or false.

acceptPolicy

boolean

Boolean. Accept Terms and Conditions and Privacy Policy to create an account. Possible values are true or false.

marketingEmailConsent

boolean

Boolean. In case of EEA (European Economic Area) countries capture consent to receive marketing emails. Possible values are true or false.

CustomerSearchResultDto

Customer summary in search results.

customerId

string

Customer identifier

username

string

Username

name

string

Name

company

string

Company

email

string

city

string

City

country

string

Country

customerStatus

string

Customer status

totalReceipts

string

Total receipts

phone

string

phoneCountryCode

string

resellerId

string

websiteCount

string

CustomerProfileDto

Customer profile fields.

customerId

string

Customer identifier

username

string

Customer username (email)

resellerId

string

Reseller identifier

parentId

string

Parent customer identifier

name

string

Customer name

company

string

Company name

email

string

Email address

phoneCountryCode

string

Phone country code

phone

string

Phone number

mobileCountryCode

string

Mobile country code

mobile

string

Mobile number

altPhoneCountryCode

string

Alternate phone country code

altPhone

string

Alternate phone number

faxCountryCode

string

Fax number country code

fax

string

Fax number

indianGstId

string

Indian GST identification number

addressLine1

string

Address line 1

addressLine2

string

Address line 2

addressLine3

string

Address line 3

city

string

City

state

string

State or province

stateId

string

State identifier

country

string

Country code

zipcode

string

Postal or ZIP code

pin

string

PIN code

creationDate

string

Account creation date

customerStatus

string

Customer account status

salesContactId

string

Sales contact identifier

salesRepresentative

string

Sales representative display name

languagePreference

string

Language preference

totalReceipts

string

Total receipts amount

isDominicanTaxConfiguredByParent

boolean

Boolean. Whether Dominican tax is configured by the parent reseller. Possible values are true or false.

vatId

string

VAT or tax identification number for the customer

otherState

string

Alternate or supplemental state/province value in responses

CustomerSalesPersonDto[]

Sales persons associated with the customer account

rncId

string

ncfType

string

dominicanRepublicTaxDisplayName

string

CustomerOrderSummaryDto

Order summary in customer order list.

orderId

string

Order identifier

customerId

string

Customer identifier

resellerId

string

Reseller identifier

entityTypeId

string

Entity type identifier

entityTypeKey

string

Entity type key

entityTypeName

string

Entity type display name

productKey

string

Product key

productCategory

string

Product category code

productCategoryLabel

string

Product category display label

domainName

string

Domain name associated with the order

domainNameUnicode

string

Unicode domain name

status

string

Current order status

creationDate

string

Order creation time

endTime

string

Order end time

deletionTime

string

Scheduled deletion time

daysToExpiry

string

Days until expiry

daysToDeletion

string

Days until deletion

parentKey

string

Parent key

tenureOfLastActionPerformed

string

Tenure of the last action performed

recurring

boolean

Boolean. Whether the order is recurring. Possible values are true or false.

DeleteCustomerResponse

Returns the result of deleting the customer account, including action tracking metadata.

actionStatus

string

Action status

actionStatusDesc

string

Action status description

actionTypeDesc

string

Action type description

entityId

string

Entity identifier

eaqId

string

Action queue identifier

actionType

string

Action type

value

string

GetCustomerResponse

Returns the customer profile for the requested account.

CustomerProfileDto

Customer profile

passwordExpired

boolean

Boolean. Whether the password has expired. Possible values are true or false.

twoFactorAuthEnabled

boolean

Boolean. Whether two-factor authentication is enabled. Possible values are true or false.

twoFactorGoogleAuthEnabled

boolean

Boolean. Whether Google two-factor authentication is enabled. Possible values are true or false.

twoFactorSmsAuthEnabled

boolean

Boolean. Whether SMS two-factor authentication is enabled. Possible values are true or false.

actionStatus

string

Action status

actionStatusDesc

string

Action status description

actionTypeDesc

string

Action type description

entityId

string

Entity identifier

eaqId

string

Action queue identifier

actionType

string

Action type

status

string

Operation status

message

string

Status message

ListCustomerOrdersResponse

Returns orders for the customer, with pagination.

totalItems

integer · int32

Total matching records

totalPages

integer · int32

Total number of pages

itemsOnPage

integer · int32

Records on this page

CustomerOrderSummaryDto[]

Customer orders

status

string

Operation status

message

string

Status message