PlanListAvailableUpsales4SalesCategoryGet_API

Syntax

ListResult BM::PlanListAvailableUpsales4SalesCategoryGet_API(

  Int PlanID;

  Str(40) STType;

  Int CategoryID;

  Int AccountID;

  Int SortNo.

)

returns

  Int PlanID - up-sale service plan ID;

  Str(60) - up-sale service plan name;

  Str(1024) ShortDescription - up-sale service plan short description;

  Str(1024) LongDescription - up-sale service plan full description;

  Int CategoryID - sales category ID;

  Int GroupID - unique group ID, up-sale service plan included in;

  Int Included - always returns "0". The parameter is obsolete, left for compatibility with PBA versions 4.2.x and earlier;

  Int RecurringType - up-sale 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 - up-sale 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 - subscription billing period duration (if BillingPeriodType=2 and BillingPeriod=1, subscription billing period is 1 month);

  Int ShowPriority - signifies the priority in which the up-sale service plan is shown among other ones of the same sales category in the online store. The highest priority is 1, thus, service plan with such a priority is shown in the topmost left position in the online store;

  Int ChildLimit - maximum number of up-sale subscriptions set for up-sale category (Maximum Up-sale Subscriptions parameter).

Special Notes

• Int PlanID - parent service plan ID;
• Str(40) STType - name of service gate the up-sale service plans are provisioned through. To get up-sales provisioned through any service gate, pass an empty string;
• Int CategoryID - sales category ID, assigned to parent plan as an up-sale category. To get up-sales of all sales categories assigned, pass 0;
• Int AccountID - vendor account ID;
• Int SortNo.- defines how output data is sorted: 1 - the output is sorted by first column in ascending order, 1 - the output is sorted by second column in ascending order, etc. Negative value makes output sorted in descending order, for example: -1 - the output is sorted by first column (Plan ID) in descending order.

Please send us your feedback on this help page