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

Hyperline Customers API

The Customers API from Hyperline — 5 operation(s) for customers.

Hyperline Customers API is one of 7 APIs that Hyperline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.hyperline.co/v1, https://sandbox.api.hyperline.co/v1.

9 operations 5 paths 1 schemas 1 DELETE4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.hyperline.co/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Authenticate with your Hyperline API key passed as a bearer token in the Authorization header - Authorization: Bearer .

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Customers 9
GET
/customers
List customers
listCustomers 2 params → 200
POST
/customers
Create a customer
createCustomer body → 201
GET
/customers/{id}
Retrieve a customer
getCustomer 1 param → 200
PATCH
/customers/{id}
Update a customer
updateCustomer 1 param body → 200
DELETE
/customers/{id}
Delete a customer (must be archived first)
deleteCustomer 1 param → 204
POST
/customers/{id}/archive
Archive a customer
archiveCustomer 1 param → 200
GET
/customers/{id}/credits
List a customer's credits
listCustomerCredits 1 param → 200
POST
/customers/{id}/credits
Grant a credit to a customer
createCustomerCredit 1 param → 201
GET
/customers/{id}/usage/{aggregatorId}
Get aggregated usage for a customer
getCustomerUsage 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Customer (5 properties). Each schema is shown below with its type and property counts.

Customer
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperline-customers-api-openapi.yml Raw ↑

Other APIs Hyperline publishes across the network.

Hyperline Billable Events API
Hyperline Invoices API
Hyperline Payments API
Hyperline Products API
Hyperline Subscriptions API
Hyperline Webhooks API