@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/price-price.md CHANGED
@@ -10,45 +10,46 @@ 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
- | `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 |
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
+ | `sequence` | *number* | :heavy_minus_sign: | Sequence is the monotonic stamp bumped on every state change that<br/>subscription line items need to react to. Read by the plan-price sync;<br/>set by the database (DEFAULT nextval) on create and by the price<br/>repository on termination / compatibility-affecting edits. |
46
+ | `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 |
47
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
48
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
49
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
50
+ | `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
51
+ | `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
52
+ | `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) |
53
+ | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
54
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
55
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-response.md CHANGED
@@ -38,50 +38,51 @@ 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
- | `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 |
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
+ | `sequence` | *number* | :heavy_minus_sign: | Sequence is the monotonic stamp bumped on every state change that<br/>subscription line items need to react to. Read by the plan-price sync;<br/>set by the database (DEFAULT nextval) on create and by the price<br/>repository on termination / compatibility-affecting edits. |
79
+ | `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 |
80
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
81
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
82
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
83
+ | `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
84
+ | `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
85
+ | `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) |
86
+ | `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
87
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
88
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/s3-export-config.md ADDED
@@ -0,0 +1,20 @@
1
+ # S3ExportConfig
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { S3ExportConfig } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: S3ExportConfig = {};
9
+ ```
10
+
11
+ ## Fields
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
+ | `isFlexpriceManaged` | *boolean* | :heavy_minus_sign: | If true, use Flexprice-managed S3 credentials instead of user-provided |
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") |
package/docs/sdk/models/secret-provider.md CHANGED
@@ -13,5 +13,5 @@ let value: SecretProvider = "quickbooks";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | Unrecognized<string>
16
+ "flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | "whop" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/sub-modify-trial-end-request.md ADDED
@@ -0,0 +1,18 @@
1
+ # SubModifyTrialEndRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubModifyTrialEndRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubModifyTrialEndRequest = {
9
+ action: "immediate",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
17
+ | `action` | [models.TrialEndAction](../../sdk/models/trial-end-action.md) | :heavy_check_mark: | N/A |
18
+ | `newTrialEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | NewTrialEnd is the new trial end date. Required when action is "scheduled_date". |
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 = "grouped_invoicing";
8
+ let value: SubscriptionModifyType = "trial_end";
9
9
  ```
10
10
 
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "inheritance" | "quantity_change" | "grouped_invoicing"
14
+ "inheritance" | "quantity_change" | "grouped_invoicing" | "trial_end"
15
15
  ```