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.io Metering API

The Metering API from Tackle.io — 2 operation(s) for metering.

Tackle.io Metering API is one of 28 APIs that Tackle.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metering. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

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

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

5 operations 2 paths 49 schemas 1 DELETE2 GET1 POST1 PUT

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
Resource Areas
1

Authentication & Security 1

Tackle.io Metering API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (tackleJwt). By default, every request must be authenticated.

  • tackleJwt — Tackle-issued JWT (interactive user or MTM token).

Paths & Operations 5

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

Metering 5
POST
/v1/metering/usage-records
Create Usage Records
v1-create-metering-usage-records body → 200400401404
PUT
/v1/metering/usage-records
Create or Update Usage Records
v1-create-update-metering-usage-records body → 200400401404409
GET
/v1/metering/usage-records
List Usage Records
v1-list-metering-usage-records 13 params → 200401
GET
/v1/metering/usage-records/{usage_record_id}
Get a Usage Record
v1-get-metering-usage-record 1 param → 200400401404
DELETE
/v1/metering/usage-records/{usage_record_id}
Delete a Usage Record
v1-delete-metering-usage-record 1 param → 200400401404

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are UsageRecord (15 properties), GcpUsageRecordRequestByProductAndCustomer (8 properties), GcpUsageRecordRequestBySubscription (7 properties), AzureUsageRecordRequestByProductAndCustomer (7 properties). Each schema is shown below with its type and property counts.

UsageRecordTest
string
Specifies if the Usage Record is a test. When NOT null, the record is a test and is not sent to the marketplace
AwsDimension
object
Product Dimension
4 properties 2 required
AzureCustomerId
string
Azure Subscription ID
AwsProductId
string
AWS Product Code
UsageRecord
object
Metering Usage Record
15 properties
UsageRecordLink
string
Url for one or more metering usage records
UsageRecordDelete
object
Delete Usage Record Response
1 property
GcpUsageRecordRequestBySubscription
object
7 properties 4 required
NextPageToken
string
A page token to fetch the next page of results using the associated "page" query parameter
AzureProductId
string
Azure Offer ID
AwsMeteringSubscriptionId
string
Agreement ID, License ID or License ARN
RedHatProductId
string
Red Hat Product Id
GcpCustomerId
string
GCP External Account ID
Error
object
4 properties 3 required
AwsMeteringProductId
string
AWS Product Code
RedHatCustomerId
string
Red Hat Customer Id
AzureDimension
object
Product Dimension
2 properties 2 required
UsageRecordMetadata
object
Usage Record Metadata
1 property
UsageRecordStatus
string
Status of usage record
UsageRecordsMetadata
object
Usage Record Metadata
2 properties
Uuid
string
UUID
TimestampZeroUtcOffset
string
ISO format timestamp with zero UTC offset
ProductId
Cloud Marketplace issued ID for a product
AwsCloud
string
AWS Cloud
UsageRecordReason
string
Explanation of Status
TimestampZeroUtcOffsetOptional
string
Optional ISO format timestamp with zero UTC offset
AzureCloud
string
Azure Cloud
AwsUsageRecordRequest
RedHatCloud
string
Red Hat Cloud
Spec_prod_Error
object
4 properties 3 required
AzureUsageRecordRequest
AzureUsageRecordRequestBySubscription
object
6 properties 4 required
TimestampNotNull
string
ISO format timestamp with UTC offset
AwsCustomerId
string
AWS Account Reference ID
UsageRecordResponse
object
Usage Record Response
2 properties
AwsMeteringCustomerId
string
AWS Customer Reference ID or AWS Account Number
UsageRecordListResponse
object
Get All Usage Records Response
2 properties
Clouds
A string identifying a cloud marketplace
SubscriptionId
string
Subscription Id
GcpUsageRecordRequest
Timestamp
string
ISO format timestamp with UTC offset
CustomerId
AwsUsageRecordRequestByProductAndCustomer
object
7 properties 5 required
GcpCloud
string
GCP Cloud
AwsUsageRecordRequestBySubscription
object
6 properties 4 required
GcpUsageRecordRequestByProductAndCustomer
object
8 properties 6 required
AzureUsageRecordRequestByProductAndCustomer
object
7 properties 5 required
GcpProductId
string
GCP Solution ID
GcpDimension
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackleio-metering-api-openapi.yml Raw ↑

Other APIs Tackle.io publishes across the network.

Tackle.io Authentication API
Tackle.io Contracts API
Tackle.io Currencies API
Tackle.io Customers API
Tackle.io Disbursements API
Tackle.io Entitlements API
Tackle.io Groups API
Tackle.io Invitations API
Tackle.io Invoices API
Tackle.io Marketplace API
Tackle.io Notifications API
Tackle.io Opportunities API