@flexprice/sdk 2.1.47-dev.33 → 2.1.48-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 (268) hide show
  1. package/docs/sdk/models/billing-term-input.md +29 -0
  2. package/docs/sdk/models/billing-term-kind.md +17 -0
  3. package/docs/sdk/models/billing-term-owner-type.md +15 -0
  4. package/docs/sdk/models/billing-term-split.md +17 -0
  5. package/docs/sdk/models/billing-term-value-type.md +19 -0
  6. package/docs/sdk/models/billing-terms-response.md +16 -0
  7. package/docs/sdk/models/billingterm-instalment.md +40 -0
  8. package/docs/sdk/models/billingterm-term.md +36 -0
  9. package/docs/sdk/models/cancellation-fee-input.md +19 -0
  10. package/docs/sdk/models/cancellation-fee-type.md +17 -0
  11. package/docs/sdk/models/commitment-response.md +3 -1
  12. package/docs/sdk/models/create-commitment-request.md +3 -1
  13. package/docs/sdk/models/get-commitment-billing-terms-request.md +17 -0
  14. package/docs/sdk/models/instalment-bill-trigger.md +17 -0
  15. package/docs/sdk/models/instalment-delivery.md +17 -0
  16. package/docs/sdk/models/instalment-kind.md +17 -0
  17. package/docs/sdk/models/instalment-status.md +17 -0
  18. package/docs/sdk/models/invoice-billing-reason.md +1 -1
  19. package/docs/sdk/models/invoice-line-item-response.md +1 -0
  20. package/docs/sdk/models/list-commitment-instalments-request.md +18 -0
  21. package/docs/sdk/models/list-instalments-response.md +15 -0
  22. package/docs/sdk/models/preview-commitment-billing-terms-request.md +21 -0
  23. package/docs/sdk/models/replace-billing-terms-request.md +17 -0
  24. package/docs/sdk/models/replace-commitment-billing-terms-request.md +21 -0
  25. package/docs/sdk/models/terminate-commitment-request.md +2 -2
  26. package/docs/sdk/models/trigger-commitment-instalment-request.md +20 -0
  27. package/docs/sdk/models/trigger-instalment-request.md +15 -0
  28. package/docs/sdk/models/webhook-dto-billing-instalment-webhook-payload.md +16 -0
  29. package/docs/sdk/models/webhook-dto-billing-terms-webhook-payload.md +18 -0
  30. package/docs/sdk/models/webhook-dto-invoice-line-item.md +1 -0
  31. package/docs/sdk/models/webhook-event-name.md +1 -1
  32. package/docs/sdks/commitments/README.md +384 -1
  33. package/docs/sdks/webhookevents/README.md +414 -0
  34. package/esm/funcs/commitments-get-commitment-billing-terms.d.ts +17 -0
  35. package/esm/funcs/commitments-get-commitment-billing-terms.d.ts.map +1 -0
  36. package/esm/funcs/commitments-get-commitment-billing-terms.js +91 -0
  37. package/esm/funcs/commitments-get-commitment-billing-terms.js.map +1 -0
  38. package/esm/funcs/commitments-list-commitment-instalments.d.ts +17 -0
  39. package/esm/funcs/commitments-list-commitment-instalments.d.ts.map +1 -0
  40. package/esm/funcs/commitments-list-commitment-instalments.js +96 -0
  41. package/esm/funcs/commitments-list-commitment-instalments.js.map +1 -0
  42. package/esm/funcs/commitments-preview-commitment-billing-terms.d.ts +17 -0
  43. package/esm/funcs/commitments-preview-commitment-billing-terms.d.ts.map +1 -0
  44. package/esm/funcs/commitments-preview-commitment-billing-terms.js +93 -0
  45. package/esm/funcs/commitments-preview-commitment-billing-terms.js.map +1 -0
  46. package/esm/funcs/commitments-replace-commitment-billing-terms.d.ts +17 -0
  47. package/esm/funcs/commitments-replace-commitment-billing-terms.d.ts.map +1 -0
  48. package/esm/funcs/commitments-replace-commitment-billing-terms.js +93 -0
  49. package/esm/funcs/commitments-replace-commitment-billing-terms.js.map +1 -0
  50. package/esm/funcs/commitments-terminate-commitment.d.ts +1 -1
  51. package/esm/funcs/commitments-terminate-commitment.js +1 -1
  52. package/esm/funcs/commitments-trigger-commitment-instalment.d.ts +17 -0
  53. package/esm/funcs/commitments-trigger-commitment-instalment.d.ts.map +1 -0
  54. package/esm/funcs/commitments-trigger-commitment-instalment.js +98 -0
  55. package/esm/funcs/commitments-trigger-commitment-instalment.js.map +1 -0
  56. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-cancelled.d.ts +17 -0
  57. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-cancelled.d.ts.map +1 -0
  58. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-cancelled.js +69 -0
  59. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-cancelled.js.map +1 -0
  60. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.d.ts +17 -0
  61. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.d.ts.map +1 -0
  62. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.js +69 -0
  63. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.js.map +1 -0
  64. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-invoiced.d.ts +17 -0
  65. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-invoiced.d.ts.map +1 -0
  66. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-invoiced.js +69 -0
  67. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-invoiced.js.map +1 -0
  68. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-updated.d.ts +17 -0
  69. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-updated.d.ts.map +1 -0
  70. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-updated.js +69 -0
  71. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-updated.js.map +1 -0
  72. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.d.ts +17 -0
  73. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.d.ts.map +1 -0
  74. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.js +69 -0
  75. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.js.map +1 -0
  76. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.d.ts +17 -0
  77. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.d.ts.map +1 -0
  78. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.js +69 -0
  79. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.js.map +1 -0
  80. package/esm/lib/config.d.ts +2 -2
  81. package/esm/lib/config.d.ts.map +1 -1
  82. package/esm/lib/config.js +2 -2
  83. package/esm/lib/config.js.map +1 -1
  84. package/esm/sdk/commitments.d.ts +36 -1
  85. package/esm/sdk/commitments.d.ts.map +1 -1
  86. package/esm/sdk/commitments.js +51 -1
  87. package/esm/sdk/commitments.js.map +1 -1
  88. package/esm/sdk/models/billing-term-input.d.ts +61 -0
  89. package/esm/sdk/models/billing-term-input.d.ts.map +1 -0
  90. package/esm/sdk/models/billing-term-input.js +40 -0
  91. package/esm/sdk/models/billing-term-input.js.map +1 -0
  92. package/esm/sdk/models/billing-term-kind.d.ts +12 -0
  93. package/esm/sdk/models/billing-term-kind.d.ts.map +1 -0
  94. package/esm/sdk/models/billing-term-kind.js +13 -0
  95. package/esm/sdk/models/billing-term-kind.js.map +1 -0
  96. package/esm/sdk/models/billing-term-owner-type.d.ts +9 -0
  97. package/esm/sdk/models/billing-term-owner-type.d.ts.map +1 -0
  98. package/esm/sdk/models/billing-term-owner-type.js +10 -0
  99. package/esm/sdk/models/billing-term-owner-type.js.map +1 -0
  100. package/esm/sdk/models/billing-term-split.d.ts +12 -0
  101. package/esm/sdk/models/billing-term-split.d.ts.map +1 -0
  102. package/esm/sdk/models/billing-term-split.js +13 -0
  103. package/esm/sdk/models/billing-term-split.js.map +1 -0
  104. package/esm/sdk/models/billing-term-value-type.d.ts +19 -0
  105. package/esm/sdk/models/billing-term-value-type.d.ts.map +1 -0
  106. package/esm/sdk/models/billing-term-value-type.js +17 -0
  107. package/esm/sdk/models/billing-term-value-type.js.map +1 -0
  108. package/esm/sdk/models/billing-terms-response.d.ts +13 -0
  109. package/esm/sdk/models/billing-terms-response.d.ts.map +1 -0
  110. package/esm/sdk/models/billing-terms-response.js +22 -0
  111. package/esm/sdk/models/billing-terms-response.js.map +1 -0
  112. package/esm/sdk/models/billingterm-instalment.d.ts +43 -0
  113. package/esm/sdk/models/billingterm-instalment.d.ts.map +1 -0
  114. package/esm/sdk/models/billingterm-instalment.js +68 -0
  115. package/esm/sdk/models/billingterm-instalment.js.map +1 -0
  116. package/esm/sdk/models/billingterm-term.d.ts +55 -0
  117. package/esm/sdk/models/billingterm-term.d.ts.map +1 -0
  118. package/esm/sdk/models/billingterm-term.js +62 -0
  119. package/esm/sdk/models/billingterm-term.js.map +1 -0
  120. package/esm/sdk/models/cancellation-fee-input.d.ts +18 -0
  121. package/esm/sdk/models/cancellation-fee-input.d.ts.map +1 -0
  122. package/esm/sdk/models/cancellation-fee-input.js +14 -0
  123. package/esm/sdk/models/cancellation-fee-input.js.map +1 -0
  124. package/esm/sdk/models/cancellation-fee-type.d.ts +16 -0
  125. package/esm/sdk/models/cancellation-fee-type.d.ts.map +1 -0
  126. package/esm/sdk/models/cancellation-fee-type.js +14 -0
  127. package/esm/sdk/models/cancellation-fee-type.js.map +1 -0
  128. package/esm/sdk/models/commitment-response.d.ts +9 -1
  129. package/esm/sdk/models/commitment-response.d.ts.map +1 -1
  130. package/esm/sdk/models/commitment-response.js +7 -1
  131. package/esm/sdk/models/commitment-response.js.map +1 -1
  132. package/esm/sdk/models/create-commitment-request.d.ts +12 -0
  133. package/esm/sdk/models/create-commitment-request.d.ts.map +1 -1
  134. package/esm/sdk/models/create-commitment-request.js +6 -0
  135. package/esm/sdk/models/create-commitment-request.js.map +1 -1
  136. package/esm/sdk/models/get-commitment-billing-terms-op.d.ts +15 -0
  137. package/esm/sdk/models/get-commitment-billing-terms-op.d.ts.map +1 -0
  138. package/esm/sdk/models/get-commitment-billing-terms-op.js +12 -0
  139. package/esm/sdk/models/get-commitment-billing-terms-op.js.map +1 -0
  140. package/esm/sdk/models/index.d.ts +24 -0
  141. package/esm/sdk/models/index.d.ts.map +1 -1
  142. package/esm/sdk/models/index.js +24 -0
  143. package/esm/sdk/models/index.js.map +1 -1
  144. package/esm/sdk/models/instalment-bill-trigger.d.ts +12 -0
  145. package/esm/sdk/models/instalment-bill-trigger.d.ts.map +1 -0
  146. package/esm/sdk/models/instalment-bill-trigger.js +13 -0
  147. package/esm/sdk/models/instalment-bill-trigger.js.map +1 -0
  148. package/esm/sdk/models/instalment-delivery.d.ts +12 -0
  149. package/esm/sdk/models/instalment-delivery.d.ts.map +1 -0
  150. package/esm/sdk/models/instalment-delivery.js +13 -0
  151. package/esm/sdk/models/instalment-delivery.js.map +1 -0
  152. package/esm/sdk/models/instalment-kind.d.ts +10 -0
  153. package/esm/sdk/models/instalment-kind.d.ts.map +1 -0
  154. package/esm/sdk/models/instalment-kind.js +11 -0
  155. package/esm/sdk/models/instalment-kind.js.map +1 -0
  156. package/esm/sdk/models/instalment-status.d.ts +11 -0
  157. package/esm/sdk/models/instalment-status.d.ts.map +1 -0
  158. package/esm/sdk/models/instalment-status.js +12 -0
  159. package/esm/sdk/models/instalment-status.js.map +1 -0
  160. package/esm/sdk/models/invoice-billing-reason.d.ts +1 -0
  161. package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
  162. package/esm/sdk/models/invoice-billing-reason.js +1 -0
  163. package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
  164. package/esm/sdk/models/invoice-line-item-response.d.ts +4 -0
  165. package/esm/sdk/models/invoice-line-item-response.d.ts.map +1 -1
  166. package/esm/sdk/models/invoice-line-item-response.js +2 -0
  167. package/esm/sdk/models/invoice-line-item-response.js.map +1 -1
  168. package/esm/sdk/models/list-commitment-instalments-op.d.ts +20 -0
  169. package/esm/sdk/models/list-commitment-instalments-op.d.ts.map +1 -0
  170. package/esm/sdk/models/list-commitment-instalments-op.js +13 -0
  171. package/esm/sdk/models/list-commitment-instalments-op.js.map +1 -0
  172. package/esm/sdk/models/list-instalments-response.d.ts +11 -0
  173. package/esm/sdk/models/list-instalments-response.d.ts.map +1 -0
  174. package/esm/sdk/models/list-instalments-response.js +15 -0
  175. package/esm/sdk/models/list-instalments-response.js.map +1 -0
  176. package/esm/sdk/models/preview-commitment-billing-terms-op.d.ts +21 -0
  177. package/esm/sdk/models/preview-commitment-billing-terms-op.d.ts.map +1 -0
  178. package/esm/sdk/models/preview-commitment-billing-terms-op.js +14 -0
  179. package/esm/sdk/models/preview-commitment-billing-terms-op.js.map +1 -0
  180. package/esm/sdk/models/replace-billing-terms-request.d.ts +13 -0
  181. package/esm/sdk/models/replace-billing-terms-request.d.ts.map +1 -0
  182. package/esm/sdk/models/replace-billing-terms-request.js +18 -0
  183. package/esm/sdk/models/replace-billing-terms-request.js.map +1 -0
  184. package/esm/sdk/models/replace-commitment-billing-terms-op.d.ts +21 -0
  185. package/esm/sdk/models/replace-commitment-billing-terms-op.d.ts.map +1 -0
  186. package/esm/sdk/models/replace-commitment-billing-terms-op.js +14 -0
  187. package/esm/sdk/models/replace-commitment-billing-terms-op.js.map +1 -0
  188. package/esm/sdk/models/terminate-commitment-request.d.ts +6 -2
  189. package/esm/sdk/models/terminate-commitment-request.d.ts.map +1 -1
  190. package/esm/sdk/models/terminate-commitment-request.js +2 -1
  191. package/esm/sdk/models/terminate-commitment-request.js.map +1 -1
  192. package/esm/sdk/models/trigger-commitment-instalment-op.d.ts +26 -0
  193. package/esm/sdk/models/trigger-commitment-instalment-op.d.ts.map +1 -0
  194. package/esm/sdk/models/trigger-commitment-instalment-op.js +20 -0
  195. package/esm/sdk/models/trigger-commitment-instalment-op.js.map +1 -0
  196. package/esm/sdk/models/trigger-instalment-request.d.ts +15 -0
  197. package/esm/sdk/models/trigger-instalment-request.d.ts.map +1 -0
  198. package/esm/sdk/models/trigger-instalment-request.js +17 -0
  199. package/esm/sdk/models/trigger-instalment-request.js.map +1 -0
  200. package/esm/sdk/models/webhook-dto-billing-instalment-webhook-payload.d.ts +13 -0
  201. package/esm/sdk/models/webhook-dto-billing-instalment-webhook-payload.d.ts.map +1 -0
  202. package/esm/sdk/models/webhook-dto-billing-instalment-webhook-payload.js +22 -0
  203. package/esm/sdk/models/webhook-dto-billing-instalment-webhook-payload.js.map +1 -0
  204. package/esm/sdk/models/webhook-dto-billing-terms-webhook-payload.d.ts +16 -0
  205. package/esm/sdk/models/webhook-dto-billing-terms-webhook-payload.d.ts.map +1 -0
  206. package/esm/sdk/models/webhook-dto-billing-terms-webhook-payload.js +28 -0
  207. package/esm/sdk/models/webhook-dto-billing-terms-webhook-payload.js.map +1 -0
  208. package/esm/sdk/models/webhook-dto-invoice-line-item.d.ts +1 -0
  209. package/esm/sdk/models/webhook-dto-invoice-line-item.d.ts.map +1 -1
  210. package/esm/sdk/models/webhook-dto-invoice-line-item.js +2 -0
  211. package/esm/sdk/models/webhook-dto-invoice-line-item.js.map +1 -1
  212. package/esm/sdk/models/webhook-event-name.d.ts +6 -0
  213. package/esm/sdk/models/webhook-event-name.d.ts.map +1 -1
  214. package/esm/sdk/models/webhook-event-name.js +6 -0
  215. package/esm/sdk/models/webhook-event-name.js.map +1 -1
  216. package/esm/sdk/webhook-events.d.ts +42 -0
  217. package/esm/sdk/webhook-events.d.ts.map +1 -1
  218. package/esm/sdk/webhook-events.js +60 -0
  219. package/esm/sdk/webhook-events.js.map +1 -1
  220. package/jsr.json +1 -1
  221. package/package.json +2 -2
  222. package/src/funcs/commitments-get-commitment-billing-terms.ts +182 -0
  223. package/src/funcs/commitments-list-commitment-instalments.ts +191 -0
  224. package/src/funcs/commitments-preview-commitment-billing-terms.ts +192 -0
  225. package/src/funcs/commitments-replace-commitment-billing-terms.ts +190 -0
  226. package/src/funcs/commitments-terminate-commitment.ts +1 -1
  227. package/src/funcs/commitments-trigger-commitment-instalment.ts +197 -0
  228. package/src/funcs/webhook-events-post-webhook-events-billing-instalment-cancelled.ts +144 -0
  229. package/src/funcs/webhook-events-post-webhook-events-billing-instalment-created.ts +144 -0
  230. package/src/funcs/webhook-events-post-webhook-events-billing-instalment-invoiced.ts +144 -0
  231. package/src/funcs/webhook-events-post-webhook-events-billing-instalment-updated.ts +144 -0
  232. package/src/funcs/webhook-events-post-webhook-events-billing-terms-created.ts +144 -0
  233. package/src/funcs/webhook-events-post-webhook-events-billing-terms-updated.ts +144 -0
  234. package/src/lib/config.ts +2 -3
  235. package/src/sdk/commitments.ts +101 -1
  236. package/src/sdk/models/billing-term-input.ts +116 -0
  237. package/src/sdk/models/billing-term-kind.ts +24 -0
  238. package/src/sdk/models/billing-term-owner-type.ts +16 -0
  239. package/src/sdk/models/billing-term-split.ts +24 -0
  240. package/src/sdk/models/billing-term-value-type.ts +31 -0
  241. package/src/sdk/models/billing-terms-response.ts +49 -0
  242. package/src/sdk/models/billingterm-instalment.ts +128 -0
  243. package/src/sdk/models/billingterm-term.ts +136 -0
  244. package/src/sdk/models/cancellation-fee-input.ts +40 -0
  245. package/src/sdk/models/cancellation-fee-type.ts +23 -0
  246. package/src/sdk/models/commitment-response.ts +22 -2
  247. package/src/sdk/models/create-commitment-request.ts +23 -0
  248. package/src/sdk/models/get-commitment-billing-terms-op.ts +35 -0
  249. package/src/sdk/models/index.ts +24 -0
  250. package/src/sdk/models/instalment-bill-trigger.ts +24 -0
  251. package/src/sdk/models/instalment-delivery.ts +24 -0
  252. package/src/sdk/models/instalment-kind.ts +19 -0
  253. package/src/sdk/models/instalment-status.ts +20 -0
  254. package/src/sdk/models/invoice-billing-reason.ts +1 -0
  255. package/src/sdk/models/invoice-line-item-response.ts +6 -0
  256. package/src/sdk/models/list-commitment-instalments-op.ts +41 -0
  257. package/src/sdk/models/list-instalments-response.ts +35 -0
  258. package/src/sdk/models/preview-commitment-billing-terms-op.ts +46 -0
  259. package/src/sdk/models/replace-billing-terms-request.ts +43 -0
  260. package/src/sdk/models/replace-commitment-billing-terms-op.ts +46 -0
  261. package/src/sdk/models/terminate-commitment-request.ts +11 -3
  262. package/src/sdk/models/trigger-commitment-instalment-op.ts +60 -0
  263. package/src/sdk/models/trigger-instalment-request.ts +41 -0
  264. package/src/sdk/models/webhook-dto-billing-instalment-webhook-payload.ts +53 -0
  265. package/src/sdk/models/webhook-dto-billing-terms-webhook-payload.ts +61 -0
  266. package/src/sdk/models/webhook-dto-invoice-line-item.ts +3 -0
  267. package/src/sdk/models/webhook-event-name.ts +6 -0
  268. package/src/sdk/webhook-events.ts +96 -0
