@flexprice/mcp-server 2.0.10 → 2.0.12

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 (537) hide show
  1. package/bin/mcp-server.js +769 -561
  2. package/bin/mcp-server.js.map +133 -133
  3. package/bun.lock +15 -15
  4. package/esm/lib/config.d.ts +3 -3
  5. package/esm/lib/config.js +3 -3
  6. package/esm/lib/config.js.map +1 -1
  7. package/esm/lib/encodings.d.ts.map +1 -1
  8. package/esm/lib/encodings.js +20 -5
  9. package/esm/lib/encodings.js.map +1 -1
  10. package/esm/mcp-server/cli/serve/command.d.ts.map +1 -1
  11. package/esm/mcp-server/cli/serve/command.js +6 -0
  12. package/esm/mcp-server/cli/serve/command.js.map +1 -1
  13. package/esm/mcp-server/cli/serve/impl.d.ts.map +1 -1
  14. package/esm/mcp-server/cli/serve/impl.js +2 -0
  15. package/esm/mcp-server/cli/serve/impl.js.map +1 -1
  16. package/esm/mcp-server/cli/start/command.d.ts.map +1 -1
  17. package/esm/mcp-server/cli/start/command.js +6 -0
  18. package/esm/mcp-server/cli/start/command.js.map +1 -1
  19. package/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
  20. package/esm/mcp-server/cli/start/impl.js +3 -0
  21. package/esm/mcp-server/cli/start/impl.js.map +1 -1
  22. package/esm/mcp-server/flags.d.ts +1 -0
  23. package/esm/mcp-server/flags.d.ts.map +1 -1
  24. package/esm/mcp-server/mcp-server.js +1 -1
  25. package/esm/mcp-server/server.d.ts +2 -0
  26. package/esm/mcp-server/server.d.ts.map +1 -1
  27. package/esm/mcp-server/server.js +3 -3
  28. package/esm/mcp-server/server.js.map +1 -1
  29. package/esm/mcp-server/tools/customersCreateCustomer.js +1 -1
  30. package/esm/mcp-server/tools/customersCreateCustomer.js.map +1 -1
  31. package/esm/mcp-server/tools/customersQueryCustomer.js +1 -1
  32. package/esm/mcp-server/tools/customersQueryCustomer.js.map +1 -1
  33. package/esm/mcp-server/tools/eventsGetUsageAnalytics.js +1 -1
  34. package/esm/mcp-server/tools/eventsGetUsageAnalytics.js.map +1 -1
  35. package/esm/mcp-server/tools/eventsGetUsageByMeter.js +1 -1
  36. package/esm/mcp-server/tools/eventsGetUsageByMeter.js.map +1 -1
  37. package/esm/mcp-server/tools/eventsGetUsageStatistics.js +1 -1
  38. package/esm/mcp-server/tools/eventsGetUsageStatistics.js.map +1 -1
  39. package/esm/mcp-server/tools/eventsIngestEvent.js +1 -1
  40. package/esm/mcp-server/tools/eventsIngestEvent.js.map +1 -1
  41. package/esm/mcp-server/tools/eventsIngestEventsBulk.js +1 -1
  42. package/esm/mcp-server/tools/eventsIngestEventsBulk.js.map +1 -1
  43. package/esm/mcp-server/tools/eventsListRawEvents.js +1 -1
  44. package/esm/mcp-server/tools/eventsListRawEvents.js.map +1 -1
  45. package/esm/mcp-server/tools/invoicesCreateInvoice.js +1 -1
  46. package/esm/mcp-server/tools/invoicesCreateInvoice.js.map +1 -1
  47. package/esm/mcp-server/tools/invoicesGetInvoicePreview.d.ts.map +1 -1
  48. package/esm/mcp-server/tools/invoicesGetInvoicePreview.js +1 -1
  49. package/esm/mcp-server/tools/invoicesGetInvoicePreview.js.map +1 -1
  50. package/esm/mcp-server/tools/invoicesQueryInvoice.js +1 -1
  51. package/esm/mcp-server/tools/invoicesQueryInvoice.js.map +1 -1
  52. package/esm/mcp-server/tools/plansCreatePlan.js +1 -1
  53. package/esm/mcp-server/tools/plansCreatePlan.js.map +1 -1
  54. package/esm/mcp-server/tools/plansQueryPlan.js +1 -1
  55. package/esm/mcp-server/tools/plansQueryPlan.js.map +1 -1
  56. package/esm/mcp-server/tools/pricesCreatePrice.js +1 -1
  57. package/esm/mcp-server/tools/pricesCreatePrice.js.map +1 -1
  58. package/esm/mcp-server/tools/pricesCreatePricesBulk.d.ts.map +1 -1
  59. package/esm/mcp-server/tools/pricesCreatePricesBulk.js +1 -1
  60. package/esm/mcp-server/tools/pricesCreatePricesBulk.js.map +1 -1
  61. package/esm/mcp-server/tools/pricesQueryPrice.js +1 -1
  62. package/esm/mcp-server/tools/pricesQueryPrice.js.map +1 -1
  63. package/esm/mcp-server/tools/subscriptionsAddSubscriptionAddon.js +1 -1
  64. package/esm/mcp-server/tools/subscriptionsAddSubscriptionAddon.js.map +1 -1
  65. package/esm/mcp-server/tools/subscriptionsCreateSubscription.d.ts.map +1 -1
  66. package/esm/mcp-server/tools/subscriptionsCreateSubscription.js +1 -1
  67. package/esm/mcp-server/tools/subscriptionsCreateSubscription.js.map +1 -1
  68. package/esm/mcp-server/tools/subscriptionsGetSubscriptionUsage.js +1 -1
  69. package/esm/mcp-server/tools/subscriptionsGetSubscriptionUsage.js.map +1 -1
  70. package/esm/mcp-server/tools/subscriptionsQuerySubscription.js +1 -1
  71. package/esm/mcp-server/tools/subscriptionsQuerySubscription.js.map +1 -1
  72. package/esm/mcp-server/tools/subscriptionsRemoveSubscriptionAddon.js +1 -1
  73. package/esm/mcp-server/tools/subscriptionsRemoveSubscriptionAddon.js.map +1 -1
  74. package/esm/mcp-server/tools.d.ts +8 -1
  75. package/esm/mcp-server/tools.d.ts.map +1 -1
  76. package/esm/mcp-server/tools.js +47 -1
  77. package/esm/mcp-server/tools.js.map +1 -1
  78. package/esm/models/activatesubscriptionop.d.ts.map +1 -1
  79. package/esm/models/activatesubscriptionop.js +1 -1
  80. package/esm/models/activatesubscriptionop.js.map +1 -1
  81. package/esm/models/cancellationtype.d.ts +2 -0
  82. package/esm/models/cancellationtype.d.ts.map +1 -1
  83. package/esm/models/cancellationtype.js +2 -0
  84. package/esm/models/cancellationtype.js.map +1 -1
  85. package/esm/models/cancelsubscriptionop.d.ts.map +1 -1
  86. package/esm/models/cancelsubscriptionop.js +1 -1
  87. package/esm/models/cancelsubscriptionop.js.map +1 -1
  88. package/esm/models/cancelsubscriptionscheduleop.d.ts.map +1 -1
  89. package/esm/models/cancelsubscriptionscheduleop.js +1 -1
  90. package/esm/models/cancelsubscriptionscheduleop.js.map +1 -1
  91. package/esm/models/commitmentinfo.d.ts.map +1 -1
  92. package/esm/models/commitmentinfo.js +2 -2
  93. package/esm/models/commitmentinfo.js.map +1 -1
  94. package/esm/models/createsubscriptionlineitemop.d.ts.map +1 -1
  95. package/esm/models/createsubscriptionlineitemop.js +1 -1
  96. package/esm/models/createsubscriptionlineitemop.js.map +1 -1
  97. package/esm/models/creditgrantexpirydurationunit.d.ts +1 -1
  98. package/esm/models/deletepriceop.js +1 -1
  99. package/esm/models/deletepriceop.js.map +1 -1
  100. package/esm/models/deletesubscriptionlineitemop.d.ts.map +1 -1
  101. package/esm/models/deletesubscriptionlineitemop.js +1 -1
  102. package/esm/models/deletesubscriptionlineitemop.js.map +1 -1
  103. package/esm/models/dtoactivatedraftsubscriptionrequest.d.ts.map +1 -1
  104. package/esm/models/dtoactivatedraftsubscriptionrequest.js +1 -1
  105. package/esm/models/dtoactivatedraftsubscriptionrequest.js.map +1 -1
  106. package/esm/models/dtoaddaddonrequest.d.ts.map +1 -1
  107. package/esm/models/dtoaddaddonrequest.js +1 -1
  108. package/esm/models/dtoaddaddonrequest.js.map +1 -1
  109. package/esm/models/dtoaddaddontosubscriptionrequest.d.ts.map +1 -1
  110. package/esm/models/dtoaddaddontosubscriptionrequest.js +1 -1
  111. package/esm/models/dtoaddaddontosubscriptionrequest.js.map +1 -1
  112. package/esm/models/dtoaddonresponse.d.ts.map +1 -1
  113. package/esm/models/dtoaddonresponse.js +2 -1
  114. package/esm/models/dtoaddonresponse.js.map +1 -1
  115. package/esm/models/dtoaggregatedentitlement.d.ts.map +1 -1
  116. package/esm/models/dtoaggregatedentitlement.js +1 -1
  117. package/esm/models/dtoaggregatedentitlement.js.map +1 -1
  118. package/esm/models/dtobillingcycleinfo.d.ts.map +1 -1
  119. package/esm/models/dtobillingcycleinfo.js +4 -4
  120. package/esm/models/dtobillingcycleinfo.js.map +1 -1
  121. package/esm/models/dtobillingperiodinfo.js +1 -1
  122. package/esm/models/dtobillingperiodinfo.js.map +1 -1
  123. package/esm/models/dtocancelschedulerequest.d.ts.map +1 -1
  124. package/esm/models/dtocancelschedulerequest.js +2 -2
  125. package/esm/models/dtocancelschedulerequest.js.map +1 -1
  126. package/esm/models/dtocancelscheduleresponse.js +1 -1
  127. package/esm/models/dtocancelscheduleresponse.js.map +1 -1
  128. package/esm/models/dtocancelsubscriptionrequest.d.ts +1 -0
  129. package/esm/models/dtocancelsubscriptionrequest.d.ts.map +1 -1
  130. package/esm/models/dtocancelsubscriptionrequest.js +2 -1
  131. package/esm/models/dtocancelsubscriptionrequest.js.map +1 -1
  132. package/esm/models/dtocancelsubscriptionresponse.js +2 -2
  133. package/esm/models/dtocancelsubscriptionresponse.js.map +1 -1
  134. package/esm/models/dtocloneplanrequest.d.ts.map +1 -1
  135. package/esm/models/dtocloneplanrequest.js +4 -4
  136. package/esm/models/dtocloneplanrequest.js.map +1 -1
  137. package/esm/models/dtocouponassociationresponse.js +4 -4
  138. package/esm/models/dtocouponassociationresponse.js.map +1 -1
  139. package/esm/models/dtocreatecreditgrantrequest.d.ts.map +1 -1
  140. package/esm/models/dtocreatecreditgrantrequest.js +2 -2
  141. package/esm/models/dtocreatecreditgrantrequest.js.map +1 -1
  142. package/esm/models/dtocreatecustomerrequest.d.ts.map +1 -1
  143. package/esm/models/dtocreatecustomerrequest.js +15 -15
  144. package/esm/models/dtocreatecustomerrequest.js.map +1 -1
  145. package/esm/models/dtocreateinvoicelineitemrequest.d.ts.map +1 -1
  146. package/esm/models/dtocreateinvoicelineitemrequest.js +18 -18
  147. package/esm/models/dtocreateinvoicelineitemrequest.js.map +1 -1
  148. package/esm/models/dtocreateinvoicerequest.d.ts.map +1 -1
  149. package/esm/models/dtocreateinvoicerequest.js +25 -23
  150. package/esm/models/dtocreateinvoicerequest.js.map +1 -1
  151. package/esm/models/dtocreatepricerequest.d.ts.map +1 -1
  152. package/esm/models/dtocreatepricerequest.js +2 -2
  153. package/esm/models/dtocreatepricerequest.js.map +1 -1
  154. package/esm/models/dtocreatepricetier.d.ts.map +1 -1
  155. package/esm/models/dtocreatepricetier.js +3 -3
  156. package/esm/models/dtocreatepricetier.js.map +1 -1
  157. package/esm/models/dtocreatesubscriptionlineitemrequest.d.ts.map +1 -1
  158. package/esm/models/dtocreatesubscriptionlineitemrequest.js +2 -2
  159. package/esm/models/dtocreatesubscriptionlineitemrequest.js.map +1 -1
  160. package/esm/models/dtocreatesubscriptionrequest.d.ts +2 -0
  161. package/esm/models/dtocreatesubscriptionrequest.d.ts.map +1 -1
  162. package/esm/models/dtocreatesubscriptionrequest.js +22 -16
  163. package/esm/models/dtocreatesubscriptionrequest.js.map +1 -1
  164. package/esm/models/dtocreditgrantresponse.d.ts.map +1 -1
  165. package/esm/models/dtocreditgrantresponse.js +2 -2
  166. package/esm/models/dtocreditgrantresponse.js.map +1 -1
  167. package/esm/models/dtocustomanalyticitem.d.ts.map +1 -1
  168. package/esm/models/dtocustomanalyticitem.js +3 -3
  169. package/esm/models/dtocustomanalyticitem.js.map +1 -1
  170. package/esm/models/dtocustomerinvoicesummary.d.ts.map +1 -1
  171. package/esm/models/dtocustomerinvoicesummary.js +10 -10
  172. package/esm/models/dtocustomerinvoicesummary.js.map +1 -1
  173. package/esm/models/dtocustomermulticurrencyinvoicesummary.d.ts.map +1 -1
  174. package/esm/models/dtocustomermulticurrencyinvoicesummary.js +3 -3
  175. package/esm/models/dtocustomermulticurrencyinvoicesummary.js.map +1 -1
  176. package/esm/models/dtocustomerresponse.d.ts.map +1 -1
  177. package/esm/models/dtocustomerresponse.js +15 -14
  178. package/esm/models/dtocustomerresponse.js.map +1 -1
  179. package/esm/models/dtoentitlementresponse.d.ts.map +1 -1
  180. package/esm/models/dtoentitlementresponse.js +1 -1
  181. package/esm/models/dtoentitlementresponse.js.map +1 -1
  182. package/esm/models/dtogeteventsrequest.d.ts.map +1 -1
  183. package/esm/models/dtogeteventsrequest.js +14 -13
  184. package/esm/models/dtogeteventsrequest.js.map +1 -1
  185. package/esm/models/dtogetpendingschedulesresponse.d.ts.map +1 -1
  186. package/esm/models/dtogetpendingschedulesresponse.js +3 -2
  187. package/esm/models/dtogetpendingschedulesresponse.js.map +1 -1
  188. package/esm/models/dtogetpreviewinvoicerequest.d.ts.map +1 -1
  189. package/esm/models/dtogetpreviewinvoicerequest.js +4 -4
  190. package/esm/models/dtogetpreviewinvoicerequest.js.map +1 -1
  191. package/esm/models/dtogetusageanalyticsrequest.d.ts.map +1 -1
  192. package/esm/models/dtogetusageanalyticsrequest.js +4 -3
  193. package/esm/models/dtogetusageanalyticsrequest.js.map +1 -1
  194. package/esm/models/dtogetusagebymeterrequest.d.ts.map +1 -1
  195. package/esm/models/dtogetusagebymeterrequest.js +1 -1
  196. package/esm/models/dtogetusagebymeterrequest.js.map +1 -1
  197. package/esm/models/dtogetusagebysubscriptionresponse.d.ts.map +1 -1
  198. package/esm/models/dtogetusagebysubscriptionresponse.js +3 -3
  199. package/esm/models/dtogetusagebysubscriptionresponse.js.map +1 -1
  200. package/esm/models/dtogetusagerequest.d.ts.map +1 -1
  201. package/esm/models/dtogetusagerequest.js +3 -3
  202. package/esm/models/dtogetusagerequest.js.map +1 -1
  203. package/esm/models/dtoingesteventrequest.d.ts.map +1 -1
  204. package/esm/models/dtoingesteventrequest.js +2 -2
  205. package/esm/models/dtoingesteventrequest.js.map +1 -1
  206. package/esm/models/dtointegrationentitymapping.d.ts.map +1 -1
  207. package/esm/models/dtointegrationentitymapping.js +2 -2
  208. package/esm/models/dtointegrationentitymapping.js.map +1 -1
  209. package/esm/models/dtoinvoicelineitemcoupon.js +1 -1
  210. package/esm/models/dtoinvoicelineitemcoupon.js.map +1 -1
  211. package/esm/models/dtoinvoicelineitempreview.d.ts.map +1 -1
  212. package/esm/models/dtoinvoicelineitempreview.js +7 -7
  213. package/esm/models/dtoinvoicelineitempreview.js.map +1 -1
  214. package/esm/models/dtoinvoicelineitemresponse.d.ts.map +1 -1
  215. package/esm/models/dtoinvoicelineitemresponse.js +5 -5
  216. package/esm/models/dtoinvoicelineitemresponse.js.map +1 -1
  217. package/esm/models/dtoinvoicepreview.d.ts.map +1 -1
  218. package/esm/models/dtoinvoicepreview.js +7 -6
  219. package/esm/models/dtoinvoicepreview.js.map +1 -1
  220. package/esm/models/dtoinvoiceresponse.d.ts.map +1 -1
  221. package/esm/models/dtoinvoiceresponse.js +36 -35
  222. package/esm/models/dtoinvoiceresponse.js.map +1 -1
  223. package/esm/models/dtolineitemcommitmentconfig.d.ts.map +1 -1
  224. package/esm/models/dtolineitemcommitmentconfig.js +5 -5
  225. package/esm/models/dtolineitemcommitmentconfig.js.map +1 -1
  226. package/esm/models/dtolistsubscriptionpausesresponse.d.ts.map +1 -1
  227. package/esm/models/dtolistsubscriptionpausesresponse.js +2 -2
  228. package/esm/models/dtolistsubscriptionpausesresponse.js.map +1 -1
  229. package/esm/models/dtooverrideentitlementrequest.d.ts.map +1 -1
  230. package/esm/models/dtooverrideentitlementrequest.js +4 -4
  231. package/esm/models/dtooverrideentitlementrequest.js.map +1 -1
  232. package/esm/models/dtooverridelineitemrequest.d.ts.map +1 -1
  233. package/esm/models/dtooverridelineitemrequest.js +6 -6
  234. package/esm/models/dtooverridelineitemrequest.js.map +1 -1
  235. package/esm/models/dtopausesubscriptionrequest.d.ts.map +1 -1
  236. package/esm/models/dtopausesubscriptionrequest.js +6 -6
  237. package/esm/models/dtopausesubscriptionrequest.js.map +1 -1
  238. package/esm/models/dtoplanresponse.d.ts.map +1 -1
  239. package/esm/models/dtoplanresponse.js +1 -1
  240. package/esm/models/dtoplanresponse.js.map +1 -1
  241. package/esm/models/dtoplansummary.js +4 -4
  242. package/esm/models/dtoplansummary.js.map +1 -1
  243. package/esm/models/dtopriceresponse.d.ts.map +1 -1
  244. package/esm/models/dtopriceresponse.js +23 -23
  245. package/esm/models/dtopriceresponse.js.map +1 -1
  246. package/esm/models/dtoprorationdetails.d.ts.map +1 -1
  247. package/esm/models/dtoprorationdetails.js +11 -11
  248. package/esm/models/dtoprorationdetails.js.map +1 -1
  249. package/esm/models/dtoresumesubscriptionrequest.d.ts.map +1 -1
  250. package/esm/models/dtoresumesubscriptionrequest.js +2 -2
  251. package/esm/models/dtoresumesubscriptionrequest.js.map +1 -1
  252. package/esm/models/dtosourceusageitem.d.ts.map +1 -1
  253. package/esm/models/dtosourceusageitem.js +5 -5
  254. package/esm/models/dtosourceusageitem.js.map +1 -1
  255. package/esm/models/dtosubscriptionchangeexecuteresponse.d.ts.map +1 -1
  256. package/esm/models/dtosubscriptionchangeexecuteresponse.js +6 -6
  257. package/esm/models/dtosubscriptionchangeexecuteresponse.js.map +1 -1
  258. package/esm/models/dtosubscriptionchangepreviewresponse.d.ts.map +1 -1
  259. package/esm/models/dtosubscriptionchangepreviewresponse.js +4 -4
  260. package/esm/models/dtosubscriptionchangepreviewresponse.js.map +1 -1
  261. package/esm/models/dtosubscriptionchangerequest.d.ts.map +1 -1
  262. package/esm/models/dtosubscriptionchangerequest.js +3 -3
  263. package/esm/models/dtosubscriptionchangerequest.js.map +1 -1
  264. package/esm/models/dtosubscriptionlineitemresponse.d.ts.map +1 -1
  265. package/esm/models/dtosubscriptionlineitemresponse.js +2 -2
  266. package/esm/models/dtosubscriptionlineitemresponse.js.map +1 -1
  267. package/esm/models/dtosubscriptionpauseresponse.d.ts.map +1 -1
  268. package/esm/models/dtosubscriptionpauseresponse.js +9 -9
  269. package/esm/models/dtosubscriptionpauseresponse.js.map +1 -1
  270. package/esm/models/dtosubscriptionphasecreaterequest.d.ts.map +1 -1
  271. package/esm/models/dtosubscriptionphasecreaterequest.js +5 -3
  272. package/esm/models/dtosubscriptionphasecreaterequest.js.map +1 -1
  273. package/esm/models/dtosubscriptionphaseresponse.d.ts.map +1 -1
  274. package/esm/models/dtosubscriptionphaseresponse.js +5 -5
  275. package/esm/models/dtosubscriptionphaseresponse.js.map +1 -1
  276. package/esm/models/dtosubscriptionresponse.d.ts.map +1 -1
  277. package/esm/models/dtosubscriptionresponse.js +30 -30
  278. package/esm/models/dtosubscriptionresponse.js.map +1 -1
  279. package/esm/models/dtosubscriptionresponsev2.d.ts.map +1 -1
  280. package/esm/models/dtosubscriptionresponsev2.js +33 -32
  281. package/esm/models/dtosubscriptionresponsev2.js.map +1 -1
  282. package/esm/models/dtosubscriptionscheduleresponse.d.ts.map +1 -1
  283. package/esm/models/dtosubscriptionscheduleresponse.js +13 -13
  284. package/esm/models/dtosubscriptionscheduleresponse.js.map +1 -1
  285. package/esm/models/dtosubscriptionsummary.d.ts.map +1 -1
  286. package/esm/models/dtosubscriptionsummary.js +7 -7
  287. package/esm/models/dtosubscriptionsummary.js.map +1 -1
  288. package/esm/models/dtosubscriptionusagebymetersresponse.d.ts.map +1 -1
  289. package/esm/models/dtosubscriptionusagebymetersresponse.js +3 -3
  290. package/esm/models/dtosubscriptionusagebymetersresponse.js.map +1 -1
  291. package/esm/models/dtoupdatecustomerrequest.d.ts.map +1 -1
  292. package/esm/models/dtoupdatecustomerrequest.js +13 -13
  293. package/esm/models/dtoupdatecustomerrequest.js.map +1 -1
  294. package/esm/models/dtoupdateinvoicerequest.d.ts.map +1 -1
  295. package/esm/models/dtoupdateinvoicerequest.js +1 -1
  296. package/esm/models/dtoupdateinvoicerequest.js.map +1 -1
  297. package/esm/models/dtoupdatepaymentstatusrequest.d.ts.map +1 -1
  298. package/esm/models/dtoupdatepaymentstatusrequest.js +1 -1
  299. package/esm/models/dtoupdatepaymentstatusrequest.js.map +1 -1
  300. package/esm/models/dtoupdatepricerequest.d.ts.map +1 -1
  301. package/esm/models/dtoupdatepricerequest.js +6 -6
  302. package/esm/models/dtoupdatepricerequest.js.map +1 -1
  303. package/esm/models/dtoupdatesubscriptionlineitemrequest.d.ts.map +1 -1
  304. package/esm/models/dtoupdatesubscriptionlineitemrequest.js +5 -5
  305. package/esm/models/dtoupdatesubscriptionlineitemrequest.js.map +1 -1
  306. package/esm/models/dtoupdatesubscriptionrequest.d.ts.map +1 -1
  307. package/esm/models/dtoupdatesubscriptionrequest.js +1 -1
  308. package/esm/models/dtoupdatesubscriptionrequest.js.map +1 -1
  309. package/esm/models/dtousageanalyticitem.d.ts.map +1 -1
  310. package/esm/models/dtousageanalyticitem.js +8 -8
  311. package/esm/models/dtousageanalyticitem.js.map +1 -1
  312. package/esm/models/dtousageanalyticpoint.d.ts.map +1 -1
  313. package/esm/models/dtousageanalyticpoint.js +2 -2
  314. package/esm/models/dtousageanalyticpoint.js.map +1 -1
  315. package/esm/models/dtousagebreakdownitem.d.ts.map +1 -1
  316. package/esm/models/dtousagebreakdownitem.js +5 -5
  317. package/esm/models/dtousagebreakdownitem.js.map +1 -1
  318. package/esm/models/executesubscriptionchangeop.d.ts.map +1 -1
  319. package/esm/models/executesubscriptionchangeop.js +1 -1
  320. package/esm/models/executesubscriptionchangeop.js.map +1 -1
  321. package/esm/models/githubcomflexpriceflexpriceinternaldomaincustomercustomer.d.ts.map +1 -1
  322. package/esm/models/githubcomflexpriceflexpriceinternaldomaincustomercustomer.js +13 -13
  323. package/esm/models/githubcomflexpriceflexpriceinternaldomaincustomercustomer.js.map +1 -1
  324. package/esm/models/invoicefilter.d.ts.map +1 -1
  325. package/esm/models/invoicefilter.js +13 -13
  326. package/esm/models/invoicefilter.js.map +1 -1
  327. package/esm/models/meteraggregation.d.ts.map +1 -1
  328. package/esm/models/meteraggregation.js +4 -4
  329. package/esm/models/meteraggregation.js.map +1 -1
  330. package/esm/models/meterfilter.d.ts.map +1 -1
  331. package/esm/models/meterfilter.js +2 -2
  332. package/esm/models/meterfilter.js.map +1 -1
  333. package/esm/models/metermeter.d.ts.map +1 -1
  334. package/esm/models/metermeter.js +5 -5
  335. package/esm/models/metermeter.js.map +1 -1
  336. package/esm/models/pausesubscriptionop.d.ts.map +1 -1
  337. package/esm/models/pausesubscriptionop.js +1 -1
  338. package/esm/models/pausesubscriptionop.js.map +1 -1
  339. package/esm/models/planfilter.d.ts.map +1 -1
  340. package/esm/models/planfilter.js +1 -1
  341. package/esm/models/planfilter.js.map +1 -1
  342. package/esm/models/postplansidcloneop.js +1 -1
  343. package/esm/models/postplansidcloneop.js.map +1 -1
  344. package/esm/models/previewsubscriptionchangeop.d.ts.map +1 -1
  345. package/esm/models/previewsubscriptionchangeop.js +1 -1
  346. package/esm/models/previewsubscriptionchangeop.js.map +1 -1
  347. package/esm/models/pricefilter.d.ts.map +1 -1
  348. package/esm/models/pricefilter.js +2 -2
  349. package/esm/models/pricefilter.js.map +1 -1
  350. package/esm/models/pricejsonbtransformquantity.js +1 -1
  351. package/esm/models/pricejsonbtransformquantity.js.map +1 -1
  352. package/esm/models/priceprice.d.ts.map +1 -1
  353. package/esm/models/priceprice.js +23 -23
  354. package/esm/models/priceprice.js.map +1 -1
  355. package/esm/models/pricepricetier.d.ts.map +1 -1
  356. package/esm/models/pricepricetier.js +3 -3
  357. package/esm/models/pricepricetier.js.map +1 -1
  358. package/esm/models/pricetransformquantity.js +1 -1
  359. package/esm/models/pricetransformquantity.js.map +1 -1
  360. package/esm/models/reportingunit.d.ts.map +1 -1
  361. package/esm/models/reportingunit.js +3 -3
  362. package/esm/models/reportingunit.js.map +1 -1
  363. package/esm/models/resumesubscriptionop.d.ts.map +1 -1
  364. package/esm/models/resumesubscriptionop.js +1 -1
  365. package/esm/models/resumesubscriptionop.js.map +1 -1
  366. package/esm/models/subscriptionfilter.d.ts.map +1 -1
  367. package/esm/models/subscriptionfilter.js +11 -10
  368. package/esm/models/subscriptionfilter.js.map +1 -1
  369. package/esm/models/subscriptionsubscriptionlineitem.d.ts.map +1 -1
  370. package/esm/models/subscriptionsubscriptionlineitem.js +2 -2
  371. package/esm/models/subscriptionsubscriptionlineitem.js.map +1 -1
  372. package/esm/models/subscriptionsubscriptionpause.d.ts.map +1 -1
  373. package/esm/models/subscriptionsubscriptionpause.js +9 -9
  374. package/esm/models/subscriptionsubscriptionpause.js.map +1 -1
  375. package/esm/models/updatecustomerop.js +1 -1
  376. package/esm/models/updatecustomerop.js.map +1 -1
  377. package/esm/models/updateinvoiceop.js +1 -1
  378. package/esm/models/updateinvoiceop.js.map +1 -1
  379. package/esm/models/updateinvoicepaymentstatusop.d.ts.map +1 -1
  380. package/esm/models/updateinvoicepaymentstatusop.js +1 -1
  381. package/esm/models/updateinvoicepaymentstatusop.js.map +1 -1
  382. package/esm/models/updateplanop.js +1 -1
  383. package/esm/models/updateplanop.js.map +1 -1
  384. package/esm/models/updatepriceop.js +1 -1
  385. package/esm/models/updatepriceop.js.map +1 -1
  386. package/esm/models/updatesubscriptionlineitemop.d.ts.map +1 -1
  387. package/esm/models/updatesubscriptionlineitemop.js +1 -1
  388. package/esm/models/updatesubscriptionlineitemop.js.map +1 -1
  389. package/esm/models/updatesubscriptionop.d.ts.map +1 -1
  390. package/esm/models/updatesubscriptionop.js +1 -1
  391. package/esm/models/updatesubscriptionop.js.map +1 -1
  392. package/esm/models/windowsize.d.ts +2 -2
  393. package/esm/models/windowsize.js +2 -2
  394. package/esm/models/windowsize.js.map +1 -1
  395. package/esm/tsconfig.tsbuildinfo +1 -1
  396. package/manifest.json +1 -1
  397. package/package.json +1 -1
  398. package/src/lib/config.ts +3 -3
  399. package/src/lib/encodings.ts +23 -4
  400. package/src/mcp-server/cli/serve/command.ts +7 -0
  401. package/src/mcp-server/cli/serve/impl.ts +2 -0
  402. package/src/mcp-server/cli/start/command.ts +7 -0
  403. package/src/mcp-server/cli/start/impl.ts +3 -0
  404. package/src/mcp-server/flags.ts +1 -0
  405. package/src/mcp-server/mcp-server.ts +1 -1
  406. package/src/mcp-server/server.ts +8 -2
  407. package/src/mcp-server/tools/customersCreateCustomer.ts +1 -1
  408. package/src/mcp-server/tools/customersQueryCustomer.ts +1 -1
  409. package/src/mcp-server/tools/eventsGetUsageAnalytics.ts +1 -1
  410. package/src/mcp-server/tools/eventsGetUsageByMeter.ts +1 -1
  411. package/src/mcp-server/tools/eventsGetUsageStatistics.ts +1 -1
  412. package/src/mcp-server/tools/eventsIngestEvent.ts +1 -1
  413. package/src/mcp-server/tools/eventsIngestEventsBulk.ts +1 -1
  414. package/src/mcp-server/tools/eventsListRawEvents.ts +1 -1
  415. package/src/mcp-server/tools/invoicesCreateInvoice.ts +1 -1
  416. package/src/mcp-server/tools/invoicesGetInvoicePreview.ts +3 -1
  417. package/src/mcp-server/tools/invoicesQueryInvoice.ts +1 -1
  418. package/src/mcp-server/tools/plansCreatePlan.ts +1 -1
  419. package/src/mcp-server/tools/plansQueryPlan.ts +1 -1
  420. package/src/mcp-server/tools/pricesCreatePrice.ts +1 -1
  421. package/src/mcp-server/tools/pricesCreatePricesBulk.ts +3 -1
  422. package/src/mcp-server/tools/pricesQueryPrice.ts +1 -1
  423. package/src/mcp-server/tools/subscriptionsAddSubscriptionAddon.ts +1 -1
  424. package/src/mcp-server/tools/subscriptionsCreateSubscription.ts +3 -1
  425. package/src/mcp-server/tools/subscriptionsGetSubscriptionUsage.ts +1 -1
  426. package/src/mcp-server/tools/subscriptionsQuerySubscription.ts +1 -1
  427. package/src/mcp-server/tools/subscriptionsRemoveSubscriptionAddon.ts +1 -1
  428. package/src/mcp-server/tools.ts +73 -0
  429. package/src/models/activatesubscriptionop.ts +3 -1
  430. package/src/models/cancellationtype.ts +2 -0
  431. package/src/models/cancelsubscriptionop.ts +3 -1
  432. package/src/models/cancelsubscriptionscheduleop.ts +3 -1
  433. package/src/models/commitmentinfo.ts +6 -2
  434. package/src/models/createsubscriptionlineitemop.ts +3 -1
  435. package/src/models/deletepriceop.ts +1 -1
  436. package/src/models/deletesubscriptionlineitemop.ts +3 -1
  437. package/src/models/dtoactivatedraftsubscriptionrequest.ts +3 -1
  438. package/src/models/dtoaddaddonrequest.ts +3 -1
  439. package/src/models/dtoaddaddontosubscriptionrequest.ts +3 -1
  440. package/src/models/dtoaddonresponse.ts +2 -1
  441. package/src/models/dtoaggregatedentitlement.ts +3 -1
  442. package/src/models/dtobillingcycleinfo.ts +12 -4
  443. package/src/models/dtobillingperiodinfo.ts +1 -1
  444. package/src/models/dtocancelschedulerequest.ts +6 -2
  445. package/src/models/dtocancelscheduleresponse.ts +1 -1
  446. package/src/models/dtocancelsubscriptionrequest.ts +7 -1
  447. package/src/models/dtocancelsubscriptionresponse.ts +2 -2
  448. package/src/models/dtocloneplanrequest.ts +12 -4
  449. package/src/models/dtocouponassociationresponse.ts +4 -4
  450. package/src/models/dtocreatecreditgrantrequest.ts +6 -2
  451. package/src/models/dtocreatecustomerrequest.ts +45 -15
  452. package/src/models/dtocreateinvoicelineitemrequest.ts +54 -18
  453. package/src/models/dtocreateinvoicerequest.ts +65 -23
  454. package/src/models/dtocreatepricerequest.ts +6 -2
  455. package/src/models/dtocreatepricetier.ts +9 -3
  456. package/src/models/dtocreatesubscriptionlineitemrequest.ts +4 -2
  457. package/src/models/dtocreatesubscriptionrequest.ts +56 -16
  458. package/src/models/dtocreditgrantresponse.ts +6 -2
  459. package/src/models/dtocustomanalyticitem.ts +9 -3
  460. package/src/models/dtocustomerinvoicesummary.ts +30 -10
  461. package/src/models/dtocustomermulticurrencyinvoicesummary.ts +9 -3
  462. package/src/models/dtocustomerresponse.ts +35 -14
  463. package/src/models/dtoentitlementresponse.ts +3 -1
  464. package/src/models/dtogeteventsrequest.ts +40 -13
  465. package/src/models/dtogetpendingschedulesresponse.ts +5 -2
  466. package/src/models/dtogetpreviewinvoicerequest.ts +12 -4
  467. package/src/models/dtogetusageanalyticsrequest.ts +10 -3
  468. package/src/models/dtogetusagebymeterrequest.ts +3 -1
  469. package/src/models/dtogetusagebysubscriptionresponse.ts +9 -3
  470. package/src/models/dtogetusagerequest.ts +9 -3
  471. package/src/models/dtoingesteventrequest.ts +6 -2
  472. package/src/models/dtointegrationentitymapping.ts +4 -2
  473. package/src/models/dtoinvoicelineitemcoupon.ts +1 -1
  474. package/src/models/dtoinvoicelineitempreview.ts +13 -7
  475. package/src/models/dtoinvoicelineitemresponse.ts +15 -5
  476. package/src/models/dtoinvoicepreview.ts +17 -6
  477. package/src/models/dtoinvoiceresponse.ts +106 -35
  478. package/src/models/dtolineitemcommitmentconfig.ts +15 -5
  479. package/src/models/dtolistsubscriptionpausesresponse.ts +6 -2
  480. package/src/models/dtooverrideentitlementrequest.ts +12 -4
  481. package/src/models/dtooverridelineitemrequest.ts +18 -6
  482. package/src/models/dtopausesubscriptionrequest.ts +18 -6
  483. package/src/models/dtoplanresponse.ts +3 -1
  484. package/src/models/dtoplansummary.ts +4 -4
  485. package/src/models/dtopriceresponse.ts +65 -23
  486. package/src/models/dtoprorationdetails.ts +33 -11
  487. package/src/models/dtoresumesubscriptionrequest.ts +6 -2
  488. package/src/models/dtosourceusageitem.ts +15 -5
  489. package/src/models/dtosubscriptionchangeexecuteresponse.ts +18 -6
  490. package/src/models/dtosubscriptionchangepreviewresponse.ts +12 -4
  491. package/src/models/dtosubscriptionchangerequest.ts +9 -3
  492. package/src/models/dtosubscriptionlineitemresponse.ts +4 -2
  493. package/src/models/dtosubscriptionpauseresponse.ts +25 -9
  494. package/src/models/dtosubscriptionphasecreaterequest.ts +11 -3
  495. package/src/models/dtosubscriptionphaseresponse.ts +15 -5
  496. package/src/models/dtosubscriptionresponse.ts +90 -30
  497. package/src/models/dtosubscriptionresponsev2.ts +97 -32
  498. package/src/models/dtosubscriptionscheduleresponse.ts +33 -13
  499. package/src/models/dtosubscriptionsummary.ts +15 -7
  500. package/src/models/dtosubscriptionusagebymetersresponse.ts +9 -3
  501. package/src/models/dtoupdatecustomerrequest.ts +39 -13
  502. package/src/models/dtoupdateinvoicerequest.ts +3 -1
  503. package/src/models/dtoupdatepaymentstatusrequest.ts +3 -1
  504. package/src/models/dtoupdatepricerequest.ts +18 -6
  505. package/src/models/dtoupdatesubscriptionlineitemrequest.ts +13 -5
  506. package/src/models/dtoupdatesubscriptionrequest.ts +3 -1
  507. package/src/models/dtousageanalyticitem.ts +18 -8
  508. package/src/models/dtousageanalyticpoint.ts +6 -2
  509. package/src/models/dtousagebreakdownitem.ts +15 -5
  510. package/src/models/executesubscriptionchangeop.ts +3 -1
  511. package/src/models/githubcomflexpriceflexpriceinternaldomaincustomercustomer.ts +37 -13
  512. package/src/models/invoicefilter.ts +39 -13
  513. package/src/models/meteraggregation.ts +12 -4
  514. package/src/models/meterfilter.ts +6 -2
  515. package/src/models/metermeter.ts +13 -5
  516. package/src/models/pausesubscriptionop.ts +3 -1
  517. package/src/models/planfilter.ts +3 -1
  518. package/src/models/postplansidcloneop.ts +1 -1
  519. package/src/models/previewsubscriptionchangeop.ts +3 -1
  520. package/src/models/pricefilter.ts +6 -2
  521. package/src/models/pricejsonbtransformquantity.ts +1 -1
  522. package/src/models/priceprice.ts +65 -23
  523. package/src/models/pricepricetier.ts +9 -3
  524. package/src/models/pricetransformquantity.ts +1 -1
  525. package/src/models/reportingunit.ts +9 -3
  526. package/src/models/resumesubscriptionop.ts +3 -1
  527. package/src/models/subscriptionfilter.ts +27 -10
  528. package/src/models/subscriptionsubscriptionlineitem.ts +4 -2
  529. package/src/models/subscriptionsubscriptionpause.ts +25 -9
  530. package/src/models/updatecustomerop.ts +1 -1
  531. package/src/models/updateinvoiceop.ts +1 -1
  532. package/src/models/updateinvoicepaymentstatusop.ts +3 -1
  533. package/src/models/updateplanop.ts +1 -1
  534. package/src/models/updatepriceop.ts +1 -1
  535. package/src/models/updatesubscriptionlineitemop.ts +3 -1
  536. package/src/models/updatesubscriptionop.ts +3 -1
  537. package/src/models/windowsize.ts +2 -2
