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

# Get a summary of active rentals

> Count the caller's active rentals and sum their hourly cost in cents, in total and per term type.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/on-demand/active-rental-summary
openapi: 3.1.0
info:
  title: Hyperbolic API
  description: >-
    HTTP API for Hyperbolic's on-demand GPU compute: rent virtual machines and
    bare-metal instances, manage storage volumes, and track usage and billing.
    Authenticate with a Bearer API key (`Authorization: Bearer <api-key>`).
  version: 2.0.0
  contact:
    name: Hyperbolic
    url: https://hyperbolic.ai
    email: support@hyperbolic.ai
servers:
  - url: https://api.hyperbolic.ai
    description: Production
  - url: https://api.hyperbolic.xyz
    description: >-
      Legacy host — the same API on Hyperbolic's original domain, kept for
      existing integrations.
security: []
tags:
  - name: openapi
    description: OpenAPI specification
    x-group: OpenAPI
  - name: rentals
    description: Manage rentals
    x-group: Rentals
  - name: bare-metal-rentals
    description: Manage bare metal rentals
    x-group: Bare Metal Rentals
  - name: virtual-machine-rentals
    description: Manage virtual machine rentals
    x-group: Virtual Machine Rentals
  - name: storage-volumes
    description: Manage storage volumes
    x-group: Storage Volumes
  - name: billing
    description: Manage billing
    x-group: Billing
  - name: users
    description: Manage users
    x-group: Users
  - name: balances
    description: Manage balances
    x-group: Balances
  - name: api-keys
    description: Manage API keys
    x-group: API Keys
  - name: ssh-keys
    description: Manage SSH public keys
    x-group: SSH Keys
paths:
  /v2/on-demand/active-rental-summary:
    get:
      tags:
        - rentals
      summary: Get a summary of active rentals
      description: >-
        Count the caller's active rentals and sum their hourly cost in cents, in
        total and per term type.
      operationId: ondemand-getActiveRentalSummary
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveRentalSummary'
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - Authorization: []
components:
  schemas:
    ActiveRentalSummary:
      type: object
      properties:
        count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        costPerHourCents:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        byTermType:
          $ref: '#/components/schemas/ActiveRentalSummaryByTermType'
      required:
        - count
        - costPerHourCents
        - byTermType
      additionalProperties: false
      description: >-
        How many rentals the caller has active, and their summed hourly cost in
        cents.
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
    ActiveRentalSummaryByTermType:
      type: object
      properties:
        on-demand:
          $ref: '#/components/schemas/RentalTermTypeSummary'
        reserved:
          $ref: '#/components/schemas/RentalTermTypeSummary'
        private-cloud:
          $ref: '#/components/schemas/RentalTermTypeSummary'
      required:
        - on-demand
        - reserved
        - private-cloud
      additionalProperties: false
      description: Active rental totals for each term type.
    RentalTermTypeSummary:
      type: object
      properties:
        count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        costPerHourCents:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      required:
        - count
        - costPerHourCents
      additionalProperties: false
      description: >-
        How many active rentals are on one term type, and their summed hourly
        cost in cents.
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.