integrateledger 0.1.1 → 0.1.2

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 (238) hide show
  1. package/README.md +63 -57
  2. package/dist/commonjs/funcs/publish-catalog.js +1 -1
  3. package/dist/commonjs/funcs/publish-catalog.js.map +1 -1
  4. package/dist/commonjs/funcs/set-customer-overage-cap.d.ts +16 -0
  5. package/dist/commonjs/funcs/set-customer-overage-cap.d.ts.map +1 -0
  6. package/dist/commonjs/funcs/set-customer-overage-cap.js +122 -0
  7. package/dist/commonjs/funcs/set-customer-overage-cap.js.map +1 -0
  8. package/dist/commonjs/funcs/set-customer-overage-override.d.ts +16 -0
  9. package/dist/commonjs/funcs/set-customer-overage-override.d.ts.map +1 -0
  10. package/dist/commonjs/funcs/set-customer-overage-override.js +122 -0
  11. package/dist/commonjs/funcs/set-customer-overage-override.js.map +1 -0
  12. package/dist/commonjs/funcs/set-subscription-cancellation.js +1 -1
  13. package/dist/commonjs/funcs/set-subscription-cancellation.js.map +1 -1
  14. package/dist/commonjs/funcs/update-add-on.js +1 -1
  15. package/dist/commonjs/funcs/update-add-on.js.map +1 -1
  16. package/dist/commonjs/funcs/update-feature.js +1 -1
  17. package/dist/commonjs/funcs/update-feature.js.map +1 -1
  18. package/dist/commonjs/funcs/update-plan.js +1 -1
  19. package/dist/commonjs/funcs/update-plan.js.map +1 -1
  20. package/dist/commonjs/lib/config.d.ts +2 -2
  21. package/dist/commonjs/lib/config.js +2 -2
  22. package/dist/commonjs/models/catalog-input.d.ts +15 -0
  23. package/dist/commonjs/models/catalog-input.d.ts.map +1 -1
  24. package/dist/commonjs/models/catalog-input.js +3 -0
  25. package/dist/commonjs/models/catalog-input.js.map +1 -1
  26. package/dist/commonjs/models/check-response.d.ts +3 -0
  27. package/dist/commonjs/models/check-response.d.ts.map +1 -1
  28. package/dist/commonjs/models/check-response.js.map +1 -1
  29. package/dist/commonjs/models/create-plan-input.d.ts +15 -0
  30. package/dist/commonjs/models/create-plan-input.d.ts.map +1 -1
  31. package/dist/commonjs/models/create-plan-input.js +3 -0
  32. package/dist/commonjs/models/create-plan-input.js.map +1 -1
  33. package/dist/commonjs/models/customer-detail.d.ts +6 -0
  34. package/dist/commonjs/models/customer-detail.d.ts.map +1 -1
  35. package/dist/commonjs/models/customer-detail.js +3 -0
  36. package/dist/commonjs/models/customer-detail.js.map +1 -1
  37. package/dist/commonjs/models/customer-overage-cap.d.ts +13 -0
  38. package/dist/commonjs/models/customer-overage-cap.d.ts.map +1 -0
  39. package/dist/commonjs/models/customer-overage-cap.js +54 -0
  40. package/dist/commonjs/models/customer-overage-cap.js.map +1 -0
  41. package/dist/commonjs/models/customer-overage-override-result.d.ts +18 -0
  42. package/dist/commonjs/models/customer-overage-override-result.d.ts.map +1 -0
  43. package/dist/commonjs/models/customer-overage-override-result.js +56 -0
  44. package/dist/commonjs/models/customer-overage-override-result.js.map +1 -0
  45. package/dist/commonjs/models/customer-overage-override.d.ts +23 -0
  46. package/dist/commonjs/models/customer-overage-override.d.ts.map +1 -0
  47. package/dist/commonjs/models/customer-overage-override.js +55 -0
  48. package/dist/commonjs/models/customer-overage-override.js.map +1 -0
  49. package/dist/commonjs/models/customer-overage.d.ts +67 -0
  50. package/dist/commonjs/models/customer-overage.d.ts.map +1 -0
  51. package/dist/commonjs/models/customer-overage.js +83 -0
  52. package/dist/commonjs/models/customer-overage.js.map +1 -0
  53. package/dist/commonjs/models/errors/track-error.d.ts +2 -0
  54. package/dist/commonjs/models/errors/track-error.d.ts.map +1 -1
  55. package/dist/commonjs/models/errors/track-error.js +5 -0
  56. package/dist/commonjs/models/errors/track-error.js.map +1 -1
  57. package/dist/commonjs/models/index.d.ts +6 -0
  58. package/dist/commonjs/models/index.d.ts.map +1 -1
  59. package/dist/commonjs/models/index.js +6 -0
  60. package/dist/commonjs/models/index.js.map +1 -1
  61. package/dist/commonjs/models/operations/index.d.ts +2 -0
  62. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  63. package/dist/commonjs/models/operations/index.js +2 -0
  64. package/dist/commonjs/models/operations/index.js.map +1 -1
  65. package/dist/commonjs/models/operations/set-customer-overage-cap.d.ts +15 -0
  66. package/dist/commonjs/models/operations/set-customer-overage-cap.d.ts.map +1 -0
  67. package/dist/commonjs/models/operations/set-customer-overage-cap.js +51 -0
  68. package/dist/commonjs/models/operations/set-customer-overage-cap.js.map +1 -0
  69. package/dist/commonjs/models/operations/set-customer-overage-override.d.ts +15 -0
  70. package/dist/commonjs/models/operations/set-customer-overage-override.d.ts.map +1 -0
  71. package/dist/commonjs/models/operations/set-customer-overage-override.js +51 -0
  72. package/dist/commonjs/models/operations/set-customer-overage-override.js.map +1 -0
  73. package/dist/commonjs/models/plan-item.d.ts +12 -0
  74. package/dist/commonjs/models/plan-item.d.ts.map +1 -1
  75. package/dist/commonjs/models/plan-item.js +3 -0
  76. package/dist/commonjs/models/plan-item.js.map +1 -1
  77. package/dist/commonjs/models/set-customer-overage-cap-input.d.ts +15 -0
  78. package/dist/commonjs/models/set-customer-overage-cap-input.d.ts.map +1 -0
  79. package/dist/commonjs/models/set-customer-overage-cap-input.js +49 -0
  80. package/dist/commonjs/models/set-customer-overage-cap-input.js.map +1 -0
  81. package/dist/commonjs/models/set-customer-overage-override-input.d.ts +30 -0
  82. package/dist/commonjs/models/set-customer-overage-override-input.d.ts.map +1 -0
  83. package/dist/commonjs/models/set-customer-overage-override-input.js +52 -0
  84. package/dist/commonjs/models/set-customer-overage-override-input.js.map +1 -0
  85. package/dist/commonjs/models/track-response.d.ts +11 -0
  86. package/dist/commonjs/models/track-response.d.ts.map +1 -1
  87. package/dist/commonjs/models/track-response.js +2 -0
  88. package/dist/commonjs/models/track-response.js.map +1 -1
  89. package/dist/commonjs/models/update-plan-input.d.ts +15 -0
  90. package/dist/commonjs/models/update-plan-input.d.ts.map +1 -1
  91. package/dist/commonjs/models/update-plan-input.js +3 -0
  92. package/dist/commonjs/models/update-plan-input.js.map +1 -1
  93. package/dist/commonjs/sdk/sdk.d.ts +8 -0
  94. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  95. package/dist/commonjs/sdk/sdk.js +14 -0
  96. package/dist/commonjs/sdk/sdk.js.map +1 -1
  97. package/dist/esm/funcs/publish-catalog.js +1 -1
  98. package/dist/esm/funcs/publish-catalog.js.map +1 -1
  99. package/dist/esm/funcs/set-customer-overage-cap.d.ts +16 -0
  100. package/dist/esm/funcs/set-customer-overage-cap.d.ts.map +1 -0
  101. package/dist/esm/funcs/set-customer-overage-cap.js +86 -0
  102. package/dist/esm/funcs/set-customer-overage-cap.js.map +1 -0
  103. package/dist/esm/funcs/set-customer-overage-override.d.ts +16 -0
  104. package/dist/esm/funcs/set-customer-overage-override.d.ts.map +1 -0
  105. package/dist/esm/funcs/set-customer-overage-override.js +86 -0
  106. package/dist/esm/funcs/set-customer-overage-override.js.map +1 -0
  107. package/dist/esm/funcs/set-subscription-cancellation.js +1 -1
  108. package/dist/esm/funcs/set-subscription-cancellation.js.map +1 -1
  109. package/dist/esm/funcs/update-add-on.js +1 -1
  110. package/dist/esm/funcs/update-add-on.js.map +1 -1
  111. package/dist/esm/funcs/update-feature.js +1 -1
  112. package/dist/esm/funcs/update-feature.js.map +1 -1
  113. package/dist/esm/funcs/update-plan.js +1 -1
  114. package/dist/esm/funcs/update-plan.js.map +1 -1
  115. package/dist/esm/lib/config.d.ts +2 -2
  116. package/dist/esm/lib/config.js +2 -2
  117. package/dist/esm/models/catalog-input.d.ts +15 -0
  118. package/dist/esm/models/catalog-input.d.ts.map +1 -1
  119. package/dist/esm/models/catalog-input.js +3 -0
  120. package/dist/esm/models/catalog-input.js.map +1 -1
  121. package/dist/esm/models/check-response.d.ts +3 -0
  122. package/dist/esm/models/check-response.d.ts.map +1 -1
  123. package/dist/esm/models/check-response.js.map +1 -1
  124. package/dist/esm/models/create-plan-input.d.ts +15 -0
  125. package/dist/esm/models/create-plan-input.d.ts.map +1 -1
  126. package/dist/esm/models/create-plan-input.js +3 -0
  127. package/dist/esm/models/create-plan-input.js.map +1 -1
  128. package/dist/esm/models/customer-detail.d.ts +6 -0
  129. package/dist/esm/models/customer-detail.d.ts.map +1 -1
  130. package/dist/esm/models/customer-detail.js +3 -0
  131. package/dist/esm/models/customer-detail.js.map +1 -1
  132. package/dist/esm/models/customer-overage-cap.d.ts +13 -0
  133. package/dist/esm/models/customer-overage-cap.d.ts.map +1 -0
  134. package/dist/esm/models/customer-overage-cap.js +17 -0
  135. package/dist/esm/models/customer-overage-cap.js.map +1 -0
  136. package/dist/esm/models/customer-overage-override-result.d.ts +18 -0
  137. package/dist/esm/models/customer-overage-override-result.d.ts.map +1 -0
  138. package/dist/esm/models/customer-overage-override-result.js +19 -0
  139. package/dist/esm/models/customer-overage-override-result.js.map +1 -0
  140. package/dist/esm/models/customer-overage-override.d.ts +23 -0
  141. package/dist/esm/models/customer-overage-override.d.ts.map +1 -0
  142. package/dist/esm/models/customer-overage-override.js +18 -0
  143. package/dist/esm/models/customer-overage-override.js.map +1 -0
  144. package/dist/esm/models/customer-overage.d.ts +67 -0
  145. package/dist/esm/models/customer-overage.d.ts.map +1 -0
  146. package/dist/esm/models/customer-overage.js +46 -0
  147. package/dist/esm/models/customer-overage.js.map +1 -0
  148. package/dist/esm/models/errors/track-error.d.ts +2 -0
  149. package/dist/esm/models/errors/track-error.d.ts.map +1 -1
  150. package/dist/esm/models/errors/track-error.js +5 -0
  151. package/dist/esm/models/errors/track-error.js.map +1 -1
  152. package/dist/esm/models/index.d.ts +6 -0
  153. package/dist/esm/models/index.d.ts.map +1 -1
  154. package/dist/esm/models/index.js +6 -0
  155. package/dist/esm/models/index.js.map +1 -1
  156. package/dist/esm/models/operations/index.d.ts +2 -0
  157. package/dist/esm/models/operations/index.d.ts.map +1 -1
  158. package/dist/esm/models/operations/index.js +2 -0
  159. package/dist/esm/models/operations/index.js.map +1 -1
  160. package/dist/esm/models/operations/set-customer-overage-cap.d.ts +15 -0
  161. package/dist/esm/models/operations/set-customer-overage-cap.d.ts.map +1 -0
  162. package/dist/esm/models/operations/set-customer-overage-cap.js +14 -0
  163. package/dist/esm/models/operations/set-customer-overage-cap.js.map +1 -0
  164. package/dist/esm/models/operations/set-customer-overage-override.d.ts +15 -0
  165. package/dist/esm/models/operations/set-customer-overage-override.d.ts.map +1 -0
  166. package/dist/esm/models/operations/set-customer-overage-override.js +14 -0
  167. package/dist/esm/models/operations/set-customer-overage-override.js.map +1 -0
  168. package/dist/esm/models/plan-item.d.ts +12 -0
  169. package/dist/esm/models/plan-item.d.ts.map +1 -1
  170. package/dist/esm/models/plan-item.js +3 -0
  171. package/dist/esm/models/plan-item.js.map +1 -1
  172. package/dist/esm/models/set-customer-overage-cap-input.d.ts +15 -0
  173. package/dist/esm/models/set-customer-overage-cap-input.d.ts.map +1 -0
  174. package/dist/esm/models/set-customer-overage-cap-input.js +12 -0
  175. package/dist/esm/models/set-customer-overage-cap-input.js.map +1 -0
  176. package/dist/esm/models/set-customer-overage-override-input.d.ts +30 -0
  177. package/dist/esm/models/set-customer-overage-override-input.d.ts.map +1 -0
  178. package/dist/esm/models/set-customer-overage-override-input.js +15 -0
  179. package/dist/esm/models/set-customer-overage-override-input.js.map +1 -0
  180. package/dist/esm/models/track-response.d.ts +11 -0
  181. package/dist/esm/models/track-response.d.ts.map +1 -1
  182. package/dist/esm/models/track-response.js +2 -0
  183. package/dist/esm/models/track-response.js.map +1 -1
  184. package/dist/esm/models/update-plan-input.d.ts +15 -0
  185. package/dist/esm/models/update-plan-input.d.ts.map +1 -1
  186. package/dist/esm/models/update-plan-input.js +3 -0
  187. package/dist/esm/models/update-plan-input.js.map +1 -1
  188. package/dist/esm/sdk/sdk.d.ts +8 -0
  189. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  190. package/dist/esm/sdk/sdk.js +14 -0
  191. package/dist/esm/sdk/sdk.js.map +1 -1
  192. package/docs/models/cap-source.md +19 -0
  193. package/docs/models/check-response.md +5 -5
  194. package/docs/models/create-plan-input.md +9 -6
  195. package/docs/models/customer-detail.md +28 -6
  196. package/docs/models/customer-overage-cap.md +39 -0
  197. package/docs/models/customer-overage-override-result.md +47 -0
  198. package/docs/models/customer-overage-override.md +27 -0
  199. package/docs/models/customer-overage.md +37 -0
  200. package/docs/models/errors/track-error.md +6 -5
  201. package/docs/models/operations/set-customer-overage-cap-request.md +21 -0
  202. package/docs/models/operations/set-customer-overage-override-request.md +21 -0
  203. package/docs/models/plan-item.md +10 -7
  204. package/docs/models/plan.md +9 -6
  205. package/docs/models/set-customer-overage-cap-input.md +17 -0
  206. package/docs/models/set-customer-overage-override-input.md +20 -0
  207. package/docs/models/source.md +19 -0
  208. package/docs/models/track-response.md +12 -8
  209. package/docs/models/update-plan-input.md +8 -5
  210. package/docs/sdks/ledger/README.md +167 -5
  211. package/package.json +1 -1
  212. package/src/funcs/publish-catalog.ts +1 -1
  213. package/src/funcs/set-customer-overage-cap.ts +176 -0
  214. package/src/funcs/set-customer-overage-override.ts +179 -0
  215. package/src/funcs/set-subscription-cancellation.ts +1 -1
  216. package/src/funcs/update-add-on.ts +1 -1
  217. package/src/funcs/update-feature.ts +1 -1
  218. package/src/funcs/update-plan.ts +1 -1
  219. package/src/lib/config.ts +2 -2
  220. package/src/models/catalog-input.ts +18 -0
  221. package/src/models/check-response.ts +3 -0
  222. package/src/models/create-plan-input.ts +18 -0
  223. package/src/models/customer-detail.ts +11 -0
  224. package/src/models/customer-overage-cap.ts +39 -0
  225. package/src/models/customer-overage-override-result.ts +48 -0
  226. package/src/models/customer-overage-override.ts +48 -0
  227. package/src/models/customer-overage.ts +108 -0
  228. package/src/models/errors/track-error.ts +6 -0
  229. package/src/models/index.ts +6 -0
  230. package/src/models/operations/index.ts +2 -0
  231. package/src/models/operations/set-customer-overage-cap.ts +36 -0
  232. package/src/models/operations/set-customer-overage-override.ts +36 -0
  233. package/src/models/plan-item.ts +15 -0
  234. package/src/models/set-customer-overage-cap-input.ts +33 -0
  235. package/src/models/set-customer-overage-override-input.ts +53 -0
  236. package/src/models/track-response.ts +13 -0
  237. package/src/models/update-plan-input.ts +18 -0
  238. package/src/sdk/sdk.ts +30 -0
