@metronome/mcp 0.3.0 → 2.0.0

package/src/tools/v1/customers/commits/create-customers-v1-commits.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,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'create_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\nCreate a new commit at the customer level.\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```",
+    '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',
   inputSchema: {
     type: 'object',
     properties: {
@@ -99,6 +98,7 @@ export const tool: Tool = {
       },
       custom_fields: {
         type: 'object',
+        description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
         additionalProperties: true,
       },
       description: {
@@ -218,29 +218,7 @@ export const tool: Tool = {
         description:
           "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
         items: {
-          type: 'object',
-          properties: {
-            presentation_group_values: {
-              type: 'object',
-              additionalProperties: true,
-            },
-            pricing_group_values: {
-              type: 'object',
-              additionalProperties: true,
-            },
-            product_id: {
-              type: 'string',
-              description: 'If provided, the specifier will only apply to the product with the specified ID.',
-            },
-            product_tags: {
-              type: 'array',
-              description:
-                'If provided, the specifier will only apply to products with all the specified tags.',
-              items: {
-                type: 'string',
-              },
-            },
-          },
+          $ref: '#/$defs/commit_specifier_input',
         },
       },
       uniqueness_key: {
@@ -248,21 +226,42 @@ export const tool: Tool = {
         description:
           'Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.',
       },
-      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: ['access_schedule', 'customer_id', 'priority', 'product_id', 'type'],
+    $defs: {
+      commit_specifier_input: {
+        type: 'object',
+        properties: {
+          presentation_group_values: {
+            type: 'object',
+            additionalProperties: true,
+          },
+          pricing_group_values: {
+            type: 'object',
+            additionalProperties: true,
+          },
+          product_id: {
+            type: 'string',
+            description: 'If provided, the specifier will only apply to the product with the specified ID.',
+          },
+          product_tags: {
+            type: 'array',
+            description:
+              'If provided, the specifier will only apply to products with all the specified tags.',
+            items: {
+              type: 'string',
+            },
+          },
+        },
+      },
+    },
   },
   annotations: {},
 };
 
 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.commits.create(body)));
+  const body = args as any;
+  return asTextContentResult(await client.v1.customers.commits.create(body));
 };
 
 export default { metadata, tool, handler };

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

