SubscriptionWithIDAdd_API

Syntax

ErrorMessage BM::SubscriptionWithIDAdd_API(

  Int SubscriptionID;

  Int ParentID;

  Str(40) SubscriptionName;

  Int Status;

  Int ServStatus;

  Int startDate;

  Int ExpirationDate;

  Int AccountID;

  Int PlanID;

  Int Period;

  Int PeriodType;

  Double SetupFee;

  Double SubscriptionFee;

  Double RenewalFee;

  Double TransferFee;

  Double NonRefundableAmt;

  Int RefundPeriod;

  Int BillingPeriodType;

  Int BillingPeriod;

  Int LastBillDate;

  Int NextBillDate.

)

returns

    Str ErrorMessage -  message after subscription has been added: "Subscription is added."

Special Notes

• Int SubscriptionID - subscription ID;
• Int ParentID - ID of the parent subscription, if there is no parent subscription, pass NULL (-2147483648);
• Str(40) SubscriptionName - new subscription name;
• Int Status - parent subscription status (10 - Ordered, 15 - Trial, 30 - Active, 40 - Graced, 50 - Expired, 60 - terminated, 70 - Canceled, 80 - Suspended);
• Int ServStatus - parent subscription service status (10 - ''Not Provisioned'', 20 - ''Provisioning'', 30 - ''Stopped'', 40 - ''Starting'', 50 - ''Running'', 60 - ''Stopping'', 70 - ''Removing'', 80 - ''Changing Plan'', 90 - ''Removed'');
• Str StartDate - the date of the parent subscription start in Unix date format;
• Str ExpirationDate - expiration date of the parent subscription in Unix date format. Expiration Date = Start Date + Subscription Period;
• Int AccountID - ID of the customer account;
• Int PlanID - ID of subscription service plan;
• 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);
• Double SetupFee - subscription setup fee;
• Double SubscriptionFee - subscription recurring fee;
• Double RenewalFee - subscription renewal fee;
• Double TransferFee - subscription transfer fee;
• Double NonRefundableAmt subscription non refundable sum;

  Note: fees for subscription are passed in "00.00" format and provider's default currency.

• Int RefundPeriod - subscription refund period duration in days, always passed 0;
• 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 LastBillDate - subscription last billing date in Unix date format;
• Int NextBillDate - subscription next billing date in Unix date format.

Please send us your feedback on this help page