PlanPeriodDetailsGet_API

Syntax

ItemResult BM::PlanPeriodDetailsGet_API(

  Int PlanPeriodID.

)

returns

  Int PlanPeriodID - service plan subscription period ID;

  Int PlanID - service plan ID;

  Int Period - subscription period duration (for example, 1 if subscription period is 1 year);

  Int PeriodType - subscription period type: 0 - Hour(s), 1 - Day(s), 2 - Month(s), 3 - Year(s);

  Int Trial - whether subscription period is trial (free): 0 - No, 1 - Yes;

  Double SetupFee - subscription setup fee. It is initial and one time charge which is taken for subscription for this plan;

  Double SubscriptionFee - subscription recurring fee. It is taken once a billing period;

  Double RenewalFee - subscription renewal fee. It is charged for subscription renewal;

  Double TransferFee - subscription transfer fee. It is charged for domain transfer and relevant for domain plans only;

  Double NonRefundableAmt - subscription non-refundable amount. The sum is not refunded to customer when refund is claimed (on subscription cancellation, for example);

  Int RefundPeriod - subscription refund period duration in days (for example, 5 if refund period is 5 days). During refund period customer can cancel his subscription and get all money back, except non-refundable amount;

  Int Enabled - whether subscription period is active : 0 - No, 1 - Yes;

  Int NumberOfPeriods - number of billing periods within subscription period. This parameter is calculated automatically and depends on Billing Period Type parameter of service plan. For example, if Billing Period Type is "Fixed Number of Months" and subscription period is 2 years long, there will be 24 billing periods, meaning customer will be charged recurring fee 24 times;

  Str(1024) FeeText - text displayed as description of period fees, for example "$9.99 setup + $18/month";

  Int SortNumber - order in which subscription periods are shown in online store and CP: "1" - on top, "2" - below it, etc.

Special Notes

Int PlanPeriodID - ID of requested subscription period.

Please send us your feedback on this help page