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

# Get credit balance



## OpenAPI

````yaml /openapi.json get /credits
openapi: 3.1.0
info:
  title: Youka REST API
  version: v1
  description: REST API for project-based karaoke creation, styling, media, and exports.
servers:
  - url: https://api.youka.io/api/v1
    description: Production
  - url: http://localhost:3003/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Inspect the API key's account identity.
  - name: Uploads
    description: Upload source audio or video before creating a project.
  - name: Credits
    description: Inspect available credit balance.
  - name: Billing
    description: Create checkout sessions and manage billing.
  - name: Projects
    description: Create projects and read the long-lived project state.
  - name: Tasks
    description: Poll async task progress until it reaches a terminal state.
  - name: Exports
    description: Create exports and fetch fresh download URLs.
  - name: Presets
    description: Manage reusable karaoke styling presets.
  - name: Media
    description: Manage uploaded reusable media.
  - name: Project Settings
    description: Read and update a project's active settings.
paths:
  /credits:
    get:
      tags:
        - Credits
      summary: Get credit balance
      operationId: getCreditsOverview
      responses:
        '200':
          description: Credit balance and renewal data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsOverview'
components:
  schemas:
    CreditsOverview:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        renewalDates:
          type: array
          items:
            type: string
        topups:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              originalAmount:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              remaining:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              expiresAt:
                type: string
            required:
              - id
              - originalAmount
              - remaining
            additionalProperties: false
        availableBalance:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        subscription:
          anyOf:
            - type: object
              properties:
                renewsAt:
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - renewsAt
              additionalProperties: false
            - type: 'null'
      required:
        - renewalDates
        - topups
        - availableBalance
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````