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

# Consultar saldo de Stars

> Retorna o saldo atual da carteira da organização, separado por compartimento (Mensal + Pacote).



## OpenAPI

````yaml /openapi.json get /billing/balance
openapi: 3.1.0
info:
  title: Apollo Space API
  description: >-
    API HTTP do Apollo Space — pré-visualização. Os endpoints aqui descritos são
    o design pretendido; alguns podem mudar antes da estabilização pública. Pra
    acesso antecipado, fale com support@apollospace.ai.
  version: 0.1.0-preview
  contact:
    email: support@apollospace.ai
servers:
  - url: https://api.apollospace.ai/v1
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Leads
    description: Operações no CRM — listar, criar, atualizar leads.
  - name: Faturamento
    description: Saldo, planos, histórico da carteira de Stars.
paths:
  /billing/balance:
    get:
      tags:
        - Faturamento
      summary: Consultar saldo de Stars
      description: >-
        Retorna o saldo atual da carteira da organização, separado por
        compartimento (Mensal + Pacote).
      operationId: getBillingBalance
      parameters:
        - name: X-Organization-Id
          in: header
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Saldo atual
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Balance:
      type: object
      properties:
        monthly_stars:
          type: number
          description: Saldo no compartimento Mensal (expira no fim do período)
        pack_stars:
          type: number
          description: Saldo no compartimento Pacote (rolling, não expira)
        total_stars:
          type: number
          description: Soma dos dois compartimentos
        monthly_grant_stars:
          type: number
          description: Crédito mensal do plano atual
        subscription:
          type: object
          nullable: true
          properties:
            tier:
              type: string
            status:
              type: string
            current_period_end:
              type: string
              format: date-time
              nullable: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Identificador estável da família de erro
            message:
              type: string
              description: Descrição legível (não estável entre versões)
            request_id:
              type: string
              description: Cole no chamado ao suporte
  responses:
    Unauthorized:
      description: Token ausente ou expirado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Autenticado mas sem permissão para o recurso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito id_token obtido após login

````