Calm Subscriptions API
Provision and revoke Calm subscriptions linked to partner users.
Calm Subscriptions API is one of 2 APIs that Calm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 0.
Requests are made against 2 base URLs: https://auth.calm.com, https://auth-ga.aws-dev.useast1.calm.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Calm Subscriptions API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
bearerAuth— JWT access token issued by POST /v0/authorize.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 DELETE, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Provision and revoke Calm subscriptions linked to partner users.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are LinkUserRequest (4 properties), LinkUserResponse (4 properties), CancelSubscriptionResponse (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Calm 1
Other APIs Calm publishes across the network.