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

Tabs Commitments API

The Commitments API from Tabs — 2 operation(s) for commitments.

Tabs Commitments API is one of 23 APIs that Tabs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://integrators.prod.api.tabsplatform.com.

3 operations 2 paths 14 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://integrators.prod.api.tabsplatform.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Tabs Commitments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (custom-header). By default, every request must be authenticated.

Paths & Operations 3

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

Commitments 3
GET
/v3/commitments
List commitments
IntegratorsApiCommitmentsController_getAllCommitments 3 params → 200500
POST
/v3/commitments
Create commitments
IntegratorsApiCommitmentsController_createUsageCommitments body → 201400404
PATCH
/v3/commitments/{commitmentId}
Update commitment
IntegratorsApiCommitmentsController_updateUsageCommitment 1 param body → 200400404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are CommitmentDto (21 properties), CreateUsageCommitmentV3Dto (20 properties), CommitmentPeriodDto (8 properties), CreateUsageCommitmentOveragePricingItemV3Dto (7 properties). Each schema is shown below with its type and property counts.

EventTypeOverageDto
object
4 properties 3 required
CreateUsageCommitmentsV3RequestDto
object
2 properties 2 required
CommitmentDto
object
21 properties 10 required
CommitmentPeriodDto
object
8 properties 6 required
PeriodAmountsDto
object
3 properties 3 required
IntegratorsApiResponse
object
4 properties 4 required
TotalsDto
object
IntegratorsApiError
object
3 properties 2 required
CreateUsageCommitmentOverageConfigV3Dto
object
5 properties 2 required
MetricsDto
object
2 properties 2 required
PaginatedResponseDTO
object
UpdateUsageCommitmentV3RequestDto
object
7 properties
CreateUsageCommitmentV3Dto
object
20 properties 4 required
CreateUsageCommitmentOveragePricingItemV3Dto
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabs-commitments-api-openapi.yml Raw ↑

Other APIs Tabs publishes across the network.

Tabs Billing Terms API
Tabs Categories API
Tabs Classes (QBO only) API
Tabs Contracts API
Tabs Credit Memos API
Tabs Custom Fields API
Tabs Customers API
Tabs Departments API
Tabs Events API
Tabs Health API
Tabs Invoices API
Tabs Items API