Method: order
Description:
Order a subscription for a website. Available subscription periods are: 1, 6 or 12 months. The default subscription period is 1 month.
Requires:
API key, id
Available in:
Version 1.0
Parameters:
apikey: The API key that is provided with your reseller account.
id: The ID under which the analysis is carried out. The ID is given after you add a new analysis. You can also use the ID's that are in the response of the list method.
period: When ordering a subscription you must submit a subscription period. Lipperhey offers 4 possible subscription periods. Available subscription periods are: 0 (trial), 1, 6 or 12 months. Successful orders will be added to your monthly bill.
recurring (optional): If you want a subscription to never end you can use the recurring parameter (recurring=true). If a subscription is recurring Lipperhey will automatically prolong the subscription month after month after the selected period. The costs will be added to your monthly bill. You can cancel a subscription with recurring billing at any time.
A simple example to order a subscription for 6 months looks like this:
http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=order&id=1653989&period=6
If you want to start a trial period (3 days) you can use the following example:
http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=order&id=1653989&period=0
Response:
If there are no errors, the API will respond with the ID of analysis. With this ID you can retrieve the progress, detailed results or download the report.
<!--Lipperhey API Response-->
<response queries="6" time="15 ms" calls-left="9985">
<error/>
<websites offset="0" results="1">
<website domain="lipperhey.com" timestamp="2009-07-07 10:54:21">
<id>1653860</id>
</website>
</websites>
</response>
If an error occured a description of the error wil be available in the error field.
Examples:
