Getting Promo Prices
Knowledge Base
Categories: Billing & Transactions API
Get Reseller Promo Pricing Details Using the API
When you want to retrieve promotional pricing details configured for a reseller account. This article explains the API request format and response details for promo pricing, validity period, customer pricing, reseller pricing, and supported promotional actions.
Description
Gets the Reseller's Promo prices.
Note
It is recommended you cache all pricing information to ensure you do not have to send API queries to the platform. As there are a huge number of products, the accompanying data may cause longer wait time than usual.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/resellers/promo-details.json?auth-userid=0&api-key=key
Response
Returns a hash map containing the below details:
For the description of the parameters,
- Reseller Id (resellerid)
- Product Key (productkey)
- Promo Start Time (starttime)
- Promo End Time (endtime)
- Promo Period (period)
- Promo Price to Sub-Reseller (resellerpriceone)
- Non-Promo Price to Sub-Reseller (resellerpricetwo)
- Customer Price (customerprice)
- Barrier Price (barrierprice)
- Price Applicable to the Reseller (resellerprice)
- Currency Symbol of the Price Applicable to the Reseller (resellerpricecurrencysymbol)
- Type of Action the Promo is Applicable for (actiontype)
- Selling Currency of the Registration Service Provider (serviceprovidersellingcurrency)
- Promo Status (isactive)
- Whether the Promo can be trickled down the Sub-Reseller chain (istrickleallow)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Did you find this article helpful?