# Metronome

Metronome is a usage-based billing platform for managing customers, contracts, pricing, usage, credits, and invoices.

Category: Finance. Connect from any Opisense bot at https://www.opisense.com/integrations/metronome/.

## Actions

- **Add Manual Balance Ledger Entry**: Manually increase or decrease an existing commit or credit balance segment.
- **Add Rate**: Add one product rate to a Metronome rate card.
- **Add Rates**: Add multiple product rates to a Metronome rate card in one request.
- **Archive Alert**: Permanently stop a threshold notification from evaluating, optionally releasing its uniqueness key for reuse.
- **Archive Billable Metric**: Archive a Metronome billable metric.
- **Archive Commit**: Archive a customer commit so it is no longer active.
- **Archive Contract**: Permanently end and archive a contract and its terms, cancel draft invoices, void upcoming scheduled invoices, and optionally void…
- **Archive Credit**: Archive a customer credit so it is no longer active.
- **Archive Customer**: Permanently archive a Metronome customer and every customer contract, void the corresponding invoices, and stop associated notifications.
- **Archive Customer Billing Provider Configurations**: Archive one or more billing provider configurations for a Metronome customer.
- **Archive Notification Config**: Archive an offset lifecycle-event notification configuration so Metronome no longer processes it.
- **Archive Package**: Permanently archive a package so it cannot be used to create new contracts.
- **Archive Pricing Unit**: Archive a custom Metronome pricing unit so it no longer appears in pricing unit selectors by default.
- **Archive Product**: Archive a Metronome product so it cannot be used for new rates.
- **Archive Rate Card**: Permanently archive a rate card so it cannot be used for new contracts.
- **Create Alert**: Create a threshold notification that monitors customer spend, usage, credits, commits, invoice totals, or seat balances.
- **Create Billable Metric**: Create a streaming billable metric from event filters and aggregation rules, or create a SQL billable metric by supplying sql instead.
- **Create Contract**: Create a Metronome contract with pricing, credits, commitments, subscriptions, and billing terms.
- **Create Custom Field Key**: Create an allowed custom field key for a Metronome entity type and choose whether its values must be unique.
- **Create Customer**: Create a Metronome customer with optional usage aliases, custom fields, and billing or revenue system configurations.
- **Create Customer Commit**: Create a customer-level prepaid or postpaid commit with access and invoice schedules.
- **Create Customer Credit**: Create a customer-level credit with a scheduled spend or quantity balance.
- **Create Historical Contract Usage Invoices**: Validate a read-only preview or create retroactive contract usage invoices for historical billing periods.
- **Create Notification Config**: Create a notification that publishes a webhook at an ISO 8601 time offset from a Metronome lifecycle event.
- **Create Package**: Create a reusable package of time-relative contract pricing and billing terms.
- **Create Pricing Unit**: Create a custom Metronome pricing unit for charging usage in a non-fiat unit.
- **Create Product**: Create a Metronome product representing an invoice line item, including its usage metric, composite behavior, quantity rules, tags, and…
- **Create Rate Card**: Create a Metronome rate card with pricing-unit conversions and scheduled aliases.
- **Delete Custom Field Key**: Remove a custom field key from a Metronome entity type's allowlist, making existing values for that key inaccessible.
- **Delete Custom Fields**: Delete selected custom field values from one Metronome entity instance without changing its other custom fields.
- **Disable Commit True-up**: Disable generation of the final true-up invoice for a postpaid commit.
- **Edit Commit**: Edit a commit's metadata, schedules, applicability, product, rate, priority, or hierarchy access.
- **Edit Contract**: Apply a v2 contract edit that adds, updates, archives, or removes contract terms.
- **Edit Credit**: Edit a credit's metadata, access schedule, applicability, product, rate, priority, or hierarchy access.
- **Edit Notification Config**: Change an offset notification policy or enable or disable webhook publishing for a system lifecycle notification.
- **Get Audit Logs** (read-only): Get one page of account audit entries for security monitoring, compliance, and operational investigation.
- **Get Batched Usage Data** (read-only): Return one page of usage aggregated across customers and billable metrics for hourly, daily, or whole-period reporting.
- **Get Billable Metric** (read-only): Retrieve one Metronome billable metric by ID, including its event matching, aggregation, grouping, custom fields, SQL, and archive state.
- **Get Contract** (read-only): Retrieve the current or historical v2 configuration of a Metronome contract.
- **Get Contract Edit History** (read-only): List all recorded edits made to a Metronome contract over time.
- **Get Contract Named Schedule** (read-only): Get the segments of a named schedule for a customer's Metronome contract, optionally selected by date and schedule properties.
- **Get Contract Rate Schedule** (read-only): Get one page of entitled contract rates at a point in time, including contract overrides.
- **Get Customer** (read-only): Get a Metronome customer by ID, including aliases, configuration, and custom fields.
- **Get Customer Alert** (read-only): Get a threshold notification's configuration and current evaluation status for a specific customer.
- **Get Customer Billing Provider Configurations** (read-only): Fetch active or archived billing provider configurations for a customer.
- **Get Customer Named Schedule** (read-only): Get the segments of a named schedule configured for a Metronome customer, optionally restricted to the segment covering a date.
- **Get Customer Revenue System Configurations** (read-only): Fetch revenue system configurations for a Metronome customer.
- **Get Embeddable Dashboard URL** (read-only): Create a secure, time-limited URL for a user-facing customer Metronome dashboard.
- **Get Grouped Usage Data** (read-only): Return one page of usage for one customer and billable metric, optionally grouped and filtered by a complete simple or compound metric…
- **Get Invoice** (read-only): Retrieve one Metronome customer invoice by ID, including its line items and external billing status.
- **Get Invoice PDF** (read-only): Download a Metronome invoice PDF and return an offloaded file reference.
- **Get Net Balance** (read-only): Get the combined current balance across a filtered set of customer commits and credits.
- **Get Notification Config** (read-only): Retrieve an offset lifecycle-event notification configuration by ID.
- **Get Package** (read-only): Get one package's name, alias schedule, duration, commits, credits, overrides, scheduled charges, and contract defaults.
- **Get Product** (read-only): Get a Metronome product by ID, including its current and initial configuration, historical updates, archive state, and custom fields.
- **Get Rate Card** (read-only): Get one rate card's metadata, pricing unit, conversions, aliases, and custom fields.
- **Get Rate Card Named Schedule** (read-only): Get the segments of a named schedule configured on a Metronome rate card, optionally restricted to the segment covering a date.
- **Get Rate Schedule** (read-only): Get one page of scheduled rate-card prices over a requested time window.
- **Get Rates** (read-only): Get one page of rate-card prices active at a specific timestamp.
- **Get Services** (read-only): Get Metronome's service registry and current IP addresses for firewall and network allowlist configuration.
- **Get Subscription Quantity History** (read-only): Retrieve historical subscription quantities and prices for a contract subscription.
- **Get Subscription Seats History** (read-only): Get one page of historical seat assignments and quantities for a contract subscription.
- **Get Webhook Delivery** (read-only): Retrieve one triggered Metronome webhook notification, its exact JSON payload, and every recorded delivery attempt.
- **Ingest Usage Events**: Ingest one to 100 usage events that immediately affect customer usage, spend, and billing.
- **List Billable Metrics** (read-only): List billable metric definitions, optionally including archived metrics, for pricing and event-matching discovery.
- **List Billing Providers** (read-only): List account-level billing providers and their delivery-method configurations.
- **List Contract Named Schedules** (read-only): List one page of contract-level named schedules for a Metronome customer, with optional contract, name, property, and date filters.
- **List Contracts** (read-only): List one page of a customer's current v2 contracts with optional balances, ledgers, and archive filters.
- **List Contracts On Package** (read-only): List one page of customer contracts provisioned from a package over a selected time period.
- **List Custom Field Keys** (read-only): List active Metronome custom field keys, optionally filtered to selected entity types.
- **List Customer Alerts** (read-only): List one page of threshold notifications and their current evaluation statuses for a customer.
- **List Customer Balances** (read-only): List one page of a customer's current commit and credit balances.
- **List Customer Billable Metrics** (read-only): List billable metrics available for a Metronome customer, optionally filtering to the current plan or including archived metrics.
- **List Customer Commits** (read-only): List one page of customer-level and optionally contract-level commits.
- **List Customer Credits** (read-only): List one page of customer-level and optionally contract-level credits.
- **List Customers** (read-only): List active or archived Metronome customers, optionally filtering by customer, ingest, Salesforce, or Stripe identifiers.
- **List Historical Balances** (read-only): List one page of commits and credits moved to historical storage.
- **List Invoice Breakdowns** (read-only): List hourly or daily invoice breakdowns for a Metronome customer and time range.
- **List Invoices** (read-only): List one page of invoices for a Metronome customer with optional status, type, contract, credit type, and billing-period filters.
- **List Offset Notification Configs** (read-only): List one page of user-created lifecycle-event notifications that publish webhooks before or after their base events.
- **List Packages** (read-only): List contract packages with their terms, commits, overrides, scheduled charges, and archive state.
- **List Pricing Units** (read-only): List fiat and custom pricing units available for rates, credits, and commits.
- **List Products** (read-only): List Metronome products and their current configuration, version history, metadata, and archive state.
- **List Rate Cards** (read-only): List rate cards with their IDs, names, descriptions, aliases, pricing units, and metadata.
- **List Seat Balances** (read-only): List one page of seat-level commit and credit balances for a contract.
- **List Spend Invoice Breakdowns** (read-only): List one page of customer invoice spend breakdowns by time window and optional presentation groups.
- **List System Notification Configs** (read-only): List one page of Metronome system lifecycle notification types and whether their webhook publishing is enabled.
- **List Webhook Deliveries** (read-only): List one page of triggered notifications and delivery summaries for a Metronome webhook destination from the last 30 days.
- **Move Rate Card Products**: Move selected products to new invoice-order positions on a rate card.
- **Preview Customer Events** (read-only): Calculate customer invoice previews from supplied usage events without ingesting the events.
- **Regenerate Invoice**: Regenerate a previously voided Metronome invoice using current rates, balances, and fees, distribute the replacement through the…
- **Release External Payment Gate Threshold Commit**: Complete or cancel a threshold commit after an external payment attempt.
- **Reset Customer Alerts**: Clear a threshold notification's cached state for a customer and trigger an asynchronous re-evaluation.
- **Schedule Pro Services Invoice**: Schedule an invoice for professional service terms on a contract.
- **Search Events** (read-only): Retrieve recent usage events by transaction ID to sample ingestion, customer matching, metric matching, and duplicate handling.
- **Set Custom Fields**: Transactionally set or overwrite custom field values on one Metronome entity instance while preserving unspecified fields.
- **Set Customer Billable Status**: Set whether a Metronome customer is billable from a specified effective time.
- **Set Customer Billing Provider Configurations**: Create one or more billing provider configurations for Metronome customers.
- **Set Customer Ingest Aliases**: Replace the complete set of usage ingest aliases for a Metronome customer.
- **Set Customer Name**: Update the display name of a Metronome customer.
- **Set Customer Revenue System Configurations**: Create one or more revenue system configurations for Metronome customers.
- **Set Rate Card Products Order**: Replace the complete invoice display order of products on a rate card.
- **Set Up Billing Provider**: Set up account-level Metronome configuration for a marketplace billing provider.
- **Set Usage Filter**: Route a customer's grouped usage to a contract starting at a specified time.
- **Update Billable Metric**: Rename an existing Metronome billable metric.
- **Update Commit End Date**: Update the access or invoice end date of a prepaid customer commit.
- **Update Contract End Date**: Set, move, or remove a contract's exclusive end timestamp.
- **Update Contract Named Schedule**: Set a dated segment on a named schedule for a customer's Metronome contract.
- **Update Credit End Date**: Update the access end date of a customer credit.
- **Update Customer Configuration**: Update the Salesforce account configuration for a Metronome customer.
- **Update Customer Named Schedule**: Set a dated segment on a named schedule configured for a Metronome customer.
- **Update Invoice Issue Date**: Reschedule the issue date of one draft contract invoice without changing future billing cycles.
- **Update Product**: Schedule a configuration update for a Metronome product without changing its type.
- **Update Rate Card**: Update a rate card's metadata, alias schedule, or pricing-unit conversions.
- **Update Rate Card Named Schedule**: Set a dated segment on a named schedule configured for a Metronome rate card.
- **Upsert Anrok API Token**: Set the Anrok API token used by specified Metronome billing delivery methods.
- **Upsert Avalara Credentials**: Set Avalara credentials for specified Metronome billing delivery methods.
- **Void Invoice**: Permanently void a Metronome invoice.
