Skip to main content

License Keys Management API

Use this API endpoint to create, edit, enable/disable and activate License Keys.

CreateLK​

Create License Keys with a designated plan type (https://app.vpnwholesaler.com/plans) and expiry date.

POST Request
    https://{vpn-brand}.vpngn.com/api/lkapi/CreateLK

Request Parameters:

  • apikey - Your API key
  • type - Product type ID to create - you can find the ID’s listed under the Plans page at https://app.vpnwholesaler.com/plans (1/3/6/12/24/36)
  • expire - The License Key expiry date in the following format YYYY-mm-dd

Optional Parameter(s):

  • prefix - Start the License Key with a fixed 4 character prefix. For example, 'AVPN' will produce the following LK's - AVPN-P7W9-TX3I-H7NE-QXHA-BJ67-ILKF-ZR8L-NFU8
  • batch - Number of License Key to create. The maximum amount in one batch is 100K License Keys. Please note that this process will take a couple of minutes to complete.
  • email - (required for batch) The email address to send the CSV file once the License Keys are created. The email address must be associated with the API key's main account (Sub-Accounts can be added on https://app.vpnwholesaler.com/subaccounts if required).

EditLK​

Check the License Key status, enable/disable it, or change its expiry date.

POST Request
    https://{vpn-brand}.vpngn.com/api/lkapi/EditLK

Request Parameters:

  • apikey - Your API key
  • license_key - The License Key to edit

Optional Parameters:

  • disabled - Disable (1) or Enable (0) the License Key
  • expire - Change the License Key expiry date using the following format YYYY-mm-dd

ActivateLK​

Activate the License Key and provision the requested email address with the relevant plan.

POST Request
    https://{vpn-brand}.vpngn.com/api/public/ActivateLK

Request Parameters:

  • license_key - The License Key to activate
  • email - The end-user's email address

Optional Parameters:

  • password - A strong password. If this field is not specified, then the platform will auto-generate a password.
  • first_name - The end-user's first name
  • last_name - The end-user's last name
  • country - The end-user country's code (2 letter ISO code)
  • company_name - The end-user's company name
  • state - The end-user's state
  • zip_code - The end-user's postal code