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

Tackle Subscriptions API

Operations for Subscriptions

Tackle Subscriptions API is one of 25 APIs that Tackle 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 an API reference.

This API exposes 2 operations across 2 paths, and defines 44 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.tackle.io.

2 operations 2 paths 44 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.tackle.io
Authentication
HTTP Bearer, HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Tackle Subscriptions API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (BasicAuthCallback). An API key is passed in the header as subscription-key (HeaderApiKeyAuthCallback). It supports OAuth 2.0 (Oauth2AuthCallback) using the clientCredentials flow.

  • BearerAuth — The Tackle API requires a JWT for authentication. You can get this by [getting your API credentials](https://developers.tackle.io/docs/how-to-get-an-m2m-client…
  • BasicAuthCallback — Use basic for [basic HTTP authentication](https://en.wikipedia.org/wiki/Basicaccessauthentication); this is only used for callbacks
  • HeaderApiKeyAuthCallback — Use headerapikey to specify a custom HTTP request header for authentication. Requests from Tackle will use the specified HTTP header for outbound requests to y…
  • Oauth2AuthCallback — This auth-type is for oauth2 client credentials flow. We will use the clientid and clientsecret to call the tokenurl to get an access token; this is only used…

Paths & Operations 2

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

Subscriptions 2

Operations for Subscriptions

GET
/v1/subscriptions
List Subscriptions
v1-list-subscriptions 5 params → 200401
GET
/v1/subscriptions/{tackle_subscription_id}
Get a Subscription
v1-get-subscription 1 param → 200401404

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are GcpEntitlement (17 properties), Subscription (13 properties), RedHatEntitlement (9 properties), AzureEntitlement (5 properties). Each schema is shown below with its type and property counts.

TimestampZeroUtcOffsetOptional
string
Optional ISO format timestamp with zero UTC offset
AwsCustomerId
string
AWS Account Reference ID
SubscriptionLink
string
A URL for a given subscription resource
CustomerId
TimestampZeroUtcOffset
string
ISO format timestamp with zero UTC offset
RedHatCustomerId
string
Red Hat Customer Id
SubscriptionId
string
Subscription Id
RedHatCloud
string
Red Hat Cloud
AwsMarketplaceData
object
Marketplace data specific to AWS
1 property
RedHatSubscriptionRenewType
string
Renew Type
RedHatTermUnit
string
The unit for the term
AwsCloud
string
AWS Cloud
GcpEntitlement
object
A purchase entitlement from GCP Marketplace
17 properties 5 required
IsFreeTrial
boolean
Designation for Free Trial
ProductLink
string
A URL for a given product resource
SubscriptionDetails
object
3 properties
OtherMarketplaceData
object
GCP, Azure, and Red Hat do not currently have marketplace specific data
AzureCustomerId
string
Azure Subscription ID
Error
object
4 properties 3 required
AzureEntitlement
object
A purchase entitlement from Azure Marketplace
5 properties 5 required
Metadata
object
Metadata for a given request
1 property 1 required
AwsEntitlement
object
A purchase entitlement from AWS Marketplace
4 properties 4 required
SubscriptionItem
object
1 property
AwsProductId
string
AWS Product Code
ListSubscriptionsResponse
object
Response describing data containing a list of subscriptions and additional response metadata
2 properties 2 required
Subscription
object
13 properties 4 required
GcpCustomerId
string
GCP External Account ID
Entitlement
object
A purchase entitlement for a given cloud marketplace
AzureCloud
string
Azure Cloud
SubscriptionContracted
ProductId
Cloud Marketplace issued ID for a product
AzureProductId
string
Azure Offer ID
GcpProductId
string
GCP Solution ID
RedHatSubscriptionType
string
Type of the subscription
OfferId
string
The AWS issued offer ID, Seller created Azure Plan ID, or the GCP issued Quote ID
MarketplaceData
The marketplace data object contains fields specific to the marketplaces
RegistrationDetails
object
Registration details of a purchaser that map to defined registration page fields for a given listing. The following fields are required at a minimum: - Company…
3 properties 3 required
Entitlements
array
A list of Entitlement objects
GetSubscriptionResponse
object
Response describing data containing a single subscription and other metadata
2 properties 2 required
RedHatEntitlement
object
A purchase entitlement from Red Hat Marketplace
9 properties 9 required
GcpCloud
string
GCP Cloud
SubscriptionExpanded
Clouds
A string identifying a cloud marketplace
RedHatProductId
string
Red Hat Product Id

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackle-subscriptions-api-openapi.yml Raw ↑

Other APIs Tackle publishes across the network.

Tackle Authentication API
Tackle Contracts API
Tackle Currencies API
Tackle Disbursements API
Tackle Entitlements API
Tackle Groups API
Tackle Invitations API
Tackle Invoices API
Tackle Marketplace API
Tackle Metering API
Tackle Notifications API
Tackle Opportunities API