reseller

is added when reseller has a customer specific business

Deleting a Customer

Description

Deletes the specified Customer, if the Customer does not have any Active Order(s).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer that you want to delete

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/customers/delete.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns true (Boolean), if the specified Customer is deleted.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Getting Customer Details By Username

Description

Gets the Customer details for the specified Customer Username.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
username String Required Username of the Customer

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/customers/details.json?auth-userid=0&api-key=key&[email protected]

Response

Returns a hash map containing the below details:

  • Customer Id (customerid)

  • Customer Username (username)

  • Reseller Id of the Parent Reseller (resellerid)

  • Name (name)

  • Company (company)

  • Email Address (useremail)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • First line of address of the Customer (address1)

  • Second line of address of the Customer (address2)

  • Third line of address of the Customer (address3)

  • City (city)

  • State (state)

  • Country Code (country)

  • ZIP Code (zip)

  • Personal Identification Number (pin)

  • Creation Date (creationdt)

  • Current Status (customerstatus)

  • Sales Contact Id (salescontactid)

  • Language Preference for the Control Panel and Emails (langpref)

  • Total Receipts (totalreceipts)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Executing an Order Without Payment

Description

Executes the pending actions against the specified Invoice Ids. You can also specify whether the Invoices need to be cancelled or kept pending.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
invoice-ids Array Of Integer Required Invoice Ids whose associated pending actions are to be executed
cancel-invoice Boolean Required

Indicates whether the Invoice needs to be cancelled or kept pending. Values can either be:

  • true - will cancel the Invoice and execute the action (to be used in cases where payment has been received through offline methods), or

  • false - will keep the Invoice pending and execute the action (for settlement upon receipt of payment at a later stage).

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/billing/execute-order-without-payment.xml?auth-userid=0&api-key=key&invoice-ids=0&invoice-ids=1&cancel-invoice=true

Response

Returns a hash map of executed actions containing the below details:

  • Invoice Id (invoiceid)

  • Order Id associated with the Invoice (51821176)

  • Customer Id associated with the Invoice (customerid)

  • Action Id of the Action associated with the Invoice (eaqid)

  • Action Type of the Action associated with the Invoice (actiontype)

  • Description of the Action associated with the Invoice (actiontypedesc)

  • Domain Name (description)

  • Status of the Action associated with the Invoice (actionstatus)

  • Description of the Action Status (actionstatusdesc)

  • Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Getting a Customer's Available Balance

Description

Gets the Available Balance of the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer whose Available Balance is to be fetched

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/billing/customer-balance.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns a hash map of the Customer's Available Balance containing the below details:

  • Selling Currency Symbol of the Parent Reseller (currencysymbol)

  • Available Balance Amount in the Selling Currency (sellingcurrencybalance)

  • Locked Amount in the Selling Currency (sellingcurrencylockedbalance)

  • Total Balance Amount in the Selling Currency (totalsellingbalance)

  • Available Balance Amount in the Accounting Currency (accountingcurrencybalance)

  • Locked Amount in the Accounting Currency (accountingcurrencylockedbalance)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Paying Customer Transactions

Description

Allows to pay Customer's Invoices and / or Debit Notes specified. Atleast one of the parameters (Invoice Id or Debit Note Id) needs to be provided. The Invoices and Debit Notes would be settled only if the Customer has sufficient funds.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
invoice-ids Array Of Integer Required Invoice Ids that are to be settled
debit-ids Array Of Integer Required Debit Note Ids that are to be settled

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/billing/customer-pay.xml?auth-userid=0&api-key=key&invoice-ids=0&invoice-ids=1&debit-ids=0&debit-ids=1

Response

Returns a hash map of the specified Transactions (Invoices and / or Debit Notes) containing the below details:

  • Invoice Id (invoiceid)

  • Action Type (actiontype)

  • Description of the Action (actiontypedesc)

  • Action Id of the Action (eaqid)

  • Customer Id associated with the Transaction (customerid)

  • Action Status (actionstatus)

  • Description of the Action Status (actionstatusdesc)

  • Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Getting Transaction Details of a Customer

