|
|
|
|
|
|
Parameters |
|
Description |
Passed |
Returned |
Method returns details of specified service plans. |
1 or more |
15 |
Syntax
ListResult BM::PlanListGet_API(
Int PlanID_1;
...
Int PlanID_N.
)
returns
Int PlanID - service plan ID;
Str Name - service plan name;
Str ShortDescription - service plan short description;
Str LongDescription - service plan long description;
Int PlanCategoryID - ID of service plan plan category;
Str STType - name of service gate the service plan is provisioned through;
Int IsPublished - signifies if service plan is published of not: "0" - published, "1" - not published;
Int GroupID - ID of unique group service plan belongs to;
Int RecurringType - service plan recurring fee collection method (Charge for Subscription parameter): "10" - before billing period; "20" - after billing period; "30" - before subscription period; "40" - in the end of month;
Int BillingPeriodType - service plan billing period type: "2" - billing period is a fixed number of months; "3" - billing period is a fixed number of years; "4" - subscription is billed monthly on statement cycle date;
Int BillingPeriod - service plan billing period;
Int IsParentReq - signifies if parent subscription is required for this type of service (0 - No, 1 - Yes). Parent subscription is required if service plan is sold as up-sale to another one;
Int ShowPriority - order number of service plan in online store;
Int Default_PlanPeriodID - ID of default subscription period of service plan. Used in online store.
Int IsOTFI - signifies whether services of this plan are sold without subscription creation (0 - No, 1 - Yes), namely whether the plan is one time fee one.
Special Notes
Int PlanID - requested service plan ID.