DomainSubscrAdd_API

Syntax

ItemResult DOMAINGATE::DomainSubscrAdd_API(

  Int ParentID;

  Int Status;

  Int ServStatus;

  Str StartDate;

  Str ExpirationDate;

  Int AccountID;

  Int PlanID;

  Int SubscriptionPeriod;

  Double SetupFee;

  Double SubscriptionFee;

  Double RenewalFee;

  Double TransferFee;

  Double NonRefundableAmt;

  Int RefundPeriod;

  Int BillingPeriodType;

  Int BillingPeriod;

  Int LastBillDate;

  Int NextBillDate;

  Int RegistrarID;

  Str(255) FullDomainName;

  Str(40) Login;

  Str(32) Password;

  Str(40) PrimaryNameServer;

  Str(40) SecondaryNameServer;

  Str(40) ThirdNameServer;

  Str(40) FourthNameServer;

  Int OwnerID;

  Int AdminID;

  Int BillingID;

  Int TechID.

)

returns

  Int SubscriptionID - ID of the created subscription;

  Int DomainID - ID of the domain.

Special Notes

• Int ParentID - ID of the parent subscription (hosting);
• 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 domain subscription service plan;
• Int SubscriptionPeriod - subscription period duration (for example, 1 if subscription period is 1 year);

  Note: subscription period type (Days, Months, Years) is not passed with the method as subscription period type for domain registration is always "Years".

• 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 (for example, 5 if refund period is 5 days);
• 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;
• Int RegistrarID - ID of registrar plug-in domain is registered with. The list of supported registrar plug-ins can be accessed from the External Systems Director > Domain Manager > Registrars submenu of the Navigation tree;
• Str(255) FullDomainName - domain name + TLD, without www prefix. For example, "domain.com";
• Str(40) Login - login to registrar;
• Str(32) Password - password to registrar;
• Str(40) PrimaryNameServer - domain primary NS;
• Str(40) SecondaryNameServer - domain secondary NS;
• Str(40) ThirdNameServer - domain third NS;
• Str(40) FourthNameServer - domain fourth NS;

  Note: primary and secondary name servers addresses are mandatory, the rest of name servers are optional.

• Int OwnerID - customer account user ID. The user contact information is used as owner contact by registrar;
• Int AdminID - customer account user ID. The user contact information is used as administrative contact by registrar;
• Int BillingID - customer account user ID. The user contact information is used as billing contact by registrar;
• Int TechID customer account user ID The user contact information is used as technical contact by registrar.

  Note: all four contacts can be of the same user or of four different users.

Please send us your feedback on this help page