> ## Documentation Index
> Fetch the complete documentation index at: https://vastai-80aa3a82-auto-openapi-update-8483c1e9.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Instance Balance

> Returns the refundable prepay deposit balance and discount information for the specified instance.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v0/instances/balance/{id}/
openapi: 3.1.0
info:
  title: Vast.ai API
  description: >-
    Vast.ai REST API for managing GPU cloud instances, machine operations, and
    AI/ML workflows.


    ## AI Agent Quick-Start


    Install the CLI skill for your agent (Claude Code, Cursor, Windsurf, etc.):
      npx skills add vast-ai/vast-cli

    CLI reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai/SKILL.md

    SDK reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai_sdk/SKILL.md


    ## Auth

    All endpoints require `Authorization: Bearer $VAST_API_KEY`.

    Get your key at: https://cloud.vast.ai/manage-keys/


    ## Key Quirks

    - `gpu_ram` in CLI = GB; in REST API = MB (CLI auto-converts)

    - SSH keys must be registered BEFORE creating an instance (VM: no recovery;
    Docker: can add post-create)

    - `onstart` field is limited to 4048 characters -- gzip+base64 for longer
    scripts

    - `POST /api/v0/asks/{id}/` (create instance) returns `new_contract` as the
    instance ID, not `id`

    - Poll trap: if `actual_status` becomes `exited`, `unknown`, or `offline` it
    will never reach `running` -- destroy and retry
  version: 1.0.0
  contact:
    name: Vast.ai Support
    url: https://discord.gg/vast
servers:
  - url: https://console.vast.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/v0/instances/balance/{id}/:
    get:
      tags:
        - Billing
      summary: Get Instance Balance
      description: >-
        Returns the refundable prepay deposit balance and discount information
        for the specified instance.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the instance.
      responses:
        '200':
          description: >-
            Returns {success: true, refundable_deposit, total_discount,
            discount_months}.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: True on success
                  refundable_deposit:
                    type: number
                    description: >-
                      Amount in USD that would be refunded if the instance is
                      deleted now
                  total_discount:
                    type: number
                    description: Total discount earned so far from the prepayment
                  discount_months:
                    type: number
                    description: Number of months of discount remaining
              example:
                success: true
                refundable_deposit: 12.5
                total_discount: 2.1
                discount_months: 1.5
        '404':
          description: >-
            Returns {success: false, error: "no_such_instance", msg: "Instance
            {id} not found."} when the instance doesn't exist for the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        msg:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````