@flexprice/sdk 2.1.42 → 2.1.44-dev.1

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 (323) hide show
  1. package/docs/sdk/models/active-window.md +16 -0
  2. package/docs/sdk/models/add-addon-ref.md +9 -8
  3. package/docs/sdk/models/addon-price-override-ref.md +17 -0
  4. package/docs/sdk/models/commitment-collection-method.md +17 -0
  5. package/docs/sdk/models/commitment-early-termination.md +17 -0
  6. package/docs/sdk/models/commitment-filter-order.md +15 -0
  7. package/docs/sdk/models/commitment-filter.md +31 -0
  8. package/docs/sdk/models/commitment-measurement.md +17 -0
  9. package/docs/sdk/models/commitment-price-input.md +19 -0
  10. package/docs/sdk/models/commitment-response.md +51 -0
  11. package/docs/sdk/models/commitment-scope-input.md +18 -0
  12. package/docs/sdk/models/commitment-scope-type.md +17 -0
  13. package/docs/sdk/models/commitment-status.md +17 -0
  14. package/docs/sdk/models/commitment-usage-breakdown.md +26 -0
  15. package/docs/sdk/models/commitment-usage-value.md +16 -0
  16. package/docs/sdk/models/create-commitment-request.md +42 -0
  17. package/docs/sdk/models/create-entitlement-request.md +1 -1
  18. package/docs/sdk/models/create-price-tier.md +1 -0
  19. package/docs/sdk/models/create-scheduled-task-request.md +1 -1
  20. package/docs/sdk/models/create-subscription-request.md +1 -0
  21. package/docs/sdk/models/delete-events-request.md +26 -0
  22. package/docs/sdk/models/delete-events-response-response.md +19 -0
  23. package/docs/sdk/models/delete-events-response.md +16 -0
  24. package/docs/sdk/models/get-commitment-request.md +17 -0
  25. package/docs/sdk/models/get-usage-by-subscription-response.md +14 -13
  26. package/docs/sdk/models/invoice-filter.md +2 -0
  27. package/docs/sdk/models/invoice-line-item-response.md +1 -0
  28. package/docs/sdk/models/list-commitments-response.md +16 -0
  29. package/docs/sdk/models/price-price-tier.md +1 -0
  30. package/docs/sdk/models/report-query-request.md +1 -0
  31. package/docs/sdk/models/scheduled-task-entity-type.md +2 -2
  32. package/docs/sdk/models/subscription-line-item-response.md +2 -0
  33. package/docs/sdk/models/subscription-subscription-line-item.md +2 -0
  34. package/docs/sdk/models/terminate-commitment-request-request.md +18 -0
  35. package/docs/sdk/models/terminate-commitment-request.md +16 -0
  36. package/docs/sdk/models/trigger-force-run-request.md +6 -1
  37. package/docs/sdk/models/update-commitment-request-request.md +19 -0
  38. package/docs/sdk/models/update-commitment-request.md +18 -0
  39. package/docs/sdk/models/update-entitlement-request.md +1 -1
  40. package/docs/sdk/models/webhook-dto-commitment-webhook-payload.md +16 -0
  41. package/docs/sdk/models/webhook-event-name.md +1 -1
  42. package/docs/sdks/commitments/README.md +476 -0
  43. package/docs/sdks/events/README.md +86 -0
  44. package/docs/sdks/webhookevents/README.md +207 -0
  45. package/esm/funcs/commitments-create-commitment.d.ts +17 -0
  46. package/esm/funcs/commitments-create-commitment.d.ts.map +1 -0
  47. package/esm/funcs/commitments-create-commitment.js +83 -0
  48. package/esm/funcs/commitments-create-commitment.js.map +1 -0
  49. package/esm/funcs/commitments-get-commitment.d.ts +17 -0
  50. package/esm/funcs/commitments-get-commitment.d.ts.map +1 -0
  51. package/esm/funcs/commitments-get-commitment.js +91 -0
  52. package/esm/funcs/commitments-get-commitment.js.map +1 -0
  53. package/esm/funcs/commitments-preview-commitment.d.ts +17 -0
  54. package/esm/funcs/commitments-preview-commitment.d.ts.map +1 -0
  55. package/esm/funcs/commitments-preview-commitment.js +83 -0
  56. package/esm/funcs/commitments-preview-commitment.js.map +1 -0
  57. package/esm/funcs/commitments-query-commitment.d.ts +17 -0
  58. package/esm/funcs/commitments-query-commitment.d.ts.map +1 -0
  59. package/esm/funcs/commitments-query-commitment.js +83 -0
  60. package/esm/funcs/commitments-query-commitment.js.map +1 -0
  61. package/esm/funcs/commitments-terminate-commitment.d.ts +17 -0
  62. package/esm/funcs/commitments-terminate-commitment.d.ts.map +1 -0
  63. package/esm/funcs/commitments-terminate-commitment.js +93 -0
  64. package/esm/funcs/commitments-terminate-commitment.js.map +1 -0
  65. package/esm/funcs/commitments-update-commitment.d.ts +17 -0
  66. package/esm/funcs/commitments-update-commitment.d.ts.map +1 -0
  67. package/esm/funcs/commitments-update-commitment.js +93 -0
  68. package/esm/funcs/commitments-update-commitment.js.map +1 -0
  69. package/esm/funcs/events-delete-events.d.ts +17 -0
  70. package/esm/funcs/events-delete-events.d.ts.map +1 -0
  71. package/esm/funcs/events-delete-events.js +86 -0
  72. package/esm/funcs/events-delete-events.js.map +1 -0
  73. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.d.ts +17 -0
  74. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.d.ts.map +1 -0
  75. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.js +69 -0
  76. package/esm/funcs/webhook-events-post-webhook-events-commitment-created.js.map +1 -0
  77. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.d.ts +17 -0
  78. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.d.ts.map +1 -0
  79. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.js +69 -0
  80. package/esm/funcs/webhook-events-post-webhook-events-commitment-terminated.js.map +1 -0
  81. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.d.ts +17 -0
  82. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.d.ts.map +1 -0
  83. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.js +69 -0
  84. package/esm/funcs/webhook-events-post-webhook-events-commitment-updated.js.map +1 -0
  85. package/esm/lib/config.d.ts +3 -3
  86. package/esm/lib/config.js +3 -3
  87. package/esm/lib/config.js.map +1 -1
  88. package/esm/sdk/commitments.d.ts +47 -0
  89. package/esm/sdk/commitments.d.ts.map +1 -0
  90. package/esm/sdk/commitments.js +68 -0
  91. package/esm/sdk/commitments.js.map +1 -0
  92. package/esm/sdk/events.d.ts +7 -0
  93. package/esm/sdk/events.d.ts.map +1 -1
  94. package/esm/sdk/events.js +10 -0
  95. package/esm/sdk/events.js.map +1 -1
  96. package/esm/sdk/models/active-window.d.ts +20 -0
  97. package/esm/sdk/models/active-window.d.ts.map +1 -0
  98. package/esm/sdk/models/active-window.js +24 -0
  99. package/esm/sdk/models/active-window.js.map +1 -0
  100. package/esm/sdk/models/add-addon-ref.d.ts +6 -0
  101. package/esm/sdk/models/add-addon-ref.d.ts.map +1 -1
  102. package/esm/sdk/models/add-addon-ref.js +3 -0
  103. package/esm/sdk/models/add-addon-ref.js.map +1 -1
  104. package/esm/sdk/models/addon-price-override-ref.d.ts +16 -0
  105. package/esm/sdk/models/addon-price-override-ref.d.ts.map +1 -0
  106. package/esm/sdk/models/addon-price-override-ref.js +20 -0
  107. package/esm/sdk/models/addon-price-override-ref.js.map +1 -0
  108. package/esm/sdk/models/commitment-collection-method.d.ts +12 -0
  109. package/esm/sdk/models/commitment-collection-method.d.ts.map +1 -0
  110. package/esm/sdk/models/commitment-collection-method.js +13 -0
  111. package/esm/sdk/models/commitment-collection-method.js.map +1 -0
  112. package/esm/sdk/models/commitment-early-termination.d.ts +11 -0
  113. package/esm/sdk/models/commitment-early-termination.d.ts.map +1 -0
  114. package/esm/sdk/models/commitment-early-termination.js +12 -0
  115. package/esm/sdk/models/commitment-early-termination.js.map +1 -0
  116. package/esm/sdk/models/commitment-filter.d.ts +60 -0
  117. package/esm/sdk/models/commitment-filter.d.ts.map +1 -0
  118. package/esm/sdk/models/commitment-filter.js +51 -0
  119. package/esm/sdk/models/commitment-filter.js.map +1 -0
  120. package/esm/sdk/models/commitment-measurement.d.ts +12 -0
  121. package/esm/sdk/models/commitment-measurement.d.ts.map +1 -0
  122. package/esm/sdk/models/commitment-measurement.js +13 -0
  123. package/esm/sdk/models/commitment-measurement.js.map +1 -0
  124. package/esm/sdk/models/commitment-price-input.d.ts +24 -0
  125. package/esm/sdk/models/commitment-price-input.d.ts.map +1 -0
  126. package/esm/sdk/models/commitment-price-input.js +27 -0
  127. package/esm/sdk/models/commitment-price-input.js.map +1 -0
  128. package/esm/sdk/models/commitment-response.d.ts +56 -0
  129. package/esm/sdk/models/commitment-response.d.ts.map +1 -0
  130. package/esm/sdk/models/commitment-response.js +88 -0
  131. package/esm/sdk/models/commitment-response.js.map +1 -0
  132. package/esm/sdk/models/commitment-scope-input.d.ts +18 -0
  133. package/esm/sdk/models/commitment-scope-input.d.ts.map +1 -0
  134. package/esm/sdk/models/commitment-scope-input.js +20 -0
  135. package/esm/sdk/models/commitment-scope-input.js.map +1 -0
  136. package/esm/sdk/models/commitment-scope-type.d.ts +14 -0
  137. package/esm/sdk/models/commitment-scope-type.d.ts.map +1 -0
  138. package/esm/sdk/models/commitment-scope-type.js +15 -0
  139. package/esm/sdk/models/commitment-scope-type.js.map +1 -0
  140. package/esm/sdk/models/commitment-status.d.ts +13 -0
  141. package/esm/sdk/models/commitment-status.d.ts.map +1 -0
  142. package/esm/sdk/models/commitment-status.js +14 -0
  143. package/esm/sdk/models/commitment-status.js.map +1 -0
  144. package/esm/sdk/models/commitment-usage-breakdown.d.ts +33 -0
  145. package/esm/sdk/models/commitment-usage-breakdown.d.ts.map +1 -0
  146. package/esm/sdk/models/commitment-usage-breakdown.js +37 -0
  147. package/esm/sdk/models/commitment-usage-breakdown.js.map +1 -0
  148. package/esm/sdk/models/commitment-usage-value.d.ts +11 -0
  149. package/esm/sdk/models/commitment-usage-value.d.ts.map +1 -0
  150. package/esm/sdk/models/commitment-usage-value.js +15 -0
  151. package/esm/sdk/models/commitment-usage-value.js.map +1 -0
  152. package/esm/sdk/models/create-commitment-request.d.ts +64 -0
  153. package/esm/sdk/models/create-commitment-request.d.ts.map +1 -0
  154. package/esm/sdk/models/create-commitment-request.js +50 -0
  155. package/esm/sdk/models/create-commitment-request.js.map +1 -0
  156. package/esm/sdk/models/create-entitlement-request.d.ts +3 -0
  157. package/esm/sdk/models/create-entitlement-request.d.ts.map +1 -1
  158. package/esm/sdk/models/create-entitlement-request.js.map +1 -1
  159. package/esm/sdk/models/create-price-tier.d.ts +3 -0
  160. package/esm/sdk/models/create-price-tier.d.ts.map +1 -1
  161. package/esm/sdk/models/create-price-tier.js +3 -0
  162. package/esm/sdk/models/create-price-tier.js.map +1 -1
  163. package/esm/sdk/models/create-subscription-request.d.ts +9 -0
  164. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  165. package/esm/sdk/models/create-subscription-request.js +2 -0
  166. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  167. package/esm/sdk/models/delete-events-op.d.ts +14 -0
  168. package/esm/sdk/models/delete-events-op.d.ts.map +1 -0
  169. package/esm/sdk/models/delete-events-op.js +21 -0
  170. package/esm/sdk/models/delete-events-op.js.map +1 -0
  171. package/esm/sdk/models/delete-events-request.d.ts +38 -0
  172. package/esm/sdk/models/delete-events-request.d.ts.map +1 -0
  173. package/esm/sdk/models/delete-events-request.js +27 -0
  174. package/esm/sdk/models/delete-events-request.js.map +1 -0
  175. package/esm/sdk/models/delete-events-response.d.ts +11 -0
  176. package/esm/sdk/models/delete-events-response.d.ts.map +1 -0
  177. package/esm/sdk/models/delete-events-response.js +21 -0
  178. package/esm/sdk/models/delete-events-response.js.map +1 -0
  179. package/esm/sdk/models/get-commitment-op.d.ts +15 -0
  180. package/esm/sdk/models/get-commitment-op.d.ts.map +1 -0
  181. package/esm/sdk/models/get-commitment-op.js +12 -0
  182. package/esm/sdk/models/get-commitment-op.js.map +1 -0
  183. package/esm/sdk/models/get-usage-by-subscription-response.d.ts +5 -0
  184. package/esm/sdk/models/get-usage-by-subscription-response.d.ts.map +1 -1
  185. package/esm/sdk/models/get-usage-by-subscription-response.js +2 -0
  186. package/esm/sdk/models/get-usage-by-subscription-response.js.map +1 -1
  187. package/esm/sdk/models/index.d.ts +24 -0
  188. package/esm/sdk/models/index.d.ts.map +1 -1
  189. package/esm/sdk/models/index.js +24 -0
  190. package/esm/sdk/models/index.js.map +1 -1
  191. package/esm/sdk/models/invoice-filter.d.ts +10 -0
  192. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  193. package/esm/sdk/models/invoice-filter.js +4 -0
  194. package/esm/sdk/models/invoice-filter.js.map +1 -1
  195. package/esm/sdk/models/invoice-line-item-response.d.ts +4 -0
  196. package/esm/sdk/models/invoice-line-item-response.d.ts.map +1 -1
  197. package/esm/sdk/models/invoice-line-item-response.js +2 -0
  198. package/esm/sdk/models/invoice-line-item-response.js.map +1 -1
  199. package/esm/sdk/models/list-commitments-response.d.ts +13 -0
  200. package/esm/sdk/models/list-commitments-response.d.ts.map +1 -0
  201. package/esm/sdk/models/list-commitments-response.js +17 -0
  202. package/esm/sdk/models/list-commitments-response.js.map +1 -0
  203. package/esm/sdk/models/price-price-tier.d.ts +2 -0
  204. package/esm/sdk/models/price-price-tier.d.ts.map +1 -1
  205. package/esm/sdk/models/price-price-tier.js +3 -0
  206. package/esm/sdk/models/price-price-tier.js.map +1 -1
  207. package/esm/sdk/models/price-transform-quantity.d.ts +5 -0
  208. package/esm/sdk/models/price-transform-quantity.d.ts.map +1 -1
  209. package/esm/sdk/models/price-transform-quantity.js +15 -1
  210. package/esm/sdk/models/price-transform-quantity.js.map +1 -1
  211. package/esm/sdk/models/report-query-request.d.ts +2 -0
  212. package/esm/sdk/models/report-query-request.d.ts.map +1 -1
  213. package/esm/sdk/models/report-query-request.js +1 -0
  214. package/esm/sdk/models/report-query-request.js.map +1 -1
  215. package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
  216. package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
  217. package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
  218. package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
  219. package/esm/sdk/models/subscription-line-item-response.d.ts +5 -0
  220. package/esm/sdk/models/subscription-line-item-response.d.ts.map +1 -1
  221. package/esm/sdk/models/subscription-line-item-response.js +4 -0
  222. package/esm/sdk/models/subscription-line-item-response.js.map +1 -1
  223. package/esm/sdk/models/subscription-subscription-line-item.d.ts +5 -0
  224. package/esm/sdk/models/subscription-subscription-line-item.d.ts.map +1 -1
  225. package/esm/sdk/models/subscription-subscription-line-item.js +4 -0
  226. package/esm/sdk/models/subscription-subscription-line-item.js.map +1 -1
  227. package/esm/sdk/models/terminate-commitment-op.d.ts +21 -0
  228. package/esm/sdk/models/terminate-commitment-op.d.ts.map +1 -0
  229. package/esm/sdk/models/terminate-commitment-op.js +14 -0
  230. package/esm/sdk/models/terminate-commitment-op.js.map +1 -0
  231. package/esm/sdk/models/terminate-commitment-request.d.ts +14 -0
  232. package/esm/sdk/models/terminate-commitment-request.d.ts.map +1 -0
  233. package/esm/sdk/models/terminate-commitment-request.js +19 -0
  234. package/esm/sdk/models/terminate-commitment-request.js.map +1 -0
  235. package/esm/sdk/models/trigger-force-run-request.d.ts +5 -0
  236. package/esm/sdk/models/trigger-force-run-request.d.ts.map +1 -1
  237. package/esm/sdk/models/trigger-force-run-request.js +2 -0
  238. package/esm/sdk/models/trigger-force-run-request.js.map +1 -1
  239. package/esm/sdk/models/update-commitment-op.d.ts +21 -0
  240. package/esm/sdk/models/update-commitment-op.d.ts.map +1 -0
  241. package/esm/sdk/models/update-commitment-op.js +14 -0
  242. package/esm/sdk/models/update-commitment-op.js.map +1 -0
  243. package/esm/sdk/models/update-commitment-request.d.ts +22 -0
  244. package/esm/sdk/models/update-commitment-request.d.ts.map +1 -0
  245. package/esm/sdk/models/update-commitment-request.js +21 -0
  246. package/esm/sdk/models/update-commitment-request.js.map +1 -0
  247. package/esm/sdk/models/update-entitlement-request.d.ts +3 -0
  248. package/esm/sdk/models/update-entitlement-request.d.ts.map +1 -1
  249. package/esm/sdk/models/update-entitlement-request.js.map +1 -1
  250. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.d.ts +13 -0
  251. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.d.ts.map +1 -0
  252. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.js +22 -0
  253. package/esm/sdk/models/webhook-dto-commitment-webhook-payload.js.map +1 -0
  254. package/esm/sdk/models/webhook-event-name.d.ts +3 -0
  255. package/esm/sdk/models/webhook-event-name.d.ts.map +1 -1
  256. package/esm/sdk/models/webhook-event-name.js +3 -0
  257. package/esm/sdk/models/webhook-event-name.js.map +1 -1
  258. package/esm/sdk/sdk.d.ts +3 -0
  259. package/esm/sdk/sdk.d.ts.map +1 -1
  260. package/esm/sdk/sdk.js +5 -0
  261. package/esm/sdk/sdk.js.map +1 -1
  262. package/esm/sdk/webhook-events.d.ts +21 -0
  263. package/esm/sdk/webhook-events.d.ts.map +1 -1
  264. package/esm/sdk/webhook-events.js +30 -0
  265. package/esm/sdk/webhook-events.js.map +1 -1
  266. package/jsr.json +1 -1
  267. package/package.json +1 -1
  268. package/src/funcs/commitments-create-commitment.ts +172 -0
  269. package/src/funcs/commitments-get-commitment.ts +181 -0
  270. package/src/funcs/commitments-preview-commitment.ts +172 -0
  271. package/src/funcs/commitments-query-commitment.ts +172 -0
  272. package/src/funcs/commitments-terminate-commitment.ts +187 -0
  273. package/src/funcs/commitments-update-commitment.ts +187 -0
  274. package/src/funcs/events-delete-events.ts +175 -0
  275. package/src/funcs/webhook-events-post-webhook-events-commitment-created.ts +144 -0
  276. package/src/funcs/webhook-events-post-webhook-events-commitment-terminated.ts +144 -0
  277. package/src/funcs/webhook-events-post-webhook-events-commitment-updated.ts +144 -0
  278. package/src/lib/config.ts +3 -3
  279. package/src/sdk/commitments.ts +121 -0
  280. package/src/sdk/events.ts +18 -0
  281. package/src/sdk/models/active-window.ts +54 -0
  282. package/src/sdk/models/add-addon-ref.ts +12 -0
  283. package/src/sdk/models/addon-price-override-ref.ts +45 -0
  284. package/src/sdk/models/commitment-collection-method.ts +26 -0
  285. package/src/sdk/models/commitment-early-termination.ts +22 -0
  286. package/src/sdk/models/commitment-filter.ts +127 -0
  287. package/src/sdk/models/commitment-measurement.ts +24 -0
  288. package/src/sdk/models/commitment-price-input.ts +64 -0
  289. package/src/sdk/models/commitment-response.ts +164 -0
  290. package/src/sdk/models/commitment-scope-input.ts +49 -0
  291. package/src/sdk/models/commitment-scope-type.ts +26 -0
  292. package/src/sdk/models/commitment-status.ts +25 -0
  293. package/src/sdk/models/commitment-usage-breakdown.ts +86 -0
  294. package/src/sdk/models/commitment-usage-value.ts +33 -0
  295. package/src/sdk/models/create-commitment-request.ts +134 -0
  296. package/src/sdk/models/create-entitlement-request.ts +3 -0
  297. package/src/sdk/models/create-price-tier.ts +9 -0
  298. package/src/sdk/models/create-subscription-request.ts +14 -0
  299. package/src/sdk/models/delete-events-op.ts +45 -0
  300. package/src/sdk/models/delete-events-request.ts +74 -0
  301. package/src/sdk/models/delete-events-response.ts +42 -0
  302. package/src/sdk/models/get-commitment-op.ts +33 -0
  303. package/src/sdk/models/get-usage-by-subscription-response.ts +11 -0
  304. package/src/sdk/models/index.ts +24 -0
  305. package/src/sdk/models/invoice-filter.ts +14 -0
  306. package/src/sdk/models/invoice-line-item-response.ts +6 -0
  307. package/src/sdk/models/list-commitments-response.ts +41 -0
  308. package/src/sdk/models/price-price-tier.ts +7 -0
  309. package/src/sdk/models/price-transform-quantity.ts +33 -1
  310. package/src/sdk/models/report-query-request.ts +3 -0
  311. package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
  312. package/src/sdk/models/subscription-line-item-response.ts +9 -0
  313. package/src/sdk/models/subscription-subscription-line-item.ts +9 -0
  314. package/src/sdk/models/terminate-commitment-op.ts +46 -0
  315. package/src/sdk/models/terminate-commitment-request.ts +44 -0
  316. package/src/sdk/models/trigger-force-run-request.ts +7 -0
  317. package/src/sdk/models/update-commitment-op.ts +46 -0
  318. package/src/sdk/models/update-commitment-request.ts +48 -0
  319. package/src/sdk/models/update-entitlement-request.ts +3 -0
  320. package/src/sdk/models/webhook-dto-commitment-webhook-payload.ts +50 -0
  321. package/src/sdk/models/webhook-event-name.ts +3 -0
  322. package/src/sdk/sdk.ts +6 -0
  323. package/src/sdk/webhook-events.ts +48 -0