package/bin/mcp-server.js CHANGED
@@ -50445,9 +50445,9 @@ var init_config = __esm(() => {
50445
50445
  SDK_METADATA = {
50446
50446
  language: "typescript",
50447
50447
  openapiDocVersion: "1.0",
50448
- sdkVersion: "2.0.10",
50449
- genVersion: "2.866.2",
50450
- userAgent: "speakeasy-sdk/mcp-typescript 2.0.10 2.866.2 1.0 @flexprice/mcp-server"
50448
+ sdkVersion: "2.0.12",
50449
+ genVersion: "2.869.23",
50450
+ userAgent: "speakeasy-sdk/mcp-typescript 2.0.12 2.869.23 1.0 @flexprice/mcp-server"
50451
50451
  };
50452
50452
  });
50453
50453
 
@@ -51334,6 +51334,21 @@ function createRegisterResourceTemplate(logger, server, getSDK, allowedScopes) {
51334
51334
  var init_resources = () => {};
51335
51335
 
51336
51336
  // src/mcp-server/tools.ts
51337
+ function buildAnnotationFilter(annotations) {
51338
+ const filter = {};
51339
+ if (!annotations || annotations.length === 0) {
51340
+ return filter;
51341
+ }
51342
+ for (const a of annotations) {
51343
+ if (!VALID_ANNOTATIONS.includes(a)) {
51344
+ throw new Error(`Invalid annotation filter: "${a}". Valid values are: ${VALID_ANNOTATIONS.join(", ")}`);
51345
+ }
51346
+ }
51347
+ for (const name of VALID_ANNOTATIONS) {
51348
+ filter[annotationToKey[name]] = annotations.includes(name);
51349
+ }
51350
+ return filter;
51351
+ }
51337
51352
  async function formatResult(response) {
51338
51353
  let content = [];
51339
51354
  const contentType = response?.headers.get("content-type") ?? "";
@@ -51349,7 +51364,7 @@ async function formatResult(response) {
51349
51364
  }
51350
51365
  return response.ok ? { content } : { content, isError: true };
51351
51366
  }
51352
- function createRegisterTool(logger, server, getSDK, allowedScopes, allowedTools, dynamic) {
51367
+ function createRegisterTool(logger, server, getSDK, allowedScopes, allowedTools, dynamic, annotationFilter) {
51353
51368
  const tools = [];
51354
51369
  const toolMap = new Map;
51355
51370
  const registerTool = (tool) => {
@@ -51363,6 +51378,21 @@ function createRegisterTool(logger, server, getSDK, allowedScopes, allowedTools,
51363
51378
  if (allowedScopes.size > 0 && !scopes.every((s) => allowedScopes.has(s))) {
51364
51379
  return;
51365
51380
  }
51381
+ if (annotationFilter) {
51382
+ const a = tool.annotations;
51383
+ if (annotationFilter.readOnlyHint !== undefined && a.readOnlyHint !== annotationFilter.readOnlyHint) {
51384
+ return;
51385
+ }
51386
+ if (annotationFilter.destructiveHint !== undefined && a.destructiveHint !== annotationFilter.destructiveHint) {
51387
+ return;
51388
+ }
51389
+ if (annotationFilter.idempotentHint !== undefined && a.idempotentHint !== annotationFilter.idempotentHint) {
51390
+ return;
51391
+ }
51392
+ if (annotationFilter.openWorldHint !== undefined && a.openWorldHint !== annotationFilter.openWorldHint) {
51393
+ return;
51394
+ }
51395
+ }
51366
51396
  toolMap.set(tool.name, tool);
51367
51397
  if (dynamic) {
51368
51398
  logger.debug("Collected tool for dynamic mode", { name: tool.name });
@@ -51591,11 +51621,24 @@ function buildSDK(headers, cliFlags, disableStaticAuth, logger) {
51591
51621
  } : undefined
51592
51622
  });
51593
51623
  }
51624
+ var VALID_ANNOTATIONS, annotationToKey;
51594
51625
  var init_tools = __esm(() => {
51595
51626
  init_zod();
51596
51627
  init_core3();
51597
51628
  init_scopes();
51598
51629
  init_shared();
51630
+ VALID_ANNOTATIONS = [
51631
+ "readOnly",
51632
+ "destructive",
51633
+ "idempotent",
51634
+ "openWorld"
51635
+ ];
51636
+ annotationToKey = {
51637
+ readOnly: "readOnlyHint",
51638
+ destructive: "destructiveHint",
51639
+ idempotent: "idempotentHint",
51640
+ openWorld: "openWorldHint"
51641
+ };
51599
51642
  });
51600
51643
 
51601
51644
  // src/lib/primitives.ts
@@ -51793,8 +51836,8 @@ var init_dtointegrationentitymapping = __esm(() => {
51793
51836
  "paypal"
51794
51837
  ]).describe('provider is the integration provider name (e.g., "stripe", "razorpay")');
51795
51838
  DtoIntegrationEntityMapping$zodSchema = object({
51796
- id: string2(),
51797
- provider: Provider$zodSchema
51839
+ id: string2().describe("id is the external entity ID from the provider"),
51840
+ provider: Provider$zodSchema.describe('provider is the integration provider name (e.g., "stripe", "razorpay")')
51798
51841
  }).describe("Integration entity mapping for external provider systems");
51799
51842
  });
51800
51843
 
@@ -51818,21 +51861,27 @@ var init_dtocreatecustomerrequest = __esm(() => {
51818
51861
  init_dtointegrationentitymapping();
51819
51862
  init_dtotaxrateoverride();
51820
51863
  DtoCreateCustomerRequest$zodSchema = object({
51821
- address_city: string2().optional(),
51822
- address_country: string2().optional(),
51823
- address_line1: string2().optional(),
51824
- address_line2: string2().optional(),
51825
- address_postal_code: string2().optional(),
51826
- address_state: string2().optional(),
51827
- email: string2().optional(),
51828
- external_id: string2(),
51829
- integration_entity_mapping: array(DtoIntegrationEntityMapping$zodSchema).optional(),
51830
- metadata: record(string2(), string2()).optional(),
51831
- name: string2().optional(),
51832
- parent_customer_external_id: string2().optional(),
51833
- parent_customer_id: string2().optional(),
51834
- skip_onboarding_workflow: boolean2().optional(),
51835
- tax_rate_overrides: array(DtoTaxRateOverride$zodSchema).optional()
51864
+ address_city: string2().optional().describe("address_city is the city name with maximum 100 characters"),
51865
+ address_country: string2().optional().describe("address_country is the two-letter ISO 3166-1 alpha-2 country code"),
51866
+ address_line1: string2().optional().describe("address_line1 is the primary address line with maximum 255 characters"),
51867
+ address_line2: string2().optional().describe("address_line2 is the secondary address line with maximum 255 characters"),
51868
+ address_postal_code: string2().optional().describe("address_postal_code is the ZIP code or postal code with maximum 20 characters"),
51869
+ address_state: string2().optional().describe("address_state is the state, province, or region name with maximum 100 characters"),
51870
+ email: string2().optional().describe("email is the customer's email address and must be a valid email format if provided"),
51871
+ external_id: string2().describe("external_id is the unique identifier from your system to reference this customer (required)"),
51872
+ integration_entity_mapping: array(DtoIntegrationEntityMapping$zodSchema).optional().describe("integration_entity_mapping contains provider integration mappings for this customer"),
51873
+ metadata: record(string2(), string2()).optional().describe("metadata contains additional key-value pairs for storing extra information"),
51874
+ name: string2().optional().describe("name is the full name or company name of the customer"),
51875
+ parent_customer_external_id: string2().optional().describe(`Deprecated: See ParentCustomerID.
51876
+ parent_customer_external_id is the external ID of the parent customer from your system.
51877
+ Exactly one of parent_customer_id or parent_customer_external_id may be provided.`),
51878
+ parent_customer_id: string2().optional().describe(`Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.
51879
+ This field is accepted for backward compatibility but no hierarchy validations are enforced.
51880
+ parent_customer_id is the internal FlexPrice ID of the parent customer.`),
51881
+ skip_onboarding_workflow: boolean2().optional().describe(`skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered
51882
+ This is used internally when a customer is created via a workflow to prevent infinite loops
51883
+ Default: false`),
51884
+ tax_rate_overrides: array(DtoTaxRateOverride$zodSchema).optional().describe("tax_rate_overrides contains tax rate configurations to be linked to this customer")
51836
51885
  }).describe("Request object for creating a new customer in the system");
51837
51886
  });
51838
51887
 
@@ -51942,7 +51991,7 @@ var init_customersCreateCustomer2 = __esm(() => {
51942
51991
  init_dtocreatecustomerrequest();
51943
51992
  init_tools();
51944
51993
  args = {
51945
- request: DtoCreateCustomerRequest$zodSchema
51994
+ request: DtoCreateCustomerRequest$zodSchema.describe(`Customer`)
51946
51995
  };
51947
51996
  tool$customersCreateCustomer = {
51948
51997
  name: "create-customer",
@@ -52111,22 +52160,24 @@ var init_dtocustomerresponse = __esm(() => {
52111
52160
  init_zod();
52112
52161
  init_status();
52113
52162
  DtoCustomerResponse$zodSchema = object({
52114
- address_city: string2().optional(),
52115
- address_country: string2().optional(),
52116
- address_line1: string2().optional(),
52117
- address_line2: string2().optional(),
52118
- address_postal_code: string2().optional(),
52119
- address_state: string2().optional(),
52163
+ address_city: string2().optional().describe("AddressCity is the city of the customer's address"),
52164
+ address_country: string2().optional().describe("AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)"),
52165
+ address_line1: string2().optional().describe("AddressLine1 is the first line of the customer's address"),
52166
+ address_line2: string2().optional().describe("AddressLine2 is the second line of the customer's address"),
52167
+ address_postal_code: string2().optional().describe("AddressPostalCode is the postal code of the customer's address"),
52168
+ address_state: string2().optional().describe("AddressState is the state of the customer's address"),
52120
52169
  created_at: string2().optional(),
52121
52170
  created_by: string2().optional(),
52122
- email: string2().optional(),
52123
- environment_id: string2().optional(),
52124
- external_id: string2().optional(),
52125
- id: string2().optional(),
52126
- metadata: record(string2(), string2()).optional(),
52127
- name: string2().optional(),
52128
- parent_customer: lazy(() => DtoCustomerResponse$zodSchema).optional(),
52129
- parent_customer_id: string2().optional(),
52171
+ email: string2().optional().describe("Email is the email of the customer"),
52172
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the customer"),
52173
+ external_id: string2().optional().describe("ExternalID is the external identifier for the customer"),
52174
+ id: string2().optional().describe("ID is the unique identifier for the customer"),
52175
+ metadata: record(string2(), string2()).optional().describe("Metadata"),
52176
+ name: string2().optional().describe("Name is the name of the customer"),
52177
+ parent_customer: lazy(() => DtoCustomerResponse$zodSchema).optional().describe("Customer response object containing all customer information"),
52178
+ parent_customer_id: string2().optional().describe(`Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.
52179
+ Retained for backward compatibility; no hierarchy rules are enforced at the service layer.
52180
+ ParentCustomerID is the parent customer identifier for the customer.`),
52130
52181
  status: Status$zodSchema.optional(),
52131
52182
  tenant_id: string2().optional(),
52132
52183
  updated_at: string2().optional(),
@@ -52436,7 +52487,7 @@ var init_dtoaggregatedentitlement = __esm(() => {
52436
52487
  DtoAggregatedEntitlement$zodSchema = object({
52437
52488
  is_enabled: boolean2().optional(),
52438
52489
  is_soft_limit: boolean2().optional(),
52439
- static_values: array(string2()).optional(),
52490
+ static_values: array(string2()).optional().describe("For static/SLA features"),
52440
52491
  usage_limit: int().optional(),
52441
52492
  usage_reset_period: EntitlementUsageResetPeriod$zodSchema.optional()
52442
52493
  });
@@ -52559,7 +52610,6 @@ var WindowSize$zodSchema;
52559
52610
  var init_windowsize = __esm(() => {
52560
52611
  init_zod();
52561
52612
  WindowSize$zodSchema = _enum([
52562
- "MONTH",
52563
52613
  "MINUTE",
52564
52614
  "15MIN",
52565
52615
  "30MIN",
@@ -52568,7 +52618,8 @@ var init_windowsize = __esm(() => {
52568
52618
  "6HOUR",
52569
52619
  "12HOUR",
52570
52620
  "DAY",
52571
- "WEEK"
52621
+ "WEEK",
52622
+ "MONTH"
52572
52623
  ]);
52573
52624
  });
52574
52625
 
@@ -52580,10 +52631,18 @@ var init_meteraggregation = __esm(() => {
52580
52631
  init_windowsize();
52581
52632
  MeterAggregation$zodSchema = object({
52582
52633
  bucket_size: WindowSize$zodSchema.optional(),
52583
- expression: string2().optional(),
52584
- field: string2().optional(),
52585
- group_by: string2().optional(),
52586
- multiplier: string2().optional(),
52634
+ expression: string2().optional().describe(`Expression is an optional CEL expression to compute per-event quantity from event.properties.
52635
+ When set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).`),
52636
+ field: string2().optional().describe(`Field is the key in $event.properties on which the aggregation is to be applied
52637
+ For ex if the aggregation type is sum for API usage, the field could be "duration_ms"
52638
+ Ignored when Expression is set.`),
52639
+ group_by: string2().optional().describe(`GroupBy is the property name in event.properties to group by before aggregating.
52640
+ Currently only supported for MAX aggregation with bucket_size.
52641
+ When set, aggregation is applied per unique value of this property within each bucket,
52642
+ then the per-group results are summed to produce the bucket total.`),
52643
+ multiplier: string2().optional().describe(`Multiplier is the multiplier for the aggregation
52644
+ For ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000
52645
+ to scale up by a factor of 1000. If not provided, it will be null.`),
52587
52646
  type: AggregationType$zodSchema.optional()
52588
52647
  });
52589
52648
  });
@@ -52593,8 +52652,10 @@ var MeterFilter$zodSchema;
52593
52652
  var init_meterfilter = __esm(() => {
52594
52653
  init_zod();
52595
52654
  MeterFilter$zodSchema = object({
52596
- key: string2().optional(),
52597
- values: array(string2()).optional()
52655
+ key: string2().optional().describe(`Key is the key for the filter from $event.properties
52656
+ Currently we support only first level keys in the properties and not nested keys`),
52657
+ values: array(string2()).optional().describe(`Values are the possible values for the filter to be considered for the meter
52658
+ For ex "model_name" could have values "o1-mini", "gpt-4o" etc`)
52598
52659
  });
52599
52660
  });
52600
52661
 
@@ -52645,9 +52706,9 @@ var ReportingUnit$zodSchema;
52645
52706
  var init_reportingunit = __esm(() => {
52646
52707
  init_zod();
52647
52708
  ReportingUnit$zodSchema = object({
52648
- conversion_rate: number2().optional(),
52649
- unit_plural: string2().optional(),
52650
- unit_singular: string2().optional()
52709
+ conversion_rate: number2().optional().describe("Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"),
52710
+ unit_plural: string2().optional().describe('Display unit label, plural (e.g. "seconds")'),
52711
+ unit_singular: string2().optional().describe('Display unit label, singular (e.g. "second")')
52651
52712
  });
52652
52713
  });
52653
52714
 
@@ -53070,7 +53131,7 @@ var init_dtobillingperiodinfo = __esm(() => {
53070
53131
  init_zod();
53071
53132
  DtoBillingPeriodInfo$zodSchema = object({
53072
53133
  end_time: string2().optional(),
53073
- period: string2().optional(),
53134
+ period: string2().optional().describe('e.g., "monthly", "yearly"'),
53074
53135
  start_time: string2().optional()
53075
53136
  });
53076
53137
  });
@@ -53432,7 +53493,7 @@ var init_customersQueryCustomer2 = __esm(() => {
53432
53493
  init_customerfilter();
53433
53494
  init_tools();
53434
53495
  args8 = {
53435
- request: CustomerFilter$zodSchema
53496
+ request: CustomerFilter$zodSchema.describe(`Filter`)
53436
53497
  };
53437
53498
  tool$customersQueryCustomer = {
53438
53499
  name: "query-customer",
@@ -53467,19 +53528,24 @@ var init_dtoupdatecustomerrequest = __esm(() => {
53467
53528
  init_zod();
53468
53529
  init_dtointegrationentitymapping();
53469
53530
  DtoUpdateCustomerRequest$zodSchema = object({
53470
- address_city: string2().optional(),
53471
- address_country: string2().optional(),
53472
- address_line1: string2().optional(),
53473
- address_line2: string2().optional(),
53474
- address_postal_code: string2().optional(),
53475
- address_state: string2().optional(),
53476
- email: string2().optional(),
53477
- external_id: string2().optional(),
53478
- integration_entity_mapping: array(DtoIntegrationEntityMapping$zodSchema).optional(),
53479
- metadata: record(string2(), string2()).optional(),
53480
- name: string2().optional(),
53481
- parent_customer_external_id: string2().optional(),
53482
- parent_customer_id: string2().optional()
53531
+ address_city: string2().optional().describe("address_city is the updated city name with maximum 100 characters"),
53532
+ address_country: string2().optional().describe("address_country is the updated two-letter ISO 3166-1 alpha-2 country code"),
53533
+ address_line1: string2().optional().describe("address_line1 is the updated primary address line with maximum 255 characters"),
53534
+ address_line2: string2().optional().describe("address_line2 is the updated secondary address line with maximum 255 characters"),
53535
+ address_postal_code: string2().optional().describe("address_postal_code is the updated postal code with maximum 20 characters"),
53536
+ address_state: string2().optional().describe("address_state is the updated state, province, or region name with maximum 100 characters"),
53537
+ email: string2().optional().describe("email is the updated email address and must be a valid email format if provided"),
53538
+ external_id: string2().optional().describe("external_id is the updated external identifier for the customer"),
53539
+ integration_entity_mapping: array(DtoIntegrationEntityMapping$zodSchema).optional().describe("integration_entity_mapping contains provider integration mappings for this customer"),
53540
+ metadata: record(string2(), string2()).optional().describe("metadata contains updated key-value pairs that will replace existing metadata"),
53541
+ name: string2().optional().describe("name is the updated name or company name for the customer"),
53542
+ parent_customer_external_id: string2().optional().describe(`Deprecated: See ParentCustomerID.
53543
+ parent_customer_external_id is the external ID of the parent customer from your system.
53544
+ Exactly one of parent_customer_id or parent_customer_external_id may be provided.
53545
+ If you provide the external ID, the parent customer value will be ignored.`),
53546
+ parent_customer_id: string2().optional().describe(`Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.
53547
+ This field is accepted for backward compatibility but no hierarchy validations are enforced.
53548
+ parent_customer_id is the internal FlexPrice ID of the parent customer.`)
53483
53549
  }).describe("Request object for updating an existing customer. All fields are optional - only provided fields will be updated");
53484
53550
  });
53485
53551
 
@@ -53491,7 +53557,7 @@ var init_updatecustomerop = __esm(() => {
53491
53557
  init_dtoupdatecustomerrequest();
53492
53558
  init_errorserrorresponse();
53493
53559
  UpdateCustomerRequest$zodSchema = object({
53494
- body: DtoUpdateCustomerRequest$zodSchema,
53560
+ body: DtoUpdateCustomerRequest$zodSchema.describe("Customer"),
53495
53561
  external_customer_id: string2().describe("Customer External ID").optional(),
53496
53562
  id: string2().describe("Customer ID").optional()
53497
53563
  });
@@ -53633,21 +53699,23 @@ var init_githubcomflexpriceflexpriceinternaldomaincustomercustomer = __esm(() =>
53633
53699
  init_zod();
53634
53700
  init_status();
53635
53701
  GithubComFlexpriceFlexpriceInternalDomainCustomerCustomer$zodSchema = object({
53636
- address_city: string2().optional(),
53637
- address_country: string2().optional(),
53638
- address_line1: string2().optional(),
53639
- address_line2: string2().optional(),
53640
- address_postal_code: string2().optional(),
53641
- address_state: string2().optional(),
53702
+ address_city: string2().optional().describe("AddressCity is the city of the customer's address"),
53703
+ address_country: string2().optional().describe("AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)"),
53704
+ address_line1: string2().optional().describe("AddressLine1 is the first line of the customer's address"),
53705
+ address_line2: string2().optional().describe("AddressLine2 is the second line of the customer's address"),
53706
+ address_postal_code: string2().optional().describe("AddressPostalCode is the postal code of the customer's address"),
53707
+ address_state: string2().optional().describe("AddressState is the state of the customer's address"),
53642
53708
  created_at: string2().optional(),
53643
53709
  created_by: string2().optional(),
53644
- email: string2().optional(),
53645
- environment_id: string2().optional(),
53646
- external_id: string2().optional(),
53647
- id: string2().optional(),
53648
- metadata: record(string2(), string2()).optional(),
53649
- name: string2().optional(),
53650
- parent_customer_id: string2().optional(),
53710
+ email: string2().optional().describe("Email is the email of the customer"),
53711
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the customer"),
53712
+ external_id: string2().optional().describe("ExternalID is the external identifier for the customer"),
53713
+ id: string2().optional().describe("ID is the unique identifier for the customer"),
53714
+ metadata: record(string2(), string2()).optional().describe("Metadata"),
53715
+ name: string2().optional().describe("Name is the name of the customer"),
53716
+ parent_customer_id: string2().optional().describe(`Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.
53717
+ Retained for backward compatibility; no hierarchy rules are enforced at the service layer.
53718
+ ParentCustomerID is the parent customer identifier for the customer.`),
53651
53719
  status: Status$zodSchema.optional(),
53652
53720
  tenant_id: string2().optional(),
53653
53721
  updated_at: string2().optional(),
@@ -53681,11 +53749,14 @@ var init_metermeter = __esm(() => {
53681
53749
  aggregation: MeterAggregation$zodSchema.optional(),
53682
53750
  created_at: string2().optional(),
53683
53751
  created_by: string2().optional(),
53684
- environment_id: string2().optional(),
53685
- event_name: string2().optional(),
53686
- filters: array(MeterFilter$zodSchema).optional(),
53687
- id: string2().optional(),
53688
- name: string2().optional(),
53752
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the meter"),
53753
+ event_name: string2().optional().describe(`EventName is the unique identifier for the event that this meter is tracking
53754
+ It is a mandatory field in the events table and hence being used as the primary matching field
53755
+ We can have multiple meters tracking the same event but with different filters and aggregation`),
53756
+ filters: array(MeterFilter$zodSchema).optional().describe(`Filters define the criteria for the meter to be applied on the events before aggregation
53757
+ It also defines the possible values on which later the charges will be applied`),
53758
+ id: string2().optional().describe("ID is the unique identifier for the meter"),
53759
+ name: string2().optional().describe("Name is the display name of the meter"),
53689
53760
  reset_usage: ResetUsage$zodSchema.optional(),
53690
53761
  status: Status$zodSchema.optional(),
53691
53762
  tenant_id: string2().optional(),
@@ -53790,7 +53861,7 @@ var init_pricejsonbtransformquantity = __esm(() => {
53790
53861
  init_zod();
53791
53862
  init_roundtype();
53792
53863
  PriceJSONBTransformQuantity$zodSchema = object({
53793
- divide_by: int().optional(),
53864
+ divide_by: int().optional().describe("Divide quantity by this number"),
53794
53865
  round: RoundType$zodSchema.optional()
53795
53866
  });
53796
53867
  });
@@ -53800,9 +53871,13 @@ var PricePriceTier$zodSchema;
53800
53871
  var init_pricepricetier = __esm(() => {
53801
53872
  init_zod();
53802
53873
  PricePriceTier$zodSchema = object({
53803
- flat_amount: string2().optional(),
53804
- unit_amount: string2().optional(),
53805
- up_to: int().optional()
53874
+ flat_amount: string2().optional().describe(`flat_amount is the flat amount for the given tier (optional)
53875
+ Applied on top of unit_amount*quantity. Useful for cases like "2.7$ + 5c"`),
53876
+ unit_amount: string2().optional().describe("unit_amount is the amount per unit for the given tier"),
53877
+ up_to: int().optional().describe(`up_to is the quantity up to which this tier applies. It is null for the last tier.
53878
+ IMPORTANT: Tier boundaries are INCLUSIVE.
53879
+ - If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier
53880
+ - This behavior is consistent across both VOLUME and SLAB tier modes`)
53806
53881
  });
53807
53882
  });
53808
53883
 
@@ -53842,43 +53917,46 @@ var init_priceprice = __esm(() => {
53842
53917
  init_priceunittype();
53843
53918
  init_status();
53844
53919
  PricePrice$zodSchema = object({
53845
- amount: string2().optional(),
53920
+ amount: string2().optional().describe(`Amount stored in main currency units (e.g., dollars, not cents)
53921
+ For USD: 12.50 means $12.50`),
53846
53922
  billing_cadence: BillingCadence$zodSchema.optional(),
53847
53923
  billing_model: BillingModel$zodSchema.optional(),
53848
53924
  billing_period: BillingPeriod$zodSchema.optional(),
53849
- billing_period_count: int().optional(),
53850
- conversion_rate: string2().optional(),
53925
+ billing_period_count: int().optional().describe("BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12"),
53926
+ conversion_rate: string2().optional().describe("ConversionRate is the conversion rate of the price unit to the fiat currency"),
53851
53927
  created_at: string2().optional(),
53852
53928
  created_by: string2().optional(),
53853
- currency: string2().optional(),
53854
- description: string2().optional(),
53855
- display_amount: string2().optional(),
53856
- display_name: string2().optional(),
53857
- display_price_unit_amount: string2().optional(),
53858
- end_date: string2().optional(),
53859
- entity_id: string2().optional(),
53929
+ currency: string2().optional().describe("Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp"),
53930
+ description: string2().optional().describe("Description of the price"),
53931
+ display_amount: string2().optional().describe(`DisplayAmount is the formatted amount with currency symbol
53932
+ For USD: $12.50`),
53933
+ display_name: string2().optional().describe("DisplayName is the name of the price"),
53934
+ display_price_unit_amount: string2().optional().describe("DisplayPriceUnitAmount is the formatted amount of the price unit"),
53935
+ end_date: string2().optional().describe("EndDate is the end date of the price"),
53936
+ entity_id: string2().optional().describe('EntityID holds the value of the "entity_id" field.'),
53860
53937
  entity_type: PriceEntityType$zodSchema.optional(),
53861
- environment_id: string2().optional(),
53862
- group_id: string2().optional(),
53863
- id: string2().optional(),
53938
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the price"),
53939
+ group_id: string2().optional().describe("GroupID references the group this price belongs to"),
53940
+ id: string2().optional().describe("ID uuid identifier for the price"),
53864
53941
  invoice_cadence: InvoiceCadence$zodSchema.optional(),
53865
- lookup_key: string2().optional(),
53942
+ lookup_key: string2().optional().describe("LookupKey used for looking up the price in the database"),
53866
53943
  metadata: record(string2(), string2()).optional(),
53867
- meter_id: string2().optional(),
53868
- min_quantity: string2().nullable().optional(),
53869
- parent_price_id: string2().optional(),
53870
- price_unit: string2().optional(),
53871
- price_unit_amount: string2().optional(),
53872
- price_unit_id: string2().optional(),
53873
- price_unit_tiers: array(PricePriceTier$zodSchema).optional(),
53944
+ meter_id: string2().optional().describe("MeterID is the id of the meter for usage based pricing"),
53945
+ min_quantity: string2().nullable().optional().describe("MinQuantity is the minimum quantity of the price"),
53946
+ parent_price_id: string2().optional().describe("ParentPriceID references the root price (always set for price lineage tracking)"),
53947
+ price_unit: string2().optional().describe("PriceUnit is the code of the price unit (e.g., 'btc', 'eth')"),
53948
+ price_unit_amount: string2().optional().describe("PriceUnitAmount is the amount of the price unit"),
53949
+ price_unit_id: string2().optional().describe("PriceUnitID is the id of the price unit (for CUSTOM type)"),
53950
+ price_unit_tiers: array(PricePriceTier$zodSchema).optional().describe("PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED"),
53874
53951
  price_unit_type: PriceUnitType$zodSchema.optional(),
53875
- start_date: string2().optional(),
53952
+ start_date: string2().optional().describe("StartDate is the start date of the price"),
53876
53953
  status: Status$zodSchema.optional(),
53877
53954
  tenant_id: string2().optional(),
53878
53955
  tier_mode: BillingTier$zodSchema.optional(),
53879
53956
  tiers: array(PricePriceTier$zodSchema).optional(),
53880
53957
  transform_quantity: PriceJSONBTransformQuantity$zodSchema.optional(),
53881
- trial_period: int().optional(),
53958
+ trial_period: int().optional().describe(`TrialPeriod is the number of days for the trial period
53959
+ Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)`),
53882
53960
  type: PriceType$zodSchema.optional(),
53883
53961
  updated_at: string2().optional(),
53884
53962
  updated_by: string2().optional()
@@ -53946,8 +54024,8 @@ var init_subscriptionsubscriptionlineitem = __esm(() => {
53946
54024
  init_subscriptionlineitementitytype();
53947
54025
  SubscriptionSubscriptionLineItem$zodSchema = object({
53948
54026
  billing_period: BillingPeriod$zodSchema.optional(),
53949
- billing_period_count: int().optional(),
53950
- commitment_amount: string2().optional(),
54027
+ billing_period_count: int().optional().describe("from price at create; default 1"),
54028
+ commitment_amount: string2().optional().describe("Commitment fields"),
53951
54029
  commitment_duration: BillingPeriod$zodSchema.optional(),
53952
54030
  commitment_overage_factor: string2().optional(),
53953
54031
  commitment_quantity: string2().optional(),
@@ -54347,11 +54425,11 @@ var init_dtogetusageanalyticsrequest = __esm(() => {
54347
54425
  init_windowsize();
54348
54426
  DtoGetUsageAnalyticsRequest$zodSchema = object({
54349
54427
  end_time: string2().optional(),
54350
- expand: array(string2()).optional(),
54428
+ expand: array(string2()).optional().describe('allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon"'),
54351
54429
  external_customer_id: string2(),
54352
54430
  feature_ids: array(string2()).optional(),
54353
- group_by: array(string2()).optional(),
54354
- property_filters: record(string2(), array(string2())).optional(),
54431
+ group_by: array(string2()).optional().describe('allowed values: "source", "feature_id", "properties.<field_name>"'),
54432
+ property_filters: record(string2(), array(string2())).optional().describe("Property filters to filter the events by the keys in `properties` field of the event"),
54355
54433
  sources: array(string2()).optional(),
54356
54434
  start_time: string2().optional(),
54357
54435
  window_size: WindowSize$zodSchema.optional()
@@ -54438,7 +54516,7 @@ var init_eventsGetUsageAnalytics2 = __esm(() => {
54438
54516
  init_dtogetusageanalyticsrequest();
54439
54517
  init_tools();
54440
54518
  args11 = {
54441
- request: DtoGetUsageAnalyticsRequest$zodSchema
54519
+ request: DtoGetUsageAnalyticsRequest$zodSchema.describe(`Request body`)
54442
54520
  };
54443
54521
  tool$eventsGetUsageAnalytics = {
54444
54522
  name: "get-usage-analytics",
@@ -54473,7 +54551,22 @@ var init_dtogetusagebymeterrequest = __esm(() => {
54473
54551
  init_zod();
54474
54552
  init_windowsize();
54475
54553
  DtoGetUsageByMeterRequest$zodSchema = object({
54476
- billing_anchor: string2().optional(),
54554
+ billing_anchor: string2().optional().describe(`BillingAnchor enables custom monthly billing periods for meter usage aggregation.
54555
+
54556
+ Usage guidelines:
54557
+ - Only effective when WindowSize = "MONTH"
54558
+ - For other window sizes (DAY, HOUR, WEEK), this field is ignored
54559
+ - When nil, uses standard calendar months (1st to 1st)
54560
+ - When provided, creates custom monthly periods (e.g., 5th to 5th)
54561
+
54562
+ Common use cases:
54563
+ - Subscription billing periods that don't align with calendar months
54564
+ - Customer-specific billing cycles (e.g., signed up on 15th)
54565
+ - Multi-tenant systems with different billing anchor dates
54566
+
54567
+ Example: If BillingAnchor = "2024-03-05T14:30:45Z" and WindowSize = "MONTH":
54568
+ - March period: 2024-03-05 14:30:45 to 2024-04-05 14:30:45
54569
+ - April period: 2024-04-05 14:30:45 to 2024-05-05 14:30:45`),
54477
54570
  bucket_size: WindowSize$zodSchema.optional(),
54478
54571
  customer_id: string2().optional(),
54479
54572
  end_time: string2().optional(),
@@ -54565,7 +54658,7 @@ var init_eventsGetUsageByMeter2 = __esm(() => {
54565
54658
  init_dtogetusagebymeterrequest();
54566
54659
  init_tools();
54567
54660
  args12 = {
54568
- request: DtoGetUsageByMeterRequest$zodSchema
54661
+ request: DtoGetUsageByMeterRequest$zodSchema.describe(`Request body`)
54569
54662
  };
54570
54663
  tool$eventsGetUsageByMeter = {
54571
54664
  name: "get-usage-by-meter",
@@ -54602,16 +54695,32 @@ var init_dtogetusagerequest = __esm(() => {
54602
54695
  init_windowsize();
54603
54696
  DtoGetUsageRequest$zodSchema = object({
54604
54697
  aggregation_type: AggregationType$zodSchema,
54605
- billing_anchor: string2().optional(),
54698
+ billing_anchor: string2().optional().describe(`BillingAnchor enables custom monthly billing periods for usage aggregation.
54699
+
54700
+ When to use:
54701
+ - WindowSize = "MONTH" AND you need custom monthly periods (not calendar months)
54702
+ - Subscription billing that doesn't align with calendar months
54703
+ - Example: Customer signed up on 15th, so billing periods are 15th to 15th
54704
+
54705
+ When NOT to use:
54706
+ - WindowSize != "MONTH" (ignored for DAY, HOUR, WEEK, etc.)
54707
+ - Standard calendar-based billing (1st to 1st of each month)
54708
+
54709
+ Example values:
54710
+ - "2024-03-05T14:30:45.123456789Z" (5th of each month at 2:30:45 PM)
54711
+ - "2024-01-15T00:00:00Z" (15th of each month at midnight)
54712
+ - "2024-02-29T12:00:00Z" (29th of each month at noon - handles leap years)`),
54606
54713
  bucket_size: WindowSize$zodSchema.optional(),
54607
54714
  customer_id: string2().optional(),
54608
54715
  end_time: string2().optional(),
54609
54716
  event_name: string2(),
54610
54717
  external_customer_id: string2().optional(),
54611
54718
  filters: record(string2(), array(string2())).optional(),
54612
- group_by_property: string2().optional(),
54719
+ group_by_property: string2().optional().describe(`GroupByProperty is the property name in event.properties to group by before aggregating.
54720
+ When set, aggregation is applied per unique value of this property within each bucket,
54721
+ then the per-group results are summed to produce the bucket total.`),
54613
54722
  multiplier: string2().optional(),
54614
- property_name: string2().optional(),
54723
+ property_name: string2().optional().describe("will be empty/ignored in case of COUNT"),
54615
54724
  start_time: string2().optional(),
54616
54725
  window_size: WindowSize$zodSchema.optional()
54617
54726
  });
@@ -54697,7 +54806,7 @@ var init_eventsGetUsageStatistics2 = __esm(() => {
54697
54806
  init_dtogetusagerequest();
54698
54807
  init_tools();
54699
54808
  args13 = {
54700
- request: DtoGetUsageRequest$zodSchema
54809
+ request: DtoGetUsageRequest$zodSchema.describe(`Request body`)
54701
54810
  };
54702
54811
  tool$eventsGetUsageStatistics = {
54703
54812
  name: "get-usage-statistics",
@@ -54735,9 +54844,9 @@ var init_dtoingesteventrequest = __esm(() => {
54735
54844
  event_id: string2().optional(),
54736
54845
  event_name: string2(),
54737
54846
  external_customer_id: string2(),
54738
- properties: record(string2(), string2()).optional(),
54847
+ properties: record(string2(), string2()).optional().describe("Handled separately for dynamic columns"),
54739
54848
  source: string2().optional(),
54740
- timestamp: string2().optional()
54849
+ timestamp: string2().optional().describe("Handled separately due to parsing")
54741
54850
  });
54742
54851
  });
54743
54852
 
@@ -54821,7 +54930,7 @@ var init_eventsIngestEvent2 = __esm(() => {
54821
54930
  init_dtoingesteventrequest();
54822
54931
  init_tools();
54823
54932
  args14 = {
54824
- request: DtoIngestEventRequest$zodSchema
54933
+ request: DtoIngestEventRequest$zodSchema.describe(`Event data`)
54825
54934
  };
54826
54935
  tool$eventsIngestEvent = {
54827
54936
  name: "ingest-event",
@@ -54940,7 +55049,7 @@ var init_eventsIngestEventsBulk2 = __esm(() => {
54940
55049
  init_dtobulkingesteventrequest();
54941
55050
  init_tools();
54942
55051
  args15 = {
54943
- request: DtoBulkIngestEventRequest$zodSchema
55052
+ request: DtoBulkIngestEventRequest$zodSchema.describe(`Event data`)
54944
55053
  };
54945
55054
  tool$eventsIngestEventsBulk = {
54946
55055
  name: "ingest-events-bulk",
@@ -54974,19 +55083,21 @@ var DtoGetEventsRequest$zodSchema;
54974
55083
  var init_dtogeteventsrequest = __esm(() => {
54975
55084
  init_zod();
54976
55085
  DtoGetEventsRequest$zodSchema = object({
54977
- end_time: string2().optional(),
54978
- event_id: string2().optional(),
54979
- event_name: string2().optional(),
54980
- external_customer_id: string2().optional(),
54981
- iter_first_key: string2().optional(),
54982
- iter_last_key: string2().optional(),
54983
- offset: int().optional(),
54984
- order: string2().optional(),
54985
- page_size: int().optional(),
54986
- property_filters: record(string2(), array(string2())).optional(),
54987
- sort: string2().optional(),
54988
- source: string2().optional(),
54989
- start_time: string2().optional()
55086
+ end_time: string2().optional().describe(`End time of the events to be fetched in ISO 8601 format
55087
+ Defaults to now if not provided`),
55088
+ event_id: string2().optional().describe("Event ID is the idempotency key for the event"),
55089
+ event_name: string2().optional().describe("Event name / Unique identifier for the event in your system"),
55090
+ external_customer_id: string2().optional().describe("Customer ID in your system that was sent with the event"),
55091
+ iter_first_key: string2().optional().describe("First key to iterate over the events"),
55092
+ iter_last_key: string2().optional().describe("Last key to iterate over the events"),
55093
+ offset: int().optional().describe("Offset to fetch the events and is set to 0 by default"),
55094
+ order: string2().optional().describe("Order by condition. Allowed values (case sensitive): asc, desc (default: desc)"),
55095
+ page_size: int().optional().describe("Page size to fetch the events and is set to 50 by default"),
55096
+ property_filters: record(string2(), array(string2())).optional().describe("Property filters to filter the events by the keys in `properties` field of the event"),
55097
+ sort: string2().optional().describe("Sort by the field. Allowed values (case sensitive): timestamp, event_name (default: timestamp)"),
55098
+ source: string2().optional().describe("Source to filter the events by the source"),
55099
+ start_time: string2().optional().describe(`Start time of the events to be fetched in ISO 8601 format
55100
+ Defaults to last 7 days from now if not provided`)
54990
55101
  });
54991
55102
  });
54992
55103
 
@@ -55070,7 +55181,7 @@ var init_eventsListRawEvents2 = __esm(() => {
55070
55181
  init_dtogeteventsrequest();
55071
55182
  init_tools();
55072
55183
  args16 = {
55073
- request: DtoGetEventsRequest$zodSchema
55184
+ request: DtoGetEventsRequest$zodSchema.describe(`Request body`)
55074
55185
  };
55075
55186
  tool$eventsListRawEvents = {
55076
55187
  name: "list-raw-events",
@@ -55247,11 +55358,11 @@ var init_commitmentinfo = __esm(() => {
55247
55358
  amount: string2().optional(),
55248
55359
  computed_commitment_utilized_amount: string2().optional(),
55249
55360
  computed_overage_amount: string2().optional(),
55250
- computed_true_up_amount: string2().optional(),
55361
+ computed_true_up_amount: string2().optional().describe("total_cost = computed_commitment_utilized_amount + computed_overage_amount + computed_true_up_amount"),
55251
55362
  duration: BillingPeriod$zodSchema.optional(),
55252
55363
  is_windowed: boolean2().optional(),
55253
55364
  overage_factor: string2().optional(),
55254
- quantity: string2().optional(),
55365
+ quantity: string2().optional().describe("Only used for quantity-based commitments"),
55255
55366
  true_up_enabled: boolean2().optional(),
55256
55367
  type: CommitmentType$zodSchema.optional()
55257
55368
  });
@@ -55263,26 +55374,27 @@ var init_dtocreateinvoicelineitemrequest = __esm(() => {
55263
55374
  init_zod();
55264
55375
  init_commitmentinfo();
55265
55376
  DtoCreateInvoiceLineItemRequest$zodSchema = object({
55266
- amount: string2(),
55377
+ amount: string2().describe("amount is the monetary amount for this line item"),
55267
55378
  commitment_info: CommitmentInfo$zodSchema.optional(),
55268
- display_name: string2().optional(),
55269
- entity_id: string2().optional(),
55270
- entity_type: string2().optional(),
55271
- invoice_level_discount: string2().optional(),
55272
- line_item_discount: string2().optional(),
55379
+ display_name: string2().optional().describe("display_name is the optional human-readable name for this line item"),
55380
+ entity_id: string2().optional().describe("entity_id is the optional unique identifier of the entity associated with this line item"),
55381
+ entity_type: string2().optional().describe("entity_type is the optional type of the entity associated with this line item"),
55382
+ invoice_level_discount: string2().optional().describe("invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice."),
55383
+ line_item_discount: string2().optional().describe("line_item_discount is the discount amount in invoice currency applied directly to this line item."),
55273
55384
  metadata: record(string2(), string2()).optional(),
55274
- meter_display_name: string2().optional(),
55275
- meter_id: string2().optional(),
55276
- period_end: string2().optional(),
55277
- period_start: string2().optional(),
55278
- plan_display_name: string2().optional(),
55279
- plan_id: string2().optional(),
55280
- prepaid_credits_applied: string2().optional(),
55281
- price_id: string2().optional(),
55282
- price_type: string2().optional(),
55283
- price_unit: string2().optional(),
55284
- price_unit_amount: string2().optional(),
55285
- quantity: string2()
55385
+ meter_display_name: string2().optional().describe("meter_display_name is the optional human-readable name of the meter"),
55386
+ meter_id: string2().optional().describe("meter_id is the optional unique identifier of the meter used for usage tracking"),
55387
+ period_end: string2().optional().describe("period_end is the optional end date of the period this line item covers"),
55388
+ period_start: string2().optional().describe("period_start is the optional start date of the period this line item covers"),
55389
+ plan_display_name: string2().optional().describe("plan_display_name is the optional human-readable name of the plan"),
55390
+ plan_id: string2().optional().describe(`TODO: !REMOVE after migration
55391
+ plan_id is the optional unique identifier of the plan associated with this line item`),
55392
+ prepaid_credits_applied: string2().optional().describe("prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application."),
55393
+ price_id: string2().optional().describe("price_id is the optional unique identifier of the price associated with this line item"),
55394
+ price_type: string2().optional().describe("price_type indicates the type of pricing (fixed, usage, tiered, etc.)"),
55395
+ price_unit: string2().optional().describe("price_unit is the optional 3-digit ISO code of the price unit associated with this line item"),
55396
+ price_unit_amount: string2().optional().describe("price_unit_amount is the optional amount converted to the price unit currency"),
55397
+ quantity: string2().describe("quantity is the quantity of units for this line item")
55286
55398
  });
55287
55399
  });
55288
55400
 
@@ -55303,7 +55415,7 @@ var init_dtoinvoicelineitemcoupon = __esm(() => {
55303
55415
  DtoInvoiceLineItemCoupon$zodSchema = object({
55304
55416
  coupon_association_id: string2().optional(),
55305
55417
  coupon_id: string2(),
55306
- line_item_id: string2()
55418
+ line_item_id: string2().describe("price_id used to match the line item")
55307
55419
  });
55308
55420
  });
55309
55421
 
@@ -55432,34 +55544,34 @@ var init_dtocreateinvoicerequest = __esm(() => {
55432
55544
  init_invoicetype();
55433
55545
  init_paymentstatus();
55434
55546
  DtoCreateInvoiceRequest$zodSchema = object({
55435
- amount_due: string2(),
55436
- amount_paid: string2().optional(),
55437
- billing_period: string2().optional(),
55547
+ amount_due: string2().describe("amount_due is the total amount that needs to be paid for this invoice"),
55548
+ amount_paid: string2().optional().describe("amount_paid is the amount that has been paid towards this invoice"),
55549
+ billing_period: string2().optional().describe('billing_period is the period this invoice covers (e.g., "monthly", "yearly")'),
55438
55550
  billing_reason: InvoiceBillingReason$zodSchema.optional(),
55439
- coupons: array(string2()).optional(),
55440
- currency: string2(),
55441
- customer_id: string2(),
55442
- description: string2().optional(),
55443
- due_date: string2().optional(),
55444
- idempotency_key: string2().optional(),
55445
- invoice_coupons: array(DtoInvoiceCoupon$zodSchema).optional(),
55446
- invoice_number: string2().optional(),
55447
- invoice_pdf_url: string2().optional(),
55551
+ coupons: array(string2()).optional().describe("coupons"),
55552
+ currency: string2().describe("currency is the three-letter ISO currency code (e.g., USD, EUR) for the invoice"),
55553
+ customer_id: string2().describe("customer_id is the unique identifier of the customer this invoice belongs to"),
55554
+ description: string2().optional().describe("description is an optional text description of the invoice"),
55555
+ due_date: string2().optional().describe("due_date is the date by which payment is expected"),
55556
+ idempotency_key: string2().optional().describe("idempotency_key is an optional key used to prevent duplicate invoice creation"),
55557
+ invoice_coupons: array(DtoInvoiceCoupon$zodSchema).optional().describe("Invoice Coupons"),
55558
+ invoice_number: string2().optional().describe("invoice_number is an optional human-readable identifier for the invoice"),
55559
+ invoice_pdf_url: string2().optional().describe("invoice_pdf_url is the URL where customers can download the PDF version of this invoice"),
55448
55560
  invoice_status: InvoiceStatus$zodSchema.optional(),
55449
55561
  invoice_type: InvoiceType$zodSchema.optional(),
55450
- line_item_coupons: array(DtoInvoiceLineItemCoupon$zodSchema).optional(),
55451
- line_items: array(DtoCreateInvoiceLineItemRequest$zodSchema).optional(),
55562
+ line_item_coupons: array(DtoInvoiceLineItemCoupon$zodSchema).optional().describe("Invoice Line Item Coupons"),
55563
+ line_items: array(DtoCreateInvoiceLineItemRequest$zodSchema).optional().describe("line_items contains the individual items that make up this invoice"),
55452
55564
  metadata: record(string2(), string2()).optional(),
55453
55565
  payment_status: PaymentStatus$zodSchema.optional(),
55454
- period_end: string2().optional(),
55455
- period_start: string2().optional(),
55456
- prepared_tax_rates: array(DtoTaxRateResponse$zodSchema).optional(),
55457
- subscription_id: string2().optional(),
55458
- subtotal: string2(),
55459
- tax_rate_overrides: array(DtoTaxRateOverride$zodSchema).optional(),
55460
- tax_rates: array(string2()).optional(),
55461
- total: string2(),
55462
- total_prepaid_applied: string2().optional()
55566
+ period_end: string2().optional().describe("period_end is the end date of the billing period"),
55567
+ period_start: string2().optional().describe("period_start is the start date of the billing period"),
55568
+ prepared_tax_rates: array(DtoTaxRateResponse$zodSchema).optional().describe("prepared_tax_rates contains the tax rates pre-resolved by the caller (e.g., billing service)"),
55569
+ subscription_id: string2().optional().describe("subscription_id is the optional unique identifier of the subscription associated with this invoice"),
55570
+ subtotal: string2().describe("subtotal is the amount before taxes and discounts are applied"),
55571
+ tax_rate_overrides: array(DtoTaxRateOverride$zodSchema).optional().describe("tax_rate_overrides is the tax rate overrides to be applied to the invoice"),
55572
+ tax_rates: array(string2()).optional().describe("tax_rates"),
55573
+ total: string2().describe("total is the total amount of the invoice including taxes and discounts"),
55574
+ total_prepaid_applied: string2().optional().describe("total_prepaid_applied is the total amount of prepaid applied to this invoice.")
55463
55575
  });
55464
55576
  });
55465
55577
 
@@ -55543,7 +55655,7 @@ var init_invoicesCreateInvoice2 = __esm(() => {
55543
55655
  init_dtocreateinvoicerequest();
55544
55656
  init_tools();
55545
55657
  args18 = {
55546
- request: DtoCreateInvoiceRequest$zodSchema
55658
+ request: DtoCreateInvoiceRequest$zodSchema.describe(`Invoice details`)
55547
55659
  };
55548
55660
  tool$invoicesCreateInvoice = {
55549
55661
  name: "create-invoice",
@@ -55706,16 +55818,16 @@ var DtoCustomerInvoiceSummary$zodSchema;
55706
55818
  var init_dtocustomerinvoicesummary = __esm(() => {
55707
55819
  init_zod();
55708
55820
  DtoCustomerInvoiceSummary$zodSchema = object({
55709
- currency: string2().optional(),
55710
- customer_id: string2().optional(),
55711
- overdue_invoice_count: int().optional(),
55712
- total_invoice_count: int().optional(),
55713
- total_overdue_amount: string2().optional(),
55714
- total_revenue_amount: string2().optional(),
55715
- total_unpaid_amount: string2().optional(),
55716
- unpaid_fixed_charges: string2().optional(),
55717
- unpaid_invoice_count: int().optional(),
55718
- unpaid_usage_charges: string2().optional()
55821
+ currency: string2().optional().describe("currency is the three-letter ISO currency code for this summary"),
55822
+ customer_id: string2().optional().describe("customer_id is the unique identifier of the customer"),
55823
+ overdue_invoice_count: int().optional().describe("overdue_invoice_count is the number of overdue invoices for this customer in this currency"),
55824
+ total_invoice_count: int().optional().describe("total_invoice_count is the total number of invoices for this customer in this currency"),
55825
+ total_overdue_amount: string2().optional().describe("total_overdue_amount is the total amount of overdue invoices in this currency"),
55826
+ total_revenue_amount: string2().optional().describe("total_revenue_amount is the total revenue generated from this customer in this currency"),
55827
+ total_unpaid_amount: string2().optional().describe("total_unpaid_amount is the total amount of unpaid invoices in this currency"),
55828
+ unpaid_fixed_charges: string2().optional().describe("unpaid_fixed_charges is the total amount of unpaid fixed charges in this currency"),
55829
+ unpaid_invoice_count: int().optional().describe("unpaid_invoice_count is the number of unpaid invoices for this customer in this currency"),
55830
+ unpaid_usage_charges: string2().optional().describe("unpaid_usage_charges is the total amount of unpaid usage-based charges in this currency")
55719
55831
  });
55720
55832
  });
55721
55833
 
@@ -55725,9 +55837,9 @@ var init_dtocustomermulticurrencyinvoicesummary = __esm(() => {
55725
55837
  init_zod();
55726
55838
  init_dtocustomerinvoicesummary();
55727
55839
  DtoCustomerMultiCurrencyInvoiceSummary$zodSchema = object({
55728
- customer_id: string2().optional(),
55729
- default_currency: string2().optional(),
55730
- summaries: array(DtoCustomerInvoiceSummary$zodSchema).optional()
55840
+ customer_id: string2().optional().describe("customer_id is the unique identifier of the customer"),
55841
+ default_currency: string2().optional().describe("default_currency is the primary currency for this customer"),
55842
+ summaries: array(DtoCustomerInvoiceSummary$zodSchema).optional().describe("summaries contains the invoice summaries for each currency")
55731
55843
  });
55732
55844
  });
55733
55845
 
@@ -55907,11 +56019,11 @@ var DtoSourceUsageItem$zodSchema;
55907
56019
  var init_dtosourceusageitem = __esm(() => {
55908
56020
  init_zod();
55909
56021
  DtoSourceUsageItem$zodSchema = object({
55910
- cost: string2().optional(),
55911
- event_count: int().optional(),
55912
- percentage: string2().optional(),
55913
- source: string2().optional(),
55914
- usage: string2().optional()
56022
+ cost: string2().optional().describe("cost is the cost attributed to this source for the line item"),
56023
+ event_count: int().optional().describe("event_count is the number of events from this source (optional)"),
56024
+ percentage: string2().optional().describe("percentage is the percentage of total line item cost from this source (optional)"),
56025
+ source: string2().optional().describe("source is the name of the event source"),
56026
+ usage: string2().optional().describe("usage is the total usage amount from this source (optional, for additional context)")
55915
56027
  });
55916
56028
  });
55917
56029
 
@@ -55920,11 +56032,11 @@ var DtoUsageBreakdownItem$zodSchema;
55920
56032
  var init_dtousagebreakdownitem = __esm(() => {
55921
56033
  init_zod();
55922
56034
  DtoUsageBreakdownItem$zodSchema = object({
55923
- cost: string2().optional(),
55924
- event_count: int().optional(),
55925
- grouped_by: record(string2(), string2()).optional(),
55926
- percentage: string2().optional(),
55927
- usage: string2().optional()
56035
+ cost: string2().optional().describe("cost is the cost attributed to this group for the line item"),
56036
+ event_count: int().optional().describe("event_count is the number of events from this group (optional)"),
56037
+ grouped_by: record(string2(), string2()).optional().describe('grouped_by contains the grouping field values (e.g., {"source": "api", "org_id": "org123"})'),
56038
+ percentage: string2().optional().describe("percentage is the percentage of total line item cost from this group (optional)"),
56039
+ usage: string2().optional().describe("usage is the total usage amount from this group (optional, for additional context)")
55928
56040
  });
55929
56041
  });
55930
56042
 
@@ -55949,15 +56061,15 @@ var init_dtoinvoicelineitemresponse = __esm(() => {
55949
56061
  environment_id: string2().optional(),
55950
56062
  id: string2().optional(),
55951
56063
  invoice_id: string2().optional(),
55952
- invoice_level_discount: string2().optional(),
55953
- line_item_discount: string2().optional(),
56064
+ invoice_level_discount: string2().optional().describe("invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice."),
56065
+ line_item_discount: string2().optional().describe("line_item_discount is the discount amount in invoice currency applied directly to this line item."),
55954
56066
  metadata: record(string2(), string2()).optional(),
55955
56067
  meter_display_name: string2().optional(),
55956
56068
  meter_id: string2().optional(),
55957
56069
  period_end: string2().optional(),
55958
56070
  period_start: string2().optional(),
55959
56071
  plan_display_name: string2().optional(),
55960
- prepaid_credits_applied: string2().optional(),
56072
+ prepaid_credits_applied: string2().optional().describe("prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application."),
55961
56073
  price_id: string2().optional(),
55962
56074
  price_type: string2().optional(),
55963
56075
  price_unit: string2().optional(),
@@ -55969,8 +56081,8 @@ var init_dtoinvoicelineitemresponse = __esm(() => {
55969
56081
  tenant_id: string2().optional(),
55970
56082
  updated_at: string2().optional(),
55971
56083
  updated_by: string2().optional(),
55972
- usage_analytics: array(DtoSourceUsageItem$zodSchema).optional(),
55973
- usage_breakdown: array(DtoUsageBreakdownItem$zodSchema).optional()
56084
+ usage_analytics: array(DtoSourceUsageItem$zodSchema).optional().describe("usage_analytics contains usage analytics for this line item (legacy - grouped by source)"),
56085
+ usage_breakdown: array(DtoUsageBreakdownItem$zodSchema).optional().describe("usage_breakdown contains flexible usage breakdown for this line item (supports any grouping)")
55974
56086
  });
55975
56087
  });
55976
56088
 
@@ -56038,15 +56150,15 @@ var init_dtocouponassociationresponse = __esm(() => {
56038
56150
  coupon_id: string2().optional(),
56039
56151
  created_at: string2().optional(),
56040
56152
  created_by: string2().optional(),
56041
- end_date: string2().optional(),
56153
+ end_date: string2().optional().describe("Optional"),
56042
56154
  environment_id: string2().optional(),
56043
56155
  id: string2().optional(),
56044
56156
  metadata: record(string2(), string2()).optional(),
56045
56157
  start_date: string2().optional(),
56046
56158
  status: Status$zodSchema.optional(),
56047
- subscription_id: string2().optional(),
56048
- subscription_line_item_id: string2().optional(),
56049
- subscription_phase_id: string2().optional(),
56159
+ subscription_id: string2().optional().describe("Mandatory"),
56160
+ subscription_line_item_id: string2().optional().describe("Optional"),
56161
+ subscription_phase_id: string2().optional().describe("Optional"),
56050
56162
  tenant_id: string2().optional(),
56051
56163
  updated_at: string2().optional(),
56052
56164
  updated_by: string2().optional()
@@ -56122,7 +56234,10 @@ var init_dtocreditgrantresponse = __esm(() => {
56122
56234
  init_status();
56123
56235
  DtoCreditGrantResponse$zodSchema = object({
56124
56236
  cadence: CreditGrantCadence$zodSchema.optional(),
56125
- conversion_rate: string2().optional(),
56237
+ conversion_rate: string2().optional().describe(`amount in the currency = number of credits * conversion_rate
56238
+ ex if conversion_rate is 1, then 1 USD = 1 credit
56239
+ ex if conversion_rate is 2, then 1 USD = 0.5 credits
56240
+ ex if conversion_rate is 0.5, then 1 USD = 2 credits`),
56126
56241
  created_at: string2().optional(),
56127
56242
  created_by: string2().optional(),
56128
56243
  credit_grant_anchor: string2().optional(),
@@ -56144,7 +56259,10 @@ var init_dtocreditgrantresponse = __esm(() => {
56144
56259
  status: Status$zodSchema.optional(),
56145
56260
  subscription_id: string2().optional(),
56146
56261
  tenant_id: string2().optional(),
56147
- topup_conversion_rate: string2().optional(),
56262
+ topup_conversion_rate: string2().optional().describe(`topup_conversion_rate is the conversion rate for the topup to the currency
56263
+ ex if topup_conversion_rate is 1, then 1 USD = 1 credit
56264
+ ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits
56265
+ ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits`),
56148
56266
  updated_at: string2().optional(),
56149
56267
  updated_by: string2().optional()
56150
56268
  });
@@ -56205,47 +56323,50 @@ var init_dtopriceresponse = __esm(() => {
56205
56323
  init_status();
56206
56324
  DtoPriceResponse$zodSchema = object({
56207
56325
  addon: lazy(() => DtoAddonResponse$zodSchema).optional(),
56208
- amount: string2().optional(),
56326
+ amount: string2().optional().describe(`Amount stored in main currency units (e.g., dollars, not cents)
56327
+ For USD: 12.50 means $12.50`),
56209
56328
  billing_cadence: BillingCadence$zodSchema.optional(),
56210
56329
  billing_model: BillingModel$zodSchema.optional(),
56211
56330
  billing_period: BillingPeriod$zodSchema.optional(),
56212
- billing_period_count: int().optional(),
56213
- conversion_rate: string2().optional(),
56331
+ billing_period_count: int().optional().describe("BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12"),
56332
+ conversion_rate: string2().optional().describe("ConversionRate is the conversion rate of the price unit to the fiat currency"),
56214
56333
  created_at: string2().optional(),
56215
56334
  created_by: string2().optional(),
56216
- currency: string2().optional(),
56217
- description: string2().optional(),
56218
- display_amount: string2().optional(),
56219
- display_name: string2().optional(),
56220
- display_price_unit_amount: string2().optional(),
56221
- end_date: string2().optional(),
56222
- entity_id: string2().optional(),
56335
+ currency: string2().optional().describe("Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp"),
56336
+ description: string2().optional().describe("Description of the price"),
56337
+ display_amount: string2().optional().describe(`DisplayAmount is the formatted amount with currency symbol
56338
+ For USD: $12.50`),
56339
+ display_name: string2().optional().describe("DisplayName is the name of the price"),
56340
+ display_price_unit_amount: string2().optional().describe("DisplayPriceUnitAmount is the formatted amount of the price unit"),
56341
+ end_date: string2().optional().describe("EndDate is the end date of the price"),
56342
+ entity_id: string2().optional().describe('EntityID holds the value of the "entity_id" field.'),
56223
56343
  entity_type: PriceEntityType$zodSchema.optional(),
56224
- environment_id: string2().optional(),
56344
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the price"),
56225
56345
  group: DtoGroupResponse$zodSchema.optional(),
56226
- group_id: string2().optional(),
56227
- id: string2().optional(),
56346
+ group_id: string2().optional().describe("GroupID references the group this price belongs to"),
56347
+ id: string2().optional().describe("ID uuid identifier for the price"),
56228
56348
  invoice_cadence: InvoiceCadence$zodSchema.optional(),
56229
- lookup_key: string2().optional(),
56349
+ lookup_key: string2().optional().describe("LookupKey used for looking up the price in the database"),
56230
56350
  metadata: record(string2(), string2()).optional(),
56231
56351
  meter: DtoMeterResponse$zodSchema.optional(),
56232
- meter_id: string2().optional(),
56233
- min_quantity: string2().nullable().optional(),
56234
- parent_price_id: string2().optional(),
56352
+ meter_id: string2().optional().describe("MeterID is the id of the meter for usage based pricing"),
56353
+ min_quantity: string2().nullable().optional().describe("MinQuantity is the minimum quantity of the price"),
56354
+ parent_price_id: string2().optional().describe("ParentPriceID references the root price (always set for price lineage tracking)"),
56235
56355
  plan: lazy(() => DtoPlanResponse$zodSchema).optional(),
56236
- price_unit: string2().optional(),
56237
- price_unit_amount: string2().optional(),
56238
- price_unit_id: string2().optional(),
56239
- price_unit_tiers: array(PricePriceTier$zodSchema).optional(),
56356
+ price_unit: string2().optional().describe("PriceUnit is the code of the price unit (e.g., 'btc', 'eth')"),
56357
+ price_unit_amount: string2().optional().describe("PriceUnitAmount is the amount of the price unit"),
56358
+ price_unit_id: string2().optional().describe("PriceUnitID is the id of the price unit (for CUSTOM type)"),
56359
+ price_unit_tiers: array(PricePriceTier$zodSchema).optional().describe("PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED"),
56240
56360
  price_unit_type: PriceUnitType$zodSchema.optional(),
56241
56361
  pricing_unit: DtoPriceUnitResponse$zodSchema.optional(),
56242
- start_date: string2().optional(),
56362
+ start_date: string2().optional().describe("StartDate is the start date of the price"),
56243
56363
  status: Status$zodSchema.optional(),
56244
56364
  tenant_id: string2().optional(),
56245
56365
  tier_mode: BillingTier$zodSchema.optional(),
56246
56366
  tiers: array(PricePriceTier$zodSchema).optional(),
56247
56367
  transform_quantity: PriceJSONBTransformQuantity$zodSchema.optional(),
56248
- trial_period: int().optional(),
56368
+ trial_period: int().optional().describe(`TrialPeriod is the number of days for the trial period
56369
+ Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)`),
56249
56370
  type: PriceType$zodSchema.optional(),
56250
56371
  updated_at: string2().optional(),
56251
56372
  updated_by: string2().optional()
@@ -56270,7 +56391,7 @@ var init_dtoaddonresponse = __esm(() => {
56270
56391
  lookup_key: string2().optional(),
56271
56392
  metadata: record(string2(), any()).optional(),
56272
56393
  name: string2().optional(),
56273
- prices: array(lazy(() => DtoPriceResponse$zodSchema)).optional(),
56394
+ prices: array(lazy(() => DtoPriceResponse$zodSchema)).optional().describe("Optional expanded fields"),
56274
56395
  status: Status$zodSchema.optional(),
56275
56396
  tenant_id: string2().optional(),
56276
56397
  type: AddonType$zodSchema.optional(),
@@ -56318,7 +56439,7 @@ var init_dtoentitlementresponse = __esm(() => {
56318
56439
  is_soft_limit: boolean2().optional(),
56319
56440
  parent_entitlement_id: string2().optional(),
56320
56441
  plan: lazy(() => DtoPlanResponse$zodSchema).optional(),
56321
- plan_id: string2().optional(),
56442
+ plan_id: string2().optional().describe("TODO: Remove this once we have a proper entitlement entity type"),
56322
56443
  start_date: string2().optional(),
56323
56444
  static_value: string2().optional(),
56324
56445
  status: Status$zodSchema.optional(),
@@ -56350,7 +56471,7 @@ var init_dtoplanresponse = __esm(() => {
56350
56471
  lookup_key: string2().optional(),
56351
56472
  metadata: record(string2(), string2()).optional(),
56352
56473
  name: string2().optional(),
56353
- prices: array(lazy(() => DtoPriceResponse$zodSchema)).optional(),
56474
+ prices: array(lazy(() => DtoPriceResponse$zodSchema)).optional().describe("TODO: Add inline addons"),
56354
56475
  status: Status$zodSchema.optional(),
56355
56476
  tenant_id: string2().optional(),
56356
56477
  updated_at: string2().optional(),
@@ -56366,13 +56487,13 @@ var init_dtosubscriptionphaseresponse = __esm(() => {
56366
56487
  DtoSubscriptionPhaseResponse$zodSchema = object({
56367
56488
  created_at: string2().optional(),
56368
56489
  created_by: string2().optional(),
56369
- end_date: string2().optional(),
56370
- environment_id: string2().optional(),
56371
- id: string2().optional(),
56490
+ end_date: string2().optional().describe("EndDate is when the phase ends (nil if phase is still active or indefinite)"),
56491
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the phase"),
56492
+ id: string2().optional().describe("ID is the unique identifier for the subscription phase"),
56372
56493
  metadata: record(string2(), string2()).optional(),
56373
- start_date: string2().optional(),
56494
+ start_date: string2().optional().describe("StartDate is when the phase starts"),
56374
56495
  status: Status$zodSchema.optional(),
56375
- subscription_id: string2().optional(),
56496
+ subscription_id: string2().optional().describe("SubscriptionID is the identifier for the subscription"),
56376
56497
  tenant_id: string2().optional(),
56377
56498
  updated_at: string2().optional(),
56378
56499
  updated_by: string2().optional()
@@ -56449,20 +56570,20 @@ var init_subscriptionsubscriptionpause = __esm(() => {
56449
56570
  SubscriptionSubscriptionPause$zodSchema = object({
56450
56571
  created_at: string2().optional(),
56451
56572
  created_by: string2().optional(),
56452
- environment_id: string2().optional(),
56453
- id: string2().optional(),
56573
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the pause"),
56574
+ id: string2().optional().describe("ID is the unique identifier for the subscription pause"),
56454
56575
  metadata: record(string2(), string2()).optional(),
56455
- original_period_end: string2().optional(),
56456
- original_period_start: string2().optional(),
56457
- pause_end: string2().optional(),
56576
+ original_period_end: string2().optional().describe("OriginalPeriodEnd is the end of the billing period when the pause was created"),
56577
+ original_period_start: string2().optional().describe("OriginalPeriodStart is the start of the billing period when the pause was created"),
56578
+ pause_end: string2().optional().describe("PauseEnd is when the pause will end (null for indefinite)"),
56458
56579
  pause_mode: PauseMode$zodSchema.optional(),
56459
- pause_start: string2().optional(),
56580
+ pause_start: string2().optional().describe("PauseStart is when the pause actually started"),
56460
56581
  pause_status: PauseStatus$zodSchema.optional(),
56461
- reason: string2().optional(),
56582
+ reason: string2().optional().describe("Reason is the reason for pausing"),
56462
56583
  resume_mode: ResumeMode$zodSchema.optional(),
56463
- resumed_at: string2().optional(),
56584
+ resumed_at: string2().optional().describe("ResumedAt is when the pause was actually ended (if manually resumed)"),
56464
56585
  status: Status$zodSchema.optional(),
56465
- subscription_id: string2().optional(),
56586
+ subscription_id: string2().optional().describe("SubscriptionID is the identifier for the subscription"),
56466
56587
  tenant_id: string2().optional(),
56467
56588
  updated_at: string2().optional(),
56468
56589
  updated_by: string2().optional()
@@ -56490,57 +56611,63 @@ var init_dtosubscriptionresponse = __esm(() => {
56490
56611
  init_subscriptionsubscriptionlineitem();
56491
56612
  init_subscriptionsubscriptionpause();
56492
56613
  DtoSubscriptionResponse$zodSchema = object({
56493
- active_pause_id: string2().optional(),
56494
- billing_anchor: string2().optional(),
56614
+ active_pause_id: string2().optional().describe(`ActivePauseID references the current active pause configuration
56615
+ This will be null if no pause is active or scheduled`),
56616
+ billing_anchor: string2().optional().describe(`BillingAnchor is the reference point that aligns future billing cycle dates.
56617
+ It sets the day of week for week intervals, the day of month for month and year intervals,
56618
+ and the month of year for year intervals. The timestamp is in UTC format.`),
56495
56619
  billing_cadence: BillingCadence$zodSchema.optional(),
56496
56620
  billing_cycle: BillingCycle$zodSchema.optional(),
56497
56621
  billing_period: BillingPeriod$zodSchema.optional(),
56498
- billing_period_count: int().optional(),
56499
- cancel_at: string2().optional(),
56500
- cancel_at_period_end: boolean2().optional(),
56501
- cancelled_at: string2().optional(),
56502
- collection_method: string2().optional(),
56503
- commitment_amount: string2().optional(),
56622
+ billing_period_count: int().optional().describe("BillingPeriodCount is the total number units of the billing period."),
56623
+ cancel_at: string2().optional().describe("CancelAt is the date the subscription will be canceled"),
56624
+ cancel_at_period_end: boolean2().optional().describe("CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period"),
56625
+ cancelled_at: string2().optional().describe("CanceledAt is the date the subscription was canceled"),
56626
+ collection_method: string2().optional().describe("CollectionMethod determines how invoices are collected"),
56627
+ commitment_amount: string2().optional().describe("CommitmentAmount is the minimum amount a customer commits to paying for a billing period"),
56504
56628
  commitment_duration: BillingPeriod$zodSchema.optional(),
56505
- coupon_associations: array(DtoCouponAssociationResponse$zodSchema).optional(),
56629
+ coupon_associations: array(DtoCouponAssociationResponse$zodSchema).optional().describe("CouponAssociations are the coupon associations for this subscription"),
56506
56630
  created_at: string2().optional(),
56507
56631
  created_by: string2().optional(),
56508
- credit_grants: array(DtoCreditGrantResponse$zodSchema).optional(),
56509
- currency: string2().optional(),
56510
- current_period_end: string2().optional(),
56511
- current_period_start: string2().optional(),
56512
- customer: DtoCustomerResponse$zodSchema.optional(),
56513
- customer_id: string2().optional(),
56632
+ credit_grants: array(DtoCreditGrantResponse$zodSchema).optional().describe("Credit grants are the credit grants for this subscription"),
56633
+ currency: string2().optional().describe("Currency is the currency of the subscription in lowercase 3 digit ISO codes"),
56634
+ current_period_end: string2().optional().describe(`CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for.
56635
+ At the end of this period, a new invoice will be created.`),
56636
+ current_period_start: string2().optional().describe(`CurrentPeriodStart is the end of the current period that the subscription has been invoiced for.
56637
+ At the end of this period, a new invoice will be created.`),
56638
+ customer: DtoCustomerResponse$zodSchema.optional().describe("Customer response object containing all customer information"),
56639
+ customer_id: string2().optional().describe("CustomerID is the identifier for the customer in our system"),
56514
56640
  customer_timezone: string2().optional(),
56515
56641
  enable_true_up: boolean2().optional(),
56516
- end_date: string2().optional(),
56517
- environment_id: string2().optional(),
56518
- gateway_payment_method_id: string2().optional(),
56519
- id: string2().optional(),
56520
- invoicing_customer_id: string2().optional(),
56642
+ end_date: string2().optional().describe("EndDate is the end date of the subscription"),
56643
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the subscription"),
56644
+ gateway_payment_method_id: string2().optional().describe("GatewayPaymentMethodID is the gateway payment method ID for this subscription"),
56645
+ id: string2().optional().describe("ID is the unique identifier for the subscription"),
56646
+ invoicing_customer_id: string2().optional().describe(`InvoicingCustomerID is the customer ID to use for invoicing
56647
+ This can differ from the subscription customer (e.g., parent company invoicing for child company)`),
56521
56648
  latest_invoice: lazy(() => DtoInvoiceResponse$zodSchema).optional(),
56522
56649
  line_items: array(SubscriptionSubscriptionLineItem$zodSchema).optional(),
56523
- lookup_key: string2().optional(),
56650
+ lookup_key: string2().optional().describe("LookupKey is the key used to lookup the subscription in our system"),
56524
56651
  metadata: record(string2(), string2()).optional(),
56525
- overage_factor: string2().optional(),
56526
- parent_subscription_id: string2().optional(),
56652
+ overage_factor: string2().optional().describe("OverageFactor is a multiplier applied to usage beyond the commitment amount"),
56653
+ parent_subscription_id: string2().optional().describe("ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)"),
56527
56654
  pause_status: PauseStatus$zodSchema.optional(),
56528
56655
  pauses: array(SubscriptionSubscriptionPause$zodSchema).optional(),
56529
- payment_behavior: string2().optional(),
56656
+ payment_behavior: string2().optional().describe("PaymentBehavior determines how subscription payments are handled"),
56530
56657
  payment_terms: PaymentTerms$zodSchema.optional(),
56531
- phases: array(DtoSubscriptionPhaseResponse$zodSchema).optional(),
56658
+ phases: array(DtoSubscriptionPhaseResponse$zodSchema).optional().describe("Phases are the subscription phases for this subscription"),
56532
56659
  plan: DtoPlanResponse$zodSchema.optional(),
56533
- plan_id: string2().optional(),
56660
+ plan_id: string2().optional().describe("PlanID is the identifier for the plan in our system"),
56534
56661
  proration_behavior: ProrationBehavior$zodSchema.optional(),
56535
- start_date: string2().optional(),
56662
+ start_date: string2().optional().describe("StartDate is the start date of the subscription"),
56536
56663
  status: Status$zodSchema.optional(),
56537
56664
  subscription_status: SubscriptionStatus$zodSchema.optional(),
56538
56665
  tenant_id: string2().optional(),
56539
- trial_end: string2().optional(),
56540
- trial_start: string2().optional(),
56666
+ trial_end: string2().optional().describe("TrialEnd is the end date of the trial period"),
56667
+ trial_start: string2().optional().describe("TrialStart is the start date of the trial period"),
56541
56668
  updated_at: string2().optional(),
56542
56669
  updated_by: string2().optional(),
56543
- version: int().optional()
56670
+ version: int().optional().describe("Version is used for optimistic locking")
56544
56671
  });
56545
56672
  });
56546
56673
 
@@ -56600,52 +56727,55 @@ var init_dtoinvoiceresponse = __esm(() => {
56600
56727
  init_paymentstatus();
56601
56728
  init_status();
56602
56729
  DtoInvoiceResponse$zodSchema = object({
56603
- adjustment_amount: string2().optional(),
56604
- amount_due: string2().optional(),
56605
- amount_paid: string2().optional(),
56606
- amount_remaining: string2().optional(),
56607
- billing_period: string2().optional(),
56608
- billing_reason: string2().optional(),
56609
- billing_sequence: int().optional(),
56610
- coupon_applications: array(DtoCouponApplicationResponse$zodSchema).optional(),
56730
+ adjustment_amount: string2().optional().describe(`adjustment_amount is the total sum of credit notes of type "adjustment".
56731
+ These are non-cash reductions applied to the invoice (e.g. goodwill credit, billing correction).`),
56732
+ amount_due: string2().optional().describe("amount_due is the total amount that needs to be paid for this invoice"),
56733
+ amount_paid: string2().optional().describe("amount_paid is the amount that has already been paid towards this invoice"),
56734
+ amount_remaining: string2().optional().describe("amount_remaining is the outstanding amount still owed on this invoice (calculated as amount_due minus amount_paid)"),
56735
+ billing_period: string2().optional().describe('billing_period describes the billing period this invoice covers (e.g., "January 2024", "Q1 2024")'),
56736
+ billing_reason: string2().optional().describe('billing_reason indicates why this invoice was generated (e.g., "subscription_billing", "manual_charge")'),
56737
+ billing_sequence: int().optional().describe("billing_sequence is the sequential number indicating the billing cycle for subscription invoices"),
56738
+ coupon_applications: array(DtoCouponApplicationResponse$zodSchema).optional().describe("coupon_applications contains the coupon applications associated with this invoice (overrides embedded field)"),
56611
56739
  created_at: string2().optional(),
56612
56740
  created_by: string2().optional(),
56613
- currency: string2().optional(),
56614
- customer: DtoCustomerResponse$zodSchema.optional(),
56615
- customer_id: string2().optional(),
56616
- description: string2().optional(),
56617
- due_date: string2().optional(),
56618
- environment_id: string2().optional(),
56619
- finalized_at: string2().optional(),
56620
- id: string2().optional(),
56621
- idempotency_key: string2().optional(),
56622
- invoice_number: string2().optional(),
56623
- invoice_pdf_url: string2().optional(),
56741
+ currency: string2().optional().describe("currency is the three-letter ISO currency code (e.g., USD, EUR, GBP) that applies to all monetary amounts on this invoice"),
56742
+ customer: DtoCustomerResponse$zodSchema.optional().describe("Customer response object containing all customer information"),
56743
+ customer_id: string2().optional().describe("customer_id is the ID of the customer who will receive this invoice"),
56744
+ description: string2().optional().describe("description is an optional description or notes about this invoice"),
56745
+ due_date: string2().optional().describe("due_date is the date when payment for this invoice is due"),
56746
+ environment_id: string2().optional().describe("environment_id is the ID of the environment this invoice belongs to (for multi-environment setups)"),
56747
+ finalized_at: string2().optional().describe("finalized_at is the timestamp when this invoice was finalized and made ready for payment"),
56748
+ id: string2().optional().describe("id is the unique identifier for this invoice"),
56749
+ idempotency_key: string2().optional().describe("idempotency_key is a unique key used to prevent duplicate invoice creation when retrying API calls"),
56750
+ invoice_number: string2().optional().describe("invoice_number is the human-readable invoice number displayed to customers (e.g., INV-2024-001)"),
56751
+ invoice_pdf_url: string2().optional().describe("invoice_pdf_url is the URL where customers can download the PDF version of this invoice"),
56624
56752
  invoice_status: InvoiceStatus$zodSchema.optional(),
56625
56753
  invoice_type: InvoiceType$zodSchema.optional(),
56626
- line_items: array(DtoInvoiceLineItemResponse$zodSchema).optional(),
56754
+ line_items: array(DtoInvoiceLineItemResponse$zodSchema).optional().describe("line_items contains the individual items that make up this invoice (overrides embedded field)"),
56627
56755
  metadata: record(string2(), string2()).optional(),
56628
- overpaid_amount: string2().optional(),
56629
- paid_at: string2().optional(),
56756
+ overpaid_amount: string2().optional().describe("overpaid_amount is the amount overpaid if payment_status is OVERPAID (amount_paid - total)"),
56757
+ paid_at: string2().optional().describe("paid_at is the timestamp when this invoice was fully paid"),
56630
56758
  payment_status: PaymentStatus$zodSchema.optional(),
56631
- period_end: string2().optional(),
56632
- period_start: string2().optional(),
56633
- recalculated_invoice_id: string2().optional(),
56634
- refunded_amount: string2().optional(),
56759
+ period_end: string2().optional().describe("period_end is the end date of the billing period covered by this invoice"),
56760
+ period_start: string2().optional().describe("period_start is the start date of the billing period covered by this invoice"),
56761
+ recalculated_invoice_id: string2().optional().describe(`recalculated_invoice_id is the ID of the replacement invoice created when this invoice was voided and recalculated.
56762
+ When set, it forms a parent→child link from this (voided) invoice to the new replacement invoice.`),
56763
+ refunded_amount: string2().optional().describe(`refunded_amount is the total sum of credit notes of type "refund".
56764
+ These are actual refunds issued to the customer.`),
56635
56765
  status: Status$zodSchema.optional(),
56636
56766
  subscription: lazy(() => DtoSubscriptionResponse$zodSchema).optional(),
56637
- subscription_id: string2().optional(),
56638
- subtotal: string2().optional(),
56639
- taxes: array(DtoTaxAppliedResponse$zodSchema).optional(),
56767
+ subscription_id: string2().optional().describe("subscription_id is the ID of the subscription this invoice is associated with (only present for subscription-based invoices)"),
56768
+ subtotal: string2().optional().describe("subtotal is the sum of all line items before any taxes, discounts, or additional fees"),
56769
+ taxes: array(DtoTaxAppliedResponse$zodSchema).optional().describe("tax_applied_records contains the tax applied records associated with this invoice"),
56640
56770
  tenant_id: string2().optional(),
56641
- total: string2().optional(),
56642
- total_discount: string2().optional(),
56643
- total_prepaid_credits_applied: string2().optional(),
56644
- total_tax: string2().optional(),
56771
+ total: string2().optional().describe("total is the final amount including taxes, fees, and discounts"),
56772
+ total_discount: string2().optional().describe("total_discount is the sum of all coupon discounts applied to the invoice"),
56773
+ total_prepaid_credits_applied: string2().optional().describe("total_prepaid_credits_applied is the total amount of prepaid credits applied to this invoice."),
56774
+ total_tax: string2().optional().describe("total_tax is the sum of all taxes combined at the invoice level."),
56645
56775
  updated_at: string2().optional(),
56646
56776
  updated_by: string2().optional(),
56647
- version: int().optional(),
56648
- voided_at: string2().optional()
56777
+ version: int().optional().describe("version is the version number for tracking changes to this invoice"),
56778
+ voided_at: string2().optional().describe("voided_at is the timestamp when this invoice was voided or cancelled")
56649
56779
  });
56650
56780
  });
56651
56781
 
@@ -56924,10 +57054,10 @@ var DtoGetPreviewInvoiceRequest$zodSchema;
56924
57054
  var init_dtogetpreviewinvoicerequest = __esm(() => {
56925
57055
  init_zod();
56926
57056
  DtoGetPreviewInvoiceRequest$zodSchema = object({
56927
- hide_zero_charges_line_items: boolean2().default(false),
56928
- period_end: string2().optional(),
56929
- period_start: string2().optional(),
56930
- subscription_id: string2()
57057
+ hide_zero_charges_line_items: boolean2().default(false).describe("hide_zero_charges_line_items indicates whether to hide line items with zero cost"),
57058
+ period_end: string2().optional().describe("period_end is the optional end date of the period to preview"),
57059
+ period_start: string2().optional().describe("period_start is the optional start date of the period to preview"),
57060
+ subscription_id: string2().describe("subscription_id is the unique identifier of the subscription to preview invoice for")
56931
57061
  });
56932
57062
  });
56933
57063
 
@@ -57011,7 +57141,7 @@ var init_invoicesGetInvoicePreview2 = __esm(() => {
57011
57141
  init_dtogetpreviewinvoicerequest();
57012
57142
  init_tools();
57013
57143
  args23 = {
57014
- request: DtoGetPreviewInvoiceRequest$zodSchema
57144
+ request: DtoGetPreviewInvoiceRequest$zodSchema.describe(`Preview Invoice Request`)
57015
57145
  };
57016
57146
  tool$invoicesGetInvoicePreview = {
57017
57147
  name: "get-invoice-preview",
@@ -57055,29 +57185,37 @@ var init_invoicefilter = __esm(() => {
57055
57185
  "desc"
57056
57186
  ]);
57057
57187
  InvoiceFilter$zodSchema = object({
57058
- amount_due_gt: number2().optional(),
57059
- amount_remaining_gt: number2().optional(),
57060
- customer_id: string2().optional(),
57188
+ amount_due_gt: number2().optional().describe(`amount_due_gt filters invoices with a total amount due greater than the specified value
57189
+ Useful for finding invoices above a certain threshold or identifying high-value invoices`),
57190
+ amount_remaining_gt: number2().optional().describe(`amount_remaining_gt filters invoices with an outstanding balance greater than the specified value
57191
+ Useful for finding invoices that still have significant unpaid amounts`),
57192
+ customer_id: string2().optional().describe(`customer_id filters invoices for a specific customer using FlexPrice's internal customer ID
57193
+ This is the ID returned by FlexPrice when creating or retrieving customers`),
57061
57194
  end_time: string2().optional(),
57062
57195
  expand: string2().optional(),
57063
- external_customer_id: string2().optional(),
57196
+ external_customer_id: string2().optional().describe(`external_customer_id filters invoices for a customer using your system's customer identifier
57197
+ This is the ID you provided when creating the customer in FlexPrice`),
57064
57198
  filters: array(FilterCondition$zodSchema).optional(),
57065
- invoice_ids: array(string2()).optional(),
57066
- invoice_status: array(InvoiceStatus$zodSchema).optional(),
57199
+ invoice_ids: array(string2()).optional().describe(`invoice_ids restricts results to invoices with the specified IDs
57200
+ Use this to retrieve specific invoices when you know their exact identifiers`),
57201
+ invoice_status: array(InvoiceStatus$zodSchema).optional().describe(`invoice_status filters by the current state of invoices in their lifecycle
57202
+ Multiple statuses can be specified to include invoices in any of the listed states`),
57067
57203
  invoice_type: InvoiceType$zodSchema.optional(),
57068
57204
  limit: int().optional(),
57069
57205
  offset: int().optional(),
57070
57206
  order: InvoiceFilterOrder$zodSchema.optional(),
57071
- payment_status: array(PaymentStatus$zodSchema).optional(),
57072
- period_end_gte: string2().optional(),
57073
- period_end_lte: string2().optional(),
57074
- period_start_gte: string2().optional(),
57075
- period_start_lte: string2().optional(),
57076
- skip_line_items: boolean2().optional(),
57207
+ payment_status: array(PaymentStatus$zodSchema).optional().describe(`payment_status filters by the payment state of invoices
57208
+ Multiple statuses can be specified to include invoices with any of the listed payment states`),
57209
+ period_end_gte: string2().optional().describe("period_end_gte filters invoices with period_end >= value"),
57210
+ period_end_lte: string2().optional().describe("period_end_lte filters invoices with period_end <= value"),
57211
+ period_start_gte: string2().optional().describe("period_start_gte filters invoices with period_start >= value"),
57212
+ period_start_lte: string2().optional().describe("period_start_lte filters invoices with period_start <= value"),
57213
+ skip_line_items: boolean2().optional().describe("SkipLineItems if true, will not include line items in the response"),
57077
57214
  sort: array(SortCondition$zodSchema).optional(),
57078
57215
  start_time: string2().optional(),
57079
57216
  status: Status$zodSchema.optional(),
57080
- subscription_id: string2().optional()
57217
+ subscription_id: string2().optional().describe(`subscription_id filters invoices generated for a specific subscription
57218
+ Only returns invoices that were created as part of the specified subscription's billing`)
57081
57219
  });
57082
57220
  });
57083
57221
 
@@ -57161,7 +57299,7 @@ var init_invoicesQueryInvoice2 = __esm(() => {
57161
57299
  init_invoicefilter();
57162
57300
  init_tools();
57163
57301
  args24 = {
57164
- request: InvoiceFilter$zodSchema
57302
+ request: InvoiceFilter$zodSchema.describe(`Filter`)
57165
57303
  };
57166
57304
  tool$invoicesQueryInvoice = {
57167
57305
  name: "query-invoice",
@@ -57599,7 +57737,7 @@ var init_dtoupdateinvoicerequest = __esm(() => {
57599
57737
  init_zod();
57600
57738
  DtoUpdateInvoiceRequest$zodSchema = object({
57601
57739
  due_date: string2().optional(),
57602
- invoice_pdf_url: string2().optional(),
57740
+ invoice_pdf_url: string2().optional().describe("invoice_pdf_url is the URL where customers can download the PDF version of this invoice"),
57603
57741
  metadata: record(string2(), string2()).optional()
57604
57742
  });
57605
57743
  });
@@ -57612,7 +57750,7 @@ var init_updateinvoiceop = __esm(() => {
57612
57750
  init_dtoupdateinvoicerequest();
57613
57751
  init_errorserrorresponse();
57614
57752
  UpdateInvoiceRequest$zodSchema = object({
57615
- body: DtoUpdateInvoiceRequest$zodSchema,
57753
+ body: DtoUpdateInvoiceRequest$zodSchema.describe("Invoice Update Request"),
57616
57754
  id: string2().describe("Invoice ID")
57617
57755
  });
57618
57756
  UpdateInvoiceResponse$zodSchema = union([
@@ -57742,7 +57880,7 @@ var init_dtoupdatepaymentstatusrequest = __esm(() => {
57742
57880
  init_zod();
57743
57881
  init_paymentstatus();
57744
57882
  DtoUpdatePaymentStatusRequest$zodSchema = object({
57745
- amount: string2().optional(),
57883
+ amount: string2().optional().describe("amount is the optional payment amount to record"),
57746
57884
  payment_status: PaymentStatus$zodSchema
57747
57885
  });
57748
57886
  });
@@ -57755,7 +57893,7 @@ var init_updateinvoicepaymentstatusop = __esm(() => {
57755
57893
  init_dtoupdatepaymentstatusrequest();
57756
57894
  init_errorserrorresponse();
57757
57895
  UpdateInvoicePaymentStatusRequest$zodSchema = object({
57758
- body: DtoUpdatePaymentStatusRequest$zodSchema,
57896
+ body: DtoUpdatePaymentStatusRequest$zodSchema.describe("Payment Status Update Request"),
57759
57897
  id: string2().describe("Invoice ID")
57760
57898
  });
57761
57899
  UpdateInvoicePaymentStatusResponse$zodSchema = union([
@@ -58101,7 +58239,7 @@ var init_plansCreatePlan2 = __esm(() => {
58101
58239
  init_dtocreateplanrequest();
58102
58240
  init_tools();
58103
58241
  args31 = {
58104
- request: DtoCreatePlanRequest$zodSchema
58242
+ request: DtoCreatePlanRequest$zodSchema.describe(`Plan configuration`)
58105
58243
  };
58106
58244
  tool$plansCreatePlan = {
58107
58245
  name: "create-plan",
@@ -58393,11 +58531,11 @@ var DtoClonePlanRequest$zodSchema;
58393
58531
  var init_dtocloneplanrequest = __esm(() => {
58394
58532
  init_zod();
58395
58533
  DtoClonePlanRequest$zodSchema = object({
58396
- description: string2().optional(),
58397
- display_order: int().optional(),
58398
- lookup_key: string2().optional(),
58534
+ description: string2().optional().describe("Description overrides the source plan's description when provided"),
58535
+ display_order: int().optional().describe("DisplayOrder overrides the source plan's display order when provided"),
58536
+ lookup_key: string2().optional().describe("LookupKey is required and must be unique across published plans"),
58399
58537
  metadata: record(string2(), string2()).optional(),
58400
- name: string2().optional()
58538
+ name: string2().optional().describe("Name is required and must be different from the source plan's name")
58401
58539
  });
58402
58540
  });
58403
58541
 
@@ -58409,7 +58547,7 @@ var init_postplansidcloneop = __esm(() => {
58409
58547
  init_dtoplanresponse();
58410
58548
  init_errorserrorresponse();
58411
58549
  PostPlansIdCloneRequest$zodSchema = object({
58412
- body: DtoClonePlanRequest$zodSchema,
58550
+ body: DtoClonePlanRequest$zodSchema.describe("Clone configuration"),
58413
58551
  id: string2().describe("Source Plan ID")
58414
58552
  });
58415
58553
  PostPlansIdCloneResponse$zodSchema = union([
@@ -58547,7 +58685,7 @@ var init_planfilter = __esm(() => {
58547
58685
  PlanFilter$zodSchema = object({
58548
58686
  end_time: string2().optional(),
58549
58687
  expand: string2().optional(),
58550
- filters: array(FilterCondition$zodSchema).optional(),
58688
+ filters: array(FilterCondition$zodSchema).optional().describe("filters allows complex filtering based on multiple fields"),
58551
58689
  limit: int().optional(),
58552
58690
  lookup_key: string2().optional(),
58553
58691
  offset: int().optional(),
@@ -58639,7 +58777,7 @@ var init_plansQueryPlan2 = __esm(() => {
58639
58777
  init_planfilter();
58640
58778
  init_tools();
58641
58779
  args35 = {
58642
- request: PlanFilter$zodSchema
58780
+ request: PlanFilter$zodSchema.describe(`Filter`)
58643
58781
  };
58644
58782
  tool$plansQueryPlan = {
58645
58783
  name: "query-plan",
@@ -58818,7 +58956,7 @@ var init_updateplanop = __esm(() => {
58818
58956
  init_dtoupdateplanrequest();
58819
58957
  init_errorserrorresponse();
58820
58958
  UpdatePlanRequest$zodSchema = object({
58821
- body: DtoUpdatePlanRequest$zodSchema,
58959
+ body: DtoUpdatePlanRequest$zodSchema.describe("Plan update"),
58822
58960
  id: string2().describe("Plan ID")
58823
58961
  });
58824
58962
  UpdatePlanResponse$zodSchema = union([
@@ -58947,9 +59085,13 @@ var DtoCreatePriceTier$zodSchema;
58947
59085
  var init_dtocreatepricetier = __esm(() => {
58948
59086
  init_zod();
58949
59087
  DtoCreatePriceTier$zodSchema = object({
58950
- flat_amount: string2().optional(),
58951
- unit_amount: string2(),
58952
- up_to: int().optional()
59088
+ flat_amount: string2().optional().describe(`flat_amount is the flat amount for the given tier (optional)
59089
+ Applied on top of unit_amount*quantity. Useful for cases like "2.7$ + 5c"`),
59090
+ unit_amount: string2().describe("unit_amount is the amount per unit for the given tier"),
59091
+ up_to: int().optional().describe(`up_to is the quantity up to which this tier applies. It is null for the last tier.
59092
+ IMPORTANT: Tier boundaries are INCLUSIVE.
59093
+ - If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier
59094
+ - This behavior is consistent across both VOLUME and SLAB tier modes`)
58953
59095
  });
58954
59096
  });
58955
59097
 
@@ -58971,7 +59113,7 @@ var init_pricetransformquantity = __esm(() => {
58971
59113
  init_zod();
58972
59114
  init_roundtype();
58973
59115
  PriceTransformQuantity$zodSchema = object({
58974
- divide_by: int().optional(),
59116
+ divide_by: int().optional().describe("Divide quantity by this number"),
58975
59117
  round: RoundType$zodSchema.optional()
58976
59118
  });
58977
59119
  });
@@ -59004,12 +59146,12 @@ var init_dtocreatepricerequest = __esm(() => {
59004
59146
  entity_id: string2(),
59005
59147
  entity_type: PriceEntityType$zodSchema,
59006
59148
  filter_values: record(string2(), array(string2())).optional(),
59007
- group_id: string2().optional(),
59149
+ group_id: string2().optional().describe("GroupID is the id of the group to add the price to"),
59008
59150
  invoice_cadence: InvoiceCadence$zodSchema,
59009
59151
  lookup_key: string2().optional(),
59010
59152
  metadata: record(string2(), string2()).optional(),
59011
59153
  meter_id: string2().optional(),
59012
- min_quantity: int().optional(),
59154
+ min_quantity: int().optional().describe("MinQuantity is the minimum quantity of the price"),
59013
59155
  price_unit_config: DtoPriceUnitConfig$zodSchema.optional(),
59014
59156
  price_unit_type: PriceUnitType$zodSchema,
59015
59157
  start_date: string2().optional(),
@@ -59101,7 +59243,7 @@ var init_pricesCreatePrice2 = __esm(() => {
59101
59243
  init_dtocreatepricerequest();
59102
59244
  init_tools();
59103
59245
  args38 = {
59104
- request: DtoCreatePriceRequest$zodSchema
59246
+ request: DtoCreatePriceRequest$zodSchema.describe(`Price configuration`)
59105
59247
  };
59106
59248
  tool$pricesCreatePrice = {
59107
59249
  name: "create-price",
@@ -59220,7 +59362,7 @@ var init_pricesCreatePricesBulk2 = __esm(() => {
59220
59362
  init_dtocreatebulkpricerequest();
59221
59363
  init_tools();
59222
59364
  args39 = {
59223
- request: DtoCreateBulkPriceRequest$zodSchema
59365
+ request: DtoCreateBulkPriceRequest$zodSchema.describe(`Bulk price configuration`)
59224
59366
  };
59225
59367
  tool$pricesCreatePricesBulk = {
59226
59368
  name: "create-prices-bulk",
@@ -59266,7 +59408,7 @@ var init_deletepriceop = __esm(() => {
59266
59408
  init_dtosuccessresponse();
59267
59409
  init_errorserrorresponse();
59268
59410
  DeletePriceRequest$zodSchema = object({
59269
- body: DtoDeletePriceRequest$zodSchema,
59411
+ body: DtoDeletePriceRequest$zodSchema.describe("Delete Price Request"),
59270
59412
  id: string2().describe("Price ID")
59271
59413
  });
59272
59414
  DeletePriceResponse$zodSchema = union([
@@ -59665,13 +59807,13 @@ var init_pricefilter = __esm(() => {
59665
59807
  entity_ids: array(string2()).optional(),
59666
59808
  entity_type: PriceEntityType$zodSchema.optional(),
59667
59809
  expand: string2().optional(),
59668
- filters: array(FilterCondition$zodSchema).optional(),
59810
+ filters: array(FilterCondition$zodSchema).optional().describe("DSL filters"),
59669
59811
  limit: int().optional(),
59670
59812
  meter_ids: array(string2()).optional(),
59671
59813
  offset: int().optional(),
59672
59814
  order: PriceFilterOrder$zodSchema.optional(),
59673
59815
  parent_price_id: string2().optional(),
59674
- plan_ids: array(string2()).optional(),
59816
+ plan_ids: array(string2()).optional().describe("Price override filtering fields"),
59675
59817
  price_ids: array(string2()).optional(),
59676
59818
  sort: string2().optional(),
59677
59819
  start_date_lt: string2().optional(),
@@ -59761,7 +59903,7 @@ var init_pricesQueryPrice2 = __esm(() => {
59761
59903
  init_pricefilter();
59762
59904
  init_tools();
59763
59905
  args43 = {
59764
- request: PriceFilter$zodSchema
59906
+ request: PriceFilter$zodSchema.describe(`Filter`)
59765
59907
  };
59766
59908
  tool$pricesQueryPrice = {
59767
59909
  name: "query-price",
@@ -59799,18 +59941,22 @@ var init_dtoupdatepricerequest = __esm(() => {
59799
59941
  init_dtocreatepricetier();
59800
59942
  init_pricetransformquantity();
59801
59943
  DtoUpdatePriceRequest$zodSchema = object({
59802
- amount: string2().optional(),
59944
+ amount: string2().optional().describe("Amount is the new price amount that overrides the original price (optional)"),
59803
59945
  billing_model: BillingModel$zodSchema.optional(),
59804
59946
  description: string2().optional(),
59805
59947
  display_name: string2().optional(),
59806
59948
  effective_from: string2().optional(),
59807
- group_id: string2().optional(),
59808
- lookup_key: string2().optional(),
59949
+ group_id: string2().optional().describe(`GroupID is the id of the group to update the price in.
59950
+ If not provided (nil), the group will not be changed
59951
+ If provided as empty string (""), the group will be removed (price will be ungrouped)
59952
+ If provided as a group ID, the price will be assigned to that group (must exist and be published)`),
59953
+ lookup_key: string2().optional().describe(`All price fields that can be updated
59954
+ Non-critical fields (can be updated directly)`),
59809
59955
  metadata: record(string2(), string2()).optional(),
59810
- price_unit_amount: string2().optional(),
59811
- price_unit_tiers: array(DtoCreatePriceTier$zodSchema).optional(),
59956
+ price_unit_amount: string2().optional().describe("PriceUnitAmount is the price unit amount (for CUSTOM price unit type, FLAT_FEE/PACKAGE billing models)"),
59957
+ price_unit_tiers: array(DtoCreatePriceTier$zodSchema).optional().describe("PriceUnitTiers are the price unit tiers (for CUSTOM price unit type, TIERED billing model)"),
59812
59958
  tier_mode: BillingTier$zodSchema.optional(),
59813
- tiers: array(DtoCreatePriceTier$zodSchema).optional(),
59959
+ tiers: array(DtoCreatePriceTier$zodSchema).optional().describe("Tiers determines the pricing tiers for this line item"),
59814
59960
  transform_quantity: PriceTransformQuantity$zodSchema.optional()
59815
59961
  });
59816
59962
  });
@@ -59823,7 +59969,7 @@ var init_updatepriceop = __esm(() => {
59823
59969
  init_dtoupdatepricerequest();
59824
59970
  init_errorserrorresponse();
59825
59971
  UpdatePriceRequest$zodSchema = object({
59826
- body: DtoUpdatePriceRequest$zodSchema,
59972
+ body: DtoUpdatePriceRequest$zodSchema.describe("Price configuration"),
59827
59973
  id: string2().describe("Price ID")
59828
59974
  });
59829
59975
  UpdatePriceResponse$zodSchema = union([
@@ -59952,7 +60098,7 @@ var DtoActivateDraftSubscriptionRequest$zodSchema;
59952
60098
  var init_dtoactivatedraftsubscriptionrequest = __esm(() => {
59953
60099
  init_zod();
59954
60100
  DtoActivateDraftSubscriptionRequest$zodSchema = object({
59955
- start_date: string2()
60101
+ start_date: string2().describe("start_date is the new start date for the subscription when activating")
59956
60102
  });
59957
60103
  });
59958
60104
 
@@ -59964,7 +60110,7 @@ var init_activatesubscriptionop = __esm(() => {
59964
60110
  init_dtosubscriptionresponse();
59965
60111
  init_errorserrorresponse();
59966
60112
  ActivateSubscriptionRequest$zodSchema = object({
59967
- body: DtoActivateDraftSubscriptionRequest$zodSchema,
60113
+ body: DtoActivateDraftSubscriptionRequest$zodSchema.describe("Activate Draft Subscription Request"),
59968
60114
  id: string2().describe("Subscription ID")
59969
60115
  });
59970
60116
  ActivateSubscriptionResponse$zodSchema = union([
@@ -60095,13 +60241,13 @@ var init_dtolineitemcommitmentconfig = __esm(() => {
60095
60241
  init_billingperiod();
60096
60242
  init_commitmenttype();
60097
60243
  DtoLineItemCommitmentConfig$zodSchema = object({
60098
- commitment_amount: number2().optional(),
60244
+ commitment_amount: number2().optional().describe("CommitmentAmount is the minimum amount committed for this line item"),
60099
60245
  commitment_duration: BillingPeriod$zodSchema.optional(),
60100
- commitment_quantity: number2().optional(),
60246
+ commitment_quantity: number2().optional().describe("CommitmentQuantity is the minimum quantity committed for this line item"),
60101
60247
  commitment_type: CommitmentType$zodSchema.optional(),
60102
- enable_true_up: boolean2().optional(),
60103
- is_window_commitment: boolean2().optional(),
60104
- overage_factor: number2().optional()
60248
+ enable_true_up: boolean2().optional().describe("EnableTrueUp determines if true-up fee should be applied when usage is below commitment"),
60249
+ is_window_commitment: boolean2().optional().describe("IsWindowCommitment determines if commitment is applied per window (e.g., per day) rather than per billing period"),
60250
+ overage_factor: number2().optional().describe("OverageFactor is a multiplier applied to usage beyond the commitment")
60105
60251
  });
60106
60252
  });
60107
60253
 
@@ -60112,7 +60258,7 @@ var init_dtoaddaddonrequest = __esm(() => {
60112
60258
  init_dtolineitemcommitmentconfig();
60113
60259
  DtoAddAddonRequest$zodSchema = object({
60114
60260
  addon_id: string2(),
60115
- line_item_commitments: record(string2(), DtoLineItemCommitmentConfig$zodSchema).optional(),
60261
+ line_item_commitments: record(string2(), DtoLineItemCommitmentConfig$zodSchema).optional().describe("LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id)"),
60116
60262
  metadata: record(string2(), any()).optional(),
60117
60263
  start_date: string2().optional(),
60118
60264
  subscription_id: string2()
@@ -60199,7 +60345,7 @@ var init_subscriptionsAddSubscriptionAddon2 = __esm(() => {
60199
60345
  init_dtoaddaddonrequest();
60200
60346
  init_tools();
60201
60347
  args46 = {
60202
- request: DtoAddAddonRequest$zodSchema
60348
+ request: DtoAddAddonRequest$zodSchema.describe(`Add Addon Request`)
60203
60349
  };
60204
60350
  tool$subscriptionsAddSubscriptionAddon = {
60205
60351
  name: "add-subscription-addon",
@@ -60244,7 +60390,8 @@ var init_cancellationtype = __esm(() => {
60244
60390
  init_zod();
60245
60391
  CancellationType$zodSchema = _enum([
60246
60392
  "immediate",
60247
- "end_of_period"
60393
+ "end_of_period",
60394
+ "scheduled_date"
60248
60395
  ]);
60249
60396
  });
60250
60397
 
@@ -60256,10 +60403,12 @@ var init_dtocancelsubscriptionrequest = __esm(() => {
60256
60403
  init_cancellationtype();
60257
60404
  init_prorationbehavior();
60258
60405
  DtoCancelSubscriptionRequest$zodSchema = object({
60406
+ cancel_at: string2().optional().describe(`CancelAt is the custom date to cancel the subscription.
60407
+ Required when CancellationType is "scheduled_date". Must be in the future.`),
60259
60408
  cancel_immediately_inovice_policy: CancelImmediatelyInvoicePolicy$zodSchema.optional(),
60260
60409
  cancellation_type: CancellationType$zodSchema,
60261
60410
  proration_behavior: ProrationBehavior$zodSchema.optional(),
60262
- reason: string2().optional()
60411
+ reason: string2().optional().describe("Reason for cancellation (for audit and business intelligence)")
60263
60412
  });
60264
60413
  });
60265
60414
 
@@ -60290,13 +60439,13 @@ var init_dtocancelsubscriptionresponse = __esm(() => {
60290
60439
  DtoCancelSubscriptionResponse$zodSchema = object({
60291
60440
  cancellation_type: CancellationType$zodSchema.optional(),
60292
60441
  effective_date: string2().optional(),
60293
- message: string2().optional(),
60442
+ message: string2().optional().describe("Response metadata"),
60294
60443
  processed_at: string2().optional(),
60295
60444
  proration_details: array(DtoProrationDetail$zodSchema).optional(),
60296
60445
  proration_invoice: DtoInvoiceResponse$zodSchema.optional(),
60297
60446
  reason: string2().optional(),
60298
60447
  status: SubscriptionStatus$zodSchema.optional(),
60299
- subscription_id: string2().optional(),
60448
+ subscription_id: string2().optional().describe("Basic cancellation info"),
60300
60449
  total_credit_amount: string2().optional()
60301
60450
  });
60302
60451
  });
@@ -60309,7 +60458,7 @@ var init_cancelsubscriptionop = __esm(() => {
60309
60458
  init_dtocancelsubscriptionresponse();
60310
60459
  init_errorserrorresponse();
60311
60460
  CancelSubscriptionRequest$zodSchema = object({
60312
- body: DtoCancelSubscriptionRequest$zodSchema,
60461
+ body: DtoCancelSubscriptionRequest$zodSchema.describe("Cancel Subscription Request"),
60313
60462
  id: string2().describe("Subscription ID")
60314
60463
  });
60315
60464
  CancelSubscriptionResponse$zodSchema = union([
@@ -60449,9 +60598,9 @@ var init_dtocancelschedulerequest = __esm(() => {
60449
60598
  init_zod();
60450
60599
  init_subscriptionschedulechangetype();
60451
60600
  DtoCancelScheduleRequest$zodSchema = object({
60452
- schedule_id: string2().optional(),
60601
+ schedule_id: string2().optional().describe("schedule_id is the ID of the schedule to cancel (optional if subscription_id and schedule_type are provided)"),
60453
60602
  schedule_type: SubscriptionScheduleChangeType$zodSchema.optional(),
60454
- subscription_id: string2().optional()
60603
+ subscription_id: string2().optional().describe("subscription_id is the ID of the subscription (required if schedule_id is not provided)")
60455
60604
  }).describe("Request to cancel a subscription schedule (supports two modes)");
60456
60605
  });
60457
60606
 
@@ -60461,7 +60610,7 @@ var init_cancelsubscriptionscheduleop = __esm(() => {
60461
60610
  init_zod();
60462
60611
  init_dtocancelschedulerequest();
60463
60612
  CancelSubscriptionScheduleRequest$zodSchema = object({
60464
- body: DtoCancelScheduleRequest$zodSchema.optional(),
60613
+ body: DtoCancelScheduleRequest$zodSchema.optional().describe("Cancel request (optional if using path parameter)"),
60465
60614
  schedule_id: string2().describe("Schedule ID (optional if using request body)")
60466
60615
  });
60467
60616
  });
@@ -60598,7 +60747,7 @@ var init_dtoaddaddontosubscriptionrequest = __esm(() => {
60598
60747
  init_dtolineitemcommitmentconfig();
60599
60748
  DtoAddAddonToSubscriptionRequest$zodSchema = object({
60600
60749
  addon_id: string2(),
60601
- line_item_commitments: record(string2(), DtoLineItemCommitmentConfig$zodSchema).optional(),
60750
+ line_item_commitments: record(string2(), DtoLineItemCommitmentConfig$zodSchema).optional().describe("LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id)"),
60602
60751
  metadata: record(string2(), any()).optional(),
60603
60752
  start_date: string2().optional()
60604
60753
  });
@@ -60615,7 +60764,10 @@ var init_dtocreatecreditgrantrequest = __esm(() => {
60615
60764
  init_creditgrantscope();
60616
60765
  DtoCreateCreditGrantRequest$zodSchema = object({
60617
60766
  cadence: CreditGrantCadence$zodSchema,
60618
- conversion_rate: string2().optional(),
60767
+ conversion_rate: string2().optional().describe(`amount in the currency = number of credits * conversion_rate
60768
+ ex if conversion_rate is 1, then 1 USD = 1 credit
60769
+ ex if conversion_rate is 2, then 1 USD = 0.5 credits
60770
+ ex if conversion_rate is 0.5, then 1 USD = 2 credits`),
60619
60771
  credits: string2(),
60620
60772
  end_date: string2().optional(),
60621
60773
  expiration_duration: int().optional(),
@@ -60630,7 +60782,10 @@ var init_dtocreatecreditgrantrequest = __esm(() => {
60630
60782
  scope: CreditGrantScope$zodSchema,
60631
60783
  start_date: string2().optional(),
60632
60784
  subscription_id: string2().optional(),
60633
- topup_conversion_rate: string2().optional()
60785
+ topup_conversion_rate: string2().optional().describe(`topup_conversion_rate is the conversion rate for the topup to the currency
60786
+ ex if topup_conversion_rate is 1, then 1 USD = 1 credit
60787
+ ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits
60788
+ ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits`)
60634
60789
  });
60635
60790
  });
60636
60791
 
@@ -60682,7 +60837,7 @@ var init_dtocreatesubscriptionlineitemrequest = __esm(() => {
60682
60837
  init_commitmenttype();
60683
60838
  init_dtosubscriptionpricecreaterequest();
60684
60839
  DtoCreateSubscriptionLineItemRequest$zodSchema = object({
60685
- commitment_amount: number2().optional(),
60840
+ commitment_amount: number2().optional().describe("Commitment fields"),
60686
60841
  commitment_duration: BillingPeriod$zodSchema.optional(),
60687
60842
  commitment_overage_factor: number2().optional(),
60688
60843
  commitment_quantity: number2().optional(),
@@ -60693,7 +60848,7 @@ var init_dtocreatesubscriptionlineitemrequest = __esm(() => {
60693
60848
  end_date: string2().optional(),
60694
60849
  metadata: record(string2(), string2()).optional(),
60695
60850
  price: DtoSubscriptionPriceCreateRequest$zodSchema.optional(),
60696
- price_id: string2().optional(),
60851
+ price_id: string2().optional().describe("PriceID references an existing price (plan, addon, or subscription-scoped). Exactly one of price_id or price must be set."),
60697
60852
  quantity: number2().optional(),
60698
60853
  start_date: string2().optional(),
60699
60854
  subscription_phase_id: string2().optional()
@@ -60705,10 +60860,11 @@ var DtoOverrideEntitlementRequest$zodSchema;
60705
60860
  var init_dtooverrideentitlementrequest = __esm(() => {
60706
60861
  init_zod();
60707
60862
  DtoOverrideEntitlementRequest$zodSchema = object({
60708
- entitlement_id: string2(),
60709
- is_enabled: boolean2().optional(),
60710
- static_value: string2().optional(),
60711
- usage_limit: int().optional()
60863
+ entitlement_id: string2().describe("EntitlementID references the plan/addon entitlement to override"),
60864
+ is_enabled: boolean2().optional().describe("IsEnabled determines if the entitlement is enabled or disabled"),
60865
+ static_value: string2().optional().describe("StaticValue is the static value for static features"),
60866
+ usage_limit: int().optional().describe(`UsageLimit is the new usage limit (only these 3 fields can be overridden)
60867
+ For metered features, nil means unlimited usage`)
60712
60868
  });
60713
60869
  });
60714
60870
 
@@ -60721,14 +60877,14 @@ var init_dtooverridelineitemrequest = __esm(() => {
60721
60877
  init_dtocreatepricetier();
60722
60878
  init_pricetransformquantity();
60723
60879
  DtoOverrideLineItemRequest$zodSchema = object({
60724
- amount: string2().optional(),
60880
+ amount: string2().optional().describe("Amount is the new price amount that overrides the original price (optional)"),
60725
60881
  billing_model: BillingModel$zodSchema.optional(),
60726
- price_id: string2(),
60727
- price_unit_amount: string2().optional(),
60728
- price_unit_tiers: array(DtoCreatePriceTier$zodSchema).optional(),
60729
- quantity: string2().optional(),
60882
+ price_id: string2().describe("PriceID references the plan price to override"),
60883
+ price_unit_amount: string2().optional().describe("PriceUnitAmount is the amount of the price unit (for CUSTOM type, FLAT_FEE/PACKAGE billing models)"),
60884
+ price_unit_tiers: array(DtoCreatePriceTier$zodSchema).optional().describe("PriceUnitTiers are the tiers for the price unit (for CUSTOM type, TIERED billing model)"),
60885
+ quantity: string2().optional().describe("Quantity for this line item (optional)"),
60730
60886
  tier_mode: BillingTier$zodSchema.optional(),
60731
- tiers: array(DtoCreatePriceTier$zodSchema).optional(),
60887
+ tiers: array(DtoCreatePriceTier$zodSchema).optional().describe("Tiers determines the pricing tiers for this line item"),
60732
60888
  transform_quantity: PriceTransformQuantity$zodSchema.optional()
60733
60889
  });
60734
60890
  });
@@ -60739,11 +60895,12 @@ var init_dtosubscriptionphasecreaterequest = __esm(() => {
60739
60895
  init_zod();
60740
60896
  init_dtooverridelineitemrequest();
60741
60897
  DtoSubscriptionPhaseCreateRequest$zodSchema = object({
60742
- coupons: array(string2()).optional(),
60898
+ coupons: array(string2()).optional().describe("Coupons represents subscription-level coupons to be applied to this phase"),
60743
60899
  end_date: string2().optional(),
60744
- line_item_coupons: record(string2(), array(string2())).optional(),
60900
+ line_item_coupons: record(string2(), array(string2())).optional().describe("LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)"),
60745
60901
  metadata: record(string2(), string2()).optional(),
60746
- override_line_items: array(DtoOverrideLineItemRequest$zodSchema).optional(),
60902
+ override_line_items: array(DtoOverrideLineItemRequest$zodSchema).optional().describe(`OverrideLineItems allows customizing specific prices for this phase
60903
+ If not provided, phase will use the same line items as the subscription (plan prices)`),
60747
60904
  start_date: string2()
60748
60905
  });
60749
60906
  });
@@ -60792,41 +60949,50 @@ var init_dtocreatesubscriptionrequest = __esm(() => {
60792
60949
  init_prorationbehavior();
60793
60950
  init_subscriptionstatus();
60794
60951
  DtoCreateSubscriptionRequest$zodSchema = object({
60795
- addons: array(DtoAddAddonToSubscriptionRequest$zodSchema).optional(),
60952
+ addons: array(DtoAddAddonToSubscriptionRequest$zodSchema).optional().describe("Addons represents addons to be added to the subscription during creation"),
60796
60953
  billing_cadence: BillingCadence$zodSchema,
60797
60954
  billing_cycle: BillingCycle$zodSchema.optional(),
60798
60955
  billing_period: BillingPeriod$zodSchema,
60799
60956
  billing_period_count: int().optional(),
60800
60957
  collection_method: CollectionMethod$zodSchema.optional(),
60801
- commitment_amount: string2().optional(),
60958
+ commitment_amount: string2().optional().describe("CommitmentAmount is the minimum amount a customer commits to paying for a billing period"),
60802
60959
  commitment_duration: BillingPeriod$zodSchema.optional(),
60803
60960
  coupons: array(string2()).optional(),
60804
- credit_grants: array(DtoCreateCreditGrantRequest$zodSchema).optional(),
60961
+ credit_grants: array(DtoCreateCreditGrantRequest$zodSchema).optional().describe("Credit grants to be applied when subscription is created"),
60805
60962
  currency: string2(),
60806
- customer_id: string2().optional(),
60807
- customer_timezone: string2().optional(),
60808
- enable_true_up: boolean2().optional(),
60963
+ customer_id: string2().optional().describe(`customer_id is the flexprice customer id
60964
+ and it is prioritized over external_customer_id in case both are provided.`),
60965
+ customer_timezone: string2().optional().describe(`Timezone of the customer.
60966
+ If not set, the default value is UTC.`),
60967
+ enable_true_up: boolean2().optional().describe("Enable Commitment True Up Fee"),
60809
60968
  end_date: string2().optional(),
60810
- external_customer_id: string2().optional(),
60969
+ external_customer_id: string2().optional().describe(`external_customer_id is the customer id in your DB
60970
+ and must be same as what you provided as external_id while creating the customer in flexprice.`),
60811
60971
  gateway_payment_method_id: string2().optional(),
60812
60972
  invoice_billing: InvoiceBilling$zodSchema.optional(),
60813
- line_item_commitments: record(string2(), DtoLineItemCommitmentConfig$zodSchema).optional(),
60973
+ invoicing_customer_external_id: string2().optional().describe(`invoicing_customer_external_id is the external ID of the customer to use for invoicing.
60974
+ Resolved internally to an internal customer ID via external ID lookup.
60975
+ Mutually exclusive with invoicing_customer_id.`),
60976
+ invoicing_customer_id: string2().optional().describe(`invoicing_customer_id is the FlexPrice customer ID to use for invoicing.
60977
+ This can differ from the subscription customer (e.g., a billing entity invoicing on behalf of another customer).
60978
+ Mutually exclusive with invoicing_customer_external_id.`),
60979
+ line_item_commitments: record(string2(), DtoLineItemCommitmentConfig$zodSchema).optional().describe("LineItemCommitments allows setting commitment configuration per line item (keyed by price_id)"),
60814
60980
  line_item_coupons: record(string2(), array(string2())).optional(),
60815
- line_items: array(DtoCreateSubscriptionLineItemRequest$zodSchema).optional(),
60981
+ line_items: array(DtoCreateSubscriptionLineItemRequest$zodSchema).optional().describe("LineItems are extra line items to add at creation (each with price_id or price), in addition to plan prices"),
60816
60982
  lookup_key: string2().optional(),
60817
60983
  metadata: record(string2(), string2()).optional(),
60818
- overage_factor: string2().optional(),
60819
- override_entitlements: array(DtoOverrideEntitlementRequest$zodSchema).optional(),
60820
- override_line_items: array(DtoOverrideLineItemRequest$zodSchema).optional(),
60821
- parent_subscription_id: string2().optional(),
60984
+ overage_factor: string2().optional().describe("OverageFactor is a multiplier applied to usage beyond the commitment amount"),
60985
+ override_entitlements: array(DtoOverrideEntitlementRequest$zodSchema).optional().describe("OverrideEntitlements allows customizing specific entitlements for this subscription"),
60986
+ override_line_items: array(DtoOverrideLineItemRequest$zodSchema).optional().describe("OverrideLineItems allows customizing specific prices for this subscription"),
60987
+ parent_subscription_id: string2().optional().describe("ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)"),
60822
60988
  payment_behavior: PaymentBehavior$zodSchema.optional(),
60823
60989
  payment_terms: PaymentTerms$zodSchema.optional(),
60824
- phases: array(DtoSubscriptionPhaseCreateRequest$zodSchema).optional(),
60990
+ phases: array(DtoSubscriptionPhaseCreateRequest$zodSchema).optional().describe("Phases represents subscription phases to be created with the subscription"),
60825
60991
  plan_id: string2(),
60826
60992
  proration_behavior: ProrationBehavior$zodSchema.optional(),
60827
60993
  start_date: string2().optional(),
60828
60994
  subscription_status: SubscriptionStatus$zodSchema.optional(),
60829
- tax_rate_overrides: array(DtoTaxRateOverride$zodSchema).optional(),
60995
+ tax_rate_overrides: array(DtoTaxRateOverride$zodSchema).optional().describe("tax_rate_overrides is the tax rate overrides\tto be applied to the subscription"),
60830
60996
  trial_end: string2().optional(),
60831
60997
  trial_start: string2().optional()
60832
60998
  });
@@ -60912,7 +61078,7 @@ var init_subscriptionsCreateSubscription2 = __esm(() => {
60912
61078
  init_dtocreatesubscriptionrequest();
60913
61079
  init_tools();
60914
61080
  args49 = {
60915
- request: DtoCreateSubscriptionRequest$zodSchema
61081
+ request: DtoCreateSubscriptionRequest$zodSchema.describe(`Subscription Request`)
60916
61082
  };
60917
61083
  tool$subscriptionsCreateSubscription = {
60918
61084
  name: "create-subscription",
@@ -60954,8 +61120,8 @@ var init_dtosubscriptionlineitemresponse = __esm(() => {
60954
61120
  init_subscriptionlineitementitytype();
60955
61121
  DtoSubscriptionLineItemResponse$zodSchema = object({
60956
61122
  billing_period: BillingPeriod$zodSchema.optional(),
60957
- billing_period_count: int().optional(),
60958
- commitment_amount: string2().optional(),
61123
+ billing_period_count: int().optional().describe("from price at create; default 1"),
61124
+ commitment_amount: string2().optional().describe("Commitment fields"),
60959
61125
  commitment_duration: BillingPeriod$zodSchema.optional(),
60960
61126
  commitment_overage_factor: string2().optional(),
60961
61127
  commitment_quantity: string2().optional(),
@@ -61002,7 +61168,7 @@ var init_createsubscriptionlineitemop = __esm(() => {
61002
61168
  init_dtosubscriptionlineitemresponse();
61003
61169
  init_errorserrorresponse();
61004
61170
  CreateSubscriptionLineItemRequest$zodSchema = object({
61005
- body: DtoCreateSubscriptionLineItemRequest$zodSchema,
61171
+ body: DtoCreateSubscriptionLineItemRequest$zodSchema.describe("Create Line Item Request"),
61006
61172
  id: string2().describe("Subscription ID")
61007
61173
  });
61008
61174
  CreateSubscriptionLineItemResponse$zodSchema = union([
@@ -61143,7 +61309,7 @@ var init_deletesubscriptionlineitemop = __esm(() => {
61143
61309
  init_dtosubscriptionlineitemresponse();
61144
61310
  init_errorserrorresponse();
61145
61311
  DeleteSubscriptionLineItemRequest$zodSchema = object({
61146
- body: DtoDeleteSubscriptionLineItemRequest$zodSchema,
61312
+ body: DtoDeleteSubscriptionLineItemRequest$zodSchema.describe("Delete Line Item Request"),
61147
61313
  id: string2().describe("Line Item ID")
61148
61314
  });
61149
61315
  DeleteSubscriptionLineItemResponse$zodSchema = union([
@@ -61272,17 +61438,17 @@ var DtoProrationDetails$zodSchema;
61272
61438
  var init_dtoprorationdetails = __esm(() => {
61273
61439
  init_zod();
61274
61440
  DtoProrationDetails$zodSchema = object({
61275
- charge_amount: string2().optional(),
61276
- charge_description: string2().optional(),
61277
- credit_amount: string2().optional(),
61278
- credit_description: string2().optional(),
61279
- currency: string2().optional(),
61280
- current_period_end: string2().optional(),
61281
- current_period_start: string2().optional(),
61282
- days_remaining: int().optional(),
61283
- days_used: int().optional(),
61284
- net_amount: string2().optional(),
61285
- proration_date: string2().optional()
61441
+ charge_amount: string2().optional().describe("charge_amount is the charge amount for the new subscription"),
61442
+ charge_description: string2().optional().describe("charge_description describes what the charge is for"),
61443
+ credit_amount: string2().optional().describe("credit_amount is the credit amount from the old subscription"),
61444
+ credit_description: string2().optional().describe("credit_description describes what the credit is for"),
61445
+ currency: string2().optional().describe("currency is the currency for all amounts"),
61446
+ current_period_end: string2().optional().describe("current_period_end is the end of the current billing period"),
61447
+ current_period_start: string2().optional().describe("current_period_start is the start of the current billing period"),
61448
+ days_remaining: int().optional().describe("days_remaining is the number of days remaining in the current period"),
61449
+ days_used: int().optional().describe("days_used is the number of days used in the current period"),
61450
+ net_amount: string2().optional().describe("net_amount is the net amount (charge - credit)"),
61451
+ proration_date: string2().optional().describe("proration_date is the date used for proration calculations")
61286
61452
  });
61287
61453
  });
61288
61454
 
@@ -61292,13 +61458,13 @@ var init_dtosubscriptionsummary = __esm(() => {
61292
61458
  init_zod();
61293
61459
  init_subscriptionstatus();
61294
61460
  DtoSubscriptionSummary$zodSchema = object({
61295
- archived_at: string2().optional(),
61296
- billing_anchor: string2().optional(),
61297
- created_at: string2().optional(),
61298
- current_period_end: string2().optional(),
61299
- current_period_start: string2().optional(),
61300
- id: string2().optional(),
61301
- plan_id: string2().optional(),
61461
+ archived_at: string2().optional().describe("archived_at timestamp (for old subscriptions)"),
61462
+ billing_anchor: string2().optional().describe("billing_anchor of the subscription"),
61463
+ created_at: string2().optional().describe("created_at timestamp"),
61464
+ current_period_end: string2().optional().describe("current_period_end of the subscription"),
61465
+ current_period_start: string2().optional().describe("current_period_start of the subscription"),
61466
+ id: string2().optional().describe("id of the subscription"),
61467
+ plan_id: string2().optional().describe("plan_id of the subscription"),
61302
61468
  status: SubscriptionStatus$zodSchema.optional()
61303
61469
  });
61304
61470
  });
@@ -61325,16 +61491,16 @@ var init_dtosubscriptionchangeexecuteresponse = __esm(() => {
61325
61491
  init_subscriptionchangetype();
61326
61492
  DtoSubscriptionChangeExecuteResponse$zodSchema = object({
61327
61493
  change_type: SubscriptionChangeType$zodSchema.optional(),
61328
- credit_grants: array(DtoCreditGrantResponse$zodSchema).optional(),
61329
- effective_date: string2().optional(),
61494
+ credit_grants: array(DtoCreditGrantResponse$zodSchema).optional().describe("credit_grants contains any credit grants created for proration credits"),
61495
+ effective_date: string2().optional().describe("effective_date is when the change took effect"),
61330
61496
  invoice: DtoInvoiceResponse$zodSchema.optional(),
61331
- is_scheduled: boolean2().optional(),
61332
- metadata: record(string2(), string2()).optional(),
61497
+ is_scheduled: boolean2().optional().describe("is_scheduled indicates if the change was scheduled or executed immediately"),
61498
+ metadata: record(string2(), string2()).optional().describe("metadata from the request"),
61333
61499
  new_subscription: DtoSubscriptionSummary$zodSchema.optional(),
61334
61500
  old_subscription: DtoSubscriptionSummary$zodSchema.optional(),
61335
61501
  proration_applied: DtoProrationDetails$zodSchema.optional(),
61336
- schedule_id: string2().optional(),
61337
- scheduled_at: string2().optional()
61502
+ schedule_id: string2().optional().describe("schedule_id is the ID of the created schedule (only if is_scheduled=true)"),
61503
+ scheduled_at: string2().optional().describe("scheduled_at is when the change will execute (only if is_scheduled=true)")
61338
61504
  }).describe("Response after successfully executing a subscription plan change");
61339
61505
  });
61340
61506
 
@@ -61361,11 +61527,11 @@ var init_dtosubscriptionchangerequest = __esm(() => {
61361
61527
  billing_cadence: BillingCadence$zodSchema,
61362
61528
  billing_cycle: BillingCycle$zodSchema,
61363
61529
  billing_period: BillingPeriod$zodSchema,
61364
- billing_period_count: int().optional(),
61530
+ billing_period_count: int().optional().describe("billing_period_count is the billing period count for the new subscription"),
61365
61531
  change_at: ScheduleType$zodSchema.optional(),
61366
- metadata: record(string2(), string2()).optional(),
61532
+ metadata: record(string2(), string2()).optional().describe("metadata contains additional key-value pairs for storing extra information"),
61367
61533
  proration_behavior: ProrationBehavior$zodSchema,
61368
- target_plan_id: string2()
61534
+ target_plan_id: string2().describe("target_plan_id is the ID of the new plan to change to (required)")
61369
61535
  }).describe("Request object for changing a subscription plan (upgrade/downgrade)");
61370
61536
  });
61371
61537
 
@@ -61377,7 +61543,7 @@ var init_executesubscriptionchangeop = __esm(() => {
61377
61543
  init_dtosubscriptionchangerequest();
61378
61544
  init_errorserrorresponse();
61379
61545
  ExecuteSubscriptionChangeRequest$zodSchema = object({
61380
- body: DtoSubscriptionChangeRequest$zodSchema,
61546
+ body: DtoSubscriptionChangeRequest$zodSchema.describe("Subscription change request"),
61381
61547
  id: string2().describe("Subscription ID")
61382
61548
  });
61383
61549
  ExecuteSubscriptionChangeResponse$zodSchema = union([
@@ -62303,7 +62469,7 @@ var init_subscriptionsGetSubscriptionUsage2 = __esm(() => {
62303
62469
  init_dtogetusagebysubscriptionrequest();
62304
62470
  init_tools();
62305
62471
  args58 = {
62306
- request: DtoGetUsageBySubscriptionRequest$zodSchema
62472
+ request: DtoGetUsageBySubscriptionRequest$zodSchema.describe(`Usage request`)
62307
62473
  };
62308
62474
  tool$subscriptionsGetSubscriptionUsage = {
62309
62475
  name: "get-subscription-usage",
@@ -62352,56 +62518,63 @@ var init_dtosubscriptionresponsev2 = __esm(() => {
62352
62518
  init_subscriptionstatus();
62353
62519
  init_subscriptionsubscriptionpause();
62354
62520
  DtoSubscriptionResponseV2$zodSchema = object({
62355
- active_pause_id: string2().optional(),
62356
- billing_anchor: string2().optional(),
62521
+ active_pause_id: string2().optional().describe(`ActivePauseID references the current active pause configuration
62522
+ This will be null if no pause is active or scheduled`),
62523
+ billing_anchor: string2().optional().describe(`BillingAnchor is the reference point that aligns future billing cycle dates.
62524
+ It sets the day of week for week intervals, the day of month for month and year intervals,
62525
+ and the month of year for year intervals. The timestamp is in UTC format.`),
62357
62526
  billing_cadence: BillingCadence$zodSchema.optional(),
62358
62527
  billing_cycle: BillingCycle$zodSchema.optional(),
62359
62528
  billing_period: BillingPeriod$zodSchema.optional(),
62360
- billing_period_count: int().optional(),
62361
- cancel_at: string2().optional(),
62362
- cancel_at_period_end: boolean2().optional(),
62363
- cancelled_at: string2().optional(),
62364
- collection_method: string2().optional(),
62365
- commitment_amount: string2().optional(),
62529
+ billing_period_count: int().optional().describe("BillingPeriodCount is the total number units of the billing period."),
62530
+ cancel_at: string2().optional().describe("CancelAt is the date the subscription will be canceled"),
62531
+ cancel_at_period_end: boolean2().optional().describe("CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period"),
62532
+ cancelled_at: string2().optional().describe("CanceledAt is the date the subscription was canceled"),
62533
+ collection_method: string2().optional().describe("CollectionMethod determines how invoices are collected"),
62534
+ commitment_amount: string2().optional().describe("CommitmentAmount is the minimum amount a customer commits to paying for a billing period"),
62366
62535
  commitment_duration: BillingPeriod$zodSchema.optional(),
62367
- coupon_associations: array(DtoCouponAssociationResponse$zodSchema).optional(),
62536
+ coupon_associations: array(DtoCouponAssociationResponse$zodSchema).optional().describe('CouponAssociations are included when "coupon_associations" is in expand parameter'),
62368
62537
  created_at: string2().optional(),
62369
62538
  created_by: string2().optional(),
62370
- credit_grants: array(DtoCreditGrantResponse$zodSchema).optional(),
62371
- currency: string2().optional(),
62372
- current_period_end: string2().optional(),
62373
- current_period_start: string2().optional(),
62374
- customer: DtoCustomerResponse$zodSchema.optional(),
62375
- customer_id: string2().optional(),
62539
+ credit_grants: array(DtoCreditGrantResponse$zodSchema).optional().describe('CreditGrants are included when "credit_grants" is in expand parameter'),
62540
+ currency: string2().optional().describe("Currency is the currency of the subscription in lowercase 3 digit ISO codes"),
62541
+ current_period_end: string2().optional().describe(`CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for.
62542
+ At the end of this period, a new invoice will be created.`),
62543
+ current_period_start: string2().optional().describe(`CurrentPeriodStart is the end of the current period that the subscription has been invoiced for.
62544
+ At the end of this period, a new invoice will be created.`),
62545
+ customer: DtoCustomerResponse$zodSchema.optional().describe("Customer response object containing all customer information"),
62546
+ customer_id: string2().optional().describe("CustomerID is the identifier for the customer in our system"),
62376
62547
  customer_timezone: string2().optional(),
62377
62548
  enable_true_up: boolean2().optional(),
62378
- end_date: string2().optional(),
62379
- environment_id: string2().optional(),
62380
- gateway_payment_method_id: string2().optional(),
62381
- id: string2().optional(),
62382
- invoicing_customer_id: string2().optional(),
62383
- line_items: array(DtoSubscriptionLineItemResponse$zodSchema).optional(),
62384
- lookup_key: string2().optional(),
62549
+ end_date: string2().optional().describe("EndDate is the end date of the subscription"),
62550
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the subscription"),
62551
+ gateway_payment_method_id: string2().optional().describe("GatewayPaymentMethodID is the gateway payment method ID for this subscription"),
62552
+ id: string2().optional().describe("ID is the unique identifier for the subscription"),
62553
+ invoicing_customer_id: string2().optional().describe(`InvoicingCustomerID is the customer ID to use for invoicing
62554
+ This can differ from the subscription customer (e.g., parent company invoicing for child company)`),
62555
+ line_items: array(DtoSubscriptionLineItemResponse$zodSchema).optional().describe(`LineItems is expanded only if "subscription_line_items" is in expand parameter
62556
+ Each line item can optionally include expanded price data`),
62557
+ lookup_key: string2().optional().describe("LookupKey is the key used to lookup the subscription in our system"),
62385
62558
  metadata: record(string2(), string2()).optional(),
62386
- overage_factor: string2().optional(),
62387
- parent_subscription_id: string2().optional(),
62559
+ overage_factor: string2().optional().describe("OverageFactor is a multiplier applied to usage beyond the commitment amount"),
62560
+ parent_subscription_id: string2().optional().describe("ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)"),
62388
62561
  pause_status: PauseStatus$zodSchema.optional(),
62389
- pauses: array(SubscriptionSubscriptionPause$zodSchema).optional(),
62390
- payment_behavior: string2().optional(),
62562
+ pauses: array(SubscriptionSubscriptionPause$zodSchema).optional().describe("Pauses are included when subscription has pause status"),
62563
+ payment_behavior: string2().optional().describe("PaymentBehavior determines how subscription payments are handled"),
62391
62564
  payment_terms: PaymentTerms$zodSchema.optional(),
62392
- phases: array(DtoSubscriptionPhaseResponse$zodSchema).optional(),
62565
+ phases: array(DtoSubscriptionPhaseResponse$zodSchema).optional().describe('Phases are included when "phases" is in expand parameter'),
62393
62566
  plan: DtoPlanResponse$zodSchema.optional(),
62394
- plan_id: string2().optional(),
62567
+ plan_id: string2().optional().describe("PlanID is the identifier for the plan in our system"),
62395
62568
  proration_behavior: ProrationBehavior$zodSchema.optional(),
62396
- start_date: string2().optional(),
62569
+ start_date: string2().optional().describe("StartDate is the start date of the subscription"),
62397
62570
  status: Status$zodSchema.optional(),
62398
62571
  subscription_status: SubscriptionStatus$zodSchema.optional(),
62399
62572
  tenant_id: string2().optional(),
62400
- trial_end: string2().optional(),
62401
- trial_start: string2().optional(),
62573
+ trial_end: string2().optional().describe("TrialEnd is the end date of the trial period"),
62574
+ trial_start: string2().optional().describe("TrialStart is the start date of the trial period"),
62402
62575
  updated_at: string2().optional(),
62403
62576
  updated_by: string2().optional(),
62404
- version: int().optional()
62577
+ version: int().optional().describe("Version is used for optimistic locking")
62405
62578
  });
62406
62579
  });
62407
62580
 
@@ -62677,20 +62850,20 @@ var init_dtosubscriptionpauseresponse = __esm(() => {
62677
62850
  DtoSubscriptionPauseResponse$zodSchema = object({
62678
62851
  created_at: string2().optional(),
62679
62852
  created_by: string2().optional(),
62680
- environment_id: string2().optional(),
62681
- id: string2().optional(),
62853
+ environment_id: string2().optional().describe("EnvironmentID is the environment identifier for the pause"),
62854
+ id: string2().optional().describe("ID is the unique identifier for the subscription pause"),
62682
62855
  metadata: record(string2(), string2()).optional(),
62683
- original_period_end: string2().optional(),
62684
- original_period_start: string2().optional(),
62685
- pause_end: string2().optional(),
62856
+ original_period_end: string2().optional().describe("OriginalPeriodEnd is the end of the billing period when the pause was created"),
62857
+ original_period_start: string2().optional().describe("OriginalPeriodStart is the start of the billing period when the pause was created"),
62858
+ pause_end: string2().optional().describe("PauseEnd is when the pause will end (null for indefinite)"),
62686
62859
  pause_mode: PauseMode$zodSchema.optional(),
62687
- pause_start: string2().optional(),
62860
+ pause_start: string2().optional().describe("PauseStart is when the pause actually started"),
62688
62861
  pause_status: PauseStatus$zodSchema.optional(),
62689
- reason: string2().optional(),
62862
+ reason: string2().optional().describe("Reason is the reason for pausing"),
62690
62863
  resume_mode: ResumeMode$zodSchema.optional(),
62691
- resumed_at: string2().optional(),
62864
+ resumed_at: string2().optional().describe("ResumedAt is when the pause was actually ended (if manually resumed)"),
62692
62865
  status: Status$zodSchema.optional(),
62693
- subscription_id: string2().optional(),
62866
+ subscription_id: string2().optional().describe("SubscriptionID is the identifier for the subscription"),
62694
62867
  tenant_id: string2().optional(),
62695
62868
  updated_at: string2().optional(),
62696
62869
  updated_by: string2().optional()
@@ -62703,8 +62876,10 @@ var init_dtolistsubscriptionpausesresponse = __esm(() => {
62703
62876
  init_zod();
62704
62877
  init_dtosubscriptionpauseresponse();
62705
62878
  DtoListSubscriptionPausesResponse$zodSchema = object({
62706
- items: array(DtoSubscriptionPauseResponse$zodSchema).optional(),
62707
- total: int().optional()
62879
+ items: array(DtoSubscriptionPauseResponse$zodSchema).optional().describe(`List of subscription pause objects
62880
+ @Description Array of subscription pauses`),
62881
+ total: int().optional().describe(`Total number of pauses
62882
+ @Description Total count of subscription pauses in the response`)
62708
62883
  }).describe("Response object for listing subscription pauses with total count");
62709
62884
  });
62710
62885
 
@@ -62966,13 +63141,25 @@ var init_dtopausesubscriptionrequest = __esm(() => {
62966
63141
  init_zod();
62967
63142
  init_pausemode();
62968
63143
  DtoPauseSubscriptionRequest$zodSchema = object({
62969
- dry_run: boolean2().optional(),
62970
- metadata: record(string2(), string2()).optional(),
62971
- pause_days: int().optional(),
62972
- pause_end: string2().optional(),
63144
+ dry_run: boolean2().optional().describe(`Whether to perform a dry run
63145
+ @Description If true, validates the request and shows impact without actually pausing the subscription
63146
+ @Example false`),
63147
+ metadata: record(string2(), string2()).optional().describe(`Additional metadata as key-value pairs
63148
+ @Description Optional metadata for storing additional information about the pause
63149
+ @Example {"requested_by": "customer", "channel": "support_ticket"}`),
63150
+ pause_days: int().optional().describe(`Duration of the pause in days
63151
+ @Description Number of days to pause the subscription. Cannot be used together with pause_end. Must be greater than 0
63152
+ @Example 30`),
63153
+ pause_end: string2().optional().describe(`End date for the subscription pause
63154
+ @Description ISO 8601 timestamp when the pause should end. Cannot be used together with pause_days. Must be after pause_start
63155
+ @Example "2024-02-15T00:00:00Z"`),
62973
63156
  pause_mode: PauseMode$zodSchema,
62974
- pause_start: string2().optional(),
62975
- reason: string2().optional()
63157
+ pause_start: string2().optional().describe(`Start date for the subscription pause
63158
+ @Description ISO 8601 timestamp when the pause should begin. Required when pause_mode is "scheduled"
63159
+ @Example "2024-01-15T00:00:00Z"`),
63160
+ reason: string2().optional().describe(`Reason for pausing the subscription
63161
+ @Description Optional reason for the pause. Maximum 255 characters
63162
+ @Example "Customer requested temporary suspension"`)
62976
63163
  }).describe("Request object for pausing an active subscription with various pause modes and options");
62977
63164
  });
62978
63165
 
@@ -62984,7 +63171,7 @@ var init_pausesubscriptionop = __esm(() => {
62984
63171
  init_dtosubscriptionpauseresponse();
62985
63172
  init_errorserrorresponse();
62986
63173
  PauseSubscriptionRequest$zodSchema = object({
62987
- body: DtoPauseSubscriptionRequest$zodSchema,
63174
+ body: DtoPauseSubscriptionRequest$zodSchema.describe("Pause subscription request"),
62988
63175
  id: string2().describe("Subscription ID")
62989
63176
  });
62990
63177
  PauseSubscriptionResponse$zodSchema = union([
@@ -63115,12 +63302,12 @@ var init_dtobillingcycleinfo = __esm(() => {
63115
63302
  init_billingcadence();
63116
63303
  init_billingperiod();
63117
63304
  DtoBillingCycleInfo$zodSchema = object({
63118
- billing_anchor: string2().optional(),
63305
+ billing_anchor: string2().optional().describe("billing_anchor is the new billing anchor"),
63119
63306
  billing_cadence: BillingCadence$zodSchema.optional(),
63120
63307
  billing_period: BillingPeriod$zodSchema.optional(),
63121
- billing_period_count: int().optional(),
63122
- period_end: string2().optional(),
63123
- period_start: string2().optional()
63308
+ billing_period_count: int().optional().describe("billing_period_count is the billing period count"),
63309
+ period_end: string2().optional().describe("period_end is the end of the new billing period"),
63310
+ period_start: string2().optional().describe("period_start is the start of the new billing period")
63124
63311
  });
63125
63312
  });
63126
63313
 
@@ -63129,13 +63316,13 @@ var DtoInvoiceLineItemPreview$zodSchema;
63129
63316
  var init_dtoinvoicelineitempreview = __esm(() => {
63130
63317
  init_zod();
63131
63318
  DtoInvoiceLineItemPreview$zodSchema = object({
63132
- amount: string2().optional(),
63133
- description: string2().optional(),
63134
- is_proration: boolean2().optional(),
63135
- period_end: string2().optional(),
63136
- period_start: string2().optional(),
63137
- quantity: string2().optional(),
63138
- unit_price: string2().optional()
63319
+ amount: string2().optional().describe("amount for this line item"),
63320
+ description: string2().optional().describe("description of the line item"),
63321
+ is_proration: boolean2().optional().describe("is_proration indicates if this line item is a proration"),
63322
+ period_end: string2().optional().describe("period_end for this line item (if applicable)"),
63323
+ period_start: string2().optional().describe("period_start for this line item (if applicable)"),
63324
+ quantity: string2().optional().describe("quantity for this line item"),
63325
+ unit_price: string2().optional().describe("unit_price for this line item")
63139
63326
  });
63140
63327
  });
63141
63328
 
@@ -63145,12 +63332,12 @@ var init_dtoinvoicepreview = __esm(() => {
63145
63332
  init_zod();
63146
63333
  init_dtoinvoicelineitempreview();
63147
63334
  DtoInvoicePreview$zodSchema = object({
63148
- currency: string2().optional(),
63149
- due_date: string2().optional(),
63150
- line_items: array(DtoInvoiceLineItemPreview$zodSchema).optional(),
63151
- subtotal: string2().optional(),
63152
- tax_amount: string2().optional(),
63153
- total: string2().optional()
63335
+ currency: string2().optional().describe("currency is the currency for all amounts"),
63336
+ due_date: string2().optional().describe("due_date is when the invoice would be due"),
63337
+ line_items: array(DtoInvoiceLineItemPreview$zodSchema).optional().describe("line_items contains preview of line items"),
63338
+ subtotal: string2().optional().describe("subtotal is the subtotal amount before taxes"),
63339
+ tax_amount: string2().optional().describe("tax_amount is the total tax amount"),
63340
+ total: string2().optional().describe("total is the total amount including taxes")
63154
63341
  });
63155
63342
  });
63156
63343
 
@@ -63159,10 +63346,10 @@ var DtoPlanSummary$zodSchema;
63159
63346
  var init_dtoplansummary = __esm(() => {
63160
63347
  init_zod();
63161
63348
  DtoPlanSummary$zodSchema = object({
63162
- description: string2().optional(),
63163
- id: string2().optional(),
63164
- lookup_key: string2().optional(),
63165
- name: string2().optional()
63349
+ description: string2().optional().describe("description of the plan"),
63350
+ id: string2().optional().describe("id of the plan"),
63351
+ lookup_key: string2().optional().describe("lookup_key of the plan"),
63352
+ name: string2().optional().describe("name of the plan")
63166
63353
  });
63167
63354
  });
63168
63355
 
@@ -63178,14 +63365,14 @@ var init_dtosubscriptionchangepreviewresponse = __esm(() => {
63178
63365
  DtoSubscriptionChangePreviewResponse$zodSchema = object({
63179
63366
  change_type: SubscriptionChangeType$zodSchema.optional(),
63180
63367
  current_plan: DtoPlanSummary$zodSchema.optional(),
63181
- effective_date: string2().optional(),
63182
- metadata: record(string2(), string2()).optional(),
63368
+ effective_date: string2().optional().describe("effective_date is when the change would take effect"),
63369
+ metadata: record(string2(), string2()).optional().describe("metadata from the request"),
63183
63370
  new_billing_cycle: DtoBillingCycleInfo$zodSchema.optional(),
63184
63371
  next_invoice_preview: DtoInvoicePreview$zodSchema.optional(),
63185
63372
  proration_details: DtoProrationDetails$zodSchema.optional(),
63186
- subscription_id: string2().optional(),
63373
+ subscription_id: string2().optional().describe("subscription_id is the ID of the subscription being changed"),
63187
63374
  target_plan: DtoPlanSummary$zodSchema.optional(),
63188
- warnings: array(string2()).optional()
63375
+ warnings: array(string2()).optional().describe("warnings contains any warnings about the change")
63189
63376
  }).describe("Response showing the financial impact of a subscription plan change");
63190
63377
  });
63191
63378
 
@@ -63197,7 +63384,7 @@ var init_previewsubscriptionchangeop = __esm(() => {
63197
63384
  init_dtosubscriptionchangerequest();
63198
63385
  init_errorserrorresponse();
63199
63386
  PreviewSubscriptionChangeRequest$zodSchema = object({
63200
- body: DtoSubscriptionChangeRequest$zodSchema,
63387
+ body: DtoSubscriptionChangeRequest$zodSchema.describe("Subscription change preview request"),
63201
63388
  id: string2().describe("Subscription ID")
63202
63389
  });
63203
63390
  PreviewSubscriptionChangeResponse$zodSchema = union([
@@ -63336,26 +63523,26 @@ var init_subscriptionfilter = __esm(() => {
63336
63523
  "desc"
63337
63524
  ]);
63338
63525
  SubscriptionFilter$zodSchema = object({
63339
- active_at: string2().optional(),
63340
- billing_cadence: array(BillingCadence$zodSchema).optional(),
63341
- billing_period: array(BillingPeriod$zodSchema).optional(),
63342
- customer_id: string2().optional(),
63526
+ active_at: string2().optional().describe("ActiveAt filters subscriptions that are active at the given time"),
63527
+ billing_cadence: array(BillingCadence$zodSchema).optional().describe("BillingCadence filters by billing cadence"),
63528
+ billing_period: array(BillingPeriod$zodSchema).optional().describe("BillingPeriod filters by billing period"),
63529
+ customer_id: string2().optional().describe("CustomerID filters by customer ID"),
63343
63530
  end_time: string2().optional(),
63344
63531
  expand: string2().optional(),
63345
- external_customer_id: string2().optional(),
63532
+ external_customer_id: string2().optional().describe("ExternalCustomerID filters by external customer ID"),
63346
63533
  filters: array(FilterCondition$zodSchema).optional(),
63347
- invoicing_customer_ids: array(string2()).optional(),
63534
+ invoicing_customer_ids: array(string2()).optional().describe("InvoicingCustomerIDs filters by invoicing customer ID"),
63348
63535
  limit: int().optional(),
63349
63536
  offset: int().optional(),
63350
63537
  order: SubscriptionFilterOrder$zodSchema.optional(),
63351
- parent_subscription_ids: array(string2()).optional(),
63352
- plan_id: string2().optional(),
63538
+ parent_subscription_ids: array(string2()).optional().describe("ParentSubscriptionIDs filters by parent subscription IDs"),
63539
+ plan_id: string2().optional().describe("PlanID filters by plan ID"),
63353
63540
  sort: array(SortCondition$zodSchema).optional(),
63354
63541
  start_time: string2().optional(),
63355
63542
  status: Status$zodSchema.optional(),
63356
63543
  subscription_ids: array(string2()).optional(),
63357
- subscription_status: array(SubscriptionStatus$zodSchema).optional(),
63358
- with_line_items: boolean2().optional()
63544
+ subscription_status: array(SubscriptionStatus$zodSchema).optional().describe("SubscriptionStatus filters by subscription status"),
63545
+ with_line_items: boolean2().optional().describe("WithLineItems includes line items in the response")
63359
63546
  });
63360
63547
  });
63361
63548
 
@@ -63439,7 +63626,7 @@ var init_subscriptionsQuerySubscription2 = __esm(() => {
63439
63626
  init_subscriptionfilter();
63440
63627
  init_tools();
63441
63628
  args65 = {
63442
- request: SubscriptionFilter$zodSchema
63629
+ request: SubscriptionFilter$zodSchema.describe(`Filter`)
63443
63630
  };
63444
63631
  tool$subscriptionsQuerySubscription = {
63445
63632
  name: "query-subscription",
@@ -63558,7 +63745,7 @@ var init_subscriptionsRemoveSubscriptionAddon2 = __esm(() => {
63558
63745
  init_dtoremoveaddonrequest();
63559
63746
  init_tools();
63560
63747
  args66 = {
63561
- request: DtoRemoveAddonRequest$zodSchema
63748
+ request: DtoRemoveAddonRequest$zodSchema.describe(`Remove Addon Request`)
63562
63749
  };
63563
63750
  tool$subscriptionsRemoveSubscriptionAddon = {
63564
63751
  name: "remove-subscription-addon",
@@ -63593,8 +63780,12 @@ var init_dtoresumesubscriptionrequest = __esm(() => {
63593
63780
  init_zod();
63594
63781
  init_resumemode();
63595
63782
  DtoResumeSubscriptionRequest$zodSchema = object({
63596
- dry_run: boolean2().optional(),
63597
- metadata: record(string2(), string2()).optional(),
63783
+ dry_run: boolean2().optional().describe(`Whether to perform a dry run
63784
+ @Description If true, validates the request and shows impact without actually resuming the subscription
63785
+ @Example false`),
63786
+ metadata: record(string2(), string2()).optional().describe(`Additional metadata as key-value pairs
63787
+ @Description Optional metadata for storing additional information about the resume operation
63788
+ @Example {"resumed_by": "admin", "reason": "issue_resolved"}`),
63598
63789
  resume_mode: ResumeMode$zodSchema
63599
63790
  }).describe("Request object for resuming a paused subscription");
63600
63791
  });
@@ -63607,7 +63798,7 @@ var init_resumesubscriptionop = __esm(() => {
63607
63798
  init_dtosubscriptionpauseresponse();
63608
63799
  init_errorserrorresponse();
63609
63800
  ResumeSubscriptionRequest$zodSchema = object({
63610
- body: DtoResumeSubscriptionRequest$zodSchema,
63801
+ body: DtoResumeSubscriptionRequest$zodSchema.describe("Resume subscription request"),
63611
63802
  id: string2().describe("Subscription ID")
63612
63803
  });
63613
63804
  ResumeSubscriptionResponse$zodSchema = union([
@@ -63739,7 +63930,7 @@ var init_dtoupdatesubscriptionrequest = __esm(() => {
63739
63930
  DtoUpdateSubscriptionRequest$zodSchema = object({
63740
63931
  cancel_at: string2().optional(),
63741
63932
  cancel_at_period_end: boolean2().optional(),
63742
- parent_subscription_id: string2().optional(),
63933
+ parent_subscription_id: string2().optional().describe('ParentSubscriptionID sets or clears the parent subscription. Omit to leave unchanged; send "" to clear.'),
63743
63934
  status: SubscriptionStatus$zodSchema.optional()
63744
63935
  });
63745
63936
  });
@@ -63752,7 +63943,7 @@ var init_updatesubscriptionop = __esm(() => {
63752
63943
  init_dtoupdatesubscriptionrequest();
63753
63944
  init_errorserrorresponse();
63754
63945
  UpdateSubscriptionRequest$zodSchema = object({
63755
- body: DtoUpdateSubscriptionRequest$zodSchema,
63946
+ body: DtoUpdateSubscriptionRequest$zodSchema.describe("Update Subscription Request"),
63756
63947
  id: string2().describe("Subscription ID")
63757
63948
  });
63758
63949
  UpdateSubscriptionResponse$zodSchema = union([
@@ -63887,19 +64078,19 @@ var init_dtoupdatesubscriptionlineitemrequest = __esm(() => {
63887
64078
  init_dtocreatepricetier();
63888
64079
  init_pricetransformquantity();
63889
64080
  DtoUpdateSubscriptionLineItemRequest$zodSchema = object({
63890
- amount: string2().optional(),
64081
+ amount: string2().optional().describe("Amount is the new price amount that overrides the original price"),
63891
64082
  billing_model: BillingModel$zodSchema.optional(),
63892
- commitment_amount: number2().optional(),
64083
+ commitment_amount: number2().optional().describe("Commitment fields"),
63893
64084
  commitment_duration: BillingPeriod$zodSchema.optional(),
63894
64085
  commitment_overage_factor: number2().optional(),
63895
64086
  commitment_quantity: number2().optional(),
63896
64087
  commitment_true_up_enabled: boolean2().optional(),
63897
64088
  commitment_type: CommitmentType$zodSchema.optional(),
63898
64089
  commitment_windowed: boolean2().optional(),
63899
- effective_from: string2().optional(),
63900
- metadata: record(string2(), string2()).optional(),
64090
+ effective_from: string2().optional().describe("EffectiveFrom for the existing line item (if not provided, defaults to now)"),
64091
+ metadata: record(string2(), string2()).optional().describe("Metadata for the new line item"),
63901
64092
  tier_mode: BillingTier$zodSchema.optional(),
63902
- tiers: array(DtoCreatePriceTier$zodSchema).optional(),
64093
+ tiers: array(DtoCreatePriceTier$zodSchema).optional().describe("Tiers determines the pricing tiers for this line item"),
63903
64094
  transform_quantity: PriceTransformQuantity$zodSchema.optional()
63904
64095
  });
63905
64096
  });
@@ -63912,7 +64103,7 @@ var init_updatesubscriptionlineitemop = __esm(() => {
63912
64103
  init_dtoupdatesubscriptionlineitemrequest();
63913
64104
  init_errorserrorresponse();
63914
64105
  UpdateSubscriptionLineItemRequest$zodSchema = object({
63915
- body: DtoUpdateSubscriptionLineItemRequest$zodSchema,
64106
+ body: DtoUpdateSubscriptionLineItemRequest$zodSchema.describe("Update Line Item Request"),
63916
64107
  id: string2().describe("Line Item ID")
63917
64108
  });
63918
64109
  UpdateSubscriptionLineItemResponse$zodSchema = union([
@@ -64040,7 +64231,7 @@ Use when changing a subscription line item (e.g. quantity or price). Implemented
64040
64231
  function createMCPServer(deps) {
64041
64232
  const server = new McpServer({
64042
64233
  name: "Flexprice",
64043
- version: "2.0.10"
64234
+ version: "2.0.12"
64044
64235
  });
64045
64236
  const getClient = deps.getSDK || (() => new FlexpriceCore({
64046
64237
  security: deps.security,
@@ -64054,7 +64245,7 @@ function createMCPServer(deps) {
64054
64245
  }));
64055
64246
  const scopes = new Set(deps.scopes);
64056
64247
  const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
64057
- const [tool, tools, toolMap] = createRegisterTool(deps.logger, server, getClient, scopes, allowedTools, deps.dynamic);
64248
+ const [tool, tools, toolMap] = createRegisterTool(deps.logger, server, getClient, scopes, allowedTools, deps.dynamic, deps.annotationFilter);
64058
64249
  const resource = createRegisterResource(deps.logger, server, getClient, scopes);
64059
64250
  const resourceTemplate = createRegisterResourceTemplate(deps.logger, server, getClient, scopes);
64060
64251
  const prompt = createRegisterPrompt(deps.logger, server, getClient, scopes);
@@ -65726,6 +65917,7 @@ async function startStreamableHTTP(cliFlags) {
65726
65917
  logger,
65727
65918
  allowedTools: cliFlags.tool,
65728
65919
  dynamic: cliFlags.mode === "dynamic",
65920
+ annotationFilter: buildAnnotationFilter(cliFlags["tool-annotations"]),
65729
65921
  scopes: cliFlags.scope,
65730
65922
  serverURL: cliFlags["server-url"],
65731
65923
  getSDK: () => buildSDK(headers, cliFlags, cliFlags["disable-static-auth"], logger),
@@ -65767,6 +65959,7 @@ var init_impl = __esm(() => {
65767
65959
  init_console_logger();
65768
65960
  init_server2();
65769
65961
  init_tools();
65962
+ init_tools();
65770
65963
  init_landing_page();
65771
65964
  import_express = __toESM(require_express(), 1);
65772
65965
  });
@@ -66018,6 +66211,7 @@ async function startStdio(flags) {
66018
66211
  logger,
66019
66212
  allowedTools: flags.tool,
66020
66213
  dynamic: flags.mode === "dynamic",
66214
+ annotationFilter: buildAnnotationFilter(flags["tool-annotations"]),
66021
66215
  scopes: flags.scope,
66022
66216
  security: { ApiKeyAuth: flags["api-key-auth"] ?? "" },
66023
66217
  serverURL: flags["server-url"],
@@ -66057,6 +66251,7 @@ async function startSSE(cliFlags) {
66057
66251
  logger,
66058
66252
  allowedTools: flags.tool,
66059
66253
  dynamic: flags.mode === "dynamic",
66254
+ annotationFilter: buildAnnotationFilter(flags["tool-annotations"]),
66060
66255
  scopes: flags.scope,
66061
66256
  security: { ApiKeyAuth: flags["api-key-auth"] ?? "" },
66062
66257
  serverURL: flags["server-url"],
@@ -66142,6 +66337,7 @@ var init_impl2 = __esm(() => {
66142
66337
  init_stdio2();
66143
66338
  init_console_logger();
66144
66339
  init_server2();
66340
+ init_tools();
66145
66341
  init_landing_page();
66146
66342
  import_express2 = __toESM(require_express(), 1);
66147
66343
  });
@@ -67987,6 +68183,12 @@ var serveCommand = buildCommand({
67987
68183
  values: ["dynamic"],
67988
68184
  optional: true
67989
68185
  },
68186
+ "tool-annotations": {
68187
+ kind: "parsed",
68188
+ brief: "Filter tools by annotations (comma-separated: readOnly, destructive, idempotent, openWorld). Listed = required true, unlisted = required false.",
68189
+ optional: true,
68190
+ parse: (value) => value.split(",").map((s) => s.trim())
68191
+ },
67990
68192
  scope: {
67991
68193
  kind: "enum",
67992
68194
  brief: "Mount tools/resources that match given scope (repeatable flag)",
@@ -68087,6 +68289,12 @@ var startCommand = buildCommand({
68087
68289
  values: ["dynamic"],
68088
68290
  optional: true
68089
68291
  },
68292
+ "tool-annotations": {
68293
+ kind: "parsed",
68294
+ brief: "Filter tools by annotations (comma-separated: readOnly, destructive, idempotent, openWorld). Listed = required true, unlisted = required false.",
68295
+ optional: true,
68296
+ parse: (value) => value.split(",").map((s) => s.trim())
68297
+ },
68090
68298
  scope: {
68091
68299
  kind: "enum",
68092
68300
  brief: "Mount tools/resources that match given scope (repeatable flag)",
@@ -68162,7 +68370,7 @@ var routes = buildRouteMap({
68162
68370
  var app = buildApplication(routes, {
68163
68371
  name: "mcp",
68164
68372
  versionInfo: {
68165
- currentVersion: "2.0.10"
68373
+ currentVersion: "2.0.12"
68166
68374
  }
68167
68375
  });
68168
68376
  run(app, process4.argv.slice(2), buildContext(process4));
@@ -68170,5 +68378,5 @@ export {
68170
68378
  app
68171
68379
  };
68172
68380
 
68173
- //# debugId=9AE395F6C07E14E464756E2164756E21
68381
+ //# debugId=890F6D70DC5AE33C64756E2164756E21
68174
68382
  //# sourceMappingURL=mcp-server.js.map