Metronome API coverage
Every endpoint documented at docs.metronome.com, linked to its page, with what metro wraps.
metro does not copy Metronome's API reference. Metronome's docs are the source of truth for every endpoint, field and response, and they change without notice, so every row below links to the live page on docs.metronome.com (add .md to any page URL for markdown). This page shows only what metro wraps: op means a metro command calls the endpoint live (writes only through preview, confirm hash, sandbox-first apply and readback); catalog read and catalog write mean metro has a reviewed contract you can read with metro api explain <id>, with writes kept to local preview; not yet means read Metronome's page and do it there. The list is re-checked against Metronome's docs every week, and a change opens an issue on the metro repo.
Checked 2026-11-03 against docs.metronome.com/llms-full.txt: 108 documented endpoints. metro covers 80 (op 27, catalog read 31, catalog write 22); 28 are not yet wrapped.
| Endpoint | Metronome page | metro status | metro command |
|---|---|---|---|
POST /v1/alerts/archive | Archive a threshold notificationalerts | not yet | none |
POST /v1/alerts/create | Create a threshold notificationalerts | not yet | none |
POST /v1/customer-alerts/get | Get a threshold notificationalerts | catalog readalerts.getForCustomer | metro api explain alerts.getForCustomer |
POST /v1/customer-alerts/list | Get all threshold notificationsalerts | catalog readalerts.listForCustomer | metro api explain alerts.listForCustomer |
POST /v1/customer-alerts/reset | Reset a threshold notificationalerts | not yet | none |
GET /v1/billable-metrics | List all billable metricsbillable-metrics | catalog readbillableMetrics.list | metro api explain billableMetrics.list |
GET /v1/billable-metrics/{billable_metric_id} | Get a billable metricbillable-metrics | catalog readbillableMetrics.get | metro api explain billableMetrics.get |
PUT /v1/billable-metrics/{billable_metric_id} | Update a billable metricbillable-metrics | catalog · preview onlybillableMetrics.update | metro api explain billableMetrics.update |
POST /v1/billable-metrics/archive | Archive a billable metricbillable-metrics | catalog · preview onlybillableMetrics.archive | metro api explain billableMetrics.archive |
POST /v1/billable-metrics/create | Create a billable metricbillable-metrics | catalog · preview onlybillableMetrics.create | metro api explain billableMetrics.create |
GET /v1/customers/{customer_id}/billable-metrics | Get billable metrics for a customerbillable-metrics | catalog readbillableMetrics.listForCustomer | metro api explain billableMetrics.listForCustomer |
POST /v1/contracts/amend | Amend a contractcontracts | not yet | none |
POST /v1/contracts/archive | Archive a contractcontracts | op · gated write | metro contract repair-accidental |
POST /v1/contracts/create | Create a contractcontracts | op · gated writecontracts.create | metro contract createmetro contract move-planmetro contract move-plan previewmetro subscription contract preview |
POST /v1/contracts/createHistoricalInvoices | Create historical invoicescontracts | not yet | none |
POST /v1/contracts/get | Get a contract (v1)contracts | catalog readcontracts.get.v1 | metro api explain contracts.get.v1 |
POST /v1/contracts/getContractRateSchedule | Get the rate schedule for a contractcontracts | catalog readcontracts.getRateSchedule | metro api explain contracts.getRateSchedule |
POST /v1/contracts/getSubscriptionQuantityHistory | Get subscription quantity historycontracts | catalog readcontracts.getSubscriptionQuantityHistory | metro api read-plan contracts.getSubscriptionQuantityHistory |
POST /v1/contracts/getSubscriptionSeatsHistory | Get subscription seats historycontracts | op · live readcontracts.getSubscriptionSeatsHistory | metro subscription seatsmetro api read-plan contracts.getSubscriptionSeatsHistory |
POST /v1/contracts/list | List customer contracts (v1)contracts | catalog readcontracts.list.v1 | metro api explain contracts.list.v1 |
POST /v1/contracts/setUsageFilter | Set a contract usage filtercontracts | not yet | none |
POST /v1/contracts/updateEndDate | Update the contract end datecontracts | op · gated writecontracts.updateEndDate | metro contract expiremetro contract extend-trialmetro contract move-planmetro contract repair-accidentalmetro contract move-plan preview |
POST /v1/contracts/updateInvoiceIssueDate | Update invoice issue datecontracts | catalog · preview onlycontracts.updateInvoiceIssueDate | metro invoice issue-date preview |
POST /v1/packages/create | Create a packagecontracts | op · gated writepackages.create | metro package clone-versionmetro package createmetro package preview |
POST /v1/packages/listContractsOnPackage | List contracts associated with a packagecontracts | op · live readpackages.listContractsOnPackage | metro package customersmetro api read-plan packages.listContractsOnPackage |
POST /v2/contracts/edit | Edit a contractcontracts | op · gated writecontracts.edit.v2 | metro ledger-adjustmentmetro subscription addmetro subscription seatsmetro subscription set-quantitymetro credit preview |
POST /v2/contracts/get | Get a contract (v2)contracts | op · live readcontracts.get.v2 | metro contract createmetro contract expiremetro contract extend-trialmetro contract move-planmetro ledger-adjustmentmetro subscription addmetro subscription seatsmetro subscription set-quantitymetro contract inspect |
POST /v2/contracts/getEditHistory | Get contract edit historycontracts | catalog readcontracts.getEditHistory | metro api read-plan contracts.getEditHistory |
POST /v2/contracts/list | List customer contracts (v2)contracts | op · live readcontracts.list.v2 | metro contract createmetro contract expiremetro contract extend-trialmetro contract move-planmetro contract repair-accidentalmetro customer balancesmetro ledger-adjustmentmetro subscription addmetro subscription seatsmetro subscription set-quantitymetro customer billing-state |
POST /v1/contracts/addManualBalanceLedgerEntry | Add a manual balance entrycredits-and-commits | op · gated write | metro ledger-adjustment |
POST /v1/contracts/commits/disableTrueup | Disable trueup for commitcredits-and-commits | not yet | none |
POST /v1/contracts/commits/threshold-billing/release | Release external payment gate threshold commitcredits-and-commits | not yet | none |
POST /v1/contracts/customerBalances/getNetBalance | Get the net balance of a customercredits-and-commits | op · live readcustomerBalances.getNetBalance | metro customer balancesmetro ledger-adjustment |
POST /v1/contracts/customerBalances/list | List balancescredits-and-commits | op · live readcustomerBalances.list | metro contract move-planmetro customer balancesmetro ledger-adjustmentmetro customer billing-state |
POST /v1/contracts/customerCommits/create | Create a commitcredits-and-commits | not yet | none |
POST /v1/contracts/customerCommits/list | List commitscredits-and-commits | catalog readcommits.list | metro customer billing-state |
POST /v1/contracts/customerCommits/updateEndDate | Update the commit end datecredits-and-commits | not yet | none |
POST /v1/contracts/customerCredits/create | Create a creditcredits-and-commits | not yet | none |
POST /v1/contracts/customerCredits/list | List creditscredits-and-commits | catalog readcredits.list | metro customer billing-state |
POST /v1/contracts/customerCredits/updateEndDate | Update the credit end datecredits-and-commits | not yet | none |
POST /v1/contracts/seatBalances/list | List seat balancescredits-and-commits | catalog readseatBalances.list | metro api read-plan seatBalances.list |
POST /v2/contracts/commits/archive | Archive a commitcredits-and-commits | not yet | none |
POST /v2/contracts/commits/edit | Edit a commitcredits-and-commits | not yet | none |
POST /v2/contracts/credits/archive | Archive a creditcredits-and-commits | not yet | none |
POST /v2/contracts/credits/edit | Edit a creditcredits-and-commits | not yet | none |
POST /v1/customFields/addKey | Create a custom field keycustom-fields | catalog · preview onlycustomFields.addKey | metro api explain customFields.addKey |
POST /v1/customFields/deleteValues | Delete custom fieldscustom-fields | catalog · preview onlycustomFields.deleteValues | metro api explain customFields.deleteValues |
POST /v1/customFields/listKeys | List custom field keyscustom-fields | op · live readcustomFields.listKeys | metro customer create |
POST /v1/customFields/removeKey | Delete a custom field keycustom-fields | catalog · preview onlycustomFields.removeKey | metro api explain customFields.removeKey |
POST /v1/customFields/setValues | Set custom field valuescustom-fields | catalog · preview onlycustomFields.setValues | metro api explain customFields.setValues |
POST /v1/archiveCustomerBillingProviderConfigurations | Archive billing provider configurations for a customercustomers | op · gated write | metro billing-provider cutover |
GET /v1/customers | List customerscustomers | op · live readcustomers.list | metro customer createmetro api read-plan customers.list |
POST /v1/customers | Create a customercustomers | op · gated writecustomers.create | metro customer createmetro customer setup preview |
GET /v1/customers/{customer_id} | Get a customercustomers | catalog readcustomers.get | metro customer billing-state |
POST /v1/customers/{customer_id}/setIngestAliases | Create or update customer ingest aliasescustomers | catalog · preview onlycustomers.setIngestAliases | metro api explain customers.setIngestAliases |
POST /v1/customers/{customer_id}/setName | Update a customer namecustomers | not yet | none |
POST /v1/customers/{customer_id}/updateConfig | Update a customer configurationcustomers | catalog · preview onlycustomers.updateConfig | metro customer setup preview |
POST /v1/customers/archive | Archive a customercustomers | catalog · preview onlycustomers.archive | metro api explain customers.archive |
POST /v1/dashboards/getEmbeddableUrl | Get an embeddable customer dashboardcustomers | not yet | none |
POST /v1/getCustomerBillingProviderConfigurations | Fetch billing provider configurations for a customercustomers | op · live readbillingProvider.getCustomerConfigurations | metro billing-provider cutovermetro customer createmetro billing-provider inspect |
POST /v1/setCustomerBillingProviderConfigurations | Set billing provider configurations for a customercustomers | op · gated writebillingProvider.setCustomerConfigurations | metro billing-provider cutovermetro billing-provider preview |
GET /v1/customers/{customer_id}/invoices | List invoicesinvoices | op · live readinvoices.listForCustomer | metro contract move-planmetro contract repair-accidentalmetro customer billing-statemetro invoice inspect |
GET /v1/customers/{customer_id}/invoices/{invoice_id} | Get an invoiceinvoices | catalog readinvoices.getForCustomer | metro api explain invoices.getForCustomer |
GET /v1/customers/{customer_id}/invoices/{invoice_id}/pdf | Get an invoice PDFinvoices | catalog readinvoices.getPdf | metro api explain invoices.getPdf |
GET /v1/customers/{customer_id}/invoices/breakdowns | List invoice breakdownsinvoices | catalog readinvoices.listBreakdowns | metro api read-plan invoices.listBreakdowns |
POST /v1/customers/{customer_id}/previewEvents | Preview eventsinvoices | catalog · preview onlyinvoices.preview | metro usage ingest preview |
POST /v1/invoices/regenerate | Regenerate an invoiceinvoices | catalog · preview onlyinvoices.regenerate | metro api explain invoices.regenerate |
POST /v1/invoices/void | Void an invoiceinvoices | catalog · preview onlyinvoices.void | metro api explain invoices.void |
POST /v2/notifications/archive | Archive an offset lifecycle event notification configurationnotifications | not yet | none |
POST /v2/notifications/create | Create an offset lifecycle event notification configurationnotifications | not yet | none |
POST /v2/notifications/edit | Edit an offset or system notificationnotifications | not yet | none |
POST /v2/notifications/get | Get an offset lifecycle event notification configurationnotifications | catalog readnotifications.get | metro api explain notifications.get |
POST /v2/notifications/offset/list | List offset lifecycle event notification configurationsnotifications | catalog readnotifications.listOffset | metro api explain notifications.listOffset |
POST /v2/notifications/system/list | List system notification typesnotifications | catalog readnotifications.listSystem | metro api explain notifications.listSystem |
POST /v1/packages/list | List all packagesother | op · live readpackages.list | metro contract createmetro contract move-planmetro package clone-versionmetro package createmetro package customersmetro package inspect |
POST /v1/packages/archive | Archive a packagepackages | catalog · preview onlypackages.archive | metro package archive preview |
POST /v1/packages/get | Get a packagepackages | op · live readpackages.get | metro contract createmetro contract move-planmetro package clone-versionmetro package createmetro package customersmetro package inspect |
POST /v1/contract-pricing/products/archive | Archive a productproducts | catalog · preview onlyproducts.archive | metro product retire previewmetro rate-card dimensional preview |
POST /v1/contract-pricing/products/create | Create a productproducts | catalog · preview onlyproducts.create | metro rate-card dimensional preview |
POST /v1/contract-pricing/products/get | Get a productproducts | op · live readproducts.get | metro dimensional new-codemetro ratecard add-ratesmetro ratecard createmetro subscription addmetro product inspect |
POST /v1/contract-pricing/products/list | List productsproducts | catalog readproducts.list | metro api explain products.list |
POST /v1/contract-pricing/products/update | Update a productproducts | catalog · preview onlyproducts.update | metro api explain products.update |
POST /v1/contract-pricing/rate-cards/addRate | Add a raterate-cards | not yet | none |
POST /v1/contract-pricing/rate-cards/addRates | Add ratesrate-cards | op · gated writerateCards.addRates | metro dimensional new-codemetro ratecard add-ratesmetro ratecard createmetro product retire preview |
POST /v1/contract-pricing/rate-cards/archive | Archive a rate cardrate-cards | catalog · preview onlyrateCards.archive | metro api explain rateCards.archive |
POST /v1/contract-pricing/rate-cards/create | Create a rate cardrate-cards | op · gated writerateCards.create | metro ratecard create |
POST /v1/contract-pricing/rate-cards/get | Get a rate cardrate-cards | op · live readrateCards.get | metro contract createmetro dimensional new-codemetro package createmetro ratecard add-ratesmetro ratecard create |
POST /v1/contract-pricing/rate-cards/getRates | Get ratesrate-cards | op · live readrateCards.getRates | metro ratecard add-ratesmetro ratecard createmetro subscription add |
POST /v1/contract-pricing/rate-cards/getRateSchedule | Get a rate schedulerate-cards | catalog readrateCards.getRateSchedule | metro product inspect |
POST /v1/contract-pricing/rate-cards/list | List rate cardsrate-cards | op · live readrateCards.list | metro ratecard create |
POST /v1/contract-pricing/rate-cards/moveRateCardProducts | Update the rate card products orderrate-cards | not yet | none |
POST /v1/contract-pricing/rate-cards/setRateCardProductsOrder | Set the rate card products orderrate-cards | catalog · preview onlyrateCards.setProductOrder | metro api explain rateCards.setProductOrder |
POST /v1/contract-pricing/rate-cards/update | Update a rate cardrate-cards | catalog · preview onlyrateCards.update | metro api explain rateCards.update |
GET /v1/auditLogs | Get audit logssecurity | catalog readsecurity.getAuditLogs | metro api explain security.getAuditLogs |
GET /v1/services | Get servicessecurity | catalog readsecurity.getServices | metro api explain security.getServices |
POST /v1/credit-types/archive | Archive a pricing unitsettings | not yet | none |
POST /v1/credit-types/create | Create a pricing unitsettings | not yet | none |
GET /v1/credit-types/list | List pricing unitssettings | catalog readsettings.listPricingUnits | metro api explain settings.listPricingUnits |
POST /v1/listConfiguredBillingProviders | List account-level billing providerssettings | catalog readbillingProvider.listConfiguredProviders | metro api explain billingProvider.listConfiguredProviders |
POST /v1/setUpBillingProvider | Set up account-level billing providersettings | not yet | none |
POST /v1/upsertAnrokApiToken | Upsert Anrok API tokensettings | not yet | none |
POST /v1/upsertAvalaraCredentials | Upsert Avalara credentialssettings | not yet | none |
POST /v1/events/search | Search eventsusage | catalog readevents.search | metro api explain events.search |
POST /v1/ingest | Ingest eventsusage | catalog · preview onlyusage.ingest | metro usage ingest preview |
POST /v1/usage | Get batched usage datausage | catalog readusage.batch | metro api explain usage.batch |
POST /v1/usage/groups | Get usage data with paginated groupingsusage | catalog readusage.groups | metro api explain usage.groups |
POST /v1/webhooks/{webhook_id}/triggered_notifications | List triggered notifications by webhookwebhooks | catalog readwebhooks.listTriggeredNotifications | metro api explain webhooks.listTriggeredNotifications |
GET /v1/webhooks/{webhook_id}/triggered_notifications/{triggered_notification_id} | Get Triggered Notification and Delivery Attemptswebhooks | catalog readwebhooks.getTriggeredNotification | metro api explain webhooks.getTriggeredNotification |
Agents: Metronome's machine-readable index is docs.metronome.com/llms.txt. The same data as JSON ships with metro at docs/metronome-cli/API_COVERAGE.json.