package/docs/sdk/models/active-window.md ADDED
@@ -0,0 +1,16 @@
1
+ # ActiveWindow
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ActiveWindow } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ActiveWindow = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
15
+ | `end` | [models.Bucket](../../sdk/models/bucket.md) | :heavy_minus_sign: | N/A |
16
+ | `start` | [models.Bucket](../../sdk/models/bucket.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/add-addon-ref.md CHANGED
@@ -10,11 +10,12 @@ let value: AddAddonRef = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
- | `addonId` | *string* | :heavy_minus_sign: | N/A |
16
- | `associationId` | *string* | :heavy_minus_sign: | N/A |
17
- | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
18
- | `coupons` | [models.CouponRef](../../sdk/models/coupon-ref.md)[] | :heavy_minus_sign: | N/A |
19
- | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
20
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
15
+ | `addonId` | *string* | :heavy_minus_sign: | N/A |
16
+ | `associationId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
18
+ | `coupons` | [models.CouponRef](../../sdk/models/coupon-ref.md)[] | :heavy_minus_sign: | N/A |
19
+ | `priceOverrides` | [models.AddonPriceOverrideRef](../../sdk/models/addon-price-override-ref.md)[] | :heavy_minus_sign: | Price overrides minted at execute time; completion repoints the line items instead of minting again. |
20
+ | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
21
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/addon-price-override-ref.md ADDED
@@ -0,0 +1,17 @@
1
+ # AddonPriceOverrideRef
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { AddonPriceOverrideRef } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: AddonPriceOverrideRef = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------ | ------------------ | ------------------ | ------------------ |
15
+ | `overridePriceId` | *string* | :heavy_minus_sign: | N/A |
16
+ | `priceId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `quantity` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-collection-method.md ADDED
@@ -0,0 +1,17 @@
1
+ # CommitmentCollectionMethod
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentCollectionMethod } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentCollectionMethod = "per_period";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "per_period" | "billing_terms" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/commitment-early-termination.md ADDED
@@ -0,0 +1,17 @@
1
+ # CommitmentEarlyTermination
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentEarlyTermination } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentEarlyTermination = "credit_note";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "forfeit" | "credit_note" | "bill_remaining" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/commitment-filter-order.md ADDED
@@ -0,0 +1,15 @@
1
+ # CommitmentFilterOrder
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentFilterOrder } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentFilterOrder = "asc";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "asc" | "desc"
15
+ ```
package/docs/sdk/models/commitment-filter.md ADDED
@@ -0,0 +1,31 @@
1
+ # CommitmentFilter
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentFilter } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentFilter = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `activeFrom` | *string* | :heavy_minus_sign: | ActiveFrom/ActiveTo select commitments whose term overlaps [ActiveFrom, ActiveTo). |
16
+ | `activeTo` | *string* | :heavy_minus_sign: | N/A |
17
+ | `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
18
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
+ | `expand` | *string* | :heavy_minus_sign: | N/A |
20
+ | `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
21
+ | `ids` | *string*[] | :heavy_minus_sign: | N/A |
22
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
23
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
24
+ | `order` | [models.CommitmentFilterOrder](../../sdk/models/commitment-filter-order.md) | :heavy_minus_sign: | N/A |
25
+ | `scopeEntityIds` | *string*[] | :heavy_minus_sign: | N/A |
26
+ | `scopeEntityType` | [models.CommitmentScopeType](../../sdk/models/commitment-scope-type.md) | :heavy_minus_sign: | N/A |
27
+ | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
28
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
29
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
30
+ | `statuses` | [models.CommitmentStatus](../../sdk/models/commitment-status.md)[] | :heavy_minus_sign: | N/A |
31
+ | `subscriptionIds` | *string*[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-measurement.md ADDED
@@ -0,0 +1,17 @@
1
+ # CommitmentMeasurement
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentMeasurement } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentMeasurement = "window";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "billing_period" | "window" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/commitment-price-input.md ADDED
@@ -0,0 +1,19 @@
1
+ # CommitmentPriceInput
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentPriceInput } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentPriceInput = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
17
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
18
+ | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | N/A |
19
+ | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-response.md ADDED
@@ -0,0 +1,51 @@
1
+ # CommitmentResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `activeWindows` | [models.ActiveWindow](../../sdk/models/active-window.md)[] | :heavy_minus_sign: | N/A |
16
+ | `binding` | *boolean* | :heavy_minus_sign: | N/A |
17
+ | `collectionMethod` | [models.CommitmentCollectionMethod](../../sdk/models/commitment-collection-method.md) | :heavy_minus_sign: | N/A |
18
+ | `commitmentStatus` | [models.CommitmentStatus](../../sdk/models/commitment-status.md) | :heavy_minus_sign: | N/A |
19
+ | `commitmentValue` | *string* | :heavy_minus_sign: | N/A |
20
+ | `committedPriceId` | *string* | :heavy_minus_sign: | N/A |
21
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
22
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
23
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
24
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
25
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
26
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
27
+ | `id` | *string* | :heavy_minus_sign: | N/A |
28
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
29
+ | `instalmentInvoicing` | *string* | :heavy_minus_sign: | N/A |
30
+ | `invoiceDescription` | *string* | :heavy_minus_sign: | N/A |
31
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
32
+ | `measurement` | [models.CommitmentMeasurement](../../sdk/models/commitment-measurement.md) | :heavy_minus_sign: | N/A |
33
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
34
+ | `name` | *string* | :heavy_minus_sign: | N/A |
35
+ | `onEarlyTermination` | [models.CommitmentEarlyTermination](../../sdk/models/commitment-early-termination.md) | :heavy_minus_sign: | N/A |
36
+ | `overagePriceId` | *string* | :heavy_minus_sign: | N/A |
37
+ | `priority` | *number* | :heavy_minus_sign: | N/A |
38
+ | `scopeEntityId` | *string* | :heavy_minus_sign: | N/A |
39
+ | `scopeEntityType` | [models.CommitmentScopeType](../../sdk/models/commitment-scope-type.md) | :heavy_minus_sign: | N/A |
40
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
41
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
42
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
43
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
44
+ | `terminatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
45
+ | `terminationInvoiceId` | *string* | :heavy_minus_sign: | N/A |
46
+ | `timezone` | *string* | :heavy_minus_sign: | N/A |
47
+ | `totalAmount` | *string* | :heavy_minus_sign: | N/A |
48
+ | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
49
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
50
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
51
+ | `value` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-scope-input.md ADDED
@@ -0,0 +1,18 @@
1
+ # CommitmentScopeInput
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentScopeInput } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentScopeInput = {
9
+ entityType: "price",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
17
+ | `entityId` | *string* | :heavy_minus_sign: | EntityID may be omitted on an inline subscription-scoped commitment; the new subscription's ID is used. |
18
+ | `entityType` | [models.CommitmentScopeType](../../sdk/models/commitment-scope-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/commitment-scope-type.md ADDED
@@ -0,0 +1,17 @@
1
+ # CommitmentScopeType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentScopeType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentScopeType = "price";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "subscription" | "group" | "meter" | "price" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/commitment-status.md ADDED
@@ -0,0 +1,17 @@
1
+ # CommitmentStatus
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentStatus } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentStatus = "ended";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "active" | "ended" | "terminated" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/commitment-usage-breakdown.md ADDED
@@ -0,0 +1,26 @@
1
+ # CommitmentUsageBreakdown
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentUsageBreakdown } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentUsageBreakdown = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `appliesFrom` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | AppliesFrom/To is the stretch of the queried window the commitment covers; usage outside it<br/>bills as overage and is not counted here. |
16
+ | `appliesTo` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
+ | `billedAmount` | *string* | :heavy_minus_sign: | BilledAmount is what the stretch bills for this commitment: used plus, when binding, the true-up. |
18
+ | `binding` | *boolean* | :heavy_minus_sign: | N/A |
19
+ | `commitmentId` | *string* | :heavy_minus_sign: | N/A |
20
+ | `committed` | [models.CommitmentUsageValue](../../sdk/models/commitment-usage-value.md) | :heavy_minus_sign: | N/A |
21
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
22
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
23
+ | `measurement` | [models.CommitmentMeasurement](../../sdk/models/commitment-measurement.md) | :heavy_minus_sign: | N/A |
24
+ | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
25
+ | `unused` | [models.CommitmentUsageValue](../../sdk/models/commitment-usage-value.md) | :heavy_minus_sign: | N/A |
26
+ | `used` | [models.CommitmentUsageValue](../../sdk/models/commitment-usage-value.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-usage-value.md ADDED
@@ -0,0 +1,16 @@
1
+ # CommitmentUsageValue
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CommitmentUsageValue } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CommitmentUsageValue = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------ | ------------------ | ------------------ | ------------------ |
15
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `quantity` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-commitment-request.md ADDED
@@ -0,0 +1,42 @@
1
+ # CreateCommitmentRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CreateCommitmentRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CreateCommitmentRequest = {
9
+ endDate: new Date("2025-02-26T11:45:33.908Z"),
10
+ measurement: "window",
11
+ name: "<value>",
12
+ scope: {
13
+ entityType: "group",
14
+ },
15
+ startDate: new Date("2026-07-21T11:23:27.274Z"),
16
+ type: "quantity",
17
+ };
18
+ ```
19
+
20
+ ## Fields
21
+
22
+ | Field | Type | Required | Description |
23
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
24
+ | `activeWindows` | [models.ActiveWindow](../../sdk/models/active-window.md)[] | :heavy_minus_sign: | N/A |
25
+ | `binding` | *boolean* | :heavy_minus_sign: | default false |
26
+ | `collectionMethod` | [models.CommitmentCollectionMethod](../../sdk/models/commitment-collection-method.md) | :heavy_minus_sign: | N/A |
27
+ | `committedPrice` | [models.CommitmentPriceInput](../../sdk/models/commitment-price-input.md) | :heavy_minus_sign: | N/A |
28
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A |
29
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
30
+ | `invoiceDescription` | *string* | :heavy_minus_sign: | N/A |
31
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
32
+ | `measurement` | [models.CommitmentMeasurement](../../sdk/models/commitment-measurement.md) | :heavy_check_mark: | N/A |
33
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
34
+ | `name` | *string* | :heavy_check_mark: | N/A |
35
+ | `overagePrice` | [models.CommitmentPriceInput](../../sdk/models/commitment-price-input.md) | :heavy_minus_sign: | N/A |
36
+ | `priority` | *number* | :heavy_minus_sign: | N/A |
37
+ | `scope` | [models.CommitmentScopeInput](../../sdk/models/commitment-scope-input.md) | :heavy_check_mark: | N/A |
38
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A |
39
+ | `subscriptionId` | *string* | :heavy_minus_sign: | SubscriptionID is required on POST /commitments and set server-side on inline commitments. |
40
+ | `timezone` | *string* | :heavy_minus_sign: | N/A |
41
+ | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_check_mark: | N/A |
42
+ | `value` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-entitlement-request.md CHANGED
@@ -34,5 +34,5 @@ let value: CreateEntitlementRequest = {
34
34
  | `planId` | *string* | :heavy_minus_sign: | N/A |
35
35
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
36
36
  | `staticValue` | *string* | :heavy_minus_sign: | N/A |
37
- | `usageLimit` | *number* | :heavy_minus_sign: | N/A |
37
+ | `usageLimit` | *number* | :heavy_minus_sign: | Deprecated: use grant_quota; a metered usage_limit is converted to a grant on create. |
38
38
  | `usageResetPeriod` | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-price-tier.md CHANGED
@@ -15,5 +15,6 @@ let value: CreatePriceTier = {
15
15
  | Field | Type | Required | Description |
16
16
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
17
  | `flatAmount` | *string* | :heavy_minus_sign: | flat_amount is the flat amount for the given tier (optional)<br/>Applied on top of unit_amount*quantity. Useful for cases like "2.7$ + 5c" |
18
+ | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
18
19
  | `unitAmount` | *string* | :heavy_check_mark: | unit_amount is the amount per unit for the given tier |
19
20
  | `upTo` | *number* | :heavy_minus_sign: | up_to is the quantity up to which this tier applies. It is null for the last tier.<br/>IMPORTANT: Tier boundaries are INCLUSIVE.<br/>- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier<br/>- This behavior is consistent across both VOLUME and SLAB tier modes |
package/docs/sdk/models/create-scheduled-task-request.md CHANGED
@@ -7,7 +7,7 @@ import { CreateScheduledTaskRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: CreateScheduledTaskRequest = {
9
9
  connectionId: "<id>",
10
- entityType: "wallet_debits",
10
+ entityType: "wallet_ledger",
11
11
  interval: "30MIN",
12
12
  jobConfig: {},
13
13
  };
package/docs/sdk/models/create-subscription-request.md CHANGED
@@ -26,6 +26,7 @@ let value: CreateSubscriptionRequest = {
26
26
  | `collectionMethod` | [models.CollectionMethod](../../sdk/models/collection-method.md) | :heavy_minus_sign: | N/A |
27
27
  | `commitmentAmount` | *string* | :heavy_minus_sign: | N/A |
28
28
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
29
+ | `commitments` | [models.CreateCommitmentRequest](../../sdk/models/create-commitment-request.md)[] | :heavy_minus_sign: | Commitments are created with the subscription. subscription_id, and entity_id on a subscription scope,<br/>are set server-side. |
29
30
  | `coupons` | *string*[] | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
30
31
  | `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | N/A |
