Releases: Metronome-Industries/metronome-ruby
Releases · Metronome-Industries/metronome-ruby
v3.5.0
3.5.0 (2026-04-18)
Full Changelog: v3.4.0...v3.5.0
Features
- Add override created at in api responses
- Add recurring_commit_ids and remove recurring_credit_ids from api
- External fixes for rollover credits
- Map missing
contract_namewhen returning Packages - Add priority to threshold commit schemas
- Add discount_configuration to contract edit API
- Return day in package_list_response
- Support nullable discount fraction on contract update inputs
Docs
- Update balance guides
- Fully document CreditAdd/CreditUpdate fields in API spec
Bug Fixes
- align path encoding with RFC 3986 section 3.3 (cba23c1)
- multipart encoding for file arrays (824320c)
- variable name typo (802a290)
Chores
- ci: skip lint on metadata-only changes (f14cdaa)
- ci: support opting out of skipping builds on metadata-only commits (6f4c5bc)
- tests: bump steady to v0.22.1 (5908006)
Refactors
- tests: switch from prism to steady (e8f7dbc)
v3.4.0
3.4.0 (2026-03-11)
Full Changelog: v3.3.0...v3.4.0
Features
- Add archive_billing_configurations endpoint
- Enable rollover fraction on credits
Bug Fixes
- fix request delays for retrying to be more respectful of high requested delays
Docs
- update documentation for /usage/groups
Chores
v3.3.0
3.3.0 (2026-03-03)
Full Changelog: v3.2.0...v3.3.0
Breaking Change
- Remove minimum config field from Rate and Override schemas
v3.2.0
3.2.0 (2026-03-02)
Full Changelog: v3.1.0...v3.2.0
Breaking Changes
- Removed
priorityparameter and response field from contracts — thepriorityfield is no longer accepted as an input or returned in contract responses.
Features
subscription_idfield on invoice line items — invoice line item objects now include asubscription_idfield.- Compound group keys supported in
/v1/usage/groups— the usage groups endpoint now supports compound group keys for more granular usage aggregation. - New package endpoints — the SDK has been updated to include new package endpoints.
Bug Fixes
- Request cancellation during retry wait — fixed an issue where a request could not be canceled while it was waiting to retry.
NullStructserialization — the encoder now correctly serializesNullStructvalues.
Docs
v3.1.0
3.1.0 (2026-02-04)
Full Changelog: [v3.0.0...v3.1.0
Features
- Add
excludefield to commit and override specifiers shape in the API - Support TieredPercentage rate on CommitRate
- Expose add revenue config in edit contract api
- Release account hierarchy
- Add API to allow editing net payment terms
- Add getNetBalance endpoint
Bug Fixes
- client: always add content-length to post body, even when empty
- docs: fix mcp installation instructions for remote servers
Documentation
v3.0.0
3.0.0 (2026-01-17)
Full Changelog: v2.2.0...v3.0.0
⚠ BREAKING CHANGES
- Remove
use_list_pricesfrom Rate objects (44e02d)
Features
- Add
revenue_system_paymentsto Payment object andrevenue_system_invoiceto Invoice object (1e5912) - Add recurring commit ID and subscription config to Commit and Credit objects. (87a38e)
- Add support for custom fields on package terms (e6ca46)
Chores
- fix typo in descriptions (fdce90d)
- internal: codegen related update (64bba19)
- internal: codegen related update (3237dc8)
- internal: update
actions/checkoutversion (5aa0985)
Documentation
- prominently feature MCP server setup in root SDK readmes (353dc18)
v2.2.0
2.2.0 (2025-12-18)
Features
- feat: Update contract creation endpoints to allow setting revenue system configuration
- feat: Add
commit_transactionsto the body of/upsertAvalaraCredentialsendpoint - feat: Add
seat_filterfield to creation request and response parameters of the alert object - feat: Add
quantityfield to plan pricing adjustment response - feat: Add
external_payment_idfield toExternalInvoice - feat: Add
descriptionfield toCreditresponse - feat: Include
custom_sqltoaggregation_typeinUsageSearchResponse - feat: Return object response for
SetBillingConfigurationsendpoint - feat: update create alert api to allow LowRemainingSeatBalanceReached alert
Documentation
- docs: Add gcp_marketplace enum
- docs: Move contract edit v2 from beta to GA
v2.1.0
2.1.0 (2025-10-31)
Full Changelog: v2.0.0...v2.1.0
Features
- Add
payment_method_idtoPaymentGateway.Stripe - Add
billing_provider_errortoinvoice.external_invoice - Add avalara creds + billing provider APIs.
- Add
exclude_zero_balancesfield to Contract list balances API. - Add
METRONOMEtoBillingProvidertype - (private beta) Add
low_remaining_seat_balance_reachedCustomerAlert type. - Add v2 notifications APIs
v2.0.0
2.0.0 (2025-10-16)
Full Changelog: v1.0.0...v2.0.0
⚠ BREAKING CHANGES
- Remove
customer_idfrom as from Preview Events API request params. - Update Preview Events API to return list of invoices
Features
- Add
AVALARAtotax_typein payment gate config - Add
hierarchy_configurationto Edit Commit and Edit Credit APIs in the Contract Edit API> - Add
parent_behavior,payer,usage_statement_behaviorto Hierarchy configuration - Add
updated_atto Customer detail object - Add retrieve invoice PDF API
- Add
invoice_sub_total,invoiced_total,pdf_url,taxto External Invoice - Add Payment APIs.
- Add
rate_typeto Recurring Commit object - Add
add_billing_provider_configuration_updateAPI to Contract Edit API
Bug Fixes
- absolutely qualified uris should always override the default (d2a34bf)
- always send
filename=...for multipart requests where a file is expected (618065e) - coroutine leaks from connection pool (f44d189)
- internal: use null byte as file separator in the fast formatting script (dec574a)
- shorten multipart boundary sep to less than RFC specificed max length (b49e6f1)
- should not reuse buffers for
IO.copy_streaminterop (c80da18)
Performance Improvements
- faster code formatting (1a84007)
Chores
v1.0.0
1.0.0 (2025-09-15)
Full Changelog: v0.3.0...v1.0.0
⚠ BREAKING CHANGES
- api: add pagination support to multiple endpoints - Added pagination to CustomerList, AlertList, InvoiceList, CommitList, CreditList, CreditGrantList, CustomerAlerts, UsageList, CustomFields list, and ContractListBalances endpoints.
- api: enhance subscriptions and commits/credits - Added Individual enum to SubscriptionConfig and rate_type enums to UpdateCredit/UpdateCommit.
- api: add comprehensive shared types to SDK - Added 34 new shared types including BaseThresholdCommit, BaseUsageFilter, Commit, CommitHierarchyConfiguration, CommitRate, CommitSpecifier, CommitSpecifierInput, Contract, ContractV2, ContractWithoutAmendments, Credit, CreditTypeData, Discount, EventTypeFilter, HierarchyConfiguration, ID, Override, OverrideTier, OverwriteRate, PaymentGateConfig, PaymentGateConfigV2, PrepaidBalanceThresholdConfiguration, PrepaidBalanceThresholdConfigurationV2, PropertyFilter, ProService, Rate, RecurringCommitSubscriptionConfig, ScheduledCharge, ScheduleDuration, SchedulePointInTime, SpendThresholdConfiguration, SpendThresholdConfigurationV2, Subscription, Tier, and UpdateBaseThresholdCommit.
Features
- api: add archived_at field to CustomerBillingConfiguration (8eb235f)
- api: add comprehensive shared types to SDK - Added 34 new shared types including BaseThresholdCommit, BaseUsageFilter, Commit, CommitHierarchyConfiguration, CommitRate, CommitSpecifier, CommitSpecifierInput, Contract, ContractV2, ContractWithoutAmendments, Credit, CreditTypeData, Discount, EventTypeFilter, HierarchyConfiguration, ID, Override, OverrideTier, OverwriteRate, PaymentGateConfig, PaymentGateConfigV2, PrepaidBalanceThresholdConfiguration, PrepaidBalanceThresholdConfigurationV2, PropertyFilter, ProService, Rate, RecurringCommitSubscriptionConfig, ScheduledCharge, ScheduleDuration, SchedulePointInTime, SpendThresholdConfiguration, SpendThresholdConfigurationV2, Subscription, Tier, and UpdateBaseThresholdCommit. (8eb235f)
- api: add created_at field to Commit (8eb235f)
- api: add customer billing configuration endpoints - Added set and retrieve endpoints for customer billing configurations. (8eb235f)
- api: add pagination support to multiple endpoints - Added pagination to CustomerList, AlertList, InvoiceList, CommitList, CreditList, CreditGrantList, CustomerAlerts, UsageList, CustomFields list, and ContractListBalances endpoints. (8eb235f)
- api: Add support for granular spend threshold alerts with group key filters. (8eb235f)
- api: enhance subscriptions and commits/credits - Added Individual enum to SubscriptionConfig and rate_type enums to UpdateCredit/UpdateCommit. (8eb235f)
Bug Fixes
- bump sorbet version and fix new type errors from the breaking change (8eb235f)
Chores
Documentation
- enhance API documentation - Added more detailed descriptions and styling improvements, and enhanced usage filter documentation with additional context. (8eb235f)