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

# Get Credit Balance

> Get current user's credit balance and package information.

Returns comprehensive credit information including:
- Total credits available
- Credits used
- Current active package
- List of all active credit packages

Args:
    current_user: Authenticated user from JWT
    supabase_service: Supabase service instance

Returns:
    CreditBalanceResponse with complete credit information

Raises:
    HTTPException: If unable to retrieve credit balance



## OpenAPI

````yaml https://api.bavlio.com/openapi.json get /api/v1/credits/balance
openapi: 3.1.0
info:
  title: Bavlio API
  description: >-
    Outreach automation API — lead enrichment, email campaigns, LinkedIn
    automation, and AI agent. Full docs at https://docs.bavlio.com.
  version: 1.0.0
servers: []
security: []
tags:
  - name: API Keys
    description: >-
      Create, list, and revoke API keys for programmatic access. JWT
      authentication required.
  - name: credits
    description: Credit balance, cost estimates, and transaction history.
  - name: campaigns
    description: Create, manage, launch, and monitor email campaigns.
  - name: campaign-personalization
    description: AI-powered email subject and body personalization for campaigns.
  - name: email-finder
    description: Find and verify email addresses for prospects.
  - name: email-verification
    description: Validate email addresses and prune invalid entries from datasets.
  - name: sender-profiles
    description: Manage sender identity profiles for outreach.
  - name: sender-profile-chat
    description: Interactive chat for building sender profiles.
  - name: templates
    description: Email template CRUD.
  - name: suppression
    description: Do-not-contact suppression list management.
  - name: datasets
    description: Lead dataset listing, download, and updates.
  - name: user-extractions
    description: Uploaded lead file management and processing.
  - name: enrichment-chat
    description: Interactive chat for data enrichment sessions.
  - name: enrichment-processing
    description: Batch lead enrichment processing.
  - name: File Upload (CSV/Excel)
    description: Upload and preview CSV/Excel lead files.
  - name: connected-accounts
    description: LinkedIn account connections via Unipile.
  - name: linkedin-content
    description: LinkedIn post creation, scheduling, and management.
  - name: linkedin-playground
    description: Direct LinkedIn actions (profile lookup, messaging, engagement).
  - name: bavimail-proxy
    description: BaviMail domain, alias, and email management.
  - name: agent
    description: Bavi AI agent chat with SSE streaming.
  - name: notifications
    description: Notification preferences and delivery.
  - name: referral
    description: Referral code management and stats.
  - name: feedback
    description: User feedback submission.
  - name: authentication
    description: JWT token verification and user info.
  - name: Google OAuth
    description: Google OAuth login flow and access tokens.
  - name: Google Sheets OAuth
    description: Google Sheets import and access management.
  - name: stripe
    description: Stripe checkout, billing portal, and subscription status. JWT only.
  - name: users
    description: User quota and usage information.
  - name: Health
    description: Health checks and system status.
  - name: Personalization
    description: Core lead personalization engine.
  - name: Session Management
    description: Enrichment session lifecycle.
  - name: Session Processing
    description: Session data processing.
  - name: webhooks
    description: Inbound webhook handlers (Stripe, BaviMail, Unipile).
paths:
  /api/v1/credits/balance:
    get:
      tags:
        - credits
      summary: Get Credit Balance
      description: |-
        Get current user's credit balance and package information.

        Returns comprehensive credit information including:
        - Total credits available
        - Credits used
        - Current active package
        - List of all active credit packages

        Args:
            current_user: Authenticated user from JWT
            supabase_service: Supabase service instance

        Returns:
            CreditBalanceResponse with complete credit information

        Raises:
            HTTPException: If unable to retrieve credit balance
      operationId: get_credit_balance_api_v1_credits_balance_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalanceResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    CreditBalanceResponse:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
          description: User ID
        total_credits:
          type: integer
          minimum: 0
          title: Total Credits
          description: Total credits available
        used_credits:
          type: integer
          minimum: 0
          title: Used Credits
          description: Credits used
        available_credits:
          type: integer
          minimum: 0
          title: Available Credits
          description: Credits available for use
        tier:
          type: string
          title: Tier
          description: User's current tier
          default: free
      type: object
      required:
        - user_id
        - total_credits
        - used_credits
        - available_credits
      title: CreditBalanceResponse
      description: User credit balance response model.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````