|
|
|
|
|
|
Parameters |
|
Description |
Passed |
Returned |
Method returns the list of available up-sale plans for specified subscription. |
5 |
12 |
Syntax
ListResult BM::PlanListUpsaleGetForSubscription_API(
Int SubscriptionID_1;
...
Int SubscriptionID_N.
)
returns
Int SubscriptionID - ID of requested subscription;
Int PlanID - ID of up-sale service plan;
Str(60) Name - 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 up-sale service plan belongs to;
Int GroupID - ID of unique group service plan is included in;
Int ShowPriority - defines the priority in which the 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 UpsellsLeft - number of available subscriptions left. It is calculated as maximum number of up-sale subscriptions set for up-sale category (Maximum Up-sale Subscriptions parameter) minus up-sale subscriptions sold.
Special Notes
Int SubscriptionID - subscription ID.