Description

Gets a Customer's Transactions along with their details.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
transaction-ids Array of Integer Required Transaction Ids of the Transactions whose details are to be fetched

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/billing/customer-transactions.json?auth-userid=0&api-key=key&transaction-ids=0&transaction-ids=1

Response

Returns a hash map of the Customer's Transactions containing the below details:

  • Transaction Id (transid)

  • Order Id (orderid)

  • Transaction Key (transactionkey)

  • Transaction Date (transactiondate)

  • Transaction Type (type)

  • Transaction Description (description)

  • Product Key (key)

  • Transaction Settlement Date (timestamp)

  • Whether Total Receipts is updated due to the Transaction (totalreceiptupdated)

  • Transaction Cancellation Date - Applicable to Invoices (invoicecancellationdate)

  • Payment Reminder Days (paymentreminderdays)

  • Last Reminder Sent Date (lastreminder)

  • Whether Transaction is Greedy (greedy)

  • Whether the Transaction Description can be modified (isDescriptionModifiable)

  • Customer Id Associated with the Transaction (customerid)

  • Reseller Chain by RID (parentkey)

  • Customer Details (customer_name, customer_company, customer_address1, customer_city, customer_state, customer_country, customer_zip, customer_telnocc, customer_telno)

  • Reseller Id of the Customer's Parent Reseller (resellerid)

  • Parent Reseller Details (reseller_name,reseller_company, brandname, reseller_address1, reseller_city, reseller_state, reseller_country, reseller_zip, reseller_telnocc, reseller_telno)

  • Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Applicable Tax Amount in the Selling Currency (sellingtaxamount)

  • Transaction Amount without Tax in the Selling Currency (sellingamountwithouttax)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Accounting Currency Symbol of the Parent Reseller (accountingcurrencysymbol)

  • Transaction Amount in the Accounting Currency (accountingamount)

  • Applicable Tax Amount in the Accounting Currency (accountingtaxamount)

  • Transaction Amount without Tax in the Accounting Currency (accountingamountwithouttax)

  • Unutilised Transaction Amount in the Accounting Currency (unutilisedaccountingamount)

  • Applicable Tax Rule Id (taxruleid)

  • Foreign Exchange Difference (forexdiff)

  • Whether Transaction Notification is to be sent to the Customer (sendcustomernotification)

  • Whether Transaction Notification is to be sent to the Parent Reseller (sendresellernotification)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Getting the Customer Pricing

Description

Gets the generic Customer Pricing or a particular Customer's Cost Price if the Customer ID is provided.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Optional Customer ID of the Customer whose Cost Price has to be retrieved. By default, generic Customer Pricing will be retrieved.

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/products/customer-price.json?auth-userid=0&api-key=key

Response

Returns a hash map with the generic Customer Pricing or the specified Customer's Cost Price. The response structure will be:

Domain Names (TLDs)


"productkey":
{
"action-name":
{
"tenure-in-years":"price"
}
}

Example:


"dotnet":
{
"addtransferdomain":
{
"1":"0.0"
},
"restoredomain":
{
"1":"0.0"
},
"addnewdomain":
{
"1":"0.0"
},
"renewdomain":
{
"1":"0.0"
}
}

Web Services


"hosting":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":0.0
}
}

Example:


"hosting":
{
"0":
{
"renew":
{
"12":0.0,
"24":0.0
},
"ssl":0.0,
"add":
{
"12":0.0,
"24":0.0
}
},
"1":
{
"renew":
{
"12":0.0,
"24":0.0
},
"add":
{
"12":0.0,
"24":0.0
}
}
}

Single Domain Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"singledomainhostinglinuxus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Multi Domain Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Reseller Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Subscribe to reseller