@flexprice/sdk 2.1.11 → 2.1.17

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 (217) hide show
  1. package/docs/sdk/models/changed-subscription.md +7 -5
  2. package/docs/sdk/models/create-invoice-line-item-request.md +25 -22
  3. package/docs/sdk/models/create-user-response.md +1 -0
  4. package/docs/sdk/models/entity-integration-mapping-response.md +1 -0
  5. package/docs/sdk/models/entity-sync-config.md +16 -0
  6. package/docs/sdk/models/execute-subscription-modify-request-request.md +1 -1
  7. package/docs/sdk/models/execute-subscription-modify-request.md +1 -0
  8. package/docs/sdk/models/get-entity-integration-mappings-request.md +19 -0
  9. package/docs/sdk/models/integration-config-entry.md +17 -0
  10. package/docs/sdk/models/integration-config-response.md +15 -0
  11. package/docs/sdk/models/invoice-billing-reason.md +1 -1
  12. package/docs/sdk/models/invoice-filter.md +2 -0
  13. package/docs/sdk/models/invoice-line-item-response.md +38 -36
  14. package/docs/sdk/models/invoice-sync-settings.md +15 -0
  15. package/docs/sdk/models/list-entity-integration-mappings-response.md +16 -0
  16. package/docs/sdk/models/payment-gateway-type.md +1 -1
  17. package/docs/sdk/models/preview-subscription-modify-request.md +1 -1
  18. package/docs/sdk/models/price-price.md +43 -42
  19. package/docs/sdk/models/price-response.md +48 -47
  20. package/docs/sdk/models/s3-export-config.md +20 -0
  21. package/docs/sdk/models/secret-provider.md +1 -1
  22. package/docs/sdk/models/sub-modify-trial-end-request.md +18 -0
  23. package/docs/sdk/models/subscription-modify-type.md +2 -2
  24. package/docs/sdk/models/subscription-response-v2.md +2 -0
  25. package/docs/sdk/models/subscription-response.md +1 -0
  26. package/docs/sdk/models/sync-config.md +23 -0
  27. package/docs/sdk/models/trial-end-action.md +15 -0
  28. package/docs/sdk/models/update-user-request.md +15 -0
  29. package/docs/sdk/models/update-user-response.md +20 -0
  30. package/docs/sdk/models/user-response.md +1 -0
  31. package/docs/sdks/integrations/README.md +143 -0
  32. package/docs/sdks/subscriptions/README.md +2 -2
  33. package/docs/sdks/users/README.md +72 -0
  34. package/esm/funcs/integrations-get-entity-integration-mappings.d.ts +17 -0
  35. package/esm/funcs/integrations-get-entity-integration-mappings.d.ts.map +1 -0
  36. package/esm/funcs/integrations-get-entity-integration-mappings.js +91 -0
  37. package/esm/funcs/integrations-get-entity-integration-mappings.js.map +1 -0
  38. package/esm/funcs/integrations-get-integration-config.d.ts +17 -0
  39. package/esm/funcs/integrations-get-integration-config.d.ts.map +1 -0
  40. package/esm/funcs/integrations-get-integration-config.js +72 -0
  41. package/esm/funcs/integrations-get-integration-config.js.map +1 -0
  42. package/esm/funcs/users-update-user.d.ts +17 -0
  43. package/esm/funcs/users-update-user.d.ts.map +1 -0
  44. package/esm/funcs/users-update-user.js +83 -0
  45. package/esm/funcs/users-update-user.js.map +1 -0
  46. package/esm/lib/config.d.ts +3 -3
  47. package/esm/lib/config.js +3 -3
  48. package/esm/sdk/integrations.d.ts +14 -0
  49. package/esm/sdk/integrations.d.ts.map +1 -1
  50. package/esm/sdk/integrations.js +20 -0
  51. package/esm/sdk/integrations.js.map +1 -1
  52. package/esm/sdk/models/changed-subscription.d.ts +2 -0
  53. package/esm/sdk/models/changed-subscription.d.ts.map +1 -1
  54. package/esm/sdk/models/changed-subscription.js +10 -2
  55. package/esm/sdk/models/changed-subscription.js.map +1 -1
  56. package/esm/sdk/models/create-invoice-line-item-request.d.ts +18 -0
  57. package/esm/sdk/models/create-invoice-line-item-request.d.ts.map +1 -1
  58. package/esm/sdk/models/create-invoice-line-item-request.js +6 -0
  59. package/esm/sdk/models/create-invoice-line-item-request.js.map +1 -1
  60. package/esm/sdk/models/create-user-response.d.ts +3 -0
  61. package/esm/sdk/models/create-user-response.d.ts.map +1 -1
  62. package/esm/sdk/models/create-user-response.js +1 -0
  63. package/esm/sdk/models/create-user-response.js.map +1 -1
  64. package/esm/sdk/models/entity-integration-mapping-response.d.ts +3 -0
  65. package/esm/sdk/models/entity-integration-mapping-response.d.ts.map +1 -1
  66. package/esm/sdk/models/entity-integration-mapping-response.js +1 -0
  67. package/esm/sdk/models/entity-integration-mapping-response.js.map +1 -1
  68. package/esm/sdk/models/entity-sync-config.d.ts +17 -0
  69. package/esm/sdk/models/entity-sync-config.d.ts.map +1 -0
  70. package/esm/sdk/models/entity-sync-config.js +15 -0
  71. package/esm/sdk/models/entity-sync-config.js.map +1 -0
  72. package/esm/sdk/models/execute-subscription-modify-request.d.ts +3 -0
  73. package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
  74. package/esm/sdk/models/execute-subscription-modify-request.js +3 -0
  75. package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
  76. package/esm/sdk/models/get-entity-integration-mappings-op.d.ts +20 -0
  77. package/esm/sdk/models/get-entity-integration-mappings-op.d.ts.map +1 -0
  78. package/esm/sdk/models/get-entity-integration-mappings-op.js +19 -0
  79. package/esm/sdk/models/get-entity-integration-mappings-op.js.map +1 -0
  80. package/esm/sdk/models/index.d.ts +12 -0
  81. package/esm/sdk/models/index.d.ts.map +1 -1
  82. package/esm/sdk/models/index.js +12 -0
  83. package/esm/sdk/models/index.js.map +1 -1
  84. package/esm/sdk/models/integration-config-entry.d.ts +14 -0
  85. package/esm/sdk/models/integration-config-entry.d.ts.map +1 -0
  86. package/esm/sdk/models/integration-config-entry.js +24 -0
  87. package/esm/sdk/models/integration-config-entry.js.map +1 -0
  88. package/esm/sdk/models/integration-config-response.d.ts +11 -0
  89. package/esm/sdk/models/integration-config-response.d.ts.map +1 -0
  90. package/esm/sdk/models/integration-config-response.js +15 -0
  91. package/esm/sdk/models/integration-config-response.js.map +1 -0
  92. package/esm/sdk/models/invoice-billing-reason.d.ts +1 -0
  93. package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
  94. package/esm/sdk/models/invoice-billing-reason.js +1 -0
  95. package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
  96. package/esm/sdk/models/invoice-filter.d.ts +11 -0
  97. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  98. package/esm/sdk/models/invoice-filter.js +4 -0
  99. package/esm/sdk/models/invoice-filter.js.map +1 -1
  100. package/esm/sdk/models/invoice-line-item-response.d.ts +11 -0
  101. package/esm/sdk/models/invoice-line-item-response.d.ts.map +1 -1
  102. package/esm/sdk/models/invoice-line-item-response.js +4 -0
  103. package/esm/sdk/models/invoice-line-item-response.js.map +1 -1
  104. package/esm/sdk/models/invoice-sync-settings.d.ts +11 -0
  105. package/esm/sdk/models/invoice-sync-settings.d.ts.map +1 -0
  106. package/esm/sdk/models/invoice-sync-settings.js +20 -0
  107. package/esm/sdk/models/invoice-sync-settings.js.map +1 -0
  108. package/esm/sdk/models/list-entity-integration-mappings-response.d.ts +13 -0
  109. package/esm/sdk/models/list-entity-integration-mappings-response.d.ts.map +1 -0
  110. package/esm/sdk/models/list-entity-integration-mappings-response.js +17 -0
  111. package/esm/sdk/models/list-entity-integration-mappings-response.js.map +1 -0
  112. package/esm/sdk/models/payment-gateway-type.d.ts +1 -0
  113. package/esm/sdk/models/payment-gateway-type.d.ts.map +1 -1
  114. package/esm/sdk/models/payment-gateway-type.js +1 -0
  115. package/esm/sdk/models/payment-gateway-type.js.map +1 -1
  116. package/esm/sdk/models/price-price.d.ts +9 -0
  117. package/esm/sdk/models/price-price.d.ts.map +1 -1
  118. package/esm/sdk/models/price-price.js +1 -0
  119. package/esm/sdk/models/price-price.js.map +1 -1
  120. package/esm/sdk/models/price-response.d.ts +9 -0
  121. package/esm/sdk/models/price-response.d.ts.map +1 -1
  122. package/esm/sdk/models/price-response.js +1 -0
  123. package/esm/sdk/models/price-response.js.map +1 -1
  124. package/esm/sdk/models/s3-export-config.d.ts +29 -0
  125. package/esm/sdk/models/s3-export-config.d.ts.map +1 -0
  126. package/esm/sdk/models/s3-export-config.js +27 -0
  127. package/esm/sdk/models/s3-export-config.js.map +1 -0
  128. package/esm/sdk/models/secret-provider.d.ts +1 -0
  129. package/esm/sdk/models/secret-provider.d.ts.map +1 -1
  130. package/esm/sdk/models/secret-provider.js +1 -0
  131. package/esm/sdk/models/secret-provider.js.map +1 -1
  132. package/esm/sdk/models/sub-modify-trial-end-request.d.ts +18 -0
  133. package/esm/sdk/models/sub-modify-trial-end-request.d.ts.map +1 -0
  134. package/esm/sdk/models/sub-modify-trial-end-request.js +19 -0
  135. package/esm/sdk/models/sub-modify-trial-end-request.js.map +1 -0
  136. package/esm/sdk/models/subscription-modify-type.d.ts +1 -0
  137. package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
  138. package/esm/sdk/models/subscription-modify-type.js +1 -0
  139. package/esm/sdk/models/subscription-modify-type.js.map +1 -1
  140. package/esm/sdk/models/subscription-response-v2.d.ts +16 -0
  141. package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
  142. package/esm/sdk/models/subscription-response-v2.js +4 -0
  143. package/esm/sdk/models/subscription-response-v2.js.map +1 -1
  144. package/esm/sdk/models/subscription-response.d.ts +8 -0
  145. package/esm/sdk/models/subscription-response.d.ts.map +1 -1
  146. package/esm/sdk/models/subscription-response.js +2 -0
  147. package/esm/sdk/models/subscription-response.js.map +1 -1
  148. package/esm/sdk/models/sync-config.d.ts +21 -0
  149. package/esm/sdk/models/sync-config.d.ts.map +1 -0
  150. package/esm/sdk/models/sync-config.js +31 -0
  151. package/esm/sdk/models/sync-config.js.map +1 -0
  152. package/esm/sdk/models/trial-end-action.d.ts +10 -0
  153. package/esm/sdk/models/trial-end-action.d.ts.map +1 -0
  154. package/esm/sdk/models/trial-end-action.js +11 -0
  155. package/esm/sdk/models/trial-end-action.js.map +1 -0
  156. package/esm/sdk/models/update-user-request.d.ts +16 -0
  157. package/esm/sdk/models/update-user-request.d.ts.map +1 -0
  158. package/esm/sdk/models/update-user-request.js +12 -0
  159. package/esm/sdk/models/update-user-request.js.map +1 -0
  160. package/esm/sdk/models/update-user-response.d.ts +22 -0
  161. package/esm/sdk/models/update-user-response.d.ts.map +1 -0
  162. package/esm/sdk/models/update-user-response.js +21 -0
  163. package/esm/sdk/models/update-user-response.js.map +1 -0
  164. package/esm/sdk/models/user-response.d.ts +3 -0
  165. package/esm/sdk/models/user-response.d.ts.map +1 -1
  166. package/esm/sdk/models/user-response.js +1 -0
  167. package/esm/sdk/models/user-response.js.map +1 -1
  168. package/esm/sdk/users.d.ts +7 -0
  169. package/esm/sdk/users.d.ts.map +1 -1
  170. package/esm/sdk/users.js +10 -0
  171. package/esm/sdk/users.js.map +1 -1
  172. package/esm/types/async.d.ts.map +1 -1
  173. package/esm/types/async.js +6 -6
  174. package/esm/types/async.js.map +1 -1
  175. package/esm/types/primitives.d.ts +0 -2
  176. package/esm/types/primitives.d.ts.map +1 -1
  177. package/esm/types/primitives.js +0 -22
  178. package/esm/types/primitives.js.map +1 -1
  179. package/jsr.json +1 -1
  180. package/package.json +1 -1
  181. package/src/funcs/integrations-get-entity-integration-mappings.ts +186 -0
  182. package/src/funcs/integrations-get-integration-config.ts +152 -0
  183. package/src/funcs/users-update-user.ts +172 -0
  184. package/src/lib/config.ts +3 -3
  185. package/src/sdk/integrations.ts +36 -0
  186. package/src/sdk/models/changed-subscription.ts +18 -5
  187. package/src/sdk/models/create-invoice-line-item-request.ts +24 -0
  188. package/src/sdk/models/create-user-response.ts +2 -0
  189. package/src/sdk/models/entity-integration-mapping-response.ts +2 -0
  190. package/src/sdk/models/entity-sync-config.ts +39 -0
  191. package/src/sdk/models/execute-subscription-modify-request.ts +9 -0
  192. package/src/sdk/models/get-entity-integration-mappings-op.ts +50 -0
  193. package/src/sdk/models/index.ts +12 -0
  194. package/src/sdk/models/integration-config-entry.ts +49 -0
  195. package/src/sdk/models/integration-config-response.ts +35 -0
  196. package/src/sdk/models/invoice-billing-reason.ts +1 -0
  197. package/src/sdk/models/invoice-filter.ts +17 -0
  198. package/src/sdk/models/invoice-line-item-response.ts +15 -0
  199. package/src/sdk/models/invoice-sync-settings.ts +43 -0
  200. package/src/sdk/models/list-entity-integration-mappings-response.ts +44 -0
  201. package/src/sdk/models/payment-gateway-type.ts +1 -0
  202. package/src/sdk/models/price-price.ts +10 -0
  203. package/src/sdk/models/price-response.ts +10 -0
  204. package/src/sdk/models/s3-export-config.ts +70 -0
  205. package/src/sdk/models/secret-provider.ts +1 -0
  206. package/src/sdk/models/sub-modify-trial-end-request.ts +50 -0
  207. package/src/sdk/models/subscription-modify-type.ts +1 -0
  208. package/src/sdk/models/subscription-response-v2.ts +20 -0
  209. package/src/sdk/models/subscription-response.ts +10 -0
  210. package/src/sdk/models/sync-config.ts +65 -0
  211. package/src/sdk/models/trial-end-action.ts +17 -0
  212. package/src/sdk/models/update-user-request.ts +30 -0
  213. package/src/sdk/models/update-user-response.ts +49 -0
  214. package/src/sdk/models/user-response.ts +2 -0
  215. package/src/sdk/users.ts +18 -0
  216. package/src/types/async.ts +8 -7
  217. package/src/types/primitives.ts +0 -26
