Metronome
Metronome is a usage-based billing platform for managing customers, contracts, pricing, usage, credits, and invoices.
118 actionsAPI key
What your bot can do in Metronome
Looks up
- Get Audit LogsGet one page of account audit entries for security monitoring, compliance, and operational investigation.
- Get Batched Usage DataReturn one page of usage aggregated across customers and billable metrics for hourly, daily, or whole-period reporting.
- Get Billable MetricRetrieve one Metronome billable metric by ID, including its event matching, aggregation, grouping, custom fields, SQL, and archive state.
- Get ContractRetrieve the current or historical v2 configuration of a Metronome contract.
- Get Contract Edit HistoryList all recorded edits made to a Metronome contract over time.
- Get Contract Named ScheduleGet the segments of a named schedule for a customer's Metronome contract, optionally selected by date and schedule properties.
- Get Contract Rate ScheduleGet one page of entitled contract rates at a point in time, including contract overrides.
- Get CustomerGet a Metronome customer by ID, including aliases, configuration, and custom fields.
- Get Customer AlertGet a threshold notification's configuration and current evaluation status for a specific customer.
- Get Customer Billing Provider ConfigurationsFetch active or archived billing provider configurations for a customer.
Show 44 more
- Get Customer Named ScheduleGet the segments of a named schedule configured for a Metronome customer, optionally restricted to the segment covering a date.
- Get Customer Revenue System ConfigurationsFetch revenue system configurations for a Metronome customer.
- Get Embeddable Dashboard URLCreate a secure, time-limited URL for a user-facing customer Metronome dashboard.
- Get Grouped Usage DataReturn one page of usage for one customer and billable metric, optionally grouped and filtered by a complete simple or compound metric…
- Get InvoiceRetrieve one Metronome customer invoice by ID, including its line items and external billing status.
- Get Invoice PDFDownload a Metronome invoice PDF and return an offloaded file reference.
- Get Net BalanceGet the combined current balance across a filtered set of customer commits and credits.
- Get Notification ConfigRetrieve an offset lifecycle-event notification configuration by ID.
- Get PackageGet one package's name, alias schedule, duration, commits, credits, overrides, scheduled charges, and contract defaults.
- Get ProductGet a Metronome product by ID, including its current and initial configuration, historical updates, archive state, and custom fields.
- Get Rate CardGet one rate card's metadata, pricing unit, conversions, aliases, and custom fields.
- Get Rate Card Named ScheduleGet the segments of a named schedule configured on a Metronome rate card, optionally restricted to the segment covering a date.
- Get Rate ScheduleGet one page of scheduled rate-card prices over a requested time window.
- Get RatesGet one page of rate-card prices active at a specific timestamp.
- Get ServicesGet Metronome's service registry and current IP addresses for firewall and network allowlist configuration.
- Get Subscription Quantity HistoryRetrieve historical subscription quantities and prices for a contract subscription.
- Get Subscription Seats HistoryGet one page of historical seat assignments and quantities for a contract subscription.
- Get Webhook DeliveryRetrieve one triggered Metronome webhook notification, its exact JSON payload, and every recorded delivery attempt.
- List Billable MetricsList billable metric definitions, optionally including archived metrics, for pricing and event-matching discovery.
- List Billing ProvidersList account-level billing providers and their delivery-method configurations.
- List Contract Named SchedulesList one page of contract-level named schedules for a Metronome customer, with optional contract, name, property, and date filters.
- List ContractsList one page of a customer's current v2 contracts with optional balances, ledgers, and archive filters.
- List Contracts On PackageList one page of customer contracts provisioned from a package over a selected time period.
- List Custom Field KeysList active Metronome custom field keys, optionally filtered to selected entity types.
- List Customer AlertsList one page of threshold notifications and their current evaluation statuses for a customer.
- List Customer BalancesList one page of a customer's current commit and credit balances.
- List Customer Billable MetricsList billable metrics available for a Metronome customer, optionally filtering to the current plan or including archived metrics.
- List Customer CommitsList one page of customer-level and optionally contract-level commits.
- List Customer CreditsList one page of customer-level and optionally contract-level credits.
- List CustomersList active or archived Metronome customers, optionally filtering by customer, ingest, Salesforce, or Stripe identifiers.
- List Historical BalancesList one page of commits and credits moved to historical storage.
- List Invoice BreakdownsList hourly or daily invoice breakdowns for a Metronome customer and time range.
- List InvoicesList one page of invoices for a Metronome customer with optional status, type, contract, credit type, and billing-period filters.
- List Offset Notification ConfigsList one page of user-created lifecycle-event notifications that publish webhooks before or after their base events.
- List PackagesList contract packages with their terms, commits, overrides, scheduled charges, and archive state.
- List Pricing UnitsList fiat and custom pricing units available for rates, credits, and commits.
- List ProductsList Metronome products and their current configuration, version history, metadata, and archive state.
- List Rate CardsList rate cards with their IDs, names, descriptions, aliases, pricing units, and metadata.
- List Seat BalancesList one page of seat-level commit and credit balances for a contract.
- List Spend Invoice BreakdownsList one page of customer invoice spend breakdowns by time window and optional presentation groups.
- List System Notification ConfigsList one page of Metronome system lifecycle notification types and whether their webhook publishing is enabled.
- List Webhook DeliveriesList one page of triggered notifications and delivery summaries for a Metronome webhook destination from the last 30 days.
- Preview Customer EventsCalculate customer invoice previews from supplied usage events without ingesting the events.
- Search EventsRetrieve recent usage events by transaction ID to sample ingestion, customer matching, metric matching, and duplicate handling.
Takes action
- Add Manual Balance Ledger EntryManually increase or decrease an existing commit or credit balance segment.
- Add RateAdd one product rate to a Metronome rate card.
- Add RatesAdd multiple product rates to a Metronome rate card in one request.
- Archive AlertPermanently stop a threshold notification from evaluating, optionally releasing its uniqueness key for reuse.
- Archive Billable MetricArchive a Metronome billable metric.
- Archive CommitArchive a customer commit so it is no longer active.
- Archive ContractPermanently end and archive a contract and its terms, cancel draft invoices, void upcoming scheduled invoices, and optionally void…
- Archive CreditArchive a customer credit so it is no longer active.
- Archive CustomerPermanently archive a Metronome customer and every customer contract, void the corresponding invoices, and stop associated notifications.
- Archive Customer Billing Provider ConfigurationsArchive one or more billing provider configurations for a Metronome customer.
Show 54 more
- Archive Notification ConfigArchive an offset lifecycle-event notification configuration so Metronome no longer processes it.
- Archive PackagePermanently archive a package so it cannot be used to create new contracts.
- Archive Pricing UnitArchive a custom Metronome pricing unit so it no longer appears in pricing unit selectors by default.
- Archive ProductArchive a Metronome product so it cannot be used for new rates.
- Archive Rate CardPermanently archive a rate card so it cannot be used for new contracts.
- Create AlertCreate a threshold notification that monitors customer spend, usage, credits, commits, invoice totals, or seat balances.
- Create Billable MetricCreate a streaming billable metric from event filters and aggregation rules, or create a SQL billable metric by supplying sql instead.
- Create ContractCreate a Metronome contract with pricing, credits, commitments, subscriptions, and billing terms.
- Create Custom Field KeyCreate an allowed custom field key for a Metronome entity type and choose whether its values must be unique.
- Create CustomerCreate a Metronome customer with optional usage aliases, custom fields, and billing or revenue system configurations.
- Create Customer CommitCreate a customer-level prepaid or postpaid commit with access and invoice schedules.
- Create Customer CreditCreate a customer-level credit with a scheduled spend or quantity balance.
- Create Historical Contract Usage InvoicesValidate a read-only preview or create retroactive contract usage invoices for historical billing periods.
- Create Notification ConfigCreate a notification that publishes a webhook at an ISO 8601 time offset from a Metronome lifecycle event.
- Create PackageCreate a reusable package of time-relative contract pricing and billing terms.
- Create Pricing UnitCreate a custom Metronome pricing unit for charging usage in a non-fiat unit.
- Create ProductCreate a Metronome product representing an invoice line item, including its usage metric, composite behavior, quantity rules, tags, and…
- Create Rate CardCreate a Metronome rate card with pricing-unit conversions and scheduled aliases.
- Delete Custom Field KeyRemove a custom field key from a Metronome entity type's allowlist, making existing values for that key inaccessible.
- Delete Custom FieldsDelete selected custom field values from one Metronome entity instance without changing its other custom fields.
- Disable Commit True-upDisable generation of the final true-up invoice for a postpaid commit.
- Edit CommitEdit a commit's metadata, schedules, applicability, product, rate, priority, or hierarchy access.
- Edit ContractApply a v2 contract edit that adds, updates, archives, or removes contract terms.
- Edit CreditEdit a credit's metadata, access schedule, applicability, product, rate, priority, or hierarchy access.
- Edit Notification ConfigChange an offset notification policy or enable or disable webhook publishing for a system lifecycle notification.
- Ingest Usage EventsIngest one to 100 usage events that immediately affect customer usage, spend, and billing.
- Move Rate Card ProductsMove selected products to new invoice-order positions on a rate card.
- Regenerate InvoiceRegenerate a previously voided Metronome invoice using current rates, balances, and fees, distribute the replacement through the…
- Release External Payment Gate Threshold CommitComplete or cancel a threshold commit after an external payment attempt.
- Reset Customer AlertsClear a threshold notification's cached state for a customer and trigger an asynchronous re-evaluation.
- Schedule Pro Services InvoiceSchedule an invoice for professional service terms on a contract.
- Set Custom FieldsTransactionally set or overwrite custom field values on one Metronome entity instance while preserving unspecified fields.
- Set Customer Billable StatusSet whether a Metronome customer is billable from a specified effective time.
- Set Customer Billing Provider ConfigurationsCreate one or more billing provider configurations for Metronome customers.
- Set Customer Ingest AliasesReplace the complete set of usage ingest aliases for a Metronome customer.
- Set Customer NameUpdate the display name of a Metronome customer.
- Set Customer Revenue System ConfigurationsCreate one or more revenue system configurations for Metronome customers.
- Set Rate Card Products OrderReplace the complete invoice display order of products on a rate card.
- Set Up Billing ProviderSet up account-level Metronome configuration for a marketplace billing provider.
- Set Usage FilterRoute a customer's grouped usage to a contract starting at a specified time.
- Update Billable MetricRename an existing Metronome billable metric.
- Update Commit End DateUpdate the access or invoice end date of a prepaid customer commit.
- Update Contract End DateSet, move, or remove a contract's exclusive end timestamp.
- Update Contract Named ScheduleSet a dated segment on a named schedule for a customer's Metronome contract.
- Update Credit End DateUpdate the access end date of a customer credit.
- Update Customer ConfigurationUpdate the Salesforce account configuration for a Metronome customer.
- Update Customer Named ScheduleSet a dated segment on a named schedule configured for a Metronome customer.
- Update Invoice Issue DateReschedule the issue date of one draft contract invoice without changing future billing cycles.
- Update ProductSchedule a configuration update for a Metronome product without changing its type.
- Update Rate CardUpdate a rate card's metadata, alias schedule, or pricing-unit conversions.
- Update Rate Card Named ScheduleSet a dated segment on a named schedule configured for a Metronome rate card.
- Upsert Anrok API TokenSet the Anrok API token used by specified Metronome billing delivery methods.
- Upsert Avalara CredentialsSet Avalara credentials for specified Metronome billing delivery methods.
- Void InvoicePermanently void a Metronome invoice.