Title: Delete a Customer Account via API  
PrimaryCategory: API  
Type: Procedural  
Tags: customer_deletion, api, request_parameters, authentication, response  
Source UI Terms: auth-userid, api-key, customer-id  
Source Reference: Delete a Customer Account via API  

Prerequisites:  
- Ensure the Customer has no active orders before deletion.  
- Have your Live Account Reseller Id.  
- Have your API key for authentication.  
- Know the Customer Id of the customer to delete.  

Steps:  
1) Prepare a POST API request to the endpoint:  
   `https://test.httpapi.com/api/customers/delete.json`  
2) Include the following required parameters in the query string or request body:  
   - `auth-userid` (Integer): Your Live Account Reseller Id.  
   - `api-key` (String): Your authentication API key.  
   - `customer-id` (Integer): The Customer Id to be deleted.  
3) Send the POST request.  
4) Check the API response:  
   - If the response returns `true` (Boolean), the customer account has been successfully deleted.  
   - If the response contains a `status` key with value `ERROR`, note the accompanying error message for troubleshooting.  

Warnings:  
- The customer cannot be deleted if they have any active orders; ensure all orders are inactive or completed.  

Summary:  
To delete a customer account via API, send a POST request with your reseller ID, API key, and the customer ID. The operation succeeds only if the customer has no active orders.  

Evaluation Pairs:  
Q: What parameters are required to delete a customer account using the API?  
A: You need `auth-userid` (your reseller ID), `api-key` (authentication key), and `customer-id` (the ID of the customer to delete).  

Q: Can a customer with active orders be deleted via this API?  
A: No, the customer must not have any active orders to be deleted.  

Q: What does the API response return upon successful deletion?  
A: It returns a Boolean `true` indicating the customer was deleted. If there is an error, it returns a `status` key with value `ERROR` and an error message.

<p>When you want to permanently remove a customer account using the API. This article explains the required parameters, API request format, and conditions required before deleting a customer account.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Deleting a Customer</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content"><a name="toc"></a>
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Deletes the specified Customer, if the Customer does not have any <em>Active</em> Order(s).</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Your Live Account Reseller Id</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">An alphanumeric code that can be used to authenticate your API calls </td></tr><tr><td colspan="1" rowspan="1">customer-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1"><strong>Customer Id</strong> of the Customer that you want to delete</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>POST</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/customers/delete.json?auth-userid=0&amp;api-key=key&amp;customer-id=0 </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns <em>true</em> (Boolean), if the specified Customer is deleted.</p>
<p>In case of any errors, a <strong>status</strong> key with value as <em>ERROR</em> alongwith an error message will be returned.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to permanently remove a customer account using the API. This article explains the required parameters, API request format, and conditions required before deleting a customer account.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	An alphanumeric code that can be used to authenticate your API calls
customer-id	Integer	Required	Customer Id of the Customer that you want to delete