31
32
  | `currency` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/delete-events-request.md ADDED
@@ -0,0 +1,26 @@
1
+ # DeleteEventsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { DeleteEventsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: DeleteEventsRequest = {
9
+ externalCustomerIds: [
10
+ "<value 1>",
11
+ ],
12
+ periodEnd: new Date("2026-03-28T00:00:00Z"),
13
+ periodStart: new Date("2026-03-01T00:00:00Z"),
14
+ };
15
+ ```
16
+
17
+ ## Fields
18
+
19
+ | Field | Type | Required | Description | Example |
20
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | `eventIds` | *string*[] | :heavy_minus_sign: | EventIDs narrows the deletion to exact event ids. Requires exactly one<br/>customer and no feature_ids. | |
22
+ | `externalCustomerIds` | *string*[] | :heavy_check_mark: | N/A | |
23
+ | `featureIds` | *string*[] | :heavy_minus_sign: | FeatureIDs narrows the deletion to the meters these features resolve to. | |
24
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2026-03-28T00:00:00Z |
25
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2026-03-01T00:00:00Z |
26
+ | `skipPayload` | *boolean* | :heavy_minus_sign: | SkipPayload stores the audit row's properties as '' so the deletion leaves<br/>no payload copy. Defaults to true: a deletion is usually an erasure, and<br/>keeping the payload would defeat it. Send false to retain it. | |