ip is IP address the license will be assigned to.type is the term of the license. Valid values: monthly or annualvps is an optional field that flags the license as VPS-only.external is an optional field that flags the license as external. This field will only works for distributor accounts.

Sample responses

Sample success response for a monthly license:

result=true&license_id=3134212737&expires=2019-10-01&billed=0.00

license_id is the internal ID of the purchased license. This is a randomized INT(10).expires is the next date the license will be due for renewal. Format: YYYY-MM-DDbilled is amount billed to a saved payment method. Monthly licenses are not billed until the 1st of the next month.

Sample failure response:

result=false&message=No payment method on file

message is a url-encoded string describing why the failure occurred.

List licenses (with optional filtering)

Sample requests

license_id is an optional field that allows the result set to be filtered by license ID specifically.ip is an optional field that allows the result set to be filtered by license IP address specifically.q is an optional general search field that allows the result set to be filtered by license hostname, license IP, or license ID. Other filters can be included as well. For example, including :active in the query limits the result to active licenses. Other available filters include :unused and :expiring. If not included, all licenses are displayed.

Sample response for each license

n[license_id] is the internal ID of the license. Format: INT(10).n[type] is the license term. Valid values are 'monthly', 'annual', and 'lifetime'.n[expires] is the next date the license will be due for renewal. Format: YYYY-MM-DDn[ip] is the licensed IPv4 or IPv6 address.n[hostname] is the licensed server's hostname. This value is for display purposes only and will update from time to time; it is not associated with licensing.

Tip: Passing the full result through PHP's parse_str function makes parsing easy.