package/docs/sdk/models/billing-term-input.md ADDED
@@ -0,0 +1,29 @@
1
+ # BillingTermInput
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingTermInput } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingTermInput = {
9
+ kind: "once",
10
+ valueType: "fixed",
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
+ | `billOn` | *string* | :heavy_minus_sign: | BillOn is a whole second, the commitment start by default. On an edit it defaults to the start of the billing<br/>period holding now, or to the commitment start once the term has ended. |
19
+ | `billTrigger` | [models.InstalmentBillTrigger](../../sdk/models/instalment-bill-trigger.md) | :heavy_minus_sign: | N/A |
20
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
21
+ | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
22
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | InvoiceLabel names the term's instalments on the invoice, "Instalment {n} of {of}" by default. {n} and {of} are<br/>filled with each instalment's place among all of the commitment's instalments and their count. |
23
+ | `kind` | [models.BillingTermKind](../../sdk/models/billing-term-kind.md) | :heavy_check_mark: | N/A |
24
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
25
+ | `periodCount` | *number* | :heavy_minus_sign: | N/A |
26
+ | `split` | [models.BillingTermSplit](../../sdk/models/billing-term-split.md) | :heavy_minus_sign: | N/A |
27
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate defaults like BillOn; EndDate defaults to the commitment end. Both are whole seconds. |
28
+ | `value` | *string* | :heavy_minus_sign: | N/A |
29
+ | `valueType` | [models.BillingTermValueType](../../sdk/models/billing-term-value-type.md) | :heavy_check_mark: | fixed or remainder; percentage is reserved and rejected as not supported yet |
package/docs/sdk/models/billing-term-kind.md ADDED
@@ -0,0 +1,17 @@
1
+ # BillingTermKind
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingTermKind } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingTermKind = "recurring";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "once" | "recurring" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/billing-term-owner-type.md ADDED
@@ -0,0 +1,15 @@
1
+ # BillingTermOwnerType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingTermOwnerType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingTermOwnerType = "commitment";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "commitment"
15
+ ```
package/docs/sdk/models/billing-term-split.md ADDED
@@ -0,0 +1,17 @@
1
+ # BillingTermSplit
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingTermSplit } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingTermSplit = "proportional";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "even" | "proportional" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/billing-term-value-type.md ADDED
@@ -0,0 +1,19 @@
1
+ # BillingTermValueType
2
+
3
+ fixed or remainder; percentage is reserved and rejected as not supported yet
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { BillingTermValueType } from "@flexprice/sdk/sdk/models";
9
+
10
+ let value: BillingTermValueType = "fixed";
11
+
12
+ // Open enum: unrecognized values are captured as Unrecognized<string>
13
+ ```
14
+
15
+ ## Values
16
+
17
+ ```typescript
18
+ "fixed" | "percentage" | "remainder" | Unrecognized<string>
19
+ ```
package/docs/sdk/models/billing-terms-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # BillingTermsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingTermsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingTermsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
15
+ | `billingTerms` | [models.BillingtermTerm](../../sdk/models/billingterm-term.md)[] | :heavy_minus_sign: | N/A |
16
+ | `instalments` | [models.BillingtermInstalment](../../sdk/models/billingterm-instalment.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/billingterm-instalment.md ADDED
@@ -0,0 +1,40 @@
1
+ # BillingtermInstalment
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingtermInstalment } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingtermInstalment = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `billOn` | *string* | :heavy_minus_sign: | N/A |
17
+ | `billTrigger` | [models.InstalmentBillTrigger](../../sdk/models/instalment-bill-trigger.md) | :heavy_minus_sign: | N/A |
18
+ | `billingTermId` | *string* | :heavy_minus_sign: | N/A |
19
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
20
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
21
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
22
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
23
+ | `delivery` | [models.InstalmentDelivery](../../sdk/models/instalment-delivery.md) | :heavy_minus_sign: | N/A |
24
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
25
+ | `id` | *string* | :heavy_minus_sign: | N/A |
26
+ | `instalmentStatus` | [models.InstalmentStatus](../../sdk/models/instalment-status.md) | :heavy_minus_sign: | N/A |
27
+ | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
28
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
29
+ | `kind` | [models.InstalmentKind](../../sdk/models/instalment-kind.md) | :heavy_minus_sign: | N/A |
30
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
31
+ | `ownerId` | *string* | :heavy_minus_sign: | N/A |
32
+ | `ownerType` | [models.BillingTermOwnerType](../../sdk/models/billing-term-owner-type.md) | :heavy_minus_sign: | N/A |
33
+ | `servicePeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
34
+ | `servicePeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
35
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
36
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
37
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
38
+ | `triggeredAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
39
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
40
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/billingterm-term.md ADDED
@@ -0,0 +1,36 @@
1
+ # BillingtermTerm
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingtermTerm } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingtermTerm = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `billOn` | *string* | :heavy_minus_sign: | N/A |
16
+ | `billTrigger` | [models.InstalmentBillTrigger](../../sdk/models/instalment-bill-trigger.md) | :heavy_minus_sign: | N/A |
17
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
19
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
20
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
21
+ | `id` | *string* | :heavy_minus_sign: | N/A |
22
+ | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
23
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | InvoiceLabel names its instalments on the invoice, after the owner's label. It may use {n} and {of}, which number<br/>all of the owner's instalments together. |
24
+ | `kind` | [models.BillingTermKind](../../sdk/models/billing-term-kind.md) | :heavy_minus_sign: | N/A |
25
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
26
+ | `ownerId` | *string* | :heavy_minus_sign: | N/A |
27
+ | `ownerType` | [models.BillingTermOwnerType](../../sdk/models/billing-term-owner-type.md) | :heavy_minus_sign: | N/A |
28
+ | `periodCount` | *number* | :heavy_minus_sign: | N/A |
29
+ | `split` | [models.BillingTermSplit](../../sdk/models/billing-term-split.md) | :heavy_minus_sign: | N/A |
30
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Recurring terms. |
31
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
32
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
33
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
34
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
35
+ | `value` | *string* | :heavy_minus_sign: | Value is the amount of a fixed term, per instalment on a recurring one; it is nil for a remainder term. |
36
+ | `valueType` | [models.BillingTermValueType](../../sdk/models/billing-term-value-type.md) | :heavy_minus_sign: | fixed or remainder; percentage is reserved and rejected as not supported yet |
package/docs/sdk/models/cancellation-fee-input.md ADDED
@@ -0,0 +1,19 @@
1
+ # CancellationFeeInput
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CancellationFeeInput } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CancellationFeeInput = {
9
+ type: "fixed",
10
+ value: "<value>",
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
18
+ | `type` | [models.CancellationFeeType](../../sdk/models/cancellation-fee-type.md) | :heavy_check_mark: | fixed; percentage is reserved and rejected as not supported yet |
19
+ | `value` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/cancellation-fee-type.md ADDED
@@ -0,0 +1,17 @@
1
+ # CancellationFeeType
2
+
3
+ fixed; percentage is reserved and rejected as not supported yet
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CancellationFeeType } from "@flexprice/sdk/sdk/models";
9
+
10
+ let value: CancellationFeeType = "fixed";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "fixed" | "percentage"
17
+ ```
package/docs/sdk/models/commitment-response.md CHANGED
@@ -13,6 +13,7 @@ let value: CommitmentResponse = {};
13
13
  | Field | Type | Required | Description |
