LogoLogo
DocsSupportDashboard
  • Introduction
    • Data Types
    • Target Filtering
    • Scan Selection
    • Pagination & Sorting
    • Permissions
    • Appendix
  • Authentication
  • Webhooks
  • Events
  • Appendix
    • Targets Filter
    • Date Match
    • IP Range
  • Endpoints
    • Discovery
    • Target
    • Scan
    • Issue
    • Tag
    • Port
    • DNS
    • HTTP
    • Whois
    • Technology
    • Website
    • Acknowledged
    • Event
    • Dark Web
    • Integration
    • PCI
    • Report
    • User
    • Account
    • Security
    • File
    • Work
Powered by GitBook

© 2024 Halo Security

On this page
  • Get a list of current subscriptions.
  • Get information about a particular subscription.

Was this helpful?

  1. Endpoints

Account

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

PreviousUserNextSecurity

Last updated 1 year ago

Was this helpful?

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.

{
    "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

{
    "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>"
    }
}
{
    "code": 0,
    "message": "subscription not found"
}
https://www.halosecurity.com/user/account/subscriptions