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

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
@@ -14,7 +14,7 @@ let value: GetUsageAnalyticsRequest = {};
14
14
  | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `breakdownBucket` | *boolean* | :heavy_minus_sign: | BreakdownBucket when true augments each time-series point with BucketID/PriceID<br/>and appends a BucketSummaries rollup to each item. Requires WindowSize to be set<br/>and the item to be linked to a subscription line item that has CommitmentTimeBuckets.<br/>Default: false (opt-in, backward compatible). |
16
16
  | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
- | `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon" |
17
+ | `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon","source","instalments" |
18
18
  | `externalCustomerId` | *string* | :heavy_minus_sign: | ExternalCustomerID is the single external customer ID.<br/>Optional when ExternalCustomerIDs is provided; required otherwise. |
19
19
  | `featureIds` | *string*[] | :heavy_minus_sign: | N/A |
20
20
  | `groupBy` | *string*[] | :heavy_minus_sign: | allowed values: "source", "feature_id", "properties.<field_name>" |
@@ -44,11 +44,13 @@ let value: GetUsageAnalyticsResponse = {
44
44
 
45
45
  ## Fields
46
46
 
47
- | Field | Type | Required | Description |
48
- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
49
- | `currency` | *string* | :heavy_minus_sign: | N/A |
50
- | `customAnalytics` | [models.CustomAnalyticItem](../../sdk/models/custom-analytic-item.md)[] | :heavy_minus_sign: | N/A |
51
- | `items` | [models.UsageAnalyticItem](../../sdk/models/usage-analytic-item.md)[] | :heavy_minus_sign: | N/A |
52
- | `subtotal` | *string* | :heavy_minus_sign: | N/A |
53
- | `totalCost` | *string* | :heavy_minus_sign: | TotalCost is the final cost after discount (Subtotal - TotalDiscount) |
54
- | `totalDiscount` | *string* | :heavy_minus_sign: | N/A |
47
+ | Field | Type | Required | Description |
48
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
50
+ | `customAnalytics` | [models.CustomAnalyticItem](../../sdk/models/custom-analytic-item.md)[] | :heavy_minus_sign: | N/A |
51
+ | `instalments` | [models.UsageAnalyticInstalment](../../sdk/models/usage-analytic-instalment.md)[] | :heavy_minus_sign: | Instalments lists, with expand "instalments", the instalments invoiced in the range for the v2 commitments covering<br/>a queried meter; it is empty with property or source filters, or when no usage line runs in the range. |
52
+ | `items` | [models.UsageAnalyticItem](../../sdk/models/usage-analytic-item.md)[] | :heavy_minus_sign: | N/A |
53
+ | `subtotal` | *string* | :heavy_minus_sign: | N/A |
54
+ | `totalCost` | *string* | :heavy_minus_sign: | TotalCost is the final cost after discount (Subtotal - TotalDiscount) |
55
+ | `totalCostWithInstalments` | *string* | :heavy_minus_sign: | TotalCostWithInstalments is TotalCost plus the amounts of Instalments, set when expand includes "instalments". |
56
+ | `totalDiscount` | *string* | :heavy_minus_sign: | N/A |
@@ -16,16 +16,16 @@ let value: GroupedInvoicingChildRequest = {
16
16
  | Field | Type | Required | Description |
17
17
  | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
18
18
  | `addons` | [models.AddAddonToSubscriptionRequest](../../sdk/models/add-addon-to-subscription-request.md)[] | :heavy_minus_sign: | N/A |
19
- | `commitmentAmount` | *string* | :heavy_minus_sign: | N/A |
19
+ | `commitmentAmount` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
20
20
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
21
21
  | `coupons` | *string*[] | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
22
22
  | `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | N/A |
23
- | `enableTrueUp` | *boolean* | :heavy_minus_sign: | N/A |
23
+ | `enableTrueUp` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
24
24
  | `externalCustomerId` | *string* | :heavy_check_mark: | N/A |
25
- | `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. |
25
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
26
26
  | `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
27
27
  | `lineItems` | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[] | :heavy_minus_sign: | LineItems are extra (non-plan) line items added at creation. |
28
- | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
28
+ | `overageFactor` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
29
29
  | `overrideEntitlements` | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[] | :heavy_minus_sign: | N/A |
30
30
  | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems overrides specific plan prices for this subscription. |
31
31
  | `phases` | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[] | :heavy_minus_sign: | N/A |
@@ -0,0 +1,17 @@
1
+ # InvoicePaymentFailureReason
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InvoicePaymentFailureReason } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InvoicePaymentFailureReason = "provider_error";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "payment_method_unavailable" | "provider_error" | "declined" | Unrecognized<string>
17
+ ```
@@ -10,35 +10,36 @@ let value: PaymentResponse = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | N/A |
16
- | `attempts` | [models.PaymentAttemptResponse](../../sdk/models/payment-attempt-response.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
- | `currency` | *string* | :heavy_minus_sign: | N/A |
20
- | `destinationId` | *string* | :heavy_minus_sign: | N/A |
21
- | `destinationType` | [models.PaymentDestinationType](../../sdk/models/payment-destination-type.md) | :heavy_minus_sign: | N/A |
22
- | `environmentId` | *string* | :heavy_minus_sign: | N/A |
23
- | `errorMessage` | *string* | :heavy_minus_sign: | N/A |
24
- | `failedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
25
- | `gatewayMetadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
26
- | `gatewayPaymentId` | *string* | :heavy_minus_sign: | N/A |
27
- | `gatewayTrackingId` | *string* | :heavy_minus_sign: | N/A |
28
- | `id` | *string* | :heavy_minus_sign: | N/A |
29
- | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
30
- | `invoiceNumber` | *string* | :heavy_minus_sign: | N/A |
31
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
32
- | `paymentGateway` | *string* | :heavy_minus_sign: | N/A |
33
- | `paymentMethodId` | *string* | :heavy_minus_sign: | N/A |
34
- | `paymentMethodType` | [models.PaymentMethodType](../../sdk/models/payment-method-type.md) | :heavy_minus_sign: | N/A |
35
- | `paymentStatus` | [models.PaymentStatus](../../sdk/models/payment-status.md) | :heavy_minus_sign: | N/A |
36
- | `paymentUrl` | *string* | :heavy_minus_sign: | N/A |
37
- | `refundedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
38
- | `saveCardAndMakeDefault` | *boolean* | :heavy_minus_sign: | N/A |
39
- | `succeededAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
40
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
41
- | `trackAttempts` | *boolean* | :heavy_minus_sign: | N/A |
42
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
43
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
44
- | `voidedAt` | [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
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `attempts` | [models.PaymentAttemptResponse](../../sdk/models/payment-attempt-response.md)[] | :heavy_minus_sign: | N/A |
17
+ | `connectionId` | *string* | :heavy_minus_sign: | connection_id is the connection that took this payment; null when no gateway connection was used |
18
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
20
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
21
+ | `destinationId` | *string* | :heavy_minus_sign: | N/A |
22
+ | `destinationType` | [models.PaymentDestinationType](../../sdk/models/payment-destination-type.md) | :heavy_minus_sign: | N/A |
23
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
24
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A |
25
+ | `failedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
26
+ | `gatewayMetadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
27
+ | `gatewayPaymentId` | *string* | :heavy_minus_sign: | N/A |
28
+ | `gatewayTrackingId` | *string* | :heavy_minus_sign: | N/A |
29
+ | `id` | *string* | :heavy_minus_sign: | N/A |
30
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
31
+ | `invoiceNumber` | *string* | :heavy_minus_sign: | N/A |
32
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
33
+ | `paymentGateway` | *string* | :heavy_minus_sign: | N/A |
34
+ | `paymentMethodId` | *string* | :heavy_minus_sign: | N/A |
35
+ | `paymentMethodType` | [models.PaymentMethodType](../../sdk/models/payment-method-type.md) | :heavy_minus_sign: | N/A |
36
+ | `paymentStatus` | [models.PaymentStatus](../../sdk/models/payment-status.md) | :heavy_minus_sign: | N/A |
37
+ | `paymentUrl` | *string* | :heavy_minus_sign: | N/A |
38
+ | `refundedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
39
+ | `saveCardAndMakeDefault` | *boolean* | :heavy_minus_sign: | N/A |
40
+ | `succeededAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
41
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
42
+ | `trackAttempts` | *boolean* | :heavy_minus_sign: | N/A |
43
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
44
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
45
+ | `voidedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
@@ -88,4 +88,5 @@ let value: PriceResponse = {
88
88
  | `trialPeriodDays` | *number* | :heavy_minus_sign: | TrialPeriodDays is the number of days for the trial period<br/>Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING) |
89
89
  | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
90
90
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
91
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
91
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
92
+ | `warnings` | *string*[] | :heavy_minus_sign: | Warnings lists defaults applied on create that the caller may want to set explicitly. |
@@ -0,0 +1,15 @@
1
+ # SettingsOverride
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SettingsOverride } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SettingsOverride = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
15
+ | `subscriptionConfig` | [models.SubscriptionConfigOverride](../../sdk/models/subscription-config-override.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,16 @@
1
+ # SubscriptionConfigOverride
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionConfigOverride } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionConfigOverride = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
15
+ | `autoCancellationEnabled` | *boolean* | :heavy_minus_sign: | N/A |
16
+ | `gracePeriodDays` | *number* | :heavy_minus_sign: | N/A |
@@ -126,6 +126,7 @@ let value: SubscriptionResponseV2 = {
126
126
  | `planId` | *string* | :heavy_minus_sign: | PlanID is the identifier for the plan in our system |
127
127
  | `planPricesOutOfSync` | *boolean* | :heavy_minus_sign: | PlanPricesOutOfSync is true when the subscription's synced_price_sequence<br/>is behind the plan's current max prices.sequence — i.e. plan-price<br/>changes have not yet been reconciled into this subscription's line items. |
128
128
  | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
129
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
129
130
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate is the start date of the subscription |
130
131
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
131
132
  | `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
@@ -165,6 +165,7 @@ let value: SubscriptionResponse = {
165
165
  | `plan` | [models.PlanResponse](../../sdk/models/plan-response.md) | :heavy_minus_sign: | N/A |
166
166
  | `planId` | *string* | :heavy_minus_sign: | PlanID is the identifier for the plan in our system |
167
167
  | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
168
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
168
169
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate is the start date of the subscription |
169
170
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
170
171
  | `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
@@ -29,5 +29,6 @@ let value: UpdateCustomerRequest = {};
29
29
  | `integrationEntityMapping` | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[] | :heavy_minus_sign: | integration_entity_mapping contains provider integration mappings for this customer |
30
30
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | metadata contains updated key-value pairs that will replace existing metadata |
31
31
  | `name` | *string* | :heavy_minus_sign: | name is the updated name or company name for the customer |
32
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
32
33
  | `taxTreatment` | [models.TaxTreatment](../../sdk/models/tax-treatment.md) | :heavy_minus_sign: | N/A |
33
34
  | `timezone` | *string* | :heavy_minus_sign: | timezone is the updated IANA timezone name for the customer (e.g. "Asia/Kolkata", "America/New_York") |
@@ -10,23 +10,23 @@ let value: UpdateSubscriptionLineItemRequest = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | Amount is the new price amount that overrides the original price |
16
- | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
17
- | `bucketSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
18
- | `commitmentAmount` | *number* | :heavy_minus_sign: | Commitment fields |
19
- | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
20
- | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | N/A |
21
- | `commitmentQuantity` | *number* | :heavy_minus_sign: | N/A |
22
- | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | Pointer so an explicit empty array can clear existing buckets (omission keeps them). |
23
- | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
24
- | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
25
- | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | N/A |
26
- | `effectiveFrom` | *string* | :heavy_minus_sign: | EffectiveFrom for the existing line item (if not provided, defaults to now) |
27
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | Metadata for the new line item |
28
- | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount for a CUSTOM price unit price (FLAT_FEE/PACKAGE billing models) |
29
- | `priceUnitTiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for a CUSTOM price unit price (TIERED billing model) |
30
- | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
31
- | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | Tiers determines the pricing tiers for this line item |
32
- | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | Amount is the new price amount that overrides the original price |
16
+ | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
17
+ | `bucketSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
18
+ | `commitmentAmount` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
19
+ | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
20
+ | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
21
+ | `commitmentQuantity` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
22
+ | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | Pointer so an explicit empty array can clear existing buckets (omission keeps them).<br/><br/>Deprecated: use POST /commitments instead. |
23
+ | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
24
+ | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
25
+ | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
26
+ | `effectiveFrom` | *string* | :heavy_minus_sign: | EffectiveFrom for the existing line item (if not provided, defaults to now) |
27
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | Metadata for the new line item |
28
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount for a CUSTOM price unit price (FLAT_FEE/PACKAGE billing models) |
29
+ | `priceUnitTiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for a CUSTOM price unit price (TIERED billing model) |
30
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
31
+ | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | Tiers determines the pricing tiers for this line item |
32
+ | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
@@ -16,4 +16,5 @@ let value: UpdateSubscriptionRequest = {};
16
16
  | `cancelAtPeriodEnd` | *boolean* | :heavy_minus_sign: | Pointer so omitting the field leaves the stored value unchanged; sending it sets the flag. |
17
17
  | `parentSubscriptionId` | *string* | :heavy_minus_sign: | ParentSubscriptionID sets or clears the parent subscription. Omit to leave unchanged; send "" to clear. |
18
18
  | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
19
+ | `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
19
20
  | `status` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
@@ -0,0 +1,24 @@
1
+ # UsageAnalyticInstalment
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UsageAnalyticInstalment } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UsageAnalyticInstalment = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `commitmentId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
18
+ | `id` | *string* | :heavy_minus_sign: | N/A |
19
+ | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
20
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
21
+ | `invoicedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | when the invoice billing it was finalized |
22
+ | `servicePeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
23
+ | `servicePeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
24
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
@@ -14,8 +14,11 @@ let value: UsageAnalyticPoint = {};
14
14
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `buckets` | [models.PointBucket](../../sdk/models/point-bucket.md)[] | :heavy_minus_sign: | Buckets lists every commitment bucket this (possibly rolled-up) window<br/>overlaps — only populated when BreakdownBucket=true and the line item has<br/>CommitmentTimeBuckets. A coarse window can overlap more than one bucket, and<br/>only partially, so this is a list. Empty when the window touches no bucket.<br/>It is an informational HINT only: the point's single cost/computed_* totals<br/>mix all overlapped buckets and out-of-bucket time and CANNOT be split per<br/>bucket — read bucket_summaries for exact per-bucket cost. |
16
16
  | `computedCommitmentUtilizedAmount` | *string* | :heavy_minus_sign: | Commitment breakdown (only populated for windowed commitments) |
17
+ | `computedCommitmentUtilizedQuantity` | *string* | :heavy_minus_sign: | Usage units behind the commitment breakdown, for v2 commitments |
17
18
  | `computedOverageAmount` | *string* | :heavy_minus_sign: | N/A |
19
+ | `computedOverageQuantity` | *string* | :heavy_minus_sign: | N/A |
18
20
  | `computedTrueUpAmount` | *string* | :heavy_minus_sign: | N/A |
21
+ | `computedTrueUpQuantity` | *string* | :heavy_minus_sign: | N/A |
19
22
  | `cost` | *string* | :heavy_minus_sign: | Cost is the final cost after discount (Subtotal - Discount) |
20
23
  | `discount` | *string* | :heavy_minus_sign: | N/A |
21
24
  | `eventCount` | *number* | :heavy_minus_sign: | Number of events in this time window |