14
14
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
15
  | `activeWindows` | [models.ActiveWindow](../../sdk/models/active-window.md)[] | :heavy_minus_sign: | N/A |
16
+ | `billingTerms` | [models.BillingtermTerm](../../sdk/models/billingterm-term.md)[] | :heavy_minus_sign: | BillingTerms and Instalments are set by create and preview. |
16
17
  | `binding` | *boolean* | :heavy_minus_sign: | N/A |
17
18
  | `collectionMethod` | [models.CommitmentCollectionMethod](../../sdk/models/commitment-collection-method.md) | :heavy_minus_sign: | N/A |
18
19
  | `commitmentStatus` | [models.CommitmentStatus](../../sdk/models/commitment-status.md) | :heavy_minus_sign: | N/A |
@@ -26,7 +27,8 @@ let value: CommitmentResponse = {};
26
27
  | `environmentId` | *string* | :heavy_minus_sign: | N/A |
27
28
  | `id` | *string* | :heavy_minus_sign: | N/A |
28
29
  | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
29
- | `instalmentInvoicing` | *string* | :heavy_minus_sign: | N/A |
30
+ | `instalmentInvoicing` | [models.InstalmentDelivery](../../sdk/models/instalment-delivery.md) | :heavy_minus_sign: | N/A |
31
+ | `instalments` | [models.BillingtermInstalment](../../sdk/models/billingterm-instalment.md)[] | :heavy_minus_sign: | N/A |
30
32
  | `invoiceDescription` | *string* | :heavy_minus_sign: | N/A |
