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

Wherobots subscriptions API

The subscriptions API from Wherobots — 7 operation(s) for subscriptions.

Wherobots subscriptions API is one of 34 APIs that Wherobots 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 and API documentation.

This API exposes 7 operations across 7 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.cloud.wherobots.com.

7 operations 7 paths 10 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.cloud.wherobots.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Wherobots subscriptions API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerToken). An API key is passed in the header as X-API-Key (wherobotsApiKey).

  • wherobotsApiKey — A Wherobots-generated API key

Paths & Operations 7

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

subscriptions 7
GET
/subscriptions/amazon-marketplace-customer
Get AWS Marketplace customer details
getAmazonMarketplaceCustomerDetails 1 param → 200400401403404409422500
POST
/subscriptions/aws-marketplace
Link organization to AWS Marketplace
linkAmazonMarketplace 1 param → 200400401403404409422500
GET
/subscriptions
Get current organization subscription
getMySubscription → 200400401403404409422500
POST
/subscriptions/upgrade
Initiate a subscription upgrade
initiateSubscriptionUpgrade → 200400401403404409422500
POST
/subscriptions/upgrade-confirmation
Confirm subscription upgrade with Stripe
confirmSubscriptionUpgrade body → 200400401403404409422500
POST
/subscriptions/cancel
Cancel organization Stripe subscription
cancelStripeSubscription → 200400401403404409422500
GET
/subscriptions/portal
Get billing portal URL
getPortalUrl → 200400401403404409422500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are SubscriptionInfo (8 properties), ErrorInfo (7 properties), StripeSubscription (7 properties), AwsMarketplaceSubscription (6 properties). Each schema is shown below with its type and property counts.

InternalDevelopmentSubscription
object
5 properties 5 required
ErrorInfo
object
7 properties 4 required
SubscriptionInfo
object
Detailed subscription information including type-specific fields. This model is used across endpoints to return comprehensive subscription data, with optional…
8 properties 5 required
AwsMarketplaceSubscription
object
6 properties 6 required
AmazonMarketplaceCustomerDetails
object
2 properties 2 required
StripeSubscription
object
7 properties 6 required
SubscriptionState
string
ErrorClass
string
ErrorBody
object
2 properties 2 required
UpgradeConfirmationRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-subscriptions-api-openapi.yml Raw ↑

Other APIs Wherobots publishes across the network.

Wherobots apikey API
Wherobots audit-log API
Wherobots catalogs API
Wherobots cloud-connections API
Wherobots coupon API
Wherobots environment-override--preset API
Wherobots environment-preset API
Wherobots files API
Wherobots Flags API
Wherobots foreign-catalog API
Wherobots Health API
Wherobots Is Super User API