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

Metronome Credits and commits API

Credits and commits are used to manage customer balances.

Metronome Credits and commits API is one of 18 APIs that Metronome publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credits and commits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 16 operations across 16 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

16 operations 16 paths 68 schemas 16 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.metronome.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Metronome Credits and commits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 16

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

Credits and commits 16

Credits and commits are used to manage customer balances.

POST
/v1/contracts/addManualBalanceLedgerEntry
Add a manual balance entry
addManualBalanceLedgerEntry-v1 body → 200400404
POST
/v1/contracts/customerCommits/list
List commits
listCustomerCommits-v1 body → 200
POST
/v1/contracts/customerCommits/create
Create a commit
createCustomerCommit-v1 body → 200400404
POST
/v1/contracts/customerCommits/updateEndDate
Update the commit end date
updateCommitEndDate-v1 body → 200400404
POST
/v1/contracts/commits/threshold-billing/release
Release external payment gate threshold commit
releaseExternalPaymentGateThresholdCommit-v1 body → 200
POST
/v1/contracts/commits/disableTrueup
Disable trueup for commit
disableCommitTrueup-v1 body → 200400404
POST
/v1/contracts/customerCredits/list
List credits
listCustomerCredits-v1 body → 200
POST
/v1/contracts/customerCredits/create
Create a credit
createCustomerCredit-v1 body → 200400404
POST
/v1/contracts/customerCredits/updateEndDate
Update the credit end date
updateCreditEndDate-v1 body → 200400404
POST
/v1/contracts/customerBalances/list
List balances
listCustomerBalances-v1 body → 200
POST
/v1/contracts/customerBalances/getNetBalance
Get the net balance of a customer
getNetBalance-v1 body → 200400
POST
/v1/contracts/seatBalances/list
List seat balances
listSeatBalances-v1 body → 200404
POST
/v2/contracts/commits/edit
Edit a commit
editCommit-v2 body → 200400
POST
/v2/contracts/credits/edit
Edit a credit
editCredit-v2 body → 200400
POST
/v2/contracts/commits/archive
Archive a commit
archiveCommit-v2 body → 200400
POST
/v2/contracts/credits/archive
Archive a credit
archiveCredit-v2 body → 200400

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are Commit (29 properties), Credit (23 properties), CreateCustomerCommitPayload (18 properties), CreateCustomerCreditPayload (15 properties). Each schema is shown below with its type and property counts.

ExcludeSpecifier
object
1 property
PrepaidCommitExpirationLedgerEntry
object
4 properties 4 required
CreditExpirationLedgerEntry
object
4 properties 4 required
PrepaidCommitManualLedgerEntry
object
4 properties 4 required
CreditAutomatedInvoiceDeductionLedgerEntry
object
6 properties 5 required
CommitHierarchyChildAccessAll
object
1 property 1 required
SchedulePointInTime
object
3 properties
CustomField
object
Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
PrepaidCommitCreditedLedgerEntry
object
6 properties 5 required
CommitSpecifier
object
5 properties
SeatCreditBalance
object
5 properties 3 required
ArchiveCommitPayload
object
2 properties 2 required
SchedulePointInTimeInput
object
Must provide either scheduleitems or recurringschedule.
4 properties
PostpaidCommitAutomatedInvoiceDeductionLedgerEntry
object
6 properties 5 required
PrepaidCommitSeatBasedAdjustmentLedgerEntry
object
4 properties 4 required
SeatBalanceCommitLedger
object
3 properties 3 required
SeatBalanceCreditLedger
object
3 properties 3 required
UpdateCommitEndDatePayload
object
4 properties 2 required
CreditRolloverLedgerEntry
object
5 properties 5 required
EditCreditPayload
object
12 properties 2 required
SeatBalanceCreditLedgerEntryType
string
CommitHierarchyChildAccessContractIds
object
2 properties 2 required
SeatBalance
object
4 properties 2 required
PostpaidCommitManualLedgerEntry
object
4 properties 4 required
CreditCreditedLedgerEntry
object
6 properties 5 required
CommitLedger
CreditCanceledLedgerEntry
object
6 properties 5 required
Credit
object
23 properties 3 required
ApplySeatIncreaseConfigForRecurringCommit
object
1 property 1 required
UpdateInvoiceScheduleInput
object
3 properties
CreditLedger
CommitHierarchyChildAccessNone
object
1 property 1 required
PrepaidCommitCanceledLedgerEntry
object
6 properties 5 required
PostpaidCommitRolloverLedgerEntry
object
5 properties 5 required
EditCommitPayload
object
14 properties 2 required
ScheduleDurationInput
object
2 properties 1 required
AddManualBalanceLedgerEntryPayload
object
8 properties 5 required
UniquenessKeyForCommitsAndCredits
string
Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or cre…
BalanceFilter
object
3 properties
SeatBalanceCommitLedgerEntryType
string
PrepaidCommitSegmentStartLedgerEntry
object
4 properties 4 required
CreateCustomerCommitPayload
object
18 properties 5 required
UpdateAccessScheduleInput
object
3 properties
PrepaidCommitAutomatedInvoiceDeductionLedgerEntry
object
6 properties 5 required
CreditSegmentStartLedgerEntry
object
4 properties 4 required
CreditSeatBasedAdjustmentLedgerEntry
object
4 properties 4 required
Id
object
1 property 1 required
Error
object
1 property 1 required
PostpaidCommitTrueupLedgerEntry
object
5 properties 4 required
ScheduleDuration
object
2 properties 1 required
Commit
object
29 properties 4 required
CommitSpecifierInput
object
5 properties
SeatCommitBalance
object
5 properties 3 required
CreditType
object
2 properties 2 required
CreateCustomerCreditPayload
object
15 properties 4 required
SubscriptionConfigAllocation
string
BalanceForCommitsAndCredits
number
The current balance of the credit or commit. This balance reflects the amount of credit or commit that the customer has access to use at this moment - thus, ex…
CreditManualLedgerEntry
object
4 properties 4 required
CommitHierarchyConfiguration
object
1 property 1 required
DisableCommitTrueupPayload
object
4 properties 3 required
PrepaidCommitRolloverLedgerEntry
object
5 properties 5 required
PostpaidCommitExpirationLedgerEntry
object
3 properties 3 required
RecurringScheduleFrequency
string
ExternalPaymentGateThresholdCommitPayload
object
2 properties 2 required
ArchiveCreditPayload
object
2 properties 2 required
PostpaidCommitInitialBalanceLedgerEntry
object
3 properties 3 required
SeatBalanceByCreditType
object
3 properties 3 required
UpdateCreditEndDatePayload
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

metronome-credits-and-commits-api-openapi.yml Raw ↑

Other APIs Metronome publishes across the network.

Metronome Alerts API
Metronome Billable Metrics API
Metronome Contracts API
Metronome Custom fields API
Metronome Customers API
Metronome Integrations API
Metronome Invoices API
Metronome Named schedules API
Metronome Notifications API
Metronome Packages API
Metronome Payments API
Metronome Products API
Where this information came from

This is an independent, third-party profile of Metronome Credits and commits 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.