@metronome/mcp 0.3.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (709) hide show
  1. package/README.md +1062 -76
  2. package/code-tool-paths.cjs +6 -0
  3. package/code-tool-paths.cjs.map +1 -0
  4. package/code-tool-paths.d.cts +2 -0
  5. package/code-tool-paths.d.cts.map +1 -0
  6. package/code-tool-types.d.mts +14 -0
  7. package/code-tool-types.d.mts.map +1 -0
  8. package/code-tool-types.d.ts +14 -0
  9. package/code-tool-types.d.ts.map +1 -0
  10. package/code-tool-types.js +4 -0
  11. package/code-tool-types.js.map +1 -0
  12. package/code-tool-types.mjs +3 -0
  13. package/code-tool-types.mjs.map +1 -0
  14. package/code-tool-worker.d.mts +5 -0
  15. package/code-tool-worker.d.mts.map +1 -0
  16. package/code-tool-worker.d.ts +5 -0
  17. package/code-tool-worker.d.ts.map +1 -0
  18. package/code-tool-worker.js +45 -0
  19. package/code-tool-worker.js.map +1 -0
  20. package/code-tool-worker.mjs +40 -0
  21. package/code-tool-worker.mjs.map +1 -0
  22. package/code-tool.d.mts +12 -0
  23. package/code-tool.d.mts.map +1 -0
  24. package/code-tool.d.ts +12 -0
  25. package/code-tool.d.ts.map +1 -0
  26. package/code-tool.js +158 -0
  27. package/code-tool.js.map +1 -0
  28. package/code-tool.mjs +122 -0
  29. package/code-tool.mjs.map +1 -0
  30. package/compat.d.mts +4 -2
  31. package/compat.d.mts.map +1 -1
  32. package/compat.d.ts +4 -2
  33. package/compat.d.ts.map +1 -1
  34. package/compat.js +3 -1
  35. package/compat.js.map +1 -1
  36. package/compat.mjs +2 -0
  37. package/compat.mjs.map +1 -1
  38. package/docs-search-tool.d.mts +44 -0
  39. package/docs-search-tool.d.mts.map +1 -0
  40. package/docs-search-tool.d.ts +44 -0
  41. package/docs-search-tool.d.ts.map +1 -0
  42. package/docs-search-tool.js +43 -0
  43. package/docs-search-tool.js.map +1 -0
  44. package/docs-search-tool.mjs +39 -0
  45. package/docs-search-tool.mjs.map +1 -0
  46. package/dynamic-tools.js +3 -3
  47. package/dynamic-tools.js.map +1 -1
  48. package/dynamic-tools.mjs +3 -3
  49. package/dynamic-tools.mjs.map +1 -1
  50. package/headers.d.mts +1 -1
  51. package/headers.d.mts.map +1 -1
  52. package/headers.d.ts +1 -1
  53. package/headers.d.ts.map +1 -1
  54. package/headers.js +1 -1
  55. package/headers.js.map +1 -1
  56. package/headers.mjs +1 -1
  57. package/headers.mjs.map +1 -1
  58. package/http.d.mts +6 -3
  59. package/http.d.mts.map +1 -1
  60. package/http.d.ts +6 -3
  61. package/http.d.ts.map +1 -1
  62. package/http.js +25 -10
  63. package/http.js.map +1 -1
  64. package/http.mjs +25 -10
  65. package/http.mjs.map +1 -1
  66. package/index.js +6 -6
  67. package/index.js.map +1 -1
  68. package/index.mjs +7 -7
  69. package/index.mjs.map +1 -1
  70. package/options.d.mts +9 -6
  71. package/options.d.mts.map +1 -1
  72. package/options.d.ts +9 -6
  73. package/options.d.ts.map +1 -1
  74. package/options.js +126 -16
  75. package/options.js.map +1 -1
  76. package/options.mjs +125 -16
  77. package/options.mjs.map +1 -1
  78. package/package.json +171 -10
  79. package/server.d.mts +3 -16
  80. package/server.d.mts.map +1 -1
  81. package/server.d.ts +3 -16
  82. package/server.d.ts.map +1 -1
  83. package/server.js +87 -25
  84. package/server.js.map +1 -1
  85. package/server.mjs +86 -24
  86. package/server.mjs.map +1 -1
  87. package/src/code-tool-paths.cts +3 -0
  88. package/src/code-tool-types.ts +14 -0
  89. package/src/code-tool-worker.ts +46 -0
  90. package/src/code-tool.ts +147 -0
  91. package/src/compat.ts +4 -2
  92. package/src/docs-search-tool.ts +48 -0
  93. package/src/dynamic-tools.ts +3 -3
  94. package/src/headers.ts +2 -3
  95. package/src/http.ts +54 -26
  96. package/src/index.ts +7 -7
  97. package/src/options.ts +147 -22
  98. package/src/server.ts +99 -36
  99. package/src/stdio.ts +3 -4
  100. package/src/tools/index.ts +12 -0
  101. package/src/tools/v1/alerts/archive-v1-alerts.ts +3 -3
  102. package/src/tools/v1/alerts/create-v1-alerts.ts +15 -14
  103. package/src/tools/v1/audit-logs/list-v1-audit-logs.ts +1 -1
  104. package/src/tools/v1/billable-metrics/archive-v1-billable-metrics.ts +1 -1
  105. package/src/tools/v1/billable-metrics/create-v1-billable-metrics.ts +1 -1
  106. package/src/tools/v1/billable-metrics/list-v1-billable-metrics.ts +1 -1
  107. package/src/tools/v1/billable-metrics/retrieve-v1-billable-metrics.ts +1 -1
  108. package/src/tools/v1/contracts/add-manual-balance-entry-v1-contracts.ts +2 -1
  109. package/src/tools/v1/contracts/amend-v1-contracts.ts +86 -143
  110. package/src/tools/v1/contracts/archive-v1-contracts.ts +1 -1
  111. package/src/tools/v1/contracts/create-historical-invoices-v1-contracts.ts +3 -1
  112. package/src/tools/v1/contracts/create-v1-contracts.ts +258 -517
  113. package/src/tools/v1/contracts/list-balances-v1-contracts.ts +4 -2
  114. package/src/tools/v1/contracts/list-v1-contracts.ts +1 -1
  115. package/src/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.ts +1 -1
  116. package/src/tools/v1/contracts/products/archive-contracts-v1-products.ts +1 -1
  117. package/src/tools/v1/contracts/products/create-contracts-v1-products.ts +2 -1
  118. package/src/tools/v1/contracts/products/list-contracts-v1-products.ts +1 -1
  119. package/src/tools/v1/contracts/products/retrieve-contracts-v1-products.ts +1 -1
  120. package/src/tools/v1/contracts/products/update-contracts-v1-products.ts +1 -1
  121. package/src/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.ts +1 -1
  122. package/src/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.ts +2 -1
  123. package/src/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.ts +1 -1
  124. package/src/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.ts +1 -1
  125. package/src/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.ts +1 -1
  126. package/src/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.ts +1 -1
  127. package/src/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.ts +25 -22
  128. package/src/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.ts +25 -22
  129. package/src/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.ts +1 -1
  130. package/src/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.ts +1 -1
  131. package/src/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.ts +1 -1
  132. package/src/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.ts +1 -1
  133. package/src/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.ts +1 -1
  134. package/src/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.ts +1 -1
  135. package/src/tools/v1/contracts/set-usage-filter-v1-contracts.ts +2 -1
  136. package/src/tools/v1/contracts/update-end-date-v1-contracts.ts +1 -1
  137. package/src/tools/v1/credit-grants/create-v1-credit-grants.ts +1 -1
  138. package/src/tools/v1/credit-grants/edit-v1-credit-grants.ts +1 -1
  139. package/src/tools/v1/credit-grants/list-entries-v1-credit-grants.ts +3 -2
  140. package/src/tools/v1/credit-grants/list-v1-credit-grants.ts +1 -1
  141. package/src/tools/v1/credit-grants/void-v1-credit-grants.ts +1 -1
  142. package/src/tools/v1/custom-fields/add-key-v1-custom-fields.ts +1 -1
  143. package/src/tools/v1/custom-fields/delete-values-v1-custom-fields.ts +2 -1
  144. package/src/tools/v1/custom-fields/list-keys-v1-custom-fields.ts +3 -2
  145. package/src/tools/v1/custom-fields/remove-key-v1-custom-fields.ts +2 -1
  146. package/src/tools/v1/custom-fields/set-values-v1-custom-fields.ts +2 -1
  147. package/src/tools/v1/customers/alerts/list-customers-v1-alerts.ts +5 -3
  148. package/src/tools/v1/customers/alerts/reset-customers-v1-alerts.ts +3 -2
  149. package/src/tools/v1/customers/alerts/retrieve-customers-v1-alerts.ts +24 -12
  150. package/src/tools/v1/customers/archive-v1-customers.ts +1 -1
  151. package/src/tools/v1/customers/billing-config/create-customers-v1-billing-config.ts +6 -1
  152. package/src/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.ts +1 -1
  153. package/src/tools/v1/customers/commits/create-customers-v1-commits.ts +32 -33
  154. package/src/tools/v1/customers/commits/list-customers-v1-commits.ts +4 -2
  155. package/src/tools/v1/customers/commits/update-end-date-customers-v1-commits.ts +1 -1
  156. package/src/tools/v1/customers/create-v1-customers.ts +14 -2
  157. package/src/tools/v1/customers/credits/create-customers-v1-credits.ts +30 -24
  158. package/src/tools/v1/customers/credits/list-customers-v1-credits.ts +4 -2
  159. package/src/tools/v1/customers/credits/update-end-date-customers-v1-credits.ts +1 -1
  160. package/src/tools/v1/customers/invoices/add-charge-customers-v1-invoices.ts +1 -1
  161. package/src/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.ts +1 -1
  162. package/src/tools/v1/customers/invoices/list-customers-v1-invoices.ts +1 -1
  163. package/src/tools/v1/customers/invoices/retrieve-customers-v1-invoices.ts +2 -1
  164. package/src/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.ts +43 -0
  165. package/src/tools/v1/customers/list-billable-metrics-v1-customers.ts +1 -1
  166. package/src/tools/v1/customers/list-costs-v1-customers.ts +1 -1
  167. package/src/tools/v1/customers/list-v1-customers.ts +1 -1
  168. package/src/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.ts +1 -1
  169. package/src/tools/v1/customers/plans/add-customers-v1-plans.ts +1 -1
  170. package/src/tools/v1/customers/plans/end-customers-v1-plans.ts +1 -1
  171. package/src/tools/v1/customers/plans/list-customers-v1-plans.ts +1 -1
  172. package/src/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.ts +1 -1
  173. package/src/tools/v1/customers/preview-events-v1-customers.ts +2 -7
  174. package/src/tools/v1/customers/retrieve-billing-configurations-v1-customers.ts +50 -0
  175. package/src/tools/v1/customers/retrieve-v1-customers.ts +1 -1
  176. package/src/tools/v1/customers/set-billing-configurations-v1-customers.ts +85 -0
  177. package/src/tools/v1/customers/set-ingest-aliases-v1-customers.ts +1 -1
  178. package/src/tools/v1/customers/set-name-v1-customers.ts +1 -1
  179. package/src/tools/v1/customers/update-config-v1-customers.ts +2 -1
  180. package/src/tools/v1/dashboards/get-embeddable-url-v1-dashboards.ts +1 -1
  181. package/src/tools/v1/invoices/regenerate-v1-invoices.ts +1 -1
  182. package/src/tools/v1/invoices/void-v1-invoices.ts +1 -1
  183. package/src/tools/v1/payments/attempt-v1-payments.ts +48 -0
  184. package/src/tools/v1/payments/cancel-v1-payments.ts +48 -0
  185. package/src/tools/v1/payments/list-v1-payments.ts +69 -0
  186. package/src/tools/v1/plans/get-details-v1-plans.ts +1 -1
  187. package/src/tools/v1/plans/list-charges-v1-plans.ts +1 -1
  188. package/src/tools/v1/plans/list-customers-v1-plans.ts +1 -1
  189. package/src/tools/v1/plans/list-v1-plans.ts +1 -1
  190. package/src/tools/v1/pricing-units/list-v1-pricing-units.ts +1 -1
  191. package/src/tools/v1/services/list-v1-services.ts +1 -1
  192. package/src/tools/v1/usage/ingest-v1-usage.ts +2 -2
  193. package/src/tools/v1/usage/list-v1-usage.ts +3 -2
  194. package/src/tools/v1/usage/list-with-groups-v1-usage.ts +1 -1
  195. package/src/tools/v1/usage/search-v1-usage.ts +1 -1
  196. package/src/tools/v2/contracts/edit-commit-v2-contracts.ts +84 -24
  197. package/src/tools/v2/contracts/edit-credit-v2-contracts.ts +84 -24
  198. package/src/tools/v2/contracts/edit-v2-contracts.ts +314 -782
  199. package/src/tools/v2/contracts/get-edit-history-v2-contracts.ts +1 -1
  200. package/src/tools/v2/contracts/list-v2-contracts.ts +1 -1
  201. package/src/tools/v2/contracts/retrieve-v2-contracts.ts +2 -1
  202. package/stdio.d.mts +1 -2
  203. package/stdio.d.mts.map +1 -1
  204. package/stdio.d.ts +1 -2
  205. package/stdio.d.ts.map +1 -1
  206. package/stdio.js +2 -2
  207. package/stdio.js.map +1 -1
  208. package/stdio.mjs +3 -3
  209. package/stdio.mjs.map +1 -1
  210. package/tools/index.d.mts.map +1 -1
  211. package/tools/index.d.ts.map +1 -1
  212. package/tools/index.js +12 -0
  213. package/tools/index.js.map +1 -1
  214. package/tools/index.mjs +12 -0
  215. package/tools/index.mjs.map +1 -1
  216. package/tools/v1/alerts/archive-v1-alerts.js +3 -3
  217. package/tools/v1/alerts/archive-v1-alerts.js.map +1 -1
  218. package/tools/v1/alerts/archive-v1-alerts.mjs +3 -3
  219. package/tools/v1/alerts/archive-v1-alerts.mjs.map +1 -1
  220. package/tools/v1/alerts/create-v1-alerts.d.mts.map +1 -1
  221. package/tools/v1/alerts/create-v1-alerts.d.ts.map +1 -1
  222. package/tools/v1/alerts/create-v1-alerts.js +14 -14
  223. package/tools/v1/alerts/create-v1-alerts.js.map +1 -1
  224. package/tools/v1/alerts/create-v1-alerts.mjs +14 -14
  225. package/tools/v1/alerts/create-v1-alerts.mjs.map +1 -1
  226. package/tools/v1/audit-logs/list-v1-audit-logs.js +1 -1
  227. package/tools/v1/audit-logs/list-v1-audit-logs.js.map +1 -1
  228. package/tools/v1/audit-logs/list-v1-audit-logs.mjs +1 -1
  229. package/tools/v1/audit-logs/list-v1-audit-logs.mjs.map +1 -1
  230. package/tools/v1/billable-metrics/archive-v1-billable-metrics.js +1 -1
  231. package/tools/v1/billable-metrics/archive-v1-billable-metrics.js.map +1 -1
  232. package/tools/v1/billable-metrics/archive-v1-billable-metrics.mjs +1 -1
  233. package/tools/v1/billable-metrics/archive-v1-billable-metrics.mjs.map +1 -1
  234. package/tools/v1/billable-metrics/create-v1-billable-metrics.js +1 -1
  235. package/tools/v1/billable-metrics/create-v1-billable-metrics.js.map +1 -1
  236. package/tools/v1/billable-metrics/create-v1-billable-metrics.mjs +1 -1
  237. package/tools/v1/billable-metrics/create-v1-billable-metrics.mjs.map +1 -1
  238. package/tools/v1/billable-metrics/list-v1-billable-metrics.js +1 -1
  239. package/tools/v1/billable-metrics/list-v1-billable-metrics.js.map +1 -1
  240. package/tools/v1/billable-metrics/list-v1-billable-metrics.mjs +1 -1
  241. package/tools/v1/billable-metrics/list-v1-billable-metrics.mjs.map +1 -1
  242. package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.js +1 -1
  243. package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.js.map +1 -1
  244. package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.mjs +1 -1
  245. package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.mjs.map +1 -1
  246. package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.d.mts.map +1 -1
  247. package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.d.ts.map +1 -1
  248. package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.js +1 -1
  249. package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.js.map +1 -1
  250. package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.mjs +1 -1
  251. package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.mjs.map +1 -1
  252. package/tools/v1/contracts/amend-v1-contracts.d.mts.map +1 -1
  253. package/tools/v1/contracts/amend-v1-contracts.d.ts.map +1 -1
  254. package/tools/v1/contracts/amend-v1-contracts.js +85 -139
  255. package/tools/v1/contracts/amend-v1-contracts.js.map +1 -1
  256. package/tools/v1/contracts/amend-v1-contracts.mjs +85 -139
  257. package/tools/v1/contracts/amend-v1-contracts.mjs.map +1 -1
  258. package/tools/v1/contracts/archive-v1-contracts.js +1 -1
  259. package/tools/v1/contracts/archive-v1-contracts.js.map +1 -1
  260. package/tools/v1/contracts/archive-v1-contracts.mjs +1 -1
  261. package/tools/v1/contracts/archive-v1-contracts.mjs.map +1 -1
  262. package/tools/v1/contracts/create-historical-invoices-v1-contracts.d.mts.map +1 -1
  263. package/tools/v1/contracts/create-historical-invoices-v1-contracts.d.ts.map +1 -1
  264. package/tools/v1/contracts/create-historical-invoices-v1-contracts.js +2 -1
  265. package/tools/v1/contracts/create-historical-invoices-v1-contracts.js.map +1 -1
  266. package/tools/v1/contracts/create-historical-invoices-v1-contracts.mjs +2 -1
  267. package/tools/v1/contracts/create-historical-invoices-v1-contracts.mjs.map +1 -1
  268. package/tools/v1/contracts/create-v1-contracts.d.mts.map +1 -1
  269. package/tools/v1/contracts/create-v1-contracts.d.ts.map +1 -1
  270. package/tools/v1/contracts/create-v1-contracts.js +241 -485
  271. package/tools/v1/contracts/create-v1-contracts.js.map +1 -1
  272. package/tools/v1/contracts/create-v1-contracts.mjs +241 -485
  273. package/tools/v1/contracts/create-v1-contracts.mjs.map +1 -1
  274. package/tools/v1/contracts/list-balances-v1-contracts.d.mts.map +1 -1
  275. package/tools/v1/contracts/list-balances-v1-contracts.d.ts.map +1 -1
  276. package/tools/v1/contracts/list-balances-v1-contracts.js +3 -2
  277. package/tools/v1/contracts/list-balances-v1-contracts.js.map +1 -1
  278. package/tools/v1/contracts/list-balances-v1-contracts.mjs +3 -2
  279. package/tools/v1/contracts/list-balances-v1-contracts.mjs.map +1 -1
  280. package/tools/v1/contracts/list-v1-contracts.js +1 -1
  281. package/tools/v1/contracts/list-v1-contracts.js.map +1 -1
  282. package/tools/v1/contracts/list-v1-contracts.mjs +1 -1
  283. package/tools/v1/contracts/list-v1-contracts.mjs.map +1 -1
  284. package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.js +1 -1
  285. package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.js.map +1 -1
  286. package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.mjs +1 -1
  287. package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.mjs.map +1 -1
  288. package/tools/v1/contracts/products/archive-contracts-v1-products.js +1 -1
  289. package/tools/v1/contracts/products/archive-contracts-v1-products.js.map +1 -1
  290. package/tools/v1/contracts/products/archive-contracts-v1-products.mjs +1 -1
  291. package/tools/v1/contracts/products/archive-contracts-v1-products.mjs.map +1 -1
  292. package/tools/v1/contracts/products/create-contracts-v1-products.d.mts.map +1 -1
  293. package/tools/v1/contracts/products/create-contracts-v1-products.d.ts.map +1 -1
  294. package/tools/v1/contracts/products/create-contracts-v1-products.js +2 -1
  295. package/tools/v1/contracts/products/create-contracts-v1-products.js.map +1 -1
  296. package/tools/v1/contracts/products/create-contracts-v1-products.mjs +2 -1
  297. package/tools/v1/contracts/products/create-contracts-v1-products.mjs.map +1 -1
  298. package/tools/v1/contracts/products/list-contracts-v1-products.js +1 -1
  299. package/tools/v1/contracts/products/list-contracts-v1-products.js.map +1 -1
  300. package/tools/v1/contracts/products/list-contracts-v1-products.mjs +1 -1
  301. package/tools/v1/contracts/products/list-contracts-v1-products.mjs.map +1 -1
  302. package/tools/v1/contracts/products/retrieve-contracts-v1-products.js +1 -1
  303. package/tools/v1/contracts/products/retrieve-contracts-v1-products.js.map +1 -1
  304. package/tools/v1/contracts/products/retrieve-contracts-v1-products.mjs +1 -1
  305. package/tools/v1/contracts/products/retrieve-contracts-v1-products.mjs.map +1 -1
  306. package/tools/v1/contracts/products/update-contracts-v1-products.js +1 -1
  307. package/tools/v1/contracts/products/update-contracts-v1-products.js.map +1 -1
  308. package/tools/v1/contracts/products/update-contracts-v1-products.mjs +1 -1
  309. package/tools/v1/contracts/products/update-contracts-v1-products.mjs.map +1 -1
  310. package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.js +1 -1
  311. package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.js.map +1 -1
  312. package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.mjs +1 -1
  313. package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.mjs.map +1 -1
  314. package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.d.mts.map +1 -1
  315. package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.d.ts.map +1 -1
  316. package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.js +2 -1
  317. package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.js.map +1 -1
  318. package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.mjs +2 -1
  319. package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.mjs.map +1 -1
  320. package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.js +1 -1
  321. package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.js.map +1 -1
  322. package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.mjs +1 -1
  323. package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.mjs.map +1 -1
  324. package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.js +1 -1
  325. package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.js.map +1 -1
  326. package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.mjs +1 -1
  327. package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.mjs.map +1 -1
  328. package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.js +1 -1
  329. package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.js.map +1 -1
  330. package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.mjs +1 -1
  331. package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.mjs.map +1 -1
  332. package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.js +1 -1
  333. package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.js.map +1 -1
  334. package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.mjs +1 -1
  335. package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.mjs.map +1 -1
  336. package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.d.mts.map +1 -1
  337. package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.d.ts.map +1 -1
  338. package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.js +24 -21
  339. package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.js.map +1 -1
  340. package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.mjs +24 -21
  341. package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.mjs.map +1 -1
  342. package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.d.mts.map +1 -1
  343. package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.d.ts.map +1 -1
  344. package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.js +24 -21
  345. package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.js.map +1 -1
  346. package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.mjs +24 -21
  347. package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.mjs.map +1 -1
  348. package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.js +1 -1
  349. package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.js.map +1 -1
  350. package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.mjs +1 -1
  351. package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.mjs.map +1 -1
  352. package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.js +1 -1
  353. package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.js.map +1 -1
  354. package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.mjs +1 -1
  355. package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.mjs.map +1 -1
  356. package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.js +1 -1
  357. package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.js.map +1 -1
  358. package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.mjs +1 -1
  359. package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.mjs.map +1 -1
  360. package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.js +1 -1
  361. package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.js.map +1 -1
  362. package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.mjs +1 -1
  363. package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.mjs.map +1 -1
  364. package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.js +1 -1
  365. package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.js.map +1 -1
  366. package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.mjs +1 -1
  367. package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.mjs.map +1 -1
  368. package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.js +1 -1
  369. package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.js.map +1 -1
  370. package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.mjs +1 -1
  371. package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.mjs.map +1 -1
  372. package/tools/v1/contracts/set-usage-filter-v1-contracts.d.mts.map +1 -1
  373. package/tools/v1/contracts/set-usage-filter-v1-contracts.d.ts.map +1 -1
  374. package/tools/v1/contracts/set-usage-filter-v1-contracts.js +1 -1
  375. package/tools/v1/contracts/set-usage-filter-v1-contracts.js.map +1 -1
  376. package/tools/v1/contracts/set-usage-filter-v1-contracts.mjs +1 -1
  377. package/tools/v1/contracts/set-usage-filter-v1-contracts.mjs.map +1 -1
  378. package/tools/v1/contracts/update-end-date-v1-contracts.js +1 -1
  379. package/tools/v1/contracts/update-end-date-v1-contracts.js.map +1 -1
  380. package/tools/v1/contracts/update-end-date-v1-contracts.mjs +1 -1
  381. package/tools/v1/contracts/update-end-date-v1-contracts.mjs.map +1 -1
  382. package/tools/v1/credit-grants/create-v1-credit-grants.js +1 -1
  383. package/tools/v1/credit-grants/create-v1-credit-grants.js.map +1 -1
  384. package/tools/v1/credit-grants/create-v1-credit-grants.mjs +1 -1
  385. package/tools/v1/credit-grants/create-v1-credit-grants.mjs.map +1 -1
  386. package/tools/v1/credit-grants/edit-v1-credit-grants.js +1 -1
  387. package/tools/v1/credit-grants/edit-v1-credit-grants.js.map +1 -1
  388. package/tools/v1/credit-grants/edit-v1-credit-grants.mjs +1 -1
  389. package/tools/v1/credit-grants/edit-v1-credit-grants.mjs.map +1 -1
  390. package/tools/v1/credit-grants/list-entries-v1-credit-grants.d.mts.map +1 -1
  391. package/tools/v1/credit-grants/list-entries-v1-credit-grants.d.ts.map +1 -1
  392. package/tools/v1/credit-grants/list-entries-v1-credit-grants.js +3 -2
  393. package/tools/v1/credit-grants/list-entries-v1-credit-grants.js.map +1 -1
  394. package/tools/v1/credit-grants/list-entries-v1-credit-grants.mjs +3 -2
  395. package/tools/v1/credit-grants/list-entries-v1-credit-grants.mjs.map +1 -1
  396. package/tools/v1/credit-grants/list-v1-credit-grants.js +1 -1
  397. package/tools/v1/credit-grants/list-v1-credit-grants.js.map +1 -1
  398. package/tools/v1/credit-grants/list-v1-credit-grants.mjs +1 -1
  399. package/tools/v1/credit-grants/list-v1-credit-grants.mjs.map +1 -1
  400. package/tools/v1/credit-grants/void-v1-credit-grants.js +1 -1
  401. package/tools/v1/credit-grants/void-v1-credit-grants.js.map +1 -1
  402. package/tools/v1/credit-grants/void-v1-credit-grants.mjs +1 -1
  403. package/tools/v1/credit-grants/void-v1-credit-grants.mjs.map +1 -1
  404. package/tools/v1/custom-fields/add-key-v1-custom-fields.js +1 -1
  405. package/tools/v1/custom-fields/add-key-v1-custom-fields.js.map +1 -1
  406. package/tools/v1/custom-fields/add-key-v1-custom-fields.mjs +1 -1
  407. package/tools/v1/custom-fields/add-key-v1-custom-fields.mjs.map +1 -1
  408. package/tools/v1/custom-fields/delete-values-v1-custom-fields.d.mts.map +1 -1
  409. package/tools/v1/custom-fields/delete-values-v1-custom-fields.d.ts.map +1 -1
  410. package/tools/v1/custom-fields/delete-values-v1-custom-fields.js +1 -1
  411. package/tools/v1/custom-fields/delete-values-v1-custom-fields.js.map +1 -1
  412. package/tools/v1/custom-fields/delete-values-v1-custom-fields.mjs +1 -1
  413. package/tools/v1/custom-fields/delete-values-v1-custom-fields.mjs.map +1 -1
  414. package/tools/v1/custom-fields/list-keys-v1-custom-fields.d.mts.map +1 -1
  415. package/tools/v1/custom-fields/list-keys-v1-custom-fields.d.ts.map +1 -1
  416. package/tools/v1/custom-fields/list-keys-v1-custom-fields.js +3 -2
  417. package/tools/v1/custom-fields/list-keys-v1-custom-fields.js.map +1 -1
  418. package/tools/v1/custom-fields/list-keys-v1-custom-fields.mjs +3 -2
  419. package/tools/v1/custom-fields/list-keys-v1-custom-fields.mjs.map +1 -1
  420. package/tools/v1/custom-fields/remove-key-v1-custom-fields.d.mts.map +1 -1
  421. package/tools/v1/custom-fields/remove-key-v1-custom-fields.d.ts.map +1 -1
  422. package/tools/v1/custom-fields/remove-key-v1-custom-fields.js +1 -1
  423. package/tools/v1/custom-fields/remove-key-v1-custom-fields.js.map +1 -1
  424. package/tools/v1/custom-fields/remove-key-v1-custom-fields.mjs +1 -1
  425. package/tools/v1/custom-fields/remove-key-v1-custom-fields.mjs.map +1 -1
  426. package/tools/v1/custom-fields/set-values-v1-custom-fields.d.mts.map +1 -1
  427. package/tools/v1/custom-fields/set-values-v1-custom-fields.d.ts.map +1 -1
  428. package/tools/v1/custom-fields/set-values-v1-custom-fields.js +2 -1
  429. package/tools/v1/custom-fields/set-values-v1-custom-fields.js.map +1 -1
  430. package/tools/v1/custom-fields/set-values-v1-custom-fields.mjs +2 -1
  431. package/tools/v1/custom-fields/set-values-v1-custom-fields.mjs.map +1 -1
  432. package/tools/v1/customers/alerts/list-customers-v1-alerts.d.mts.map +1 -1
  433. package/tools/v1/customers/alerts/list-customers-v1-alerts.d.ts.map +1 -1
  434. package/tools/v1/customers/alerts/list-customers-v1-alerts.js +4 -3
  435. package/tools/v1/customers/alerts/list-customers-v1-alerts.js.map +1 -1
  436. package/tools/v1/customers/alerts/list-customers-v1-alerts.mjs +4 -3
  437. package/tools/v1/customers/alerts/list-customers-v1-alerts.mjs.map +1 -1
  438. package/tools/v1/customers/alerts/reset-customers-v1-alerts.d.mts.map +1 -1
  439. package/tools/v1/customers/alerts/reset-customers-v1-alerts.d.ts.map +1 -1
  440. package/tools/v1/customers/alerts/reset-customers-v1-alerts.js +2 -2
  441. package/tools/v1/customers/alerts/reset-customers-v1-alerts.js.map +1 -1
  442. package/tools/v1/customers/alerts/reset-customers-v1-alerts.mjs +2 -2
  443. package/tools/v1/customers/alerts/reset-customers-v1-alerts.mjs.map +1 -1
  444. package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.d.mts.map +1 -1
  445. package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.d.ts.map +1 -1
  446. package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.js +22 -11
  447. package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.js.map +1 -1
  448. package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.mjs +22 -11
  449. package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.mjs.map +1 -1
  450. package/tools/v1/customers/archive-v1-customers.js +1 -1
  451. package/tools/v1/customers/archive-v1-customers.js.map +1 -1
  452. package/tools/v1/customers/archive-v1-customers.mjs +1 -1
  453. package/tools/v1/customers/archive-v1-customers.mjs.map +1 -1
  454. package/tools/v1/customers/billing-config/create-customers-v1-billing-config.d.mts.map +1 -1
  455. package/tools/v1/customers/billing-config/create-customers-v1-billing-config.d.ts.map +1 -1
  456. package/tools/v1/customers/billing-config/create-customers-v1-billing-config.js +6 -1
  457. package/tools/v1/customers/billing-config/create-customers-v1-billing-config.js.map +1 -1
  458. package/tools/v1/customers/billing-config/create-customers-v1-billing-config.mjs +6 -1
  459. package/tools/v1/customers/billing-config/create-customers-v1-billing-config.mjs.map +1 -1
  460. package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.js +1 -1
  461. package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.js.map +1 -1
  462. package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.mjs +1 -1
  463. package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.mjs.map +1 -1
  464. package/tools/v1/customers/commits/create-customers-v1-commits.d.mts.map +1 -1
  465. package/tools/v1/customers/commits/create-customers-v1-commits.d.ts.map +1 -1
  466. package/tools/v1/customers/commits/create-customers-v1-commits.js +31 -31
  467. package/tools/v1/customers/commits/create-customers-v1-commits.js.map +1 -1
  468. package/tools/v1/customers/commits/create-customers-v1-commits.mjs +31 -31
  469. package/tools/v1/customers/commits/create-customers-v1-commits.mjs.map +1 -1
  470. package/tools/v1/customers/commits/list-customers-v1-commits.d.mts.map +1 -1
  471. package/tools/v1/customers/commits/list-customers-v1-commits.d.ts.map +1 -1
  472. package/tools/v1/customers/commits/list-customers-v1-commits.js +3 -2
  473. package/tools/v1/customers/commits/list-customers-v1-commits.js.map +1 -1
  474. package/tools/v1/customers/commits/list-customers-v1-commits.mjs +3 -2
  475. package/tools/v1/customers/commits/list-customers-v1-commits.mjs.map +1 -1
  476. package/tools/v1/customers/commits/update-end-date-customers-v1-commits.js +1 -1
  477. package/tools/v1/customers/commits/update-end-date-customers-v1-commits.js.map +1 -1
  478. package/tools/v1/customers/commits/update-end-date-customers-v1-commits.mjs +1 -1
  479. package/tools/v1/customers/commits/update-end-date-customers-v1-commits.mjs.map +1 -1
  480. package/tools/v1/customers/create-v1-customers.d.mts.map +1 -1
  481. package/tools/v1/customers/create-v1-customers.d.ts.map +1 -1
  482. package/tools/v1/customers/create-v1-customers.js +13 -2
  483. package/tools/v1/customers/create-v1-customers.js.map +1 -1
  484. package/tools/v1/customers/create-v1-customers.mjs +13 -2
  485. package/tools/v1/customers/create-v1-customers.mjs.map +1 -1
  486. package/tools/v1/customers/credits/create-customers-v1-credits.d.mts.map +1 -1
  487. package/tools/v1/customers/credits/create-customers-v1-credits.d.ts.map +1 -1
  488. package/tools/v1/customers/credits/create-customers-v1-credits.js +29 -23
  489. package/tools/v1/customers/credits/create-customers-v1-credits.js.map +1 -1
  490. package/tools/v1/customers/credits/create-customers-v1-credits.mjs +29 -23
  491. package/tools/v1/customers/credits/create-customers-v1-credits.mjs.map +1 -1
  492. package/tools/v1/customers/credits/list-customers-v1-credits.d.mts.map +1 -1
  493. package/tools/v1/customers/credits/list-customers-v1-credits.d.ts.map +1 -1
  494. package/tools/v1/customers/credits/list-customers-v1-credits.js +3 -2
  495. package/tools/v1/customers/credits/list-customers-v1-credits.js.map +1 -1
  496. package/tools/v1/customers/credits/list-customers-v1-credits.mjs +3 -2
  497. package/tools/v1/customers/credits/list-customers-v1-credits.mjs.map +1 -1
  498. package/tools/v1/customers/credits/update-end-date-customers-v1-credits.js +1 -1
  499. package/tools/v1/customers/credits/update-end-date-customers-v1-credits.js.map +1 -1
  500. package/tools/v1/customers/credits/update-end-date-customers-v1-credits.mjs +1 -1
  501. package/tools/v1/customers/credits/update-end-date-customers-v1-credits.mjs.map +1 -1
  502. package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.js +1 -1
  503. package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.js.map +1 -1
  504. package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.mjs +1 -1
  505. package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.mjs.map +1 -1
  506. package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.js +1 -1
  507. package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.js.map +1 -1
  508. package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.mjs +1 -1
  509. package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.mjs.map +1 -1
  510. package/tools/v1/customers/invoices/list-customers-v1-invoices.js +1 -1
  511. package/tools/v1/customers/invoices/list-customers-v1-invoices.js.map +1 -1
  512. package/tools/v1/customers/invoices/list-customers-v1-invoices.mjs +1 -1
  513. package/tools/v1/customers/invoices/list-customers-v1-invoices.mjs.map +1 -1
  514. package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.d.mts.map +1 -1
  515. package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.d.ts.map +1 -1
  516. package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.js +1 -1
  517. package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.js.map +1 -1
  518. package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.mjs +1 -1
  519. package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.mjs.map +1 -1
  520. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.mts +45 -0
  521. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.mts.map +1 -0
  522. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.ts +45 -0
  523. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.ts.map +1 -0
  524. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.js +39 -0
  525. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.js.map +1 -0
  526. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.mjs +35 -0
  527. package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.mjs.map +1 -0
  528. package/tools/v1/customers/list-billable-metrics-v1-customers.js +1 -1
  529. package/tools/v1/customers/list-billable-metrics-v1-customers.js.map +1 -1
  530. package/tools/v1/customers/list-billable-metrics-v1-customers.mjs +1 -1
  531. package/tools/v1/customers/list-billable-metrics-v1-customers.mjs.map +1 -1
  532. package/tools/v1/customers/list-costs-v1-customers.js +1 -1
  533. package/tools/v1/customers/list-costs-v1-customers.js.map +1 -1
  534. package/tools/v1/customers/list-costs-v1-customers.mjs +1 -1
  535. package/tools/v1/customers/list-costs-v1-customers.mjs.map +1 -1
  536. package/tools/v1/customers/list-v1-customers.js +1 -1
  537. package/tools/v1/customers/list-v1-customers.js.map +1 -1
  538. package/tools/v1/customers/list-v1-customers.mjs +1 -1
  539. package/tools/v1/customers/list-v1-customers.mjs.map +1 -1
  540. package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.js +1 -1
  541. package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.js.map +1 -1
  542. package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.mjs +1 -1
  543. package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.mjs.map +1 -1
  544. package/tools/v1/customers/plans/add-customers-v1-plans.js +1 -1
  545. package/tools/v1/customers/plans/add-customers-v1-plans.js.map +1 -1
  546. package/tools/v1/customers/plans/add-customers-v1-plans.mjs +1 -1
  547. package/tools/v1/customers/plans/add-customers-v1-plans.mjs.map +1 -1
  548. package/tools/v1/customers/plans/end-customers-v1-plans.js +1 -1
  549. package/tools/v1/customers/plans/end-customers-v1-plans.js.map +1 -1
  550. package/tools/v1/customers/plans/end-customers-v1-plans.mjs +1 -1
  551. package/tools/v1/customers/plans/end-customers-v1-plans.mjs.map +1 -1
  552. package/tools/v1/customers/plans/list-customers-v1-plans.js +1 -1
  553. package/tools/v1/customers/plans/list-customers-v1-plans.js.map +1 -1
  554. package/tools/v1/customers/plans/list-customers-v1-plans.mjs +1 -1
  555. package/tools/v1/customers/plans/list-customers-v1-plans.mjs.map +1 -1
  556. package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.js +1 -1
  557. package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.js.map +1 -1
  558. package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.mjs +1 -1
  559. package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.mjs.map +1 -1
  560. package/tools/v1/customers/preview-events-v1-customers.d.mts.map +1 -1
  561. package/tools/v1/customers/preview-events-v1-customers.d.ts.map +1 -1
  562. package/tools/v1/customers/preview-events-v1-customers.js +2 -6
  563. package/tools/v1/customers/preview-events-v1-customers.js.map +1 -1
  564. package/tools/v1/customers/preview-events-v1-customers.mjs +2 -6
  565. package/tools/v1/customers/preview-events-v1-customers.mjs.map +1 -1
  566. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.mts +45 -0
  567. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.mts.map +1 -0
  568. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.ts +45 -0
  569. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.ts.map +1 -0
  570. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.js +43 -0
  571. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.js.map +1 -0
  572. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.mjs +39 -0
  573. package/tools/v1/customers/retrieve-billing-configurations-v1-customers.mjs.map +1 -0
  574. package/tools/v1/customers/retrieve-v1-customers.js +1 -1
  575. package/tools/v1/customers/retrieve-v1-customers.js.map +1 -1
  576. package/tools/v1/customers/retrieve-v1-customers.mjs +1 -1
  577. package/tools/v1/customers/retrieve-v1-customers.mjs.map +1 -1
  578. package/tools/v1/customers/set-billing-configurations-v1-customers.d.mts +45 -0
  579. package/tools/v1/customers/set-billing-configurations-v1-customers.d.mts.map +1 -0
  580. package/tools/v1/customers/set-billing-configurations-v1-customers.d.ts +45 -0
  581. package/tools/v1/customers/set-billing-configurations-v1-customers.d.ts.map +1 -0
  582. package/tools/v1/customers/set-billing-configurations-v1-customers.js +77 -0
  583. package/tools/v1/customers/set-billing-configurations-v1-customers.js.map +1 -0
  584. package/tools/v1/customers/set-billing-configurations-v1-customers.mjs +73 -0
  585. package/tools/v1/customers/set-billing-configurations-v1-customers.mjs.map +1 -0
  586. package/tools/v1/customers/set-ingest-aliases-v1-customers.js +1 -1
  587. package/tools/v1/customers/set-ingest-aliases-v1-customers.js.map +1 -1
  588. package/tools/v1/customers/set-ingest-aliases-v1-customers.mjs +1 -1
  589. package/tools/v1/customers/set-ingest-aliases-v1-customers.mjs.map +1 -1
  590. package/tools/v1/customers/set-name-v1-customers.js +1 -1
  591. package/tools/v1/customers/set-name-v1-customers.js.map +1 -1
  592. package/tools/v1/customers/set-name-v1-customers.mjs +1 -1
  593. package/tools/v1/customers/set-name-v1-customers.mjs.map +1 -1
  594. package/tools/v1/customers/update-config-v1-customers.d.mts.map +1 -1
  595. package/tools/v1/customers/update-config-v1-customers.d.ts.map +1 -1
  596. package/tools/v1/customers/update-config-v1-customers.js +1 -1
  597. package/tools/v1/customers/update-config-v1-customers.js.map +1 -1
  598. package/tools/v1/customers/update-config-v1-customers.mjs +1 -1
  599. package/tools/v1/customers/update-config-v1-customers.mjs.map +1 -1
  600. package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.js +1 -1
  601. package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.js.map +1 -1
  602. package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.mjs +1 -1
  603. package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.mjs.map +1 -1
  604. package/tools/v1/invoices/regenerate-v1-invoices.js +1 -1
  605. package/tools/v1/invoices/regenerate-v1-invoices.js.map +1 -1
  606. package/tools/v1/invoices/regenerate-v1-invoices.mjs +1 -1
  607. package/tools/v1/invoices/regenerate-v1-invoices.mjs.map +1 -1
  608. package/tools/v1/invoices/void-v1-invoices.js +1 -1
  609. package/tools/v1/invoices/void-v1-invoices.js.map +1 -1
  610. package/tools/v1/invoices/void-v1-invoices.mjs +1 -1
  611. package/tools/v1/invoices/void-v1-invoices.mjs.map +1 -1
  612. package/tools/v1/payments/attempt-v1-payments.d.mts +45 -0
  613. package/tools/v1/payments/attempt-v1-payments.d.mts.map +1 -0
  614. package/tools/v1/payments/attempt-v1-payments.d.ts +45 -0
  615. package/tools/v1/payments/attempt-v1-payments.d.ts.map +1 -0
  616. package/tools/v1/payments/attempt-v1-payments.js +43 -0
  617. package/tools/v1/payments/attempt-v1-payments.js.map +1 -0
  618. package/tools/v1/payments/attempt-v1-payments.mjs +39 -0
  619. package/tools/v1/payments/attempt-v1-payments.mjs.map +1 -0
  620. package/tools/v1/payments/cancel-v1-payments.d.mts +45 -0
  621. package/tools/v1/payments/cancel-v1-payments.d.mts.map +1 -0
  622. package/tools/v1/payments/cancel-v1-payments.d.ts +45 -0
  623. package/tools/v1/payments/cancel-v1-payments.d.ts.map +1 -0
  624. package/tools/v1/payments/cancel-v1-payments.js +43 -0
  625. package/tools/v1/payments/cancel-v1-payments.js.map +1 -0
  626. package/tools/v1/payments/cancel-v1-payments.mjs +39 -0
  627. package/tools/v1/payments/cancel-v1-payments.mjs.map +1 -0
  628. package/tools/v1/payments/list-v1-payments.d.mts +45 -0
  629. package/tools/v1/payments/list-v1-payments.d.mts.map +1 -0
  630. package/tools/v1/payments/list-v1-payments.d.ts +45 -0
  631. package/tools/v1/payments/list-v1-payments.d.ts.map +1 -0
  632. package/tools/v1/payments/list-v1-payments.js +64 -0
  633. package/tools/v1/payments/list-v1-payments.js.map +1 -0
  634. package/tools/v1/payments/list-v1-payments.mjs +60 -0
  635. package/tools/v1/payments/list-v1-payments.mjs.map +1 -0
  636. package/tools/v1/plans/get-details-v1-plans.js +1 -1
  637. package/tools/v1/plans/get-details-v1-plans.js.map +1 -1
  638. package/tools/v1/plans/get-details-v1-plans.mjs +1 -1
  639. package/tools/v1/plans/get-details-v1-plans.mjs.map +1 -1
  640. package/tools/v1/plans/list-charges-v1-plans.js +1 -1
  641. package/tools/v1/plans/list-charges-v1-plans.js.map +1 -1
  642. package/tools/v1/plans/list-charges-v1-plans.mjs +1 -1
  643. package/tools/v1/plans/list-charges-v1-plans.mjs.map +1 -1
  644. package/tools/v1/plans/list-customers-v1-plans.js +1 -1
  645. package/tools/v1/plans/list-customers-v1-plans.js.map +1 -1
  646. package/tools/v1/plans/list-customers-v1-plans.mjs +1 -1
  647. package/tools/v1/plans/list-customers-v1-plans.mjs.map +1 -1
  648. package/tools/v1/plans/list-v1-plans.js +1 -1
  649. package/tools/v1/plans/list-v1-plans.js.map +1 -1
  650. package/tools/v1/plans/list-v1-plans.mjs +1 -1
  651. package/tools/v1/plans/list-v1-plans.mjs.map +1 -1
  652. package/tools/v1/pricing-units/list-v1-pricing-units.js +1 -1
  653. package/tools/v1/pricing-units/list-v1-pricing-units.js.map +1 -1
  654. package/tools/v1/pricing-units/list-v1-pricing-units.mjs +1 -1
  655. package/tools/v1/pricing-units/list-v1-pricing-units.mjs.map +1 -1
  656. package/tools/v1/services/list-v1-services.js +1 -1
  657. package/tools/v1/services/list-v1-services.js.map +1 -1
  658. package/tools/v1/services/list-v1-services.mjs +1 -1
  659. package/tools/v1/services/list-v1-services.mjs.map +1 -1
  660. package/tools/v1/usage/ingest-v1-usage.js +2 -2
  661. package/tools/v1/usage/ingest-v1-usage.js.map +1 -1
  662. package/tools/v1/usage/ingest-v1-usage.mjs +2 -2
  663. package/tools/v1/usage/ingest-v1-usage.mjs.map +1 -1
  664. package/tools/v1/usage/list-v1-usage.d.mts.map +1 -1
  665. package/tools/v1/usage/list-v1-usage.d.ts.map +1 -1
  666. package/tools/v1/usage/list-v1-usage.js +3 -2
  667. package/tools/v1/usage/list-v1-usage.js.map +1 -1
  668. package/tools/v1/usage/list-v1-usage.mjs +3 -2
  669. package/tools/v1/usage/list-v1-usage.mjs.map +1 -1
  670. package/tools/v1/usage/list-with-groups-v1-usage.js +1 -1
  671. package/tools/v1/usage/list-with-groups-v1-usage.js.map +1 -1
  672. package/tools/v1/usage/list-with-groups-v1-usage.mjs +1 -1
  673. package/tools/v1/usage/list-with-groups-v1-usage.mjs.map +1 -1
  674. package/tools/v1/usage/search-v1-usage.js +1 -1
  675. package/tools/v1/usage/search-v1-usage.js.map +1 -1
  676. package/tools/v1/usage/search-v1-usage.mjs +1 -1
  677. package/tools/v1/usage/search-v1-usage.mjs.map +1 -1
  678. package/tools/v2/contracts/edit-commit-v2-contracts.d.mts.map +1 -1
  679. package/tools/v2/contracts/edit-commit-v2-contracts.d.ts.map +1 -1
  680. package/tools/v2/contracts/edit-commit-v2-contracts.js +82 -23
  681. package/tools/v2/contracts/edit-commit-v2-contracts.js.map +1 -1
  682. package/tools/v2/contracts/edit-commit-v2-contracts.mjs +82 -23
  683. package/tools/v2/contracts/edit-commit-v2-contracts.mjs.map +1 -1
  684. package/tools/v2/contracts/edit-credit-v2-contracts.d.mts.map +1 -1
  685. package/tools/v2/contracts/edit-credit-v2-contracts.d.ts.map +1 -1
  686. package/tools/v2/contracts/edit-credit-v2-contracts.js +82 -23
  687. package/tools/v2/contracts/edit-credit-v2-contracts.js.map +1 -1
  688. package/tools/v2/contracts/edit-credit-v2-contracts.mjs +82 -23
  689. package/tools/v2/contracts/edit-credit-v2-contracts.mjs.map +1 -1
  690. package/tools/v2/contracts/edit-v2-contracts.d.mts.map +1 -1
  691. package/tools/v2/contracts/edit-v2-contracts.d.ts.map +1 -1
  692. package/tools/v2/contracts/edit-v2-contracts.js +303 -741
  693. package/tools/v2/contracts/edit-v2-contracts.js.map +1 -1
  694. package/tools/v2/contracts/edit-v2-contracts.mjs +303 -741
  695. package/tools/v2/contracts/edit-v2-contracts.mjs.map +1 -1
  696. package/tools/v2/contracts/get-edit-history-v2-contracts.js +1 -1
  697. package/tools/v2/contracts/get-edit-history-v2-contracts.js.map +1 -1
  698. package/tools/v2/contracts/get-edit-history-v2-contracts.mjs +1 -1
  699. package/tools/v2/contracts/get-edit-history-v2-contracts.mjs.map +1 -1
  700. package/tools/v2/contracts/list-v2-contracts.js +1 -1
  701. package/tools/v2/contracts/list-v2-contracts.js.map +1 -1
  702. package/tools/v2/contracts/list-v2-contracts.mjs +1 -1
  703. package/tools/v2/contracts/list-v2-contracts.mjs.map +1 -1
  704. package/tools/v2/contracts/retrieve-v2-contracts.d.mts.map +1 -1
  705. package/tools/v2/contracts/retrieve-v2-contracts.d.ts.map +1 -1
  706. package/tools/v2/contracts/retrieve-v2-contracts.js +1 -1
  707. package/tools/v2/contracts/retrieve-v2-contracts.js.map +1 -1
  708. package/tools/v2/contracts/retrieve-v2-contracts.mjs +1 -1
  709. package/tools/v2/contracts/retrieve-v2-contracts.mjs.map +1 -1
