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

# Add a term to your listing

> Adds a financial term to a draft or available listing your organization owns, for example a spot term on a VM relist that sells reserved windows. Terms cannot be edited; add a new one and delete the old one. Requires Idempotency-Key.

Terms cannot be edited. To change a price, add a term with the new price, then [delete the old term](/api-reference/relist/delete-term) if nothing uses it. The console and CLI do not provide this operation.


## OpenAPI

````yaml openapi.yaml POST /commerce/v2/listings/{listingId}/terms
openapi: 3.1.0
info:
  title: Ornn compute API
  version: 1.0.0
  description: >-
    Customer HTTP API for Ornn GPU capacity. It covers reserved capacity and
    nodes, VM and Bare Metal access, Kubernetes and Slurm clusters, SSH keys,
    storage volumes and GitHub repositories, private networks, monitoring,
    buying and selling capacity (Reserve, Market, Spot, and Relist), and
    billing. API keys are scoped to one organization and act with their
    creator's access there; account, team, and API-key management stay in the
    console. Most operations require an approved organization. See
    https://docs.ornn.com/api-keys to create a key and
    https://docs.ornn.com/guides/kubernetes-api for an end-to-end Kubernetes
    integration. Examples use fictional IDs and credentials. The info.version
    field identifies the contract revision, not a shared API path version.
  contact:
    email: support@ornn.com
servers:
  - url: https://api.ornn.com
    description: Production
security:
  - OrnnApiKey: []
tags:
  - name: Authentication
  - name: Reservations
  - name: GPU nodes
  - name: Clusters
  - name: Workers
  - name: Virtual machines
    description: >-
      Choose a VM disk, launch VM access on a reservation, and read each VM's
      status, launch progress, and SSH connection details.
  - name: Bare Metal
    description: >-
      Launch Bare Metal access on a reservation, read a host's readiness and SSH
      connection details, and reboot or hard reset it.
  - name: SSH keys
    description: >-
      Register public keys for your organization, choose which keys a VM or Bare
      Metal reservation uses, and queue key delivery to machines. Slurm clusters
      take organization key IDs at launch. Kubernetes API access does not use
      SSH keys.
  - name: Reserve
    description: >-
      Browse reserved-capacity listings and their terms, and post, cancel, or
      accept offers. Reserve listings are visible to approved organizations.
  - name: Market
    description: >-
      Browse relisted capacity and buy windows at the asking price, paid up
      front. Open to every member of your organization.
  - name: Spot
    description: >-
      Hourly order books for VMs with 1, 2, 4, or 8 GPUs on one node: read
      books, trades, and quotes, place and cancel bids, and follow fills.
  - name: Relist
    description: >-
      Sell whole nodes from a reservation you hold at your asking price, and
      manage those listings.
  - name: Storage
    description: >-
      Managed volumes, their files, and GitHub repository pulls. Volumes belong
      to the API key's creator in the key's organization.
  - name: Networks
    description: >-
      Organization private networks and the WireGuard configs you use to reach
      private machines and clusters.
  - name: Monitoring
    description: >-
      Machine telemetry and console logs for capacity your organization holds.
      Reads are limited to your reservation window.
  - name: Billing
    description: >-
      Invoices, billing summary, usage cost, Ornn credits, and account
      statements. Saving a card and paying invoices stay in the console.
externalDocs:
  description: REST integration walkthrough
  url: >-
    https://docs.ornn.com/guides/kubernetes-access#provision-and-manage-through-rest
