licenses.php¶

License management module for retrieving journal lists and updating expiration dates.

API Methods¶

Method	Action	Description
`licenses_journal_list`	get licenses journal list	Returns a list of license journal entries filtered by billing, type, and date range.

licenses/licenses_journal_list¶

Returns a list of license journal entries filtered by billing, type, and date range.

HTTP method: POST

Parameters:

Parameter	Required	Type	Description
action	✅	string	Method identifier: `licenses_journal_list`
token	✅	string	Authentication token for the request.
billing	❌	string	Invoice number or billing identifier to filter results.
family	❌	string	License type or family name used for filtering.
period_from	❌	string	Start date for the journal entry period range.
period_to	❌	string	End date for the journal entry period range.

Request example

curl -s "https://invapi.hostkey.com/licenses.php" -X POST \
--data "action=licenses_journal_list" \
--data "token=HOSTKEY_TOKEN"

Success response example

{
"result": "OK",
"action": "licenses_journal_list",
"data": [
{
"id": 1024,
"license_type": "standard",
"billing": "INV-99823",
"date": "2024-05-20T14:30:00Z",
"status": "active"
},
{
"id": 1025,
"license_type": "premium",
"billing": "INV-99824",
"date": "2024-05-21T09:15:00Z",
"status": "expired"
}
]
}

Error examples

{
"code": 400,
"message": "Please provide acton"
}