31
33
  | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
32
34
  | `measurement` | [models.CommitmentMeasurement](../../sdk/models/commitment-measurement.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-commitment-request.md CHANGED
@@ -21,11 +21,13 @@ let value: CreateCommitmentRequest = {
21
21
  | Field | Type | Required | Description |
22
22
  | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
23
23
  | `activeWindows` | [models.ActiveWindow](../../sdk/models/active-window.md)[] | :heavy_minus_sign: | N/A |
24
+ | `billingTerms` | [models.BillingTermInput](../../sdk/models/billing-term-input.md)[] | :heavy_minus_sign: | BillingTerms apply only to collection_method billing_terms, which requires at least one. |
24
25
  | `binding` | *boolean* | :heavy_minus_sign: | default false |
25
26
  | `collectionMethod` | [models.CommitmentCollectionMethod](../../sdk/models/commitment-collection-method.md) | :heavy_minus_sign: | N/A |
26
27
  | `committedPrice` | [models.CommitmentPriceInput](../../sdk/models/commitment-price-input.md) | :heavy_minus_sign: | N/A |
27
28
  | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate is exclusive; omit it for an open-ended commitment, which bills every period until terminated. |
28
29
  | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
30
+ | `instalmentInvoicing` | [models.InstalmentDelivery](../../sdk/models/instalment-delivery.md) | :heavy_minus_sign: | N/A |
29
31
  | `invoiceDescription` | *string* | :heavy_minus_sign: | N/A |
30
32
  | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
31
33
  | `measurement` | [models.CommitmentMeasurement](../../sdk/models/commitment-measurement.md) | :heavy_check_mark: | N/A |
@@ -34,7 +36,7 @@ let value: CreateCommitmentRequest = {
34
36
  | `overagePrice` | [models.CommitmentPriceInput](../../sdk/models/commitment-price-input.md) | :heavy_minus_sign: | N/A |
35
37
  | `priority` | *number* | :heavy_minus_sign: | N/A |
36
38
  | `scope` | [models.CommitmentScopeInput](../../sdk/models/commitment-scope-input.md) | :heavy_check_mark: | N/A |
37
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A |
39
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | StartDate and EndDate must be whole seconds. |
38
40
  | `subscriptionId` | *string* | :heavy_minus_sign: | SubscriptionID is required on POST /commitments and set server-side on inline commitments. |
39
41
  | `timezone` | *string* | :heavy_minus_sign: | N/A |
40
42
  | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/get-commitment-billing-terms-request.md ADDED
@@ -0,0 +1,17 @@
1
+ # GetCommitmentBillingTermsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GetCommitmentBillingTermsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GetCommitmentBillingTermsRequest = {
9
+ id: "<id>",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------ | ------------------ | ------------------ | ------------------ |
17
+ | `id` | *string* | :heavy_check_mark: | Commitment ID |
package/docs/sdk/models/instalment-bill-trigger.md ADDED
@@ -0,0 +1,17 @@
1
+ # InstalmentBillTrigger
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InstalmentBillTrigger } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InstalmentBillTrigger = "manual";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "date" | "manual" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/instalment-delivery.md ADDED
@@ -0,0 +1,17 @@
1
+ # InstalmentDelivery
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InstalmentDelivery } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InstalmentDelivery = "separate_invoice";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "subscription_invoice" | "separate_invoice" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/instalment-kind.md ADDED
@@ -0,0 +1,17 @@
1
+ # InstalmentKind
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InstalmentKind } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InstalmentKind = "settlement";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "instalment" | "settlement" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/instalment-status.md ADDED
@@ -0,0 +1,17 @@
1
+ # InstalmentStatus
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InstalmentStatus } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InstalmentStatus = "cancelled";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "scheduled" | "invoiced" | "cancelled" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/invoice-billing-reason.md CHANGED
@@ -11,5 +11,5 @@ let value: InvoiceBillingReason = "SUBSCRIPTION_TRIAL_END";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP" | "SUBSCRIPTION_PAUSED" | "SUBSCRIPTION_RESUME"
14
+ "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP" | "SUBSCRIPTION_PAUSED" | "SUBSCRIPTION_RESUME" | "BILLING_TERMS"
15
15
  ```
package/docs/sdk/models/invoice-line-item-response.md CHANGED
@@ -14,6 +14,7 @@ let value: InvoiceLineItemResponse = {};
14
14
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `adjustedEntitlementQuantity` | *string* | :heavy_minus_sign: | adjusted_entitlement_quantity is the entitlement-covered portion deducted from raw usage.<br/>Nil when no entitlement was applied. Raw usage = Quantity + AdjustedEntitlementQuantity. |
16
16
  | `amount` | *string* | :heavy_minus_sign: | N/A |
17
+ | `billingInstalmentId` | *string* | :heavy_minus_sign: | billing_instalment_id links this line item to the billing instalment it bills. |
17
18
  | `commitmentId` | *string* | :heavy_minus_sign: | commitment_id links this line item to the commitment it bills. |
18
19
  | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
19
20
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/list-commitment-instalments-request.md ADDED
@@ -0,0 +1,18 @@
1
+ # ListCommitmentInstalmentsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListCommitmentInstalmentsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListCommitmentInstalmentsRequest = {
9
+ id: "<id>",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
17
+ | `id` | *string* | :heavy_check_mark: | Commitment ID |
18
+ | `status` | *string*[] | :heavy_minus_sign: | Only instalments in these statuses (scheduled, invoiced, cancelled) |
package/docs/sdk/models/list-instalments-response.md ADDED
@@ -0,0 +1,15 @@
1
+ # ListInstalmentsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListInstalmentsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListInstalmentsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
15
+ | `items` | [models.BillingtermInstalment](../../sdk/models/billingterm-instalment.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/preview-commitment-billing-terms-request.md ADDED
@@ -0,0 +1,21 @@
1
+ # PreviewCommitmentBillingTermsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PreviewCommitmentBillingTermsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PreviewCommitmentBillingTermsRequest = {
9
+ id: "<id>",
10
+ body: {
11
+ billingTerms: [],
12
+ },
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description |
19
+ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
20
+ | `id` | *string* | :heavy_check_mark: | Commitment ID |
21
+ | `body` | [models.ReplaceBillingTermsRequest](../../sdk/models/replace-billing-terms-request.md) | :heavy_check_mark: | Billing terms |
package/docs/sdk/models/replace-billing-terms-request.md ADDED
@@ -0,0 +1,17 @@
1
+ # ReplaceBillingTermsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ReplaceBillingTermsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ReplaceBillingTermsRequest = {
9
+ billingTerms: [],
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
17
+ | `billingTerms` | [models.BillingTermInput](../../sdk/models/billing-term-input.md)[] | :heavy_check_mark: | N/A |
package/docs/sdk/models/replace-commitment-billing-terms-request.md ADDED
@@ -0,0 +1,21 @@
1
+ # ReplaceCommitmentBillingTermsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ReplaceCommitmentBillingTermsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ReplaceCommitmentBillingTermsRequest = {
9
+ id: "<id>",
10
+ body: {
11
+ billingTerms: [],
12
+ },
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description |
19
+ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
20
+ | `id` | *string* | :heavy_check_mark: | Commitment ID |
21
+ | `body` | [models.ReplaceBillingTermsRequest](../../sdk/models/replace-billing-terms-request.md) | :heavy_check_mark: | Billing terms |
package/docs/sdk/models/terminate-commitment-request.md CHANGED
@@ -12,5 +12,5 @@ let value: TerminateCommitmentRequest = {};
12
12
 
13
13
  | Field | Type | Required | Description |
14
14
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
- | `cancellationFee` | *string* | :heavy_minus_sign: | N/A |
16
- | `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
15
+ | `cancellationFee` | [models.CancellationFeeInput](../../sdk/models/cancellation-fee-input.md) | :heavy_minus_sign: | N/A |
16
+ | `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EffectiveAt defaults to now; a given one must be a whole second. |