@@ -0,0 +1,47 @@
1
+ # CustomerOverageOverrideResult
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CustomerOverageOverrideResult } from "integrateledger/models";
7
+
8
+ let value: CustomerOverageOverrideResult = {
9
+ customerId: "<id>",
10
+ planId: "<id>",
11
+ override: {
12
+ planId: "<id>",
13
+ unitAmountCents: 79626,
14
+ billingUnits: 329657,
15
+ capCents: null,
16
+ effectiveFrom: new Date("2025-08-27T01:33:36.832Z"),
17
+ },
18
+ overage: {
19
+ credits: 796457,
20
+ costCents: 552761,
21
+ unitAmountCents: 439398,
22
+ billingUnits: 862453,
23
+ capCents: 993233,
24
+ capSource: "customer",
25
+ remainingCents: 313263,
26
+ source: "override",
27
+ override: {
28
+ planId: "<id>",
29
+ unitAmountCents: 79626,
30
+ billingUnits: 329657,
31
+ capCents: null,
32
+ effectiveFrom: new Date("2025-08-27T01:33:36.832Z"),
33
+ },
34
+ periodStart: new Date("2025-03-12T04:09:16.465Z"),
35
+ periodEnd: new Date("2026-05-12T05:18:43.629Z"),
36
+ },
37
+ };
38
+ ```
39
+
40
+ ## Fields
41
+
42
+ | Field | Type | Required | Description |
43
+ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
44
+ | `customerId` | *string* | :heavy_check_mark: | N/A |
45
+ | `planId` | *string* | :heavy_check_mark: | The scope that was set or cleared. Null: any plan. |
46
+ | `override` | [models.CustomerOverageOverride](../models/customer-overage-override.md) | :heavy_check_mark: | N/A |
47
+ | `overage` | [models.CustomerOverage](../models/customer-overage.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,27 @@
1
+ # CustomerOverageOverride
2
+
3
+ The override behind the rate when source is override. Null otherwise.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CustomerOverageOverride } from "integrateledger/models";
9
+
10
+ let value: CustomerOverageOverride = {
11
+ planId: "<id>",
12
+ unitAmountCents: 633563,
13
+ billingUnits: 407849,
14
+ capCents: 196711,
15
+ effectiveFrom: new Date("2026-10-29T11:19:43.527Z"),
16
+ };
17
+ ```
18
+
19
+ ## Fields
20
+
21
+ | Field | Type | Required | Description |
22
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
23
+ | `planId` | *string* | :heavy_check_mark: | The plan it applies to. Null: any plan. |
24
+ | `unitAmountCents` | *number* | :heavy_check_mark: | N/A |
25
+ | `billingUnits` | *number* | :heavy_check_mark: | N/A |
26
+ | `capCents` | *number* | :heavy_check_mark: | The override's cap. Null: the plan default applies. |
27
+ | `effectiveFrom` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A |
@@ -0,0 +1,37 @@
1
+ # CustomerOverage
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CustomerOverage } from "integrateledger/models";
7
+
8
+ let value: CustomerOverage = {
9
+ credits: 485930,
10
+ costCents: 513445,
11
+ unitAmountCents: 143846,
12
+ billingUnits: 206177,
13
+ capCents: 556912,
14
+ capSource: "plan",
15
+ remainingCents: null,
16
+ source: "plan",
17
+ override: null,
18
+ periodStart: new Date("2024-10-26T12:30:07.250Z"),
19
+ periodEnd: new Date("2026-11-04T07:38:06.531Z"),
20
+ };
21
+ ```
22
+
23
+ ## Fields
24
+
25
+ | Field | Type | Required | Description |
26
+ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
27
+ | `credits` | *number* | :heavy_check_mark: | Overage credits recorded in the current billing period. |
28
+ | `costCents` | *number* | :heavy_check_mark: | This period's overage cost: ceil(credits / billingUnits) × unitAmountCents per recorded rate. |
29
+ | `unitAmountCents` | *number* | :heavy_check_mark: | N/A |
30
+ | `billingUnits` | *number* | :heavy_check_mark: | N/A |
31
+ | `capCents` | *number* | :heavy_check_mark: | Effective monthly overage cap. Null: no cap. |
32
+ | `capSource` | [models.CapSource](../models/cap-source.md) | :heavy_check_mark: | customer: the customer's own cap; override: the customer's overage override; plan: the plan default; null: no cap. |
33
+ | `remainingCents` | *number* | :heavy_check_mark: | N/A |
34
+ | `source` | [models.Source](../models/source.md) | :heavy_check_mark: | Where the overage rate comes from: the plan, or an override set with setCustomerOverageOverride. |
35
+ | `override` | [models.CustomerOverageOverride](../models/customer-overage-override.md) | :heavy_check_mark: | The override behind the rate when source is override. Null otherwise. |
36
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A |
37
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A |
@@ -10,8 +10,9 @@ import { TrackError } from "integrateledger/models/errors";
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------ | ------------------ | ------------------ | ------------------ |
15
- | `error` | *string* | :heavy_check_mark: | N/A |
16
- | `availableCredits` | *number* | :heavy_minus_sign: | N/A |
17
- | `creditCost` | *number* | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
15
+ | `error` | *string* | :heavy_check_mark: | N/A |
16
+ | `availableCredits` | *number* | :heavy_minus_sign: | N/A |
17
+ | `creditCost` | *number* | :heavy_minus_sign: | N/A |
18
+ | `overageRemainingCents` | *number* | :heavy_minus_sign: | N/A |
@@ -0,0 +1,21 @@
1
+ # SetCustomerOverageCapRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SetCustomerOverageCapRequest } from "integrateledger/models/operations";
7
+
8
+ let value: SetCustomerOverageCapRequest = {
9
+ customerId: "<id>",
10
+ body: {
11
+ capCents: null,
12
+ },
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description |
19
+ | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
20
+ | `customerId` | *string* | :heavy_check_mark: | N/A |
21
+ | `body` | [models.SetCustomerOverageCapInput](../../models/set-customer-overage-cap-input.md) | :heavy_check_mark: | N/A |
@@ -0,0 +1,21 @@
1
+ # SetCustomerOverageOverrideRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SetCustomerOverageOverrideRequest } from "integrateledger/models/operations";
7
+
8
+ let value: SetCustomerOverageOverrideRequest = {
9
+ customerId: "<id>",
10
+ body: {
11
+ unitAmountCents: 163411,
12
+ },
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description |
19
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
20
+ | `customerId` | *string* | :heavy_check_mark: | N/A |
21
+ | `body` | [models.SetCustomerOverageOverrideInput](../../models/set-customer-overage-override-input.md) | :heavy_check_mark: | N/A |
@@ -15,10 +15,13 @@ let value: PlanItem = {
15
15
 
16
16
  ## Fields
17
17
 
18
- | Field | Type | Required | Description |
19
- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
20
- | `id` | *string* | :heavy_check_mark: | N/A |
21
- | `name` | *string* | :heavy_check_mark: | N/A |
22
- | `monthlyCredits` | *number* | :heavy_check_mark: | N/A |
23
- | `monthlyPriceCents` | *number* | :heavy_check_mark: | N/A |
24
- | `stripeSyncStatus` | [models.StripeSyncStatus](../models/stripe-sync-status.md) | :heavy_minus_sign: | N/A |
18
+ | Field | Type | Required | Description |
19
+ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
20
+ | `id` | *string* | :heavy_check_mark: | N/A |
21
+ | `name` | *string* | :heavy_check_mark: | N/A |
22
+ | `monthlyCredits` | *number* | :heavy_check_mark: | N/A |
23
+ | `monthlyPriceCents` | *number* | :heavy_check_mark: | N/A |
24
+ | `overageUnitAmountCents` | *number* | :heavy_minus_sign: | Price in cents per overageBillingUnits credits used after the plan's credits and packs run out. Null or omitted: no overage. |
25
+ | `overageBillingUnits` | *number* | :heavy_minus_sign: | Credits billed per overageUnitAmountCents. Defaults to 1. |
26
+ | `overageCapCents` | *number* | :heavy_minus_sign: | Default monthly overage spend cap in cents. A customer's own cap replaces it. Null or omitted: no cap. |
27
+ | `stripeSyncStatus` | [models.StripeSyncStatus](../models/stripe-sync-status.md) | :heavy_minus_sign: | N/A |
@@ -15,9 +15,12 @@ let value: Plan = {
15
15
 
16
16
  ## Fields
17
17
 
18
- | Field | Type | Required | Description |
19
- | ------------------- | ------------------- | ------------------- | ------------------- |
20
- | `id` | *string* | :heavy_check_mark: | N/A |
21
- | `name` | *string* | :heavy_check_mark: | N/A |
22
- | `monthlyCredits` | *number* | :heavy_check_mark: | N/A |
23
- | `monthlyPriceCents` | *number* | :heavy_check_mark: | N/A |
18
+ | Field | Type | Required | Description |
19
+ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
20
+ | `id` | *string* | :heavy_check_mark: | N/A |
21
+ | `name` | *string* | :heavy_check_mark: | N/A |
22
+ | `monthlyCredits` | *number* | :heavy_check_mark: | N/A |
23
+ | `monthlyPriceCents` | *number* | :heavy_check_mark: | N/A |
24
+ | `overageUnitAmountCents` | *number* | :heavy_minus_sign: | Price in cents per overageBillingUnits credits used after the plan's credits and packs run out. Null or omitted: no overage. |
25
+ | `overageBillingUnits` | *number* | :heavy_minus_sign: | Credits billed per overageUnitAmountCents. Defaults to 1. |
26
+ | `overageCapCents` | *number* | :heavy_minus_sign: | Default monthly overage spend cap in cents. A customer's own cap replaces it. Null or omitted: no cap. |
@@ -0,0 +1,17 @@
1
+ # SetCustomerOverageCapInput
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SetCustomerOverageCapInput } from "integrateledger/models";
7
+
8
+ let value: SetCustomerOverageCapInput = {
9
+ capCents: 971835,
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | `capCents` | *number* | :heavy_check_mark: | The customer's monthly overage cap in cents. It replaces the plan default, higher or lower. Null clears it and restores the plan default. |
@@ -0,0 +1,20 @@
1
+ # SetCustomerOverageOverrideInput
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SetCustomerOverageOverrideInput } from "integrateledger/models";
7
+
8
+ let value: SetCustomerOverageOverrideInput = {
9
+ unitAmountCents: 656589,
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | `planId` | *string* | :heavy_minus_sign: | The plan this override applies to. Omit or null to apply it to any plan; a plan-specific override beats one for any plan. |
18
+ | `unitAmountCents` | *number* | :heavy_check_mark: | Negotiated price in cents per billingUnits overage credits. Null clears the override for this planId and restores the plan rate. |
19
+ | `billingUnits` | *number* | :heavy_minus_sign: | Credits billed per unitAmountCents. Defaults to 1. Omit when clearing. |
20
+ | `capCents` | *number* | :heavy_minus_sign: | Monthly overage cap in cents for this override. Omit or null to keep the plan default. The customer's own cap (setCustomerOverageCap) still wins. Omit when clearing. |
@@ -0,0 +1,19 @@
1
+ # Source
2
+
3
+ Where the overage rate comes from: the plan, or an override set with setCustomerOverageOverride.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { Source } from "integrateledger/models";
9
+
10
+ let value: Source = "plan";
11
+
12
+ // Open enum: unrecognized values are captured as Unrecognized<string>
13
+ ```
14
+
15
+ ## Values
16
+
17
+ ```typescript
18
+ "plan" | "override" | Unrecognized<string>
19
+ ```
@@ -9,17 +9,21 @@ let value: TrackResponse = {
9
9
  allowed: true,
10
10
  availableCredits: 296403,
11
11
  chargedCredits: 817157,
12
+ overageCredits: 597850,
13
+ overageRemainingCents: 159668,
12
14
  requestId: "<id>",
13
- idempotent: false,
15
+ idempotent: true,
14
16
  };
