openapi: 3.1.0
info:
  title: Moonshot AI Billing API
  version: 1.0.0
  description: Moonshot AI / Kimi 大语言模型服务 API
servers:
- url: https://api.moonshot.cn
  description: 生产环境
tags:
- name: Billing
paths:
  /v1/users/me/balance:
    get:
      summary: 查询余额
      description: 查询您在 Kimi 开放平台上的可用余额、代金券余额和现金余额。
      tags:
      - Billing
      security:
      - bearerAuth: []
      responses:
        '200':
          description: 余额信息
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
        '401':
          description: 未授权 - API 密钥无效或缺失
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 服务器错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: 描述错误原因的错误消息
            type:
              type: string
              description: 错误类型
            code:
              type: string
              description: 错误码
          required:
          - message
      required:
      - error
    BalanceResponse:
      type: object
      properties:
        code:
          type: integer
          description: 响应码。0 表示成功。
        data:
          type: object
          properties:
            available_balance:
              type: number
              format: float
              description: 可用余额（单位：人民币元），包含现金余额和代金券余额。当小于等于 0 时，用户无法调用推理 API
              example: 49.58894
            voucher_balance:
              type: number
              format: float
              description: 代金券余额（单位：人民币元），不可为负
              example: 46.58893
            cash_balance:
              type: number
              format: float
              description: 现金余额（单位：人民币元），可为负值表示欠费。当为负值时，available_balance 等于 voucher_balance 的值
              example: 3.00001
          required:
          - available_balance
          - voucher_balance
          - cash_balance
        scode:
          type: string
          description: 状态码
          example: '0x0'
        status:
          type: boolean
          description: 请求状态
          example: true
      required:
      - code
      - data
      - scode
      - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Authorization 请求头需要一个 Bearer 令牌。使用 MOONSHOT_API_KEY 作为令牌。这是一个服务端密钥，请在 [API 密钥页面](https://platform.kimi.com/console/api-keys) 生成。