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

APIs.io Engineering Platform User Subscription API

The User Subscription API from APIs.io Engineering Platform — 2 operation(s) for user subscription.

This API exposes 3 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

3 operations 2 paths 24 schemas 1 DELETE1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform User Subscription API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User Subscription 3
GET
/user/subscriptions
APIs.io Engineering Platform Get User Subscriptions
user-subscription-get-user-subscriptions → 4XX200
DELETE
/user/subscriptions/{identifier}
APIs.io Engineering Platform Delete User Subscription
user-subscription-delete-user-subscription 1 param body → 4XX200
PUT
/user/subscriptions/{identifier}
APIs.io Engineering Platform Update User Subscription
user-subscription-update-user-subscription 1 param body → 4XX200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are bill-subs-api_subscription-v2 (11 properties), bill-subs-api_rate_plan (7 properties), bill-subs-api_result_info (4 properties), bill-subs-api_component_value (4 properties). Each schema is shown below with its type and property counts.

bill-subs-api_rate_plan
object
The rate plan applied to the subscription.
7 properties
bill-subs-api_api-response-collection
object
bill-subs-api_subscription
object
bill-subs-api_zone
object
A simple zone object. May have null properties if not a zone subscription.
2 properties
bill-subs-api_messages
array
bill-subs-api_component_values
array
The list of add-ons subscribed to.
bill-subs-api_install_id
string
app install id.
bill-subs-api_name
string
The domain name
bill-subs-api_subscription-v2
object
11 properties
bill-subs-api_api-response-common-failure
object
4 properties 4 required
bill-subs-api_user_subscription_response_collection
bill-subs-api_price
number
The price of the subscription that will be billed, in US dollars.
bill-subs-api_component_value
object
A component value for a subscription.
4 properties
bill-subs-api_schemas-identifier
string
Subscription identifier tag.
bill-subs-api_identifier
string
Identifier
bill-subs-api_frequency
string
How often the subscription is renewed automatically.
bill-subs-api_state
string
The state that the subscription is in.
bill-subs-api_current_period_end
string
The end of the current period and also when the next billing is due.
bill-subs-api_currency
string
The monetary unit in which pricing information is displayed.
bill-subs-api_user_subscription_response_single
bill-subs-api_api-response-single
object
bill-subs-api_current_period_start
string
When the current billing period started. May match initialperiodstart if this is the first period.
bill-subs-api_result_info
object
4 properties
bill-subs-api_api-response-common
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-user-subscription-api-openapi.yml Raw ↑