@@ -16,7 +16,8 @@ export const metadata: Metadata = {
16
16
 
17
17
  export const tool: Tool = {
18
18
  name: 'create_v1_contracts',
19
- description: 'Create a new contract\n',
19
+ description:
20
+ "Contracts define a customer's products, pricing, discounts, access duration, and billing configuration. Contracts serve as the central billing agreement for both PLG and Enterprise customers, you can automatically customers access to your products and services directly from your product or CRM.\n\n### Use this endpoint to:\n- PLG onboarding: Automatically provision new self-serve customers with contracts when they sign up.\n- Enterprise sales: Push negotiated contracts from Salesforce with custom pricing and commitments\n- Promotional pricing: Implement time-limited discounts and free trials through overrides\n\n### Key components:\n#### Contract Term and Billing Schedule\n- Set contract duration using `starting_at` and `ending_before` fields. PLG contracts typically use perpetual agreements (no end date), while Enterprise contracts have fixed end dates which can be edited over time in the case of co-term upsells.\n\n#### Rate Card\nIf you are offering usage based pricing, you can set a rate card for the contract to reference through `rate_card_id` or `rate_card_alias`. The rate card is a store of all of your usage based products and their centralized pricing. Any new products or price changes on the rate card can be set to automatically propagate to all associated contracts - this ensures consistent pricing and product launches flow to contracts without manual updates and migrations. The `usage_statement_schedule` determines the cadence on which Metronome will finalize a usage invoice for the customer. This defaults to monthly on the 1st, with options for custom dates, quarterly, or annual cadences. Note: Most usage based billing companies align usage statements to be evaluated aligned to the first of the month.\nRead more about [Rate Cards](https://docs.metronome.com/pricing-packaging/create-manage-rate-cards/).\n\n#### Overrides and discounts\nCustomize pricing on the contract through time-bounded overrides that can target specific products, product families, or complex usage scenarios. Overrides enable two key capabilities:\n- Discounts: Apply percentage discounts, fixed rate reductions, or quantity-based pricing tiers\n- Entitlements: Provide special pricing or access to specific products for negotiated deals\n\nRead more about [Contract Overrides](https://docs.metronome.com/manage-product-access/add-contract-override/).\n\n#### Commits and Credits\nUsing commits, configure prepaid or postpaid spending commitments where customers promise to spend a certain amount over the contract period paid in advance or in arrears. Use credits to provide free spending allowances. Under the hood these are the same mechanisms, however, credits are typically offered for free (SLA or promotional) or as a part of an allotment associated with a Subscription.\n\nIn Metronome, you can set commits and credits to only be applicable for a subset of usage. Use `applicable_product_ids` or `applicable_product_tags` to create product or product-family specific commits or credits, or you can build complex boolean logic specifiers to target usage based on pricing and presentation group values using `override_specifiers`.\n\nThese objects can also also be configured to have a recurrence schedule to easily model customer packaging which includes recurring monthly or quarterly allotments.\n\nCommits support rollover settings (`rollover_fraction`) to transfer unused balances between contract periods, either entirely or as a percentage.\n\nRead more about [Credits and Commits](https://docs.metronome.com/pricing-packaging/apply-credits-commits/).\n\n#### Subscriptions\nYou can add a fixed recurring charge to a contract, like monthly licenses or seat-based fees, using the subscription charge. Subscription charges are defined on your rate card and you can select which subscription is applicable to add to each contract. When you add a subscription to a contract you need to:\n- Define whether the subscription is paid for in-advance or in-arrears (`collection_schedule`)\n- Define the proration behavior (`proration`)\n- Specify an initial quantity (`initial_quantity`)\n- Define which subscription rate on the rate card should be used (`subscription_rate`)\n\nRead more about [Subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/).\n\n#### Scheduled Charges\nSet up one-time, recurring, or entirely custom charges that occur on specific dates, separate from usage-based billing or commitments. These can be used to model non-recurring platform charges or professional services.\n\n#### Threshold Billing\nMetronome allows you to configure automatic billing triggers when customers reach spending thresholds to prevent fraud and manage risk. You can use `spend_threshold_configuration` to trigger an invoice to cover current charges whenever the threshold is reached or you can ensure the customer maintains a minimum prepaid balance using the `prepaid_balance_configuration`.\n\nRead more about [Spend Threshold](https://docs.metronome.com/manage-product-access/spend-thresholds/) and [Prepaid Balance Thresholds](https://docs.metronome.com/manage-product-access/prepaid-balance-thresholds/).\n\n### Usage guidelines:\n- You can always [Edit Contracts](https://docs.metronome.com/manage-product-access/edit-contract/) after it has been created, using the `editContract` endpoint. Metronome keeps track of all edits, both in the audit log and over the `getEditHistory` endpoint.\n- Customers in Metronome can have multiple concurrent contracts at one time. Use `usage_filters` to route the correct usage to each contract. [Read more about usage filters](https://docs.metronome.com/manage-product-access/provision-customer/#create-a-usage-filter).\n",
20
21
  inputSchema: {
21
22
  type: 'object',
22
23
  properties: {
@@ -118,6 +119,7 @@ export const tool: Tool = {
118
119
  },
119
120
  custom_fields: {
120
121
  type: 'object',
122
+ description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
121
123
  additionalProperties: true,
122
124
  },
123
125
  description: {
@@ -125,51 +127,7 @@ export const tool: Tool = {
125
127
  description: 'Used only in UI/API. It is not exposed to end customers.',
126
128
  },
127
129
  hierarchy_configuration: {
128
- type: 'object',
129
- description: 'Optional configuration for commit hierarchy access control',
130
- properties: {
131
- child_access: {
132
- anyOf: [
133
- {
134
- type: 'object',
135
- properties: {
136
- type: {
137
- type: 'string',
138
- enum: ['ALL'],
139
- },
140
- },
141
- required: ['type'],
142
- },
143
- {
144
- type: 'object',
145
- properties: {
146
- type: {
147
- type: 'string',
148
- enum: ['NONE'],
149
- },
150
- },
151
- required: ['type'],
152
- },
153
- {
154
- type: 'object',
155
- properties: {
156
- contract_ids: {
157
- type: 'array',
158
- items: {
159
- type: 'string',
160
- },
161
- },
162
- type: {
163
- type: 'string',
164
- enum: ['CONTRACT_IDS'],
165
- },
166
- },
167
- required: ['contract_ids', 'type'],
168
- },
169
- ],
170
- },
171
- },
172
- required: ['child_access'],
130
+ $ref: '#/$defs/commit_hierarchy_configuration',
173
131
  },
174
132
  invoice_schedule: {
175
133
  type: 'object',
@@ -320,7 +278,7 @@ export const tool: Tool = {
320
278
  type: 'string',
321
279
  description:
322
280
  'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
323
- enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
281
+ enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
324
282
  },
325
283
  },
326
284
  required: ['payment_gate_type'],
@@ -343,30 +301,7 @@ export const tool: Tool = {
343
301
  description:
344
302
  "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
345
303
  items: {
346
- type: 'object',
347
- properties: {
348
- presentation_group_values: {
349
- type: 'object',
350
- additionalProperties: true,
351
- },
352
- pricing_group_values: {
353
- type: 'object',
354
- additionalProperties: true,
355
- },
356
- product_id: {
357
- type: 'string',
358
- description:
359
- 'If provided, the specifier will only apply to the product with the specified ID.',
360
- },
361
- product_tags: {
362
- type: 'array',
363
- description:
364
- 'If provided, the specifier will only apply to products with all the specified tags.',
365
- items: {
366
- type: 'string',
367
- },
368
- },
369
- },
304
+ $ref: '#/$defs/commit_specifier_input',
370
305
  },
371
306
  },
372
307
  temporary_id: {
@@ -437,6 +372,7 @@ export const tool: Tool = {
437
372
  },
438
373
  custom_fields: {
439
374
  type: 'object',
375
+ description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
440
376
  additionalProperties: true,
441
377
  },
442
378
  description: {
@@ -444,51 +380,7 @@ export const tool: Tool = {
444
380
  description: 'Used only in UI/API. It is not exposed to end customers.',
445
381
  },
446
382
  hierarchy_configuration: {
447
- type: 'object',
448
- description: 'Optional configuration for credit hierarchy access control',
449
- properties: {
450
- child_access: {
451
- anyOf: [
452
- {
453
- type: 'object',
454
- properties: {
455
- type: {
456
- type: 'string',
457
- enum: ['ALL'],
458
- },
459
- },
460
- required: ['type'],
461
- },
462
- {
463
- type: 'object',
464
- properties: {
465
- type: {
466
- type: 'string',
467
- enum: ['NONE'],
468
- },
469
- },
470
- required: ['type'],
471
- },
472
- {
473
- type: 'object',
474
- properties: {
475
- contract_ids: {
476
- type: 'array',
477
- items: {
478
- type: 'string',
479
- },
480
- },
481
- type: {
482
- type: 'string',
483
- enum: ['CONTRACT_IDS'],
484
- },
485
- },
486
- required: ['contract_ids', 'type'],
487
- },
488
- ],
489
- },
490
- },
491
- required: ['child_access'],
383
+ $ref: '#/$defs/commit_hierarchy_configuration',
492
384
  },
493
385
  name: {
494
386
  type: 'string',
@@ -512,30 +404,7 @@ export const tool: Tool = {
512
404
  description:
513
405
  "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
514
406
  items: {
515
- type: 'object',
516
- properties: {
517
- presentation_group_values: {
518
- type: 'object',
519
- additionalProperties: true,
520
- },
521
- pricing_group_values: {
522
- type: 'object',
523
- additionalProperties: true,
524
- },
525
- product_id: {
526
- type: 'string',
527
- description:
528
- 'If provided, the specifier will only apply to the product with the specified ID.',
529
- },
530
- product_tags: {
531
- type: 'array',
532
- description:
533
- 'If provided, the specifier will only apply to products with all the specified tags.',
534
- items: {
535
- type: 'string',
536
- },
537
- },
538
- },
407
+ $ref: '#/$defs/commit_specifier_input',
539
408
  },
540
409
  },
541
410
  },
@@ -544,6 +413,7 @@ export const tool: Tool = {
544
413
  },
545
414
  custom_fields: {
546
415
  type: 'object',
416
+ description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
547
417
  additionalProperties: true,
548
418
  },
549
419
  discounts: {
@@ -643,6 +513,7 @@ export const tool: Tool = {
643
513
  },
644
514
  custom_fields: {
645
515
  type: 'object',
516
+ description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
646
517
  additionalProperties: true,
647
518
  },
648
519
  name: {
@@ -677,8 +548,29 @@ export const tool: Tool = {
677
548
  },
678
549
  required: ['contract_id', 'customer_id'],
679
550
  },
551
+ parent_behavior: {
552
+ type: 'object',
553
+ properties: {
554
+ invoice_consolidation_type: {
555
+ type: 'string',
556
+ description:
557
+ 'Indicates the desired behavior of consolidated invoices generated by the parent in a customer hierarchy\n**CONCATENATE**: Statements on the invoices of child customers will be appended to the consolidated invoice\n**NONE**: Do not generate consolidated invoices',
558
+ enum: ['CONCATENATE', 'NONE'],
559
+ },
560
+ },
561
+ },
562
+ payer: {
563
+ type: 'string',
564
+ description: "Indicates whether the parent should pay for the child's invoice charges",
565
+ enum: ['SELF', 'PARENT'],
566
+ },
567
+ usage_statement_behavior: {
568
+ type: 'string',
569
+ description:
570
+ "Indicates the behavior of the child's invoice statements on the parent's invoices\n**CONSOLIDATE**: Child's invoice statements will be added to parent's consolidated invoices\n**SEPARATE**: Child's invoice statements will appear not appear on parent's consolidated invoices",
571
+ enum: ['CONSOLIDATE', 'SEPARATE'],
572
+ },
680
573
  },
681
- required: ['parent'],
682
574
  },
683
575
  multiplier_override_prioritization: {
684
576
  type: 'string',
@@ -745,7 +637,7 @@ export const tool: Tool = {
745
637
  commit_ids: {
746
638
  type: 'array',
747
639
  description:
748
- 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id, product_tags, pricing_group_values, or presentation_group_values. If provided, the override will only apply to the specified commits. If not provided, the override will apply to all commits.',
640
+ 'Can only be used for commit specific overrides. Must be used in conjunction with one of `product_id`, `product_tags`, `pricing_group_values`, or `presentation_group_values`. If provided, the override will only apply to the specified commits. If not provided, the override will apply to all commits.',
749
641
  items: {
750
642
  type: 'string',
751
643
  },
@@ -778,7 +670,7 @@ export const tool: Tool = {
778
670
  recurring_commit_ids: {
779
671
  type: 'array',
780
672
  description:
781
- 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id, product_tags, pricing_group_values, or presentation_group_values. If provided, the override will only apply to commits created by the specified recurring commit ids.',
673
+ 'Can only be used for commit specific overrides. Must be used in conjunction with one of `product_id`, `product_tags`, `pricing_group_values`, or `presentation_group_values`. If provided, the override will only apply to commits created by the specified recurring commit ids.',
782
674
  items: {
783
675
  type: 'string',
784
676
  },
@@ -786,7 +678,7 @@ export const tool: Tool = {
786
678
  recurring_credit_ids: {
787
679
  type: 'array',
788
680
  description:
789
- 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id, product_tags, pricing_group_values, or presentation_group_values. If provided, the override will only apply to credits created by the specified recurring credit ids.',
681
+ 'Can only be used for commit specific overrides. Must be used in conjunction with one of `product_id`, `product_tags`, `pricing_group_values`, or `presentation_group_values`. If provided, the override will only apply to credits created by the specified recurring credit ids.',
790
682
  items: {
791
683
  type: 'string',
792
684
  },
@@ -877,148 +769,7 @@ export const tool: Tool = {
877
769
  },
878
770
  },
879
771
  prepaid_balance_threshold_configuration: {
880
- type: 'object',
881
- properties: {
882
- commit: {
883
- type: 'object',
884
- properties: {
885
- product_id: {
886
- type: 'string',
887
- description:
888
- 'The commit product that will be used to generate the line item for commit payment.',
889
- },
890
- applicable_product_ids: {
891
- type: 'array',
892
- description:
893
- 'Which products the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.',
894
- items: {
895
- type: 'string',
896
- },
897
- },
898
- applicable_product_tags: {
899
- type: 'array',
900
- description:
901
- 'Which tags the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.',
902
- items: {
903
- type: 'string',
904
- },
905
- },
906
- description: {
907
- type: 'string',
908
- },
909
- name: {
910
- type: 'string',
911
- description:
912
- 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
913
- },
914
- specifiers: {
915
- type: 'array',
916
- description:
917
- "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
918
- items: {
919
- type: 'object',
920
- properties: {
921
- presentation_group_values: {
922
- type: 'object',
923
- additionalProperties: true,
924
- },
925
- pricing_group_values: {
926
- type: 'object',
927
- additionalProperties: true,
928
- },
929
- product_id: {
930
- type: 'string',
931
- description:
932
- 'If provided, the specifier will only apply to the product with the specified ID.',
933
- },
934
- product_tags: {
935
- type: 'array',
936
- description:
937
- 'If provided, the specifier will only apply to products with all the specified tags.',
938
- items: {
939
- type: 'string',
940
- },
941
- },
942
- },
943
- },
944
- },
945
- },
946
- required: ['product_id'],
947
- },
948
- is_enabled: {
949
- type: 'boolean',
950
- description:
951
- 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
952
- },
953
- payment_gate_config: {
954
- type: 'object',
955
- properties: {
956
- payment_gate_type: {
957
- type: 'string',
958
- description:
959
- 'Gate access to the commit balance based on successful collection of payment. Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to facilitate payment using your own payment integration. Select NONE if you do not wish to payment gate the commit balance.',
960
- enum: ['NONE', 'STRIPE', 'EXTERNAL'],
961
- },
962
- precalculated_tax_config: {
963
- type: 'object',
964
- description: 'Only applicable if using PRECALCULATED as your tax type.',
965
- properties: {
966
- tax_amount: {
967
- type: 'number',
968
- description:
969
- "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
970
- },
971
- tax_name: {
972
- type: 'string',
973
- description:
974
- 'Name of the tax to be applied. This may be used in an invoice line item description.',
975
- },
976
- },
977
- required: ['tax_amount'],
978
- },
979
- stripe_config: {
980
- type: 'object',
981
- description: 'Only applicable if using STRIPE as your payment gate type.',
982
- properties: {
983
- payment_type: {
984
- type: 'string',
985
- description: 'If left blank, will default to INVOICE',
986
- enum: ['INVOICE', 'PAYMENT_INTENT'],
987
- },
988
- invoice_metadata: {
989
- type: 'object',
990
- description:
991
- 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
992
- additionalProperties: true,
993
- },
994
- },
995
- required: ['payment_type'],
996
- },
997
- tax_type: {
998
- type: 'string',
999
- description:
1000
- 'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
1001
- enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
1002
- },
1003
- },
1004
- required: ['payment_gate_type'],
1005
- },
1006
- recharge_to_amount: {
1007
- type: 'number',
1008
- description: 'Specify the amount the balance should be recharged to.',
1009
- },
1010
- threshold_amount: {
1011
- type: 'number',
1012
- description:
1013
- "Specify the threshold amount for the contract. Each time the contract's prepaid balance lowers to this amount, a threshold charge will be initiated.",
1014
- },
1015
- custom_credit_type_id: {
1016
- type: 'string',
1017
- description:
1018
- 'If provided, the threshold, recharge-to amount, and the resulting threshold commit amount will be in terms of this credit type instead of the fiat currency.',
1019
- },
1020
- },
1021
- required: ['commit', 'is_enabled', 'payment_gate_config', 'recharge_to_amount', 'threshold_amount'],
772
+ $ref: '#/$defs/prepaid_balance_threshold_configuration',
1022
773
  },
1023
774
  priority: {
1024
775
  type: 'number',
@@ -1049,6 +800,7 @@ export const tool: Tool = {
1049
800
  },
1050
801
  custom_fields: {
1051
802
  type: 'object',
803
+ description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
1052
804
  additionalProperties: true,
1053
805
  },
1054
806
  description: {
@@ -1143,51 +895,7 @@ export const tool: Tool = {
1143
895
  format: 'date-time',
1144
896
  },
1145
897
  hierarchy_configuration: {
1146
- type: 'object',
1147
- description: 'Optional configuration for recurring commit/credit hierarchy access control',
1148
- properties: {
1149
- child_access: {
1150
- anyOf: [
1151
- {
1152
- type: 'object',
1153
- properties: {
1154
- type: {
1155
- type: 'string',
1156
- enum: ['ALL'],
1157
- },
1158
- },
1159
- required: ['type'],
1160
- },
1161
- {
1162
- type: 'object',
1163
- properties: {
1164
- type: {
1165
- type: 'string',
1166
- enum: ['NONE'],
1167
- },
1168
- },
1169
- required: ['type'],
1170
- },
1171
- {
1172
- type: 'object',
1173
- properties: {
1174
- contract_ids: {
1175
- type: 'array',
1176
- items: {
1177
- type: 'string',
1178
- },
1179
- },
1180
- type: {
1181
- type: 'string',
1182
- enum: ['CONTRACT_IDS'],
1183
- },
1184
- },
1185
- required: ['contract_ids', 'type'],
1186
- },
1187
- ],
1188
- },
1189
- },
1190
- required: ['child_access'],
898
+ $ref: '#/$defs/commit_hierarchy_configuration',
1191
899
  },
1192
900
  invoice_amount: {
1193
901
  type: 'object',
@@ -1240,30 +948,7 @@ export const tool: Tool = {
1240
948
  description:
1241
949
  "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
1242
950
  items: {
1243
- type: 'object',
1244
- properties: {
1245
- presentation_group_values: {
1246
- type: 'object',
1247
- additionalProperties: true,
1248
- },
1249
- pricing_group_values: {
1250
- type: 'object',
1251
- additionalProperties: true,
1252
- },
1253
- product_id: {
1254
- type: 'string',
1255
- description:
1256
- 'If provided, the specifier will only apply to the product with the specified ID.',
1257
- },
1258
- product_tags: {
1259
- type: 'array',
1260
- description:
1261
- 'If provided, the specifier will only apply to products with all the specified tags.',
1262
- items: {
1263
- type: 'string',
1264
- },
1265
- },
1266
- },
951
+ $ref: '#/$defs/commit_specifier_input',
1267
952
  },
1268
953
  },
1269
954
  subscription_config: {
@@ -1287,7 +972,7 @@ export const tool: Tool = {
1287
972
  allocation: {
1288
973
  type: 'string',
1289
974
  description: 'If set to POOLED, allocation added per seat is pooled across the account.',
1290
- enum: ['POOLED'],
975
+ enum: ['INDIVIDUAL', 'POOLED'],
1291
976
  },
1292
977
  },
1293
978
  required: ['apply_seat_increase_config', 'subscription_id'],
@@ -1375,51 +1060,7 @@ export const tool: Tool = {
1375
1060
  format: 'date-time',
1376
1061
  },
1377
1062
  hierarchy_configuration: {
1378
- type: 'object',
1379
- description: 'Optional configuration for recurring commit/credit hierarchy access control',
1380
- properties: {
1381
- child_access: {
1382
- anyOf: [
1383
- {
1384
- type: 'object',
1385
- properties: {
1386
- type: {
1387
- type: 'string',
1388
- enum: ['ALL'],
1389
- },
1390
- },
1391
- required: ['type'],
1392
- },
1393
- {
1394
- type: 'object',
1395
- properties: {
1396
- type: {
1397
- type: 'string',
1398
- enum: ['NONE'],
1399
- },
1400
- },
1401
- required: ['type'],
1402
- },
1403
- {
1404
- type: 'object',
1405
- properties: {
1406
- contract_ids: {
1407
- type: 'array',
1408
- items: {
1409
- type: 'string',
1410
- },
1411
- },
1412
- type: {
1413
- type: 'string',
1414
- enum: ['CONTRACT_IDS'],
1415
- },
1416
- },
1417
- required: ['contract_ids', 'type'],
1418
- },
1419
- ],
1420
- },
1421
- },
1422
- required: ['child_access'],
1063
+ $ref: '#/$defs/commit_hierarchy_configuration',
1423
1064
  },
1424
1065
  name: {
1425
1066
  type: 'string',
@@ -1456,30 +1097,7 @@ export const tool: Tool = {
1456
1097
  description:
1457
1098
  "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
1458
1099
  items: {
1459
- type: 'object',
1460
- properties: {
1461
- presentation_group_values: {
1462
- type: 'object',
1463
- additionalProperties: true,
1464
- },
1465
- pricing_group_values: {
1466
- type: 'object',
1467
- additionalProperties: true,
1468
- },
1469
- product_id: {
1470
- type: 'string',
1471
- description:
1472
- 'If provided, the specifier will only apply to the product with the specified ID.',
1473
- },
1474
- product_tags: {
1475
- type: 'array',
1476
- description:
1477
- 'If provided, the specifier will only apply to products with all the specified tags.',
1478
- items: {
1479
- type: 'string',
1480
- },
1481
- },
1482
- },
1100
+ $ref: '#/$defs/commit_specifier_input',
1483
1101
  },
1484
1102
  },
1485
1103
  subscription_config: {
@@ -1503,7 +1121,7 @@ export const tool: Tool = {
1503
1121
  allocation: {
1504
1122
  type: 'string',
1505
1123
  description: 'If set to POOLED, allocation added per seat is pooled across the account.',
1506
- enum: ['POOLED'],
1124
+ enum: ['INDIVIDUAL', 'POOLED'],
1507
1125
  },
1508
1126
  },
1509
1127
  required: ['apply_seat_increase_config', 'subscription_id'],
@@ -1687,6 +1305,7 @@ export const tool: Tool = {
1687
1305
  },
1688
1306
  custom_fields: {
1689
1307
  type: 'object',
1308
+ description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
1690
1309
  additionalProperties: true,
1691
1310
  },
1692
1311
  name: {
@@ -1708,92 +1327,7 @@ export const tool: Tool = {
1708
1327
  enum: ['ALL'],
1709
1328
  },
1710
1329
  spend_threshold_configuration: {
1711
- type: 'object',
1712
- properties: {
1713
- commit: {
1714
- type: 'object',
1715
- properties: {
1716
- product_id: {
1717
- type: 'string',
1718
- description:
1719
- 'The commit product that will be used to generate the line item for commit payment.',
1720
- },
1721
- description: {
1722
- type: 'string',
1723
- },
1724
- name: {
1725
- type: 'string',
1726
- description:
1727
- 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
1728
- },
1729
- },
1730
- required: ['product_id'],
1731
- },
1732
- is_enabled: {
1733
- type: 'boolean',
1734
- description:
1735
- 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
1736
- },
1737
- payment_gate_config: {
1738
- type: 'object',
1739
- properties: {
1740
- payment_gate_type: {
1741
- type: 'string',
1742
- description:
1743
- 'Gate access to the commit balance based on successful collection of payment. Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to facilitate payment using your own payment integration. Select NONE if you do not wish to payment gate the commit balance.',
1744
- enum: ['NONE', 'STRIPE', 'EXTERNAL'],
1745
- },
1746
- precalculated_tax_config: {
1747
- type: 'object',
1748
- description: 'Only applicable if using PRECALCULATED as your tax type.',
1749
- properties: {
1750
- tax_amount: {
1751
- type: 'number',
1752
- description:
1753
- "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
1754
- },
1755
- tax_name: {
1756
- type: 'string',
1757
- description:
1758
- 'Name of the tax to be applied. This may be used in an invoice line item description.',
1759
- },
1760
- },
1761
- required: ['tax_amount'],
1762
- },
1763
- stripe_config: {
1764
- type: 'object',
1765
- description: 'Only applicable if using STRIPE as your payment gate type.',
1766
- properties: {
1767
- payment_type: {
1768
- type: 'string',
1769
- description: 'If left blank, will default to INVOICE',
1770
- enum: ['INVOICE', 'PAYMENT_INTENT'],
1771
- },
1772
- invoice_metadata: {
1773
- type: 'object',
1774
- description:
1775
- 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
1776
- additionalProperties: true,
1777
- },
1778
- },
1779
- required: ['payment_type'],
1780
- },
1781
- tax_type: {
1782
- type: 'string',
1783
- description:
1784
- 'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
1785
- enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
1786
- },
1787
- },
1788
- required: ['payment_gate_type'],
1789
- },
1790
- threshold_amount: {
1791
- type: 'number',
1792
- description:
1793
- "Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.",
1794
- },
1795
- },
1796
- required: ['commit', 'is_enabled', 'payment_gate_config', 'threshold_amount'],
1330
+ $ref: '#/$defs/spend_threshold_configuration',
1797
1331
  },
1798
1332
  subscriptions: {
1799
1333
  type: 'array',
@@ -1806,10 +1340,6 @@ export const tool: Tool = {
1806
1340
  type: 'string',
1807
1341
  enum: ['ADVANCE', 'ARREARS'],
1808
1342
  },
1809
- initial_quantity: {
1810
- type: 'number',
1811
- description: 'The initial quantity for the subscription. It must be non-negative value.',
1812
- },
1813
1343
  proration: {
1814
1344
  type: 'object',
1815
1345
  properties: {
@@ -1843,6 +1373,7 @@ export const tool: Tool = {
1843
1373
  },
1844
1374
  custom_fields: {
1845
1375
  type: 'object',
1376
+ description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
1846
1377
  additionalProperties: true,
1847
1378
  },
1848
1379
  description: {
@@ -1854,9 +1385,20 @@ export const tool: Tool = {
1854
1385
  'Exclusive end time for the subscription. If not provided, subscription inherits contract end date.',
1855
1386
  format: 'date-time',
1856
1387
  },
1388
+ initial_quantity: {
1389
+ type: 'number',
1390
+ description:
1391
+ 'The initial quantity for the subscription. It must be non-negative value. Required if quantity_management_mode is QUANTITY_ONLY.',
1392
+ },
1857
1393
  name: {
1858
1394
  type: 'string',
1859
1395
  },
1396
+ quantity_management_mode: {
1397
+ type: 'string',
1398
+ description:
1399
+ "Determines how the subscription's quantity is controlled. Defaults to QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified directly on the subscription. `initial_quantity` must be provided with this option. Compatible with recurring commits/credits that use POOLED allocation.",
1400
+ enum: ['SEAT_BASED', 'QUANTITY_ONLY'],
1401
+ },
1860
1402
  starting_at: {
1861
1403
  type: 'string',
1862
1404
  description:
@@ -1869,7 +1411,7 @@ export const tool: Tool = {
1869
1411
  'A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.',
1870
1412
  },
1871
1413
  },
1872
- required: ['collection_schedule', 'initial_quantity', 'proration', 'subscription_rate'],
1414
+ required: ['collection_schedule', 'proration', 'subscription_rate'],
1873
1415
  },
1874
1416
  },
1875
1417
  total_contract_value: {
@@ -1939,6 +1481,77 @@ export const tool: Tool = {
1939
1481
  },
1940
1482
  required: ['customer_id', 'starting_at'],
1941
1483
  $defs: {
1484
+ commit_hierarchy_configuration: {
1485
+ type: 'object',
1486
+ properties: {
1487
+ child_access: {
1488
+ anyOf: [
1489
+ {
1490
+ type: 'object',
1491
+ properties: {
1492
+ type: {
1493
+ type: 'string',
1494
+ enum: ['ALL'],
1495
+ },
1496
+ },
1497
+ required: ['type'],
1498
+ },
1499
+ {
1500
+ type: 'object',
1501
+ properties: {
1502
+ type: {
1503
+ type: 'string',
1504
+ enum: ['NONE'],
1505
+ },
1506
+ },
1507
+ required: ['type'],
1508
+ },
1509
+ {
1510
+ type: 'object',
1511
+ properties: {
1512
+ contract_ids: {
1513
+ type: 'array',
1514
+ items: {
1515
+ type: 'string',
1516
+ },
1517
+ },
1518
+ type: {
1519
+ type: 'string',
1520
+ enum: ['CONTRACT_IDS'],
1521
+ },
1522
+ },
1523
+ required: ['contract_ids', 'type'],
1524
+ },
1525
+ ],
1526
+ },
1527
+ },
1528
+ required: ['child_access'],
1529
+ },
1530
+ commit_specifier_input: {
1531
+ type: 'object',
1532
+ properties: {
1533
+ presentation_group_values: {
1534
+ type: 'object',
1535
+ additionalProperties: true,
1536
+ },
1537
+ pricing_group_values: {
1538
+ type: 'object',
1539
+ additionalProperties: true,
1540
+ },
1541
+ product_id: {
1542
+ type: 'string',
1543
+ description: 'If provided, the specifier will only apply to the product with the specified ID.',
1544
+ },
1545
+ product_tags: {
1546
+ type: 'array',
1547
+ description:
1548
+ 'If provided, the specifier will only apply to products with all the specified tags.',
1549
+ items: {
1550
+ type: 'string',
1551
+ },
1552
+ },
1553
+ },
1554
+ },
1942
1555
  tier: {
1943
1556
  type: 'object',
1944
1557
  properties: {
@@ -1951,6 +1564,134 @@ export const tool: Tool = {
1951
1564
  },
1952
1565
  required: ['price'],
1953
1566
  },
1567
+ prepaid_balance_threshold_configuration: {
1568
+ type: 'object',
1569
+ properties: {
1570
+ commit: {
1571
+ allOf: [
1572
+ {
1573
+ $ref: '#/$defs/base_threshold_commit',
1574
+ },
1575
+ ],
1576
+ },
1577
+ is_enabled: {
1578
+ type: 'boolean',
1579
+ description:
1580
+ 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
1581
+ },
1582
+ payment_gate_config: {
1583
+ $ref: '#/$defs/payment_gate_config',
1584
+ },
1585
+ recharge_to_amount: {
1586
+ type: 'number',
1587
+ description: 'Specify the amount the balance should be recharged to.',
1588
+ },
1589
+ threshold_amount: {
1590
+ type: 'number',
1591
+ description:
1592
+ "Specify the threshold amount for the contract. Each time the contract's prepaid balance lowers to this amount, a threshold charge will be initiated.",
1593
+ },
1594
+ custom_credit_type_id: {
1595
+ type: 'string',
1596
+ description:
1597
+ 'If provided, the threshold, recharge-to amount, and the resulting threshold commit amount will be in terms of this credit type instead of the fiat currency.',
1598
+ },
1599
+ },
1600
+ required: ['commit', 'is_enabled', 'payment_gate_config', 'recharge_to_amount', 'threshold_amount'],
1601
+ },
1602
+ base_threshold_commit: {
1603
+ type: 'object',
1604
+ properties: {
1605
+ product_id: {
1606
+ type: 'string',
1607
+ description: 'The commit product that will be used to generate the line item for commit payment.',
1608
+ },
1609
+ description: {
1610
+ type: 'string',
1611
+ },
1612
+ name: {
1613
+ type: 'string',
1614
+ description:
1615
+ 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
1616
+ },
1617
+ },
1618
+ required: ['product_id'],
1619
+ },
1620
+ payment_gate_config: {
1621
+ type: 'object',
1622
+ properties: {
1623
+ payment_gate_type: {
1624
+ type: 'string',
1625
+ description:
1626
+ 'Gate access to the commit balance based on successful collection of payment. Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to facilitate payment using your own payment integration. Select NONE if you do not wish to payment gate the commit balance.',
1627
+ enum: ['NONE', 'STRIPE', 'EXTERNAL'],
1628
+ },
1629
+ precalculated_tax_config: {
1630
+ type: 'object',
1631
+ description: 'Only applicable if using PRECALCULATED as your tax type.',
1632
+ properties: {
1633
+ tax_amount: {
1634
+ type: 'number',
1635
+ description:
1636
+ "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
1637
+ },
1638
+ tax_name: {
1639
+ type: 'string',
1640
+ description:
1641
+ 'Name of the tax to be applied. This may be used in an invoice line item description.',
1642
+ },
1643
+ },
1644
+ required: ['tax_amount'],
1645
+ },
1646
+ stripe_config: {
1647
+ type: 'object',
1648
+ description: 'Only applicable if using STRIPE as your payment gate type.',
1649
+ properties: {
1650
+ payment_type: {
1651
+ type: 'string',
1652
+ description: 'If left blank, will default to INVOICE',
1653
+ enum: ['INVOICE', 'PAYMENT_INTENT'],
1654
+ },
1655
+ invoice_metadata: {
1656
+ type: 'object',
1657
+ description:
1658
+ 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
1659
+ additionalProperties: true,
1660
+ },
1661
+ },
1662
+ required: ['payment_type'],
1663
+ },
1664
+ tax_type: {
1665
+ type: 'string',
1666
+ description:
1667
+ 'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
1668
+ enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
1669
+ },
1670
+ },
1671
+ required: ['payment_gate_type'],
1672
+ },
1673
+ spend_threshold_configuration: {
1674
+ type: 'object',
1675
+ properties: {
1676
+ commit: {
1677
+ $ref: '#/$defs/base_threshold_commit',
1678
+ },
1679
+ is_enabled: {
1680
+ type: 'boolean',
1681
+ description:
1682
+ 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
1683
+ },
1684
+ payment_gate_config: {
1685
+ $ref: '#/$defs/payment_gate_config',
1686
+ },
1687
+ threshold_amount: {
1688
+ type: 'number',
1689
+ description:
1690
+ "Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.",
1691
+ },
1692
+ },
1693
+ required: ['commit', 'is_enabled', 'payment_gate_config', 'threshold_amount'],
1694
+ },
1954
1695
  base_usage_filter: {
1955
1696
  type: 'object',
1956
1697
  properties: {