# Get Credits Balance

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

Endpoint: GET /data-api/v2/credits
Security: authorization

## Security:

  - `authorization` (unknown)
    http bearer API_KEY

## Response 200:

  - `200` (unknown)
    Credits Response

## Response 200 fields (application/json):

  - `contract_end` (string)
    Contract end date
    Example: 2024-12-31

  - `contract_start` (string)
    Contract start date
    Example: 2024-01-01

  - `credits` (object)

  - `credits.consumed` (integer)
    Credits consumed so far
    Example: 500

  - `credits.percentage_consumed` (number)
    Percentage of credits consumed
    Example: 25

  - `credits.remaining` (integer)
    Credits remaining
    Example: 1500

  - `credits.total` (integer)
    Total credits in contract
    Example: 2000

  - `entitlements` (object)

  - `entitlements.companies` (object)
    Company data entitlements, or null if not entitled

  - `entitlements.companies.fai` (string)
    Access level for Functional Area Intelligence data
    Enum: "none", "full"

  - `entitlements.companies.firmographics` (string)
    Access level for firmographic data
    Example: full

  - `entitlements.companies.intent` (string)
    Access level for intent data
    Enum: "none", "full"

  - `entitlements.companies.spend` (string)
    Access level for spend data
    Example: full

  - `entitlements.companies.technographics` (string)
    Access level for technographic data
    Example: full

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `errors` (array)

  - `errors.detail` (string, required)
    Example: The api key provided is not valid

  - `errors.source` (string)

  - `errors.title` (string, required)
    Example: Unauthorized

## Response 502:

  - `502` (unknown)
    Upstream Error

## Response 502 fields (application/json):

  - `error` (string)
    Example: upstream_error