---
canonical_url: "https://docs.composio.dev/toolkits/metronome"
markdown_url: "https://docs.composio.dev/toolkits/metronome.md"
product: "platform"
version: null
last_updated: null
---

# Metronome

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

- **Category:** accounting
- **Auth:** BEARER_TOKEN
- **Composio-managed OAuth available?** N/A
- **Tools:** 118
- **Triggers:** 0
- **Slug:** `METRONOME`
- **Version:** 00000000_00

## Tools

### Add Manual Balance Ledger Entry

**Slug:** `METRONOME_ADD_MANUAL_BALANCE_LEDGER_ENTRY`

Manually increase or decrease an existing commit or credit balance segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the commit or credit balance to adjust. |
| `amount` | number | Yes | Amount to add; a negative value draws down the balance. |
| `reason` | string | Yes | Reason displayed in the balance ledger. |
| `timestamp` | string | No | Time of the adjustment; defaults to the segment start. |
| `segment_id` | string | Yes | ID of the balance segment to adjust. |
| `contract_id` | string | No | Contract ID; omit for a customer-level balance. |
| `customer_id` | string | Yes | ID of the customer whose balance is adjusted. |
| `uniqueness_key` | string | No | Idempotent resource uniqueness key. |
| `per_group_amounts` | object | No | Per-seat amounts, which must sum to amount. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Rate

**Slug:** `METRONOME_ADD_RATE`

Add one product rate to a Metronome rate card. Prefer Add Rates for bulk changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price` | number | No | Default price for the rate. |
| `tiers` | array | No | Price tiers for a tiered rate. |
| `entitled` | boolean | Yes | Whether contracts are entitled to this product. |
| `quantity` | number | No | Default quantity for a subscription rate. |
| `rate_type` | string ("FLAT" | "flat" | "PERCENTAGE" | "percentage" | "SUBSCRIPTION" | "subscription" | "TIERED" | "tiered" | "TIERED_PERCENTAGE" | "tiered_percentage" | "CUSTOM" | "custom") | Yes | Pricing model for the rate. |
| `product_id` | string | Yes | ID of the product to price. |
| `commit_rate` | object | No | Alternative rate used when consuming a commit. |
| `custom_rate` | object | No | Configuration interpreted by a custom rate processor. |
| `is_prorated` | boolean | No | Whether a subscription rate is prorated. |
| `starting_at` | string | Yes | Inclusive effective timestamp for the rate. |
| `rate_card_id` | string | Yes | ID of the rate card to update. |
| `ending_before` | string | No | Exclusive end timestamp for the rate. |
| `credit_type_id` | string | No | Pricing unit for the rate; defaults to USD cents. |
| `minimum_config` | object | No | Minimum charge for a percentage-based rate. |
| `billing_frequency` | string ("MONTHLY" | "QUARTERLY" | "SEMI_ANNUAL" | "ANNUAL" | "WEEKLY" | "monthly" | "quarterly" | "semi_annual" | "annual" | "weekly") | No | Billing frequency for subscription products. |
| `pricing_group_values` | object | No | Pricing-group key-value pairs used to select this rate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Rates

**Slug:** `METRONOME_ADD_RATES`

Add multiple product rates to a Metronome rate card in one request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rates` | array | Yes | Product rates to add to the rate card. |
| `rate_card_id` | string | Yes | ID of the rate card to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Alert

**Slug:** `METRONOME_ARCHIVE_ALERT`

Permanently stop a threshold notification from evaluating, optionally releasing its uniqueness key for reuse.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Metronome ID of the threshold notification to archive. |
| `release_uniqueness_key` | boolean | No | Release the notification's uniqueness key so it can be reused. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Billable Metric

**Slug:** `METRONOME_ARCHIVE_BILLABLE_METRIC`

Archive a Metronome billable metric. Archived metrics cannot be assigned to new products, and Metronome does not document a restore operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the billable metric to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Commit

**Slug:** `METRONOME_ARCHIVE_COMMIT`

Archive a customer commit so it is no longer active.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `commit_id` | string | Yes | ID of the commit to archive. |
| `customer_id` | string | Yes | ID of the customer whose commit is archived. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Contract

**Slug:** `METRONOME_ARCHIVE_CONTRACT`

Permanently end and archive a contract and its terms, cancel draft invoices, void upcoming scheduled invoices, and optionally void existing finalized invoices. Active prepaid commit balances are closed and may receive expiration ledger entries. Requires the customer and contract IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | ID of the contract to archive. |
| `customer_id` | string | Yes | ID of the customer whose contract will be archived. |
| `void_invoices` | boolean | Yes | Whether to also void existing finalized invoices. Draft invoices are always canceled and upcoming scheduled invoices are always voided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Credit

**Slug:** `METRONOME_ARCHIVE_CREDIT`

Archive a customer credit so it is no longer active.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credit_id` | string | Yes | ID of the credit to archive. |
| `customer_id` | string | Yes | ID of the customer whose credit is archived. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Pricing Unit

**Slug:** `METRONOME_ARCHIVE_CREDIT_TYPE`

Archive a custom Metronome pricing unit so it no longer appears in pricing unit selectors by default.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the custom pricing unit to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Customer

**Slug:** `METRONOME_ARCHIVE_CUSTOMER`

Permanently archive a Metronome customer and every customer contract, void the corresponding invoices, and stop associated notifications. Requires the customer ID and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the customer to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Customer Billing Provider Configurations

**Slug:** `METRONOME_ARCHIVE_CUSTOMER_BILLING_PROVIDER_CONFIGURATIONS`

Archive one or more billing provider configurations for a Metronome customer. This immediately stops affected contracts from metering to downstream systems.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | UUID of the customer that owns the billing provider configurations. |
| `customer_billing_provider_configuration_ids` | array | Yes | UUIDs of the customer billing provider configurations to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Notification Config

**Slug:** `METRONOME_ARCHIVE_NOTIFICATION_CONFIG`

Archive an offset lifecycle-event notification configuration so Metronome no longer processes it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the offset notification configuration to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Package

**Slug:** `METRONOME_ARCHIVE_PACKAGE`

Permanently archive a package so it cannot be used to create new contracts. Existing contracts using the package continue to function.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | string | Yes | ID of the package to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Product

**Slug:** `METRONOME_ARCHIVE_PRODUCT`

Archive a Metronome product so it cannot be used for new rates. Existing rate cards continue to function, and Metronome does not support unarchiving.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | ID of the product to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Rate Card

**Slug:** `METRONOME_ARCHIVE_RATE_CARD`

Permanently archive a rate card so it cannot be used for new contracts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the rate card to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Alert

**Slug:** `METRONOME_CREATE_ALERT`

Create a threshold notification that monitors customer spend, usage, credits, commits, invoice totals, or seat balances.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Display name of the threshold notification. |
| `threshold` | number | Yes | Threshold amount, remaining days, or percentage used by the notification. |
| `alert_type` | string ("spend_threshold_reached" | "monthly_invoice_total_spend_threshold_reached" | "usage_threshold_reached" | "low_remaining_days_for_commit_segment_reached" | "low_remaining_commit_balance_reached" | "low_remaining_commit_percentage_reached" | "low_remaining_days_for_contract_credit_segment_reached" | "low_remaining_contract_credit_balance_reached" | "low_remaining_contract_credit_percentage_reached" | "low_remaining_contract_credit_and_commit_balance_reached" | "low_remaining_contract_credit_and_commit_percentage_reached" | "invoice_total_reached" | "low_remaining_seat_balance_reached") | Yes | Type of threshold notification to create. |
| `access_type` | string ("SPEND" | "spend" | "QUANTITY" | "quantity") | No | Commit or credit access type evaluated by supported notifications. |
| `customer_id` | string | No | Customer ID to target; omit to create the notification for all customers. |
| `seat_filter` | object | No | Seat group scope for a remaining seat balance notification. |
| `group_values` | array | No | Presentation group key-value filters for spend threshold notifications. |
| `credit_type_id` | string | No | Pricing unit ID used by notification types that evaluate monetary balances. |
| `uniqueness_key` | string | No | Unique idempotency key that prevents duplicate notification creation. |
| `alert_specifiers` | array | No | Commit and credit filters used to calculate combined remaining balances. |
| `billable_metric_id` | string | No | Billable metric ID required for usage threshold notifications. |
| `evaluate_on_create` | boolean | No | Evaluate existing customers immediately after creating the notification. |
| `custom_field_filters` | array | No | Custom field filters for notification types that support advanced filtering. |
| `invoice_types_filter` | array | No | Invoice types evaluated by an invoice total notification. |
| `credit_grant_type_filters` | array | No | Credit grant types to which the notification applies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Billable Metric

**Slug:** `METRONOME_CREATE_BILLABLE_METRIC`

Create a streaming billable metric from event filters and aggregation rules, or create a SQL billable metric by supplying sql instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sql` | string | No | SQL query for a SQL billable metric. Omit aggregation_type, event_type_filter, property_filters, aggregation_key, and group_keys when this is provided. |
| `name` | string | Yes | Display name of the billable metric. |
| `group_keys` | array | No | Property sets used to group usage into distinct invoice buckets. |
| `custom_fields` | object | No | Custom key-value fields to attach to the billable metric. |
| `aggregation_key` | string | No | Event property aggregated by the metric; it must name a property filter and does not apply to count aggregation. |
| `aggregation_type` | string ("count" | "Count" | "COUNT" | "latest" | "Latest" | "LATEST" | "max" | "Max" | "MAX" | "sum" | "Sum" | "SUM" | "unique" | "Unique" | "UNIQUE") | No | Aggregation performed on matching events. |
| `property_filters` | array | No | Rules on event properties; every rule must pass for an event to match. |
| `event_type_filter` | object | No | Optional rule matching events by event type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contract

**Slug:** `METRONOME_CREATE_CONTRACT`

Create a Metronome contract with pricing, credits, commitments, subscriptions, and billing terms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Customer-facing contract name. |
| `commits` | array | No | Commitment terms to create. |
| `credits` | array | No | Credit terms to create. |
| `discounts` | array | No | Discount terms to add when enabled for the account. |
| `overrides` | array | No | Rate overrides to add to the contract. |
| `package_id` | string | No | Package ID to provision instead of defining standalone terms. |
| `transition` | object | No | Renewal or supersession relationship to another contract. |
| `customer_id` | string | Yes | ID of the customer receiving the contract. |
| `starting_at` | string | Yes | Inclusive contract start timestamp. |
| `rate_card_id` | string | No | Rate card used by the contract. |
| `usage_filter` | object | No | Usage routing filter for this contract. |
| `custom_fields` | object | No | Custom field values for the contract. |
| `ending_before` | string | No | Exclusive contract end timestamp. |
| `package_alias` | string | No | Package alias to provision; mutually exclusive with package_id. |
| `subscriptions` | array | No | Subscription terms to create. |
| `spend_trackers` | array | No | Spend trackers attached to this contract. |
| `uniqueness_key` | string | No | Idempotency key preventing duplicate contract creation. |
| `rate_card_alias` | string | No | Rate card alias resolved as of the contract start. |
| `stripe_metadata` | object | No | Stripe subscription metadata linked to the contract. |
| `recurring_commits` | array | No | Recurring commitment terms to create. |
| `recurring_credits` | array | No | Recurring credit terms to create. |
| `scheduled_charges` | array | No | One-time scheduled charges to add. |
| `reseller_royalties` | array | No | Reseller royalty terms to add. |
| `total_contract_value` | number | No | Total value recorded for the contract. |
| `professional_services` | array | No | Professional service terms to add. |
| `net_payment_terms_days` | number | No | Days after invoice issue when payment is due. |
| `package_customizations` | object | No | Overrides applied when provisioning from a package. |
| `hierarchy_configuration` | object | No | Account hierarchy configuration for the contract. |
| `netsuite_sales_order_id` | string | No | NetSuite sales order associated with the contract. |
| `usage_statement_schedule` | object | No | Usage statement cadence and billing anchor. |
| `salesforce_opportunity_id` | string | No | Salesforce opportunity associated with the contract. |
| `revenue_system_configuration` | object | No | Revenue system configuration selected for the contract. |
| `spend_threshold_configuration` | object | No | Spend threshold configuration for the contract. |
| `billing_provider_configuration` | object | No | Billing provider configuration selected for the contract. |
| `credit_type_conversion_overrides` | array | No | Custom pricing-unit conversion overrides. |
| `multiplier_override_prioritization` | string ("LOWEST_MULTIPLIER" | "lowest_multiplier" | "EXPLICIT" | "explicit") | No | How overlapping multiplier overrides are prioritized. |
| `scheduled_charges_on_usage_invoices` | string | No | How scheduled charges are placed on usage invoices. |
| `prepaid_balance_threshold_configuration` | object | No | Prepaid balance threshold configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Pricing Unit

**Slug:** `METRONOME_CREATE_CREDIT_TYPE`

Create a custom Metronome pricing unit for charging usage in a non-fiat unit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the custom pricing unit shown on invoices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer

**Slug:** `METRONOME_CREATE_CUSTOMER`

Create a Metronome customer with optional usage aliases, custom fields, and billing or revenue system configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Customer display name; Metronome truncates it to 160 characters. |
| `external_id` | string | No | Deprecated usage identifier; prefer ingest_aliases. |
| `custom_fields` | object | No | Custom field values to attach to the customer. |
| `ingest_aliases` | array | No | Aliases that can identify this customer in usage events. |
| `customer_revenue_system_configurations` | array | No | Revenue system configurations to create with the customer. |
| `customer_billing_provider_configurations` | array | No | Billing provider configurations to create with the customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Commit

**Slug:** `METRONOME_CREATE_CUSTOMER_COMMIT`

Create a customer-level prepaid or postpaid commit with access and invoice schedules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name displayed on invoices. |
| `type` | string ("PREPAID" | "prepaid" | "POSTPAID" | "postpaid") | Yes | Commit payment timing. |
| `priority` | number | Yes | Drawdown priority; lower values apply first. |
| `rate_type` | string ("COMMIT_RATE" | "commit_rate" | "LIST_RATE" | "list_rate") | No | Rate used to draw down the commit. |
| `product_id` | string | Yes | Fixed product used to invoice the commit. |
| `specifiers` | array | No | Usage filters for commit drawdown. |
| `customer_id` | string | Yes | ID of the customer receiving the commit. |
| `description` | string | No | Internal commit description. |
| `custom_fields` | object | No | Custom fields attached to the commit. |
| `uniqueness_key` | string | No | Key preventing duplicate commits or credits. |
| `access_schedule` | object | Yes | Schedule distributing committed balance. |
| `invoice_schedule` | object | No | Schedule for invoicing the commit. |
| `invoice_contract_id` | string | No | Contract billed for the commit. |
| `applicable_product_ids` | array | No | Products whose usage can draw down the commit. |
| `applicable_contract_ids` | array | No | Contracts to which the commit applies. |
| `applicable_product_tags` | array | No | Product tags whose usage can draw down the commit. |
| `netsuite_sales_order_id` | string | No | NetSuite sales order ID, when enabled. |
| `salesforce_opportunity_id` | string | No | Salesforce opportunity ID, when enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Credit

**Slug:** `METRONOME_CREATE_CUSTOMER_CREDIT`

Create a customer-level credit with a scheduled spend or quantity balance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name displayed on invoices. |
| `priority` | number | Yes | Drawdown priority; lower values apply first. |
| `rate_type` | string ("COMMIT_RATE" | "commit_rate" | "LIST_RATE" | "list_rate") | No | Rate used to draw down the credit. |
| `product_id` | string | Yes | Product associated with the credit. |
| `specifiers` | array | No | Usage filters for credit drawdown. |
| `customer_id` | string | Yes | ID of the customer receiving the credit. |
| `description` | string | No | Internal credit description. |
| `custom_fields` | object | No | Custom fields attached to the credit. |
| `uniqueness_key` | string | No | Key preventing duplicate commits or credits. |
| `access_schedule` | object | Yes | Schedule distributing credit balance. |
| `applicable_product_ids` | array | No | Products whose usage can draw down the credit. |
| `applicable_contract_ids` | array | No | Contracts to which the credit applies. |
| `applicable_product_tags` | array | No | Product tags whose usage can draw down the credit. |
| `netsuite_sales_order_id` | string | No | NetSuite sales order ID, when enabled. |
| `salesforce_opportunity_id` | string | No | Salesforce opportunity ID, when enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field Key

**Slug:** `METRONOME_CREATE_CUSTOM_FIELD_KEY`

Create an allowed custom field key for a Metronome entity type and choose whether its values must be unique.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Custom field key to add to the entity's allowlist. |
| `entity` | string ("alert" | "billable_metric" | "charge" | "commit" | "contract_credit" | "contract_product" | "contract" | "customer" | "discount" | "invoice" | "professional_service" | "product" | "rate_card" | "scheduled_charge" | "subscription" | "package_commit" | "package_credit" | "package_subscription" | "package_scheduled_charge") | Yes | Metronome entity type that will allow this custom field key. |
| `enforce_uniqueness` | boolean | Yes | Whether values for this key must be unique across the entity type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Historical Contract Usage Invoices

**Slug:** `METRONOME_CREATE_HISTORICAL_CONTRACT_USAGE_INVOICES`

Validate a read-only preview or create retroactive contract usage invoices for historical billing periods. Set preview=true for validation with no billing records created; set preview=false to create invoices. Because this single endpoint can create billing records, the action is classified as a create operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `preview` | boolean | Yes | Set true to validate and return a read-only preview without creating billing records. Set false only when ready to create the invoices. |
| `invoices` | array | Yes | Historical contract usage invoices to validate in preview mode or persist in creation mode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notification Config

**Slug:** `METRONOME_CREATE_NOTIFICATION_CONFIG`

Create a notification that publishes a webhook at an ISO 8601 time offset from a Metronome lifecycle event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the offset notification configuration. |
| `policy` | object | Yes | Lifecycle event and time offset that trigger the notification. |
| `uniqueness_key` | string | No | Key that prevents duplicate notification configurations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Package

**Slug:** `METRONOME_CREATE_PACKAGE`

Create a reusable package of time-relative contract pricing and billing terms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Package name. |
| `aliases` | array | No | Package aliases. |
| `commits` | array | No | Commit templates. |
| `credits` | array | No | Credit templates. |
| `duration` | object | No | Contract duration. |
| `overrides` | array | No | Rate overrides. |
| `rate_card_id` | string | No | Provisioned rate card. |
| `contract_name` | string | No | Provisioned contract name. |
| `subscriptions` | array | No | Subscription templates. |
| `spend_trackers` | array | No | Spend trackers. |
| `uniqueness_key` | string | No | Package idempotency key. |
| `delivery_method` | string ("direct_to_billing_provider" | "aws_sqs" | "tackle" | "aws_sns") | No | Invoice delivery method. |
| `rate_card_alias` | string | No | Provisioned rate card alias. |
| `billing_provider` | string ("aws_marketplace" | "azure_marketplace" | "gcp_marketplace" | "stripe" | "netsuite") | No | Required billing provider. |
| `recurring_commits` | array | No | Recurring commit templates. |
| `recurring_credits` | array | No | Recurring credit templates. |
| `scheduled_charges` | array | No | Scheduled charges. |
| `net_payment_terms_days` | number | No | Payment terms. |
| `usage_statement_schedule` | object | No | Usage statement schedule. |
| `spend_threshold_configuration` | object | No | Spend threshold settings. |
| `multiplier_override_prioritization` | string ("LOWEST_MULTIPLIER" | "lowest_multiplier" | "EXPLICIT" | "explicit") | No | Multiplier override priority mode. |
| `scheduled_charges_on_usage_invoices` | string | No | Consolidate all eligible scheduled charges onto usage invoices. |
| `prepaid_balance_threshold_configuration` | object | No | Prepaid balance threshold settings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `METRONOME_CREATE_PRODUCT`

Create a Metronome product representing an invoice line item, including its usage metric, composite behavior, quantity rules, tags, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Product name displayed on invoices. |
| `tags` | array | No | Tags assigned to the product. |
| `type` | string ("FIXED" | "fixed" | "USAGE" | "usage" | "COMPOSITE" | "composite" | "SUBSCRIPTION" | "subscription" | "PROFESSIONAL_SERVICE" | "professional_service" | "PRO_SERVICE" | "pro_service") | Yes | Product's pricing and usage behavior type. |
| `custom_fields` | object | No | Organization-defined custom fields attached to the product. |
| `is_refundable` | boolean | No | Whether charges for this product are refundable. |
| `composite_tags` | array | No | Tags selecting products included by a composite product. |
| `composite_scope` | string ("customer" | "CUSTOMER" | "contract" | "CONTRACT") | No | Whether customer-wide or contract-level spend contributes to the composite charge. |
| `pricing_group_key` | array | No | Billable metric group keys that determine separate prices. |
| `quantity_rounding` | object | No | Usage quantity rounding configuration. |
| `billable_metric_id` | string | No | Billable metric ID required for a usage product. |
| `exclude_free_usage` | boolean | No | Whether zero-cost products are excluded from composite usage. |
| `quantity_conversion` | object | No | Usage quantity conversion configuration. |
| `composite_product_ids` | array | No | Product IDs included by a composite product. |
| `presentation_group_key` | array | No | Billable metric group keys used to group invoice line items. |
| `include_composite_spend` | boolean | No | Whether spend from other composite products contributes to this product. |
| `netsuite_overage_item_id` | string | No | NetSuite overage item ID, when enabled for the organization. |
| `netsuite_internal_item_id` | string | No | NetSuite item ID, when enabled for the organization. |
| `sql_breakdown_granularity` | string ("HOUR" | "hour" | "SERVICE_PERIOD" | "service_period") | No | Whether SQL billable metric usage is evaluated hourly or per service period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Rate Card

**Slug:** `METRONOME_CREATE_RATE_CARD`

Create a Metronome rate card with pricing-unit conversions and scheduled aliases.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Internal name of the rate card. |
| `aliases` | array | No | Aliases used to resolve this rate card for new contracts. |
| `description` | string | No | Rate card description. |
| `custom_fields` | object | No | Custom fields attached to the rate card. |
| `fiat_credit_type_id` | string | No | Fiat pricing unit; defaults to USD cents. |
| `credit_type_conversions` | array | No | Conversions required for custom pricing units. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Field Key

**Slug:** `METRONOME_DELETE_CUSTOM_FIELD_KEY`

Remove a custom field key from a Metronome entity type's allowlist, making existing values for that key inaccessible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Custom field key to remove from the entity allowlist. |
| `entity` | string ("alert" | "billable_metric" | "charge" | "commit" | "contract_credit" | "contract_product" | "contract" | "customer" | "discount" | "invoice" | "professional_service" | "product" | "rate_card" | "scheduled_charge" | "subscription" | "package_commit" | "package_credit" | "package_subscription" | "package_scheduled_charge") | Yes | Metronome entity type whose custom field key will be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Fields

**Slug:** `METRONOME_DELETE_CUSTOM_FIELDS`

Delete selected custom field values from one Metronome entity instance without changing its other custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keys` | array | Yes | Custom field keys to remove from the specified entity instance. |
| `entity` | string ("alert" | "billable_metric" | "charge" | "commit" | "contract_credit" | "contract_product" | "contract" | "customer" | "discount" | "invoice" | "professional_service" | "product" | "rate_card" | "scheduled_charge" | "subscription" | "package_commit" | "package_credit" | "package_subscription" | "package_scheduled_charge") | Yes | Metronome entity type whose custom field values will be removed. |
| `entity_id` | string | Yes | Metronome UUID of the specific entity whose fields will be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Commit True-up

**Slug:** `METRONOME_DISABLE_COMMIT_TRUEUP`

Disable generation of the final true-up invoice for a postpaid commit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `commit_id` | string | Yes | ID of the postpaid commit. |
| `contract_id` | string | Yes | ID of the contract containing the commit. |
| `customer_id` | string | Yes | ID of the customer whose commit is updated. |
| `amendment_id` | string | No | Amendment ID containing the commit, when applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Commit

**Slug:** `METRONOME_EDIT_COMMIT`

Edit a commit's metadata, schedules, applicability, product, rate, priority, or hierarchy access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Updated commit name. |
| `priority` | number | No | Updated drawdown priority. |
| `commit_id` | string | Yes | ID of the commit to edit. |
| `rate_type` | string ("LIST_RATE" | "list_rate" | "COMMIT_RATE" | "commit_rate") | No | Updated rate type. |
| `product_id` | string | No | Updated commit product ID. |
| `specifiers` | array | No | Usage filters for commit drawdown. |
| `customer_id` | string | Yes | ID of the customer whose commit is edited. |
| `description` | string | No | Updated commit description. |
| `access_schedule` | object | No | Access schedule changes. |
| `invoice_schedule` | object | No | Invoice schedule changes. |
| `invoice_contract_id` | string | No | Contract used for invoicing. |
| `applicable_product_ids` | array | No | Products whose usage can draw down the commit; null applies to all. |
| `applicable_contract_ids` | array | No | Contracts to which the commit applies; null applies to all. |
| `applicable_product_tags` | array | No | Product tags whose usage can draw down the commit; null applies to all. |
| `hierarchy_configuration` | object | No | Child-contract access configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Contract

**Slug:** `METRONOME_EDIT_CONTRACT`

Apply a v2 contract edit that adds, updates, archives, or removes contract terms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `add_commits` | array | No | Commit terms to add. |
| `add_credits` | array | No | Credit terms to add. |
| `contract_id` | string | Yes | ID of the contract to edit. |
| `customer_id` | string | Yes | ID of the customer whose contract is edited. |
| `add_discounts` | array | No | Discount terms to add. |
| `add_overrides` | array | No | Rate overrides to add. |
| `uniqueness_key` | string | No | Idempotency key preventing duplicate contract edits. |
| `update_commits` | array | No | Commit changes. |
| `update_credits` | array | No | Credit changes. |
| `archive_commits` | array | No | Commits to archive. |
| `archive_credits` | array | No | Credits to archive. |
| `remove_overrides` | array | No | Rate overrides to remove. |
| `add_subscriptions` | array | No | Subscriptions to add. |
| `add_spend_trackers` | array | No | Spend trackers to add. |
| `add_stripe_metadata` | object | No | Stripe metadata to add to a contract that has none. |
| `update_contract_name` | string | No | New contract name; null clears the name. |
| `update_subscriptions` | array | No | Subscription changes. |
| `add_recurring_commits` | array | No | Recurring commitment terms to add. |
| `add_recurring_credits` | array | No | Recurring credit terms to add. |
| `add_scheduled_charges` | array | No | Scheduled charges to add. |
| `add_reseller_royalties` | array | No | Reseller royalty terms to add. |
| `archive_spend_trackers` | array | No | Spend tracker aliases to archive. |
| `update_stripe_metadata` | object | No | Stripe metadata to update or remove. |
| `update_contract_end_date` | string | No | New exclusive contract end timestamp; null removes the end date. |
| `update_recurring_commits` | array | No | Changes to future recurring commitments. |
| `update_recurring_credits` | array | No | Changes to future recurring credits. |
| `update_scheduled_charges` | array | No | Scheduled charge changes. |
| `add_professional_services` | array | No | Professional service terms to add. |
| `archive_scheduled_charges` | array | No | Scheduled charges to archive. |
| `update_net_payment_terms_days` | number | No | New invoice payment terms in days; null clears them. |
| `add_spend_threshold_configuration` | object | No | Spend threshold configuration to add. |
| `add_credit_type_conversion_overrides` | array | No | Pricing-unit conversion overrides to add. |
| `update_spend_threshold_configuration` | object | No | Spend threshold configuration changes. |
| `add_revenue_system_configuration_update` | object | No | Revenue system configuration update to schedule. |
| `add_billing_provider_configuration_update` | object | No | Billing provider configuration update to schedule. |
| `add_prepaid_balance_threshold_configuration` | object | No | Prepaid balance threshold configuration to add. |
| `allow_contract_ending_before_finalized_invoice` | boolean | No | Allow the contract to end before an existing finalized invoice period. |
| `update_prepaid_balance_threshold_configuration` | object | No | Prepaid balance threshold configuration changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Credit

**Slug:** `METRONOME_EDIT_CREDIT`

Edit a credit's metadata, access schedule, applicability, product, rate, priority, or hierarchy access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Updated credit name. |
| `priority` | number | No | Updated drawdown priority. |
| `credit_id` | string | Yes | ID of the credit to edit. |
| `rate_type` | string ("LIST_RATE" | "list_rate" | "COMMIT_RATE" | "commit_rate") | No | Updated rate type. |
| `product_id` | string | No | Updated credit product ID. |
| `specifiers` | array | No | Usage filters for credit drawdown. |
| `customer_id` | string | Yes | ID of the customer whose credit is edited. |
| `description` | string | No | Updated credit description. |
| `access_schedule` | object | No | Access schedule changes. |
| `applicable_product_ids` | array | No | Products whose usage can draw down the credit; null applies to all. |
| `applicable_contract_ids` | array | No | Contracts to which the credit applies; null applies to all. |
| `applicable_product_tags` | array | No | Product tags whose usage can draw down the credit; null applies to all. |
| `hierarchy_configuration` | object | No | Child-contract access configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Notification Config

**Slug:** `METRONOME_EDIT_NOTIFICATION_CONFIG`

Change an offset notification policy or enable or disable webhook publishing for a system lifecycle notification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Offset notification configuration ID; omit for a system event. |
| `policy` | string | Yes | Updated policy. Its lifecycle event type must match the existing configuration. |
| `is_enabled` | boolean | No | Enable or disable webhook publishing for a system lifecycle event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Audit Logs

**Slug:** `METRONOME_GET_AUDIT_LOGS`

Get one page of account audit entries for security monitoring, compliance, and operational investigation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date_asc" | "date_desc") | No | Order entries by timestamp in ascending or descending order. |
| `limit` | integer | No | Maximum audit log entries to return in this page (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `resource_id` | string | No | Resource ID to filter by; resource_type is required when this is set. |
| `starting_on` | string | No | Earliest audit log timestamp to return, inclusive; cannot be used with next_page. |
| `ending_before` | string | No | Latest audit log timestamp to return, exclusive; cannot be used with next_page. |
| `resource_type` | string | No | Resource type to filter by; resource_id is required when this is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Billable Metric

**Slug:** `METRONOME_GET_BILLABLE_METRIC`

Retrieve one Metronome billable metric by ID, including its event matching, aggregation, grouping, custom fields, SQL, and archive state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `billable_metric_id` | string | Yes | UUID of the billable metric to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contract

**Slug:** `METRONOME_GET_CONTRACT`

Retrieve the current or historical v2 configuration of a Metronome contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `as_of_date` | string | No | Return contract configuration as of this timestamp; cannot be combined with include_ledgers. |
| `contract_id` | string | Yes | ID of the contract to retrieve. |
| `customer_id` | string | Yes | ID of the customer that owns the contract. |
| `include_balance` | boolean | No | Include current credit and commit balances. |
| `include_ledgers` | boolean | No | Include commit and credit ledgers; cannot be combined with as_of_date. |
| `webhook_notification_id` | string | No | Webhook notification that triggered this request, when applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contract Edit History

**Slug:** `METRONOME_GET_CONTRACT_EDIT_HISTORY`

List all recorded edits made to a Metronome contract over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | ID of the contract whose edit history is requested. |
| `customer_id` | string | Yes | ID of the customer that owns the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contract Named Schedule

**Slug:** `METRONOME_GET_CONTRACT_NAMED_SCHEDULE`

Get the segments of a named schedule for a customer's Metronome contract, optionally selected by date and schedule properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `properties` | object | No | Key-value qualifiers selecting the applicable schedule. |
| `contract_id` | string | Yes | ID of the contract whose schedule will be retrieved. |
| `customer_id` | string | Yes | ID of the customer that owns the contract. |
| `covering_date` | string | No | Return at most the segment covering this date; omit to return every segment. |
| `schedule_name` | string | Yes | Identifier of the named schedule to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contract Rate Schedule

**Slug:** `METRONOME_GET_CONTRACT_RATE_SCHEDULE`

Get one page of entitled contract rates at a point in time, including contract overrides.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum rate segments to return in this page. |
| `next_page` | string | No | Cursor returned by a previous call; omit for the first page. |
| `selectors` | array | No | Selectors; rates matching any selector are returned. |
| `contract_id` | string | Yes | ID of the contract whose rate schedule is requested. |
| `customer_id` | string | Yes | ID of the customer whose rate schedule is requested. |
| `effective_at` | string | No | Timestamp overlapping the requested rate segments; omit to use now. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `METRONOME_GET_CUSTOMER`

Get a Metronome customer by ID, including aliases, configuration, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | UUID of the customer to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Alert

**Slug:** `METRONOME_GET_CUSTOMER_ALERT`

Get a threshold notification's configuration and current evaluation status for a specific customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Metronome ID of the threshold notification. |
| `customer_id` | string | Yes | Metronome ID of the customer. |
| `seat_filter` | object | No | Seat group key-value pair used to select a seat notification. |
| `group_values` | array | No | Presentation group key-value filters for a spend notification. |
| `alert_specifiers` | array | No | Commit and credit custom field filters used to select the notification. |
| `plans_or_contracts` | string ("PLANS" | "CONTRACTS") | No | Select plan or contract notifications during a parallel migration. |
| `custom_field_filters` | array | No | Custom field filters used to select the notification. |
| `webhook_notification_id` | string | No | Webhook notification ID that triggered this status lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Billing Provider Configurations

**Slug:** `METRONOME_GET_CUSTOMER_BILLING_PROVIDER_CONFIGURATIONS`

Fetch active or archived billing provider configurations for a customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | UUID of the customer whose configurations to retrieve. |
| `include_archived` | boolean | No | Whether to include archived billing provider configurations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Named Schedule

**Slug:** `METRONOME_GET_CUSTOMER_NAMED_SCHEDULE`

Get the segments of a named schedule configured for a Metronome customer, optionally restricted to the segment covering a date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | ID of the customer whose schedule will be retrieved. |
| `covering_date` | string | No | Return at most the segment covering this date; omit to return every segment. |
| `schedule_name` | string | Yes | Identifier of the named schedule to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Revenue System Configurations

**Slug:** `METRONOME_GET_CUSTOMER_REVENUE_SYSTEM_CONFIGURATIONS`

Fetch revenue system configurations for a Metronome customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | No | Optional revenue system provider filter. |
| `customer_id` | string | Yes | UUID of the customer whose configurations to retrieve. |
| `include_archived` | boolean | No | Whether to include archived revenue system configurations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Embeddable Dashboard URL

**Slug:** `METRONOME_GET_EMBEDDABLE_DASHBOARD_URL`

Create a secure, time-limited URL for a user-facing customer Metronome dashboard. This returns an embeddable human interface, not dashboard data the agent can inspect; use invoice, usage, commit, or credit read actions when structured data is needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dashboard` | string ("invoices" | "usage" | "commits_and_credits") | Yes | Type of customer dashboard to retrieve. |
| `customer_id` | string | Yes | UUID of the customer whose dashboard to embed. |
| `color_overrides` | array | No | Optional dashboard color overrides. |
| `dashboard_options` | array | No | Dashboard-specific display and filtering options. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice

**Slug:** `METRONOME_GET_INVOICE`

Retrieve one Metronome customer invoice by ID, including its line items and external billing status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | Yes | ID of the invoice to retrieve. |
| `customer_id` | string | Yes | ID of the customer that owns the invoice. |
| `skip_zero_qty_line_items` | boolean | No | Whether to omit zero-quantity line items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice PDF

**Slug:** `METRONOME_GET_INVOICE_PDF`

Download a Metronome invoice PDF and return an offloaded file reference.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | Yes | ID of the invoice whose PDF to download. |
| `customer_id` | string | Yes | ID of the customer that owns the invoice. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Net Balance

**Slug:** `METRONOME_GET_NET_BALANCE`

Get the combined current balance across a filtered set of customer commits and credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | No | OR-combined balance filters; fields inside each filter are ANDed. |
| `access_type` | string ("SPEND" | "spend" | "QUANTITY" | "quantity") | No | How matching balances are drawn down. |
| `customer_id` | string | Yes | ID of the customer. |
| `credit_type_id` | string | No | Pricing unit ID; defaults to USD cents. |
| `invoice_inclusion_mode` | string ("FINALIZED" | "FINALIZED_AND_DRAFT") | No | Whether draft invoice deductions affect the balance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notification Config

**Slug:** `METRONOME_GET_NOTIFICATION_CONFIG`

Retrieve an offset lifecycle-event notification configuration by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the offset notification configuration to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Package

**Slug:** `METRONOME_GET_PACKAGE`

Get one package's name, alias schedule, duration, commits, credits, overrides, scheduled charges, and contract defaults.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | string | Yes | ID of the package to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Grouped Usage Data

**Slug:** `METRONOME_GET_PAGED_USAGE`

Return one page of usage for one customer and billable metric, optionally grouped and filtered by a complete simple or compound metric group key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum grouped usage aggregates to return on this page (1-100). |
| `group_by` | object | No | Deprecated single-key grouping. Prefer group_key and group_filters. |
| `group_key` | array | No | Complete simple or compound group key configured on the metric. |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `customer_id` | string | Yes | ID of the customer whose usage to retrieve. |
| `starting_on` | string | No | Optional inclusive start time aligned to UTC midnight. |
| `window_size` | string ("hour" | "day" | "none" | "HOUR" | "DAY" | "NONE" | "Hour" | "Day" | "None") | Yes | Aggregate into hourly, daily, or one whole-period ('none') window. |
| `ending_before` | string | No | Optional exclusive end time aligned to UTC midnight. |
| `group_filters` | object | No | Group-key values to include. Keys must occur in group_key and all value arrays together may contain at most 200 entries. |
| `billable_metric_id` | string | Yes | ID of the billable metric to aggregate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product

**Slug:** `METRONOME_GET_PRODUCT`

Get a Metronome product by ID, including its current and initial configuration, historical updates, archive state, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the product to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Card

**Slug:** `METRONOME_GET_RATE_CARD`

Get one rate card's metadata, pricing unit, conversions, aliases, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the rate card to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Card Named Schedule

**Slug:** `METRONOME_GET_RATE_CARD_NAMED_SCHEDULE`