@@ -16,7 +16,8 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'list_customers_v1_commits',
-  description: 'List commits.\n',
+  description:
+    "Retrieve all commit agreements for a customer, including both prepaid and postpaid commitments. This endpoint provides comprehensive visibility into contractual spending obligations, enabling you to track commitment utilization and manage customer contracts effectively.\n\n### Use this endpoint to:\n- Display commitment balances and utilization in customer dashboards\n- Track prepaid commitment drawdown and remaining balances\n- Monitor postpaid commitment progress toward minimum thresholds\n- Build commitment tracking and forecasting tools\n- Show commitment history with optional ledger details\n- Manage rollover balances between contract periods\n\n### Key response fields:\nAn array of Commit objects containing:\n- Commit type: PREPAID (pay upfront) or POSTPAID (pay at true-up)\n- Rate type: COMMIT_RATE (discounted) or LIST_RATE (standard pricing)\n- Access schedule: When commitment funds become available\n- Invoice schedule: When the customer is billed\n- Product targeting: Which product(s) usage is eligible to draw from this commit\n- Optional ledger entries: Transaction history (if `include_ledgers=true`)\n- Balance information: Current available amount (if `include_balance=true`)\n- Rollover settings: Fraction of unused amount that carries forward\n\n### Usage guidelines:\n- Pagination: Results limited to 25 commits per page; use 'next_page' for more\n- Date filtering options:\n    - `covering_date`: Commits active on a specific date\n    - `starting_at`: Commits with access on/after a date\n    - `effective_before`: Commits with access before a date (exclusive)\n- Scope options:\n    - `include_contract_commits`: Include contract-level commits (not just customer-level)\n    - `include_archived`: Include archived commits and commits from archived contracts\n- Performance considerations:\n    - include_ledgers: Adds detailed transaction history (slower)\n    - include_balance: Adds current balance calculation (slower)\n- Optional filtering: Use commit_id to retrieve a specific commit\n",
   inputSchema: {
     type: 'object',
     properties: {
@@ -75,7 +76,8 @@ export const tool: Tool = {
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
   const body = args as any;
-  return asTextContentResult(await client.v1.customers.commits.list(body));
+  const response = await client.v1.customers.commits.list(body).asResponse();
+  return asTextContentResult(await response.json());
 };
 
 export default { metadata, tool, handler };

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\nPull forward the end date of a prepaid commit. Use the \"edit a commit\" endpoint to extend the end date of a prepaid commit, or to make other edits to the commit.\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\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          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: {
@@ -84,13 +84,19 @@ export const tool: Tool = {
           },
           stripe_collection_method: {
             type: 'string',
-            enum: ['charge_automatically', 'send_invoice'],
+            enum: [
+              'charge_automatically',
+              'send_invoice',
+              'auto_charge_payment_intent',
+              'manually_charge_payment_intent',
+            ],
           },
         },
         required: ['billing_provider_customer_id', 'billing_provider_type'],
       },
       custom_fields: {
         type: 'object',
+        description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
         additionalProperties: true,
       },
       customer_billing_provider_configurations: {
@@ -120,6 +126,12 @@ export const tool: Tool = {
               description:
                 'ID of the delivery method to use for this customer. If not provided, the `delivery_method` must be provided.',
             },
+            tax_provider: {
+              type: 'string',
+              description:
+                'Specifies which tax provider Metronome should use for tax calculation when billing through Stripe. This is only supported for Stripe billing provider configurations with auto_charge_payment_intent or manual_charge_payment_intent collection methods.',
+              enum: ['anrok', 'avalara', 'stripe'],
+            },
           },
           required: ['billing_provider'],
         },

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\nCreate a new credit at the customer level.\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: {
@@ -92,6 +92,7 @@ export const tool: Tool = {
       },
       custom_fields: {
         type: 'object',
+        description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
         additionalProperties: true,
       },
       description: {
@@ -119,29 +120,7 @@ export const tool: Tool = {
         description:
           "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
         items: {
-          type: 'object',
-          properties: {
-            presentation_group_values: {
-              type: 'object',
-              additionalProperties: true,
-            },
-            pricing_group_values: {
-              type: 'object',
-              additionalProperties: true,
-            },
-            product_id: {
-              type: 'string',
-              description: 'If provided, the specifier will only apply to the product with the specified ID.',
-            },
-            product_tags: {
-              type: 'array',
-              description:
-                'If provided, the specifier will only apply to products with all the specified tags.',
-              items: {
-                type: 'string',
-              },
-            },
-          },
+          $ref: '#/$defs/commit_specifier_input',
         },
       },
       uniqueness_key: {
@@ -157,6 +136,33 @@ export const tool: Tool = {
       },
     },
     required: ['access_schedule', 'customer_id', 'priority', 'product_id'],
+    $defs: {
+      commit_specifier_input: {
+        type: 'object',
+        properties: {
+          presentation_group_values: {
+            type: 'object',
+            additionalProperties: true,
+          },
+          pricing_group_values: {
+            type: 'object',
+            additionalProperties: true,
+          },
+          product_id: {
+            type: 'string',
+            description: 'If provided, the specifier will only apply to the product with the specified ID.',
+          },
+          product_tags: {
+            type: 'array',
+            description:
+              'If provided, the specifier will only apply to products with all the specified tags.',
+            items: {
+              type: 'string',
+            },
+          },
+        },
+      },
+    },
   },
   annotations: {},
 };

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

