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

# Get Credit Grant Balance

> Returns credit grant balance.



## OpenAPI

````yaml /api-reference/customer/openapi.json get /api/v1/customer/credit-grants/balance
openapi: 3.0.0
info:
  title: OABUS Customer API
  description: OABUS API
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/v1/customer/credit-grants/balance:
    get:
      tags:
        - CreditGrant
      summary: Get Credit Grant Balance
      description: Returns credit grant balance.
      operationId: getCreditGrantBalance
      parameters:
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      responses:
        '200':
          $ref: '#/components/responses/GetCreditGrantBalance200Response'
        '400':
          $ref: '#/components/responses/GetCreditGrantBalance400Response'
        '401':
          $ref: '#/components/responses/GetCreditGrantBalance401Response'
        '500':
          $ref: '#/components/responses/GetCreditGrantBalance500Response'
      security:
        - bearer: []
components:
  responses:
    GetCreditGrantBalance200Response:
      content:
        application/json:
          schema:
            type: object
            properties:
              availableAmount:
                type: integer
            required:
              - availableAmount
            additionalProperties: false
            description: Credit grant balance
      description: OK
    GetCreditGrantBalance400Response:
      content:
        application/json:
          example:
            errors:
              - message: required
                path: name
            message: Bad Request Error
            statusCode: 400
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 400
                type: number
              errors:
                items:
                  properties:
                    message:
                      type: string
                    path:
                      type: string
                  required:
                    - message
                    - path
                  type: object
                type: array
            required:
              - message
              - statusCode
            type: object
      description: Bad Request Error
    GetCreditGrantBalance401Response:
      content:
        application/json:
          example:
            message: Missing or invalid access token
            statusCode: 401
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 401
                type: number
            required:
              - message
              - statusCode
            type: object
      description: Unauthorized
    GetCreditGrantBalance500Response:
      content:
        application/json:
          example:
            message: Internal Server Error
            statusCode: 500
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 500
                type: number
            required:
              - message
              - statusCode
            type: object
      description: Internal Server Error
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````