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

# Credit Balance

> Get the authenticated account's current monthly, signup, and purchased credit balances.

`GET /credits` is free and returns the balance associated with your API key. It does
not accept a user ID or consume credits. The `purchased_remaining` value includes
one-time signup credits and purchased credits. For unlimited accounts,
`monthly_remaining` and `total_available` are `null`; check `is_unlimited` to
distinguish that from a zero balance.


## OpenAPI

````yaml openapi.json GET /credits
openapi: 3.0.3
info:
  title: Fundable API
  description: >-
    Canonical OpenAPI specification for the Fundable API. Choose the collection
    endpoint whose return type matches the requested result: POST /companies for
    company discovery (the default for most sourcing workflows), POST /deals for
    round-level analysis across complete company histories, POST /investors for
    investor firms, and POST /people for founders, employees, angels, or lead
    partners. Use singular detail endpoints when a stable identifier such as a
    domain or LinkedIn URL is already known; use /search endpoints for fuzzy
    names or uncertain identifiers. Resolve human-readable locations and
    industries with their search endpoints before applying permalink filters.
    Operation descriptions contain the route-specific selection rules.
  version: 2.0.0
  contact:
    name: Fundable API Support
    url: mailto:jacob@tryfundable.ai
  license:
    name: Proprietary
    url: https://www.tryfundable.ai/terms/privacy/
servers:
  - url: https://www.tryfundable.ai/api/v1
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: deals
    description: Venture capital deals data
  - name: companies
    description: Company data, search, and discovery operations
  - name: investors
    description: Investor data and search operations
  - name: people
    description: People search and detail operations
  - name: alerts
    description: Saved alert configurations and deal data
  - name: credits
    description: Credit balance and account usage operations
  - name: locations
    description: Location search and utility operations
  - name: industries
    description: Industry and super category search operations
paths:
  /credits:
    get:
      tags:
        - credits
      summary: Get the authenticated account's credit balance
      description: >
        Retrieve the current credit balance for the account associated with the
        API key.

        This endpoint is free, consumes no credits, and does not accept a user
        ID. The

        response includes the standard metadata with `credits_used: 0`.


        `purchased_remaining` includes one-time signup credits and purchased
        credits.

        Signup credits are granted once per account and do not expire. For
        unlimited

        accounts, `monthly_remaining` and `total_available` are `null` and

        `is_unlimited` is `true`. `has_included_credits` indicates whether the
        plan has

        included monthly credits, even when its current monthly balance is zero.
      operationId: getCreditBalance
      parameters: []
      responses:
        '200':
          description: Current balance returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalanceResponse'
              example:
                success: true
                data:
                  tier: Free
                  is_unlimited: false
                  monthly_remaining: 0
                  purchased_remaining: 250
                  total_available: 250
                  has_included_credits: false
                  purchase_url: https://www.tryfundable.ai/credits
                  plans_url: https://www.tryfundable.ai/billing
                meta:
                  page: 0
                  page_size: 1
                  credits_used: 0
        '401':
          description: Missing, invalid, or inactive API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtherAuthError'
        '429':
          description: Rate limit exceeded (200 requests per minute)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                example: 60
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
        '503':
          description: Credit accounting is temporarily unavailable; retry after 5 seconds
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - error
                  - statusCode
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        enum:
                          - CREDIT_ACCOUNTING_UNAVAILABLE
                      message:
                        type: string
                        example: >-
                          Credit accounting is temporarily unavailable. Try
                          again shortly.
                  statusCode:
                    type: integer
                    example: 503
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                example: 5
components:
  schemas:
    CreditBalanceResponse:
      type: object
      required:
        - success
        - data
        - meta
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: object
          required:
            - tier
            - is_unlimited
            - monthly_remaining
            - purchased_remaining
            - total_available
            - has_included_credits
            - purchase_url
            - plans_url
          properties:
            tier:
              type: string
              description: Current or legacy account tier
              example: Free
            is_unlimited:
              type: boolean
              description: Whether monthly and total available credits are unlimited
              example: false
            monthly_remaining:
              type: number
              nullable: true
              description: Remaining monthly credits, or null for unlimited accounts
              example: 0
            purchased_remaining:
              type: number
              description: Remaining one-time signup and purchased credits
              example: 250
            total_available:
              type: number
              nullable: true
              description: Total available credits, or null for unlimited accounts
              example: 250
            has_included_credits:
              type: boolean
              description: Whether the tier includes monthly credits, even if exhausted
              example: false
            purchase_url:
              type: string
              format: uri
              example: https://www.tryfundable.ai/credits
            plans_url:
              type: string
              format: uri
              example: https://www.tryfundable.ai/billing
        meta:
          type: object
          required:
            - page
            - page_size
            - credits_used
          properties:
            page:
              type: integer
              example: 0
            page_size:
              type: integer
              description: Number of data objects returned
              example: 1
            credits_used:
              type: integer
              description: Credits consumed by this request (always zero)
              example: 0
    OtherAuthError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - AUTH_ERROR
                - INVALID_API_KEY
                - INACTIVE_API_KEY
              example: AUTH_ERROR
            message:
              type: string
              example: API key not provided
            details:
              type: object
              properties:
                help:
                  type: string
                  example: Please provide your API key in the Authorization header
                format:
                  type: string
                  example: Bearer vg_your_api_key_here
                example:
                  type: object
                  properties:
                    header:
                      type: string
                      example: 'Authorization: Bearer vg_your_api_key_here'
                    curl:
                      type: string
                      example: >-
                        curl -H 'Authorization: Bearer vg_your_api_key_here'
                        https://www.tryfundable.ai/api/v1/location/search?name=san+francisco
                documentation:
                  type: string
                  example: >-
                    Visit our documentation for more information about
                    authentication
      required:
        - error
    RateLimitError:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: RATE_LIMIT_EXCEEDED
            message:
              type: string
              example: Rate limit exceeded. Maximum 200 requests per minute.
            details:
              type: object
              properties:
                limit:
                  type: integer
                  description: Maximum requests allowed per window
                  example: 200
                window:
                  type: string
                  description: Rate limit window duration
                  example: 60 seconds
                help:
                  type: string
                  example: Please reduce your request frequency and try again.
      required:
        - error
    ServerError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: INTERNAL_SERVER_ERROR
            message:
              type: string
              example: An unexpected error occurred
            details:
              type: string
              nullable: true
              description: Error details (only in development mode)
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key provided as a Bearer token

````

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