@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/docs/sdk/models/price-response.md CHANGED
@@ -38,50 +38,50 @@ let value: PriceResponse = {
38
38
 
39
39
  ## Fields
40
40
 
41
- | Field | Type | Required | Description |
42
- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
43
- | `addon` | [models.AddonResponse](../../sdk/models/addon-response.md) | :heavy_minus_sign: | N/A |
44
- | `amount` | *string* | :heavy_minus_sign: | Amount stored in main currency units (e.g., dollars, not cents)<br/>For USD: 12.50 means $12.50 |
45
- | `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_minus_sign: | N/A |
46
- | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
47
- | `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
48
- | `billingPeriodCount` | *number* | :heavy_minus_sign: | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12 |
49
- | `conversionRate` | *string* | :heavy_minus_sign: | ConversionRate is the conversion rate of the price unit to the fiat currency |
50
- | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
51
- | `createdBy` | *string* | :heavy_minus_sign: | N/A |
52
- | `currency` | *string* | :heavy_minus_sign: | Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp |
53
- | `description` | *string* | :heavy_minus_sign: | Description of the price |
54
- | `displayAmount` | *string* | :heavy_minus_sign: | DisplayAmount is the formatted amount with currency symbol<br/>For USD: $12.50 |
55
- | `displayName` | *string* | :heavy_minus_sign: | DisplayName is the name of the price |
56
- | `displayPriceUnitAmount` | *string* | :heavy_minus_sign: | DisplayPriceUnitAmount is the formatted amount of the price unit |
57
- | `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 |
58
- | `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
59
- | `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
60
- | `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
61
- | `group` | [models.GroupResponse](../../sdk/models/group-response.md) | :heavy_minus_sign: | N/A |
62
- | `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
63
- | `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
64
- | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
65
- | `lookupKey` | *string* | :heavy_minus_sign: | LookupKey used for looking up the price in the database |
66
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
67
- | `meter` | [models.MeterResponse](../../sdk/models/meter-response.md) | :heavy_minus_sign: | N/A |
68
- | `meterId` | *string* | :heavy_minus_sign: | MeterID is the id of the meter for usage based pricing |
69
- | `minQuantity` | *string* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
70
- | `parentPriceId` | *string* | :heavy_minus_sign: | ParentPriceID references the root price (always set for price lineage tracking) |
71
- | `plan` | [models.PlanResponse](../../sdk/models/plan-response.md) | :heavy_minus_sign: | N/A |
72
- | `priceUnit` | *string* | :heavy_minus_sign: | PriceUnit is the code of the price unit (e.g., 'btc', 'eth') |
73
- | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount of the price unit |
74
- | `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
75
- | `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
76
- | `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
77
- | `pricingUnit` | [models.PriceUnitResponse](../../sdk/models/price-unit-response.md) | :heavy_minus_sign: | N/A |
78
- | `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 |
79
- | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
80
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
81
- | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
82
- | `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
83
- | `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
84
- | `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) |
85
- | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
86
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
87
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
41
+ | Field | Type | Required | Description |
42
+ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
43
+ | `addon` | [models.AddonResponse](../../sdk/models/addon-response.md) | :heavy_minus_sign: | N/A |
44
+ | `amount` | *string* | :heavy_minus_sign: | Amount stored in main currency units (e.g., dollars, not cents)<br/>For USD: 12.50 means $12.50 |
45
+ | `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_minus_sign: | N/A |
46
+ | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
47
+ | `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
48
+ | `billingPeriodCount` | *number* | :heavy_minus_sign: | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12 |
49
+ | `conversionRate` | *string* | :heavy_minus_sign: | ConversionRate is the conversion rate of the price unit to the fiat currency |
50
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
51
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
52
+ | `currency` | *string* | :heavy_minus_sign: | Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp |
53
+ | `description` | *string* | :heavy_minus_sign: | Description of the price |
54
+ | `displayAmount` | *string* | :heavy_minus_sign: | DisplayAmount is the formatted amount with currency symbol<br/>For USD: $12.50 |
55
+ | `displayName` | *string* | :heavy_minus_sign: | DisplayName is the name of the price |
56
+ | `displayPriceUnitAmount` | *string* | :heavy_minus_sign: | DisplayPriceUnitAmount is the formatted amount of the price unit |
57
+ | `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 |
58
+ | `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
59
+ | `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
60
+ | `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
61
+ | `group` | [models.GroupResponse](../../sdk/models/group-response.md) | :heavy_minus_sign: | N/A |
62
+ | `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
63
+ | `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
64
+ | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
65
+ | `lookupKey` | *string* | :heavy_minus_sign: | LookupKey used for looking up the price in the database |
66
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
67
+ | `meter` | [models.MeterResponse](../../sdk/models/meter-response.md) | :heavy_minus_sign: | N/A |
68
+ | `meterId` | *string* | :heavy_minus_sign: | MeterID is the id of the meter for usage based pricing |
69
+ | `minQuantity` | *string* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
70
+ | `parentPriceId` | *string* | :heavy_minus_sign: | ParentPriceID references the root price (always set for price lineage tracking) |
71
+ | `plan` | [models.PlanResponse](../../sdk/models/plan-response.md) | :heavy_minus_sign: | N/A |
72
+ | `priceUnit` | *string* | :heavy_minus_sign: | PriceUnit is the code of the price unit (e.g., 'btc', 'eth') |
73
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount of the price unit |
74
+ | `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
75
+ | `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
76
+ | `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
77
+ | `pricingUnit` | [models.PriceUnitResponse](../../sdk/models/price-unit-response.md) | :heavy_minus_sign: | N/A |
78
+ | `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 |
79
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
80
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
81
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
82
+ | `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
83
+ | `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
84
+ | `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) |
85
+ | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
86
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
87
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/s3-job-config.md CHANGED
@@ -10,12 +10,13 @@ let value: S3JobConfig = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
15
- | `bucket` | *string* | :heavy_minus_sign: | S3 bucket name |
16
- | `compression` | [models.S3CompressionType](../../sdk/models/s3-compression-type.md) | :heavy_minus_sign: | N/A |
17
- | `encryption` | [models.S3EncryptionType](../../sdk/models/s3-encryption-type.md) | :heavy_minus_sign: | N/A |
18
- | `endpointUrl` | *string* | :heavy_minus_sign: | Custom S3 endpoint URL (e.g., "http://minio:9000" for MinIO) |
19
- | `keyPrefix` | *string* | :heavy_minus_sign: | Optional prefix for S3 keys (e.g., "flexprice-exports/") |
20
- | `region` | *string* | :heavy_minus_sign: | AWS region (e.g., "us-west-2") |
21
- | `usePathStyle` | *boolean* | :heavy_minus_sign: | Use path-style addressing instead of virtual-hosted-style (required for MinIO) |
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
15
+ | `bucket` | *string* | :heavy_minus_sign: | S3 bucket name |
16
+ | `compression` | [models.S3CompressionType](../../sdk/models/s3-compression-type.md) | :heavy_minus_sign: | N/A |
17
+ | `encryption` | [models.S3EncryptionType](../../sdk/models/s3-encryption-type.md) | :heavy_minus_sign: | N/A |
18
+ | `endpointUrl` | *string* | :heavy_minus_sign: | Custom S3 endpoint URL (e.g., "http://minio:9000" for MinIO) |
19
+ | `exportMetadataFields` | [models.ExportMetadataField](../../sdk/models/export-metadata-field.md)[] | :heavy_minus_sign: | Optional user-selected metadata columns |
20
+ | `keyPrefix` | *string* | :heavy_minus_sign: | Optional prefix for S3 keys (e.g., "flexprice-exports/") |
21
+ | `region` | *string* | :heavy_minus_sign: | AWS region (e.g., "us-west-2") |
22
+ | `usePathStyle` | *boolean* | :heavy_minus_sign: | Use path-style addressing (required for MinIO) |
package/docs/sdk/models/scheduled-task-entity-type.md CHANGED
@@ -13,5 +13,5 @@ let value: ScheduledTaskEntityType = "invoice";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "events" | "invoice" | "credit_topups" | "credit_usage" | Unrecognized<string>
16
+ "events" | "invoice" | "credit_topups" | "credit_usage" | "usage_analytics" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/sub-modify-grouped-invoicing-params.md ADDED
@@ -0,0 +1,19 @@
1
+ # SubModifyGroupedInvoicingParams
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubModifyGroupedInvoicingParams } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubModifyGroupedInvoicingParams = {
9
+ action: "remove",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
17
+ | `action` | [models.GroupedInvoicingAction](../../sdk/models/grouped-invoicing-action.md) | :heavy_check_mark: | N/A |
18
+ | `childSubscriptionIds` | *string*[] | :heavy_minus_sign: | N/A |
19
+ | `parentSubscriptionId` | *string* | :heavy_minus_sign: | ParentSubscriptionID is required for action 'add'. |
package/docs/sdk/models/subscription-filter.md CHANGED
@@ -34,4 +34,5 @@ let value: SubscriptionFilter = {};
34
34
  | `subscriptionIds` | *string*[] | :heavy_minus_sign: | N/A |
35
35
  | `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)[] | :heavy_minus_sign: | SubscriptionStatus filters by subscription status |
36
36
  | `subscriptionType` | [models.SubscriptionType](../../sdk/models/subscription-type.md)[] | :heavy_minus_sign: | SubscriptionType filters by subscription type |
37
+ | `trialEndDueLte` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | TrialEndDueLTE, when set, restricts to subscriptions with trial_end not nil and trial_end <= trial_end_due_lte.<br/>Use with subscription_status trialing for trial-end cron processing. |
37
38
  | `withLineItems` | *boolean* | :heavy_minus_sign: | WithLineItems includes line items in the response |
package/docs/sdk/models/subscription-inheritance-config.md CHANGED
@@ -10,8 +10,9 @@ let value: SubscriptionInheritanceConfig = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
15
- | `externalCustomerIdsToInheritSubscription` | *string*[] | :heavy_minus_sign: | N/A |
16
- | `invoicingCustomerExternalId` | *string* | :heavy_minus_sign: | N/A |
17
- | `parentSubscriptionId` | *string* | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `externalCustomerIdsToInheritSubscription` | *string*[] | :heavy_minus_sign: | ExternalCustomerIDsToInheritSubscription: child customer external IDs for which<br/>inherited skeleton subscriptions will be created. Only valid for parent behavior. |
16
+ | `invoicingCustomerExternalId` | *string* | :heavy_minus_sign: | InvoicingCustomerExternalID sets a different billing recipient (external ID).<br/>Required for delegated; rejected for inherited; optional for others. |
17
+ | `parentSubscriptionId` | *string* | :heavy_minus_sign: | ParentSubscriptionID links this subscription to an existing parent.<br/>Required for inherited and grouped_invoicing; rejected for standalone, delegated, parent. |
18
+ | `subscriptionsIdsForGroupedInvoicing` | *string*[] | :heavy_minus_sign: | SubscriptionsIDsForGroupedInvoicing: existing standalone subscription IDs to convert to<br/>grouped_invoicing under this parent at creation time. Only valid for parent behavior. |
package/docs/sdk/models/subscription-line-item-filter-order.md ADDED
@@ -0,0 +1,15 @@
1
+ # SubscriptionLineItemFilterOrder
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionLineItemFilterOrder } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionLineItemFilterOrder = "asc";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "asc" | "desc"
15
+ ```
package/docs/sdk/models/subscription-line-item-filter.md ADDED
@@ -0,0 +1,34 @@
1
+ # SubscriptionLineItemFilter
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionLineItemFilter } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionLineItemFilter = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
15
+ | `activeFilter` | *boolean* | :heavy_minus_sign: | N/A |
16
+ | `addonAssociationIds` | *string*[] | :heavy_minus_sign: | N/A |
17
+ | `billingPeriods` | *string*[] | :heavy_minus_sign: | N/A |
18
+ | `currencies` | *string*[] | :heavy_minus_sign: | N/A |
19
+ | `currentPeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
20
+ | `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
21
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
22
+ | `entityIds` | *string*[] | :heavy_minus_sign: | N/A |
23
+ | `entityType` | [models.SubscriptionLineItemEntityType](../../sdk/models/subscription-line-item-entity-type.md) | :heavy_minus_sign: | N/A |
24
+ | `expand` | *string* | :heavy_minus_sign: | N/A |
25
+ | `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
26
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
27
+ | `meterIds` | *string*[] | :heavy_minus_sign: | N/A |
28
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
29
+ | `order` | [models.SubscriptionLineItemFilterOrder](../../sdk/models/subscription-line-item-filter-order.md) | :heavy_minus_sign: | N/A |
30
+ | `priceIds` | *string*[] | :heavy_minus_sign: | N/A |
31
+ | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
32
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
33
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
34
+ | `subscriptionIds` | *string*[] | :heavy_minus_sign: | Specific filters |
package/docs/sdk/models/subscription-line-item-response.md CHANGED
@@ -78,6 +78,5 @@ let value: SubscriptionLineItemResponse = {
78
78
  | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
79
79
  | `subscriptionPhaseId` | *string* | :heavy_minus_sign: | N/A |
80
80
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
81
- | `trialPeriod` | *number* | :heavy_minus_sign: | N/A |
82
81
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
83
82
  | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-modify-type.md CHANGED
@@ -5,11 +5,11 @@
5
5
  ```typescript
6
6
  import { SubscriptionModifyType } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: SubscriptionModifyType = "quantity_change";
8
+ let value: SubscriptionModifyType = "grouped_invoicing";
9
9
  ```
10
10
 
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "inheritance" | "quantity_change"
14
+ "inheritance" | "quantity_change" | "grouped_invoicing"
15
15
  ```
package/docs/sdk/models/subscription-price-create-request.md CHANGED
@@ -37,5 +37,5 @@ let value: SubscriptionPriceCreateRequest = {
37
37
  | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
38
38
  | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | N/A |
39
39
  | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
40
- | `trialPeriod` | *number* | :heavy_minus_sign: | N/A |
40
+ | `trialPeriodDays` | *number* | :heavy_minus_sign: | N/A |
41
41
  | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/subscription-subscription-line-item.md CHANGED
@@ -48,6 +48,5 @@ let value: SubscriptionSubscriptionLineItem = {};
48
48
  | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
49
49
  | `subscriptionPhaseId` | *string* | :heavy_minus_sign: | N/A |
50
50
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
51
- | `trialPeriod` | *number* | :heavy_minus_sign: | N/A |
52
51
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
53
52
  | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-type.md CHANGED
@@ -13,5 +13,5 @@ let value: SubscriptionType = "inherited";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "standalone" | "parent" | "inherited" | Unrecognized<string>
16
+ "standalone" | "delegated_invoicing" | "parent" | "inherited" | "grouped_invoicing" | Unrecognized<string>
17
17
  ```
package/docs/sdks/scheduledtasks/README.md CHANGED
@@ -101,7 +101,7 @@ const flexprice = new Flexprice({
101
101
  async function run() {
102
102
  const result = await flexprice.scheduledTasks.createScheduledTask({
103
103
  connectionId: "<id>",
104
- entityType: "credit_topups",
104
+ entityType: "credit_usage",
105
105
  interval: "custom",
106
106
  jobConfig: {},
107
107
  });
@@ -129,7 +129,7 @@ const flexprice = new FlexpriceCore({
129
129
  async function run() {
130
130
  const res = await scheduledTasksCreateScheduledTask(flexprice, {
131
131
  connectionId: "<id>",
132
- entityType: "credit_topups",
132
+ entityType: "credit_usage",
133
133
  interval: "custom",
134
134
  jobConfig: {},
135
135
  });