Hubble Network · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hubble Platform Billing API

7 actions 7 updates phrasing extends openapi/hubble-network-billing-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hubble Network's API. It is a proposal applied on top of the contract, not a document Hubble Network publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/org/{org_id}/billing/invoices'].get
$.paths['/v1/org/{org_id}/billing/invoices/{invoice_id}/pdf'].get
$.paths['/v1/org/{org_id}/billing/usage'].get
$.paths['/v1/org/{org_id}/billing/active-devices'].get
$.paths['/v1/org/{org_id}/billing/subscription'].get
$.paths['/v1/org/{org_id}/billing/payment-method'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hubble Platform Billing API
  version: 1.0.0
extends: openapi/hubble-network-billing-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/org/{org_id}/billing/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent invoices
      effect: read
      questions:
      - Where can I see my organization's most recent invoices?
      - What have we been billed lately by Hubble Network?
      instructions:
      - text: List the most recent invoices for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show me our latest bills for org {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/billing/invoices/{invoice_id}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an invoice as a PDF
      effect: read
      questions:
      - How do I get a PDF copy of a specific invoice?
      - Can I download an invoice document to send to accounting?
      instructions:
      - text: Download the PDF for invoice {invoice_id} in organization {org_id}.
        slots:
          invoice_id: path.invoice_id
          org_id: path.org_id
      - text: Get me a printable copy of invoice {invoice_id} for org {org_id}.
        slots:
          invoice_id: path.invoice_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/billing/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Check current billing usage
      effect: read
      questions:
      - How much billable usage has my organization racked up recently?
      - What does our latest billing usage look like?
      instructions:
      - text: Show the most recent billing usage for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Pull our latest usage totals for billing in org {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/billing/active-devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices billed as active this period
      effect: read
      questions:
      - Which devices count as active in the current billing period?
      - Can I see only the satellite devices we're being billed for this period?
      - What makes a device count as active for billing purposes?
      instructions:
      - text: List the devices active in the current billing period for org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show billable active devices on the {network_type} network for org {org_id}, {limit} per page.
        slots:
          network_type: query.network_type
          org_id: path.org_id
          limit: query.limit
      - text: Get the next page of billing-period active devices for org {org_id} using token {Continuation-Token}.
        slots:
          org_id: path.org_id
          Continuation-Token: header.Continuation-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/billing/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: View the current subscription plan
      effect: read
      questions:
      - What plan tier is my organization subscribed to right now?
      - Is our subscription active, and when does the current billing period end?
      instructions:
      - text: Show the current subscription plan and status for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Tell me which plan tier org {org_id} is on and its billing period dates.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/billing/payment-method'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved payment cards
      effect: read
      questions:
      - Which credit cards are saved on file for my organization?
      - Which saved card is the default one used to pay invoices?
      instructions:
      - text: List the saved card payment methods for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show which card is the invoice default for org {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'