15
17
  ```
16
18
 
17
19
  ## Fields
18
20
 
19
- | Field | Type | Required | Description |
20
- | ------------------ | ------------------ | ------------------ | ------------------ |
21
- | `allowed` | *true* | :heavy_check_mark: | N/A |
22
- | `availableCredits` | *number* | :heavy_check_mark: | N/A |
23
- | `chargedCredits` | *number* | :heavy_check_mark: | N/A |
24
- | `requestId` | *string* | :heavy_check_mark: | N/A |
25
- | `idempotent` | *boolean* | :heavy_check_mark: | N/A |
21
+ | Field | Type | Required | Description |
22
+ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
23
+ | `allowed` | *true* | :heavy_check_mark: | N/A |
24
+ | `availableCredits` | *number* | :heavy_check_mark: | Prepaid credits left in plan and credit-pack grants. Overage never makes this negative. |
25
+ | `chargedCredits` | *number* | :heavy_check_mark: | N/A |
26
+ | `overageCredits` | *number* | :heavy_check_mark: | Overage credits recorded in the current billing period, including this request. |
27
+ | `overageRemainingCents` | *number* | :heavy_check_mark: | Overage spend left under the effective cap this period. Null when there is no cap or no overage. |
28
+ | `requestId` | *string* | :heavy_check_mark: | N/A |
29
+ | `idempotent` | *boolean* | :heavy_check_mark: | N/A |
@@ -14,8 +14,11 @@ let value: UpdatePlanInput = {
14
14
 
15
15
  ## Fields
16
16
 
17
- | Field | Type | Required | Description |
18
- | ------------------- | ------------------- | ------------------- | ------------------- |
19
- | `name` | *string* | :heavy_check_mark: | N/A |
20
- | `monthlyCredits` | *number* | :heavy_check_mark: | N/A |
21
- | `monthlyPriceCents` | *number* | :heavy_check_mark: | N/A |
17
+ | Field | Type | Required | Description |
18
+ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
19
+ | `name` | *string* | :heavy_check_mark: | N/A |
20
+ | `monthlyCredits` | *number* | :heavy_check_mark: | N/A |
21
+ | `monthlyPriceCents` | *number* | :heavy_check_mark: | N/A |
22
+ | `overageUnitAmountCents` | *number* | :heavy_minus_sign: | Price in cents per overageBillingUnits credits used after the plan's credits and packs run out. Null or omitted: no overage. |
23
+ | `overageBillingUnits` | *number* | :heavy_minus_sign: | Credits billed per overageUnitAmountCents. Defaults to 1. |
24
+ | `overageCapCents` | *number* | :heavy_minus_sign: | Default monthly overage spend cap in cents. A customer's own cap replaces it. Null or omitted: no cap. |
@@ -24,6 +24,8 @@
24
24
  * [listCustomerSubscriptions](#listcustomersubscriptions) - List a customer's subscriptions
25
25
  * [listCustomerPurchases](#listcustomerpurchases) - List a customer's credit-pack purchases
26
26
  * [setSubscriptionCancellation](#setsubscriptioncancellation) - Stop or resume a paid subscription's renewal
27
+ * [setCustomerOverageCap](#setcustomeroveragecap) - Set or clear a customer's overage cap
28
+ * [setCustomerOverageOverride](#setcustomeroverageoverride) - Set or clear a customer's negotiated overage rate
27
29
  * [getCustomer](#getcustomer) - Get a customer and current balance
28
30
  * [createOrGetCustomer](#createorgetcustomer) - Create or get a customer
29
31
  * [trackUsage](#trackusage) - Record feature usage
@@ -36,7 +38,7 @@ Publish an organization's catalog
36
38
 
37
39
  ### Example Usage
38
40
 
39
- <!-- UsageSnippet language="typescript" operationID="publishCatalog" method="put" path="/v1/catalog" -->
41
+ <!-- UsageSnippet language="typescript" operationID="publishCatalog" method="post" path="/v1/catalog" -->
40
42
  ```typescript
