Skip to content
Credits/
Get Credits Balance

Get Credits Balance

Request

Returns credit balance, contract dates, and data entitlements for the authenticated organization.

Security
authorization
GET
/data-api/v2/credits
curl -i -X GET \
  https://api.hginsights.com/data-api/v2/credits \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>'

Responses

Credits Response

Bodyapplication/json
contract_endstring

Contract end date

Example:"2024-12-31"
contract_startstring

Contract start date

Example:"2024-01-01"
creditsobject
entitlementsobject
Response
{
  "contract_end": "2024-12-31",
  "contract_start": "2024-01-01",
  "credits": {
    "consumed": 500,
    "percentage_consumed": 25,
    "remaining": 1500,
    "total": 2000
  },
  "entitlements": {
    "companies": { … }
  }
}