@metronome/mcp 0.3.0 → 2.0.0

package/src/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'update_contracts_v1_rate_cards',
   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\nUpdate a rate card\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\nUpdate the metadata properties of an existing rate card, including its name, description, and aliases. This endpoint is designed for managing rate card identity and reference aliases rather than modifying pricing rates.\n\nModifies the descriptive properties and alias configuration of a rate card without affecting the underlying pricing rates or schedules. This allows you to update how a rate card is identified and referenced throughout your system.\n\n### Use this endpoint to:\n- Rate card renaming: Update display names or descriptions for organizational clarity\n- Alias management: Add, modify, or schedule alias transitions for seamless rate card migrations\n- Documentation updates: Keep rate card descriptions current with business context\n- Self-serve provisioning setup: Configure aliases to enable code-free rate card transitions\n\n#### Active contract impact:\n- Alias changes: Already-created contracts continue using their originally assigned rate cards.\n- Other changes made using this endpoint will only impact the Metronome UI.\n\n#### Grandfathering existing PLG customer pricing:\n- Rate card aliases support scheduled transitions, enabling seamless rate card migrations for new customers, allowing existing customers to be grandfathered into their existing prices without code. Note that there are multiple mechanisms to support grandfathering in Metronome. \n\n#### How scheduled aliases work for PLG grandfathering:\nInitial setup:\n- Add alias to current rate card: Assign a stable alias (e.g., \"standard-pricing\") to your active rate card\n- Reference alias during contract creation: Configure your self-serve workflow to create contracts using `rate_card_alias` instead of direct `rate_card_id`\n- Automatic resolution: New contracts referencing the alias automatically resolve to the rate card associated with the alias at the point in time of provisioning\n\n#### Grandfathering process:\n- Create new rate card: Build your new rate card with updated pricing structure\n- Schedule alias transition: Add the same alias to the new rate card with a `starting_at` timestamp\n- Automatic cutover: Starting at the scheduled time, new contracts created in your PLG workflow using that alias will automatically reference the new rate card\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/rate_card_update_response',\n  $defs: {\n    rate_card_update_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/contracts/retrieve-rate-schedule-v1-contracts.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'retrieve_rate_schedule_v1_contracts',
   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 the rate schedule for the rate card on a given contract.\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          entitled: {\n            type: 'boolean'\n          },\n          list_rate: {\n            $ref: '#/$defs/rate'\n          },\n          product_custom_fields: {\n            type: 'object',\n            additionalProperties: true\n          },\n          product_id: {\n            type: 'string'\n          },\n          product_name: {\n            type: 'string'\n          },\n          product_tags: {\n            type: 'array',\n            items: {\n              type: 'string'\n            }\n          },\n          rate_card_id: {\n            type: 'string'\n          },\n          starting_at: {\n            type: 'string',\n            format: 'date-time'\n          },\n          billing_frequency: {\n            type: 'string',\n            enum: [              'MONTHLY',\n              'QUARTERLY',\n              'ANNUAL',\n              'WEEKLY'\n            ]\n          },\n          commit_rate: {\n            type: 'object',\n            description: 'A distinct rate on the rate card. You can choose to use this rate rather than list rate when consuming a credit or commit.',\n            properties: {\n              rate_type: {\n                type: 'string',\n                enum: [                  'FLAT',\n                  'PERCENTAGE',\n                  'SUBSCRIPTION',\n                  'TIERED',\n                  'CUSTOM'\n                ]\n              },\n              price: {\n                type: 'number',\n                description: 'Commit rate price. For FLAT rate_type, this must be >=0.'\n              },\n              tiers: {\n                type: 'array',\n                description: 'Only set for TIERED rate_type.',\n                items: {\n                  $ref: '#/$defs/tier'\n                }\n              }\n            },\n            required: [              'rate_type'\n            ]\n          },\n          ending_before: {\n            type: 'string',\n            format: 'date-time'\n          },\n          override_rate: {\n            $ref: '#/$defs/rate'\n          },\n          pricing_group_values: {\n            type: 'object',\n            additionalProperties: true\n          }\n        },\n        required: [          'entitled',\n          'list_rate',\n          'product_custom_fields',\n          'product_id',\n          'product_name',\n          'product_tags',\n          'rate_card_id',\n          'starting_at'\n        ]\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data'\n  ],\n  $defs: {\n    rate: {\n      type: 'object',\n      properties: {\n        rate_type: {\n          type: 'string',\n          enum: [            'FLAT',\n            'PERCENTAGE',\n            'SUBSCRIPTION',\n            'CUSTOM',\n            'TIERED'\n          ]\n        },\n        credit_type: {\n          $ref: '#/$defs/credit_type_data'\n        },\n        custom_rate: {\n          type: 'object',\n          description: 'Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.',\n          additionalProperties: true\n        },\n        is_prorated: {\n          type: 'boolean',\n          description: 'Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.'\n        },\n        price: {\n          type: 'number',\n          description: 'Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.'\n        },\n        pricing_group_values: {\n          type: 'object',\n          description: 'if pricing groups are used, this will contain the values used to calculate the price',\n          additionalProperties: true\n        },\n        quantity: {\n          type: 'number',\n          description: 'Default quantity. For SUBSCRIPTION rate_type, this must be >=0.'\n        },\n        tiers: {\n          type: 'array',\n          description: 'Only set for TIERED rate_type.',\n          items: {\n            $ref: '#/$defs/tier'\n          }\n        },\n        use_list_prices: {\n          type: 'boolean',\n          description: 'Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed using list prices rather than the standard rates for this product on the contract.'\n        }\n      },\n      required: [        'rate_type'\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    tier: {\n      type: 'object',\n      properties: {\n        price: {\n          type: 'number'\n        },\n        size: {\n          type: 'number'\n        }\n      },\n      required: [        'price'\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\nFor a specific customer and contract, get the rates at a specific point in time. This endpoint takes the contract's rate card into consideration, including scheduled changes. It also takes into account overrides on the contract. \n\nFor example, if you want to show your customer a summary of the prices they are paying, inclusive of any negotiated discounts or promotions, use this endpoint. This endpoint only returns rates that are entitled.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/contract_retrieve_rate_schedule_response',\n  $defs: {\n    contract_retrieve_rate_schedule_response: {\n      type: 'object',\n      properties: {\n        data: {\n          type: 'array',\n          items: {\n            type: 'object',\n            properties: {\n              entitled: {\n                type: 'boolean'\n              },\n              list_rate: {\n                $ref: '#/$defs/rate'\n              },\n              product_custom_fields: {\n                type: 'object',\n                description: 'Custom fields to be added eg. { \"key1\": \"value1\", \"key2\": \"value2\" }',\n                additionalProperties: true\n              },\n              product_id: {\n                type: 'string'\n              },\n              product_name: {\n                type: 'string'\n              },\n              product_tags: {\n                type: 'array',\n                items: {\n                  type: 'string'\n                }\n              },\n              rate_card_id: {\n                type: 'string'\n              },\n              starting_at: {\n                type: 'string',\n                format: 'date-time'\n              },\n              billing_frequency: {\n                type: 'string',\n                enum: [                  'MONTHLY',\n                  'QUARTERLY',\n                  'ANNUAL',\n                  'WEEKLY'\n                ]\n              },\n              commit_rate: {\n                $ref: '#/$defs/commit_rate'\n              },\n              ending_before: {\n                type: 'string',\n                format: 'date-time'\n              },\n              override_rate: {\n                $ref: '#/$defs/rate'\n              },\n              pricing_group_values: {\n                type: 'object',\n                additionalProperties: true\n              }\n            },\n            required: [              'entitled',\n              'list_rate',\n              'product_custom_fields',\n              'product_id',\n              'product_name',\n              'product_tags',\n              'rate_card_id',\n              'starting_at'\n            ]\n          }\n        },\n        next_page: {\n          type: 'string'\n        }\n      },\n      required: [        'data'\n      ]\n    },\n    rate: {\n      type: 'object',\n      properties: {\n        rate_type: {\n          type: 'string',\n          enum: [            'FLAT',\n            'PERCENTAGE',\n            'SUBSCRIPTION',\n            'CUSTOM',\n            'TIERED'\n          ]\n        },\n        credit_type: {\n          $ref: '#/$defs/credit_type_data'\n        },\n        custom_rate: {\n          type: 'object',\n          description: 'Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.',\n          additionalProperties: true\n        },\n        is_prorated: {\n          type: 'boolean',\n          description: 'Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.'\n        },\n        price: {\n          type: 'number',\n          description: 'Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.'\n        },\n        pricing_group_values: {\n          type: 'object',\n          description: 'if pricing groups are used, this will contain the values used to calculate the price',\n          additionalProperties: true\n        },\n        quantity: {\n          type: 'number',\n          description: 'Default quantity. For SUBSCRIPTION rate_type, this must be >=0.'\n        },\n        tiers: {\n          type: 'array',\n          description: 'Only set for TIERED rate_type.',\n          items: {\n            $ref: '#/$defs/tier'\n          }\n        },\n        use_list_prices: {\n          type: 'boolean',\n          description: 'Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed using list prices rather than the standard rates for this product on the contract.'\n        }\n      },\n      required: [        'rate_type'\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    tier: {\n      type: 'object',\n      properties: {\n        price: {\n          type: 'number'\n        },\n        size: {\n          type: 'number'\n        }\n      },\n      required: [        'price'\n      ]\n    },\n    commit_rate: {\n      type: 'object',\n      description: 'A distinct rate on the rate card. You can choose to use this rate rather than list rate when consuming a credit or commit.',\n      properties: {\n        rate_type: {\n          type: 'string',\n          enum: [            'FLAT',\n            'PERCENTAGE',\n            'SUBSCRIPTION',\n            'TIERED',\n            'CUSTOM'\n          ]\n        },\n        price: {\n          type: 'number',\n          description: 'Commit rate price. For FLAT rate_type, this must be >=0.'\n        },\n        tiers: {\n          type: 'array',\n          description: 'Only set for TIERED rate_type.',\n          items: {\n            $ref: '#/$defs/tier'\n          }\n        }\n      },\n      required: [        'rate_type'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'retrieve_subscription_quantity_history_v1_contracts',
   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 quantity and price for a subscription over time. End-point does not return future scheduled changes.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'object',\n      properties: {\n        fiat_credit_type_id: {\n          type: 'string'\n        },\n        history: {\n          type: 'array',\n          items: {\n            type: 'object',\n            properties: {\n              data: {\n                type: 'array',\n                items: {\n                  type: 'object',\n                  properties: {\n                    quantity: {\n                      type: 'number'\n                    },\n                    total: {\n                      type: 'number'\n                    },\n                    unit_price: {\n                      type: 'number'\n                    }\n                  },\n                  required: [                    'quantity',\n                    'total',\n                    'unit_price'\n                  ]\n                }\n              },\n              starting_at: {\n                type: 'string',\n                format: 'date-time'\n              }\n            },\n            required: [              'data',\n              'starting_at'\n            ]\n          }\n        },\n        subscription_id: {\n          type: 'string'\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 the history of subscription quantities and prices over time for a given `subscription_id`. This endpoint can be used to power an in-product experience where you show a customer their historical changes to seat count. Future changes are not included in this endpoint - use the `getContract` endpoint to view the future scheduled changes to a subscription's quantity. \n\nSubscriptions are used to model fixed recurring fees as well as seat-based recurring fees. To model changes to the number of seats in Metronome, you can increment or decrement the quantity on a subscription at any point in the past or future.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/contract_retrieve_subscription_quantity_history_response',\n  $defs: {\n    contract_retrieve_subscription_quantity_history_response: {\n      type: 'object',\n      properties: {\n        data: {\n          type: 'object',\n          properties: {\n            fiat_credit_type_id: {\n              type: 'string'\n            },\n            history: {\n              type: 'array',\n              items: {\n                type: 'object',\n                properties: {\n                  data: {\n                    type: 'array',\n                    items: {\n                      type: 'object',\n                      properties: {\n                        quantity: {\n                          type: 'number'\n                        },\n                        total: {\n                          type: 'number'\n                        },\n                        unit_price: {\n                          type: 'number'\n                        }\n                      },\n                      required: [                        'quantity',\n                        'total',\n                        'unit_price'\n                      ]\n                    }\n                  },\n                  starting_at: {\n                    type: 'string',\n                    format: 'date-time'\n                  }\n                },\n                required: [                  'data',\n                  'starting_at'\n                ]\n              }\n            },\n            subscription_id: {\n              type: 'string'\n            }\n          }\n        }\n      },\n      required: [        'data'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/contracts/set-usage-filter-v1-contracts.ts

@@ -16,7 +16,8 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'set_usage_filter_v1_contracts',
-  description: 'Set usage filter for a contract\n',
+  description:
+    'If a customer has multiple contracts with overlapping rates, the usage filter routes usage to the appropriate contract based on a predefined group key. \n\nAs an example, imagine you have a customer associated with two projects. Each project is associated with its own contract. You can create a usage filter with group key `project_id`\non each contract, and route usage for `project_1` to the first contract and `project_2` to the second contract. \n\n### Use this endpoint to:\n- Support enterprise contracting scenarios where multiple contracts are associated to the same customer with the same rates.\n- Update the usage filter associated with the contract over time. \n\n### Usage guidelines:\nTo use usage filters, the `group_key` must be defined on the billable metrics underlying the rate card on the contracts.\n',
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/contracts/update-end-date-v1-contracts.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'update_end_date_v1_contracts',
   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\nUpdate the end date of a contract\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\nUpdate or add an end date to a contract. Ending a contract early will impact draft usage statements, truncate any terms, and remove upcoming scheduled invoices. Moving the date into the future will only extend the contract length. Terms and scheduled invoices are not extended. In-advance subscriptions will not be extended. Use this if a contract's end date has changed or if a perpetual contract ends.\n\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/contract_update_end_date_response',\n  $defs: {\n    contract_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/credit-grants/create-v1-credit-grants.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'create_v1_credit_grants',
   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 grant\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\nCreate a new credit grant\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/credit_grant_create_response',\n  $defs: {\n    credit_grant_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/credit-grants/edit-v1-credit-grants.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'edit_v1_credit_grants',
   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\nEdit an existing credit grant\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\nEdit an existing credit grant\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/credit_grant_edit_response',\n  $defs: {\n    credit_grant_edit_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/credit-grants/list-entries-v1-credit-grants.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_entries_v1_credit_grants',
   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\nFetches a list of credit ledger entries. Returns lists of ledgers per customer. Ledger entries are returned in chronological order. Ledger entries associated with voided credit grants are not included.\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          customer_id: {\n            type: 'string'\n          },\n          ledgers: {\n            type: 'array',\n            items: {\n              type: 'object',\n              properties: {\n                credit_type: {\n                  $ref: '#/$defs/credit_type_data'\n                },\n                ending_balance: {\n                  type: 'object',\n                  description: 'the effective balances at the end of the specified time window',\n                  properties: {\n                    effective_at: {\n                      type: 'string',\n                      description: 'the ending_before request parameter (if supplied) or the current billing period\\'s end date',\n                      format: 'date-time'\n                    },\n                    excluding_pending: {\n                      type: 'number',\n                      description: 'the ending balance, including the balance of all grants that have not expired before the effective_at date and deductions that happened before the effective_at date'\n                    },\n                    including_pending: {\n                      type: 'number',\n                      description: 'the excluding_pending balance plus any pending invoice deductions and expirations that will happen by the effective_at date'\n                    }\n                  },\n                  required: [                    'effective_at',\n                    'excluding_pending',\n                    'including_pending'\n                  ]\n                },\n                entries: {\n                  type: 'array',\n                  items: {\n                    $ref: '#/$defs/credit_ledger_entry'\n                  }\n                },\n                pending_entries: {\n                  type: 'array',\n                  items: {\n                    $ref: '#/$defs/credit_ledger_entry'\n                  }\n                },\n                starting_balance: {\n                  type: 'object',\n                  properties: {\n                    effective_at: {\n                      type: 'string',\n                      description: 'the starting_on request parameter (if supplied) or the first credit grant\\'s effective_at date',\n                      format: 'date-time'\n                    },\n                    excluding_pending: {\n                      type: 'number',\n                      description: 'the starting balance, including all posted grants, deductions, and expirations that happened at or before the effective_at timestamp'\n                    },\n                    including_pending: {\n                      type: 'number',\n                      description: 'the excluding_pending balance plus any pending activity that has not been posted at the time of the query'\n                    }\n                  },\n                  required: [                    'effective_at',\n                    'excluding_pending',\n                    'including_pending'\n                  ]\n                }\n              },\n              required: [                'credit_type',\n                'ending_balance',\n                'entries',\n                'pending_entries',\n                'starting_balance'\n              ]\n            }\n          }\n        },\n        required: [          'customer_id',\n          'ledgers'\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    credit_ledger_entry: {\n      type: 'object',\n      properties: {\n        amount: {\n          type: 'number',\n          description: 'an amount representing the change to the customer\\'s credit balance'\n        },\n        created_by: {\n          type: 'string'\n        },\n        credit_grant_id: {\n          type: 'string',\n          description: 'the credit grant this entry is related to'\n        },\n        effective_at: {\n          type: 'string',\n          format: 'date-time'\n        },\n        reason: {\n          type: 'string'\n        },\n        running_balance: {\n          type: 'number',\n          description: 'the running balance for this credit type at the time of the ledger entry, including all preceding charges'\n        },\n        invoice_id: {\n          type: 'string',\n          description: 'if this entry is a deduction, the Metronome ID of the invoice where the credit deduction was consumed; if this entry is a grant, the Metronome ID of the invoice where the grant\\'s paid_amount was charged'\n        }\n      },\n      required: [        'amount',\n        'created_by',\n        'credit_grant_id',\n        'effective_at',\n        'reason',\n        'running_balance'\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\nFetches a list of credit ledger entries. Returns lists of ledgers per customer. Ledger entries are returned in chronological order. Ledger entries associated with voided credit grants are not included.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/credit_grant_list_entries_response'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    credit_grant_list_entries_response: {\n      type: 'object',\n      properties: {\n        customer_id: {\n          type: 'string'\n        },\n        ledgers: {\n          type: 'array',\n          items: {\n            type: 'object',\n            properties: {\n              credit_type: {\n                $ref: '#/$defs/credit_type_data'\n              },\n              ending_balance: {\n                type: 'object',\n                description: 'the effective balances at the end of the specified time window',\n                properties: {\n                  effective_at: {\n                    type: 'string',\n                    description: 'the ending_before request parameter (if supplied) or the current billing period\\'s end date',\n                    format: 'date-time'\n                  },\n                  excluding_pending: {\n                    type: 'number',\n                    description: 'the ending balance, including the balance of all grants that have not expired before the effective_at date and deductions that happened before the effective_at date'\n                  },\n                  including_pending: {\n                    type: 'number',\n                    description: 'the excluding_pending balance plus any pending invoice deductions and expirations that will happen by the effective_at date'\n                  }\n                },\n                required: [                  'effective_at',\n                  'excluding_pending',\n                  'including_pending'\n                ]\n              },\n              entries: {\n                type: 'array',\n                items: {\n                  $ref: '#/$defs/credit_ledger_entry'\n                }\n              },\n              pending_entries: {\n                type: 'array',\n                items: {\n                  $ref: '#/$defs/credit_ledger_entry'\n                }\n              },\n              starting_balance: {\n                type: 'object',\n                properties: {\n                  effective_at: {\n                    type: 'string',\n                    description: 'the starting_on request parameter (if supplied) or the first credit grant\\'s effective_at date',\n                    format: 'date-time'\n                  },\n                  excluding_pending: {\n                    type: 'number',\n                    description: 'the starting balance, including all posted grants, deductions, and expirations that happened at or before the effective_at timestamp'\n                  },\n                  including_pending: {\n                    type: 'number',\n                    description: 'the excluding_pending balance plus any pending activity that has not been posted at the time of the query'\n                  }\n                },\n                required: [                  'effective_at',\n                  'excluding_pending',\n                  'including_pending'\n                ]\n              }\n            },\n            required: [              'credit_type',\n              'ending_balance',\n              'entries',\n              'pending_entries',\n              'starting_balance'\n            ]\n          }\n        }\n      },\n      required: [        'customer_id',\n        'ledgers'\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    credit_ledger_entry: {\n      type: 'object',\n      properties: {\n        amount: {\n          type: 'number',\n          description: 'an amount representing the change to the customer\\'s credit balance'\n        },\n        created_by: {\n          type: 'string'\n        },\n        credit_grant_id: {\n          type: 'string',\n          description: 'the credit grant this entry is related to'\n        },\n        effective_at: {\n          type: 'string',\n          format: 'date-time'\n        },\n        reason: {\n          type: 'string'\n        },\n        running_balance: {\n          type: 'number',\n          description: 'the running balance for this credit type at the time of the ledger entry, including all preceding charges'\n        },\n        invoice_id: {\n          type: 'string',\n          description: 'if this entry is a deduction, the Metronome ID of the invoice where the credit deduction was consumed; if this entry is a grant, the Metronome ID of the invoice where the grant\\'s paid_amount was charged'\n        }\n      },\n      required: [        'amount',\n        'created_by',\n        'credit_grant_id',\n        'effective_at',\n        'reason',\n        'running_balance'\n      ]\n    }\n  }\n}\n```",
   inputSchema: {
     type: 'object',
     properties: {
@@ -72,7 +72,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.creditGrants.listEntries(body)));
+  const response = await client.v1.creditGrants.listEntries(body).asResponse();
+  return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/credit-grants/list-v1-credit-grants.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'list_v1_credit_grants',
   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 credit grants. This list does not included voided grants.\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 Metronome ID of the credit grant'\n          },\n          balance: {\n            type: 'object',\n            description: 'The effective balance of the grant as of the end of the customer\\'s current billing period. Expiration deductions will be included only if the grant expires before the end of the current billing period.',\n            properties: {\n              effective_at: {\n                type: 'string',\n                description: 'The end_date of the customer\\'s current billing period.',\n                format: 'date-time'\n              },\n              excluding_pending: {\n                type: 'number',\n                description: 'The grant\\'s current balance including all posted deductions. If the grant has expired, this amount will be 0.'\n              },\n              including_pending: {\n                type: 'number',\n                description: 'The grant\\'s current balance including all posted and pending deductions. If the grant expires before the end of the customer\\'s current billing period, this amount will be 0.'\n              }\n            },\n            required: [              'effective_at',\n              'excluding_pending',\n              'including_pending'\n            ]\n          },\n          custom_fields: {\n            type: 'object',\n            additionalProperties: true\n          },\n          customer_id: {\n            type: 'string',\n            description: 'the Metronome ID of the customer'\n          },\n          deductions: {\n            type: 'array',\n            items: {\n              $ref: '#/$defs/credit_ledger_entry'\n            }\n          },\n          effective_at: {\n            type: 'string',\n            format: 'date-time'\n          },\n          expires_at: {\n            type: 'string',\n            format: 'date-time'\n          },\n          grant_amount: {\n            type: 'object',\n            description: 'the amount of credits initially granted',\n            properties: {\n              amount: {\n                type: 'number'\n              },\n              credit_type: {\n                $ref: '#/$defs/credit_type_data'\n              }\n            },\n            required: [              'amount',\n              'credit_type'\n            ]\n          },\n          name: {\n            type: 'string'\n          },\n          paid_amount: {\n            type: 'object',\n            description: 'the amount paid for this credit grant',\n            properties: {\n              amount: {\n                type: 'number'\n              },\n              credit_type: {\n                $ref: '#/$defs/credit_type_data'\n              }\n            },\n            required: [              'amount',\n              'credit_type'\n            ]\n          },\n          pending_deductions: {\n            type: 'array',\n            items: {\n              $ref: '#/$defs/credit_ledger_entry'\n            }\n          },\n          priority: {\n            type: 'number'\n          },\n          credit_grant_type: {\n            type: 'string'\n          },\n          invoice_id: {\n            type: 'string',\n            description: 'the Metronome ID of the invoice with the purchase charge for this credit grant, if applicable'\n          },\n          products: {\n            type: 'array',\n            description: 'The products which these credits will be applied to. (If unspecified, the credits will be applied to charges for all products.)',\n            items: {\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          reason: {\n            type: 'string'\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          'balance',\n          'custom_fields',\n          'customer_id',\n          'deductions',\n          'effective_at',\n          'expires_at',\n          'grant_amount',\n          'name',\n          'paid_amount',\n          'pending_deductions',\n          'priority'\n        ]\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    credit_ledger_entry: {\n      type: 'object',\n      properties: {\n        amount: {\n          type: 'number',\n          description: 'an amount representing the change to the customer\\'s credit balance'\n        },\n        created_by: {\n          type: 'string'\n        },\n        credit_grant_id: {\n          type: 'string',\n          description: 'the credit grant this entry is related to'\n        },\n        effective_at: {\n          type: 'string',\n          format: 'date-time'\n        },\n        reason: {\n          type: 'string'\n        },\n        running_balance: {\n          type: 'number',\n          description: 'the running balance for this credit type at the time of the ledger entry, including all preceding charges'\n        },\n        invoice_id: {\n          type: 'string',\n          description: 'if this entry is a deduction, the Metronome ID of the invoice where the credit deduction was consumed; if this entry is a grant, the Metronome ID of the invoice where the grant\\'s paid_amount was charged'\n        }\n      },\n      required: [        'amount',\n        'created_by',\n        'credit_grant_id',\n        'effective_at',\n        'reason',\n        'running_balance'\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\nList credit grants. This list does not included voided grants.\n\n# Response Schema\n```json\n{\n  type: 'object',\n  properties: {\n    data: {\n      type: 'array',\n      items: {\n        $ref: '#/$defs/credit_grant_list_response'\n      }\n    },\n    next_page: {\n      type: 'string'\n    }\n  },\n  required: [    'data',\n    'next_page'\n  ],\n  $defs: {\n    credit_grant_list_response: {\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'the Metronome ID of the credit grant'\n        },\n        balance: {\n          type: 'object',\n          description: 'The effective balance of the grant as of the end of the customer\\'s current billing period. Expiration deductions will be included only if the grant expires before the end of the current billing period.',\n          properties: {\n            effective_at: {\n              type: 'string',\n              description: 'The end_date of the customer\\'s current billing period.',\n              format: 'date-time'\n            },\n            excluding_pending: {\n              type: 'number',\n              description: 'The grant\\'s current balance including all posted deductions. If the grant has expired, this amount will be 0.'\n            },\n            including_pending: {\n              type: 'number',\n              description: 'The grant\\'s current balance including all posted and pending deductions. If the grant expires before the end of the customer\\'s current billing period, this amount will be 0.'\n            }\n          },\n          required: [            'effective_at',\n            'excluding_pending',\n            'including_pending'\n          ]\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_id: {\n          type: 'string',\n          description: 'the Metronome ID of the customer'\n        },\n        deductions: {\n          type: 'array',\n          items: {\n            $ref: '#/$defs/credit_ledger_entry'\n          }\n        },\n        effective_at: {\n          type: 'string',\n          format: 'date-time'\n        },\n        expires_at: {\n          type: 'string',\n          format: 'date-time'\n        },\n        grant_amount: {\n          type: 'object',\n          description: 'the amount of credits initially granted',\n          properties: {\n            amount: {\n              type: 'number'\n            },\n            credit_type: {\n              $ref: '#/$defs/credit_type_data'\n            }\n          },\n          required: [            'amount',\n            'credit_type'\n          ]\n        },\n        name: {\n          type: 'string'\n        },\n        paid_amount: {\n          type: 'object',\n          description: 'the amount paid for this credit grant',\n          properties: {\n            amount: {\n              type: 'number'\n            },\n            credit_type: {\n              $ref: '#/$defs/credit_type_data'\n            }\n          },\n          required: [            'amount',\n            'credit_type'\n          ]\n        },\n        pending_deductions: {\n          type: 'array',\n          items: {\n            $ref: '#/$defs/credit_ledger_entry'\n          }\n        },\n        priority: {\n          type: 'number'\n        },\n        credit_grant_type: {\n          type: 'string'\n        },\n        invoice_id: {\n          type: 'string',\n          description: 'the Metronome ID of the invoice with the purchase charge for this credit grant, if applicable'\n        },\n        products: {\n          type: 'array',\n          description: 'The products which these credits will be applied to. (If unspecified, the credits will be applied to charges for all products.)',\n          items: {\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        reason: {\n          type: 'string'\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        'balance',\n        'custom_fields',\n        'customer_id',\n        'deductions',\n        'effective_at',\n        'expires_at',\n        'grant_amount',\n        'name',\n        'paid_amount',\n        'pending_deductions',\n        'priority'\n      ]\n    },\n    credit_ledger_entry: {\n      type: 'object',\n      properties: {\n        amount: {\n          type: 'number',\n          description: 'an amount representing the change to the customer\\'s credit balance'\n        },\n        created_by: {\n          type: 'string'\n        },\n        credit_grant_id: {\n          type: 'string',\n          description: 'the credit grant this entry is related to'\n        },\n        effective_at: {\n          type: 'string',\n          format: 'date-time'\n        },\n        reason: {\n          type: 'string'\n        },\n        running_balance: {\n          type: 'number',\n          description: 'the running balance for this credit type at the time of the ledger entry, including all preceding charges'\n        },\n        invoice_id: {\n          type: 'string',\n          description: 'if this entry is a deduction, the Metronome ID of the invoice where the credit deduction was consumed; if this entry is a grant, the Metronome ID of the invoice where the grant\\'s paid_amount was charged'\n        }\n      },\n      required: [        'amount',\n        'created_by',\n        'credit_grant_id',\n        'effective_at',\n        'reason',\n        'running_balance'\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/credit-grants/void-v1-credit-grants.ts

@@ -18,7 +18,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'void_v1_credit_grants',
   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\nVoid a credit grant\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\nVoid a credit grant\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/credit_grant_void_response',\n  $defs: {\n    credit_grant_void_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/custom-fields/add-key-v1-custom-fields.ts

@@ -17,7 +17,7 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'add_key_v1_custom_fields',
   description:
-    'Add a key to the allow list for a given entity. There is a 100 character limit on custom field keys.\n',
+    'Creates a new custom field key for a given entity (e.g. billable metric, contract, alert).\n\nCustom fields are properties that you can add to Metronome objects to store metadata like foreign keys or other descriptors. This metadata can get transferred to or accessed by other systems to contextualize Metronome data and power business processes. For example, to service workflows like revenue recognition, reconciliation, and invoicing, custom fields help Metronome know the relationship between entities in the platform and third-party systems.\n\n### Use this endpoint to:\n- Create a new custom field key for Customer objects in Metronome. You can then use the Set Custom Field Values endpoint to set the value of this key for a specific customer. \n- Specify whether the key should enforce uniqueness. If the key is set to enforce uniqueness and you attempt to set a custom field value for the key that already exists, it will fail. \n\n### Usage guidelines:\n- Custom fields set on commits, credits, and contracts can be used to scope alert evaluation. For example, you can create a spend threshold alert that only considers spend associated with contracts with custom field key `contract_type` and value `paygo`\n- Custom fields set on products can be used in the Stripe integration to set metadata on invoices.\n- Custom fields for customers, contracts, invoices, products, commits, scheduled charges, and subscriptions are passed down to the invoice.\n',
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/custom-fields/delete-values-v1-custom-fields.ts

@@ -16,7 +16,8 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'delete_values_v1_custom_fields',
-  description: 'Deletes one or more custom fields on an instance of a Metronome entity.\n',
+  description:
+    'Remove specific custom field values from a Metronome entity instance by specifying the field keys to delete. Use this endpoint to clean up unwanted custom field data while preserving other fields on the same entity. Requires the entity type, entity ID, and array of keys to remove.\n',
   inputSchema: {
     type: 'object',
     properties: {

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\nList all active custom field keys, optionally filtered by entity type.\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: {
@@ -67,7 +67,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.customFields.listKeys(body)));
+  const response = await client.v1.customFields.listKeys(body).asResponse();
+  return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
 };
 
 export default { metadata, tool, handler };

package/src/tools/v1/custom-fields/remove-key-v1-custom-fields.ts

@@ -16,7 +16,8 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'remove_key_v1_custom_fields',
-  description: 'Remove a key from the allow list for a given entity.\n',
+  description:
+    'Removes a custom field key from the allowlist for a specific entity type, preventing future use of that key across all instances of the entity. Existing values for this key on entity instances will no longer be accessible once the key is removed.\n',
   inputSchema: {
     type: 'object',
     properties: {

package/src/tools/v1/custom-fields/set-values-v1-custom-fields.ts

@@ -17,12 +17,13 @@ export const metadata: Metadata = {
 export const tool: Tool = {
   name: 'set_values_v1_custom_fields',
   description:
-    'Sets one or more custom fields on an instance of a Metronome entity. If a key/value pair passed in this request matches one already set on the entity, its value will be overwritten. Any key/value pairs that exist on the entity that do not match those passed in this request will remain untouched. This endpoint is transactional and will update all key/value pairs or no key/value pairs. Partial updates are not supported. There is a 200 character limit on custom field values.\n',
+    'Sets custom field values on a specific Metronome entity instance. Overwrites existing values for matching keys while preserving other fields. All updates are transactional—either all values are set or none are. Custom field values are limited to 200 characters each.\n',
   inputSchema: {
     type: 'object',
     properties: {
       custom_fields: {
         type: 'object',
+        description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
         additionalProperties: true,
       },
       entity: {

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\nFetch all customer alert statuses and alert information for a customer\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                  'value'\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                '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'],
@@ -52,7 +53,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.list(body)));
+  const response = await client.v1.customers.alerts.list(body).asResponse();
+  return asTextContentResult(await maybeFilter(jq_filter, await response.json()));
 };
 
 export default { metadata, tool, handler };

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

@@ -16,13 +16,14 @@ export const metadata: Metadata = {
 
 export const tool: Tool = {
   name: 'reset_customers_v1_alerts',
-  description: 'Reset state for an alert by customer id and force re-evaluation',
+  description:
+    '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,29 +17,42 @@ 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\nGet the customer alert status and alert information for the specified customer and alert\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                  'value'\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',
         description: 'The Metronome ID of the customer',
       },
-      plans_or_contracts: {
-        type: 'string',
+      group_values: {
+        type: 'array',
         description:
-          'When parallel alerts are enabled during migration, this flag denotes whether to fetch alerts for plans or contracts.',
-        enum: ['PLANS', 'CONTRACTS'],
+          'Only present for `spend_threshold_reached` notifications. Retrieve the notification for a specific group key-value pair.',
+        items: {
+          type: 'object',
+          description:
+            'Scopes threshold notification evaluation to a specific presentation group key on individual line items. Only present for spend notifications.',
+          properties: {
+            key: {
+              type: 'string',
+            },
+            value: {
+              type: 'string',
+            },
+          },
+          required: ['key', 'value'],
+        },
       },
-      jq_filter: {
+      plans_or_contracts: {
         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/).',
+          'When parallel threshold notifications are enabled during migration, this flag denotes whether to fetch notifications for plans or contracts.',
+        enum: ['PLANS', 'CONTRACTS'],
       },
     },
     required: ['alert_id', 'customer_id'],
@@ -49,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\nArchive a customer Note: any alerts associated with the customer will not 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

@@ -76,7 +76,12 @@ 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: ['customer_id', 'billing_provider_type', 'billing_provider_customer_id'],

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          ]\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.\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              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: {