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

Koyeb Subscriptions API

The Subscriptions API from Koyeb — 1 operation(s) for subscriptions.

Koyeb Subscriptions API is one of 42 APIs that Koyeb 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 1 operation across 1 path, and defines 10 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://app.koyeb.com.

1 operations 1 paths 10 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://app.koyeb.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Koyeb Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

Paths & Operations 1

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

Subscriptions 1
GET
/v1/subscriptions/{id}
Get Subscription
GetSubscription 1 param → 200400401403404500503default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Subscription (24 properties), Subscription.PaymentFailure (10 properties), ErrorWithFields (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Subscription.PaymentFailure.StripeSDK
object
2 properties
google.rpc.Status
object
3 properties
ErrorWithFields
object
4 properties
Subscription
object
24 properties
google.protobuf.Any
object
1 property
Subscription.Status
string
ErrorField
object
2 properties
Subscription.PaymentFailure
object
10 properties
Error
object
3 properties
GetSubscriptionReply
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-subscriptions-api-openapi.yml Raw ↑

Other APIs Koyeb publishes across the network.

Koyeb activity API
Koyeb Apps API
Koyeb Archives API
Koyeb billing API
Koyeb CatalogDatacenters API
Koyeb CatalogInstances API
Koyeb CatalogInstanceUsage API
Koyeb CatalogRegions API
Koyeb Compose API
Koyeb Coupons API
Koyeb Credentials API
Koyeb Deployments API