@flexprice/sdk 2.1.49-dev.3 → 2.1.49-dev.31

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 (211) hide show
  1. package/docs/sdk/models/add-addon-request.md +13 -13
  2. package/docs/sdk/models/add-addon-to-subscription-request.md +11 -11
  3. package/docs/sdk/models/billingterm-instalment.md +1 -0
  4. package/docs/sdk/models/commitment-info.md +15 -12
  5. package/docs/sdk/models/commitment-response.md +0 -1
  6. package/docs/sdk/models/create-commitment-request.md +0 -1
  7. package/docs/sdk/models/create-customer-request.md +1 -0
  8. package/docs/sdk/models/create-subscription-line-item-request.md +6 -6
  9. package/docs/sdk/models/create-subscription-request.md +5 -4
  10. package/docs/sdk/models/customer-response.md +1 -0
  11. package/docs/sdk/models/customer.md +1 -0
  12. package/docs/sdk/models/get-usage-analytics-request.md +1 -1
  13. package/docs/sdk/models/get-usage-analytics-response.md +10 -8
  14. package/docs/sdk/models/grouped-invoicing-child-request.md +4 -4
  15. package/docs/sdk/models/invoice-payment-failure-reason.md +17 -0
  16. package/docs/sdk/models/payment-response.md +33 -32
  17. package/docs/sdk/models/price-response.md +2 -1
  18. package/docs/sdk/models/settings-override.md +15 -0
  19. package/docs/sdk/models/subscription-config-override.md +16 -0
  20. package/docs/sdk/models/subscription-response-v2.md +1 -0
  21. package/docs/sdk/models/subscription-response.md +1 -0
  22. package/docs/sdk/models/update-customer-request.md +1 -0
  23. package/docs/sdk/models/update-subscription-line-item-request.md +20 -20
  24. package/docs/sdk/models/update-subscription-request.md +1 -0
  25. package/docs/sdk/models/usage-analytic-instalment.md +24 -0
  26. package/docs/sdk/models/usage-analytic-point.md +3 -0
  27. package/docs/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.md +21 -0
  28. package/docs/sdk/models/webhook-dto-payment.md +1 -0
  29. package/docs/sdk/models/webhook-event-name.md +1 -1
  30. package/docs/sdks/scheduledtasks/README.md +0 -143
  31. package/docs/sdks/webhookevents/README.md +69 -0
  32. package/esm/funcs/{scheduled-tasks-schedule-update-billing-period.d.ts → webhook-events-post-webhook-events-invoice-payment-failed.d.ts} +4 -4
  33. package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-failed.d.ts.map +1 -0
  34. package/esm/funcs/{scheduled-tasks-schedule-draft-finalization.js → webhook-events-post-webhook-events-invoice-payment-failed.js} +7 -10
  35. package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-failed.js.map +1 -0
  36. package/esm/lib/config.d.ts +3 -3
  37. package/esm/lib/config.d.ts.map +1 -1
  38. package/esm/lib/config.js +3 -3
  39. package/esm/lib/config.js.map +1 -1
  40. package/esm/sdk/models/add-addon-request.d.ts +1 -1
  41. package/esm/sdk/models/add-addon-to-subscription-request.d.ts +1 -1
  42. package/esm/sdk/models/billingterm-instalment.d.ts +4 -0
  43. package/esm/sdk/models/billingterm-instalment.d.ts.map +1 -1
  44. package/esm/sdk/models/billingterm-instalment.js +2 -0
  45. package/esm/sdk/models/billingterm-instalment.js.map +1 -1
  46. package/esm/sdk/models/commitment-info.d.ts +15 -0
  47. package/esm/sdk/models/commitment-info.d.ts.map +1 -1
  48. package/esm/sdk/models/commitment-info.js +12 -0
  49. package/esm/sdk/models/commitment-info.js.map +1 -1
  50. package/esm/sdk/models/commitment-response.d.ts +0 -1
  51. package/esm/sdk/models/commitment-response.d.ts.map +1 -1
  52. package/esm/sdk/models/commitment-response.js +0 -1
  53. package/esm/sdk/models/commitment-response.js.map +1 -1
  54. package/esm/sdk/models/create-commitment-request.d.ts +0 -2
  55. package/esm/sdk/models/create-commitment-request.d.ts.map +1 -1
  56. package/esm/sdk/models/create-commitment-request.js +0 -1
  57. package/esm/sdk/models/create-commitment-request.js.map +1 -1
  58. package/esm/sdk/models/create-customer-request.d.ts +3 -0
  59. package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
  60. package/esm/sdk/models/create-customer-request.js +2 -0
  61. package/esm/sdk/models/create-customer-request.js.map +1 -1
  62. package/esm/sdk/models/create-subscription-line-item-request.d.ts +16 -1
  63. package/esm/sdk/models/create-subscription-line-item-request.d.ts.map +1 -1
  64. package/esm/sdk/models/create-subscription-line-item-request.js.map +1 -1
  65. package/esm/sdk/models/create-subscription-request.d.ts +13 -1
  66. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  67. package/esm/sdk/models/create-subscription-request.js +2 -0
  68. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  69. package/esm/sdk/models/customer-response.d.ts +2 -0
  70. package/esm/sdk/models/customer-response.d.ts.map +1 -1
  71. package/esm/sdk/models/customer-response.js +2 -0
  72. package/esm/sdk/models/customer-response.js.map +1 -1
  73. package/esm/sdk/models/customer.d.ts +2 -0
  74. package/esm/sdk/models/customer.d.ts.map +1 -1
  75. package/esm/sdk/models/customer.js +2 -0
  76. package/esm/sdk/models/customer.js.map +1 -1
  77. package/esm/sdk/models/get-usage-analytics-request.d.ts +1 -1
  78. package/esm/sdk/models/get-usage-analytics-response.d.ts +12 -0
  79. package/esm/sdk/models/get-usage-analytics-response.d.ts.map +1 -1
  80. package/esm/sdk/models/get-usage-analytics-response.js +4 -0
  81. package/esm/sdk/models/get-usage-analytics-response.js.map +1 -1
  82. package/esm/sdk/models/grouped-invoicing-child-request.d.ts +10 -1
  83. package/esm/sdk/models/grouped-invoicing-child-request.d.ts.map +1 -1
  84. package/esm/sdk/models/grouped-invoicing-child-request.js.map +1 -1
  85. package/esm/sdk/models/index.d.ts +5 -2
  86. package/esm/sdk/models/index.d.ts.map +1 -1
  87. package/esm/sdk/models/index.js +5 -2
  88. package/esm/sdk/models/index.js.map +1 -1
  89. package/esm/sdk/models/invoice-payment-failure-reason.d.ts +11 -0
  90. package/esm/sdk/models/invoice-payment-failure-reason.d.ts.map +1 -0
  91. package/esm/sdk/models/invoice-payment-failure-reason.js +12 -0
  92. package/esm/sdk/models/invoice-payment-failure-reason.js.map +1 -0
  93. package/esm/sdk/models/payment-response.d.ts +4 -0
  94. package/esm/sdk/models/payment-response.d.ts.map +1 -1
  95. package/esm/sdk/models/payment-response.js +2 -0
  96. package/esm/sdk/models/payment-response.js.map +1 -1
  97. package/esm/sdk/models/price-response.d.ts +4 -0
  98. package/esm/sdk/models/price-response.d.ts.map +1 -1
  99. package/esm/sdk/models/price-response.js +1 -0
  100. package/esm/sdk/models/price-response.js.map +1 -1
  101. package/esm/sdk/models/settings-override.d.ts +18 -0
  102. package/esm/sdk/models/settings-override.d.ts.map +1 -0
  103. package/esm/sdk/models/settings-override.js +31 -0
  104. package/esm/sdk/models/settings-override.js.map +1 -0
  105. package/esm/sdk/models/subscription-config-override.d.ts +19 -0
  106. package/esm/sdk/models/subscription-config-override.d.ts.map +1 -0
  107. package/esm/sdk/models/subscription-config-override.js +34 -0
  108. package/esm/sdk/models/subscription-config-override.js.map +1 -0
  109. package/esm/sdk/models/subscription-response-v2.d.ts +2 -0
  110. package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
  111. package/esm/sdk/models/subscription-response-v2.js +2 -0
  112. package/esm/sdk/models/subscription-response-v2.js.map +1 -1
  113. package/esm/sdk/models/subscription-response.d.ts +2 -0
  114. package/esm/sdk/models/subscription-response.d.ts.map +1 -1
  115. package/esm/sdk/models/subscription-response.js +2 -0
  116. package/esm/sdk/models/subscription-response.js.map +1 -1
  117. package/esm/sdk/models/update-customer-request.d.ts +3 -0
  118. package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
  119. package/esm/sdk/models/update-customer-request.js +2 -0
  120. package/esm/sdk/models/update-customer-request.js.map +1 -1
  121. package/esm/sdk/models/update-subscription-line-item-request.d.ts +17 -1
  122. package/esm/sdk/models/update-subscription-line-item-request.d.ts.map +1 -1
  123. package/esm/sdk/models/update-subscription-line-item-request.js.map +1 -1
  124. package/esm/sdk/models/update-subscription-request.d.ts +3 -0
  125. package/esm/sdk/models/update-subscription-request.d.ts.map +1 -1
  126. package/esm/sdk/models/update-subscription-request.js +2 -0
  127. package/esm/sdk/models/update-subscription-request.js.map +1 -1
  128. package/esm/sdk/models/usage-analytic-instalment.d.ts +22 -0
  129. package/esm/sdk/models/usage-analytic-instalment.d.ts.map +1 -0
  130. package/esm/sdk/models/usage-analytic-instalment.js +34 -0
  131. package/esm/sdk/models/usage-analytic-instalment.js.map +1 -0
  132. package/esm/sdk/models/usage-analytic-point.d.ts +6 -0
  133. package/esm/sdk/models/usage-analytic-point.d.ts.map +1 -1
  134. package/esm/sdk/models/usage-analytic-point.js +6 -0
  135. package/esm/sdk/models/usage-analytic-point.js.map +1 -1
  136. package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.d.ts +20 -0
  137. package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.d.ts.map +1 -0
  138. package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.js +31 -0
  139. package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.js.map +1 -0
  140. package/esm/sdk/models/webhook-dto-payment.d.ts +1 -0
  141. package/esm/sdk/models/webhook-dto-payment.d.ts.map +1 -1
  142. package/esm/sdk/models/webhook-dto-payment.js +2 -0
  143. package/esm/sdk/models/webhook-dto-payment.js.map +1 -1
  144. package/esm/sdk/models/webhook-event-name.d.ts +1 -0
  145. package/esm/sdk/models/webhook-event-name.d.ts.map +1 -1
  146. package/esm/sdk/models/webhook-event-name.js +1 -0
  147. package/esm/sdk/models/webhook-event-name.js.map +1 -1
  148. package/esm/sdk/scheduled-tasks.d.ts +0 -14
  149. package/esm/sdk/scheduled-tasks.d.ts.map +1 -1
  150. package/esm/sdk/scheduled-tasks.js +0 -20
  151. package/esm/sdk/scheduled-tasks.js.map +1 -1
  152. package/esm/sdk/webhook-events.d.ts +7 -0
  153. package/esm/sdk/webhook-events.d.ts.map +1 -1
  154. package/esm/sdk/webhook-events.js +10 -0
  155. package/esm/sdk/webhook-events.js.map +1 -1
  156. package/jsr.json +1 -1
  157. package/package.json +2 -2
  158. package/src/funcs/{scheduled-tasks-schedule-draft-finalization.ts → webhook-events-post-webhook-events-invoice-payment-failed.ts} +13 -19
  159. package/src/lib/config.ts +4 -3
  160. package/src/sdk/models/add-addon-request.ts +1 -1
  161. package/src/sdk/models/add-addon-to-subscription-request.ts +1 -1
  162. package/src/sdk/models/billingterm-instalment.ts +6 -0
  163. package/src/sdk/models/commitment-info.ts +29 -0
  164. package/src/sdk/models/commitment-response.ts +0 -2
  165. package/src/sdk/models/create-commitment-request.ts +0 -3
  166. package/src/sdk/models/create-customer-request.ts +8 -0
  167. package/src/sdk/models/create-subscription-line-item-request.ts +16 -1
  168. package/src/sdk/models/create-subscription-request.ts +18 -1
  169. package/src/sdk/models/customer-response.ts +6 -0
  170. package/src/sdk/models/customer.ts +6 -0
  171. package/src/sdk/models/get-usage-analytics-request.ts +1 -1
  172. package/src/sdk/models/get-usage-analytics-response.ts +18 -0
  173. package/src/sdk/models/grouped-invoicing-child-request.ts +10 -1
  174. package/src/sdk/models/index.ts +5 -2
  175. package/src/sdk/models/invoice-payment-failure-reason.ts +22 -0
  176. package/src/sdk/models/payment-response.ts +6 -0
  177. package/src/sdk/models/price-response.ts +5 -0
  178. package/src/sdk/models/settings-override.ts +73 -0
  179. package/src/sdk/models/subscription-config-override.ts +71 -0
  180. package/src/sdk/models/subscription-response-v2.ts +6 -0
  181. package/src/sdk/models/subscription-response.ts +6 -0
  182. package/src/sdk/models/update-customer-request.ts +8 -0
  183. package/src/sdk/models/update-subscription-line-item-request.ts +17 -1
  184. package/src/sdk/models/update-subscription-request.ts +8 -0
  185. package/src/sdk/models/usage-analytic-instalment.ts +66 -0
  186. package/src/sdk/models/usage-analytic-point.ts +13 -0
  187. package/src/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.ts +73 -0
  188. package/src/sdk/models/webhook-dto-payment.ts +3 -0
  189. package/src/sdk/models/webhook-event-name.ts +1 -0
  190. package/src/sdk/scheduled-tasks.ts +0 -34
  191. package/src/sdk/webhook-events.ts +16 -0
  192. package/docs/sdk/models/schedule-draft-finalization-response.md +0 -16
  193. package/docs/sdk/models/schedule-update-billing-period-request.md +0 -16
  194. package/docs/sdk/models/schedule-update-billing-period-response.md +0 -16
  195. package/esm/funcs/scheduled-tasks-schedule-draft-finalization.d.ts +0 -17
  196. package/esm/funcs/scheduled-tasks-schedule-draft-finalization.d.ts.map +0 -1
  197. package/esm/funcs/scheduled-tasks-schedule-draft-finalization.js.map +0 -1
  198. package/esm/funcs/scheduled-tasks-schedule-update-billing-period.d.ts.map +0 -1
  199. package/esm/funcs/scheduled-tasks-schedule-update-billing-period.js +0 -73
  200. package/esm/funcs/scheduled-tasks-schedule-update-billing-period.js.map +0 -1
  201. package/esm/sdk/models/schedule-draft-finalization-op.d.ts +0 -11
  202. package/esm/sdk/models/schedule-draft-finalization-op.d.ts.map +0 -1
  203. package/esm/sdk/models/schedule-draft-finalization-op.js +0 -11
  204. package/esm/sdk/models/schedule-draft-finalization-op.js.map +0 -1
  205. package/esm/sdk/models/schedule-update-billing-period-op.d.ts +0 -20
  206. package/esm/sdk/models/schedule-update-billing-period-op.d.ts.map +0 -1
  207. package/esm/sdk/models/schedule-update-billing-period-op.js +0 -16
  208. package/esm/sdk/models/schedule-update-billing-period-op.js.map +0 -1
  209. package/src/funcs/scheduled-tasks-schedule-update-billing-period.ts +0 -157
  210. package/src/sdk/models/schedule-draft-finalization-op.ts +0 -29
  211. package/src/sdk/models/schedule-update-billing-period-op.ts +0 -54
