Changelog
Metronome upstream changes and metro coverage.
Metronome's upstream changes, and whether metro covers each one. Source: docs.metronome.com/changelog.
Source
Generated from docs/metronome-cli/METRONOME_UPSTREAM_CHANGELOG.md in metrocli/metro @146bf3e. Source schemaVersion: n/a (hand-authored markdown).
Source of truth: https://docs.metronome.com/changelog Machine-readable markdown: https://docs.metronome.com/changelog.md Docs index: https://docs.metronome.com/llms.txt
Last synced into metro: 2026-07-15 (docs/metronome-cli/site/metronome-upstream.json).
Metro does not auto-ingest OpenAPI. This page is the checklist that keeps
shapes, the endpoint matrix, and api-catalog honest when Metronome ships changes.
How to refresh
# Offline: does the frozen inventory still match expected key count?
npm run docs:upstream:check
# Explicit network: fetch changelog.md and report new/missing titles
npm run docs:upstream:check -- --fetchWhen --fetch reports new entries: curl every linked Metronome .md page,
update skills/metronome-danger-zone/references/endpoint-matrix.md and/or
packages/metro-core/src/api-catalog/index.js + shapes/validators, bump
syncedAt, regenerate goldens/site if catalog output changed, and rewrite
coverage notes in scripts/generate-metronome-upstream.js (or re-run it).
Coverage legend
| Status | Meaning |
|---|---|
accounted | Metro catalog/skills/docs already cover the behavior |
partial | Related coverage exists; missing gotcha, shortcut, or validator prose |
gap | API-relevant and not yet represented - fix before relying on the feature |
n/a | Not an applicable metro operating surface |
n/a-sdk / n/a-ui | SDK or UI-only; no metro shape work unless API fields change |
Gaps that need follow-up
- GAP May 29, 2026 - Configurable rounding for prorated subscriptions and recurring commits: No shape/validator/docs yet for proration rounding fields. Curl subscription + recurring commit API docs before first use.
- GAP February 5, 2026 - Get net balance API: Verified in endpoint-matrix (
POST /v1/contracts/customerBalances/getNetBalance) but not yet a reviewed api-catalog ID /metro api readshape. Prefer over paginating balances when consolidating. - Partial July 7, 2026 - Daily recurring credits and commits are supported: Catalog/shapes cover recurring commits generally; daily cadence (
commit_duration/ recurrence unit daily) not yet called out in TEAM-QUICKSTART or shape prose. Re-curl create/edit docs before using daily. - Partial February 27, 2026 - Compound group keys in usage breakdowns:
usage.groupsis in api-catalog; compound group key constraint and page-size 100 not yet in validator prose/TEAM-QUICKSTART. - Partial February 17, 2026 - Change end date on advance, prorated subscriptions: Subscription end-date edits exist via contract/subscription edit paths; advance-prorated edge case not a dedicated gotcha yet.
- Partial February 12, 2026 - Stripe invoice PDFs available in UI and API: Matrix notes invoice PDF GET path in conventions; not a first-class
metroshortcut. Prefer Stripe dashboard or guarded invoice get when needed. - Partial February 10, 2026 - Subscription and invoice line item linking improvements:
subscription_idon line items / Stripe metadata - useful for reconcile; not yet a metro proof field. - Partial January 16, 2026 - Major version SDK release: Breaking: removed
use_list_pricesfrom Rate objects - ensure rate-card payloads/validators do not emit it. - Partial October 14, 2025 - September fixes and improvements: Spot-check API subsection against edit/billing-provider sources when touching those shapes.
- Partial September 10, 2025 - August fixes and improvements: Historical API fixes (billing config updates via edit, etc.) - reflected in danger-zone / stripe-delivery skills.
- Partial August 5, 2025 - July fixes and improvements: API notes (searchEvents, commits) - events.search / commits paths in catalog.
- Partial August 4, 2025 - Seat-based credit pools: Seat / credit pool shapes in skills; not a TEAM-QUICKSTART one-liner.
- Partial July 23, 2025 - Threshold billing and auto-recharge: Spend/prepaid thresholds via contract edit - danger-zone aware; not a dedicated metro shortcut.
- Partial June 26, 2025 - Scope credits and commits to specific pricing or presentation group values: Specifier / dimensional scoping; keep sources current.
- Partial June 13, 2025 - Support for seat-based subscription billing: Seat subscriptions in skills; most packages are credit+plan fee shaped.
- Partial May 20, 2025 - April fixes and improvements: Historical; verify touched endpoints against current
.mdsources. - Partial April 1, 2025 - Support for weekly frequencies for billing, recurring commits, and credits: Cadence fields exist; weekly not a common shape.
- Partial March 26, 2025 - In Tempo: Spring 2025 changelog: Large release note - recurring commits, uniqueness keys, invoice breakdowns, updateEndDate guard already reflected across matrix/catalog/skills.
- Partial September 25, 2024 - In Tempo: Fall 2024: voidInvoice etc. in catalog; plan-era APIs are historical.
Batch / large requests (smart paths)
Metronome guides: high-volume ingestion, send usage events, API quickstart.
| Need | Smart path in metro | Do not |
|---|---|---|
| Full package inventory | metro package list --sandbox or --prod (follows next_page) | Single-page api read and assume page = tenant |
| Who is on a package | metro package customers --package <id or alias> | Manual contracts-on-package loops without page follow |
| Many plan moves | metro contract move-plan bulk-preflight then bulk-apply with --delay-ms / --limit canary | Parallel writers across the fleet |
| New action code on all cards | metro dimensional new-code --all ... | Hand-rolled per-card scripts |
| Usage aggregates (multi-customer) | Reviewed usage.batch + query next_page | Stuffing pagination into POST body |
| Usage by dimensions | usage.groups (compound keys only if BM defines them; max page 100) | Grouping by multiple simple keys |
| Combined credit+commit balance | Prefer getNetBalance once catalogued; until then balances list + pagination | N+1 per commit without a reason |
| Ingest | Batches ≤100 events; stable transaction IDs; retry client on 429 | Firehose without backoff |
| Rate append | addRates ≤100 rows per call | Mega payloads |
| Audit log export | metro audit export plan documents pagination; live pull is gated | Unbounded concurrent page fetches |
Pagination rule (current API): for nearly all modern list endpoints,
limit and next_page belong in the URL query string, not the POST body.
(Older local notes that said “send next_page in the body” are wrong for packages,
getRates, usage.groups/batch, contracts-on-package, etc. - validators enforce query.)
Retry: metro uses metronome-retry-client (429/5xx backoff).
Still prefer serial pagination + bulk --delay-ms over high concurrency.
Full inventory (every Metronome entry)
July 7, 2026 - Daily recurring credits and commits are supported
Tags: Billing, API, UI
Metro coverage: partial - Catalog/shapes cover recurring commits generally; daily cadence (commit_duration / recurrence unit daily) not yet called out in TEAM-QUICKSTART or shape prose. Re-curl create/edit docs before using daily.
Catalog IDs: contracts.create, contracts.edit
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
May 29, 2026 - Configurable rounding for prorated subscriptions and recurring commits
Tags: Billing, API, UI
Metro coverage: gap - No shape/validator/docs yet for proration rounding fields. Curl subscription + recurring commit API docs before first use.
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
May 29, 2026 - Richer responses from createContract and editContract
Tags: API
Metro coverage: accounted - Catalog sources point at create/edit docs. Metro still requires expected-vs-actual re-read after apply (richer response does not replace proof).
Catalog IDs: contracts.create, contracts.edit
Metronome links:
May 15, 2026 - Metronome Java SDK is now available
Tags: SDK
Metro coverage: n/a-sdk - Metro is Node CLI; Java SDK not used.
Metronome links:
April 17, 2026 - Q1 usability updates: quality of life improvements
Tags: Improvements, UI
Metro coverage: n/a-ui - UI-only QoL; no API shape impact.
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
April 11, 2026 - Assign RBAC roles to API tokens
Tags: New releases, UI
Metro coverage: accounted - Token scope matters for operator mode + keys. Documented under platform RBAC link; prefer reader tokens with metro mode set read-only.
Metronome links:
April 11, 2026 - Package contract transitions and credit rollover improvements
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: accounted - Package transitions and rollover_fraction used in preview/contract-move shapes and skills.
Catalog IDs: packages.create, contracts.create, contracts.edit
Metronome links:
April 11, 2026 - NetSuite integration (Public Beta)
Tags: New releases, Integrations
Metro coverage: n/a - Invoices via Stripe, not NetSuite.
Metronome links:
March 9, 2026 - Dark mode
Tags: New releases, UI
Metro coverage: n/a-ui - UI only.
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
March 2, 2026 - SDK releases
Tags: New releases, API
Metro coverage: n/a-sdk - Track only when release notes imply API schema breakers (e.g. removed priority). Metro catalog is hand-curated.
Metronome links:
February 27, 2026 - Compound group keys in usage breakdowns
Tags: New releases, API
Metro coverage: partial - usage.groups is in api-catalog; compound group key constraint and page-size 100 not yet in validator prose/TEAM-QUICKSTART.
Catalog IDs: usage.groups
Metronome links:
February 23, 2026 - Archive packages
Tags: New releases, API, UI
Metro coverage: accounted - packages.archive in api-catalog + validators.
Catalog IDs: packages.archive
Metronome links:
February 19, 2026 - New Metronome UI
Tags: New releases, UI
Metro coverage: n/a-ui - UI only.
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
February 17, 2026 - Change end date on advance, prorated subscriptions
Tags: New releases, API
Metro coverage: partial - Subscription end-date edits exist via contract/subscription edit paths; advance-prorated edge case not a dedicated gotcha yet.
Catalog IDs: contracts.edit
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
February 12, 2026 - Stripe invoice PDFs available in UI and API
Tags: New releases, API, UI
Metro coverage: partial - Matrix notes invoice PDF GET path in conventions; not a first-class metro shortcut. Prefer Stripe dashboard or guarded invoice get when needed.
Catalog IDs: invoices.get
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
February 10, 2026 - Subscription and invoice line item linking improvements
Tags: Improvements, API, Integrations
Metro coverage: partial - subscription_id on line items / Stripe metadata - useful for reconcile; not yet a metro proof field.
Catalog IDs: invoices.get, invoices.listForCustomer
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
February 9, 2026 - Create contracts from packages in the UI
Tags: New releases, UI
Metro coverage: n/a-ui - API path already covered (packages + contracts.create). UI convenience only.
Catalog IDs: contracts.create
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
February 6, 2026 - In-app embedded dashboards
Tags: New releases, UI
Metro coverage: n/a-ui - UI reporting; use metro + exports.
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
February 5, 2026 - SDK releases
Tags: New releases, API
Metro coverage: n/a-sdk - Track only when release notes imply API schema breakers (e.g. removed priority). Metro catalog is hand-curated.
Metronome links:
February 5, 2026 - Get net balance API
Tags: New releases, API
Metro coverage: gap - Verified in endpoint-matrix (POST /v1/contracts/customerBalances/getNetBalance) but not yet a reviewed api-catalog ID / metro api read shape. Prefer over paginating balances when consolidating.
Metronome links:
January 29, 2026 - Edit net payment terms on contracts
Tags: New releases, API, UI
Metro coverage: accounted - Preview supports net_payment_terms_days; edit history still required for audit.
Catalog IDs: contracts.edit
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
January 16, 2026 - Major version SDK release
Tags: New releases, API
Metro coverage: partial - Breaking: removed use_list_prices from Rate objects - ensure rate-card payloads/validators do not emit it.
Catalog IDs: rateCards.addRates, rateCards.getRates
Metronome links:
January 12, 2026 - Self-serve access to Metronome
Tags: New releases, UI
Metro coverage: n/a-ui - Onboarding UI.
Metronome links:
January 12, 2026 - Billing configuration API endpoints now return response bodies
Tags: Improvements, API
Metro coverage: accounted - Billing-provider set/archive in catalog; responses expected in sandbox-proof paths.
Catalog IDs: customers.setBillingProviderConfigurations, customers.archiveBillingProviderConfigurations
Metronome links:
December 22, 2025 - High cardinality group key spend alerts
Tags: New releases, Notifications
Metro coverage: n/a - Alerts not in metro core day-to-day.
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
December 19, 2025 - SDK releases
Tags: New releases, API
Metro coverage: n/a-sdk - Track only when release notes imply API schema breakers (e.g. removed priority). Metro catalog is hand-curated.
Metronome links:
November 14, 2025 - Launch week recap: Monetization Infrastructure for AI
Tags: New releases, API, Notifications, Integrations, UI, Pricing and Packaging
Metro coverage: n/a-ui - Marketing recap; follow linked product guides when relevant.
Metronome links:
November 3, 2025 - Invoicing with Google Cloud Marketplace
Tags: New releases, Integrations
Metro coverage: n/a - Uses Stripe billing.
Metronome links:
October 31, 2025 - New SDK releases
Tags: New releases, API
Metro coverage: n/a-sdk - Track only when release notes imply API schema breakers (e.g. removed priority). Metro catalog is hand-curated.
Metronome links:
October 14, 2025 - September fixes and improvements
Tags: Improvements, API, Notifications, UI, Pricing and Packaging
Metro coverage: partial - Spot-check API subsection against edit/billing-provider sources when touching those shapes.
Catalog IDs: contracts.edit
Metronome links:
spend_threshold_reached- Add a billing configuration
- Archive a billing provider
- Edit the rate type of a recurring commit
- Node
- Go
- Python
- Ruby
September 24, 2025 - Make advanced contract overrides in the Metronome app
Tags: New releases, UI, Pricing and Packaging
Metro coverage: n/a-ui - UI for overrides; API overrides remain via contracts.edit.
Catalog IDs: contracts.edit
Metronome links:
September 24, 2025 - Custom Reports
Tags: New releases, UI
Metro coverage: n/a-ui - In-app reports.
Metronome links:
September 18, 2025 - Customer Lifecycle Notifications
Tags: New releases, API, Notifications, UI
Metro coverage: n/a - Notifications not operated via metro today.
Metronome links:
September 11, 2025 - New documentation experience
Tags: New releases, API, Notifications, Integrations, UI, Pricing and Packaging
Metro coverage: accounted - Sources use docs.metronome.com .md URLs + llms.txt. This tracker is the metro-side sync surface.
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
September 10, 2025 - August fixes and improvements
Tags: Improvements, API, UI, Pricing and Packaging
Metro coverage: partial - Historical API fixes (billing config updates via edit, etc.) - reflected in danger-zone / stripe-delivery skills.
Catalog IDs: contracts.edit
Metronome links:
- data exports
- edit a commit
- products
- create contract
- get an invoice
- list invoice breakdowns
- list invoices
- Node
- Go
- Python
- Ruby
- edit contract
August 15, 2025 - Invoice breakdowns in Data Export
Tags: New releases, UI
Metro coverage: partial - invoices.listBreakdowns in catalog; data-export tables are separate.
Catalog IDs: invoices.listBreakdowns
Metronome links:
August 5, 2025 - July fixes and improvements
Tags: Improvements, API, Notifications, Integrations, UI, Pricing and Packaging
Metro coverage: partial - API notes (searchEvents, commits) - events.search / commits paths in catalog.
Catalog IDs: events.search, commits.list
Metronome links:
- prepaid
- postpaid
- Search events
/v1/contracts/customerCommits/create/v2/contracts/edit/v1/contracts/createv2/contracts/editv2/contracts/getv1/contracts/customerCommits/listv2/contracts/list- Node
- Go
- Python
- Ruby
- Send Metronome events to Slack
August 4, 2025 - Use group keys to set budgets across users, teams, and projects
Tags: New releases, API, Notifications, UI
Metro coverage: n/a - Spend controls/alerts - not metro day-to-day.
Metronome links:
August 4, 2025 - Seat-based credit pools
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: partial - Seat / credit pool shapes in skills; not a TEAM-QUICKSTART one-liner.
Catalog IDs: contracts.edit
Metronome links:
August 1, 2025 - Embeddable dashboard for credit and commit balances
Tags: New releases, API
Metro coverage: n/a-ui - Embeddable UI; metro uses balances list / (future) getNetBalance.
Catalog IDs: customerBalances.list
Metronome links:
July 23, 2025 - Threshold billing and auto-recharge
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: partial - Spend/prepaid thresholds via contract edit - danger-zone aware; not a dedicated metro shortcut.
Catalog IDs: contracts.edit
Metronome links:
July 15, 2025 - Set up multi-entity billing
Tags: New releases, Integrations
Metro coverage: partial - Account hierarchy / billing config - skills note hierarchy; careful with Stripe entity.
Catalog IDs: customers.setBillingProviderConfigurations
Metronome links:
June 26, 2025 - Scope credits and commits to specific pricing or presentation group values
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: partial - Specifier / dimensional scoping; keep sources current.
Catalog IDs: contracts.edit, rateCards.addRates
Metronome links:
June 13, 2025 - Edit recurring commits and credits
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: accounted - Recurring edit via contracts.edit / commit edit docs in skills.
Catalog IDs: contracts.edit
Metronome links:
June 13, 2025 - Support for seat-based subscription billing
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: partial - Seat subscriptions in skills; most packages are credit+plan fee shaped.
Catalog IDs: contracts.create, contracts.edit
Metronome links:
May 20, 2025 - April fixes and improvements
Tags: Improvements, API, Integrations, UI
Metro coverage: partial - Historical; verify touched endpoints against current .md sources.
Metronome links:
May 8, 2025 - Remove overrides and archive commits and scheduled charges
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: accounted - editContract archive/remove paths documented in danger-zone.
Catalog IDs: contracts.edit
Metronome links:
May 5, 2025 - Support for NZD and SGD currencies
Tags: New releases, Pricing and Packaging
Metro coverage: n/a - Standard currency amounts.
Metronome links:
May 1, 2025 - Ruby SDK
Tags: New releases, API
Metro coverage: n/a-sdk - SDK only.
Metronome links:
April 29, 2025 - Updated UI for creating and editing contracts, customer-level commits, and customer-level credits
Tags: New releases, UI
Metro coverage: n/a-ui - UI only.
Metronome links:
April 9, 2025 - Edit rates in the Rate Card UI
Tags: Improvements, UI
Metro coverage: n/a-ui - API: addRates/getRates in catalog.
Catalog IDs: rateCards.addRates
No deep links in the changelog body - start from https://docs.metronome.com/changelog and curl the matching API/guide page via llms.txt.
April 2, 2025 - Usage threshold alerts supported on Contracts
Tags: New releases, API, Notifications
Metro coverage: n/a - Alerts out of metro day-to-day.
Metronome links:
April 2, 2025 - Contract editing
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: accounted - contracts.edit + danger-zone editContract support matrix.
Catalog IDs: contracts.edit
Metronome links:
April 1, 2025 - Support for weekly frequencies for billing, recurring commits, and credits
Tags: New releases, API, UI, Pricing and Packaging
Metro coverage: partial - Cadence fields exist; weekly not a common shape.
Catalog IDs: contracts.create, contracts.edit
Metronome links:
March 26, 2025 - In Tempo: Spring 2025 changelog
Tags: New releases, API, Notifications, Integrations, UI, Pricing and Packaging
Metro coverage: partial - Large release note - recurring commits, uniqueness keys, invoice breakdowns, updateEndDate guard already reflected across matrix/catalog/skills.
Catalog IDs: contracts.create, contracts.edit, contracts.updateEndDate, invoices.listBreakdowns, customerBalances.list
Metronome links:
- here
- here
- here
- here
- here
- here
- here
- here
- request body
- API
- here
- here
- here
- here
- Metronome Trust Center
- here
- here
- we launched Metronome 2.0
- here
- here
- here
- here
October 17, 2024 - Metronome 2.0
Tags: New releases, API, Notifications, Integrations, UI, Pricing and Packaging
Metro coverage: accounted - Metro is built on Metronome 2.0 contracts/rate-cards/packages model.
Metronome links:
- managing rate cards
- customizing pricing
- enterprise commit launch guide
- dimensional pricing
- billable metrics
- customer and contract provisioning
- building customer dashboards
- API documentation
- customer spend controls
- creating and managing alerts
- syncing billing data into Salesforce
September 25, 2024 - In Tempo: Fall 2024
Tags: New releases, API, Notifications, UI, Pricing and Packaging
Metro coverage: partial - voidInvoice etc. in catalog; plan-era APIs are historical.
Catalog IDs: invoices.void
Metronome links:
June 10, 2024 - In Tempo: Spring 2024
Tags: New releases, API, Notifications, Integrations, UI, Pricing and Packaging
Metro coverage: n/a-ui - Mostly pre-2.0/plan-era; do not copy paths into new workflows without matrix check.
Metronome links: