@metronome/mcp 1.0.0 → 2.1.0

package/src/tools/v1/custom-fields/list-keys-v1-custom-fields.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_keys_v1_custom_fields',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nRetrieve all your active custom field keys, with optional filtering by entity type (customer, contract, product, etc.). Use this endpoint to discover what custom field keys are available before setting values on entities or to audit your custom field configuration across different entity types.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        type: 'object',\n        properties: {\n          enforce_uniqueness: {\n            type: 'boolean'\n          },\n          entity: {\n            type: 'string',\n            enum: [              'alert',\n              'billable_metric',\n              'charge',\n              'commit',\n              'contract_credit',\n              'contract_product',\n              'contract',\n              'credit_grant',\n              'customer_plan',\n              'customer',\n              'discount',\n              'invoice',\n              'plan',\n              'professional_service',\n              'product',\n              'rate_card',\n              'scheduled_charge',\n              'subscription'\n            ]\n          },\n          key: {\n            type: 'string'\n          }\n        },\n        required: [          'enforce_uniqueness',\n          'entity',\n          'key'\n        ]\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ]\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nRetrieve all your active custom field keys, with optional filtering by entity type (customer, contract, product, etc.). Use this endpoint to discover what custom field keys are available before setting values on entities or to audit your custom field configuration across different entity types.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/custom_field_list_keys_response'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    custom_field_list_keys_response: {\n      type: 'object',\n      properties: {\n        enforce_uniqueness: {\n          type: 'boolean'\n        },\n        entity: {\n          type: 'string',\n          enum: [            'alert',\n            'billable_metric',\n            'charge',\n            'commit',\n            'contract_credit',\n            'contract_product',\n            'contract',\n            'credit_grant',\n            'customer_plan',\n            'customer',\n            'discount',\n            'invoice',\n            'plan',\n            'professional_service',\n            'product',\n            'rate_card',\n            'scheduled_charge',\n            'subscription'\n          ]\n        },\n        key: {\n          type: 'string'\n        }\n      },\n      required: [        'enforce_uniqueness',\n        'entity',\n        'key'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/alerts/list-customers-v1-alerts.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_customers_v1_alerts',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nRetrieve all alert configurations and their current statuses for a specific customer in a single API call. This endpoint provides a comprehensive view of all alerts monitoring a customer account.\n\n### Use this endpoint to:\n- Display all active alerts for a customer in dashboards or admin panels\n- Quickly identify which alerts a customer is currently triggering\n- Audit alert coverage for specific accounts\n- Filter alerts by status (enabled, disabled, or archived)\n\n### Key response fields:\n- data: Array of CustomerAlert objects, each containing:\n  - Current evaluation status (`ok`, `in_alarm`, `evaluating`, or `null`)\n  - Complete alert configuration and threshold details\n  - Alert metadata including type, name, and last update time\n- `next_page`: Pagination cursor for retrieving additional results\n\n### Usage guidelines:\n- Default behavior: Returns only enabled alerts unless alert_statuses filter is specified\n- Pagination: Use the `next_page` cursor to retrieve all results for customers with many alerts\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/customer_alert'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    customer_alert: {\n      type: 'object',\n      properties: {\n        alert: {\n          type: 'object',\n          properties: {\n            id: {\n              type: 'string',\n              description: 'the Metronome ID of the alert'\n            },\n            name: {\n              type: 'string',\n              description: 'Name of the alert'\n            },\n            status: {\n              type: 'string',\n              description: 'Status of the alert',\n              enum: [                'enabled',\n                'archived',\n                'disabled'\n              ]\n            },\n            threshold: {\n              type: 'number',\n              description: 'Threshold value of the alert policy'\n            },\n            type: {\n              type: 'string',\n              description: 'Type of the alert',\n              enum: [                'low_credit_balance_reached',\n                'spend_threshold_reached',\n                'monthly_invoice_total_spend_threshold_reached',\n                'low_remaining_days_in_plan_reached',\n                'low_remaining_credit_percentage_reached',\n                'usage_threshold_reached',\n                'low_remaining_days_for_commit_segment_reached',\n                'low_remaining_commit_balance_reached',\n                'low_remaining_commit_percentage_reached',\n                'low_remaining_days_for_contract_credit_segment_reached',\n                'low_remaining_contract_credit_balance_reached',\n                'low_remaining_contract_credit_percentage_reached',\n                'low_remaining_contract_credit_and_commit_balance_reached',\n                'invoice_total_reached'\n              ]\n            },\n            updated_at: {\n              type: 'string',\n              description: 'Timestamp for when the alert was last updated',\n              format: 'date-time'\n            },\n            credit_grant_type_filters: {\n              type: 'array',\n              description: 'An array of strings, representing a way to filter the credit grant this alert applies to, by looking at the credit_grant_type field on the credit grant. This field is only defined for CreditPercentage and CreditBalance alerts',\n              items: {\n                type: 'string'\n              }\n            },\n            credit_type: {\n              $ref: '#/$defs/credit_type_data'\n            },\n            custom_field_filters: {\n              type: 'array',\n              description: 'A list of custom field filters for alert types that support advanced filtering',\n              items: {\n                type: 'object',\n                properties: {\n                  entity: {\n                    type: 'string',\n                    enum: [                      'Contract',\n                      'Commit',\n                      'ContractCredit'\n                    ]\n                  },\n                  key: {\n                    type: 'string'\n                  },\n                  value: {\n                    type: 'string'\n                  }\n                },\n                required: [                  'entity',\n                  'key',\n                  'value'\n                ]\n              }\n            },\n            group_key_filter: {\n              type: 'object',\n              description: 'Scopes alert evaluation to a specific presentation group key on individual line items. Only present for spend alerts.',\n              properties: {\n                key: {\n                  type: 'string'\n                },\n                value: {\n                  type: 'string'\n                }\n              },\n              required: [                'key',\n                'value'\n              ]\n            },\n            group_values: {\n              type: 'array',\n              description: 'Only present for `spend_threshold_reached` alerts. Scope alert to a specific group key on individual line items.',\n              items: {\n                type: 'object',\n                properties: {\n                  key: {\n                    type: 'string'\n                  },\n                  value: {\n                    type: 'string'\n                  }\n                },\n                required: [                  'key'\n                ]\n              }\n            },\n            invoice_types_filter: {\n              type: 'array',\n              description: 'Only supported for invoice_total_reached alerts. A list of invoice types to evaluate.',\n              items: {\n                type: 'string'\n              }\n            },\n            uniqueness_key: {\n              type: 'string',\n              description: 'Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.'\n            }\n          },\n          required: [            'id',\n            'name',\n            'status',\n            'threshold',\n            'type',\n            'updated_at'\n          ]\n        },\n        customer_status: {\n          type: 'string',\n          description: 'The status of the customer alert. If the alert is archived, null will be returned.',\n          enum: [            'ok',\n            'in_alarm',\n            'evaluating'\n          ]\n        },\n        triggered_by: {\n          type: 'string',\n          description: 'If present, indicates the reason the alert was triggered.'\n        }\n      },\n      required: [        'alert',\n        'customer_status'\n      ]\n    },\n    credit_type_data: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        },\n        name: {\n          type: 'string'\n        }\n      },\n      required: [        'id',\n        'name'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nRetrieve all threshold notification configurations and their current statuses for a specific customer in a single API call. This endpoint provides a comprehensive view of all threshold notification monitoring a customer account.\n\n### Use this endpoint to:\n- Display all active threshold notifications for a customer in dashboards or admin panels\n- Quickly identify which threshold notifications a customer is currently triggering\n- Audit threshold notification coverage for specific accounts\n- Filter threshold notifications by status (enabled, disabled, or archived)\n\n### Key response fields:\n- data: Array of CustomerAlert objects, each containing:\n  - Current evaluation status (`ok`, `in_alarm`, `evaluating`, or `null`)\n  - Complete threshold notification configuration and threshold details\n  - Threshold notification metadata including type, name, and last update time\n- next_page: Pagination cursor for retrieving additional results\n\n### Usage guidelines:\n- Default behavior: Returns only enabled threshold notifications unless `alert_statuses` filter is specified\n- Pagination: Use the `next_page` cursor to retrieve all results for customers with many notifications\n- Performance: Efficiently retrieves multiple threshold notification statuses in a single request instead of making individual calls\n- Filtering: Pass the `alert_statuses` array to include disabled or archived threshold notifications in results\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/customer_alert'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    customer_alert: {\n      type: 'object',\n      properties: {\n        alert: {\n          type: 'object',\n          properties: {\n            id: {\n              type: 'string',\n              description: 'the Metronome ID of the threshold notification'\n            },\n            name: {\n              type: 'string',\n              description: 'Name of the threshold notification'\n            },\n            status: {\n              type: 'string',\n              description: 'Status of the threshold notification',\n              enum: [                'enabled',\n                'archived',\n                'disabled'\n              ]\n            },\n            threshold: {\n              type: 'number',\n              description: 'Threshold value of the notification policy'\n            },\n            type: {\n              type: 'string',\n              description: 'Type of the threshold notification',\n              enum: [                'low_credit_balance_reached',\n                'spend_threshold_reached',\n                'monthly_invoice_total_spend_threshold_reached',\n                'low_remaining_days_in_plan_reached',\n                'low_remaining_credit_percentage_reached',\n                'usage_threshold_reached',\n                'low_remaining_days_for_commit_segment_reached',\n                'low_remaining_commit_balance_reached',\n                'low_remaining_commit_percentage_reached',\n                'low_remaining_days_for_contract_credit_segment_reached',\n                'low_remaining_contract_credit_balance_reached',\n                'low_remaining_contract_credit_percentage_reached',\n                'low_remaining_contract_credit_and_commit_balance_reached',\n                'low_remaining_seat_balance_reached',\n                'invoice_total_reached'\n              ]\n            },\n            updated_at: {\n              type: 'string',\n              description: 'Timestamp for when the threshold notification was last updated',\n              format: 'date-time'\n            },\n            credit_grant_type_filters: {\n              type: 'array',\n              description: 'An array of strings, representing a way to filter the credit grant this threshold notification applies to, by looking at the credit_grant_type field on the credit grant. This field is only defined for CreditPercentage and CreditBalance notifications',\n              items: {\n                type: 'string'\n              }\n            },\n            credit_type: {\n              $ref: '#/$defs/credit_type_data'\n            },\n            custom_field_filters: {\n              type: 'array',\n              description: 'A list of custom field filters for notification types that support advanced filtering',\n              items: {\n                type: 'object',\n                properties: {\n                  entity: {\n                    type: 'string',\n                    enum: [                      'Contract',\n                      'Commit',\n                      'ContractCredit'\n                    ]\n                  },\n                  key: {\n                    type: 'string'\n                  },\n                  value: {\n                    type: 'string'\n                  }\n                },\n                required: [                  'entity',\n                  'key',\n                  'value'\n                ]\n              }\n            },\n            group_key_filter: {\n              type: 'object',\n              description: 'Scopes threshold notification evaluation to a specific presentation group key on individual line items. Only present for spend notifications.',\n              properties: {\n                key: {\n                  type: 'string'\n                },\n                value: {\n                  type: 'string'\n                }\n              },\n              required: [                'key',\n                'value'\n              ]\n            },\n            group_values: {\n              type: 'array',\n              description: 'Only present for `spend_threshold_reached` notifications. Scope notification to a specific group key on individual line items.',\n              items: {\n                type: 'object',\n                properties: {\n                  key: {\n                    type: 'string'\n                  },\n                  value: {\n                    type: 'string'\n                  }\n                },\n                required: [                  'key'\n                ]\n              }\n            },\n            invoice_types_filter: {\n              type: 'array',\n              description: 'Only supported for invoice_total_reached threshold notifications. A list of invoice types to evaluate.',\n              items: {\n                type: 'string'\n              }\n            },\n            uniqueness_key: {\n              type: 'string',\n              description: 'Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.'\n            }\n          },\n          required: [            'id',\n            'name',\n            'status',\n            'threshold',\n            'type',\n            'updated_at'\n          ]\n        },\n        customer_status: {\n          type: 'string',\n          description: 'The status of the threshold notification. If the notification is archived, null will be returned.',\n          enum: [            'ok',\n            'in_alarm',\n            'evaluating'\n          ]\n        },\n        triggered_by: {\n          type: 'string',\n          description: 'If present, indicates the reason the threshold notification was triggered.'\n        }\n      },\n      required: [        'alert',\n        'customer_status'\n      ]\n    },\n    credit_type_data: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        },\n        name: {\n          type: 'string'\n        }\n      },\n      required: [        'id',\n        'name'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {
@@ -32,7 +32,8 @@ export const tool: Tool = {
       },
       alert_statuses: {
         type: 'array',
-        description: 'Optionally filter by alert status. If absent, only enabled alerts will be returned.',
+        description:
+          'Optionally filter by threshold notification status. If absent, only enabled notifications will be returned.',
         items: {
           type: 'string',
           enum: ['ENABLED', 'DISABLED', 'ARCHIVED'],

package/src/tools/v1/customers/alerts/reset-customers-v1-alerts.ts

@@ -17,13 +17,13 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'reset_customers_v1_alerts',
   description:
-    'Force an immediate re-evaluation of a specific alert for a customer, clearing any previous state and triggering a fresh assessment against current thresholds. This endpoint ensures alert accuracy after configuration changes or data corrections.\n\n### Use this endpoint to:\n- Clear false positive alerts after fixing data issues\n- Re-evaluate alerts after adjusting customer balances or credits\n- Test alert behavior during development and debugging\n- Resolve stuck alerts that may be in an incorrect state\n- Trigger immediate evaluation after threshold modifications\n\n### Key response fields: \n- 200 Success: Confirmation that the alert has been reset and re-evaluation initiated\n- No response body is returned - the operation completes asynchronously\n\n### Usage guidelines:\n- Immediate effect: Triggers re-evaluation instantly, which may result in new webhook notifications if thresholds are breached\n- State clearing: Removes any cached evaluation state, ensuring a fresh assessment\n- Use sparingly: Intended for exceptional cases, not routine operations\n- Asynchronous processing: The reset completes immediately, but re-evaluation happens in the background\n',
+    'Force an immediate re-evaluation of a specific threshold notification for a customer, clearing any previous state and triggering a fresh assessment against current thresholds. This endpoint ensures threshold notification accuracy after configuration changes or data corrections.\n\n### Use this endpoint to:\n- Clear false positive threshold notifications after fixing data issues\n- Re-evaluate threshold notifications after adjusting customer balances or credits\n- Test threshold notification behavior during development and debugging\n- Resolve stuck threshold notification that may be in an incorrect state\n- Trigger immediate evaluation after threshold modifications\n\n### Key response fields: \n- 200 Success: Confirmation that the threshold notification has been reset and re-evaluation initiated\n- No response body is returned - the operation completes asynchronously\n\n### Usage guidelines:\n- Immediate effect: Triggers re-evaluation instantly, which may result in new webhook notifications if thresholds are breached\n- State clearing: Removes any cached evaluation state, ensuring a fresh assessment\n- Use sparingly: Intended for exceptional cases, not routine operations\n- Asynchronous processing: The reset completes immediately, but re-evaluation happens in the background\n',
   inputSchema: {
     type: 'object',
     properties: {
       alert_id: {
         type: 'string',
-        description: 'The Metronome ID of the alert',
+        description: 'The Metronome ID of the threshold notification',
       },
       customer_id: {
         type: 'string',

package/src/tools/v1/customers/alerts/retrieve-customers-v1-alerts.ts

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { maybeFilter } from '@metronome/mcp/filtering';
 import { Metadata, asTextContentResult } from '@metronome/mcp/tools/types';
 
 import { Tool } from '@modelcontextprotocol/sdk/types.js';
@@ -18,13 +17,13 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'retrieve_customers_v1_alerts',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nRetrieve the real-time evaluation status for a specific alert-customer pair. This endpoint provides instant visibility into whether a customer has triggered an alert condition, enabling you to monitor account health and take proactive action based on current alert states.\n\n### Use this endpoint to:\n- Check if a specific customer is currently violating an alert threshold (`in_alarm` status)\n- Verify alert configuration details and threshold values for a customer\n- Integrate alert status checks into customer support tools or admin interfaces\n\n### Key response fields: \nA CustomerAlert object containing:\n\n- `customer_status`: The current evaluation state\n\n- `ok` - Customer is within acceptable thresholds\n- `in_alarm`- Customer has breached the alert threshold\n- `evaluating` - Alert has yet to be evaluated (typically due to a customer or alert having just been created)\n- `null` - Alert has been archived\n- `triggered_by`: Additional context about what caused the alert to trigger (when applicable)\n- alert: Complete alert configuration including:\n  - Alert ID, name, and type\n  - Current threshold values and credit type information\n  - Alert status (enabled, disabled, or archived)\n  - Last update timestamp\n  - Any applied filters (credit grant types, custom fields, group values)\n\n### Usage guidelines:\n- Customer status: Returns the current evaluation state, not historical data. For alert history, use webhook notifications or event logs\n- Archived alerts: Returns null for customer_status if the alert has been archived, but still includes the alert configuration details\n- Integration patterns: This endpoint can be used to check a customer's alert status, but shouldn't be scraped. You should instead rely on the webhook notification to understand when customers are moved to IN_ALARM.\n- Error handling: Returns 404 if either the customer or alert ID doesn't exist or isn't accessible to your organization\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      $ref: '#/$defs/customer_alert'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    customer_alert: {\n      type: 'object',\n      properties: {\n        alert: {\n          type: 'object',\n          properties: {\n            id: {\n              type: 'string',\n              description: 'the Metronome ID of the alert'\n            },\n            name: {\n              type: 'string',\n              description: 'Name of the alert'\n            },\n            status: {\n              type: 'string',\n              description: 'Status of the alert',\n              enum: [                'enabled',\n                'archived',\n                'disabled'\n              ]\n            },\n            threshold: {\n              type: 'number',\n              description: 'Threshold value of the alert policy'\n            },\n            type: {\n              type: 'string',\n              description: 'Type of the alert',\n              enum: [                'low_credit_balance_reached',\n                'spend_threshold_reached',\n                'monthly_invoice_total_spend_threshold_reached',\n                'low_remaining_days_in_plan_reached',\n                'low_remaining_credit_percentage_reached',\n                'usage_threshold_reached',\n                'low_remaining_days_for_commit_segment_reached',\n                'low_remaining_commit_balance_reached',\n                'low_remaining_commit_percentage_reached',\n                'low_remaining_days_for_contract_credit_segment_reached',\n                'low_remaining_contract_credit_balance_reached',\n                'low_remaining_contract_credit_percentage_reached',\n                'low_remaining_contract_credit_and_commit_balance_reached',\n                'invoice_total_reached'\n              ]\n            },\n            updated_at: {\n              type: 'string',\n              description: 'Timestamp for when the alert was last updated',\n              format: 'date-time'\n            },\n            credit_grant_type_filters: {\n              type: 'array',\n              description: 'An array of strings, representing a way to filter the credit grant this alert applies to, by looking at the credit_grant_type field on the credit grant. This field is only defined for CreditPercentage and CreditBalance alerts',\n              items: {\n                type: 'string'\n              }\n            },\n            credit_type: {\n              $ref: '#/$defs/credit_type_data'\n            },\n            custom_field_filters: {\n              type: 'array',\n              description: 'A list of custom field filters for alert types that support advanced filtering',\n              items: {\n                type: 'object',\n                properties: {\n                  entity: {\n                    type: 'string',\n                    enum: [                      'Contract',\n                      'Commit',\n                      'ContractCredit'\n                    ]\n                  },\n                  key: {\n                    type: 'string'\n                  },\n                  value: {\n                    type: 'string'\n                  }\n                },\n                required: [                  'entity',\n                  'key',\n                  'value'\n                ]\n              }\n            },\n            group_key_filter: {\n              type: 'object',\n              description: 'Scopes alert evaluation to a specific presentation group key on individual line items. Only present for spend alerts.',\n              properties: {\n                key: {\n                  type: 'string'\n                },\n                value: {\n                  type: 'string'\n                }\n              },\n              required: [                'key',\n                'value'\n              ]\n            },\n            group_values: {\n              type: 'array',\n              description: 'Only present for `spend_threshold_reached` alerts. Scope alert to a specific group key on individual line items.',\n              items: {\n                type: 'object',\n                properties: {\n                  key: {\n                    type: 'string'\n                  },\n                  value: {\n                    type: 'string'\n                  }\n                },\n                required: [                  'key'\n                ]\n              }\n            },\n            invoice_types_filter: {\n              type: 'array',\n              description: 'Only supported for invoice_total_reached alerts. A list of invoice types to evaluate.',\n              items: {\n                type: 'string'\n              }\n            },\n            uniqueness_key: {\n              type: 'string',\n              description: 'Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.'\n            }\n          },\n          required: [            'id',\n            'name',\n            'status',\n            'threshold',\n            'type',\n            'updated_at'\n          ]\n        },\n        customer_status: {\n          type: 'string',\n          description: 'The status of the customer alert. If the alert is archived, null will be returned.',\n          enum: [            'ok',\n            'in_alarm',\n            'evaluating'\n          ]\n        },\n        triggered_by: {\n          type: 'string',\n          description: 'If present, indicates the reason the alert was triggered.'\n        }\n      },\n      required: [        'alert',\n        'customer_status'\n      ]\n    },\n    credit_type_data: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        },\n        name: {\n          type: 'string'\n        }\n      },\n      required: [        'id',\n        'name'\n      ]\n    }\n  }\n}\n```",
+    "Retrieve the real-time evaluation status for a specific threshold notification-customer pair. This endpoint provides instant visibility into whether a customer has triggered a threshold notification condition, enabling you to monitor account health and take proactive action based on current threshold notification states.\n\n### Use this endpoint to:\n- Check if a specific customer is currently violating an threshold notification (`in_alarm` status)\n- Verify threshold notification configuration details and threshold values for a customer\n- Monitor the evaluation state of newly created or recently modified threshold notification\n- Build dashboards or automated workflows that respond to specific threshold notification conditions\n- Validate threshold notification behavior before deploying to production customers\n- Integrate threshold notification status checks into customer support tools or admin interfaces\n\n### Key response fields: \nA CustomerAlert object containing:\n\n- `customer_status`: The current evaluation state\n\n- `ok` - Customer is within acceptable thresholds\n- `in_alarm` - Customer has breached the threshold for the notification\n- `evaluating` - Notification is currently being evaluated (typically during initial setup)\n- `null` - Notification has been archived\n- `triggered_by`: Additional context about what caused the notification to trigger (when applicable)\n- alert: Complete threshold notification configuration including:\n  - Notification ID, name, and type\n  - Current threshold values and credit type information\n  - Notification status (enabled, disabled, or archived)\n  - Last update timestamp\n  - Any applied filters (credit grant types, custom fields, group values)\n\n### Usage guidelines:\n- Customer status: Returns the current evaluation state, not historical data. For threshold notification history, use webhook notifications or event logs\n- Required parameters: Both customer_id and alert_id must be valid UUIDs that exist in your organization\n- Archived notifications: Returns null for customer_status if the notification has been archived, but still includes the notification configuration details\n- Performance considerations: This endpoint queries live evaluation state, making it ideal for real-time monitoring but not for bulk status checks\n- Integration patterns: Best used for on-demand status checks in response to user actions or as part of targeted monitoring workflows\n- Error handling: Returns 404 if either the customer or alert_id doesn't exist or isn't accessible to your organization\n",
   inputSchema: {
     type: 'object',
     properties: {
       alert_id: {
         type: 'string',
-        description: 'The Metronome ID of the alert',
+        description: 'The Metronome ID of the threshold notification',
       },
       customer_id: {
         type: 'string',
@@ -33,11 +32,11 @@ export const tool: Tool = {
       group_values: {
         type: 'array',
         description:
-          'Only present for `spend_threshold_reached` alerts. Retrieve the alert for a specific group key-value pair.',
+          'Only present for `spend_threshold_reached` notifications. Retrieve the notification for a specific group key-value pair.',
         items: {
           type: 'object',
           description:
-            'Scopes alert evaluation to a specific presentation group key on individual line items. Only present for spend alerts.',
+            'Scopes threshold notification evaluation to a specific presentation group key on individual line items. Only present for spend notifications.',
           properties: {
             key: {
               type: 'string',
@@ -52,15 +51,9 @@ export const tool: Tool = {
       plans_or_contracts: {
         type: 'string',
         description:
-          'When parallel alerts are enabled during migration, this flag denotes whether to fetch alerts for plans or contracts.',
+          'When parallel threshold notifications are enabled during migration, this flag denotes whether to fetch notifications for plans or contracts.',
         enum: ['PLANS', 'CONTRACTS'],
       },
-      jq_filter: {
-        type: 'string',
-        title: 'jq Filter',
-        description:
-          'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
-      },
     },
     required: ['alert_id', 'customer_id'],
   },
@@ -68,8 +61,8 @@ export const tool: Tool = {
 };
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
-  const { jq_filter, ...body } = args as any;
-  return asTextContentResult(await maybeFilter(jq_filter, await client.v1.customers.alerts.retrieve(body)));
+  const body = args as any;
+  return asTextContentResult(await client.v1.customers.alerts.retrieve(body));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/customers/archive-v1-customers.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'archive_v1_customers',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nUse this endpoint to archive a customer while preserving auditability. Archiving a customer will automatically archive all contracts as of the current date and void all corresponding invoices. Use this endpoint if a customer is onboarded by mistake.\n\n### Usage guidelines:\n- Once a customer is archived, it cannot be unarchived.\n- Archived customers can still be viewed through the API or the UI for audit purposes. \n- Ingest aliases remain idempotent for archived customers. In order to reuse an ingest alias, first remove the ingest alias from the customer prior to archiving.\n- Any alerts associated with the customer will no longer be triggered.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      $ref: '#/$defs/id'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nUse this endpoint to archive a customer while preserving auditability. Archiving a customer will automatically archive all contracts as of the current date and void all corresponding invoices. Use this endpoint if a customer is onboarded by mistake.\n\n### Usage guidelines:\n- Once a customer is archived, it cannot be unarchived.\n- Archived customers can still be viewed through the API or the UI for audit purposes. \n- Ingest aliases remain idempotent for archived customers. In order to reuse an ingest alias, first remove the ingest alias from the customer prior to archiving.\n- Any notifications associated with the customer will no longer be triggered.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/customer_archive_response',\n  $defs: {\n    customer_archive_response: {\n      type: 'object',\n      properties: {\n        data: {\n          $ref: '#/$defs/id'\n        }\n      },\n      required: [        'data'\n      ]\n    },\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/billing-config/create-customers-v1-billing-config.ts

@@ -16,7 +16,8 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'create_customers_v1_billing_config',
-  description: 'Set the billing configuration for a given customer.',
+  description:
+    'Set the billing configuration for a given customer. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.\n',
   inputSchema: {
     type: 'object',
     properties: {
@@ -34,6 +35,7 @@ export const tool: Tool = {
           'quickbooks_online',
           'workday',
           'gcp_marketplace',
+          'metronome',
         ],
       },
       billing_provider_customer_id: {
@@ -76,6 +78,8 @@ export const tool: Tool = {
       },
       stripe_collection_method: {
         type: 'string',
+        description:
+          "The collection method for the customer's invoices.\nNOTE: `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.",
         enum: [
           'charge_automatically',
           'send_invoice',

package/src/tools/v1/customers/billing-config/delete-customers-v1-billing-config.ts

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'delete_customers_v1_billing_config',
   description:
-    'Delete the billing configuration for a given customer. Note: this is unsupported for Azure and AWS Marketplace customers.\n',
+    'Delete the billing configuration for a given customer.\nNote: this is unsupported for Azure and AWS Marketplace customers. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.\n',
   inputSchema: {
     type: 'object',
     properties: {
@@ -35,6 +35,7 @@ export const tool: Tool = {
           'quickbooks_online',
           'workday',
           'gcp_marketplace',
+          'metronome',
         ],
       },
     },

package/src/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'retrieve_customers_v1_billing_config',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nFetch the billing configuration for the given customer.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'object',\n      properties: {\n        aws_expiration_date: {\n          type: 'string',\n          description: 'Contract expiration date for the customer. The expected format is RFC 3339 and can be retrieved from [AWS\\'s GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).',\n          format: 'date-time'\n        },\n        aws_is_subscription_product: {\n          type: 'boolean',\n          description: 'True if the aws_product_code is a SAAS subscription product, false otherwise.'\n        },\n        aws_product_code: {\n          type: 'string'\n        },\n        aws_region: {\n          type: 'string',\n          enum: [            'af-south-1',\n            'ap-east-1',\n            'ap-northeast-1',\n            'ap-northeast-2',\n            'ap-northeast-3',\n            'ap-south-1',\n            'ap-southeast-1',\n            'ap-southeast-2',\n            'ca-central-1',\n            'cn-north-1',\n            'cn-northwest-1',\n            'eu-central-1',\n            'eu-north-1',\n            'eu-south-1',\n            'eu-west-1',\n            'eu-west-2',\n            'eu-west-3',\n            'me-south-1',\n            'sa-east-1',\n            'us-east-1',\n            'us-east-2',\n            'us-gov-east-1',\n            'us-gov-west-1',\n            'us-west-1',\n            'us-west-2'\n          ]\n        },\n        azure_expiration_date: {\n          type: 'string',\n          description: 'Subscription term start/end date for the customer. The expected format is RFC 3339 and can be retrieved from [Azure\\'s Get Subscription API](https://learn.microsoft.com/en-us/partner-center/marketplace/partner-center-portal/pc-saas-fulfillment-subscription-api#get-subscription).',\n          format: 'date-time'\n        },\n        azure_plan_id: {\n          type: 'string'\n        },\n        azure_start_date: {\n          type: 'string',\n          description: 'Subscription term start/end date for the customer. The expected format is RFC 3339 and can be retrieved from [Azure\\'s Get Subscription API](https://learn.microsoft.com/en-us/partner-center/marketplace/partner-center-portal/pc-saas-fulfillment-subscription-api#get-subscription).',\n          format: 'date-time'\n        },\n        azure_subscription_status: {\n          type: 'string',\n          enum: [            'Subscribed',\n            'Unsubscribed',\n            'Suspended',\n            'PendingFulfillmentStart'\n          ]\n        },\n        billing_provider_customer_id: {\n          type: 'string'\n        },\n        stripe_collection_method: {\n          type: 'string',\n          enum: [            'charge_automatically',\n            'send_invoice',\n            'auto_charge_payment_intent',\n            'manually_charge_payment_intent'\n          ]\n        }\n      }\n    }\n  },\n  required: [    'data'\n  ]\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nFetch the billing configuration for the given customer. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/billing_config_retrieve_response',\n  $defs: {\n    billing_config_retrieve_response: {\n      type: 'object',\n      properties: {\n        data: {\n          type: 'object',\n          properties: {\n            aws_expiration_date: {\n              type: 'string',\n              description: 'Contract expiration date for the customer. The expected format is RFC 3339 and can be retrieved from [AWS\\'s GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).',\n              format: 'date-time'\n            },\n            aws_is_subscription_product: {\n              type: 'boolean',\n              description: 'True if the aws_product_code is a SAAS subscription product, false otherwise.'\n            },\n            aws_product_code: {\n              type: 'string'\n            },\n            aws_region: {\n              type: 'string',\n              enum: [                'af-south-1',\n                'ap-east-1',\n                'ap-northeast-1',\n                'ap-northeast-2',\n                'ap-northeast-3',\n                'ap-south-1',\n                'ap-southeast-1',\n                'ap-southeast-2',\n                'ca-central-1',\n                'cn-north-1',\n                'cn-northwest-1',\n                'eu-central-1',\n                'eu-north-1',\n                'eu-south-1',\n                'eu-west-1',\n                'eu-west-2',\n                'eu-west-3',\n                'me-south-1',\n                'sa-east-1',\n                'us-east-1',\n                'us-east-2',\n                'us-gov-east-1',\n                'us-gov-west-1',\n                'us-west-1',\n                'us-west-2'\n              ]\n            },\n            azure_expiration_date: {\n              type: 'string',\n              description: 'Subscription term start/end date for the customer. The expected format is RFC 3339 and can be retrieved from [Azure\\'s Get Subscription API](https://learn.microsoft.com/en-us/partner-center/marketplace/partner-center-portal/pc-saas-fulfillment-subscription-api#get-subscription).',\n              format: 'date-time'\n            },\n            azure_plan_id: {\n              type: 'string'\n            },\n            azure_start_date: {\n              type: 'string',\n              description: 'Subscription term start/end date for the customer. The expected format is RFC 3339 and can be retrieved from [Azure\\'s Get Subscription API](https://learn.microsoft.com/en-us/partner-center/marketplace/partner-center-portal/pc-saas-fulfillment-subscription-api#get-subscription).',\n              format: 'date-time'\n            },\n            azure_subscription_status: {\n              type: 'string',\n              enum: [                'Subscribed',\n                'Unsubscribed',\n                'Suspended',\n                'PendingFulfillmentStart'\n              ]\n            },\n            billing_provider_customer_id: {\n              type: 'string'\n            },\n            stripe_collection_method: {\n              type: 'string',\n              description: 'The collection method for the customer\\'s invoices.\\nNOTE: `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.',\n              enum: [                'charge_automatically',\n                'send_invoice',\n                'auto_charge_payment_intent',\n                'manually_charge_payment_intent'\n              ]\n            }\n          }\n        }\n      },\n      required: [        'data'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {
@@ -36,6 +36,7 @@ export const tool: Tool = {
           'quickbooks_online',
           'workday',
           'gcp_marketplace',
+          'metronome',
         ],
       },
       jq_filter: {

package/src/tools/v1/customers/commits/create-customers-v1-commits.ts

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'create_customers_v1_commits',
   description:
-    'Creates customer-level commits that establish spending commitments for customers across their Metronome usage. Commits represent contracted spending obligations that can be either prepaid (paid upfront) or postpaid (billed later). \n\nNote: In most cases, you should add commitments directly to customer contracts using the contract/create or contract/edit APIs.\n\n### Use this endpoint to:\nUse this endpoint when you need to establish customer-level spending commitments that can be applied across multiple contracts or scoped to specific contracts. Customer-level commits are ideal for:\n- Enterprise-wide minimum spending agreements that span multiple contracts\n- Multi-contract volume commitments with shared spending pools\n- Cross-contract discount tiers based on aggregate usage\n\n#### Commit type Requirements: \n- You must specify either "prepaid" or "postpaid" as the commit type:\n- Prepaid commits: Customer pays upfront; invoice_schedule is optional (if omitted, creates a commit without an invoice)\n- Postpaid commits: Customer pays when the commitment expires (the end of the access_schedule); invoice_schedule is required and must match access_schedule totals. \n\n#### Billing configuration:\n- invoice_contract_id is required for postpaid commits and for prepaid commits with billing (only optional for free prepaid commits)\n- For postpaid commits: access_schedule and invoice_schedule must have matching amounts\n- For postpaid commits: only one schedule item is allowed in both schedules.\n\n#### Scoping flexibility:\nCustomer-level commits can be configured in a few ways:\n- Contract-specific: Use the `applicable_contract_ids` field to limit the commit to specific contracts\n- Cross-contract: Leave `applicable_contract_ids` empty to allow the commit to be used across all of the customer\'s contracts\n\n#### Product targeting:\nCommits can be scoped to specific products using applicable_product_ids, applicable_product_tags, or specifiers, or left unrestricted to apply to all products.\n\n#### Priority considerations:\nWhen multiple commits are applicable, the one with the lower priority value will be consumed first. If there is a tie, contract level commits and credits will be applied before customer level commits and credits. Plan your priority scheme carefully to ensure commits are applied in the desired order.\n\n### Usage guidelines:\n⚠️ Preferred Alternative: In most cases, you should add commits directly to contracts using the create contract or edit contract APIs instead of creating customer-level commits. Contract-level commits provide better organization and are the recommended approach for standard use cases.\n',
+    'Creates customer-level commits that establish spending commitments for customers across their Metronome usage. Commits represent contracted spending obligations that can be either prepaid (paid upfront) or postpaid (billed later). \n\nNote: In most cases, you should add commitments directly to customer contracts using the contract/create or contract/edit APIs.\n\n### Use this endpoint to:\nUse this endpoint when you need to establish customer-level spending commitments that can be applied across multiple contracts or scoped to specific contracts. Customer-level commits are ideal for:\n- Enterprise-wide minimum spending agreements that span multiple contracts\n- Multi-contract volume commitments with shared spending pools\n- Cross-contract discount tiers based on aggregate usage\n\n#### Commit type Requirements: \n- You must specify either "prepaid" or "postpaid" as the commit type:\n- Prepaid commits: Customer pays upfront; invoice_schedule is optional (if omitted, creates a commit without an invoice)\n- Postpaid commits: Customer pays when the commitment expires (the end of the access_schedule); invoice_schedule is required and must match access_schedule totals. \n\n#### Billing configuration:\n- invoice_contract_id is required for postpaid commits and for prepaid commits with billing (only optional for free prepaid commits) unless do_not_invoice is set to true\n- For postpaid commits: access_schedule and invoice_schedule must have matching amounts\n- For postpaid commits: only one schedule item is allowed in both schedules.\n\n#### Scoping flexibility:\nCustomer-level commits can be configured in a few ways:\n- Contract-specific: Use the `applicable_contract_ids` field to limit the commit to specific contracts\n- Cross-contract: Leave `applicable_contract_ids` empty to allow the commit to be used across all of the customer\'s contracts\n\n#### Product targeting:\nCommits can be scoped to specific products using applicable_product_ids, applicable_product_tags, or specifiers, or left unrestricted to apply to all products.\n\n#### Priority considerations:\nWhen multiple commits are applicable, the one with the lower priority value will be consumed first. If there is a tie, contract level commits and credits will be applied before customer level commits and credits. Plan your priority scheme carefully to ensure commits are applied in the desired order.\n\n### Usage guidelines:\n⚠️ Preferred Alternative: In most cases, you should add commits directly to contracts using the create contract or edit contract APIs instead of creating customer-level commits. Contract-level commits provide better organization and are the recommended approach for standard use cases.\n',
   inputSchema: {
     type: 'object',
     properties: {
@@ -108,7 +108,7 @@ export const tool: Tool = {
       invoice_contract_id: {
         type: 'string',
         description:
-          'The contract that this commit will be billed on. This is required for "POSTPAID" commits and for "PREPAID" commits unless there is no invoice schedule above (i.e., the commit is \'free\').',
+          'The contract that this commit will be billed on. This is required for "POSTPAID" commits and for "PREPAID" commits unless there is no invoice schedule above (i.e., the commit is \'free\'), or if do_not_invoice is set to true.',
       },
       invoice_schedule: {
         type: 'object',

package/src/tools/v1/customers/commits/update-end-date-customers-v1-commits.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'update_end_date_customers_v1_commits',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nShortens the end date of a prepaid commit to terminate it earlier than originally scheduled. Use this endpoint when you need to cancel or reduce the duration of an existing prepaid commit. Only works with prepaid commit types and can only move the end date forward (earlier), not extend it. \n\n### Usage guidelines:\nTo extend commit end dates or make other comprehensive edits, use the 'edit commit' endpoint instead.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      $ref: '#/$defs/id'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nShortens the end date of a prepaid commit to terminate it earlier than originally scheduled. Use this endpoint when you need to cancel or reduce the duration of an existing prepaid commit. Only works with prepaid commit types and can only move the end date forward (earlier), not extend it. \n\n### Usage guidelines:\nTo extend commit end dates or make other comprehensive edits, use the 'edit commit' endpoint instead.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/commit_update_end_date_response',\n  $defs: {\n    commit_update_end_date_response: {\n      type: 'object',\n      properties: {\n        data: {\n          $ref: '#/$defs/id'\n        }\n      },\n      required: [        'data'\n      ]\n    },\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/create-v1-customers.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'create_v1_customers',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nCreate a new customer in Metronome and optionally the billing configuration (recommended) which dictates where invoices for the customer will be sent or where payment will be collected. \n\n### Use this endpoint to:\nExecute your customer provisioning workflows for either PLG motions, where customers originate in your platform, or SLG motions, where customers originate in your sales system.\n\n### Key response fields: \nThis end-point returns the `customer_id` created by the request. This id can be used to fetch relevant billing configurations and create contracts.\n\n### Example workflow:\n- Generally, Metronome recommends first creating the customer in the downstream payment / ERP system when payment method is collected and then creating the customer in Metronome using the response (i.e. `customer_id`) from the downstream system. If you do not create a billing configuration on customer creation, you can add it later.        \n- Once a customer is created, you can then create a contract for the customer. In the contract creation process, you will need to add the customer billing configuration to the contract to ensure Metronome invoices the customer correctly. This is because a customer can have multiple configurations.\n- As part of the customer creation process, set the ingest alias for the customer which will ensure usage is accurately mapped to the customer. Ingest aliases can be added or changed after the creation process as well.\n\n### Usage guidelines:\nFor details on different billing configurations for different systems, review the `/setCustomerBillingConfiguration` end-point.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      $ref: '#/$defs/customer'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    customer: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'the Metronome ID of the customer'\n        },\n        external_id: {\n          type: 'string',\n          description: '(deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias) that can be used in usage events'\n        },\n        ingest_aliases: {\n          type: 'array',\n          description: 'aliases for this customer that can be used instead of the Metronome customer ID in usage events',\n          items: {\n            type: 'string'\n          }\n        },\n        name: {\n          type: 'string'\n        },\n        custom_fields: {\n          type: 'object',\n          description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n          additionalProperties: true\n        }\n      },\n      required: [        'id',\n        'external_id',\n        'ingest_aliases',\n        'name'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nCreate a new customer in Metronome and optionally the billing configuration (recommended) which dictates where invoices for the customer will be sent or where payment will be collected. \n\n### Use this endpoint to:\nExecute your customer provisioning workflows for either PLG motions, where customers originate in your platform, or SLG motions, where customers originate in your sales system.\n\n### Key response fields: \nThis end-point returns the `customer_id` created by the request. This id can be used to fetch relevant billing configurations and create contracts.\n\n### Example workflow:\n- Generally, Metronome recommends first creating the customer in the downstream payment / ERP system when payment method is collected and then creating the customer in Metronome using the response (i.e. `customer_id`) from the downstream system. If you do not create a billing configuration on customer creation, you can add it later.        \n- Once a customer is created, you can then create a contract for the customer. In the contract creation process, you will need to add the customer billing configuration to the contract to ensure Metronome invoices the customer correctly. This is because a customer can have multiple configurations.\n- As part of the customer creation process, set the ingest alias for the customer which will ensure usage is accurately mapped to the customer. Ingest aliases can be added or changed after the creation process as well.\n\n### Usage guidelines:\nFor details on different billing configurations for different systems, review the `/setCustomerBillingConfiguration` end-point.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/customer_create_response',\n  $defs: {\n    customer_create_response: {\n      type: 'object',\n      properties: {\n        data: {\n          $ref: '#/$defs/customer'\n        }\n      },\n      required: [        'data'\n      ]\n    },\n    customer: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'the Metronome ID of the customer'\n        },\n        external_id: {\n          type: 'string',\n          description: '(deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias) that can be used in usage events'\n        },\n        ingest_aliases: {\n          type: 'array',\n          description: 'aliases for this customer that can be used instead of the Metronome customer ID in usage events',\n          items: {\n            type: 'string'\n          }\n        },\n        name: {\n          type: 'string'\n        },\n        custom_fields: {\n          type: 'object',\n          description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n          additionalProperties: true\n        }\n      },\n      required: [        'id',\n        'external_id',\n        'ingest_aliases',\n        'name'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {
@@ -43,6 +43,7 @@ export const tool: Tool = {
               'quickbooks_online',
               'workday',
               'gcp_marketplace',
+              'metronome',
             ],
           },
           aws_is_subscription_product: {
@@ -84,6 +85,8 @@ export const tool: Tool = {
           },
           stripe_collection_method: {
             type: 'string',
+            description:
+              "The collection method for the customer's invoices.\nNOTE: `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.",
             enum: [
               'charge_automatically',
               'send_invoice',

package/src/tools/v1/customers/credits/create-customers-v1-credits.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'create_customers_v1_credits',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nCreates customer-level credits that provide spending allowances or free credit balances for customers across their Metronome usage. Note: In most cases, you should add credits directly to customer contracts using the contract/create or contract/edit APIs.\n\n### Use this endpoint to:\nUse this endpoint when you need to provision credits directly at the customer level that can be applied across multiple contracts or scoped to specific contracts. Customer-level credits are ideal for:\n- Customer onboarding incentives that apply globally\n- Flexible spending allowances that aren't tied to a single contract\n- Migration scenarios where you need to preserve existing customer balances\n\n#### Scoping flexibility: \nCustomer-level credits can be configured in two ways:\n- Contract-specific: Use the applicable_contract_ids field to limit the credit to specific contracts\n- Cross-contract: Leave applicable_contract_ids empty to allow the credit to be used across all of the customer's contracts\n\n#### Product Targeting: \nCredits can be scoped to specific products using `applicable_product_ids` or `applicable_product_tags`, or left unrestricted to apply to all products.\n\n#### Priority considerations: \nWhen multiple credits are applicable, the one with the lower priority value will be consumed first. If there is a tie, contract level commits and credits will be applied before customer level commits and credits. Plan your priority scheme carefully to ensure credits are applied in the desired order.\n\n#### Access Schedule Required: \nYou must provide an `access_schedule` that defines when and how much credit becomes available to the customer over time. This usually is aligned to the contract schedule or starts immediately and is set to expire in the future.\n\n### Usage Guidelines:\n⚠️ Preferred Alternative: In most cases, you should add credits directly to contracts using the contract/create or contract/edit APIs instead of creating customer-level credits. Contract-level credits provide better organization, and are easier for finance teams to recognize revenue, and are the recommended approach for most use cases.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      $ref: '#/$defs/id'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nCreates customer-level credits that provide spending allowances or free credit balances for customers across their Metronome usage. Note: In most cases, you should add credits directly to customer contracts using the contract/create or contract/edit APIs.\n\n### Use this endpoint to:\nUse this endpoint when you need to provision credits directly at the customer level that can be applied across multiple contracts or scoped to specific contracts. Customer-level credits are ideal for:\n- Customer onboarding incentives that apply globally\n- Flexible spending allowances that aren't tied to a single contract\n- Migration scenarios where you need to preserve existing customer balances\n\n#### Scoping flexibility: \nCustomer-level credits can be configured in two ways:\n- Contract-specific: Use the applicable_contract_ids field to limit the credit to specific contracts\n- Cross-contract: Leave applicable_contract_ids empty to allow the credit to be used across all of the customer's contracts\n\n#### Product Targeting: \nCredits can be scoped to specific products using `applicable_product_ids` or `applicable_product_tags`, or left unrestricted to apply to all products.\n\n#### Priority considerations: \nWhen multiple credits are applicable, the one with the lower priority value will be consumed first. If there is a tie, contract level commits and credits will be applied before customer level commits and credits. Plan your priority scheme carefully to ensure credits are applied in the desired order.\n\n#### Access Schedule Required: \nYou must provide an `access_schedule` that defines when and how much credit becomes available to the customer over time. This usually is aligned to the contract schedule or starts immediately and is set to expire in the future.\n\n### Usage Guidelines:\n⚠️ Preferred Alternative: In most cases, you should add credits directly to contracts using the contract/create or contract/edit APIs instead of creating customer-level credits. Contract-level credits provide better organization, and are easier for finance teams to recognize revenue, and are the recommended approach for most use cases.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/credit_create_response',\n  $defs: {\n    credit_create_response: {\n      type: 'object',\n      properties: {\n        data: {\n          $ref: '#/$defs/id'\n        }\n      },\n      required: [        'data'\n      ]\n    },\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/credits/update-end-date-customers-v1-credits.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'update_end_date_customers_v1_credits',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nShortens the end date of an existing customer credit to terminate it earlier than originally scheduled. Only allows moving end dates forward (earlier), not extending them. \n\nNote: To extend credit end dates or make comprehensive edits, use the 'edit credit' endpoint instead.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      $ref: '#/$defs/id'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nShortens the end date of an existing customer credit to terminate it earlier than originally scheduled. Only allows moving end dates forward (earlier), not extending them. \n\nNote: To extend credit end dates or make comprehensive edits, use the 'edit credit' endpoint instead.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/credit_update_end_date_response',\n  $defs: {\n    credit_update_end_date_response: {\n      type: 'object',\n      properties: {\n        data: {\n          $ref: '#/$defs/id'\n        }\n      },\n      required: [        'data'\n      ]\n    },\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/invoices/add-charge-customers-v1-invoices.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'add_charge_customers_v1_invoices',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nAdd a one time charge to the specified invoice\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {}\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nAdd a one time charge to the specified invoice. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/invoice_add_charge_response',\n  $defs: {\n    invoice_add_charge_response: {\n      type: 'object',\n      properties: {}\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.ts

@@ -0,0 +1,43 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Metadata, asBinaryContentResult } from '@metronome/mcp/tools/types';
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.invoices',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/invoices/{invoice_id}/pdf',
+  operationId: 'getInvoicePdf-v1',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_pdf_customers_v1_invoices',
+  description:
+    'Retrieve a PDF version of a specific invoice by its unique identifier. This endpoint generates a professionally formatted invoice document suitable for sharing with customers, accounting teams, or for record-keeping purposes.\n\n### Use this endpoint to:\n- Provide customers with downloadable or emailable copies of their invoices\n- Support accounting and finance teams with official billing documents\n- Maintain accurate records of billing transactions for audits and compliance\n\n### Key response details:\n- The response is a binary PDF file representing the full invoice\n- The PDF includes all standard invoice information such as line items, totals, billing period, and customer details\n- The document is formatted for clarity and professionalism, suitable for official use\n\n### Usage guidelines:\n- Ensure the `invoice_id` corresponds to an existing invoice for the specified `customer_id`\n- The PDF is generated on-demand; frequent requests for the same invoice may impact performance\n- Use appropriate headers to handle the binary response in your application (e.g., setting `Content-Type: application/pdf`)\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      invoice_id: {
+        type: 'string',
+      },
+    },
+    required: ['customer_id', 'invoice_id'],
+  },
+  annotations: {
+    readOnlyHint: true,
+  },
+};
+
+export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return asBinaryContentResult(await client.v1.customers.invoices.retrievePdf(body));
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/list-billable-metrics-v1-customers.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_billable_metrics_v1_customers',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet all billable metrics available for a specific customer. Supports pagination and filtering by current plan status or archived metrics. Use this endpoint to see which metrics are being tracked for billing calculations for a given customer.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        type: 'object',\n        properties: {\n          id: {\n            type: 'string'\n          },\n          name: {\n            type: 'string'\n          },\n          aggregate: {\n            type: 'string',\n            description: '(DEPRECATED) use aggregation_type instead'\n          },\n          aggregate_keys: {\n            type: 'array',\n            description: '(DEPRECATED) use aggregation_key instead',\n            items: {\n              type: 'string'\n            }\n          },\n          aggregation_key: {\n            type: 'string',\n            description: 'A key that specifies which property of the event is used to aggregate data. This key must be one of the property filter names and is not applicable when the aggregation type is \\'count\\'.'\n          },\n          aggregation_type: {\n            type: 'string',\n            description: 'Specifies the type of aggregation performed on matching events.',\n            enum: [              'COUNT',\n              'LATEST',\n              'MAX',\n              'SUM',\n              'UNIQUE'\n            ]\n          },\n          archived_at: {\n            type: 'string',\n            description: 'RFC 3339 timestamp indicating when the billable metric was archived. If not provided, the billable metric is not archived.',\n            format: 'date-time'\n          },\n          custom_fields: {\n            type: 'object',\n            description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n            additionalProperties: true\n          },\n          event_type_filter: {\n            $ref: '#/$defs/event_type_filter'\n          },\n          filter: {\n            type: 'object',\n            description: '(DEPRECATED) use property_filters & event_type_filter instead',\n            additionalProperties: true\n          },\n          group_by: {\n            type: 'array',\n            description: '(DEPRECATED) use group_keys instead',\n            items: {\n              type: 'string',\n              description: 'A list of keys that can be used to additionally segment the values of the billable metric when making usage queries'\n            }\n          },\n          group_keys: {\n            type: 'array',\n            description: 'Property names that are used to group usage costs on an invoice. Each entry represents a set of properties used to slice events into distinct buckets.',\n            items: {\n              type: 'array',\n              items: {\n                type: 'string'\n              }\n            }\n          },\n          property_filters: {\n            type: 'array',\n            description: 'A list of filters to match events to this billable metric. Each filter defines a rule on an event property. All rules must pass for the event to match the billable metric.',\n            items: {\n              $ref: '#/$defs/property_filter'\n            }\n          },\n          sql: {\n            type: 'string',\n            description: 'The SQL query associated with the billable metric'\n          }\n        },\n        required: [          'id',\n          'name'\n        ]\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    event_type_filter: {\n      type: 'object',\n      description: 'An optional filtering rule to match the \\'event_type\\' property of an event.',\n      properties: {\n        in_values: {\n          type: 'array',\n          description: 'A list of event types that are explicitly included in the billable metric. If specified, only events of these types will match the billable metric. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        },\n        not_in_values: {\n          type: 'array',\n          description: 'A list of event types that are explicitly excluded from the billable metric. If specified, events of these types will not match the billable metric. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        }\n      }\n    },\n    property_filter: {\n      type: 'object',\n      properties: {\n        name: {\n          type: 'string',\n          description: 'The name of the event property.'\n        },\n        exists: {\n          type: 'boolean',\n          description: 'Determines whether the property must exist in the event. If true, only events with this property will pass the filter. If false, only events without this property will pass the filter. If null or omitted, the existence of the property is optional.'\n        },\n        in_values: {\n          type: 'array',\n          description: 'Specifies the allowed values for the property to match an event. An event will pass the filter only if its property value is included in this list. If undefined, all property values will pass the filter. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        },\n        not_in_values: {\n          type: 'array',\n          description: 'Specifies the values that prevent an event from matching the filter. An event will not pass the filter if its property value is included in this list. If null or empty, all property values will pass the filter. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        }\n      },\n      required: [        'name'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet all billable metrics available for a specific customer. Supports pagination and filtering by current plan status or archived metrics. Use this endpoint to see which metrics are being tracked for billing calculations for a given customer.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/customer_list_billable_metrics_response'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    customer_list_billable_metrics_response: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        },\n        name: {\n          type: 'string'\n        },\n        aggregate: {\n          type: 'string',\n          description: '(DEPRECATED) use aggregation_type instead'\n        },\n        aggregate_keys: {\n          type: 'array',\n          description: '(DEPRECATED) use aggregation_key instead',\n          items: {\n            type: 'string'\n          }\n        },\n        aggregation_key: {\n          type: 'string',\n          description: 'A key that specifies which property of the event is used to aggregate data. This key must be one of the property filter names and is not applicable when the aggregation type is \\'count\\'.'\n        },\n        aggregation_type: {\n          type: 'string',\n          description: 'Specifies the type of aggregation performed on matching events.',\n          enum: [            'COUNT',\n            'LATEST',\n            'MAX',\n            'SUM',\n            'UNIQUE'\n          ]\n        },\n        archived_at: {\n          type: 'string',\n          description: 'RFC 3339 timestamp indicating when the billable metric was archived. If not provided, the billable metric is not archived.',\n          format: 'date-time'\n        },\n        custom_fields: {\n          type: 'object',\n          description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n          additionalProperties: true\n        },\n        event_type_filter: {\n          $ref: '#/$defs/event_type_filter'\n        },\n        filter: {\n          type: 'object',\n          description: '(DEPRECATED) use property_filters & event_type_filter instead',\n          additionalProperties: true\n        },\n        group_by: {\n          type: 'array',\n          description: '(DEPRECATED) use group_keys instead',\n          items: {\n            type: 'string',\n            description: 'A list of keys that can be used to additionally segment the values of the billable metric when making usage queries'\n          }\n        },\n        group_keys: {\n          type: 'array',\n          description: 'Property names that are used to group usage costs on an invoice. Each entry represents a set of properties used to slice events into distinct buckets.',\n          items: {\n            type: 'array',\n            items: {\n              type: 'string'\n            }\n          }\n        },\n        property_filters: {\n          type: 'array',\n          description: 'A list of filters to match events to this billable metric. Each filter defines a rule on an event property. All rules must pass for the event to match the billable metric.',\n          items: {\n            $ref: '#/$defs/property_filter'\n          }\n        },\n        sql: {\n          type: 'string',\n          description: 'The SQL query associated with the billable metric'\n        }\n      },\n      required: [        'id',\n        'name'\n      ]\n    },\n    event_type_filter: {\n      type: 'object',\n      description: 'An optional filtering rule to match the \\'event_type\\' property of an event.',\n      properties: {\n        in_values: {\n          type: 'array',\n          description: 'A list of event types that are explicitly included in the billable metric. If specified, only events of these types will match the billable metric. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        },\n        not_in_values: {\n          type: 'array',\n          description: 'A list of event types that are explicitly excluded from the billable metric. If specified, events of these types will not match the billable metric. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        }\n      }\n    },\n    property_filter: {\n      type: 'object',\n      properties: {\n        name: {\n          type: 'string',\n          description: 'The name of the event property.'\n        },\n        exists: {\n          type: 'boolean',\n          description: 'Determines whether the property must exist in the event. If true, only events with this property will pass the filter. If false, only events without this property will pass the filter. If null or omitted, the existence of the property is optional.'\n        },\n        in_values: {\n          type: 'array',\n          description: 'Specifies the allowed values for the property to match an event. An event will pass the filter only if its property value is included in this list. If undefined, all property values will pass the filter. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        },\n        not_in_values: {\n          type: 'array',\n          description: 'Specifies the values that prevent an event from matching the filter. An event will not pass the filter if its property value is included in this list. If null or empty, all property values will pass the filter. Must be non-empty if present.',\n          items: {\n            type: 'string'\n          }\n        }\n      },\n      required: [        'name'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/list-costs-v1-customers.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_costs_v1_customers',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nFetch daily pending costs for the specified customer, broken down by credit type and line items. Note: this is not supported for customers whose plan includes a UNIQUE-type billable metric.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        type: 'object',\n        properties: {\n          credit_types: {\n            type: 'object',\n            additionalProperties: true\n          },\n          end_timestamp: {\n            type: 'string',\n            format: 'date-time'\n          },\n          start_timestamp: {\n            type: 'string',\n            format: 'date-time'\n          }\n        },\n        required: [          'credit_types',\n          'end_timestamp',\n          'start_timestamp'\n        ]\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ]\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nFetch daily pending costs for the specified customer, broken down by credit type and line items. Note: this is not supported for customers whose plan includes a UNIQUE-type billable metric. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/customer_list_costs_response'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    customer_list_costs_response: {\n      type: 'object',\n      properties: {\n        credit_types: {\n          type: 'object',\n          additionalProperties: true\n        },\n        end_timestamp: {\n          type: 'string',\n          format: 'date-time'\n        },\n        start_timestamp: {\n          type: 'string',\n          format: 'date-time'\n        }\n      },\n      required: [        'credit_types',\n        'end_timestamp',\n        'start_timestamp'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/list-v1-customers.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_v1_customers',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGets a paginated list of all customers in your Metronome account. Use this endpoint to browse your customer base, implement customer search functionality, or sync customer data with external systems. Returns customer details including IDs, names, and configuration settings. Supports filtering and pagination parameters for efficient data retrieval.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/customer_detail'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    customer_detail: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'the Metronome ID of the customer'\n        },\n        created_at: {\n          type: 'string',\n          description: 'RFC 3339 timestamp indicating when the customer was created.',\n          format: 'date-time'\n        },\n        custom_fields: {\n          type: 'object',\n          description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n          additionalProperties: true\n        },\n        customer_config: {\n          type: 'object',\n          properties: {\n            salesforce_account_id: {\n              type: 'string',\n              description: 'The Salesforce account ID for the customer'\n            }\n          },\n          required: [            'salesforce_account_id'\n          ]\n        },\n        external_id: {\n          type: 'string',\n          description: '(deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias) that can be used in usage events'\n        },\n        ingest_aliases: {\n          type: 'array',\n          description: 'aliases for this customer that can be used instead of the Metronome customer ID in usage events',\n          items: {\n            type: 'string'\n          }\n        },\n        name: {\n          type: 'string'\n        },\n        archived_at: {\n          type: 'string',\n          description: 'RFC 3339 timestamp indicating when the customer was archived. Null if the customer is active.',\n          format: 'date-time'\n        },\n        current_billable_status: {\n          type: 'object',\n          description: 'This field\\'s availability is dependent on your client\\'s configuration.',\n          properties: {\n            value: {\n              type: 'string',\n              enum: [                'billable',\n                'unbillable'\n              ]\n            },\n            effective_at: {\n              type: 'string',\n              format: 'date-time'\n            }\n          },\n          required: [            'value'\n          ]\n        }\n      },\n      required: [        'id',\n        'created_at',\n        'custom_fields',\n        'customer_config',\n        'external_id',\n        'ingest_aliases',\n        'name'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGets a paginated list of all customers in your Metronome account. Use this endpoint to browse your customer base, implement customer search functionality, or sync customer data with external systems. Returns customer details including IDs, names, and configuration settings. Supports filtering and pagination parameters for efficient data retrieval.\n\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/customer_detail'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    customer_detail: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'the Metronome ID of the customer'\n        },\n        created_at: {\n          type: 'string',\n          description: 'RFC 3339 timestamp indicating when the customer was created.',\n          format: 'date-time'\n        },\n        custom_fields: {\n          type: 'object',\n          description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n          additionalProperties: true\n        },\n        customer_config: {\n          type: 'object',\n          properties: {\n            salesforce_account_id: {\n              type: 'string',\n              description: 'The Salesforce account ID for the customer'\n            }\n          },\n          required: [            'salesforce_account_id'\n          ]\n        },\n        external_id: {\n          type: 'string',\n          description: '(deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias) that can be used in usage events'\n        },\n        ingest_aliases: {\n          type: 'array',\n          description: 'aliases for this customer that can be used instead of the Metronome customer ID in usage events',\n          items: {\n            type: 'string'\n          }\n        },\n        name: {\n          type: 'string'\n        },\n        updated_at: {\n          type: 'string',\n          description: 'RFC 3339 timestamp indicating when the customer was last updated.',\n          format: 'date-time'\n        },\n        archived_at: {\n          type: 'string',\n          description: 'RFC 3339 timestamp indicating when the customer was archived. Null if the customer is active.',\n          format: 'date-time'\n        },\n        current_billable_status: {\n          type: 'object',\n          description: 'This field\\'s availability is dependent on your client\\'s configuration.',\n          properties: {\n            value: {\n              type: 'string',\n              enum: [                'billable',\n                'unbillable'\n              ]\n            },\n            effective_at: {\n              type: 'string',\n              format: 'date-time'\n            }\n          },\n          required: [            'value'\n          ]\n        }\n      },\n      required: [        'id',\n        'created_at',\n        'custom_fields',\n        'customer_config',\n        'external_id',\n        'ingest_aliases',\n        'name',\n        'updated_at'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'retrieve_customers_v1_named_schedules',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet a named schedule for the given customer. This endpoint's availability is dependent on your client's configuration.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        type: 'object',\n        properties: {\n          starting_at: {\n            type: 'string',\n            format: 'date-time'\n          },\n          value: {\n            type: 'object',\n            additionalProperties: true\n          },\n          ending_before: {\n            type: 'string',\n            format: 'date-time'\n          }\n        },\n        required: [          'starting_at',\n          'value'\n        ]\n      }\n    }\n  },\n  required: [    'data'\n  ]\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet a named schedule for the given customer. This endpoint's availability is dependent on your client's configuration.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/named_schedule_retrieve_response',\n  $defs: {\n    named_schedule_retrieve_response: {\n      type: 'object',\n      properties: {\n        data: {\n          type: 'array',\n          items: {\n            type: 'object',\n            properties: {\n              starting_at: {\n                type: 'string',\n                format: 'date-time'\n              },\n              value: {\n                type: 'object',\n                additionalProperties: true\n              },\n              ending_before: {\n                type: 'string',\n                format: 'date-time'\n              }\n            },\n            required: [              'starting_at',\n              'value'\n            ]\n          }\n        }\n      },\n      required: [        'data'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/plans/add-customers-v1-plans.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'add_customers_v1_plans',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nAssociate an existing customer with a plan for a specified date range.  See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details on the price adjustments.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      $ref: '#/$defs/id'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nAssociate an existing customer with a plan for a specified date range.  See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details on the price adjustments. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/plan_add_response',\n  $defs: {\n    plan_add_response: {\n      type: 'object',\n      properties: {\n        data: {\n          $ref: '#/$defs/id'\n        }\n      },\n      required: [        'data'\n      ]\n    },\n    id: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string'\n        }\n      },\n      required: [        'id'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/customers/plans/end-customers-v1-plans.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'end_customers_v1_plans',
   description:
-    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nChange the end date of a customer's plan.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {}\n}\n```",
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nChange the end date of a customer's plan. This is a Plans (deprecated) endpoint. New clients should implement using Contracts.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/plan_end_response',\n  $defs: {\n    plan_end_response: {\n      type: 'object',\n      properties: {}\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {