reseller

is added when reseller has a customer specific business

Get Reseller Pricing Based On Pricing Bands (Mock Response)

Description

Gets mock response of the Reseller's Band Pricing. Eventually this response will be a part of this response.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/mock/products/reseller-price.json?auth-userid=0&api-key=key

Response

Returns a map with the prices of Web Services plans.


{"product-key":{"plan-category":{"band-id":{"pricing":{"action":price},"description":{"plan-category-parameter-key":plan-category-parameter-value}}}}

Example:


{"hosting":{"email_plan":{"0":{"pricing":{"renew":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true}},"1":{"description":{"no_of_mail_accounts":1,"default":false}}},"websitebuilder_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"noofpages":50,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":0,"default":false,"bandwidth":0,"noofpages":0,"webspace":0}}},"windows_hosting_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":0,"default":false,"bandwidth":0,"webspace":0}}},"linux_hosting_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":1,"default":false,"bandwidth":1,"webspace":1}}}}}

* -1 denotes Unlimited.

* "pricing" key will come only when pricing is set for that particular band.

* "default":true denotes the default band.

Selecting which Product Plans to display on your SuperSite 2

The SuperSite 2 Admin Area allows you to select the Product Plans that you wish to display on your SuperSite 2.

For SuperSite 2

You may display upto 4 Plans each, of the various Hosting Products that you are selling, on your SuperSite 2.

Note

There is no option to choose the Plans to be displayed on your SuperSite 2 for the following Products:

Your SuperSite 2 will always display all the Plans available under these Products.

To Add/Remove Plans from your SuperSite 2

  1. Login to your SuperSite 2 Admin Area. See details

  2. Click the Settings menu.

  3. Now, click the Edit Settings button, besides each of the following Hosting categories individually:

    • Shared Linux Hosting Plans. This category is common for Single Domain Linux Hosting and Multi Domain Linux Hosting.

    • Shared Windows Hosting Plans. This category is common for Single Domain Windows Hosting and Multi Domain Windows Hosting.

    • Reseller Linux Hosting Plans

    • Reseller Windows Hosting Plans

    • Email Only Plans

    • Website Builder Plans

  4. Note

    You need to perform the below steps for each Geo Hosting that you have signed up for.

    Select a Geo location next to Choose the Server Location.

  5. To select which Plans you wish to sell, drag the desired Plan from the Available <Hosting Product> Plans section to the <Hosting Product> displayed on <Hosting Product> Page
    section.

    Example:

    If you clicked the Edit Settings button besides Email Only Plans, then you may drag any Plan from the
    Available Email Hosting plans section to the Email Hosting displayed on Email Hosting Page section.

    Choose a Plan from the Choose Preferred plan menu. This Plan will be highlighted on the Hosting Plans page of your SuperSite 2.

  6. Choose a Geo Hosting from the Set preferred server location menu. The Hosting Plans page of your SuperSite 2 will display the Plans for this Geo Hosting by default.

  7. Finally, click the Save button to save the changes.

Note
  • You may choose to display from 1 to 4 Plans per Hosting category for each Geo Hosting on your SuperSite 2.

  • This process will modify the Plans displayed for every Language SuperSite 2 that you have created.

  • This process only allows you to modify which plans are displayed. If you wish to not to display (sell) a particular Plan,
    you would have to stop selling the parent Product entirely (for Multi Domain Hosting, Reseller Hosting, VPS, Dedicated Server, Managed Server, Enterprise Email, SiteLock and CodeGuard) or stop selling the Plan (for Single Domain Hosting, Email and Website Builder). See details

  • If you wish to revert to the default Plans that were configured, click the Reset to Default button.

Getting Customer Details By Id

Description