Get the segments of a named schedule configured on a Metronome rate card, optionally restricted to the segment covering a date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rate_card_id` | string | Yes | ID of the rate card whose named schedule will be retrieved. |
| `covering_date` | string | No | Return at most the segment covering this date; omit to return every segment. |
| `schedule_name` | string | Yes | Identifier of the named schedule to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rates

**Slug:** `METRONOME_GET_RATES`

Get one page of rate-card prices active at a specific timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum rates to return in this page. |
| `next_page` | string | No | Cursor returned by a previous call; omit for the first page. |
| `selectors` | array | No | Selectors; rates matching any selector are returned. |
| `effective_at` | string | Yes | Timestamp at which the requested rates must be effective. |
| `rate_card_id` | string | Yes | ID of the rate card to query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Schedule

**Slug:** `METRONOME_GET_RATE_SCHEDULE`

Get one page of scheduled rate-card prices over a requested time window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum rate segments to return in this page. |
| `next_page` | string | No | Cursor returned by a previous call; omit for the first page. |
| `selectors` | array | No | Selectors; rates matching any selector are returned. |
| `starting_at` | string | Yes | Inclusive beginning of the schedule window. |
| `rate_card_id` | string | Yes | ID of the rate card to query. |
| `ending_before` | string | No | Exclusive end of the schedule window. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Services

**Slug:** `METRONOME_GET_SERVICES`

Get Metronome's service registry and current IP addresses for firewall and network allowlist configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscription Quantity History

**Slug:** `METRONOME_GET_SUBSCRIPTION_QUANTITY_HISTORY`

Retrieve historical subscription quantities and prices for a contract subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | ID of the contract that contains the subscription. |
| `customer_id` | string | Yes | ID of the customer that owns the subscription. |
| `subscription_id` | string | Yes | ID of the subscription whose quantity history is requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscription Seats History

**Slug:** `METRONOME_GET_SUBSCRIPTION_SEATS_HISTORY`

Get one page of historical seat assignments and quantities for a contract subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum seat schedule entries to return, from 1 to 10. |
| `cursor` | string | No | Cursor returned by a previous call; omit for the first page. |
| `contract_id` | string | Yes | ID of the contract that contains the subscription. |
| `customer_id` | string | Yes | ID of the customer that owns the subscription. |
| `starting_at` | string | No | Include seat segments active at or after this timestamp. |
| `covering_date` | string | No | Return the seat segment active at this time; cannot be combined with a range. |
| `ending_before` | string | No | Include seat segments active at or before this timestamp. |
| `subscription_id` | string | Yes | ID of the subscription whose seat history is requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batched Usage Data

**Slug:** `METRONOME_GET_USAGE_BATCH`

Return one page of usage aggregated across customers and billable metrics for hourly, daily, or whole-period reporting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `starting_on` | string | Yes | Inclusive start time aligned to UTC midnight. |
| `window_size` | string ("hour" | "day" | "none" | "HOUR" | "DAY" | "NONE" | "Hour" | "Day" | "None") | Yes | Aggregate into hourly, daily, or one whole-period ('none') window. |
| `customer_ids` | array | No | Customer IDs to include; omit to return usage for all customers. |
| `ending_before` | string | Yes | Exclusive end time aligned to UTC midnight and after starting_on. |
| `billable_metrics` | array | No | Billable metrics and optional groupings to include; omit for all metrics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook Delivery

**Slug:** `METRONOME_GET_WEBHOOK_DELIVERY`

Retrieve one triggered Metronome webhook notification, its exact JSON payload, and every recorded delivery attempt.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | ID of the webhook destination in the current Metronome environment. |
| `triggered_notification_id` | string | Yes | ID of the triggered notification to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Ingest Usage Events

**Slug:** `METRONOME_INGEST_USAGE_EVENTS`

Ingest one to 100 usage events that immediately affect customer usage, spend, and billing. Use globally unique transaction IDs; Metronome ignores duplicates for 34 days and accepts events backdated by at most 34 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | Yes | One to 100 usage events to ingest as a single JSON array. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Billable Metrics

**Slug:** `METRONOME_LIST_BILLABLE_METRICS`

List billable metric definitions, optionally including archived metrics, for pricing and event-matching discovery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum billable metrics to return in this page (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `include_archived` | boolean | No | Include archived billable metrics in addition to active metrics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Billing Providers

**Slug:** `METRONOME_LIST_BILLING_PROVIDERS`

List account-level billing providers and their delivery-method configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoice Breakdowns

**Slug:** `METRONOME_LIST_BREAKDOWN_INVOICES`

List hourly or daily invoice breakdowns for a Metronome customer and time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date_asc" | "date_desc") | No | Invoice issue-date sort order. |
| `limit` | integer | No | Maximum number of breakdowns to return (1-100). |
| `status` | string | No | Invoice status filter. |
| `next_page` | string | No | Cursor returned by a previous call. |
| `customer_id` | string | Yes | ID of the customer whose invoice breakdowns to list. |
| `starting_on` | string | Yes | Inclusive RFC 3339 breakdown-window start. |
| `window_size` | string ("hour" | "day" | "HOUR" | "DAY" | "Hour" | "Day") | No | Breakdown granularity; defaults to day. |
| `ending_before` | string | Yes | RFC 3339 breakdown-window end bound. |
| `credit_type_id` | string | No | Return only invoices for this credit type ID. |
| `skip_zero_qty_line_items` | boolean | No | Whether to omit zero-quantity line items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contracts

**Slug:** `METRONOME_LIST_CONTRACTS`

List one page of a customer's current v2 contracts with optional balances, ledgers, and archive filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum contracts to return in this page, from 1 to 20. |
| `cursor` | string | No | Cursor returned by a previous call; omit for the first page. |
| `customer_id` | string | Yes | ID of the customer whose contracts are listed. |
| `starting_at` | string | No | Include contracts starting at or after this timestamp. |
| `covering_date` | string | No | Include contracts active at this timestamp. |
| `include_balance` | boolean | No | Include credit and commit balances. |
| `include_ledgers` | boolean | No | Include commit and credit ledgers in each contract. |
| `include_archived` | boolean | No | Include archived contracts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contract Named Schedules

**Slug:** `METRONOME_LIST_CONTRACTS_NAMED_SCHEDULES`

List one page of contract-level named schedules for a Metronome customer, with optional contract, name, property, and date filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of named schedules to return on this page. |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `properties` | object | No | Key-value subset that each returned schedule must contain. |
| `contract_id` | string | No | Contract ID used to restrict results to one contract. |
| `customer_id` | string | Yes | ID of the customer whose schedules will be listed. |
| `covering_date` | string | No | Return at most one segment covering this date for each schedule. |
| `schedule_name` | string | No | Schedule name used to restrict the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contracts On Package

**Slug:** `METRONOME_LIST_CONTRACTS_ON_PACKAGE`

List one page of customer contracts provisioned from a package over a selected time period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum contracts to return in this page. |
| `next_page` | string | No | Cursor returned by a previous call; omit for the first page. |
| `package_id` | string | Yes | ID of the package whose contracts are listed. |
| `starting_at` | string | No | Include contracts starting at or after this timestamp. |
| `covering_date` | string | No | Include contracts active at this timestamp. |
| `include_archived` | boolean | No | Include archived contracts in the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Alerts

**Slug:** `METRONOME_LIST_CUSTOMER_ALERTS`

List one page of threshold notifications and their current evaluation statuses for a customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `customer_id` | string | Yes | Metronome ID of the customer. |
| `alert_statuses` | array | No | Notification statuses to include; omit to return only enabled alerts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Balances

**Slug:** `METRONOME_LIST_CUSTOMER_BALANCES`

List one page of a customer's current commit and credit balances.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Return only this commit or credit ID. |
| `limit` | integer | No | Maximum balances to return; defaults to 25. |
| `next_page` | string | No | Cursor returned by a previous call. |
| `access_type` | string ("SPEND" | "spend" | "QUANTITY" | "quantity") | No | Filter by balance drawdown method. |
| `customer_id` | string | Yes | ID of the customer whose balances are listed. |
| `starting_at` | string | No | Return balances with access on or after this time. |
| `covering_date` | string | No | Return balances whose access schedule covers this time. |
| `include_balance` | boolean | No | Include calculated balance amounts. |
| `include_ledgers` | boolean | No | Include transaction ledgers. |
| `effective_before` | string | No | Return balances with access before this time. |
| `include_archived` | boolean | No | Include archived balances. |
| `exclude_zero_balances` | boolean | No | Exclude balances with zero amounts. |
| `webhook_notification_id` | string | No | Webhook notification that triggered this query. |
| `include_contract_balances` | boolean | No | Include contract-level balances. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Billable Metrics

**Slug:** `METRONOME_LIST_CUSTOMER_BILLABLE_METRICS`

List billable metrics available for a Metronome customer, optionally filtering to the current plan or including archived metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of billable metrics to return (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `customer_id` | string | Yes | UUID of the customer whose available billable metrics to list. |
| `on_current_plan` | boolean | No | When true, return only metrics on the customer's current plan. |
| `include_archived` | boolean | No | When true, include archived billable metrics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Commits

**Slug:** `METRONOME_LIST_CUSTOMER_COMMITS`

List one page of customer-level and optionally contract-level commits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum commits to return. |
| `commit_id` | string | No | Return only this commit. |
| `next_page` | string | No | Cursor returned by a previous call. |
| `access_type` | string ("SPEND" | "spend" | "QUANTITY" | "quantity") | No | Filter by drawdown method. |
| `customer_id` | string | Yes | ID of the customer whose commits are listed. |
| `starting_at` | string | No | Return commits with access on or after this time. |
| `covering_date` | string | No | Return commits whose access covers this time. |
| `include_balance` | boolean | No | Include calculated balances. |
| `include_ledgers` | boolean | No | Include commit ledgers. |
| `effective_before` | string | No | Return commits with access before this time. |
| `include_archived` | boolean | No | Include archived commits. |
| `include_contract_commits` | boolean | No | Include contract-level commits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Credits

**Slug:** `METRONOME_LIST_CUSTOMER_CREDITS`

List one page of customer-level and optionally contract-level credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum credits to return. |
| `credit_id` | string | No | Return only this credit. |
| `next_page` | string | No | Cursor returned by a previous call. |
| `customer_id` | string | Yes | ID of the customer whose credits are listed. |
| `starting_at` | string | No | Return credits with access on or after this time. |
| `covering_date` | string | No | Return credits whose access covers this time. |
| `include_balance` | boolean | No | Include calculated balances. |
| `include_ledgers` | boolean | No | Include credit ledgers. |
| `effective_before` | string | No | Return credits with access before this time. |
| `include_archived` | boolean | No | Include archived credits. |
| `include_contract_credits` | boolean | No | Include contract-level credits. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `METRONOME_LIST_CUSTOMERS`

List active or archived Metronome customers, optionally filtering by customer, ingest, Salesforce, or Stripe identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum customers to return in this page (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `customer_ids` | array | No | Return customers whose Metronome IDs are in this list (up to 100). |
| `ingest_alias` | string | No | Return customers matching this event-ingestion alias. |
| `only_archived` | boolean | No | Return only archived customers instead of the default active customers. |
| `stripe_customer_id` | string | No | Return active customers linked to this Stripe customer ID. |
| `salesforce_account_ids` | array | No | Return customers linked to any of these Salesforce account IDs (up to 100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Field Keys

**Slug:** `METRONOME_LIST_CUSTOM_FIELD_KEYS`

List active Metronome custom field keys, optionally filtered to selected entity types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entities` | array | No | Optional entity types whose active custom field keys should be returned. |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Historical Balances

**Slug:** `METRONOME_LIST_HISTORICAL_BALANCES`

List one page of commits and credits moved to historical storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Return only this historical balance. |
| `limit` | integer | No | Maximum historical balances to return. |
| `next_page` | string | No | Cursor returned by a previous call. |
| `contract_id` | string | No | Return balances from this contract. |
| `customer_id` | string | Yes | ID of the customer whose historical balances are listed. |
| `starting_at` | string | No | Return balances with access on or after this time. |
| `covering_date` | string | No | Return balances whose access covered this time. |
| `include_ledgers` | boolean | No | Include transaction ledgers. |
| `effective_before` | string | No | Return balances with access before this time. |
| `moved_to_history_after` | string | No | Return balances moved to history at or after this time. |
| `moved_to_history_before` | string | No | Return balances moved to history before this time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoices

**Slug:** `METRONOME_LIST_INVOICES`

List one page of invoices for a Metronome customer with optional status, type, contract, credit type, and billing-period filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date_asc" | "date_desc") | No | Sort order by invoice issue date. |
| `type` | string ("USAGE" | "USAGE_CONSOLIDATED" | "SCHEDULED") | No | Invoice type to return; omit to return all types. |
| `limit` | integer | No | Maximum number of invoices to return (1-100). |
| `status` | string | No | Invoice status, such as DRAFT, FINALIZED, or VOID. |
| `next_page` | string | No | Cursor returned by a previous call; omit for the first page. |
| `contract_id` | string | No | Return only invoices for this contract ID. |
| `customer_id` | string | Yes | ID of the customer whose invoices to list. |
| `starting_on` | string | No | Inclusive RFC 3339 lower bound for invoice billing-period starts. |
| `ending_before` | string | No | Exclusive RFC 3339 upper bound for invoice billing-period ends. |
| `credit_type_id` | string | No | Return only invoices using this credit type ID. |
| `webhook_notification_id` | string | No | Webhook notification ID that triggered this request. |
| `skip_zero_qty_line_items` | boolean | No | Whether to omit line items whose quantity is zero. |
| `include_historical_commit_invoices` | boolean | No | Whether to include historical commit invoices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Offset Notification Configs

**Slug:** `METRONOME_LIST_OFFSET_NOTIFICATION_CONFIGS`

List one page of user-created lifecycle-event notifications that publish webhooks before or after their base events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum notification configurations to return, up to 400. |
| `cursor` | string | No | Cursor returned by a previous call; omit for the first page. |
| `archive_filter` | string ("ARCHIVED" | "NOT_ARCHIVED" | "ALL") | No | Archive state to include; Metronome defaults to NOT_ARCHIVED. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Packages