41
43
  import ledger from "integrateledger";
42
44
 
@@ -393,7 +395,7 @@ Update a feature
393
395
 
394
396
  ### Example Usage
395
397
 
396
- <!-- UsageSnippet language="typescript" operationID="updateFeature" method="put" path="/v1/features/{id}" -->
398
+ <!-- UsageSnippet language="typescript" operationID="updateFeature" method="post" path="/v1/features/{id}" -->
397
399
  ```typescript
398
400
  import ledger from "integrateledger";
399
401
 
@@ -781,7 +783,7 @@ Update a plan
781
783
 
782
784
  ### Example Usage
783
785
 
784
- <!-- UsageSnippet language="typescript" operationID="updatePlan" method="put" path="/v1/plans/{id}" -->
786
+ <!-- UsageSnippet language="typescript" operationID="updatePlan" method="post" path="/v1/plans/{id}" -->
785
787
  ```typescript
786
788
  import ledger from "integrateledger";
787
789
 
@@ -1173,7 +1175,7 @@ Update an add-on
1173
1175
 
1174
1176
  ### Example Usage
1175
1177
 
1176
- <!-- UsageSnippet language="typescript" operationID="updateAddOn" method="put" path="/v1/add-ons/{id}" -->
1178
+ <!-- UsageSnippet language="typescript" operationID="updateAddOn" method="post" path="/v1/add-ons/{id}" -->
1177
1179
  ```typescript
1178
1180
  import ledger from "integrateledger";
1179
1181
 
@@ -1562,7 +1564,7 @@ Stop or resume a paid subscription's renewal
1562
1564
 
1563
1565
  ### Example Usage
1564
1566
 
1565
- <!-- UsageSnippet language="typescript" operationID="setSubscriptionCancellation" method="put" path="/v1/customers/subscriptions/{subscriptionId}/cancellation" -->
1567
+ <!-- UsageSnippet language="typescript" operationID="setSubscriptionCancellation" method="post" path="/v1/customers/subscriptions/{subscriptionId}/cancellation" -->
1566
1568
  ```typescript
1567
1569
  import ledger from "integrateledger";
1568
1570
 
@@ -1639,6 +1641,166 @@ run();
1639
1641
  | errors.CustomerError | 502 | application/json |
1640
1642
  | errors.LedgerDefaultError | 4XX, 5XX | \*/\* |
1641
1643
 
1644
+ ## setCustomerOverageCap
1645
+
1646
+ Set or clear a customer's overage cap
1647
+
1648
+ ### Example Usage
1649
+
1650
+ <!-- UsageSnippet language="typescript" operationID="setCustomerOverageCap" method="post" path="/v1/customers/overage-cap" -->
1651
+ ```typescript
1652
+ import ledger from "integrateledger";
1653
+
1654
+ const client = new ledger({
1655
+ apiKey: process.env["LEDGER_API_KEY"] ?? "",
1656
+ });
1657
+
1658
+ async function run() {
1659
+ const result = await client.setCustomerOverageCap({
1660
+ customerId: "<id>",
1661
+ body: {
1662
+ capCents: 597713,
1663
+ },
1664
+ });
1665
+
1666
+ console.log(result);
1667
+ }
1668
+
1669
+ run();
1670
+ ```
1671
+
1672
+ ### Standalone function
1673
+
1674
+ The standalone function version of this method:
1675
+
1676
+ ```typescript
1677
+ import { LedgerCore } from "integrateledger/core.js";
1678
+ import { setCustomerOverageCap } from "integrateledger/funcs/set-customer-overage-cap.js";
1679
+
1680
+ // Use `LedgerCore` for best tree-shaking performance.
1681
+ // You can create one instance of it to use across an application.
1682
+ const ledger = new LedgerCore({
1683
+ apiKey: process.env["LEDGER_API_KEY"] ?? "",
1684
+ });
1685
+
1686
+ async function run() {
1687
+ const res = await setCustomerOverageCap(ledger, {
1688
+ customerId: "<id>",
1689
+ body: {
1690
+ capCents: 597713,
1691
+ },
1692
+ });
1693
+ if (res.ok) {
1694
+ const { value: result } = res;
1695
+ console.log(result);
1696
+ } else {
1697
+ console.log("setCustomerOverageCap failed:", res.error);
1698
+ }
1699
+ }
1700
+
1701
+ run();
1702
+ ```
1703
+
1704
+ ### Parameters
1705
+
1706
+ | Parameter | Type | Required | Description |
1707
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1708
+ | `request` | [operations.SetCustomerOverageCapRequest](../../models/operations/set-customer-overage-cap-request.md) | :heavy_check_mark: | The request object to use for the request. |
1709
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1710
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1711
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1712
+
1713
+ ### Response
1714
+
1715
+ **Promise\<[models.CustomerOverageCap](../../models/customer-overage-cap.md)\>**
1716
+
1717
+ ### Errors
1718
+
1719
+ | Error Type | Status Code | Content Type |
1720
+ | ------------------------- | ------------------------- | ------------------------- |
1721
+ | errors.CustomerError | 400, 401, 404 | application/json |
1722
+ | errors.LedgerDefaultError | 4XX, 5XX | \*/\* |
1723
+
1724
+ ## setCustomerOverageOverride
1725
+
1726
+ Set or clear a customer's negotiated overage rate
1727
+
1728
+ ### Example Usage
1729
+
1730
+ <!-- UsageSnippet language="typescript" operationID="setCustomerOverageOverride" method="post" path="/v1/customers/overage-override" -->
1731
+ ```typescript
1732
+ import ledger from "integrateledger";
1733
+
1734
+ const client = new ledger({
1735
+ apiKey: process.env["LEDGER_API_KEY"] ?? "",
1736
+ });
1737
+
1738
+ async function run() {
1739
+ const result = await client.setCustomerOverageOverride({
1740
+ customerId: "<id>",
1741
+ body: {
1742
+ unitAmountCents: 844704,
1743
+ },
1744
+ });
1745
+
1746
+ console.log(result);
1747
+ }
1748
+
1749
+ run();
1750
+ ```
1751
+
1752
+ ### Standalone function
1753
+
1754
+ The standalone function version of this method:
1755
+
1756
+ ```typescript
1757
+ import { LedgerCore } from "integrateledger/core.js";
1758
+ import { setCustomerOverageOverride } from "integrateledger/funcs/set-customer-overage-override.js";
1759
+
1760
+ // Use `LedgerCore` for best tree-shaking performance.
1761
+ // You can create one instance of it to use across an application.
1762
+ const ledger = new LedgerCore({
1763
+ apiKey: process.env["LEDGER_API_KEY"] ?? "",
1764
+ });
1765
+
1766
+ async function run() {
1767
+ const res = await setCustomerOverageOverride(ledger, {
1768
+ customerId: "<id>",
1769
+ body: {
1770
+ unitAmountCents: 844704,
1771
+ },
1772
+ });
1773
+ if (res.ok) {
1774
+ const { value: result } = res;
1775
+ console.log(result);
1776
+ } else {
1777
+ console.log("setCustomerOverageOverride failed:", res.error);
1778
+ }
1779
+ }
1780
+
1781
+ run();
1782
+ ```
1783
+
1784
+ ### Parameters
1785
+
1786
+ | Parameter | Type | Required | Description |
1787
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1788
+ | `request` | [operations.SetCustomerOverageOverrideRequest](../../models/operations/set-customer-overage-override-request.md) | :heavy_check_mark: | The request object to use for the request. |
1789
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1790
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1791
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1792
+
1793
+ ### Response
1794
+
1795
+ **Promise\<[models.CustomerOverageOverrideResult](../../models/customer-overage-override-result.md)\>**
1796
+
1797
+ ### Errors
1798
+
1799
+ | Error Type | Status Code | Content Type |
1800
+ | ------------------------- | ------------------------- | ------------------------- |
1801
+ | errors.CustomerError | 400, 401, 404, 409 | application/json |
1802
+ | errors.LedgerDefaultError | 4XX, 5XX | \*/\* |
1803
+
1642
1804
  ## getCustomer
1643
1805
 
1644
1806
  Get a customer and current balance
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "integrateledger",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "author": "Ledger",
5
5
  "description": "Server-side TypeScript client for the Ledger billing and usage API",
6
6
  "homepage": "https://docs.integrateledger.com/quickstart",