Gets the Customer details for the specified Customer Id.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/customers/details-by-id.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns a hash map containing the below details:

  • Customer Id (customerid)

  • Customer Username (username)

  • Reseller Id of the Parent Reseller (resellerid)

  • Name (name)

  • Company (company)

  • Email Address (useremail)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • First line of address of the Customer (address1)

  • Second line of address of the Customer (address2)

  • Third line of address of the Customer (address3)

  • City (city)

  • State (state)

  • Country Code (country)

  • ZIP Code (zip)

  • Personal Identification Number (pin)

  • Creation Date (creationdt)

  • Current Status (customerstatus)

  • Sales Contact Id (salescontactid)

  • Language Preference for the Control Panel and Emails (langpref)

  • Total Receipts (totalreceipts)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Search Archived Transactions Of Customers

Description

Gets a detailed list of the Customer's Archived Transactions, matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Transactions to be fetched
page-no Integer Required Page number for which details are to be fetched
customer-id Array of Integers Optional Customer Id of the Customers whose archived Transaction are to be fetched
username Array of Strings Optional Username of the Customers whose archived Transactions are to be fetched
transaction-type Array of Strings Optional Type of the Transactions. Possible values can be credit, debit, invoice, receipt.
transaction-key String Optional Transaction key. Possible value can be manually or systemgenerated.
transaction-id Array of Integers Optional Transaction Ids
transaction-description String Optional Transaction description
amt-range-start Integer Optional Lowest amount in the range of Transactions you intend to list
amt-range-end Integer Optional Highest amount in the range of Transactions you intend to list
transaction-date-start String Optional UNIX TimeStamp for listing of Archived Transactions whose Creation Date is greater than transaction-date-start
transaction-date-end String Optional UNIX TimeStamp for listing of Archived Transactions whose Creation Date is less than transaction-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the Transactions.