package/docs/sdk/models/add-addon-request.md CHANGED
@@ -13,16 +13,16 @@ let value: AddAddonRequest = {
13
13
 
14
14
  ## Fields
15
15
 
16
- | Field | Type | Required | Description |
17
- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
18
- | `addonId` | *string* | :heavy_check_mark: | N/A |
19
- | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
20
- | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
21
- | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
22
- | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
23
- | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
24
- | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
25
- | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
26
- | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.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: | N/A |
28
- | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
16
+ | Field | Type | Required | Description |
17
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
18
+ | `addonId` | *string* | :heavy_check_mark: | N/A |
19
+ | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
20
+ | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
21
+ | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
22
+ | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
23
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
24
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
25
+ | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
26
+ | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.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: | N/A |
28
+ | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/add-addon-to-subscription-request.md CHANGED
@@ -12,14 +12,14 @@ let value: AddAddonToSubscriptionRequest = {
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
17
- | `addonId` | *string* | :heavy_check_mark: | N/A |
18
- | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
19
- | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
20
- | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
21
- | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
22
- | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
23
- | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
24
- | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
25
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
15
+ | Field | Type | Required | Description |
16
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
17
+ | `addonId` | *string* | :heavy_check_mark: | N/A |
18
+ | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
19
+ | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
20
+ | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
21
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
22
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
23
+ | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
24
+ | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
25
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/billingterm-instalment.md CHANGED
@@ -26,6 +26,7 @@ let value: BillingtermInstalment = {};
26
26
  | `instalmentStatus` | [models.InstalmentStatus](../../sdk/models/instalment-status.md) | :heavy_minus_sign: | N/A |
27
27
  | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
28
28
  | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
29
+ | `invoicedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | InvoicedAt is when the invoice billing the instalment was finalized. |
29
30
  | `kind` | [models.InstalmentKind](../../sdk/models/instalment-kind.md) | :heavy_minus_sign: | N/A |
30
31
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
31
32
  | `ownerId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-info.md CHANGED
@@ -10,15 +10,18 @@ let value: CommitmentInfo = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | N/A |
16
- | `computedCommitmentUtilizedAmount` | *string* | :heavy_minus_sign: | N/A |
17
- | `computedOverageAmount` | *string* | :heavy_minus_sign: | N/A |
18
- | `computedTrueUpAmount` | *string* | :heavy_minus_sign: | total_cost = computed_commitment_utilized_amount + computed_overage_amount + computed_true_up_amount |
19
- | `duration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
20
- | `isWindowed` | *boolean* | :heavy_minus_sign: | N/A |
21
- | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
22
- | `quantity` | *string* | :heavy_minus_sign: | Only used for quantity-based commitments |
23
- | `trueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
24
- | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15
+ | `amount` | *string* | :heavy_minus_sign: | Amount is the commitment amount (v1), or computed_commitment_utilized_amount + computed_true_up_amount (v2). |
16
+ | `computedCommitmentUtilizedAmount` | *string* | :heavy_minus_sign: | N/A |
17
+ | `computedCommitmentUtilizedQuantity` | *string* | :heavy_minus_sign: | Usage units behind the computed amounts: usage a billing-terms commitment covers counts as utilized at no<br/>charge, and a quantity commitment's true-up counts its unused units. |
18
+ | `computedOverageAmount` | *string* | :heavy_minus_sign: | N/A |
19
+ | `computedOverageQuantity` | *string* | :heavy_minus_sign: | N/A |
20
+ | `computedTrueUpAmount` | *string* | :heavy_minus_sign: | total_cost = computed_commitment_utilized_amount + computed_overage_amount + computed_true_up_amount |
21
+ | `computedTrueUpQuantity` | *string* | :heavy_minus_sign: | N/A |
22
+ | `duration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
23
+ | `isWindowed` | *boolean* | :heavy_minus_sign: | N/A |
24
+ | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
25
+ | `quantity` | *string* | :heavy_minus_sign: | Only used for quantity-based commitments |
26
+ | `trueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
27
+ | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-response.md CHANGED
@@ -45,7 +45,6 @@ let value: CommitmentResponse = {};
45
45
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
46
46
  | `terminatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
47
47
  | `terminationInvoiceId` | *string* | :heavy_minus_sign: | N/A |
48
- | `timezone` | *string* | :heavy_minus_sign: | N/A |
49
48
  | `totalAmount` | *string* | :heavy_minus_sign: | N/A |
50
49
  | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
51
50
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-commitment-request.md CHANGED
@@ -38,6 +38,5 @@ let value: CreateCommitmentRequest = {
38
38
  | `scope` | [models.CommitmentScopeInput](../../sdk/models/commitment-scope-input.md) | :heavy_check_mark: | N/A |
39
39
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | StartDate and EndDate within a second after a billing period edge are taken as that edge. |
40
40
  | `subscriptionId` | *string* | :heavy_minus_sign: | SubscriptionID is required on POST /commitments and set server-side on inline commitments. |
41
- | `timezone` | *string* | :heavy_minus_sign: | N/A |
42
41
  | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_check_mark: | N/A |
43
42
  | `value` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-customer-request.md CHANGED
@@ -33,6 +33,7 @@ let value: CreateCustomerRequest = {
33
33
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | metadata contains additional key-value pairs for storing extra information |
34
34
  | `name` | *string* | :heavy_check_mark: | name is the full name or company name of the customer |
35
35
  | `onboardingWorkflowName` | *string* | :heavy_minus_sign: | onboarding_workflow_name is given if a custom onboarding workflow is to be triggered for this customer |
36
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
36
37
  | `skipOnboardingWorkflow` | *boolean* | :heavy_minus_sign: | skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered<br/>This is used internally when a customer is created via a workflow to prevent infinite loops<br/>Default: false |
37
38
  | `taxRateOverrides` | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[] | :heavy_minus_sign: | tax_rate_overrides contains tax rate configurations to be linked to this customer |
38
39
  | `taxTreatment` | [models.TaxTreatment](../../sdk/models/tax-treatment.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-subscription-line-item-request.md CHANGED
@@ -12,14 +12,14 @@ let value: CreateSubscriptionLineItemRequest = {};
12
12
 
13
13
  | Field | Type | Required | Description |
14
14
  | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
15
- | `commitmentAmount` | *number* | :heavy_minus_sign: | Commitment fields |
15
+ | `commitmentAmount` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
16
16
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
17
- | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | N/A |
18
- | `commitmentQuantity` | *number* | :heavy_minus_sign: | N/A |
19
- | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | N/A |
20
- | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
17
+ | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
18
+ | `commitmentQuantity` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
19
+ | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
20
+ | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
21
21
  | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
22
- | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | N/A |
22
+ | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
23
23
  | `displayName` | *string* | :heavy_minus_sign: | N/A |
24
24
  | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
25
25
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-subscription-request.md CHANGED
@@ -24,27 +24,27 @@ let value: CreateSubscriptionRequest = {
24
24
  | `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
25
25
  | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
26
26
  | `collectionMethod` | [models.CollectionMethod](../../sdk/models/collection-method.md) | :heavy_minus_sign: | N/A |
27
- | `commitmentAmount` | *string* | :heavy_minus_sign: | N/A |
27
+ | `commitmentAmount` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
28
28
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
29
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. |
30
30
  | `coupons` | *string*[] | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
31
31
  | `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | N/A |
32
32
  | `currency` | *string* | :heavy_check_mark: | N/A |
33
33
  | `customerId` | *string* | :heavy_minus_sign: | CustomerID takes priority over ExternalCustomerID when both are provided. |
34
- | `enableTrueUp` | *boolean* | :heavy_minus_sign: | N/A |
34
+ | `enableTrueUp` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
35
35
  | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
36
36
  | `externalCustomerId` | *string* | :heavy_minus_sign: | N/A |
37
37
  | `fxRates` | [models.InlineFXRate](../../sdk/models/inline-fx-rate.md)[] | :heavy_minus_sign: | FxRates sets subscription-scope rates to the invoicing customer's billing currency, one per<br/>non-overlapping window. Rejected when nothing needs converting or the pair has no tenant rate. |
38
38
  | `gatewayPaymentMethodId` | *string* | :heavy_minus_sign: | N/A |
39
39
  | `includePriceIds` | *string*[] | :heavy_minus_sign: | IncludePriceIDs selects which plan prices to attach. Nil/omitted attaches matching-cadence<br/>prices plus ONETIME; [] attaches none (LineItems extras still apply); a non-empty list<br/>attaches only those IDs. Each listed ID must belong to the plan, match the subscription<br/>currency, and have a cadence that equals or strictly divides the subscription cadence.<br/>Pointer-slice distinguishes nil from [].<br/>NOTE: no `dive,required` on this tag — swaggo misinterprets `required`<br/>inside `dive` as marking the whole field required, which then shows up<br/>in the OpenAPI schema and breaks callers that omit the field. Per-element<br/>non-emptiness is enforced explicitly in Validate() below. |
40
40
  | `inheritance` | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md) | :heavy_minus_sign: | N/A |
41
- | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments sets per-line-item commitment config, keyed by price_id. |
41
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
42
42
  | `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
43
43
  | `lineItemGrouping` | [models.LineItemGrouping](../../sdk/models/line-item-grouping.md) | :heavy_minus_sign: | N/A |
44
44
  | `lineItems` | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[] | :heavy_minus_sign: | LineItems are extra (non-plan) line items added at creation. |
45
45
  | `lookupKey` | *string* | :heavy_minus_sign: | N/A |
46
46
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
47
- | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
47
+ | `overageFactor` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
48
48
  | `overrideEntitlements` | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[] | :heavy_minus_sign: | N/A |
49
49
  | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems overrides specific plan prices for this subscription. |
50
50
  | `paymentBehavior` | [models.PaymentBehavior](../../sdk/models/payment-behavior.md) | :heavy_minus_sign: | N/A |
@@ -52,6 +52,7 @@ let value: CreateSubscriptionRequest = {
52
52
  | `phases` | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[] | :heavy_minus_sign: | N/A |
53
53
  | `planId` | *string* | :heavy_check_mark: | N/A |
54
54
  | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
55
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
55
56
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
56
57
  | `subscriptionCoupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | SubscriptionCoupons is the preferred way to attach coupons at creation.<br/>Accepts coupon_code; optionally targets a line item via price_id. |
57
58
  | `subscriptionEntitlementGrants` | [models.CreateSubscriptionEntitlementGrantRequest](../../sdk/models/create-subscription-entitlement-grant-request.md)[] | :heavy_minus_sign: | SubscriptionEntitlementGrants are dollar entitlement grants shared by every usage line, created with the subscription. |
package/docs/sdk/models/customer-response.md CHANGED
@@ -33,6 +33,7 @@ let value: CustomerResponse = {};
33
33
  | `integrations` | [models.EntityIntegrationMappingResponse](../../sdk/models/entity-integration-mapping-response.md)[] | :heavy_minus_sign: | N/A |
34
34
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | Metadata |
35
35
  | `name` | *string* | :heavy_minus_sign: | Name is the name of the customer |
36
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
36
37
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
37
38
  | `taxTreatment` | [models.TaxTreatment](../../sdk/models/tax-treatment.md) | :heavy_minus_sign: | N/A |
38
39
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/customer.md CHANGED
@@ -30,6 +30,7 @@ let value: Customer = {};
30
30
  | `id` | *string* | :heavy_minus_sign: | ID is the unique identifier for the customer |
31
31
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | Metadata |
32
32
  | `name` | *string* | :heavy_minus_sign: | Name is the name of the customer |
33
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
33
34
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
34
35
  | `taxTreatment` | [models.TaxTreatment](../../sdk/models/tax-treatment.md) | :heavy_minus_sign: | N/A |
35
36
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |