Account

The Account endpoint provides methods for listing and adding subscriptions to the current account.

Get a list of current subscriptions.

GET https://api.halosecurity.com/api/v1/account/subscription-list.json

Retrieve a list of subscriptions related to the currently logged in account.

https://www.halosecurity.com/user/account/subscriptions

200: OK

{
    "companyId": 12345,
    "subscriptions": [
        {
            "renewFrequency": "Year",
            "siteCount": 0,
            "product": 3,
            "dateCreated": "2022-03-14 18:38",
            "dateRenew": "2023-03-14",
            "price": "$0",
            "siteIds": [],
            "subscriptionId": 1234
        }
    ],
    "success": 1
}

Get information about a particular subscription.

GET https://api.halosecurity.com/api/v1/account/subscription-get.json

Query Parameters

Name	Type	Description
subscrption_id*	integer	ID of the subscription

200: OK

{
    "subscription": {
        "subscription_id": 12345,
        "product": 3,
        "amount": "0.00",
        "partner": 0,
        "renew_date": "2023-03-14",
        "renew_frequency": 2,
        "description": "Example",
        "detail": "1000x Target<br>100x Application Scanning<br>100x Server Scanning<br>Compliance Reporting<br>"
    }
}

404: Not Found

{
    "code": 0,
    "message": "subscription not found"
}