Orb

Orb Availability API

The Availability API from Orb — 1 operation(s) for availability.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.withorb.com/
📖
GettingStarted
https://docs.withorb.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/orb/refs/heads/main/openapi/orb-availability-api-openapi.yml

OpenAPI Specification

orb-availability-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Orb Alerts Availability API
  description: Orb is a billing platform for usage-based pricing. The API supports customers, plans, subscriptions, invoices, alerts, coupons, credit notes, and event ingestion.
  version: '1.0'
servers:
- url: https://api.withorb.com/v1
  description: Orb API
tags:
- name: Availability
paths:
  /availability:
    get:
      summary: Test connection to the Orb API and check API key validity
      operationId: checkAvailability
      responses:
        '200':
          $ref: '#/components/responses/Generic'
      tags:
      - Availability
components:
  responses:
    Generic:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
x-generated-from: https://docs.withorb.com/llms.txt
x-generated-by: claude-crawl-2026-05-08