**Slug:** `METRONOME_LIST_PACKAGES`

List contract packages with their terms, commits, overrides, scheduled charges, and archive state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum packages to return in this page (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `archive_filter` | string ("ARCHIVED" | "NOT_ARCHIVED" | "ALL" | "archived" | "not_archived" | "all") | No | Choose whether to return archived packages, active packages, or all packages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pricing Units

**Slug:** `METRONOME_LIST_PRICING_UNITS`

List fiat and custom pricing units available for rates, credits, and commits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum pricing units to return in this page (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `METRONOME_LIST_PRODUCTS`

List Metronome products and their current configuration, version history, metadata, and archive state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum products to return in this page (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `archive_filter` | string ("ARCHIVED" | "NOT_ARCHIVED" | "ALL") | No | Choose whether to return archived products, active products, or all products. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Rate Cards

**Slug:** `METRONOME_LIST_RATE_CARDS`

List rate cards with their IDs, names, descriptions, aliases, pricing units, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum rate cards to return in this page (1-100). |
| `next_page` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Seat Balances

**Slug:** `METRONOME_LIST_SEAT_BALANCES`

List one page of seat-level commit and credit balances for a contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum seats to return; defaults to 25. |
| `cursor` | string | No | Cursor returned by a previous call. |
| `seat_ids` | array | No | Only these seat identifiers. |
| `contract_id` | string | Yes | ID of the contract whose seat balances are listed. |
| `customer_id` | string | Yes | ID of the customer whose seat balances are listed. |
| `starting_at` | string | No | Include balances effective on or after this time. |
| `covering_date` | string | No | Include balances covering this time. |
| `include_ledgers` | boolean | No | Include ledgers; requires include_credits_and_commits. |
| `effective_before` | string | No | Include balances effective on or before this time. |
| `subscription_ids` | array | No | Only seats from these seat-based subscriptions. |
| `skip_missing_seat_ids` | boolean | No | Omit unknown seat IDs instead of returning an error. |
| `include_credits_and_commits` | boolean | No | Include per-seat credit and commit records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Spend Invoice Breakdowns

**Slug:** `METRONOME_LIST_SPEND_BREAKDOWN_INVOICES`

List one page of customer invoice spend breakdowns by time window and optional presentation groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("date_asc" | "date_desc") | No | Invoice issue-date sort order. |
| `limit` | integer | No | Maximum number of breakdowns to return (1-100). |
| `next_page` | string | No | Cursor returned by a previous call. |
| `group_keys` | array | No | Presentation keys by which to break down spend. |
| `customer_id` | string | Yes | ID of the customer whose spend to break down. |
| `starting_on` | string | Yes | Inclusive RFC 3339 breakdown-window start. |
| `window_size` | string ("day" | "none" | "DAY" | "NONE" | "Day" | "None") | No | Breakdown granularity; day or one window per billing period. |
| `ending_before` | string | Yes | Exclusive RFC 3339 breakdown-window end. |
| `group_filters` | object | No | Allowed values for each requested group key. |
| `credit_type_id` | string | No | Return only invoices for this credit type ID. |
| `include_list_prices` | boolean | No | Whether to include list prices for usage and subscription items. |
| `skip_zero_qty_line_items` | boolean | No | Whether to omit zero-quantity line items. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List System Notification Configs

**Slug:** `METRONOME_LIST_SYSTEM_NOTIFICATION_CONFIGS`

List one page of Metronome system lifecycle notification types and whether their webhook publishing is enabled.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhook Deliveries

**Slug:** `METRONOME_LIST_WEBHOOK_DELIVERIES`

List one page of triggered notifications and delivery summaries for a Metronome webhook destination from the last 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum triggered notifications to return in this page (1-100). |
| `filters` | object | No | Optional customer, notification type, and notification ID filters. |
| `end_date` | string | No | Exclusive latest first-attempt timestamp; defaults to the current time. |
| `next_page` | string | No | Cursor returned by a previous call with the same path and filters. |
| `start_date` | string | Yes | Inclusive earliest first-attempt timestamp; must be within the last 30 days. |
| `webhook_id` | string | Yes | ID of the webhook destination in the current Metronome environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Rate Card Products

**Slug:** `METRONOME_MOVE_RATE_CARD_PRODUCTS`

Move selected products to new invoice-order positions on a rate card.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rate_card_id` | string | Yes | ID of the rate card to reorder. |
| `product_moves` | array | Yes | Products and their new positions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Customer Events

**Slug:** `METRONOME_PREVIEW_CUSTOMER_EVENTS`

Calculate customer invoice previews from supplied usage events without ingesting the events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("replace" | "merge") | No | Replace historical usage or merge these events with existing usage; defaults to replace. |
| `events` | array | Yes | Usage events to include in the preview. |
| `customer_id` | string | Yes | ID of the customer whose invoices to preview. |
| `skip_zero_qty_line_items` | boolean | No | Whether to omit zero-quantity line items from preview invoices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Regenerate Invoice

**Slug:** `METRONOME_REGENERATE_INVOICE`

Regenerate a previously voided Metronome invoice using current rates, balances, and fees, distribute the replacement through the configured billing provider, and return its new invoice ID. This is a billing-impacting operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the previously voided invoice to regenerate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Release External Payment Gate Threshold Commit

**Slug:** `METRONOME_RELEASE_EXTERNAL_PAYMENT_GATE_THRESHOLD_COMMIT`

Complete or cancel a threshold commit after an external payment attempt.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outcome` | string ("paid" | "PAID" | "failed" | "FAILED") | Yes | Outcome of the external payment attempt. |
| `workflow_id` | string | Yes | Workflow ID from the payment_gate.external_initiate webhook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Customer Alerts

**Slug:** `METRONOME_RESET_CUSTOMER_ALERTS`

Clear a threshold notification's cached state for a customer and trigger an asynchronous re-evaluation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Metronome ID of the threshold notification to reset. |
| `customer_id` | string | Yes | Metronome ID of the customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Schedule Pro Services Invoice

**Slug:** `METRONOME_SCHEDULE_PRO_SERVICES_INVOICE`

Schedule an invoice for professional service terms on a contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `issued_at` | string | Yes | Timestamp when the invoice is issued. |
| `line_items` | array | Yes | Professional service terms and amounts to invoice. |
| `contract_id` | string | Yes | ID of the contract containing the professional services. |
| `customer_id` | string | Yes | ID of the customer receiving the invoice. |
| `netsuite_invoice_header_end` | string | No | NetSuite invoice-header end timestamp. |
| `netsuite_invoice_header_start` | string | No | NetSuite invoice-header start timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Events

**Slug:** `METRONOME_SEARCH_EVENTS`

Retrieve recent usage events by transaction ID to sample ingestion, customer matching, metric matching, and duplicate handling. Metronome heavily rate limits this endpoint; use targeted samples rather than broad or repeated polling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transaction_ids` | array | Yes | Transaction IDs for events ingested within the last 34 days. This endpoint is heavily rate limited, so use only targeted samples and avoid broad or repeated polling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Customer Billable Status

**Slug:** `METRONOME_SET_CUSTOMER_BILLABLE_STATUS`

Set whether a Metronome customer is billable from a specified effective time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | UUID of the customer whose status to set. |
| `effective_at` | string | Yes | RFC 3339 timestamp at which the billable state becomes effective. |
| `billable_status` | string ("billable" | "unbillable") | Yes | New billable state for the customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Customer Billing Provider Configurations

**Slug:** `METRONOME_SET_CUSTOMER_BILLING_PROVIDER_CONFIGURATIONS`

Create one or more billing provider configurations for Metronome customers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Billing provider configurations to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Customer Name

**Slug:** `METRONOME_SET_CUSTOMER_NAME`

Update the display name of a Metronome customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New customer name; Metronome truncates it to 160 characters. |
| `customer_id` | string | Yes | UUID of the customer to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Customer Revenue System Configurations

**Slug:** `METRONOME_SET_CUSTOMER_REVENUE_SYSTEM_CONFIGURATIONS`

Create one or more revenue system configurations for Metronome customers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Revenue system configurations to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Custom Fields

**Slug:** `METRONOME_SET_CUSTOM_FIELDS`

Transactionally set or overwrite custom field values on one Metronome entity instance while preserving unspecified fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity` | string ("alert" | "billable_metric" | "charge" | "commit" | "contract_credit" | "contract_product" | "contract" | "customer" | "discount" | "invoice" | "professional_service" | "product" | "rate_card" | "scheduled_charge" | "subscription" | "package_commit" | "package_credit" | "package_subscription" | "package_scheduled_charge") | Yes | Metronome entity type whose custom field values will be set. |
| `entity_id` | string | Yes | Metronome UUID of the specific entity whose fields will be set. |
| `custom_fields` | object | Yes | Custom field key-value pairs to set transactionally. Values may contain at most 200 characters. Existing matching keys are overwritten. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Customer Ingest Aliases

**Slug:** `METRONOME_SET_INGEST_ALIASES`

Replace the complete set of usage ingest aliases for a Metronome customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | UUID of the customer to update. |
| `ingest_aliases` | array | Yes | Complete replacement set of aliases accepted in usage events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Rate Card Products Order

**Slug:** `METRONOME_SET_RATE_CARD_PRODUCTS_ORDER`

Replace the complete invoice display order of products on a rate card.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rate_card_id` | string | Yes | ID of the rate card to reorder. |
| `product_order` | array | Yes | Product IDs in the complete desired invoice order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Up Billing Provider

**Slug:** `METRONOME_SET_UP_BILLING_PROVIDER`

Set up account-level Metronome configuration for a marketplace billing provider.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `configuration` | object | Yes | Provider- and delivery-method-specific account configuration. |
| `delivery_method` | string ("direct_to_billing_provider" | "aws_sqs" | "aws_sns") | Yes | Method used to deliver invoices for this configuration. |
| `billing_provider` | string ("aws_marketplace" | "azure_marketplace" | "gcp_marketplace") | Yes | Marketplace billing provider to configure. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Usage Filter

**Slug:** `METRONOME_SET_USAGE_FILTER`

Route a customer's grouped usage to a contract starting at a specified time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_key` | string | Yes | Billable-metric group key used to route usage. |
| `contract_id` | string | Yes | ID of the contract receiving the usage filter. |
| `customer_id` | string | Yes | ID of the customer that owns the contract. |
| `starting_at` | string | Yes | Timestamp when the usage filter becomes active. |
| `group_values` | array | Yes | Group values routed to this contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Billable Metric

**Slug:** `METRONOME_UPDATE_BILLABLE_METRIC`

Rename an existing Metronome billable metric. Metronome does not allow this endpoint to change the metric's filtering or aggregation configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New display name for the billable metric. |
| `billable_metric_id` | string | Yes | UUID of the billable metric to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Commit End Date

**Slug:** `METRONOME_UPDATE_COMMIT_END_DATE`

Update the access or invoice end date of a prepaid customer commit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `commit_id` | string | Yes | ID of the prepaid commit. |
| `customer_id` | string | Yes | ID of the customer whose commit is updated. |
| `access_ending_before` | string | No | New exclusive end of commit access. |
| `invoices_ending_before` | string | No | New exclusive end of commit invoicing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contract End Date

**Slug:** `METRONOME_UPDATE_CONTRACT_END_DATE`

Set, move, or remove a contract's exclusive end timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | ID of the contract to update. |
| `customer_id` | string | Yes | ID of the customer whose contract will be updated. |
| `ending_before` | string | No | Exclusive contract end timestamp; omit to make the contract open-ended. |
| `allow_ending_before_finalized_invoice` | boolean | No | Allow the contract to end before an existing finalized invoice period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contract Named Schedule

**Slug:** `METRONOME_UPDATE_CONTRACT_NAMED_SCHEDULE`

Set a dated segment on a named schedule for a customer's Metronome contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | Value to set; its structure is specific to the named schedule. |
| `properties` | object | No | Key-value qualifiers selecting the schedule to update. |
| `contract_id` | string | Yes | ID of the contract whose schedule will be updated. |
| `customer_id` | string | Yes | ID of the customer that owns the contract. |
| `starting_at` | string | Yes | Inclusive start time of the schedule segment. |
| `ending_before` | string | No | Exclusive end time of the segment; omit when it has no fixed end. |
| `schedule_name` | string | Yes | Identifier of the named schedule to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Credit End Date

**Slug:** `METRONOME_UPDATE_CREDIT_END_DATE`

Update the access end date of a customer credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credit_id` | string | Yes | ID of the credit to update. |
| `customer_id` | string | Yes | ID of the customer whose credit is updated. |
| `access_ending_before` | string | Yes | New exclusive end of credit access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Configuration

**Slug:** `METRONOME_UPDATE_CUSTOMER_CONFIG`

Update the Salesforce account configuration for a Metronome customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | UUID of the customer to update. |
| `salesforce_account_id` | string | No | Salesforce account ID to link, or null to remove the existing link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Named Schedule

**Slug:** `METRONOME_UPDATE_CUSTOMER_NAMED_SCHEDULE`

Set a dated segment on a named schedule configured for a Metronome customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | Value to set; its structure is specific to the named schedule. |
| `customer_id` | string | Yes | ID of the customer whose schedule will be updated. |
| `starting_at` | string | Yes | Inclusive start time of the schedule segment. |
| `ending_before` | string | No | Exclusive end time of the segment; omit when it has no fixed end. |
| `schedule_name` | string | Yes | Identifier of the named schedule to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Invoice Issue Date

**Slug:** `METRONOME_UPDATE_INVOICE_ISSUE_DATE`

Reschedule the issue date of one draft contract invoice without changing future billing cycles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | Yes | ID of the draft invoice to update. |
| `issue_date` | string | Yes | New invoice issue timestamp; it cannot be after the contract end date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Product

**Slug:** `METRONOME_UPDATE_PRODUCT`

Schedule a configuration update for a Metronome product without changing its type. The effective timestamp must be on an hour boundary.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Updated invoice display name; omit to retain the current name. |
| `tags` | array | No | Updated product tags. |
| `product_id` | string | Yes | ID of the product to update. |
| `starting_at` | string | Yes | Hour-boundary timestamp when the update takes effect. |
| `is_refundable` | boolean | No | Updated refundability setting. |
| `composite_tags` | array | No | Updated tags selecting composite component products. |
| `pricing_group_key` | array | No | Updated group keys that determine separate prices. |
| `quantity_rounding` | object | No | Updated usage quantity rounding configuration. |
| `billable_metric_id` | string | No | Updated billable metric ID for a usage product. |
| `exclude_free_usage` | boolean | No | Whether zero-cost products are excluded from composite usage. |
| `quantity_conversion` | object | No | Updated usage quantity conversion configuration. |
| `composite_product_ids` | array | No | Updated component product IDs for a composite product. |
| `presentation_group_key` | array | No | Updated group keys used to group invoice line items. |
| `include_composite_spend` | boolean | No | Whether spend from other composite products contributes to this product. |
| `netsuite_overage_item_id` | string | No | Updated NetSuite overage item ID, when enabled. |
| `netsuite_internal_item_id` | string | No | Updated NetSuite item ID, when enabled. |
| `sql_breakdown_granularity` | string ("HOUR" | "hour" | "SERVICE_PERIOD" | "service_period") | No | Whether SQL billable metric usage is evaluated hourly or per service period. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Rate Card

**Slug:** `METRONOME_UPDATE_RATE_CARD`

Update a rate card's metadata, alias schedule, or pricing-unit conversions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New internal rate card name. |
| `aliases` | array | No | Replacement alias schedule. |
| `description` | string | No | New rate card description. |
| `rate_card_id` | string | Yes | ID of the rate card to update. |
| `add_credit_type_conversions` | array | No | New pricing-unit conversions to add. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Rate Card Named Schedule

**Slug:** `METRONOME_UPDATE_RATE_CARD_NAMED_SCHEDULE`

Set a dated segment on a named schedule configured for a Metronome rate card.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | Value to set; its structure is specific to the named schedule. |
| `starting_at` | string | Yes | Inclusive start time of the schedule segment. |
| `rate_card_id` | string | Yes | ID of the rate card whose named schedule will be updated. |
| `ending_before` | string | No | Exclusive end time of the segment; omit when it has no fixed end. |
| `schedule_name` | string | Yes | Identifier of the named schedule to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Anrok API Token

**Slug:** `METRONOME_UPSERT_ANROK_API_TOKEN`

Set the Anrok API token used by specified Metronome billing delivery methods.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `anrok_api_token` | string | Yes | Opaque Anrok API token to store for the specified delivery methods. |
| `delivery_method_ids` | array | Yes | Billing provider delivery method IDs to associate with the Anrok token. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Avalara Credentials

**Slug:** `METRONOME_UPSERT_AVALARA_CREDENTIALS`

Set Avalara credentials for specified Metronome billing delivery methods.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `avalara_password` | string | Yes | Password for the Avalara account. |
| `avalara_username` | string | Yes | Username for the Avalara account. |
| `avalara_environment` | string ("PRODUCTION" | "SANDBOX") | Yes | Avalara environment in which the credentials are valid. |
| `commit_transactions` | boolean | No | Whether Avalara should commit transactions for reporting and tax filing. |
| `delivery_method_ids` | array | Yes | Billing provider delivery method IDs to associate with the credentials. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Void Invoice

**Slug:** `METRONOME_VOID_INVOICE`

Permanently void a Metronome invoice. This destructive billing operation cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the invoice to void. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