paths:
  /commerce/v2/listings/{listingId}/terms:
    post:
      tags:
        - Relist
      summary: Add a term to your listing
      description: >-
        Adds a financial term to a draft or available listing your organization
        owns, for example a spot term on a VM relist that sells reserved
        windows. Terms cannot be edited; add a new one and delete the old one.
        Requires Idempotency-Key.
      operationId: capacityAddListingTerm
      parameters:
        - name: listingId
          in: path
          required: true
          description: Listing ID (capacityListingId or listingId).
          schema:
            type: string
            format: uuid
          example: 77777777-7777-4777-8777-777777777777
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Required. A unique key of 1 to 200 bytes for this operation, such as
            a UUID. Retrying with the same key and the same body returns the
            original response instead of writing again. The key is remembered
            for 24 hours; reusing it with a different body returns 409
            idempotency_conflict. A missing key returns 422
            invalid_idempotency_key.
          schema:
            type: string
            minLength: 1
            maxLength: 200
          example: 3f1c2a9e-6b1d-4c55-9a77-0d2b8f1e4c10
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CapacityTermInput'
            example:
              type: spot
              minDurationHours: 1
              maxDurationHours: 1
              pricePerGpuHourMicroUsd: 2500000
              downPaymentCents: null
              renewable: true
      responses:
        '201':
          description: Term added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityListingTerm'
              example:
                listingTermsId: 13131313-1313-4313-8313-131313131313
                capacityListingId: eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee
                type: spot
                renewable: true
                minDurationHours: 1
                maxDurationHours: 1
                downPaymentCents: null
                pricePerGpuHourMicroUsd: 2500000
                createdAt: '2026-10-14T18:30:00Z'
        '400':
          description: Malformed body, unknown field, or invalid ID.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/CapacityRequestBodyError'
              example:
                detail:
                  code: invalid_id
                  message: That capacity or financial term ID is not valid.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Your organization does not own the listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: forbidden
                  message: Your account cannot make this change.
        '409':
          description: The listing is not draft or available, or the key was reused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: listing_not_editable
                  message: Add terms only to draft or available listings.
        '422':
          description: >-
            Invalid term, or a missing Idempotency-Key. Codes include
            invalid_terms, invalid_hourly_terms, invalid_duration,
            invalid_spot_listing, and invalid_idempotency_key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: invalid_hourly_terms
                  message: >-
                    Spot and On-demand terms require a one-hour duration with
                    renewal enabled.
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    CapacityTermInput:
      type: object
      required:
        - minDurationHours
        - maxDurationHours
        - pricePerGpuHourMicroUsd
        - renewable
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
            - reserved
            - spot
            - on-demand
          description: >-
            reserved (the default) sells fixed windows in the Market. spot
            offers the nodes' idle time on the Spot order book and requires VM
            capacity. spot and on-demand are hourly: set both durations to 1 and
            renewable to true.
        minDurationHours:
          type: number
          exclusiveMinimum: 0
          description: Shortest window a buyer can take, in hours equal to whole seconds.
        maxDurationHours:
          type: number
          exclusiveMinimum: 0
          description: >-
            Longest window, in hours equal to whole seconds. Must fit inside the
            listing window.
        pricePerGpuHourMicroUsd:
          type: integer
          format: int64
          minimum: 1
          description: >-
            Your asking price: what you receive per GPU-hour, in integer
            micro-USD.
        downPaymentCents:
          type:
            - integer
            - 'null'
          format: int64
          minimum: 0
        renewable:
          type: boolean
    CapacityListingTerm:
      type: object
      required:
        - listingTermsId
        - capacityListingId
        - pricePerGpuHourMicroUsd
        - renewable
      properties:
        listingTermsId:
          type: string
          format: uuid
          description: Send as listingTermId in offers and purchases.
        capacityListingId:
          type: string
          format: uuid
        type:
          type:
            - string
            - 'null'
          enum:
            - reserved
            - spot
            - on-demand
            - null
        renewable:
          type: boolean
        minDurationHours:
          type:
            - number
            - 'null'
        maxDurationHours:
          type:
            - number
            - 'null'
        downPaymentCents:
          type:
            - integer
            - 'null'
          format: int64
        pricePerGpuHourMicroUsd:
          type: integer
          format: int64
          description: >-
            The listing's price. On relisted capacity this is the seller's
            asking price before fees; buyers pay the schedule price instead.
        preemptNoticeSeconds:
          type: integer
          minimum: 0
          maximum: 604800
          description: >-
            Spot and On-demand terms only. The least notice, in seconds, a VM
            sold on this term gets before its seller can take the node back. 0
            means no notice. Spot terms on a relist are always 3600; a value you
            send is replaced.
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        detail:
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
    CapacityRequestBodyError:
      type: object
      description: Returned for a malformed JSON body or an unknown field.
      properties:
        error:
          type: string
      example:
        error: invalid request body
  responses:
    Unauthorized:
      description: >-
        The credential is missing, invalid, revoked, or no longer belongs to a
        current organization member. Check the HTTP status before parsing the
        body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: >-
        Unsuccessful request. Check HTTP status first. Errors may have
        detail.code/detail.message, a string detail and optional top-level code,
        or an empty/non-JSON body. 401: invalid credential; 403: access or
        approval required; 404: not visible or credentials not ready; 409:
        lifecycle conflict; 429: back off; 5xx: service failure. Inspect current
        state before retrying mutations.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    OrnnApiKey:
      type: http
      scheme: bearer
      bearerFormat: ornn_sk_...
      description: >-
        Create an organization API key in Account Settings > Developer. Do not
        send this key to the Kubernetes API server.

````

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