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

Calm Subscriptions API

Link and cancel partner-user Calm subscriptions.

Calm Subscriptions API is one of 2 APIs that Calm 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 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v0.

Requests are made against 2 base URLs: https://auth.calm.com, https://auth-ga.aws-dev.useast1.calm.com.

2 operations 2 paths 3 schemas 1 DELETE1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v0
Base URL
https://auth.calm.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Calm Subscriptions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (CalmOAuth2) using the clientCredentials flow, exposing 2 scopes.

  • CalmOAuth2 — OAuth 2.0 client-credentials grant against the Calm auth service.

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.

Subscriptions 2

Link and cancel partner-user Calm subscriptions.

POST
/v0/b2b/users/link
Link a partner user to a Calm subscription
linkUser 1 param body → 200303400401
DELETE
/v0/b2b/users/{partner_user_id}
Cancel a partner user subscription
cancelUser 1 param → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CancelResponse (4 properties), LinkRequest (2 properties), LinkPseudoResponse (1 property). Each schema is shown below with its type and property counts.

LinkPseudoResponse
object
1 property
LinkRequest
object
2 properties 1 required
CancelResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calm-subscriptions-api-openapi.yml Raw ↑

Other APIs Calm publishes across the network.

Calm Authentication API