find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cockroachdb-billing-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: CockroachDB Cloud Billing API
  description: The CockroachDB Cloud API is a REST interface that provides programmatic access to manage the lifecycle of clusters within a CockroachDB Cloud organization.
  version: '2024-09-16'
  contact:
    name: Cockroach Labs Support
    url: https://support.cockroachlabs.com
  termsOfService: https://www.cockroachlabs.com/cloud-terms-and-conditions/
servers:
- url: https://cockroachlabs.cloud
  description: CockroachDB Cloud Production Server
security:
- bearerAuth: []
tags:
- name: Billing
  description: Retrieve invoices and billing information for the CockroachDB Cloud organization.
paths:
  /api/v1/invoices:
    get:
      operationId: ListInvoices
      summary: List invoices
      description: Returns a list of invoices for the organization. Optionally filter by invoice status to retrieve only Finalized or Draft invoices.
      tags:
      - Billing
      parameters:
      - name: status
        in: query
        description: Filter invoices by status. Accepted values are Finalized and Draft. If not specified, both types are returned.
        schema:
          type: string
          enum:
          - Finalized
          - Draft
      responses:
        '200':
          description: List of invoices returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInvoicesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/invoices/{invoice_id}:
    get:
      operationId: GetInvoice
      summary: Get an invoice
      description: Retrieves a specific invoice by its unique ID including line items and totals for the billing period.
      tags:
      - Billing
      parameters:
      - name: invoice_id
        in: path
        required: true
        description: Unique identifier of the invoice to retrieve.
        schema:
          type: string
      responses:
        '200':
          description: Invoice retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invoice'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: Standard error response returned by the API.
      properties:
        code:
          type: integer
          description: HTTP status code of the error.
        message:
          type: string
          description: Human-readable description of the error.
        details:
          type: array
          description: Additional detail objects providing error context.
          items:
            type: object
    Invoice:
      type: object
      description: A billing invoice for a CockroachDB Cloud organization.
      properties:
        id:
          type: string
          description: Unique identifier of the invoice.
        status:
          type: string
          description: Status of the invoice. Values include Finalized and Draft.
        period_start:
          type: string
          format: date-time
          description: Start of the billing period covered by this invoice.
        period_end:
          type: string
          format: date-time
          description: End of the billing period covered by this invoice.
        total_amount:
          type: number
          description: Total invoice amount in US cents.
    ListInvoicesResponse:
      type: object
      description: List of invoices for the organization.
      properties:
        invoices:
          type: array
          description: Array of invoice objects.
          items:
            $ref: '#/components/schemas/Invoice'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication. Generate a token in the CockroachDB Cloud Console under Organization Settings > API Access.
externalDocs:
  description: CockroachDB Cloud API Documentation
  url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api