> ## Documentation Index
> Fetch the complete documentation index at: https://docs.intentleads.si/llms.txt
> Use this file to discover all available pages before exploring further.

# Get usage

> Your plan and contacts this billing period. `allowance` is the plan's `monthly_contacts` plus `rollover_contacts` (last period's unused monthly contacts, kept for one period). `used` counts people exported this period; each person counts once per period.

`left_to_export` is the most a new export can take: `remaining` less contacts held by exports still running. It's 0 without an active plan. Works with any key; admin keys can also see plans and billing with `GET /api/v1/billing`.

**Free.** This doesn't use any contacts from your plan.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/usage
openapi: 3.1.0
info:
  title: Intent Leads API
  version: '1.0'
  description: >-
    The Intent Leads API finds B2B people actively researching the topics you
    sell into, and exports them with contact details into your own tools.


    **Authentication.** Send an API key as a bearer token: `Authorization:
    Bearer il_live_…`. Keys belong to one organization. Standard keys work with
    everything except billing, team and key management, which need an admin key.


    **What costs contacts.** Only `POST /api/v1/exports` with `"dry_run": false`
    uses contacts from your plan. Quotes, counts, checks, samples and
    re-downloads are free.


    **Errors.** Every error is JSON: `{"error": "code", "message":
    "Plain-English explanation"}`. Codes are stable; messages may change.


    **Conventions.** JSON by default. Dates are `YYYY-MM-DD` and timestamps ISO
    8601, all in UTC. Lane codes (`L1`) are case-insensitive.
servers:
  - url: https://intentleads.si
security:
  - bearerAuth: []
tags:
  - name: Exports
    description: Quote (free) and buy new people from your lanes, then download them.
  - name: Leads
    description: Pull and re-download the leads you've exported, and list deliveries.
  - name: Lanes
    description: >-
      Create, inspect and tune lanes: keywords plus the companies and roles you
      want.
  - name: Keywords
    description: Add and remove a lane's keywords; each one is approved as its own topic.
  - name: Checks
    description: >-
      Free lane checks that size every filter step over 14 days, plus quick
      topic signals.
  - name: Company list
    description: >-
      The target-company list your lanes can narrow to or use instead of
      industries.
  - name: Suppressions
    description: People you exported who later asked to be removed.
  - name: Usage
    description: Contacts used and left this billing period.
  - name: Billing
    description: Plan, invoices and plan changes. Admin keys only.
  - name: Team
    description: Members and invite links. Admin keys only.
  - name: API keys
    description: Create, rename, rotate and revoke API keys. Admin keys only.
  - name: Account
    description: Check which organization a key belongs to and its role.
  - name: Reference
    description: Valid values for lane filters.
  - name: Activity
    description: A feed of changes and events in your organization.
paths:
  /api/v1/usage:
    get:
      tags:
        - Usage
      summary: Get usage
      description: >-
        Your plan and contacts this billing period. `allowance` is the plan's
        `monthly_contacts` plus `rollover_contacts` (last period's unused
        monthly contacts, kept for one period). `used` counts people exported
        this period; each person counts once per period.


        `left_to_export` is the most a new export can take: `remaining` less
        contacts held by exports still running. It's 0 without an active plan.
        Works with any key; admin keys can also see plans and billing with `GET
        /api/v1/billing`.


        **Free.** This doesn't use any contacts from your plan.
      operationId: getUsage
      responses:
        '200':
          description: Usage this period.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
              example:
                plan: growth
                plan_name: Growth
                period_start: '2026-10-01'
                period_end: '2026-11-01'
                monthly_contacts: 7500
                rollover_contacts: 1200
                allowance: 8700
                used: 2350
                remaining: 6350
                held_by_exports_in_progress: 250
                left_to_export: 6100
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Usage:
      type: object
      properties:
        plan:
          type:
            - string
            - 'null'
          description: >-
            Plan id (`starter`, `growth`, `scale`, `partner`), or null without a
            plan.
        plan_name:
          type:
            - string
            - 'null'
        period_start:
          type:
            - string
            - 'null'
          format: date
          description: Start of the current billing period.
        period_end:
          type:
            - string
            - 'null'
          format: date
          description: End of the current billing period.
        monthly_contacts:
          type: integer
          description: Contacts included in the plan each period.
        rollover_contacts:
          type: integer
          description: >-
            Unused monthly contacts carried over from last period (for one
            period).
        allowance:
          type: integer
          description: '`monthly_contacts` + `rollover_contacts`.'
        used:
          type: integer
          description: People exported this period.
        remaining:
          type: integer
          description: '`allowance` − `used`.'
        held_by_exports_in_progress:
          type: integer
          description: Contacts reserved by exports still running.
        left_to_export:
          type: integer
          description: >-
            What a new export can take: `remaining` less what's held. 0 without
            an active plan.
      required:
        - plan
        - plan_name
        - period_start
        - period_end
        - monthly_contacts
        - rollover_contacts
        - allowance
        - used
        - remaining
        - held_by_exports_in_progress
        - left_to_export
      example:
        plan: growth
        plan_name: Growth
        period_start: '2026-10-01'
        period_end: '2026-11-01'
        monthly_contacts: 7500
        rollover_contacts: 1200
        allowance: 8700
        used: 2350
        remaining: 6350
        held_by_exports_in_progress: 250
        left_to_export: 6100
    Error:
      type: object
      properties:
        error:
          type: string
          example: lane_not_found
          description: Stable machine-readable code, e.g. `lane_not_found`.
        message:
          type: string
          example: No lane L9.
          description: Plain-English explanation you can show to a person.
      required:
        - error
        - message
      description: Every error has this shape.
  responses:
    Unauthorized:
      description: Missing, malformed, unknown or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            unauthorized:
              value:
                error: unauthorized
                message: 'Send a valid API key as: Authorization: Bearer il_live_…'
    InternalError:
      description: >-
        Unexpected server error. Safe to retry reads; retry an export only with
        the same `idempotency_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internal_error:
              value:
                error: internal_error
                message: Something went wrong. Try again.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: il_live_…
      description: >-
        An Intent Leads API key, e.g. `il_live_` followed by 32 letters and
        digits. Create one on the API and CLI page of the dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.