|
|
|
|
|
|
Parameters |
||||
Description |
Passed |
Returned |
|||
Method returns properties of service plan resource rates purchased under at least one of subscriptions. Method returns result only for active, trial, or ordered subscriptions. Method does not return any resource usage statistics. |
4 |
24 |
|||
Table below illustrates method invocation result for three different cases:
|
|||||
Plan ID |
Subscription ID |
Subscription status |
Resource rate ID |
Result |
|
1 |
1000001 |
Terminated |
1,2,5 |
Empty |
|
1000002 |
Terminated |
2 |
|||
2 |
none |
|
|
Empty |
|
3
|
1000003 |
Active |
1,2,3 |
Details for resource rates ID 1,2,3, and 4
|
|
1000004 |
Ordered |
3,4 |
|||
1000005 |
Terminated |
3,4,5,6 |
|||
Syntax
ListResult BM::PlanRateListGet_API(
Int PlanID;
Int SortNo;
Int Reserved1;
Int Reserved2.
)
returns
Int ID - resource rate ID;
Str Name - resource rate name;
Str Description - resource rate description;
Double Included Value - resource included value;
Double Upper Limit - resource upper limit;
Double Lower Limit - resource lower limit;
Str Unit of Measure - resource unit of measure;
Double Setup Fee - resource setup fee;
Double Recurring Fee - resource recurring fee;
Int Measurable - signifies if resource is measurable ("1") or not ("0");
Int ResourceID - resource ID;
Str SetupFeeDescr - setup fee description, shown in CP and online store;
Str RecurrFeeDescr - recurring fee description, shown in CP and online store;
Int IsVisible - signifies if resource rate is shown in CP ("1") or not("0");
Int IsMain - signifies if resource rate is shown in store ("1") or not("0");;
Str StoreText - resource description shown in store;
Int IsSFperUnit - signifies if setup fee is changed per unit ("1") or not ("0");
Int IsRFperUnit - signifies if recurring fee is changed per unit ("1") or not ("0");
Int IsSFforUpgrade - signifies if upgrade fee is changed per unit ("1") or not ("0");
Str StorePriceText - resource price text shown in store (i.e. "5 Gb / month");
Int ResourceCategoryID - ID of resource category resource is included to;
Int SortOrder - sort order of resource in store;
Str Radio Group Name - used for licensed services mostly. If resource has at least one required and one conflicting resource (configured under Depends On tab of resource), two conflicting resources are displayed as option buttons group and required resource name is taken as the group name;
Str Parent Resource Name - parent resource name if resource depends on another resource (common for licensed services);
Special Notes