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 Balances API

Endpoints for creating/retrieving/updating/deleting Balances on Accounts.When you have created a Balance for an Account, you can create a positive or negative Transaction amounts for the Balance. To do this, you must first define Transaction Types for your Organization, and then use one of these Transaction Types when you add a specific Transaction to a Balance - see the [Create TransactionType](https://www.m3ter.com/docs/api#tag/TransactionType/operation/CreateTransactionType) call in the Transaction Type section in this API Reference for more details.Balances are typically used when a customer prepays an amount to add a credit to their Account, which can then be draw-down against charges due for product or service consumption. You can include options to top-up the original Balance.Examples of how Balances for end customer Accounts can be used:* Onboarding Balance/Free Trials. Offering an onboarding incentive to new customers as an initial free credit Balance on their Account. * Balance as initial commitment. Add a Balance amount to a new customer Account. This acts as an initial commitment, which allows them to use the service and gain an accurate insight into their usage level. * Managing Customer Satisfaction. Use Balance as credits that will be applied to subsequent Bills as compensation for acknowledged service delivery issues.* Facilitating Balance Adjustments: * Apply negative amounts to immediately write-off outstanding Balances.#### 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 - also referred to as 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 commitment or 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 Commitments/Prepayments and Balances together on Account, and define at Organization or individual Account level the order in which any Balance/Commitment credit on an Account is drawn-down - Balance amounts first or Commitment/Prepayment amounts first.

M3ter Balances API is one of 58 APIs that M3ter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances. 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 8 operations across 4 paths, and defines 13 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.

8 operations 4 paths 13 schemas 1 DELETE4 GET2 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 Balances 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 8

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

Balances 8

Endpoints for creating/retrieving/updating/deleting Balances on Accounts. When you have created a Balance for an Account, you can create a positive or negative Transaction amounts…

GET
/organizations/{orgId}/balances/{balanceId}/transactions
List Transactions
ListBalanceTransactions 7 params → 2004XX5XX
POST
/organizations/{orgId}/balances/{balanceId}/transactions
Create Balance Transaction
PostBalanceTransaction 2 params body → 2004XX5XX
GET
/organizations/{orgId}/balances/{balanceId}/transactions/summary
Get Balance Transactions Summary
GetBalanceTransactionsSummary 2 params → 2004XX5XX
GET
/organizations/{orgId}/balances
List Balances
ListBalances 9 params → 2004XX5XX
POST
/organizations/{orgId}/balances
Create Balance
PostBalance 1 param body → 2004XX5XX
GET
/organizations/{orgId}/balances/{id}
Retrieve Balance
GetBalance 2 params → 2004XX5XX
PUT
/organizations/{orgId}/balances/{id}
Update Balance
PutBalance 2 params body → 2004XX5XX
DELETE
/organizations/{orgId}/balances/{id}
Delete Balance
DeleteBalance 2 params → 2004XX5XX

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are BalanceTransactionsSummary (6 properties), AbstractResponse (2 properties), PaginatedBalanceResponseData (2 properties), PaginatedBalanceTransactionResponseData (2 properties). Each schema is shown below with its type and property counts.

EntityType
string
PaginatedBalanceTransactionResponseData
object
2 properties
BalanceRequest
object
BalanceTransactionResponse
object
AbstractRequestWithCustomFields
object
AbstractResponse
object
2 properties 1 required
PaginatedBalanceResponseData
object
2 properties
BalanceTransactionRequest
object
BalanceLineItemType
string
Available line item types for Balances
AbstractRequest
object
1 property
BalanceTransactionsSummary
object
6 properties
BalanceResponse
object
AbstractResponseWithCustomFields
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

m3ter-balances-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 BalanceTransactionSchedule API
M3ter Bill API
M3ter BillConfig API
M3ter BillGroupingKey API
M3ter BillJob API
M3ter Charge API
M3ter Commitments API
Where this information came from

This is an independent, third-party profile of M3ter Balances 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.