How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

M3ter Commitments API

Endpoints that manage Commitments *(also known as Prepayments)* in the context of usage-based pricing and billing. A Commitment represents an agreement where the end-customer has agreed to pay a fixed minimum amount throughout the contract period. ***The commitment amount is payable regardless of the actual usage by the customer of your service or product.***These endpoints enable the creation, updating, retrieval, and deletion of Commitments. Use them to manage your customer's Commitments and ensure optimal revenue recognition:* Specify which type of charges can draw-down against a Commitment amount on an Account at billing: usage, minimum spend, standing charges, or recurring charges.* Define overage surcharge percentages, which are applied when the usage charges exceed the agreed Commitment amount within the contract duration.#### What is the difference between Balances and Commitments/Prepayments?To manage credit amounts for your end-customer Accounts, you can use Balances or Commitments/Prepayments. However, these two kinds of credits for Accounts serve different purposes.Commitments/Prepayments are used for amounts end-customers have agreed to pay for consuming your product or services across a full contract term. A customer might pay the entire or only part of the agreed amount upfront, but ***the prepayment amount is payable regardless of the actual usage by the customer of your service or product.***In contrast, a Balance - often referred to as a Top-Up or Prepaid draw-down - is used when a customer wants to add a credit amount to their Account at any time during the service period or when you as service provider want to add a credit to a customer Account. This Balance credit can then be drawn-down against for billing the Account for usage, minimum spend, standing charges, or recurring charges due. Balances therefore serve payment use cases in a more flexible way, for example to be used for a "Free Credit" sign-up scheme you offer to encourage sales or to enhance customer satisfaction by adding credit to an Account to compensate for service delivery issues.You can use Prepayments/Commitments and Balances together on Account, and define at Organization or individual Account level the order in which any Balance/Prepayment credit on an Account is drawn-down - Balance amounts first or Prepayment amounts first.#### Billing for Commitments If not all of an agreed Commitment amount is paid at the start of an end-customer contract period, you can choose one of two options for billing the outstanding fees due on the customer Account:- Select a Product *Plan to bill with*.- Define a *schedule of billing dates*.

M3ter Commitments API is one of 58 APIs that M3ter 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, an API reference, authentication docs, and a getting-started guide.

This API exposes 6 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

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

6 operations 3 paths 8 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.m3ter.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

M3ter Commitments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials and authorizationCode flows, exposing 6 scopes. By default, every request must be authenticated.

  • OAuth2 — m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow. The authorizationCode flow controls access for human users via the m3…

Paths & Operations 6

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

Commitments 6

Endpoints that manage Commitments (also known as Prepayments) in the context of usage-based pricing and billing. A Commitment represents an agreement where the end-customer has ag…

GET
/organizations/{orgId}/commitments/{id}
Retrieve Commitment
GetCommitment 2 params → 2004XX5XX
PUT
/organizations/{orgId}/commitments/{id}
Update Commitment
PutCommitment 2 params body → 2004XX5XX
DELETE
/organizations/{orgId}/commitments/{id}
Delete Commitment
DeleteCommitment 2 params → 2004XX5XX
GET
/organizations/{orgId}/commitments
List Commitments
ListCommitments 10 params → 2004XX5XX
POST
/organizations/{orgId}/commitments
Create Commitment
PostCommitment 1 param body → 2004XX5XX
GET
/organizations/{orgId}/commitments/search
Search Commitments
SearchCommitments 7 params → 2004XX5XX

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CommitmentFee (4 properties), AbstractResponse (2 properties), PaginatedCommitmentResponseData (2 properties), AbstractRequest (1 property). Each schema is shown below with its type and property counts.

PaginatedCommitmentResponseData
object
2 properties
CommitmentResponse
object
AbstractResponse
object
2 properties 1 required
CommitmentRequest
object
CommitmentFee
object
4 properties 4 required
ChildBillingMode
string
If the Account is either a Parent or a Child Account, this specifies the Account hierarchy billing mode. The mode determines how billing will be handled and sh…
AbstractRequest
object
1 property
CommitmentLineItemType
string
Available line item types for Commitments

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

m3ter-commitments-api-openapi.yml Raw ↑

Other APIs M3ter publishes across the network.

M3ter Account API
M3ter AccountPlan API
M3ter Aggregation API
M3ter Auth API
M3ter BalanceChargeSchedule API
M3ter Balances API
M3ter BalanceTransactionSchedule API
M3ter Bill API
M3ter BillConfig API
M3ter BillGroupingKey API
M3ter BillJob API
M3ter Charge API
Where this information came from

This is an independent, third-party profile of M3ter Commitments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.