Knowledge Base
Categories: Website Builder API
Get the Modify or Upgrade Price for a Web Services Order Using the API
When you want to retrieve the applicable modify or upgrade price for a Web Services order using the API. This article explains the required authentication parameters, order and plan inputs, tenure details, and upgrade pricing response information. .
Description
Gets the applicable modify/upgrade price for a particular Web Services Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The OrderId for which the details are to be fetched. |
| new-plan-id | Integer | Required | The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method. |
| months | Integer | Required | The number of months (tenure) in the new plan for which the Order to be placed. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/webservices/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0
Response
Returns the applicable modify/ upgrade price for a particular Web Services Order.
Example:
{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"modifyCostResult":"upgrade",
"remainingmonths":0,
"currentOrderPrice":0.0
}
where
-
currentOrderPrice: The current pricing of the Order for remaining months.
-
modifiedOrderPrice: New applicable pricing of the Order as per the new plan.
-
upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice
Did you find this article helpful?