Title: Get Active Product Plan Details Using the API
PrimaryCategory: API
Type: Informational
Tags: api, product plan, authentication, get method, reseller
Source UI Terms: None
Source Reference: Get Plan Details

Key Info:
This API endpoint retrieves details of all active product plans for a reseller. It requires authentication parameters and allows an optional product key to fetch details for a specific product.

Parameters:

| Name         | Data Type | Required / Optional | Description                                       |
|--------------|-----------|---------------------|-------------------------------------------------|
| auth-userid  | Integer   | Required            | Authentication Parameter                         |
| api-key      | String    | Required            | Authentication Parameter                         |
| product-key  | String    | Optional            | Product key of the product for which details are to be fetched |

HTTP Method:
GET

Example Test URL:
```
https://test.httpapi.com/api/products/plan-details.json?auth-userid=0&amp;api-key=key
```

Response:
The API returns a map containing details of all the reseller&#39;s product plans.

Summary:
This API call retrieves detailed information about all active product plans for a reseller, requiring authentication and optionally filtering by product key.

Evaluation Pairs:
Q: What parameters are required to retrieve active product plan details using the API?  
A: You must provide &#39;auth-userid&#39; (Integer) and &#39;api-key&#39; (String) as authentication parameters; &#39;product-key&#39; is optional.

Q: What HTTP method is used to get active product plan details?  
A: The GET method is used.

Q: Can you retrieve details for a specific product plan using this API?  
A: Yes, by providing the optional &#39;product-key&#39; parameter you can fetch details for a specific product plan.

<p>When you want to retrieve the details of active product plans using the API. This article explains the required authentication parameters, optional product key input, and product plan response information.</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">Get Plan Details</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content">
<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>Gets the details of the all active product plans of the Reseller.</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">Authentication Parameter</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">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">product-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Product key of the product for which the details are to be fetched</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>GET</p>
<h2><a name="heading_3"></a>Example Test URL</h2>
<p><code>https://test.httpapi.com/api/products/plan-details.json?auth-userid=0&amp;api-key=key</code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns a map with the details of all the product plan of the Reseller.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to retrieve the details of active product plans using the API. This article explains the required authentication parameters, optional product key input, and product plan response information.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
product-key	String	Optional	Product key of the product for which the details are to be fetched