package/docs/sdk/models/changed-subscription.md CHANGED
@@ -10,8 +10,10 @@ let value: ChangedSubscription = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
15
- | `action` | [models.ChangedSubscriptionAction](../../sdk/models/changed-subscription-action.md) | :heavy_minus_sign: | created \| updated |
16
- | `id` | *string* | :heavy_minus_sign: | N/A |
17
- | `status` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `action` | [models.ChangedSubscriptionAction](../../sdk/models/changed-subscription-action.md) | :heavy_minus_sign: | created \| updated |
16
+ | `currentPeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
+ | `id` | *string* | :heavy_minus_sign: | N/A |
18
+ | `status` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
19
+ | `trialEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-invoice-line-item-request.md CHANGED
@@ -13,25 +13,28 @@ let value: CreateInvoiceLineItemRequest = {
13
13
 
14
14
  ## Fields
15
15
 
16
- | Field | Type | Required | Description |
17
- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
18
- | `amount` | *string* | :heavy_check_mark: | amount is the monetary amount for this line item |
19
- | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
20
- | `displayName` | *string* | :heavy_minus_sign: | display_name is the optional human-readable name for this line item |
21
- | `entityId` | *string* | :heavy_minus_sign: | entity_id is the optional unique identifier of the entity associated with this line item |
22
- | `entityType` | *string* | :heavy_minus_sign: | entity_type is the optional type of the entity associated with this line item |
23
- | `invoiceLevelDiscount` | *string* | :heavy_minus_sign: | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice. |
24
- | `lineItemDiscount` | *string* | :heavy_minus_sign: | line_item_discount is the discount amount in invoice currency applied directly to this line item. |
25
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
26
- | `meterDisplayName` | *string* | :heavy_minus_sign: | meter_display_name is the optional human-readable name of the meter |
27
- | `meterId` | *string* | :heavy_minus_sign: | meter_id is the optional unique identifier of the meter used for usage tracking |
28
- | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | period_end is the optional end date of the period this line item covers |
29
- | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | period_start is the optional start date of the period this line item covers |
30
- | `planDisplayName` | *string* | :heavy_minus_sign: | plan_display_name is the optional human-readable name of the plan |
31
- | `planId` | *string* | :heavy_minus_sign: | TODO: !REMOVE after migration<br/>plan_id is the optional unique identifier of the plan associated with this line item |
32
- | `prepaidCreditsApplied` | *string* | :heavy_minus_sign: | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application. |
33
- | `priceId` | *string* | :heavy_minus_sign: | price_id is the optional unique identifier of the price associated with this line item |
34
- | `priceType` | *string* | :heavy_minus_sign: | price_type indicates the type of pricing (fixed, usage, tiered, etc.) |
35
- | `priceUnit` | *string* | :heavy_minus_sign: | price_unit is the optional 3-digit ISO code of the price unit associated with this line item |
36
- | `priceUnitAmount` | *string* | :heavy_minus_sign: | price_unit_amount is the optional amount converted to the price unit currency |
37
- | `quantity` | *string* | :heavy_check_mark: | quantity is the quantity of units for this line item |
16
+ | Field | Type | Required | Description |
17
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
+ | `adjustedEntitlementQuantity` | *string* | :heavy_minus_sign: | adjusted_entitlement_quantity is the entitlement-covered units deducted from raw usage. |
19
+ | `amount` | *string* | :heavy_check_mark: | amount is the monetary amount for this line item |
20
+ | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
21
+ | `displayName` | *string* | :heavy_minus_sign: | display_name is the optional human-readable name for this line item |
22
+ | `entityId` | *string* | :heavy_minus_sign: | entity_id is the optional unique identifier of the entity associated with this line item |
23
+ | `entityType` | *string* | :heavy_minus_sign: | entity_type is the optional type of the entity associated with this line item |
24
+ | `invoiceLevelDiscount` | *string* | :heavy_minus_sign: | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice. |
25
+ | `lineItemDiscount` | *string* | :heavy_minus_sign: | line_item_discount is the discount amount in invoice currency applied directly to this line item. |
26
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
27
+ | `meterDisplayName` | *string* | :heavy_minus_sign: | meter_display_name is the optional human-readable name of the meter |
28
+ | `meterId` | *string* | :heavy_minus_sign: | meter_id is the optional unique identifier of the meter used for usage tracking |
29
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | period_end is the optional end date of the period this line item covers |
30
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | period_start is the optional start date of the period this line item covers |
31
+ | `planDisplayName` | *string* | :heavy_minus_sign: | plan_display_name is the optional human-readable name of the plan |
32
+ | `planId` | *string* | :heavy_minus_sign: | TODO: !REMOVE after migration<br/>plan_id is the optional unique identifier of the plan associated with this line item |
33
+ | `prepaidCreditsApplied` | *string* | :heavy_minus_sign: | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application. |
34
+ | `priceId` | *string* | :heavy_minus_sign: | price_id is the optional unique identifier of the price associated with this line item |
35
+ | `priceType` | *string* | :heavy_minus_sign: | price_type indicates the type of pricing (fixed, usage, tiered, etc.) |
36
+ | `priceUnit` | *string* | :heavy_minus_sign: | price_unit is the optional 3-digit ISO code of the price unit associated with this line item |
37
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | price_unit_amount is the optional amount converted to the price unit currency |
38
+ | `quantity` | *string* | :heavy_check_mark: | quantity is the quantity of units for this line item |
39
+ | `subscriptionId` | *string* | :heavy_minus_sign: | subscription_id overrides the invoice's subscription_id for this specific line item.<br/>Used for grouped invoicing where child line items belong to child subscriptions. |
40
+ | `subscriptionLineItemId` | *string* | :heavy_minus_sign: | sub_line_item_id links this line item to the subscription_line_item that generated it. |
package/docs/sdk/models/create-user-response.md CHANGED
@@ -14,6 +14,7 @@ let value: CreateUserResponse = {};
14
14
  | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
15
15
  | `email` | *string* | :heavy_minus_sign: | Empty for service accounts |
16
16
  | `id` | *string* | :heavy_minus_sign: | N/A |
17
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
17
18
  | `password` | *string* | :heavy_minus_sign: | N/A |
18
19
  | `roles` | *string*[] | :heavy_minus_sign: | N/A |
19
20
  | `tenant` | [models.TenantResponse](../../sdk/models/tenant-response.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/entity-integration-mapping-response.md CHANGED
@@ -18,6 +18,7 @@ let value: EntityIntegrationMappingResponse = {};
18
18
  | `entityType` | [models.IntegrationEntityType](../../sdk/models/integration-entity-type.md) | :heavy_minus_sign: | N/A |
19
19
  | `environmentId` | *string* | :heavy_minus_sign: | N/A |
20
20
  | `id` | *string* | :heavy_minus_sign: | N/A |
21
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
21
22
  | `providerEntityId` | *string* | :heavy_minus_sign: | N/A |
22
23
  | `providerType` | *string* | :heavy_minus_sign: | N/A |
23
24
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/entity-sync-config.md ADDED
@@ -0,0 +1,16 @@
1
+ # EntitySyncConfig
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { EntitySyncConfig } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: EntitySyncConfig = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
15
+ | `inbound` | *boolean* | :heavy_minus_sign: | Inbound from external provider to FlexPrice |
16
+ | `outbound` | *boolean* | :heavy_minus_sign: | Outbound from FlexPrice to external provider |
package/docs/sdk/models/execute-subscription-modify-request-request.md CHANGED
@@ -8,7 +8,7 @@ import { ExecuteSubscriptionModifyRequestRequest } from "@flexprice/sdk/sdk/mode
8
8
  let value: ExecuteSubscriptionModifyRequestRequest = {
9
9
  id: "<id>",
10
10
  body: {
11
- type: "quantity_change",
11
+ type: "grouped_invoicing",
12
12
  },
13
13
  };
14
14
  ```
package/docs/sdk/models/execute-subscription-modify-request.md CHANGED
@@ -17,4 +17,5 @@ let value: ExecuteSubscriptionModifyRequest = {
17
17
  | `groupedInvoicingParams` | [models.SubModifyGroupedInvoicingParams](../../sdk/models/sub-modify-grouped-invoicing-params.md) | :heavy_minus_sign: | N/A |
18
18
  | `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
19
19
  | `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
20
+ | `trialEndParams` | [models.SubModifyTrialEndRequest](../../sdk/models/sub-modify-trial-end-request.md) | :heavy_minus_sign: | N/A |
20
21
  | `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/get-entity-integration-mappings-request.md ADDED
@@ -0,0 +1,19 @@
1
+ # GetEntityIntegrationMappingsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GetEntityIntegrationMappingsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GetEntityIntegrationMappingsRequest = {
9
+ entityType: "<value>",
10
+ entityId: "<id>",
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
18
+ | `entityType` | *string* | :heavy_check_mark: | Entity type (customer, plan, invoice, subscription, payment, credit_note, addon, item, item_price, price) |
19
+ | `entityId` | *string* | :heavy_check_mark: | Entity ID |
package/docs/sdk/models/integration-config-entry.md ADDED
@@ -0,0 +1,17 @@
1
+ # IntegrationConfigEntry
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { IntegrationConfigEntry } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: IntegrationConfigEntry = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
15
+ | `baseConfig` | [models.SyncConfig](../../sdk/models/sync-config.md) | :heavy_minus_sign: | N/A |
16
+ | `currentConfig` | [models.SyncConfig](../../sdk/models/sync-config.md) | :heavy_minus_sign: | N/A |
17
+ | `provider` | [models.SecretProvider](../../sdk/models/secret-provider.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/integration-config-response.md ADDED
@@ -0,0 +1,15 @@
1
+ # IntegrationConfigResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { IntegrationConfigResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: IntegrationConfigResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
15
+ | `integrations` | [models.IntegrationConfigEntry](../../sdk/models/integration-config-entry.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-billing-reason.md CHANGED
@@ -11,5 +11,5 @@ let value: InvoiceBillingReason = "SUBSCRIPTION_UPDATE";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD"
14
+ "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP"
15
15
  ```
package/docs/sdk/models/invoice-filter.md CHANGED
@@ -14,6 +14,8 @@ let value: InvoiceFilter = {};
14
14
  | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `amountDueGt` | *number* | :heavy_minus_sign: | amount_due_gt filters invoices with a total amount due greater than the specified value<br/>Useful for finding invoices above a certain threshold or identifying high-value invoices |
16
16
  | `amountRemainingGt` | *number* | :heavy_minus_sign: | amount_remaining_gt filters invoices with an outstanding balance greater than the specified value<br/>Useful for finding invoices that still have significant unpaid amounts |
17
+ | `billingReason` | [models.InvoiceBillingReason](../../sdk/models/invoice-billing-reason.md) | :heavy_minus_sign: | N/A |
18
+ | `currency` | *string* | :heavy_minus_sign: | currency filters invoices by their currency (ISO 4217 code, e.g. "usd", "eur").<br/>Matches on the invoices.currency column exactly. |
17
19
  | `customerId` | *string* | :heavy_minus_sign: | customer_id filters invoices for a specific customer using FlexPrice's internal customer ID<br/>This is the ID returned by FlexPrice when creating or retrieving customers |
18
20
  | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
21
  | `expand` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-line-item-response.md CHANGED
@@ -10,39 +10,41 @@ let value: InvoiceLineItemResponse = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | N/A |
16
- | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
17
- | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
- | `createdBy` | *string* | :heavy_minus_sign: | N/A |
19
- | `currency` | *string* | :heavy_minus_sign: | N/A |
20
- | `customerId` | *string* | :heavy_minus_sign: | N/A |
21
- | `displayName` | *string* | :heavy_minus_sign: | N/A |
22
- | `entityId` | *string* | :heavy_minus_sign: | N/A |
23
- | `entityType` | *string* | :heavy_minus_sign: | N/A |
24
- | `environmentId` | *string* | :heavy_minus_sign: | N/A |
25
- | `id` | *string* | :heavy_minus_sign: | N/A |
26
- | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
27
- | `invoiceLevelDiscount` | *string* | :heavy_minus_sign: | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice. |
28
- | `lineItemDiscount` | *string* | :heavy_minus_sign: | line_item_discount is the discount amount in invoice currency applied directly to this line item. |
29
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
30
- | `meterDisplayName` | *string* | :heavy_minus_sign: | N/A |
31
- | `meterId` | *string* | :heavy_minus_sign: | N/A |
32
- | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
33
- | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
34
- | `planDisplayName` | *string* | :heavy_minus_sign: | N/A |
35
- | `prepaidCreditsApplied` | *string* | :heavy_minus_sign: | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application. |
36
- | `priceId` | *string* | :heavy_minus_sign: | N/A |
37
- | `priceType` | *string* | :heavy_minus_sign: | N/A |
38
- | `priceUnit` | *string* | :heavy_minus_sign: | N/A |
39
- | `priceUnitAmount` | *string* | :heavy_minus_sign: | N/A |
40
- | `priceUnitId` | *string* | :heavy_minus_sign: | N/A |
41
- | `quantity` | *string* | :heavy_minus_sign: | N/A |
42
- | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
43
- | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
44
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
45
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
46
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
47
- | `usageAnalytics` | [models.SourceUsageItem](../../sdk/models/source-usage-item.md)[] | :heavy_minus_sign: | usage_analytics contains usage analytics for this line item (legacy - grouped by source) |
48
- | `usageBreakdown` | [models.UsageBreakdownItem](../../sdk/models/usage-breakdown-item.md)[] | :heavy_minus_sign: | usage_breakdown contains flexible usage breakdown for this line item (supports any grouping) |
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `adjustedEntitlementQuantity` | *string* | :heavy_minus_sign: | adjusted_entitlement_quantity is the entitlement-covered portion deducted from raw usage.<br/>Nil when no entitlement was applied. Raw usage = Quantity + AdjustedEntitlementQuantity. |
16
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
17
+ | `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
18
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
20
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
21
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
22
+ | `displayName` | *string* | :heavy_minus_sign: | N/A |
23
+ | `entityId` | *string* | :heavy_minus_sign: | N/A |
24
+ | `entityType` | *string* | :heavy_minus_sign: | N/A |
25
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
26
+ | `id` | *string* | :heavy_minus_sign: | N/A |
27
+ | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
28
+ | `invoiceLevelDiscount` | *string* | :heavy_minus_sign: | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice. |
29
+ | `lineItemDiscount` | *string* | :heavy_minus_sign: | line_item_discount is the discount amount in invoice currency applied directly to this line item. |
30
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
31
+ | `meterDisplayName` | *string* | :heavy_minus_sign: | N/A |
32
+ | `meterId` | *string* | :heavy_minus_sign: | N/A |
33
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
34
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
35
+ | `planDisplayName` | *string* | :heavy_minus_sign: | N/A |
36
+ | `prepaidCreditsApplied` | *string* | :heavy_minus_sign: | prepaid_credits_applied is the amount in invoice currency reduced from this line item due to prepaid credits application. |
37
+ | `priceId` | *string* | :heavy_minus_sign: | N/A |
38
+ | `priceType` | *string* | :heavy_minus_sign: | N/A |
39
+ | `priceUnit` | *string* | :heavy_minus_sign: | N/A |
40
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | N/A |
41
+ | `priceUnitId` | *string* | :heavy_minus_sign: | N/A |
42
+ | `quantity` | *string* | :heavy_minus_sign: | N/A |
43
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
44
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
45
+ | `subscriptionLineItemId` | *string* | :heavy_minus_sign: | sub_line_item_id links this invoice line item to the subscription_line_item that generated it. |
46
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
47
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
48
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
49
+ | `usageAnalytics` | [models.SourceUsageItem](../../sdk/models/source-usage-item.md)[] | :heavy_minus_sign: | usage_analytics contains usage analytics for this line item (legacy - grouped by source) |
50
+ | `usageBreakdown` | [models.UsageBreakdownItem](../../sdk/models/usage-breakdown-item.md)[] | :heavy_minus_sign: | usage_breakdown contains flexible usage breakdown for this line item (supports any grouping) |
package/docs/sdk/models/invoice-sync-settings.md ADDED
@@ -0,0 +1,15 @@
1
+ # InvoiceSyncSettings
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InvoiceSyncSettings } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InvoiceSyncSettings = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
15
+ | `normalizeFixedTo` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/list-entity-integration-mappings-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListEntityIntegrationMappingsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListEntityIntegrationMappingsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListEntityIntegrationMappingsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
15
+ | `items` | [models.EntityIntegrationMappingResponse](../../sdk/models/entity-integration-mapping-response.md)[] | :heavy_minus_sign: | N/A |
16
+ | `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/payment-gateway-type.md CHANGED
@@ -11,5 +11,5 @@ let value: PaymentGatewayType = "moyasar";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "stripe" | "razorpay" | "nomod" | "moyasar" | "paddle"
14
+ "stripe" | "razorpay" | "nomod" | "moyasar" | "paddle" | "whop"
15
15
  ```
package/docs/sdk/models/preview-subscription-modify-request.md CHANGED
@@ -8,7 +8,7 @@ import { PreviewSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
8
8
  let value: PreviewSubscriptionModifyRequest = {
9
9
  id: "<id>",
10
10
  body: {
11
- type: "quantity_change",
11
+ type: "grouped_invoicing",
12
12
  },
13
13
  };
14
14
  ```