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 Subscriptions API

The Subscriptions API from Hyperline — 6 operation(s) for subscriptions.

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

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

This API exposes 8 operations across 6 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.

8 operations 6 paths 1 schemas 2 GET1 PATCH5 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 Subscriptions 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 8

Across 6 paths, the API surfaces 8 operations — 2 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 8
GET
/subscriptions
List subscriptions
listSubscriptions → 200
POST
/subscriptions
Create a subscription
createSubscription body → 201
GET
/subscriptions/{id}
Retrieve a subscription
getSubscription 1 param → 200
PATCH
/subscriptions/{id}
Update a subscription
updateSubscription 1 param → 200
POST
/subscriptions/{id}/activate
Activate a subscription
activateSubscription 1 param → 200
POST
/subscriptions/{id}/cancel
Cancel a subscription
cancelSubscription 1 param → 200
POST
/subscriptions/{id}/pause
Pause a subscription
pauseSubscription 1 param → 200
POST
/subscriptions/refresh
Refresh subscriptions usage data and related open invoices
refreshSubscriptions → 202

Schemas 1

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

Subscription
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperline-subscriptions-api-openapi.yml Raw ↑

Other APIs Hyperline publishes across the network.

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