| Required role: | Admin |
| POST | /R_CreatePlanRequest | ||
|---|---|---|---|
| OPTIONS | /R_CreatePlanRequest |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | body | string | No | |
| Description | body | string | No | |
| PriceDescription | body | string | No | |
| CurrencyTypeId | body | long | No | |
| PlanStatus | body | long | No | |
| BillingStructureId | body | long | No | |
| PriceList | body | List<R_Price> | No | |
| Validate | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Requester | form | string | No | Identity of the caller |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlanId | form | long? | No | |
| PromoId | form | long? | No | |
| Description | form | string | No | |
| PriceTypeId | form | long | No | |
| Value | form | decimal | No | |
| Interval | form | int | No | |
| IntervalTypeId | form | long | No | |
| CurrencyTypeId | form | long | No | |
| IncludeInRegularBill | form | bool | No | |
| IncludeInTrialBill | form | bool | No | |
| Id | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlanId | form | long | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/R_CreatePlanRequest HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: application/json
Content-Length: length
{"Name":"String","Description":"String","PriceDescription":"String","CurrencyTypeId":0,"PlanStatus":0,"BillingStructureId":0,"PriceList":[{"PlanId":0,"PromoId":0,"Description":"String","PriceTypeId":0,"Value":0,"Interval":0,"IntervalTypeId":0,"CurrencyTypeId":0,"IncludeInRegularBill":false,"IncludeInTrialBill":false,"Id":0}],"Validate":false,"Requester":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"PlanId":0}