@@ -16,7 +16,8 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'list_customers_v1_credits',
-  description: 'List credits.\n',
+  description:
+    'Retrieve a detailed list of all credits available to a customer, including promotional credits and contract-specific credits. This endpoint provides comprehensive visibility into credit balances, access schedules, and usage rules, enabling you to build credit management interfaces and track available funding.\n\n### Use this endpoint to:\n- Display all available credits in customer billing dashboards\n- Show credit balances and expiration dates\n- Track credit usage history with optional ledger details\n- Build credit management and reporting tools\n- Monitor promotional credit utilization\n• Support customer inquiries about available credits\n\n### Key response fields:\nAn array of Credit objects containing:\n- Credit details: Name, priority, and which applicable products/tags it applies to\n- Product ID: The `product_id` of the credit. This is for external mapping into your quote-to-cash stack, not the product it applies to. \n- Access schedule: When credits become available and expire\n- Optional ledger entries: Transaction history (if `include_ledgers=true`)\n- Balance information: Current available amount (if `include_balance=true`)\n- Metadata: Custom fields and usage specifiers\n\n### Usage guidelines:\n- Pagination: Results limited to 25 commits per page; use next_page for more\n- Date filtering options:\n    - `covering_date`: Credits active on a specific date\n    - `starting_at`: Credits with access on/after a date\n    - `effective_before`: Credits with access before a date (exclusive)\n- Scope options:\n    - `include_contract_credits`: Include contract-level credits (not just customer-level)\n    - `include_archived`: Include archived credits and credits from archived contracts\n- Performance considerations:\n    - `include_ledgers`: Adds detailed transaction history (slower)\n    - `include_balance`: Adds current balance calculation (slower)\n- Optional filtering: Use credit_id to retrieve a specific commit\n',
   inputSchema: {
     type: 'object',
     properties: {
@@ -75,7 +76,8 @@ export const tool: Tool = {
 
 export const handler = async (client: Metronome, args: Record<string, unknown> | undefined) => {
   const body = args as any;
-  return asTextContentResult(await client.v1.customers.credits.list(body));
+  const response = await client.v1.customers.credits.list(body).asResponse();
+  return asTextContentResult(await response.json());
 };
 
 export default { metadata, tool, handler };

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\nPull forward the end date of a credit. Use the \"edit a credit\" endpoint to extend the end date of a credit, or to make other edits to the credit.\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\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/list-breakdowns-customers-v1-invoices.ts

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_breakdowns_customers_v1_invoices',
   description:
-    'List daily or hourly invoice breakdowns for a given customer, optionally filtered by status, date range, and/or credit type.\nImportant considerations:\n- If we receive backdated usage after an invoice has been finalized, the backdated usage will be included in the response and usage numbers may differ.',
+    'Retrieve granular time-series breakdowns of invoice data at hourly or daily intervals. This endpoint transforms standard invoices into detailed timelines, enabling you to track usage patterns, identify consumption spikes, and provide customers with transparency into their billing details throughout the billing period.\n\n### Use this endpoint to:\n- Build usage analytics dashboards showing daily or hourly consumption trends\n- Identify peak usage periods for capacity planning and cost optimization\n- Generate detailed billing reports for finance teams and customer success\n- Troubleshoot billing disputes by examining usage patterns at specific times\n- Power real-time cost monitoring and alerting systems\n\n### Key response fields:\nAn array of BreakdownInvoice objects, each containing:\n- All standard invoice fields (ID, customer, commit, line items, totals, status)\n- Line items with quantities and costs for that specific period\n- `breakdown_start_timestamp`: Start of the specific time window\n- `breakdown_end_timestamp`: End of the specific time window\n- `next_page`: Pagination cursor for large result sets\n\n### Usage guidelines:\n- Time granularity: Set `window_size` to hour or day based on your analysis needs\n- Response limits: Daily breakdowns return up to 35 days; hourly breakdowns return up to 24 hours per request\n- Date filtering: Use `starting_on` and `ending_before` to focus on specific periods\n- Performance: For large date ranges, use pagination to retrieve all data efficiently\n- Backdated usage: If usage events arrive after invoice finalization, breakdowns will reflect the updated usage\n- Zero quantity filtering: Use `skip_zero_qty_line_items=true` to exclude periods with no usage',
   inputSchema: {
     type: 'object',
     properties: {

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

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_customers_v1_invoices',
   description:
-    'List all invoices for a given customer, optionally filtered by status, date range, and/or credit type.',
+    "Retrieves a paginated list of invoices for a specific customer, with flexible filtering options to narrow results by status, date range, credit type, and more. This endpoint provides a comprehensive view of a customer's billing history and current charges, supporting both real-time billing dashboards and historical reporting needs.\n\n### Use this endpoint to:\n- Display historical invoice details in customer-facing dashboards or billing portals.\n- Retrieve current month draft invoices to show customers their month-to-date spend.\n- Access finalized invoices for historical billing records and payment reconciliation.\n- Validate customer pricing and credit applications for customer support queries. \n- Generate financial reports by filtering invoices within specific date ranges\n\n### Key response fields:\nArray of invoice objects containing:\n- Invoice ID and status (DRAFT, FINALIZED, VOID)\n- Invoice type (USAGE, SCHEDULED)\n- Billing period start and end dates\n- Issue date and due date\n- Total amount, subtotal, and amount due\n- Applied credits summary\n- Contract ID reference\n- External billing provider status (if integrated with Stripe, etc.)\n- Pagination metadata `next_page` cursor\n\n### Usage guidelines:\n- The endpoint returns invoice summaries; use the Get Invoice endpoint for detailed line items\n- Draft invoices are continuously updated as new usage is reported and will show real-time spend\n- Results are ordered by creation date descending by default (newest first)\n- When filtering by date range, the filter applies to the billing period, not the issue date\n- For customers with many invoices, implement pagination to ensure all results are retrieved\nExternal billing provider statuses (like Stripe payment status) are included when applicable\n- Voided invoices are included in results by default unless filtered out by status\n",
   inputSchema: {
     type: 'object',
     properties: {

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

@@ -16,7 +16,8 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'retrieve_customers_v1_invoices',
-  description: 'Fetch a specific invoice for a given customer.',
+  description:
+    'Retrieve detailed information for a specific invoice by its unique identifier. This endpoint returns comprehensive invoice data including line items, applied credits, totals, and billing period details for both finalized and draft invoices.\n\n### Use this endpoint to:\n- Display historical invoice details in customer-facing dashboards or billing portals.\n- Retrieve current month draft invoices to show customers their month-to-date spend.\n- Access finalized invoices for historical billing records and payment reconciliation.\n- Validate customer pricing and credit applications for customer support queries. \n\n### Key response fields: \nInvoice status (DRAFT, FINALIZED, VOID)\nBilling period start and end dates\nTotal amount and amount due after credits\nDetailed line items broken down by:\n- Customer and contract information\n- Invoice line item type\n- Product/service name and ID\n- Quantity consumed\n- Unit and total price \n- Time period for usage-based charges\n- Applied credits or prepaid commitments\n\n\n### Usage guidelines:\n- Draft invoices update in real-time as usage is reported and may change before finalization\n- The response includes both usage-based line items (e.g., API calls, data processed) and scheduled charges (e.g., monthly subscriptions, commitment fees)\n- Credit and commitment applications are shown as separate line items with negative amounts\n- For voided invoices, the response will indicate VOID status but retain all original line item details\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 for a given customer.\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            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.\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\nList all customers.\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          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.\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.\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: {

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

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_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\nList the given customer's plans in reverse-chronological order.\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            description: 'the ID of the customer plan'\n          },\n          custom_fields: {\n            type: 'object',\n            additionalProperties: true\n          },\n          plan_description: {\n            type: 'string'\n          },\n          plan_id: {\n            type: 'string',\n            description: 'the ID of the plan'\n          },\n          plan_name: {\n            type: 'string'\n          },\n          starting_on: {\n            type: 'string',\n            format: 'date-time'\n          },\n          ending_before: {\n            type: 'string',\n            format: 'date-time'\n          },\n          net_payment_terms_days: {\n            type: 'number'\n          },\n          trial_info: {\n            type: 'object',\n            properties: {\n              ending_before: {\n                type: 'string',\n                format: 'date-time'\n              },\n              spending_caps: {\n                type: 'array',\n                items: {\n                  type: 'object',\n                  properties: {\n                    amount: {\n                      type: 'number'\n                    },\n                    amount_remaining: {\n                      type: 'number'\n                    },\n                    credit_type: {\n                      $ref: '#/$defs/credit_type_data'\n                    }\n                  },\n                  required: [                    'amount',\n                    'amount_remaining',\n                    'credit_type'\n                  ]\n                }\n              }\n            },\n            required: [              'ending_before',\n              'spending_caps'\n            ]\n          }\n        },\n        required: [          'id',\n          'custom_fields',\n          'plan_description',\n          'plan_id',\n          'plan_name',\n          'starting_on'\n        ]\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\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\nList the given customer's plans in reverse-chronological order.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/plan_list_response'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    plan_list_response: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'the ID of the customer plan'\n        },\n        custom_fields: {\n          type: 'object',\n          description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n          additionalProperties: true\n        },\n        plan_description: {\n          type: 'string'\n        },\n        plan_id: {\n          type: 'string',\n          description: 'the ID of the plan'\n        },\n        plan_name: {\n          type: 'string'\n        },\n        starting_on: {\n          type: 'string',\n          format: 'date-time'\n        },\n        ending_before: {\n          type: 'string',\n          format: 'date-time'\n        },\n        net_payment_terms_days: {\n          type: 'number'\n        },\n        trial_info: {\n          type: 'object',\n          properties: {\n            ending_before: {\n              type: 'string',\n              format: 'date-time'\n            },\n            spending_caps: {\n              type: 'array',\n              items: {\n                type: 'object',\n                properties: {\n                  amount: {\n                    type: 'number'\n                  },\n                  amount_remaining: {\n                    type: 'number'\n                  },\n                  credit_type: {\n                    $ref: '#/$defs/credit_type_data'\n                  }\n                },\n                required: [                  'amount',\n                  'amount_remaining',\n                  'credit_type'\n                ]\n              }\n            }\n          },\n          required: [            'ending_before',\n            'spending_caps'\n          ]\n        }\n      },\n      required: [        'id',\n        'custom_fields',\n        'plan_description',\n        'plan_id',\n        'plan_name',\n        'starting_on'\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: {

package/src/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_price_adjustments_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\nLists a customer plans adjustments. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details.\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          charge_id: {\n            type: 'string'\n          },\n          charge_type: {\n            type: 'string',\n            enum: [              'usage',\n              'fixed',\n              'composite',\n              'minimum',\n              'seat'\n            ]\n          },\n          prices: {\n            type: 'array',\n            items: {\n              type: 'object',\n              properties: {\n                adjustment_type: {\n                  type: 'string',\n                  description: 'Determines how the value will be applied.',\n                  enum: [                    'fixed',\n                    'quantity',\n                    'percentage',\n                    'override'\n                  ]\n                },\n                tier: {\n                  type: 'number',\n                  description: 'Used in pricing tiers.  Indicates at what metric value the price applies.'\n                },\n                value: {\n                  type: 'number'\n                }\n              },\n              required: [                'adjustment_type'\n              ]\n            }\n          },\n          start_period: {\n            type: 'number'\n          },\n          quantity: {\n            type: 'number'\n          }\n        },\n        required: [          'charge_id',\n          'charge_type',\n          'prices',\n          'start_period'\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\nLists a customer plans adjustments. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/plan_list_price_adjustments_response'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    plan_list_price_adjustments_response: {\n      type: 'object',\n      properties: {\n        charge_id: {\n          type: 'string'\n        },\n        charge_type: {\n          type: 'string',\n          enum: [            'usage',\n            'fixed',\n            'composite',\n            'minimum',\n            'seat'\n          ]\n        },\n        prices: {\n          type: 'array',\n          items: {\n            type: 'object',\n            properties: {\n              adjustment_type: {\n                type: 'string',\n                description: 'Determines how the value will be applied.',\n                enum: [                  'fixed',\n                  'quantity',\n                  'percentage',\n                  'override'\n                ]\n              },\n              tier: {\n                type: 'number',\n                description: 'Used in pricing tiers.  Indicates at what metric value the price applies.'\n              },\n              value: {\n                type: 'number'\n              }\n            },\n            required: [              'adjustment_type'\n            ]\n          }\n        },\n        start_period: {\n          type: 'number'\n        },\n        quantity: {\n          type: 'number'\n        }\n      },\n      required: [        'charge_id',\n        'charge_type',\n        'prices',\n        'start_period'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {