|
|
|
|
|
|
Parameters |
|
Description |
Passed |
Returned |
Method returns details for specified service plan. |
1 |
15 |
Syntax
ItemResult BM::PlanDetailsGet_API(
Int PlanID.
)
returns
Int PlanID - requested service plan ID;
Str(60) Name - service plan name;
Int CategoryID - ID of the plan category assigned to the requested service plan;
Int CurrencyID - ID of the default provider's currency;
Str(1024) ShortDescription - requested service plan short description;
Str(1024) LongDescription - requested service plan long description.
Str(40) GateName - type of service. Identified by name of gate service is provisioned through (DOMAINGATE, PEMGATE, etc);
Int GroupID - ID of the unique group assigned to the requested service plan.
Int IsParentReq - signifies whether parent subscription is required for this type of service (0 - No, 1 - Yes). Some domain subscriptions require hosting subscription to be specified as parent one;
Int RecurringType - signifies how recurring fee is charged for subscription (10 - before billing period; 20 - after billing period; 30 - before subscription period; 40 - at the end of month);
Int BillingPeriodType - subscription billing period type (4 - monthly on statement cycle date, 2 - fixed number of months, 3 - fixed number of years);
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 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 Default_PlanPeriodID - ID of the subscription period that is automatically selected when customer orders the plan 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 - ID of the requested service plan.