@flexprice/sdk 2.1.5 → 2.1.9

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 (237) hide show
  1. package/FUNCTIONS.md +2 -2
  2. package/docs/sdk/models/create-price-request.md +1 -1
  3. package/docs/sdk/models/create-subscription-request.md +1 -2
  4. package/docs/sdk/models/customer-filter.md +1 -0
  5. package/docs/sdk/models/execute-subscription-modify-request.md +7 -6
  6. package/docs/sdk/models/export-metadata-entity-type.md +17 -0
  7. package/docs/sdk/models/export-metadata-field.md +20 -0
  8. package/docs/sdk/models/grouped-invoicing-action.md +15 -0
  9. package/docs/sdk/models/invoice-billing-reason.md +1 -1
  10. package/docs/sdk/models/list-subscription-line-items-response.md +50 -0
  11. package/docs/sdk/models/plan-filter.md +1 -0
  12. package/docs/sdk/models/price-price.md +42 -42
  13. package/docs/sdk/models/price-response.md +47 -47
  14. package/docs/sdk/models/s3-job-config.md +10 -9
  15. package/docs/sdk/models/scheduled-task-entity-type.md +1 -1
  16. package/docs/sdk/models/sub-modify-grouped-invoicing-params.md +19 -0
  17. package/docs/sdk/models/subscription-filter.md +1 -0
  18. package/docs/sdk/models/subscription-inheritance-config.md +6 -5
  19. package/docs/sdk/models/subscription-line-item-filter-order.md +15 -0
  20. package/docs/sdk/models/subscription-line-item-filter.md +34 -0
  21. package/docs/sdk/models/subscription-line-item-response.md +0 -1
  22. package/docs/sdk/models/subscription-modify-type.md +2 -2
  23. package/docs/sdk/models/subscription-price-create-request.md +1 -1
  24. package/docs/sdk/models/subscription-subscription-line-item.md +0 -1
  25. package/docs/sdk/models/subscription-type.md +1 -1
  26. package/docs/sdks/scheduledtasks/README.md +2 -2
  27. package/docs/sdks/subscriptions/README.md +74 -228
  28. package/esm/funcs/subscriptions-query-subscription-line-items.d.ts +17 -0
  29. package/esm/funcs/subscriptions-query-subscription-line-items.d.ts.map +1 -0
  30. package/esm/funcs/{subscriptions-list-subscription-pauses.js → subscriptions-query-subscription-line-items.js} +14 -22
  31. package/esm/funcs/subscriptions-query-subscription-line-items.js.map +1 -0
  32. package/esm/lib/config.d.ts +3 -3
  33. package/esm/lib/config.js +3 -3
  34. package/esm/sdk/models/create-price-request.d.ts +2 -2
  35. package/esm/sdk/models/create-price-request.d.ts.map +1 -1
  36. package/esm/sdk/models/create-price-request.js +2 -2
  37. package/esm/sdk/models/create-price-request.js.map +1 -1
  38. package/esm/sdk/models/create-subscription-request.d.ts +8 -4
  39. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  40. package/esm/sdk/models/create-subscription-request.js +2 -4
  41. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  42. package/esm/sdk/models/customer-filter.d.ts +6 -0
  43. package/esm/sdk/models/customer-filter.d.ts.map +1 -1
  44. package/esm/sdk/models/customer-filter.js +1 -0
  45. package/esm/sdk/models/customer-filter.js.map +1 -1
  46. package/esm/sdk/models/execute-subscription-modify-request.d.ts +3 -0
  47. package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
  48. package/esm/sdk/models/execute-subscription-modify-request.js +3 -0
  49. package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
  50. package/esm/sdk/models/export-metadata-entity-type.d.ts +12 -0
  51. package/esm/sdk/models/export-metadata-entity-type.d.ts.map +1 -0
  52. package/esm/sdk/models/export-metadata-entity-type.js +13 -0
  53. package/esm/sdk/models/export-metadata-entity-type.js.map +1 -0
  54. package/esm/sdk/models/export-metadata-field.d.ts +28 -0
  55. package/esm/sdk/models/export-metadata-field.d.ts.map +1 -0
  56. package/esm/sdk/models/export-metadata-field.js +39 -0
  57. package/esm/sdk/models/export-metadata-field.js.map +1 -0
  58. package/esm/sdk/models/grouped-invoicing-action.d.ts +10 -0
  59. package/esm/sdk/models/grouped-invoicing-action.d.ts.map +1 -0
  60. package/esm/sdk/models/grouped-invoicing-action.js +11 -0
  61. package/esm/sdk/models/grouped-invoicing-action.js.map +1 -0
  62. package/esm/sdk/models/index.d.ts +6 -7
  63. package/esm/sdk/models/index.d.ts.map +1 -1
  64. package/esm/sdk/models/index.js +6 -7
  65. package/esm/sdk/models/index.js.map +1 -1
  66. package/esm/sdk/models/invoice-billing-reason.d.ts +2 -0
  67. package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
  68. package/esm/sdk/models/invoice-billing-reason.js +2 -0
  69. package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
  70. package/esm/sdk/models/list-subscription-line-items-response.d.ts +13 -0
  71. package/esm/sdk/models/list-subscription-line-items-response.d.ts.map +1 -0
  72. package/esm/sdk/models/list-subscription-line-items-response.js +17 -0
  73. package/esm/sdk/models/list-subscription-line-items-response.js.map +1 -0
  74. package/esm/sdk/models/pause-mode.d.ts +0 -2
  75. package/esm/sdk/models/pause-mode.d.ts.map +1 -1
  76. package/esm/sdk/models/pause-mode.js +0 -2
  77. package/esm/sdk/models/pause-mode.js.map +1 -1
  78. package/esm/sdk/models/plan-filter.d.ts +6 -0
  79. package/esm/sdk/models/plan-filter.d.ts.map +1 -1
  80. package/esm/sdk/models/plan-filter.js +1 -0
  81. package/esm/sdk/models/plan-filter.js.map +1 -1
  82. package/esm/sdk/models/price-price.d.ts +2 -2
  83. package/esm/sdk/models/price-price.d.ts.map +1 -1
  84. package/esm/sdk/models/price-price.js +2 -2
  85. package/esm/sdk/models/price-price.js.map +1 -1
  86. package/esm/sdk/models/price-response.d.ts +2 -2
  87. package/esm/sdk/models/price-response.d.ts.map +1 -1
  88. package/esm/sdk/models/price-response.js +2 -2
  89. package/esm/sdk/models/price-response.js.map +1 -1
  90. package/esm/sdk/models/resume-mode.d.ts +0 -2
  91. package/esm/sdk/models/resume-mode.d.ts.map +1 -1
  92. package/esm/sdk/models/resume-mode.js +0 -2
  93. package/esm/sdk/models/resume-mode.js.map +1 -1
  94. package/esm/sdk/models/s3-job-config.d.ts +7 -1
  95. package/esm/sdk/models/s3-job-config.d.ts.map +1 -1
  96. package/esm/sdk/models/s3-job-config.js +5 -0
  97. package/esm/sdk/models/s3-job-config.js.map +1 -1
  98. package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
  99. package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
  100. package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
  101. package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
  102. package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts +20 -0
  103. package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts.map +1 -0
  104. package/esm/sdk/models/sub-modify-grouped-invoicing-params.js +21 -0
  105. package/esm/sdk/models/sub-modify-grouped-invoicing-params.js.map +1 -0
  106. package/esm/sdk/models/subscription-filter.d.ts +8 -0
  107. package/esm/sdk/models/subscription-filter.d.ts.map +1 -1
  108. package/esm/sdk/models/subscription-filter.js +2 -0
  109. package/esm/sdk/models/subscription-filter.js.map +1 -1
  110. package/esm/sdk/models/subscription-inheritance-config.d.ts +26 -0
  111. package/esm/sdk/models/subscription-inheritance-config.d.ts.map +1 -1
  112. package/esm/sdk/models/subscription-inheritance-config.js +2 -0
  113. package/esm/sdk/models/subscription-inheritance-config.js.map +1 -1
  114. package/esm/sdk/models/subscription-line-item-entity-type.d.ts +2 -0
  115. package/esm/sdk/models/subscription-line-item-entity-type.d.ts.map +1 -1
  116. package/esm/sdk/models/subscription-line-item-entity-type.js +2 -0
  117. package/esm/sdk/models/subscription-line-item-entity-type.js.map +1 -1
  118. package/esm/sdk/models/subscription-line-item-filter.d.ts +65 -0
  119. package/esm/sdk/models/subscription-line-item-filter.d.ts.map +1 -0
  120. package/esm/sdk/models/subscription-line-item-filter.js +57 -0
  121. package/esm/sdk/models/subscription-line-item-filter.js.map +1 -0
  122. package/esm/sdk/models/subscription-line-item-response.d.ts +0 -1
  123. package/esm/sdk/models/subscription-line-item-response.d.ts.map +1 -1
  124. package/esm/sdk/models/subscription-line-item-response.js +0 -2
  125. package/esm/sdk/models/subscription-line-item-response.js.map +1 -1
  126. package/esm/sdk/models/subscription-modify-type.d.ts +1 -0
  127. package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
  128. package/esm/sdk/models/subscription-modify-type.js +1 -0
  129. package/esm/sdk/models/subscription-modify-type.js.map +1 -1
  130. package/esm/sdk/models/subscription-price-create-request.d.ts +2 -2
  131. package/esm/sdk/models/subscription-price-create-request.d.ts.map +1 -1
  132. package/esm/sdk/models/subscription-price-create-request.js +2 -2
  133. package/esm/sdk/models/subscription-price-create-request.js.map +1 -1
  134. package/esm/sdk/models/subscription-subscription-line-item.d.ts +0 -1
  135. package/esm/sdk/models/subscription-subscription-line-item.d.ts.map +1 -1
  136. package/esm/sdk/models/subscription-subscription-line-item.js +0 -2
  137. package/esm/sdk/models/subscription-subscription-line-item.js.map +1 -1
  138. package/esm/sdk/models/subscription-type.d.ts +2 -0
  139. package/esm/sdk/models/subscription-type.d.ts.map +1 -1
  140. package/esm/sdk/models/subscription-type.js +2 -0
  141. package/esm/sdk/models/subscription-type.js.map +1 -1
  142. package/esm/sdk/subscriptions.d.ts +7 -21
  143. package/esm/sdk/subscriptions.d.ts.map +1 -1
  144. package/esm/sdk/subscriptions.js +10 -30
  145. package/esm/sdk/subscriptions.js.map +1 -1
  146. package/esm/types/primitives.d.ts +1 -1
  147. package/esm/types/primitives.d.ts.map +1 -1
  148. package/esm/types/primitives.js +2 -3
  149. package/esm/types/primitives.js.map +1 -1
  150. package/jsr.json +1 -1
  151. package/package.json +1 -1
  152. package/src/funcs/{subscriptions-list-subscription-pauses.ts → subscriptions-query-subscription-line-items.ts} +19 -29
  153. package/src/lib/config.ts +3 -3
  154. package/src/sdk/models/create-price-request.ts +4 -4
  155. package/src/sdk/models/create-subscription-request.ts +10 -8
  156. package/src/sdk/models/customer-filter.ts +3 -0
  157. package/src/sdk/models/execute-subscription-modify-request.ts +13 -0
  158. package/src/sdk/models/export-metadata-entity-type.ts +26 -0
  159. package/src/sdk/models/export-metadata-field.ts +88 -0
  160. package/src/sdk/models/grouped-invoicing-action.ts +17 -0
  161. package/src/sdk/models/index.ts +6 -7
  162. package/src/sdk/models/invoice-billing-reason.ts +2 -0
  163. package/src/sdk/models/list-subscription-line-items-response.ts +41 -0
  164. package/src/sdk/models/pause-mode.ts +0 -3
  165. package/src/sdk/models/plan-filter.ts +3 -0
  166. package/src/sdk/models/price-price.ts +4 -4
  167. package/src/sdk/models/price-response.ts +4 -4
  168. package/src/sdk/models/resume-mode.ts +0 -3
  169. package/src/sdk/models/s3-job-config.ts +20 -1
  170. package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
  171. package/src/sdk/models/sub-modify-grouped-invoicing-params.ts +54 -0
  172. package/src/sdk/models/subscription-filter.ts +12 -0
  173. package/src/sdk/models/subscription-inheritance-config.ts +29 -0
  174. package/src/sdk/models/subscription-line-item-entity-type.ts +5 -0
  175. package/src/sdk/models/subscription-line-item-filter.ts +140 -0
  176. package/src/sdk/models/subscription-line-item-response.ts +0 -3
  177. package/src/sdk/models/subscription-modify-type.ts +1 -0
  178. package/src/sdk/models/subscription-price-create-request.ts +4 -4
  179. package/src/sdk/models/subscription-subscription-line-item.ts +0 -3
  180. package/src/sdk/models/subscription-type.ts +2 -0
  181. package/src/sdk/subscriptions.ts +18 -58
  182. package/src/types/primitives.ts +2 -4
  183. package/docs/sdk/models/list-subscription-pauses-request.md +0 -17
  184. package/docs/sdk/models/list-subscription-pauses-response.md +0 -18
  185. package/docs/sdk/models/pause-subscription-request-request.md +0 -21
  186. package/docs/sdk/models/pause-subscription-request.md +0 -25
  187. package/docs/sdk/models/resume-subscription-request-request.md +0 -21
  188. package/docs/sdk/models/resume-subscription-request.md +0 -21
  189. package/docs/sdk/models/subscription-pause-response.md +0 -35
  190. package/esm/funcs/subscriptions-list-subscription-pauses.d.ts +0 -17
  191. package/esm/funcs/subscriptions-list-subscription-pauses.d.ts.map +0 -1
  192. package/esm/funcs/subscriptions-list-subscription-pauses.js.map +0 -1
  193. package/esm/funcs/subscriptions-pause-subscription.d.ts +0 -17
  194. package/esm/funcs/subscriptions-pause-subscription.d.ts.map +0 -1
  195. package/esm/funcs/subscriptions-pause-subscription.js +0 -93
  196. package/esm/funcs/subscriptions-pause-subscription.js.map +0 -1
  197. package/esm/funcs/subscriptions-resume-subscription.d.ts +0 -17
  198. package/esm/funcs/subscriptions-resume-subscription.d.ts.map +0 -1
  199. package/esm/funcs/subscriptions-resume-subscription.js +0 -93
  200. package/esm/funcs/subscriptions-resume-subscription.js.map +0 -1
  201. package/esm/sdk/models/list-subscription-pauses-op.d.ts +0 -15
  202. package/esm/sdk/models/list-subscription-pauses-op.d.ts.map +0 -1
  203. package/esm/sdk/models/list-subscription-pauses-op.js +0 -12
  204. package/esm/sdk/models/list-subscription-pauses-op.js.map +0 -1
  205. package/esm/sdk/models/list-subscription-pauses-response.d.ts +0 -27
  206. package/esm/sdk/models/list-subscription-pauses-response.d.ts.map +0 -1
  207. package/esm/sdk/models/list-subscription-pauses-response.js +0 -16
  208. package/esm/sdk/models/list-subscription-pauses-response.js.map +0 -1
  209. package/esm/sdk/models/pause-subscription-op.d.ts +0 -21
  210. package/esm/sdk/models/pause-subscription-op.d.ts.map +0 -1
  211. package/esm/sdk/models/pause-subscription-op.js +0 -14
  212. package/esm/sdk/models/pause-subscription-op.js.map +0 -1
  213. package/esm/sdk/models/pause-subscription-request.d.ts +0 -74
  214. package/esm/sdk/models/pause-subscription-request.d.ts.map +0 -1
  215. package/esm/sdk/models/pause-subscription-request.js +0 -28
  216. package/esm/sdk/models/pause-subscription-request.js.map +0 -1
  217. package/esm/sdk/models/resume-subscription-op.d.ts +0 -21
  218. package/esm/sdk/models/resume-subscription-op.d.ts.map +0 -1
  219. package/esm/sdk/models/resume-subscription-op.js +0 -14
  220. package/esm/sdk/models/resume-subscription-op.js.map +0 -1
  221. package/esm/sdk/models/resume-subscription-request.d.ts +0 -38
  222. package/esm/sdk/models/resume-subscription-request.d.ts.map +0 -1
  223. package/esm/sdk/models/resume-subscription-request.js +0 -21
  224. package/esm/sdk/models/resume-subscription-request.js.map +0 -1
  225. package/esm/sdk/models/subscription-pause-response.d.ts +0 -64
  226. package/esm/sdk/models/subscription-pause-response.d.ts.map +0 -1
  227. package/esm/sdk/models/subscription-pause-response.js +0 -55
  228. package/esm/sdk/models/subscription-pause-response.js.map +0 -1
  229. package/src/funcs/subscriptions-pause-subscription.ts +0 -187
  230. package/src/funcs/subscriptions-resume-subscription.ts +0 -187
  231. package/src/sdk/models/list-subscription-pauses-op.ts +0 -35
  232. package/src/sdk/models/list-subscription-pauses-response.ts +0 -52
  233. package/src/sdk/models/pause-subscription-op.ts +0 -46
  234. package/src/sdk/models/pause-subscription-request.ts +0 -106
  235. package/src/sdk/models/resume-subscription-op.ts +0 -46
  236. package/src/sdk/models/resume-subscription-request.ts +0 -63
  237. package/src/sdk/models/subscription-pause-response.ts +0 -123
package/FUNCTIONS.md CHANGED
@@ -1,11 +1,11 @@
1
1
  # Standalone Functions
2
2
 
3
3
  > [!NOTE]
4
- > This section is useful if you are using a bundler and targetting browsers and
4
+ > This section is useful if you are using a bundler and targeting browsers and
5
5
  > runtimes where the size of an application affects performance and load times.
6
6
 
7
7
  Every method in this SDK is also available as a standalone function. This
8
- alternative API is suitable when targetting the browser or serverless runtimes
8
+ alternative API is suitable when targeting the browser or serverless runtimes
9
9
  and using a bundler to build your application since all unused functionality
10
10
  will be tree-shaken away. This includes code for unused methods, Zod schemas,
11
11
  encoding helpers and response handlers. The result is dramatically smaller
package/docs/sdk/models/create-price-request.md CHANGED
@@ -44,5 +44,5 @@ let value: CreatePriceRequest = {
44
44
  | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
45
45
  | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | N/A |
46
46
  | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
47
- | `trialPeriod` | *number* | :heavy_minus_sign: | N/A |
47
+ | `trialPeriodDays` | *number* | :heavy_minus_sign: | N/A |
48
48
  | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/create-subscription-request.md CHANGED
@@ -50,5 +50,4 @@ let value: CreateSubscriptionRequest = {
50
50
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
51
51
  | `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
52
52
  | `taxRateOverrides` | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[] | :heavy_minus_sign: | tax_rate_overrides is the tax rate overrides to be applied to the subscription |
53
- | `trialEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
54
- | `trialStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
53
+ | `trialPeriodDays` | *number* | :heavy_minus_sign: | TrialPeriodDays: nil = inherit trial length from plan recurring-fixed prices (must be uniform).<br/>0 = explicitly no trial (overrides catalog). >0 = override duration in days. |
package/docs/sdk/models/customer-filter.md CHANGED
@@ -20,6 +20,7 @@ let value: CustomerFilter = {};
20
20
  | `externalIds` | *string*[] | :heavy_minus_sign: | N/A |
21
21
  | `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
22
22
  | `limit` | *number* | :heavy_minus_sign: | N/A |
23
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
23
24
  | `offset` | *number* | :heavy_minus_sign: | N/A |
24
25
  | `order` | [models.CustomerFilterOrder](../../sdk/models/customer-filter-order.md) | :heavy_minus_sign: | N/A |
25
26
  | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/execute-subscription-modify-request.md CHANGED
@@ -6,14 +6,15 @@
6
6
  import { ExecuteSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: ExecuteSubscriptionModifyRequest = {
9
- type: "quantity_change",
9
+ type: "grouped_invoicing",
10
10
  };
11
11
  ```
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
17
- | `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
18
- | `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
19
- | `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
15
+ | Field | Type | Required | Description |
16
+ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
17
+ | `groupedInvoicingParams` | [models.SubModifyGroupedInvoicingParams](../../sdk/models/sub-modify-grouped-invoicing-params.md) | :heavy_minus_sign: | N/A |
18
+ | `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
19
+ | `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
20
+ | `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/export-metadata-entity-type.md ADDED
@@ -0,0 +1,17 @@
1
+ # ExportMetadataEntityType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ExportMetadataEntityType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ExportMetadataEntityType = "wallet";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "customer" | "wallet" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/export-metadata-field.md ADDED
@@ -0,0 +1,20 @@
1
+ # ExportMetadataField
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ExportMetadataField } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ExportMetadataField = {
9
+ entityType: "customer",
10
+ fieldKey: "<value>",
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
18
+ | `columnName` | *string* | :heavy_minus_sign: | CSV column header to be shown in the exported file |
19
+ | `entityType` | [models.ExportMetadataEntityType](../../sdk/models/export-metadata-entity-type.md) | :heavy_check_mark: | N/A |
20
+ | `fieldKey` | *string* | :heavy_check_mark: | metadata key to look up |
package/docs/sdk/models/grouped-invoicing-action.md ADDED
@@ -0,0 +1,15 @@
1
+ # GroupedInvoicingAction
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GroupedInvoicingAction } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GroupedInvoicingAction = "remove";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "add" | "remove"
15
+ ```
package/docs/sdk/models/invoice-billing-reason.md CHANGED
@@ -11,5 +11,5 @@ let value: InvoiceBillingReason = "SUBSCRIPTION_CYCLE";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "PRORATION" | "MANUAL"
14
+ "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL"
15
15
  ```
package/docs/sdk/models/list-subscription-line-items-response.md ADDED
@@ -0,0 +1,50 @@
1
+ # ListSubscriptionLineItemsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListSubscriptionLineItemsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListSubscriptionLineItemsResponse = {
9
+ items: [
10
+ {
11
+ price: {
12
+ addon: {
13
+ prices: [
14
+ {
15
+ addon: {},
16
+ meter: {
17
+ createdAt: new Date("2024-03-20T15:04:05Z"),
18
+ eventName: "api_request",
19
+ id: "550e8400-e29b-41d4-a716-446655440000",
20
+ name: "API Usage Meter",
21
+ status: "published",
22
+ tenantId: "tenant123",
23
+ updatedAt: new Date("2024-03-20T15:04:05Z"),
24
+ },
25
+ plan: {},
26
+ },
27
+ ],
28
+ },
29
+ meter: {
30
+ createdAt: new Date("2024-03-20T15:04:05Z"),
31
+ eventName: "api_request",
32
+ id: "550e8400-e29b-41d4-a716-446655440000",
33
+ name: "API Usage Meter",
34
+ status: "published",
35
+ tenantId: "tenant123",
36
+ updatedAt: new Date("2024-03-20T15:04:05Z"),
37
+ },
38
+ plan: {},
39
+ },
40
+ },
41
+ ],
42
+ };
43
+ ```
44
+
45
+ ## Fields
46
+
47
+ | Field | Type | Required | Description |
48
+ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
49
+ | `items` | [models.SubscriptionLineItemResponse](../../sdk/models/subscription-line-item-response.md)[] | :heavy_minus_sign: | N/A |
50
+ | `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/plan-filter.md CHANGED
@@ -17,6 +17,7 @@ let value: PlanFilter = {};
17
17
  | `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | filters allows complex filtering based on multiple fields |
18
18
  | `limit` | *number* | :heavy_minus_sign: | N/A |
19
19
  | `lookupKey` | *string* | :heavy_minus_sign: | N/A |
20
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
20
21
  | `offset` | *number* | :heavy_minus_sign: | N/A |
21
22
  | `order` | [models.PlanFilterOrder](../../sdk/models/plan-filter-order.md) | :heavy_minus_sign: | N/A |
22
23
  | `planIds` | *string*[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-price.md CHANGED
@@ -10,45 +10,45 @@ let value: PricePrice = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | Amount stored in main currency units (e.g., dollars, not cents)<br/>For USD: 12.50 means $12.50 |
16
- | `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_minus_sign: | N/A |
17
- | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
18
- | `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
19
- | `billingPeriodCount` | *number* | :heavy_minus_sign: | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12 |
20
- | `conversionRate` | *string* | :heavy_minus_sign: | ConversionRate is the conversion rate of the price unit to the fiat currency |
21
- | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
22
- | `createdBy` | *string* | :heavy_minus_sign: | N/A |
23
- | `currency` | *string* | :heavy_minus_sign: | Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp |
24
- | `description` | *string* | :heavy_minus_sign: | Description of the price |
25
- | `displayAmount` | *string* | :heavy_minus_sign: | DisplayAmount is the formatted amount with currency symbol<br/>For USD: $12.50 |
26
- | `displayName` | *string* | :heavy_minus_sign: | DisplayName is the name of the price |
27
- | `displayPriceUnitAmount` | *string* | :heavy_minus_sign: | DisplayPriceUnitAmount is the formatted amount of the price unit |
28
- | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate is the end date of the price |
29
- | `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
30
- | `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
31
- | `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
32
- | `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
33
- | `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
34
- | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
35
- | `lookupKey` | *string* | :heavy_minus_sign: | LookupKey used for looking up the price in the database |
36
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
37
- | `meterId` | *string* | :heavy_minus_sign: | MeterID is the id of the meter for usage based pricing |
38
- | `minQuantity` | *string* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
39
- | `parentPriceId` | *string* | :heavy_minus_sign: | ParentPriceID references the root price (always set for price lineage tracking) |
40
- | `priceUnit` | *string* | :heavy_minus_sign: | PriceUnit is the code of the price unit (e.g., 'btc', 'eth') |
41
- | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount of the price unit |
42
- | `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
43
- | `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
44
- | `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
45
- | `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 price |
46
- | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
47
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
48
- | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
49
- | `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
50
- | `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
51
- | `trialPeriod` | *number* | :heavy_minus_sign: | TrialPeriod is the number of days for the trial period<br/>Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING) |
52
- | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
53
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
54
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | Amount stored in main currency units (e.g., dollars, not cents)<br/>For USD: 12.50 means $12.50 |
16
+ | `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_minus_sign: | N/A |
17
+ | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
18
+ | `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
19
+ | `billingPeriodCount` | *number* | :heavy_minus_sign: | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12 |
20
+ | `conversionRate` | *string* | :heavy_minus_sign: | ConversionRate is the conversion rate of the price unit to the fiat currency |
21
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
22
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
23
+ | `currency` | *string* | :heavy_minus_sign: | Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp |
24
+ | `description` | *string* | :heavy_minus_sign: | Description of the price |
25
+ | `displayAmount` | *string* | :heavy_minus_sign: | DisplayAmount is the formatted amount with currency symbol<br/>For USD: $12.50 |
26
+ | `displayName` | *string* | :heavy_minus_sign: | DisplayName is the name of the price |
27
+ | `displayPriceUnitAmount` | *string* | :heavy_minus_sign: | DisplayPriceUnitAmount is the formatted amount of the price unit |
28
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate is the end date of the price |
29
+ | `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
30
+ | `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
31
+ | `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
32
+ | `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
33
+ | `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
34
+ | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
35
+ | `lookupKey` | *string* | :heavy_minus_sign: | LookupKey used for looking up the price in the database |
36
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
37
+ | `meterId` | *string* | :heavy_minus_sign: | MeterID is the id of the meter for usage based pricing |
38
+ | `minQuantity` | *string* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
39
+ | `parentPriceId` | *string* | :heavy_minus_sign: | ParentPriceID references the root price (always set for price lineage tracking) |
40
+ | `priceUnit` | *string* | :heavy_minus_sign: | PriceUnit is the code of the price unit (e.g., 'btc', 'eth') |
41
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount of the price unit |
42
+ | `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
43
+ | `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
44
+ | `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
45
+ | `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 price |
46
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
47
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
48
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
49
+ | `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
50
+ | `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
51
+ | `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) |
52
+ | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
53
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
54
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |