LimeLM
wyBuild
Support forum
wyDay blog
wyDay Home

limelm.trialExtension.generate

Generates a trial extension.

Arguments

api_key (Required)
Your API application key. Your api key is available on your settings page.
version_id (Required)
The id of the version to create the trial extension in. You can get the version ID by examining the URL in your browser. For instance, from the URL https://wyday.com/limelm/version/100/ you can see the version ID is 100. (Note: The Version ID is not the Version GUID).
is_online (Required)
Whether this trial extension will require online validation with the LimeLM servers (recommended), or will be completely standalone (and much longer, 380+ characters). Possible values: true or false.
for_verified (Optional)
Whether this trial extension is for verified trials or not. If this is set to true then the trial extension will be for verified trials. Otherwise the trial extension will be for unverified trials. Possible values: true or false (default: false).
length (Required)
The length of the trial extension in days.
expires (Required)
When the trial extension can no longer be used (in form YYYY-MM-DD, e.g. 2011-01-22)
customer_id (Optional)
A customer ID, email, or any other unique identifier so you can easily search trial extensions later.
max_uses (Optional)
The max uses for the online trial extension. If this is not set then the default value of 1 is used. Set to 0 for unlimited uses.

Example Response

The method returns the single trial extension.

<trialext id="103" extension="9KR5-PBGH-23CW-FUQ6-9Q22-BI76-3NXT"/>

Error Codes

100: Invalid API Key
The API key passed was not valid or has expired.
101: Method "xxx" not found
The requested method was not found.
164: An API key must be used by X devices. Configurable in your settings.
You can only use an API key from X devices. You can set the exact number on your settings page. If you need to use the web API from multiple servers then create another user. You can also temporarily reset this message by logging into the account for which the API key is created and resetting the last used IP address on your settings page.
108: The version id is missing.
The version id was not specified.
109: The version doesnʼt exist or you donʼt have access to it.
Check to make sure you have access to the version id youʼve passed in.
118: Your account is in dormant mode. Re-enable your account.
You cannot generate product keys when your account is in dormant mode. Re-enable your account and you will no longer get this error.
121: You must specify the length of the trial using the "length" parameter.
The length of the trial must be greater than or equal to "1".
122: The expires date must be after today. We recommend 2 weeks from now.
The expires date must be in the future.
123: The customer ID must be less than 321 characters.
The customer ID is limited to a maximum of 320 characters.
142: Service currently unavailable
The requested service is temporarily unavailable.
165: You cannot generate a verified trial extension with "is_online" set to "false".
Verified trial extensions must be online. To do offline extensions of verified trials, go through the offline verified trial request / response process.