Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HorizonIQ Billing API

Endpoints related to Billing

HorizonIQ Billing API is one of 9 APIs that HorizonIQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 7 operations across 7 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 2023-05-30T22:28:43Z.

Requests are made against a single base URL, https://api.compass.horizoniq.com/{basePath}.

7 operations 7 paths 9 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2023-05-30T22:28:43Z
Base URL
https://api.compass.horizoniq.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

HorizonIQ Billing API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API token issued from the Compass portal (Profile API Tokens). Sent as Authorization: Bearer . See https://compass-horizoniq.readme.io/reference/authentication

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Billing 7

Endpoints related to Billing

GET
/billing/credits
List Credits
getBillingCredits 5 params → 200
GET
/billing/invoices/{invoiceUUID}/csv
Get Invoice CSV
getBillingInvoicesByInvoiceUUIDCsv 2 params → 200404
GET
/billing/invoices/{invoiceUUID}/pdf
Get Invoice PDF
getBillingInvoicesByInvoiceUUIDPdf 2 params → 200404
GET
/billing/invoices/{invoiceUUID}
Get Invoice
getBillingInvoicesByInvoiceUUID 2 params → 200404
GET
/billing/invoices
List Invoices
getBillingInvoices 6 params → 200
GET
/billing/services/active
List Active Services
getBillingServicesActive 5 params → 200
GET
/billing/services/cancelled
List Cancelled Services
getBillingServicesCancelled 5 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ServiceGetModel (18 properties), InvoiceGetModel (11 properties), CreditGetModel (11 properties), InvoiceListModel (7 properties). Each schema is shown below with its type and property counts.

CreditListModel
object
6 properties
InvoiceListModel
object
7 properties
ErrorModel
object
1 property
InvoiceGetPdfModel
object
2 properties
ServiceGetModel
object
18 properties
InvoiceGetCsvModel
object
2 properties
ServiceListModel
array
InvoiceGetModel
object
11 properties
CreditGetModel
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

horizoniq-billing-api-openapi.yml Raw ↑

Other APIs HorizonIQ publishes across the network.

HorizonIQ Action Items API
HorizonIQ Devices API
HorizonIQ Images API
HorizonIQ Managed Firewalls API
HorizonIQ Servers API
HorizonIQ SSL Certificates API
HorizonIQ Support API
HorizonIQ User Accounts API