Example: If page-no is 1, no-of-records is 30 and order-by is customerid; it will fetch the first 30 Transactions which suit the search criteria sorted by customerid. If page-no is 2, no-of-records is 30 and order-by is customerid; it will fetch the second batch of 30 Transactions sorted by customerid

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/customer-archived-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map of the Customer's Archived Transactions containing the below details:

  • Transaction Id (customer_transaction.transid)

  • Transaction Date (customer_transaction.transactiondate)

  • Order Id associated with the Transaction (customer_transaction.orderid)

  • Product Key (customer_transaction.key)

  • Transaction Type (customer_transaction.type)

  • Transaction Description (customer_transaction.description)

  • Whether Transaction is Greedy (greedy)

  • Customer Id Associated with the Transaction (customer_transaction.customerid)

  • Selling Currency Symbol of the Parent Reseller (customer_transaction.sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (customer_transaction.sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (customer_transaction.unutilisedsellingamount)

  • Accounting Currency Symbol of the Parent Reseller (customer_transaction.accountingcurrencysymbol)

  • Transaction Amount in the Accounting Currency (customer_transaction.accountingamount)

  • Unutilised Transaction Amount in the Accounting Currency (customer_transaction.unutilisedaccountingamount)

  • Foreign Exchange Difference (forexdiff)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Search Transactions of a Customer

Description

Gets a detailed list of Customer's Transactions, matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Transactions to be fetched
page-no Integer Required Page number for which details are to be fetched
customer-id Array of Integers Optional Customer Id of the Customers(s) whose Transactions are to be fetched
username Array of Strings Optional Username of the Customer(s) whose Transactions are to be fetched
transaction-type Array of Strings Optional Type of the Transactions. Possible values can be credit, debit, invoice, receipt.
transaction-key String Optional Transaction key. Possible value can be manually or systemgenerated.
transaction-id Array of Integers Optional Transaction Ids
transaction-description String Optional Transaction description
balance-type String Optional

Payment status for the Transaction. Possible values can be:

  • onlybalanced: Will fetch all transactions that have been balanced or paid for

  • onlyunbalanced: Will fetch all transactions that are yet to be balanced or paid

If this parameter is not included in the API call, all Transactions (balanced as well as unbalanced) will be fetched.

amt-range-start Integer Optional Lowest amount in the range of Transactions you intend to list
amt-range-end Integer Optional Highest amount in the range of Transactions you intend to list
transaction-date-start String Optional UNIX TimeStamp for listing of Transactions whose Creation Date is greater than transaction-date-start
transaction-date-end String Optional UNIX TimeStamp for listing of Transactions whose Creation Date is less than transaction-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the Transactions.

Example: If page-no is 1, no-of-records is 30 and order-by is customer-id; it will fetch the first 30 Transactions which match the search criteria sorted by customer-id. If page-no is 2, no-of-records is 30 and order-by is customer-id; it will fetch the second batch of 30 Transactions sorted by customer-id.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/customer-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map of the Customer's Transactions containing the below details:

  • Transaction Id (customer_transaction.transid)

  • Transaction Date (customer_transaction.transactiondate)

  • Order Id associated with the Transaction (customer_transaction.orderid)

  • Product Key (customer_transaction.key)

  • Transaction Type (customer_transaction.type)

  • Transaction Description (customer_transaction.description)

  • Whether Transaction is Greedy (greedy)

  • Customer Id Associated with the Transaction (customer_transaction.customerid)

  • Selling Currency Symbol of the Parent Reseller (customer_transaction.sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (customer_transaction.sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (customer_transaction.unutilisedsellingamount)

  • Accounting Currency Symbol of the Parent Reseller (customer_transaction.accountingcurrencysymbol)

  • Transaction Amount in the Accounting Currency (customer_transaction.accountingamount)

  • Unutilised Transaction Amount in the Accounting Currency (customer_transaction.unutilisedaccountingamount)

  • Foreign Exchange Difference (forexdiff)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Web Services Setup Guide

As a Reseller, you need to take the following steps in order to start selling the Web Services Product to your Customers and Sub-Resellers:

  • Ensure that you are Selling the Web Services
    Product. See details

  • Select the Plans you want to sell and set their Selling Price for your Customers and
    Sub-Resellers. See details

  • Select which Plans to display on your SuperSite. See details

  • Setting up Fully Branded Name Servers: When your Customers purchase any Web Services Plan for their domain name, it is essential that
    they change the Name Servers of their domain name to the Name Servers setup by the system for you.

    While you may use these partially branded Name Servers provided by firstfoot Interactive Pvt Ltd., you may want to consider branding them
    completely. See details

  • Specifying your Branded Name Servers as your Default Name Servers: It is recommended that you specify your branded Name Servers
    to be pre-filled every time your Customers register a domain
    name. See details

  • If Tax is applicable to the Web Services Product in your Country, you may use our Tax Engine to collect it from your Customers and
    Sub-Resellers. See details

Web Services (Email Hosting, Web Hosting, Website Builder Plans) Product

firstfoot Interactive Pvt Ltd.'s Web Services Product consists of the following Plan categories:

  • Email Only Plans

  • Windows Web Hosting and Email Plans

  • Linux Web Hosting and Email Plans

  • Website Builder Plans

Under each of the above Plan categories, we have included a default Plan. You may create as many Plans, per your requirement. You may also choose to delete any Plan,
should you no longer wish to offer the same to your Customers.

The pricing model for your Customers and Sub-Resellers differs to some extent:

  • Customers: Customer pricing is based on discounts, depending on the number of months any Plan's Order is purchased
    and renewed for
    . This feature is referred as Telescopic Pricing.

  • Sub-Resellers: Pricing is determined by Pricing Bands.

To Select the Plans you want to Sell to your Customers (Anchor: select)

  1. Login to your Control Panel. See details

  2. In the Menu, point to Settings and click Manage Products and Pricing.

  3. Click the Web Services link.

    By default, there is a Plan created under Email Only Plans, Windows Web Hosting and Email Plans, Linux Web
    Hosting and Email Plans and Website Builder Plans
    . Here, you may:

    • Create New Plans: You may add as many new Plans as you require, by clicking the Create New Plan link under
      each Plan category and saving it.

    • Stop Selling Existing Plans: Upon creating a new Plan, its status is, by default, set to Selling.

      Click the Change link under Selling Status for Customers, select No New Orders and click the Save button.

      This status disallows accepting new Web Services Orders for the Plan from your Customers. However, existing Orders can continue to be Managed and Renewed.

    • Delete Existing Plans: Click the Change link under Selling Status for Customers and
      select Do Not Sell and click the Save button.

Note
  • While you may add several plans under any Plan, your SuperSite can display upto 4 Plans each, under all Plan categories individually. This implies you may display
    simultaneously:

    • upto 4 Email Only Plans.

    • upto 4 Windows Web Hosting and Email Plans.

      Within Windows Hosting Plans, you may set only a maximum of 3 Plans for Windows Hosting (minimum being 1) and 2 Plans for Multi Domain Windows Hosting (minimum being 1).

      Examples:

      • If you have chosen to display 3 Windows Hosting Plans, you would only be able to display any 1 Multi Domain Windows Hosting Plan. You would only be able to display the 2nd Multi Domain Windows Hosting Plan, once you have set the number of Windows Hosting Plans to be displayed to 2.

      • If you have chosen to display 2 Multi Domain Windows Hosting Plans, you would only be able to display any 2 Windows Hosting Plans. You would only be able to display the 3rd Windows Hosting Plan, once you have set the number of Multi Domain Windows Hosting Plans to be displayed to 1.

    • upto 4 Linux Web Hosting and Email Plans.

      Within Linux Hosting Plans, you may set only a maximum of 3 Plans for Linux Hosting (minimum being 1) and 2 Plans for Multi Domain Linux Hosting (minimum being 1).

      Examples:

      • If you have chosen to display 3 Linux Hosting Plans, you would only be able to display any 1 Multi Domain Linux Hosting Plan. You would only be able to display the 2nd Multi Domain Linux Hosting Plan, once you have set the number of Linux Hosting Plans to be displayed to 2.

      • If you have chosen to display 2 Multi Domain Linux Hosting Plans, you would only be able to display any 2 Linux Hosting Plans. You would only be able to display the 3rd Linux Hosting Plan, once you have set the number of Multi Domain Linux Hosting Plans to be displayed to 1.

    • upto 4 Website Builder Plans.

  • The default Plan under each Plan category has unlimited parameters. If you delete this Plan, you may restore it, by simply adding another Plan with unlimited parameters.

  • Any Plan that you create is only visible to your Customers through your SuperSite and not your Sub-Resellers.

  • If you do not want your Sub-Resellers to sell a particular Plan category, you would need to stop offering the Web Services Product entirely.
    See details

Set Web Services Plans Selling Price for Customers (Anchor: plans)

firstfoot Interactive Pvt Ltd. allows you to set Telescopic Price ranges for all Web Services Adds and Renewals for each one
of your Plans. This simply means that you may offer your Customers increased discounts as and when they may choose to add / renew their Web Services Orders with you for multiple months.

Example:

Suppose that your Cost Price for Plan A is USD 5 per month. Depending upon your business model, you may set your Selling Price for 12 months as USD 10 per month. Now, if a Customer
wished to add a Hosting Order under Plan A for 36 months, he would be charged USD 360 (USD 10 per month). However, with the Telescopic Pricing model, you may set a reduced price of say,
USD 8 per month. In this way, your Customer is charged USD 288 instead of USD 360, thus, availing a discount for purchasing for a longer duration.

To Set your Web Services Plans Telescopic Selling Price for Customers

  1. Login to your Control Panel. See details

  2. In the Menu, point to Settings and click Manage Products and Pricing.

  3. Click the Web Services link.

  4. Click the Customers tab under any Plan category.

  5. Click the Manage Price link under the Action column.

  6. Mention the per month Selling Price in each text box as per your requirement.

    Note

    Your Cost Price is determined based on the various resource parameters pricing applicable to you, under various Pricing Bands set by firstfoot Interactive Pvt Ltd..

  7. You may choose to add additional slabs for the duration of the Plan, by selecting it from the drop-down at the bottom of the page and clicking Add Slab.

  8. Click the Update button to save your changes.

Note
  • Pricing for the following parameters can be configured for only the slab of the least duration:

    Plan Name

    Parameter(s)

    All Web Hosting Plans

    Add Dedicated IP/SSL

    Example:

    If you have a Selling Price For 12 Months slab and a Selling Price For 36 Months slab, then you would be able to mention the Add Dedicated IP/SSL Selling Price for only the 12 Months slab.

  • If you have multiple slabs configured, you need to set reduced pricing for the higher duration slab, than the one that is immediately of a lower duration.

    Example:

    If you have a Selling Price For 12 Months slab and add a Selling Price For 36 Months slab, then the per month Selling price you need to mention for the 36 Months slab needs to be lower
    than that of the 12 Months slab.

  • When Specific Pricing is not set, then your Customer would get the best pricing from amongst the Telescopic Pricing (for Web Services) and any ongoing Promotion
    Pricing (if applicable)
    .

    Additional Information

    Understanding Specific Pricing

  • A Plan Name can be customized by clicking the Edit link next to it and submitting a new Plan Name. Plan Name of existing Orders will be updated to reflect the new Plan Name.

  • The SuperSite contains Pricing information about the Products and Services you offer to your Customers. This data is downloaded to your SuperSite
    from your Control Panel and cached (stored) on the SuperSite server. The cache of your SuperSite will be reloaded automatically, once you have completed the above process. This way, the updated details will be downloaded to your SuperSite from your Control Panel.

    Additional Information

    SuperSite

Set Web Services Plans Selling Price for Sub-Resellers (Anchor: set)

Pricing for Web Services Plans for your Sub-Resellers is based on Pricing Bands. Each Pricing Band constitutes various resource parameters such as number of Email Accounts, amount of Data Transfer, etc..

  1. Login to your Control Panel. See details

  2. In the Menu, point to Settings and click Manage Products and Pricing.

  3. Click the Web Services link.

  4. Click the Sub-Resellers tab under any Plan category.

  5. Click the Manage Price link.

  6. Set your Selling Price for each Pricing Band.

  7. Click the Update Pricing button to save your changes.

Note
  • If the price for a Pricing Band has not been set, the pricing set for the next highest Pricing Band will be used.

  • You must enter all the values for the highest Pricing Band.

    For the rest of the Pricing Bands, you may either fill in all the fields or leave all of them blank.

  • Price can be any number (upto 2 decimal places). Hence, 3.00, 3, 3.19 are all valid prices.

  • The pricing in a Pricing Band must be greater than or equal to that of the Pricing Band above it.

    Example:

    The pricing you mention in Band 3 must be greater than Band 2.

  • Pricing for the following parameters can be configured for only Band 1:

    Plan Name

    Parameter(s)

    All Web Hosting Plans

    Add Dedicated IP/SSL

  • Your Sub-Resellers can create their own custom plans and are charged a fixed price per Order as set by you, irrespective of their Selling Price.

  • The PartnerSite contains Pricing information about the Products and Services you offer to your Resellers. This data is downloaded to your PartnerSite from your Control Panel
    and cached (stored) on the PartnerSite server. The cache of your PartnerSite will be reloaded automatically, once you have completed the above process. This way, the updated details will be downloaded to your PartnerSite from your Control Panel.

    Additional Information

    PartnerSite

Get Modify/Upgrade Price

Description

Gets the applicable modify/upgrade price for a particular Web Services Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId for which the details are to be fetched.
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.
months Integer Required The number of months (tenure) in the new plan for which the Order to be placed.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/webservices/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Response

Returns the applicable modify/ upgrade price for a particular Web Services Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"modifyCostResult":"upgrade",
"remainingmonths":0,
"currentOrderPrice":0.0
}

where

  • currentOrderPrice: The current pricing of the Order for remaining months.

  • modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

  • upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice