@flexprice/sdk 2.1.48 → 2.1.49-dev.10

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 (212) hide show
  1. package/docs/sdk/models/billing-address.md +20 -0
  2. package/docs/sdk/models/billing-details.md +18 -0
  3. package/docs/sdk/models/billing-entity-mode-response.md +15 -0
  4. package/docs/sdk/models/billing-entity-mode.md +17 -0
  5. package/docs/sdk/models/billing-entity-response.md +27 -0
  6. package/docs/sdk/models/billingterm-instalment.md +1 -0
  7. package/docs/sdk/models/create-billing-entity-request.md +21 -0
  8. package/docs/sdk/models/create-customer-request.md +1 -0
  9. package/docs/sdk/models/customer-filter.md +1 -0
  10. package/docs/sdk/models/customer-response.md +1 -0
  11. package/docs/sdk/models/customer.md +1 -0
  12. package/docs/sdk/models/get-billing-entity-request.md +17 -0
  13. package/docs/sdk/models/get-usage-analytics-request.md +1 -1
  14. package/docs/sdk/models/get-usage-analytics-response.md +10 -8
  15. package/docs/sdk/models/invoice-billing-entity.md +17 -0
  16. package/docs/sdk/models/invoice-filter.md +1 -0
  17. package/docs/sdk/models/invoice-response.md +2 -0
  18. package/docs/sdk/models/list-billing-entities-order.md +15 -0
  19. package/docs/sdk/models/list-billing-entities-request.md +22 -0
  20. package/docs/sdk/models/list-billing-entities-response.md +16 -0
  21. package/docs/sdk/models/list-billing-entities-status.md +15 -0
  22. package/docs/sdk/models/tax-rate-entity-type.md +2 -2
  23. package/docs/sdk/models/update-billing-entity-request-request.md +19 -0
  24. package/docs/sdk/models/update-billing-entity-request.md +18 -0
  25. package/docs/sdk/models/update-customer-request.md +1 -0
  26. package/docs/sdk/models/usage-analytic-instalment.md +24 -0
  27. package/docs/sdk/models/webhook-dto-customer.md +1 -0
  28. package/docs/sdk/models/webhook-dto-invoice.md +1 -0
  29. package/docs/sdks/billingentities/README.md +442 -0
  30. package/docs/sdks/subscriptions/README.md +1 -1
  31. package/esm/funcs/billing-entities-create-billing-entity.d.ts +17 -0
  32. package/esm/funcs/billing-entities-create-billing-entity.d.ts.map +1 -0
  33. package/esm/funcs/billing-entities-create-billing-entity.js +83 -0
  34. package/esm/funcs/billing-entities-create-billing-entity.js.map +1 -0
  35. package/esm/funcs/billing-entities-enable-billing-entities.d.ts +17 -0
  36. package/esm/funcs/billing-entities-enable-billing-entities.d.ts.map +1 -0
  37. package/esm/funcs/billing-entities-enable-billing-entities.js +72 -0
  38. package/esm/funcs/billing-entities-enable-billing-entities.js.map +1 -0
  39. package/esm/funcs/billing-entities-get-billing-entities-status.d.ts +17 -0
  40. package/esm/funcs/billing-entities-get-billing-entities-status.d.ts.map +1 -0
  41. package/esm/funcs/billing-entities-get-billing-entities-status.js +72 -0
  42. package/esm/funcs/billing-entities-get-billing-entities-status.js.map +1 -0
  43. package/esm/funcs/billing-entities-get-billing-entity.d.ts +17 -0
  44. package/esm/funcs/billing-entities-get-billing-entity.d.ts.map +1 -0
  45. package/esm/funcs/billing-entities-get-billing-entity.js +91 -0
  46. package/esm/funcs/billing-entities-get-billing-entity.js.map +1 -0
  47. package/esm/funcs/billing-entities-list-billing-entities.d.ts +17 -0
  48. package/esm/funcs/billing-entities-list-billing-entities.d.ts.map +1 -0
  49. package/esm/funcs/billing-entities-list-billing-entities.js +94 -0
  50. package/esm/funcs/billing-entities-list-billing-entities.js.map +1 -0
  51. package/esm/funcs/billing-entities-update-billing-entity.d.ts +17 -0
  52. package/esm/funcs/billing-entities-update-billing-entity.d.ts.map +1 -0
  53. package/esm/funcs/billing-entities-update-billing-entity.js +93 -0
  54. package/esm/funcs/billing-entities-update-billing-entity.js.map +1 -0
  55. package/esm/funcs/subscriptions-cancel-subscription.js +1 -1
  56. package/esm/funcs/subscriptions-cancel-subscription.js.map +1 -1
  57. package/esm/lib/config.d.ts +2 -2
  58. package/esm/lib/config.d.ts.map +1 -1
  59. package/esm/lib/config.js +2 -2
  60. package/esm/lib/config.js.map +1 -1
  61. package/esm/sdk/billing-entities.d.ts +47 -0
  62. package/esm/sdk/billing-entities.d.ts.map +1 -0
  63. package/esm/sdk/billing-entities.js +68 -0
  64. package/esm/sdk/billing-entities.js.map +1 -0
  65. package/esm/sdk/models/billing-address.d.ts +27 -0
  66. package/esm/sdk/models/billing-address.d.ts.map +1 -0
  67. package/esm/sdk/models/billing-address.js +50 -0
  68. package/esm/sdk/models/billing-address.js.map +1 -0
  69. package/esm/sdk/models/billing-details.d.ts +24 -0
  70. package/esm/sdk/models/billing-details.d.ts.map +1 -0
  71. package/esm/sdk/models/billing-details.js +37 -0
  72. package/esm/sdk/models/billing-details.js.map +1 -0
  73. package/esm/sdk/models/billing-entity-mode-response.d.ts +11 -0
  74. package/esm/sdk/models/billing-entity-mode-response.d.ts.map +1 -0
  75. package/esm/sdk/models/billing-entity-mode-response.js +15 -0
  76. package/esm/sdk/models/billing-entity-mode-response.js.map +1 -0
  77. package/esm/sdk/models/billing-entity-mode.d.ts +11 -0
  78. package/esm/sdk/models/billing-entity-mode.d.ts.map +1 -0
  79. package/esm/sdk/models/billing-entity-mode.js +12 -0
  80. package/esm/sdk/models/billing-entity-mode.js.map +1 -0
  81. package/esm/sdk/models/billing-entity-response.d.ts +26 -0
  82. package/esm/sdk/models/billing-entity-response.d.ts.map +1 -0
  83. package/esm/sdk/models/billing-entity-response.js +41 -0
  84. package/esm/sdk/models/billing-entity-response.js.map +1 -0
  85. package/esm/sdk/models/billingterm-instalment.d.ts +4 -0
  86. package/esm/sdk/models/billingterm-instalment.d.ts.map +1 -1
  87. package/esm/sdk/models/billingterm-instalment.js +2 -0
  88. package/esm/sdk/models/billingterm-instalment.js.map +1 -1
  89. package/esm/sdk/models/create-billing-entity-request.d.ts +23 -0
  90. package/esm/sdk/models/create-billing-entity-request.d.ts.map +1 -0
  91. package/esm/sdk/models/create-billing-entity-request.js +22 -0
  92. package/esm/sdk/models/create-billing-entity-request.js.map +1 -0
  93. package/esm/sdk/models/create-customer-request.d.ts +8 -0
  94. package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
  95. package/esm/sdk/models/create-customer-request.js +2 -0
  96. package/esm/sdk/models/create-customer-request.js.map +1 -1
  97. package/esm/sdk/models/customer-filter.d.ts +5 -0
  98. package/esm/sdk/models/customer-filter.d.ts.map +1 -1
  99. package/esm/sdk/models/customer-filter.js +2 -0
  100. package/esm/sdk/models/customer-filter.js.map +1 -1
  101. package/esm/sdk/models/customer-response.d.ts +4 -0
  102. package/esm/sdk/models/customer-response.d.ts.map +1 -1
  103. package/esm/sdk/models/customer-response.js +2 -0
  104. package/esm/sdk/models/customer-response.js.map +1 -1
  105. package/esm/sdk/models/customer.d.ts +4 -0
  106. package/esm/sdk/models/customer.d.ts.map +1 -1
  107. package/esm/sdk/models/customer.js +2 -0
  108. package/esm/sdk/models/customer.js.map +1 -1
  109. package/esm/sdk/models/get-billing-entity-op.d.ts +15 -0
  110. package/esm/sdk/models/get-billing-entity-op.d.ts.map +1 -0
  111. package/esm/sdk/models/get-billing-entity-op.js +12 -0
  112. package/esm/sdk/models/get-billing-entity-op.js.map +1 -0
  113. package/esm/sdk/models/get-usage-analytics-request.d.ts +1 -1
  114. package/esm/sdk/models/get-usage-analytics-response.d.ts +12 -0
  115. package/esm/sdk/models/get-usage-analytics-response.d.ts.map +1 -1
  116. package/esm/sdk/models/get-usage-analytics-response.js +4 -0
  117. package/esm/sdk/models/get-usage-analytics-response.js.map +1 -1
  118. package/esm/sdk/models/index.d.ts +13 -0
  119. package/esm/sdk/models/index.d.ts.map +1 -1
  120. package/esm/sdk/models/index.js +13 -0
  121. package/esm/sdk/models/index.js.map +1 -1
  122. package/esm/sdk/models/invoice-billing-entity.d.ts +13 -0
  123. package/esm/sdk/models/invoice-billing-entity.d.ts.map +1 -0
  124. package/esm/sdk/models/invoice-billing-entity.js +23 -0
  125. package/esm/sdk/models/invoice-billing-entity.js.map +1 -0
  126. package/esm/sdk/models/invoice-filter.d.ts +5 -0
  127. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  128. package/esm/sdk/models/invoice-filter.js +2 -0
  129. package/esm/sdk/models/invoice-filter.js.map +1 -1
  130. package/esm/sdk/models/invoice-response.d.ts +6 -0
  131. package/esm/sdk/models/invoice-response.d.ts.map +1 -1
  132. package/esm/sdk/models/invoice-response.js +5 -0
  133. package/esm/sdk/models/invoice-response.js.map +1 -1
  134. package/esm/sdk/models/list-billing-entities-op.d.ts +42 -0
  135. package/esm/sdk/models/list-billing-entities-op.d.ts.map +1 -0
  136. package/esm/sdk/models/list-billing-entities-op.js +38 -0
  137. package/esm/sdk/models/list-billing-entities-op.js.map +1 -0
  138. package/esm/sdk/models/list-billing-entities-response.d.ts +13 -0
  139. package/esm/sdk/models/list-billing-entities-response.d.ts.map +1 -0
  140. package/esm/sdk/models/list-billing-entities-response.js +17 -0
  141. package/esm/sdk/models/list-billing-entities-response.js.map +1 -0
  142. package/esm/sdk/models/tax-rate-entity-type.d.ts +1 -0
  143. package/esm/sdk/models/tax-rate-entity-type.d.ts.map +1 -1
  144. package/esm/sdk/models/tax-rate-entity-type.js +1 -0
  145. package/esm/sdk/models/tax-rate-entity-type.js.map +1 -1
  146. package/esm/sdk/models/update-billing-entity-op.d.ts +21 -0
  147. package/esm/sdk/models/update-billing-entity-op.d.ts.map +1 -0
  148. package/esm/sdk/models/update-billing-entity-op.js +14 -0
  149. package/esm/sdk/models/update-billing-entity-op.js.map +1 -0
  150. package/esm/sdk/models/update-billing-entity-request.d.ts +23 -0
  151. package/esm/sdk/models/update-billing-entity-request.d.ts.map +1 -0
  152. package/esm/sdk/models/update-billing-entity-request.js +22 -0
  153. package/esm/sdk/models/update-billing-entity-request.js.map +1 -0
  154. package/esm/sdk/models/update-customer-request.d.ts +5 -0
  155. package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
  156. package/esm/sdk/models/update-customer-request.js +2 -0
  157. package/esm/sdk/models/update-customer-request.js.map +1 -1
  158. package/esm/sdk/models/usage-analytic-instalment.d.ts +22 -0
  159. package/esm/sdk/models/usage-analytic-instalment.d.ts.map +1 -0
  160. package/esm/sdk/models/usage-analytic-instalment.js +34 -0
  161. package/esm/sdk/models/usage-analytic-instalment.js.map +1 -0
  162. package/esm/sdk/models/webhook-dto-customer.d.ts +1 -0
  163. package/esm/sdk/models/webhook-dto-customer.d.ts.map +1 -1
  164. package/esm/sdk/models/webhook-dto-customer.js +2 -0
  165. package/esm/sdk/models/webhook-dto-customer.js.map +1 -1
  166. package/esm/sdk/models/webhook-dto-invoice.d.ts +1 -0
  167. package/esm/sdk/models/webhook-dto-invoice.d.ts.map +1 -1
  168. package/esm/sdk/models/webhook-dto-invoice.js +2 -0
  169. package/esm/sdk/models/webhook-dto-invoice.js.map +1 -1
  170. package/esm/sdk/sdk.d.ts +3 -0
  171. package/esm/sdk/sdk.d.ts.map +1 -1
  172. package/esm/sdk/sdk.js +5 -0
  173. package/esm/sdk/sdk.js.map +1 -1
  174. package/jsr.json +1 -1
  175. package/package.json +3 -3
  176. package/src/funcs/billing-entities-create-billing-entity.ts +172 -0
  177. package/src/funcs/billing-entities-enable-billing-entities.ts +153 -0
  178. package/src/funcs/billing-entities-get-billing-entities-status.ts +152 -0
  179. package/src/funcs/billing-entities-get-billing-entity.ts +181 -0
  180. package/src/funcs/billing-entities-list-billing-entities.ts +191 -0
  181. package/src/funcs/billing-entities-update-billing-entity.ts +187 -0
  182. package/src/funcs/subscriptions-cancel-subscription.ts +1 -1
  183. package/src/lib/config.ts +3 -2
  184. package/src/sdk/billing-entities.ts +115 -0
  185. package/src/sdk/models/billing-address.ts +91 -0
  186. package/src/sdk/models/billing-details.ts +79 -0
  187. package/src/sdk/models/billing-entity-mode-response.ts +35 -0
  188. package/src/sdk/models/billing-entity-mode.ts +20 -0
  189. package/src/sdk/models/billing-entity-response.ts +76 -0
  190. package/src/sdk/models/billingterm-instalment.ts +6 -0
  191. package/src/sdk/models/create-billing-entity-request.ts +53 -0
  192. package/src/sdk/models/create-customer-request.ts +10 -0
  193. package/src/sdk/models/customer-filter.ts +7 -0
  194. package/src/sdk/models/customer-response.ts +6 -0
  195. package/src/sdk/models/customer.ts +6 -0
  196. package/src/sdk/models/get-billing-entity-op.ts +33 -0
  197. package/src/sdk/models/get-usage-analytics-request.ts +1 -1
  198. package/src/sdk/models/get-usage-analytics-response.ts +18 -0
  199. package/src/sdk/models/index.ts +13 -0
  200. package/src/sdk/models/invoice-billing-entity.ts +48 -0
  201. package/src/sdk/models/invoice-filter.ts +7 -0
  202. package/src/sdk/models/invoice-response.ts +13 -0
  203. package/src/sdk/models/list-billing-entities-op.ts +88 -0
  204. package/src/sdk/models/list-billing-entities-response.ts +41 -0
  205. package/src/sdk/models/tax-rate-entity-type.ts +1 -0
  206. package/src/sdk/models/update-billing-entity-op.ts +46 -0
  207. package/src/sdk/models/update-billing-entity-request.ts +53 -0
  208. package/src/sdk/models/update-customer-request.ts +7 -0
  209. package/src/sdk/models/usage-analytic-instalment.ts +66 -0
  210. package/src/sdk/models/webhook-dto-customer.ts +3 -0
  211. package/src/sdk/models/webhook-dto-invoice.ts +3 -0
  212. package/src/sdk/sdk.ts +6 -0
package/docs/sdk/models/billing-address.md ADDED
@@ -0,0 +1,20 @@
1
+ # BillingAddress
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingAddress } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingAddress = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------- | ------------------- | ------------------- | ------------------- |
15
+ | `addressCity` | *string* | :heavy_minus_sign: | N/A |
16
+ | `addressCountry` | *string* | :heavy_minus_sign: | N/A |
17
+ | `addressLine1` | *string* | :heavy_minus_sign: | N/A |
18
+ | `addressLine2` | *string* | :heavy_minus_sign: | N/A |
19
+ | `addressPostalCode` | *string* | :heavy_minus_sign: | N/A |
20
+ | `addressState` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/billing-details.md ADDED
@@ -0,0 +1,18 @@
1
+ # BillingDetails
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingDetails } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingDetails = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
15
+ | `address` | [models.BillingAddress](../../sdk/models/billing-address.md) | :heavy_minus_sign: | N/A |
16
+ | `email` | *string* | :heavy_minus_sign: | N/A |
17
+ | `helpEmail` | *string* | :heavy_minus_sign: | N/A |
18
+ | `phone` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/billing-entity-mode-response.md ADDED
@@ -0,0 +1,15 @@
1
+ # BillingEntityModeResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingEntityModeResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingEntityModeResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
15
+ | `mode` | [models.BillingEntityMode](../../sdk/models/billing-entity-mode.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/billing-entity-mode.md ADDED
@@ -0,0 +1,17 @@
1
+ # BillingEntityMode
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingEntityMode } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingEntityMode = "enabling";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "off" | "enabling" | "enabled" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/billing-entity-response.md ADDED
@@ -0,0 +1,27 @@
1
+ # BillingEntityResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingEntityResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingEntityResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `billingDetails` | [models.BillingDetails](../../sdk/models/billing-details.md) | :heavy_minus_sign: | N/A |
16
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
18
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
19
+ | `id` | *string* | :heavy_minus_sign: | N/A |
20
+ | `invoiceNumberPrefix` | *string* | :heavy_minus_sign: | N/A |
21
+ | `isDefault` | *boolean* | :heavy_minus_sign: | N/A |
22
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
23
+ | `name` | *string* | :heavy_minus_sign: | N/A |
24
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
25
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
26
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
27
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/billingterm-instalment.md CHANGED
@@ -26,6 +26,7 @@ let value: BillingtermInstalment = {};
26
26
  | `instalmentStatus` | [models.InstalmentStatus](../../sdk/models/instalment-status.md) | :heavy_minus_sign: | N/A |
27
27
  | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
28
28
  | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
29
+ | `invoicedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | InvoicedAt is when the invoice billing the instalment was finalized. |
29
30
  | `kind` | [models.InstalmentKind](../../sdk/models/instalment-kind.md) | :heavy_minus_sign: | N/A |
30
31
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
31
32
  | `ownerId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-billing-entity-request.md ADDED
@@ -0,0 +1,21 @@
1
+ # CreateBillingEntityRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CreateBillingEntityRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CreateBillingEntityRequest = {
9
+ invoiceNumberPrefix: "<value>",
10
+ name: "<value>",
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
18
+ | `billingDetails` | [models.BillingDetails](../../sdk/models/billing-details.md) | :heavy_minus_sign: | N/A |
19
+ | `invoiceNumberPrefix` | *string* | :heavy_check_mark: | N/A |
20
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
21
+ | `name` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/create-customer-request.md CHANGED
@@ -24,6 +24,7 @@ let value: CreateCustomerRequest = {
24
24
  | `addressPostalCode` | *string* | :heavy_minus_sign: | address_postal_code is the ZIP code or postal code with maximum 20 characters |
25
25
  | `addressState` | *string* | :heavy_minus_sign: | address_state is the state, province, or region name with maximum 100 characters |
26
26
  | `billingCurrency` | *string* | :heavy_minus_sign: | billing_currency is the fiat currency invoices are issued in; empty means the charge currency is used as-is |
27
+ | `billingEntityId` | *string* | :heavy_minus_sign: | billing_entity_id is the billing entity that bills this customer; defaults to the environment's<br/>default entity. Accepted only once billing entities are enabled, and never changes afterwards. |
27
28
  | `contact` | *string* | :heavy_minus_sign: | contact is an optional contact number for the customer (e.g. phone) |
28
29
  | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_minus_sign: | contact_persons are people at the customer; at most one may be primary |
29
30
  | `email` | *string* | :heavy_minus_sign: | email is the customer's email address and must be a valid email format if provided |
package/docs/sdk/models/customer-filter.md CHANGED
@@ -12,6 +12,7 @@ let value: CustomerFilter = {};
12
12
 
13
13
  | Field | Type | Required | Description |
14
14
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `billingEntityId` | *string* | :heavy_minus_sign: | billing_entity_id filters by the customer's billing entity |
15
16
  | `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
16
17
  | `email` | *string* | :heavy_minus_sign: | N/A |
17
18
  | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/customer-response.md CHANGED
@@ -21,6 +21,7 @@ let value: CustomerResponse = {};
21
21
  | `addressPostalCode` | *string* | :heavy_minus_sign: | AddressPostalCode is the postal code of the customer's address |
22
22
  | `addressState` | *string* | :heavy_minus_sign: | AddressState is the state of the customer's address |
23
23
  | `billingCurrency` | *string* | :heavy_minus_sign: | BillingCurrency is the fiat currency invoices are issued in; nil means charge currency is used as-is. |
24
+ | `billingEntityId` | *string* | :heavy_minus_sign: | BillingEntityID is the entity that bills the customer; nil while the environment has no billing entities. Never changes once set. |
24
25
  | `contact` | *string* | :heavy_minus_sign: | Contact is an optional contact number for the customer (e.g. phone) |
25
26
  | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_minus_sign: | N/A |
26
27
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/customer.md CHANGED
@@ -19,6 +19,7 @@ let value: Customer = {};
19
19
  | `addressPostalCode` | *string* | :heavy_minus_sign: | AddressPostalCode is the postal code of the customer's address |
20
20
  | `addressState` | *string* | :heavy_minus_sign: | AddressState is the state of the customer's address |
21
21
  | `billingCurrency` | *string* | :heavy_minus_sign: | BillingCurrency is the fiat currency invoices are issued in; nil means charge currency is used as-is. |
22
+ | `billingEntityId` | *string* | :heavy_minus_sign: | BillingEntityID is the entity that bills the customer; nil while the environment has no billing entities. Never changes once set. |
22
23
  | `contact` | *string* | :heavy_minus_sign: | Contact is an optional contact number for the customer (e.g. phone) |
23
24
  | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_minus_sign: | N/A |
24
25
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/get-billing-entity-request.md ADDED
@@ -0,0 +1,17 @@
1
+ # GetBillingEntityRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GetBillingEntityRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GetBillingEntityRequest = {
9
+ id: "<id>",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------ | ------------------ | ------------------ | ------------------ |
17
+ | `id` | *string* | :heavy_check_mark: | Billing entity ID |
package/docs/sdk/models/get-usage-analytics-request.md CHANGED
@@ -14,7 +14,7 @@ let value: GetUsageAnalyticsRequest = {};
14
14
  | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `breakdownBucket` | *boolean* | :heavy_minus_sign: | BreakdownBucket when true augments each time-series point with BucketID/PriceID<br/>and appends a BucketSummaries rollup to each item. Requires WindowSize to be set<br/>and the item to be linked to a subscription line item that has CommitmentTimeBuckets.<br/>Default: false (opt-in, backward compatible). |
16
16
  | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
- | `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon" |
17
+ | `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon","source","instalments" |
18
18
  | `externalCustomerId` | *string* | :heavy_minus_sign: | ExternalCustomerID is the single external customer ID.<br/>Optional when ExternalCustomerIDs is provided; required otherwise. |
19
19
  | `featureIds` | *string*[] | :heavy_minus_sign: | N/A |
20
20
  | `groupBy` | *string*[] | :heavy_minus_sign: | allowed values: "source", "feature_id", "properties.<field_name>" |
package/docs/sdk/models/get-usage-analytics-response.md CHANGED
@@ -44,11 +44,13 @@ let value: GetUsageAnalyticsResponse = {
44
44
 
45
45
  ## Fields
46
46
 
47
- | Field | Type | Required | Description |
48
- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
49
- | `currency` | *string* | :heavy_minus_sign: | N/A |
50
- | `customAnalytics` | [models.CustomAnalyticItem](../../sdk/models/custom-analytic-item.md)[] | :heavy_minus_sign: | N/A |
51
- | `items` | [models.UsageAnalyticItem](../../sdk/models/usage-analytic-item.md)[] | :heavy_minus_sign: | N/A |
52
- | `subtotal` | *string* | :heavy_minus_sign: | N/A |
53
- | `totalCost` | *string* | :heavy_minus_sign: | TotalCost is the final cost after discount (Subtotal - TotalDiscount) |
54
- | `totalDiscount` | *string* | :heavy_minus_sign: | N/A |
47
+ | Field | Type | Required | Description |
48
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
50
+ | `customAnalytics` | [models.CustomAnalyticItem](../../sdk/models/custom-analytic-item.md)[] | :heavy_minus_sign: | N/A |
51
+ | `instalments` | [models.UsageAnalyticInstalment](../../sdk/models/usage-analytic-instalment.md)[] | :heavy_minus_sign: | Instalments lists, with expand "instalments", the instalments of the v2 commitments the request applied that were<br/>invoiced in the range. Property and source filters apply no commitments, so they list none. |
52
+ | `items` | [models.UsageAnalyticItem](../../sdk/models/usage-analytic-item.md)[] | :heavy_minus_sign: | N/A |
53
+ | `subtotal` | *string* | :heavy_minus_sign: | N/A |
54
+ | `totalCost` | *string* | :heavy_minus_sign: | TotalCost is the final cost after discount (Subtotal - TotalDiscount) |
55
+ | `totalCostWithInstalments` | *string* | :heavy_minus_sign: | TotalCostWithInstalments is TotalCost plus the amounts of Instalments, set when expand includes "instalments". |
56
+ | `totalDiscount` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-billing-entity.md ADDED
@@ -0,0 +1,17 @@
1
+ # InvoiceBillingEntity
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { InvoiceBillingEntity } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: InvoiceBillingEntity = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
15
+ | `billingDetails` | [models.BillingDetails](../../sdk/models/billing-details.md) | :heavy_minus_sign: | N/A |
16
+ | `billingEntityId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `name` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-filter.md CHANGED
@@ -14,6 +14,7 @@ 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
+ | `billingEntityId` | *string* | :heavy_minus_sign: | billing_entity_id filters by the customer's billing entity |
17
18
  | `billingReason` | [models.InvoiceBillingReason](../../sdk/models/invoice-billing-reason.md) | :heavy_minus_sign: | N/A |
18
19
  | `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. |
19
20
  | `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 |
package/docs/sdk/models/invoice-response.md CHANGED
@@ -125,6 +125,8 @@ let value: InvoiceResponse = {
125
125
  | `amountDue` | *string* | :heavy_minus_sign: | amount_due is the total amount that needs to be paid for this invoice |
126
126
  | `amountPaid` | *string* | :heavy_minus_sign: | amount_paid is the amount that has already been paid towards this invoice |
127
127
  | `amountRemaining` | *string* | :heavy_minus_sign: | amount_remaining is the outstanding amount still owed on this invoice (calculated as amount_due minus amount_paid) |
128
+ | `billingEntity` | [models.InvoiceBillingEntity](../../sdk/models/invoice-billing-entity.md) | :heavy_minus_sign: | N/A |
129
+ | `billingEntityId` | *string* | :heavy_minus_sign: | BillingEntityID is the entity that bills the invoice; nil while the environment has no billing entities. Never changes once set. |
128
130
  | `billingPeriod` | *string* | :heavy_minus_sign: | billing_period describes the billing period this invoice covers (e.g., "January 2024", "Q1 2024") |
129
131
  | `billingReason` | *string* | :heavy_minus_sign: | billing_reason indicates why this invoice was generated (e.g., "subscription_billing", "manual_charge") |
130
132
  | `billingSequence` | *number* | :heavy_minus_sign: | billing_sequence is the sequential number indicating the billing cycle for subscription invoices |
package/docs/sdk/models/list-billing-entities-order.md ADDED
@@ -0,0 +1,15 @@
1
+ # ListBillingEntitiesOrder
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListBillingEntitiesOrder } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListBillingEntitiesOrder = "asc";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "asc" | "desc"
15
+ ```
package/docs/sdk/models/list-billing-entities-request.md ADDED
@@ -0,0 +1,22 @@
1
+ # ListBillingEntitiesRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListBillingEntitiesRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListBillingEntitiesRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
15
+ | `billingEntityIds` | *string*[] | :heavy_minus_sign: | N/A |
16
+ | `expand` | *string* | :heavy_minus_sign: | N/A |
17
+ | `isDefault` | *boolean* | :heavy_minus_sign: | N/A |
18
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
19
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
20
+ | `order` | [models.ListBillingEntitiesOrder](../../sdk/models/list-billing-entities-order.md) | :heavy_minus_sign: | N/A |
21
+ | `sort` | *string* | :heavy_minus_sign: | N/A |
22
+ | `status` | [models.ListBillingEntitiesStatus](../../sdk/models/list-billing-entities-status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/list-billing-entities-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListBillingEntitiesResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListBillingEntitiesResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListBillingEntitiesResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
15
+ | `items` | [models.BillingEntityResponse](../../sdk/models/billing-entity-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/list-billing-entities-status.md ADDED
@@ -0,0 +1,15 @@
1
+ # ListBillingEntitiesStatus
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListBillingEntitiesStatus } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListBillingEntitiesStatus = "published";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "published" | "deleted" | "archived"
15
+ ```
package/docs/sdk/models/tax-rate-entity-type.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { TaxRateEntityType } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: TaxRateEntityType = "subscription";
8
+ let value: TaxRateEntityType = "invoice";
9
9
 
10
10
  // Open enum: unrecognized values are captured as Unrecognized<string>
11
11
  ```
@@ -13,5 +13,5 @@ let value: TaxRateEntityType = "subscription";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "customer" | "subscription" | "invoice" | "tenant" | "credit_note" | Unrecognized<string>
16
+ "customer" | "subscription" | "invoice" | "tenant" | "credit_note" | "billing_entity" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/update-billing-entity-request-request.md ADDED
@@ -0,0 +1,19 @@
1
+ # UpdateBillingEntityRequestRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UpdateBillingEntityRequestRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UpdateBillingEntityRequestRequest = {
9
+ id: "<id>",
10
+ body: {},
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
18
+ | `id` | *string* | :heavy_check_mark: | Billing entity ID |
19
+ | `body` | [models.UpdateBillingEntityRequest](../../sdk/models/update-billing-entity-request.md) | :heavy_check_mark: | Fields to change |
package/docs/sdk/models/update-billing-entity-request.md ADDED
@@ -0,0 +1,18 @@
1
+ # UpdateBillingEntityRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UpdateBillingEntityRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UpdateBillingEntityRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
15
+ | `billingDetails` | [models.BillingDetails](../../sdk/models/billing-details.md) | :heavy_minus_sign: | N/A |
16
+ | `invoiceNumberPrefix` | *string* | :heavy_minus_sign: | N/A |
17
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
18
+ | `name` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/update-customer-request.md CHANGED
@@ -21,6 +21,7 @@ let value: UpdateCustomerRequest = {};
21
21
  | `addressPostalCode` | *string* | :heavy_minus_sign: | address_postal_code is the updated postal code with maximum 20 characters |
22
22
  | `addressState` | *string* | :heavy_minus_sign: | address_state is the updated state, province, or region name with maximum 100 characters |
23
23
  | `billingCurrency` | *string* | :heavy_minus_sign: | billing_currency updates the invoicing currency; send "" to clear it back to the charge currency |
24
+ | `billingEntityId` | *string* | :heavy_minus_sign: | billing_entity_id cannot be changed; sending it is rejected |
24
25
  | `contact` | *string* | :heavy_minus_sign: | contact is the updated contact number for the customer (e.g. phone) |
25
26
  | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_minus_sign: | contact_persons replaces the customer's contact persons when provided; at most one may be primary |
26
27
  | `email` | *string* | :heavy_minus_sign: | email is the updated email address and must be a valid email format if provided |
package/docs/sdk/models/usage-analytic-instalment.md ADDED
@@ -0,0 +1,24 @@
1
+ # UsageAnalyticInstalment
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UsageAnalyticInstalment } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UsageAnalyticInstalment = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `commitmentId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
18
+ | `id` | *string* | :heavy_minus_sign: | N/A |
19
+ | `invoiceId` | *string* | :heavy_minus_sign: | N/A |
20
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
21
+ | `invoicedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | when the invoice billing it was finalized |
22
+ | `servicePeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
23
+ | `servicePeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
24
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/webhook-dto-customer.md CHANGED
@@ -18,6 +18,7 @@ let value: WebhookDtoCustomer = {};
18
18
  | `addressLine2` | *string* | :heavy_minus_sign: | N/A |
19
19
  | `addressPostalCode` | *string* | :heavy_minus_sign: | N/A |
20
20
  | `addressState` | *string* | :heavy_minus_sign: | N/A |
21
+ | `billingEntityId` | *string* | :heavy_minus_sign: | N/A |
21
22
  | `email` | *string* | :heavy_minus_sign: | N/A |
22
23
  | `environmentId` | *string* | :heavy_minus_sign: | N/A |
23
24
  | `externalId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/webhook-dto-invoice.md CHANGED
@@ -15,6 +15,7 @@ let value: WebhookDtoInvoice = {};
15
15
  | `amountDue` | *string* | :heavy_minus_sign: | N/A |
16
16
  | `amountPaid` | *string* | :heavy_minus_sign: | N/A |
17
17
  | `amountRemaining` | *string* | :heavy_minus_sign: | N/A |
18
+ | `billingEntityId` | *string* | :heavy_minus_sign: | N/A |
18
19
  | `billingPeriod` | *string* | :heavy_minus_sign: | N/A |
19
20
  | `billingReason` | *string* | :heavy_minus_sign: | N/A |
20
21
  | `billingSequence` | *number* | :heavy_minus_sign: | N/A |