@flexprice/sdk 2.1.35 → 2.1.37

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 (204) hide show
  1. package/docs/sdk/models/add-addon-ref.md +1 -0
  2. package/docs/sdk/models/add-addon-request.md +1 -0
  3. package/docs/sdk/models/add-addon-to-subscription-request.md +1 -0
  4. package/docs/sdk/models/coupon-ref.md +19 -0
  5. package/docs/sdk/models/create-credit-grant-request.md +1 -0
  6. package/docs/sdk/models/create-customer-request.md +6 -0
  7. package/docs/sdk/models/create-scheduled-task-request.md +1 -1
  8. package/docs/sdk/models/customer-contact-person.md +25 -0
  9. package/docs/sdk/models/customer-response.md +1 -0
  10. package/docs/sdk/models/customer.md +1 -0
  11. package/docs/sdk/models/external-tax-details.md +25 -0
  12. package/docs/sdk/models/line-item-change.md +1 -0
  13. package/docs/sdk/models/modify-subscription-line-item.md +1 -0
  14. package/docs/sdk/models/scheduled-task-entity-type.md +1 -1
  15. package/docs/sdk/models/tax-applied-response.md +5 -1
  16. package/docs/sdk/models/tax-exemption-reason-code.md +2 -2
  17. package/docs/sdk/models/tax-jurisdiction.md +18 -0
  18. package/docs/sdk/models/tax-provider.md +17 -0
  19. package/docs/sdk/models/tax-rate-entity-type.md +1 -1
  20. package/docs/sdk/models/tax-reversal-mode.md +17 -0
  21. package/docs/sdk/models/tax-reversal.md +16 -0
  22. package/docs/sdk/models/tax-transaction-type.md +17 -0
  23. package/docs/sdk/models/top-up-coupon.md +17 -0
  24. package/docs/sdk/models/top-up-wallet-request.md +1 -0
  25. package/docs/sdk/models/update-customer-request-request.md +7 -1
  26. package/docs/sdk/models/update-customer-request.md +4 -1
  27. package/docs/sdk/models/update-subscription-request.md +1 -1
  28. package/docs/sdk/models/wallet-transaction-response.md +3 -0
  29. package/docs/sdk/models/wallet-tx-consumption.md +16 -0
  30. package/docs/sdk/models/wallet-tx-source-type.md +15 -0
  31. package/docs/sdk/models/webhook-dto-invoice-line-item.md +1 -0
  32. package/docs/sdk/models/webhook-dto-invoice.md +1 -0
  33. package/docs/sdk/models/webhook-dto-tax-applied.md +3 -0
  34. package/docs/sdk/models/webhook-dto-wallet-transaction.md +3 -0
  35. package/docs/sdks/customers/README.md +8 -2
  36. package/esm/lib/config.d.ts +3 -3
  37. package/esm/lib/config.js +3 -3
  38. package/esm/sdk/models/add-addon-ref.d.ts +3 -0
  39. package/esm/sdk/models/add-addon-ref.d.ts.map +1 -1
  40. package/esm/sdk/models/add-addon-ref.js +2 -0
  41. package/esm/sdk/models/add-addon-ref.js.map +1 -1
  42. package/esm/sdk/models/add-addon-request.d.ts +6 -0
  43. package/esm/sdk/models/add-addon-request.d.ts.map +1 -1
  44. package/esm/sdk/models/add-addon-request.js +2 -0
  45. package/esm/sdk/models/add-addon-request.js.map +1 -1
  46. package/esm/sdk/models/add-addon-to-subscription-request.d.ts +6 -0
  47. package/esm/sdk/models/add-addon-to-subscription-request.d.ts.map +1 -1
  48. package/esm/sdk/models/add-addon-to-subscription-request.js +2 -0
  49. package/esm/sdk/models/add-addon-to-subscription-request.js.map +1 -1
  50. package/esm/sdk/models/coupon-ref.d.ts +20 -0
  51. package/esm/sdk/models/coupon-ref.d.ts.map +1 -0
  52. package/esm/sdk/models/coupon-ref.js +25 -0
  53. package/esm/sdk/models/coupon-ref.js.map +1 -0
  54. package/esm/sdk/models/create-credit-grant-request.d.ts +3 -0
  55. package/esm/sdk/models/create-credit-grant-request.d.ts.map +1 -1
  56. package/esm/sdk/models/create-credit-grant-request.js +3 -0
  57. package/esm/sdk/models/create-credit-grant-request.js.map +1 -1
  58. package/esm/sdk/models/create-customer-request.d.ts +6 -0
  59. package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
  60. package/esm/sdk/models/create-customer-request.js +3 -0
  61. package/esm/sdk/models/create-customer-request.js.map +1 -1
  62. package/esm/sdk/models/customer-contact-person.d.ts +33 -0
  63. package/esm/sdk/models/customer-contact-person.d.ts.map +1 -0
  64. package/esm/sdk/models/customer-contact-person.js +50 -0
  65. package/esm/sdk/models/customer-contact-person.js.map +1 -0
  66. package/esm/sdk/models/customer-response.d.ts +2 -0
  67. package/esm/sdk/models/customer-response.d.ts.map +1 -1
  68. package/esm/sdk/models/customer-response.js +3 -0
  69. package/esm/sdk/models/customer-response.js.map +1 -1
  70. package/esm/sdk/models/customer.d.ts +2 -0
  71. package/esm/sdk/models/customer.d.ts.map +1 -1
  72. package/esm/sdk/models/customer.js +3 -0
  73. package/esm/sdk/models/customer.js.map +1 -1
  74. package/esm/sdk/models/external-tax-details.d.ts +66 -0
  75. package/esm/sdk/models/external-tax-details.d.ts.map +1 -0
  76. package/esm/sdk/models/external-tax-details.js +36 -0
  77. package/esm/sdk/models/external-tax-details.js.map +1 -0
  78. package/esm/sdk/models/index.d.ts +11 -0
  79. package/esm/sdk/models/index.d.ts.map +1 -1
  80. package/esm/sdk/models/index.js +11 -0
  81. package/esm/sdk/models/index.js.map +1 -1
  82. package/esm/sdk/models/line-item-change.d.ts +6 -0
  83. package/esm/sdk/models/line-item-change.d.ts.map +1 -1
  84. package/esm/sdk/models/line-item-change.js +2 -0
  85. package/esm/sdk/models/line-item-change.js.map +1 -1
  86. package/esm/sdk/models/modify-subscription-line-item.d.ts +3 -0
  87. package/esm/sdk/models/modify-subscription-line-item.d.ts.map +1 -1
  88. package/esm/sdk/models/modify-subscription-line-item.js +2 -0
  89. package/esm/sdk/models/modify-subscription-line-item.js.map +1 -1
  90. package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
  91. package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
  92. package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
  93. package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
  94. package/esm/sdk/models/tax-applied-response.d.ts +13 -0
  95. package/esm/sdk/models/tax-applied-response.d.ts.map +1 -1
  96. package/esm/sdk/models/tax-applied-response.js +10 -0
  97. package/esm/sdk/models/tax-applied-response.js.map +1 -1
  98. package/esm/sdk/models/tax-exemption-reason-code.d.ts +4 -0
  99. package/esm/sdk/models/tax-exemption-reason-code.d.ts.map +1 -1
  100. package/esm/sdk/models/tax-exemption-reason-code.js +4 -0
  101. package/esm/sdk/models/tax-exemption-reason-code.js.map +1 -1
  102. package/esm/sdk/models/tax-jurisdiction.d.ts +13 -0
  103. package/esm/sdk/models/tax-jurisdiction.d.ts.map +1 -0
  104. package/esm/sdk/models/tax-jurisdiction.js +22 -0
  105. package/esm/sdk/models/tax-jurisdiction.js.map +1 -0
  106. package/esm/sdk/models/tax-provider.d.ts +10 -0
  107. package/esm/sdk/models/tax-provider.d.ts.map +1 -0
  108. package/esm/sdk/models/tax-provider.js +11 -0
  109. package/esm/sdk/models/tax-provider.js.map +1 -0
  110. package/esm/sdk/models/tax-rate-entity-type.d.ts +1 -0
  111. package/esm/sdk/models/tax-rate-entity-type.d.ts.map +1 -1
  112. package/esm/sdk/models/tax-rate-entity-type.js +1 -0
  113. package/esm/sdk/models/tax-rate-entity-type.js.map +1 -1
  114. package/esm/sdk/models/tax-reversal-mode.d.ts +10 -0
  115. package/esm/sdk/models/tax-reversal-mode.d.ts.map +1 -0
  116. package/esm/sdk/models/tax-reversal-mode.js +11 -0
  117. package/esm/sdk/models/tax-reversal-mode.js.map +1 -0
  118. package/esm/sdk/models/tax-reversal.d.ts +12 -0
  119. package/esm/sdk/models/tax-reversal.d.ts.map +1 -0
  120. package/esm/sdk/models/tax-reversal.js +22 -0
  121. package/esm/sdk/models/tax-reversal.js.map +1 -0
  122. package/esm/sdk/models/tax-transaction-type.d.ts +10 -0
  123. package/esm/sdk/models/tax-transaction-type.d.ts.map +1 -0
  124. package/esm/sdk/models/tax-transaction-type.js +11 -0
  125. package/esm/sdk/models/tax-transaction-type.js.map +1 -0
  126. package/esm/sdk/models/top-up-coupon.d.ts +12 -0
  127. package/esm/sdk/models/top-up-coupon.d.ts.map +1 -0
  128. package/esm/sdk/models/top-up-coupon.js +17 -0
  129. package/esm/sdk/models/top-up-coupon.js.map +1 -0
  130. package/esm/sdk/models/top-up-wallet-request.d.ts +3 -0
  131. package/esm/sdk/models/top-up-wallet-request.d.ts.map +1 -1
  132. package/esm/sdk/models/top-up-wallet-request.js +2 -0
  133. package/esm/sdk/models/top-up-wallet-request.js.map +1 -1
  134. package/esm/sdk/models/update-customer-request.d.ts +6 -0
  135. package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
  136. package/esm/sdk/models/update-customer-request.js +3 -0
  137. package/esm/sdk/models/update-customer-request.js.map +1 -1
  138. package/esm/sdk/models/update-subscription-request.d.ts +3 -0
  139. package/esm/sdk/models/update-subscription-request.d.ts.map +1 -1
  140. package/esm/sdk/models/update-subscription-request.js.map +1 -1
  141. package/esm/sdk/models/wallet-transaction-response.d.ts +8 -0
  142. package/esm/sdk/models/wallet-transaction-response.d.ts.map +1 -1
  143. package/esm/sdk/models/wallet-transaction-response.js +8 -0
  144. package/esm/sdk/models/wallet-transaction-response.js.map +1 -1
  145. package/esm/sdk/models/wallet-tx-consumption.d.ts +11 -0
  146. package/esm/sdk/models/wallet-tx-consumption.d.ts.map +1 -0
  147. package/esm/sdk/models/wallet-tx-consumption.js +20 -0
  148. package/esm/sdk/models/wallet-tx-consumption.js.map +1 -0
  149. package/esm/sdk/models/wallet-tx-source-type.d.ts +9 -0
  150. package/esm/sdk/models/wallet-tx-source-type.d.ts.map +1 -0
  151. package/esm/sdk/models/wallet-tx-source-type.js +10 -0
  152. package/esm/sdk/models/wallet-tx-source-type.js.map +1 -0
  153. package/esm/sdk/models/webhook-dto-invoice-line-item.d.ts +2 -0
  154. package/esm/sdk/models/webhook-dto-invoice-line-item.d.ts.map +1 -1
  155. package/esm/sdk/models/webhook-dto-invoice-line-item.js +3 -0
  156. package/esm/sdk/models/webhook-dto-invoice-line-item.js.map +1 -1
  157. package/esm/sdk/models/webhook-dto-invoice.d.ts +2 -0
  158. package/esm/sdk/models/webhook-dto-invoice.d.ts.map +1 -1
  159. package/esm/sdk/models/webhook-dto-invoice.js +3 -0
  160. package/esm/sdk/models/webhook-dto-invoice.js.map +1 -1
  161. package/esm/sdk/models/webhook-dto-tax-applied.d.ts +6 -0
  162. package/esm/sdk/models/webhook-dto-tax-applied.d.ts.map +1 -1
  163. package/esm/sdk/models/webhook-dto-tax-applied.js +8 -0
  164. package/esm/sdk/models/webhook-dto-tax-applied.js.map +1 -1
  165. package/esm/sdk/models/webhook-dto-wallet-transaction.d.ts +5 -0
  166. package/esm/sdk/models/webhook-dto-wallet-transaction.d.ts.map +1 -1
  167. package/esm/sdk/models/webhook-dto-wallet-transaction.js +8 -0
  168. package/esm/sdk/models/webhook-dto-wallet-transaction.js.map +1 -1
  169. package/jsr.json +1 -1
  170. package/package.json +1 -1
  171. package/src/lib/config.ts +3 -3
  172. package/src/sdk/models/add-addon-ref.ts +8 -0
  173. package/src/sdk/models/add-addon-request.ts +11 -0
  174. package/src/sdk/models/add-addon-to-subscription-request.ts +11 -0
  175. package/src/sdk/models/coupon-ref.ts +50 -0
  176. package/src/sdk/models/create-credit-grant-request.ts +8 -0
  177. package/src/sdk/models/create-customer-request.ts +12 -0
  178. package/src/sdk/models/customer-contact-person.ts +101 -0
  179. package/src/sdk/models/customer-response.ts +9 -0
  180. package/src/sdk/models/customer.ts +9 -0
  181. package/src/sdk/models/external-tax-details.ts +113 -0
  182. package/src/sdk/models/index.ts +11 -0
  183. package/src/sdk/models/line-item-change.ts +11 -0
  184. package/src/sdk/models/modify-subscription-line-item.ts +8 -0
  185. package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
  186. package/src/sdk/models/tax-applied-response.ts +26 -0
  187. package/src/sdk/models/tax-exemption-reason-code.ts +4 -0
  188. package/src/sdk/models/tax-jurisdiction.ts +45 -0
  189. package/src/sdk/models/tax-provider.ts +17 -0
  190. package/src/sdk/models/tax-rate-entity-type.ts +1 -0
  191. package/src/sdk/models/tax-reversal-mode.ts +19 -0
  192. package/src/sdk/models/tax-reversal.ts +43 -0
  193. package/src/sdk/models/tax-transaction-type.ts +19 -0
  194. package/src/sdk/models/top-up-coupon.ts +34 -0
  195. package/src/sdk/models/top-up-wallet-request.ts +8 -0
  196. package/src/sdk/models/update-customer-request.ts +12 -0
  197. package/src/sdk/models/update-subscription-request.ts +3 -0
  198. package/src/sdk/models/wallet-transaction-response.ts +22 -0
  199. package/src/sdk/models/wallet-tx-consumption.ts +41 -0
  200. package/src/sdk/models/wallet-tx-source-type.ts +16 -0
  201. package/src/sdk/models/webhook-dto-invoice-line-item.ts +4 -0
  202. package/src/sdk/models/webhook-dto-invoice.ts +4 -0
  203. package/src/sdk/models/webhook-dto-tax-applied.ts +17 -0
  204. package/src/sdk/models/webhook-dto-wallet-transaction.ts +19 -0
package/docs/sdk/models/add-addon-ref.md CHANGED
@@ -15,5 +15,6 @@ let value: AddAddonRef = {};
15
15
  | `addonId` | *string* | :heavy_minus_sign: | N/A |
16
16
  | `associationId` | *string* | :heavy_minus_sign: | N/A |
17
17
  | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
18
+ | `coupons` | [models.CouponRef](../../sdk/models/coupon-ref.md)[] | :heavy_minus_sign: | N/A |
18
19
  | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
19
20
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/add-addon-request.md CHANGED
@@ -19,6 +19,7 @@ let value: AddAddonRequest = {
19
19
  | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
20
20
  | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
21
21
  | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
22
+ | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
22
23
  | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
23
24
  | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
24
25
  | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
package/docs/sdk/models/add-addon-to-subscription-request.md CHANGED
@@ -17,6 +17,7 @@ let value: AddAddonToSubscriptionRequest = {
17
17
  | `addonId` | *string* | :heavy_check_mark: | N/A |
18
18
  | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
19
19
  | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
20
+ | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
20
21
  | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
21
22
  | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
22
23
  | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
package/docs/sdk/models/coupon-ref.md ADDED
@@ -0,0 +1,19 @@
1
+ # CouponRef
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CouponRef } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CouponRef = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `associationId` | *string* | :heavy_minus_sign: | N/A |
16
+ | `couponId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
+ | `priceId` | *string* | :heavy_minus_sign: | N/A |
19
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-credit-grant-request.md CHANGED
@@ -31,6 +31,7 @@ let value: CreateCreditGrantRequest = {
31
31
  | `periodCount` | *number* | :heavy_minus_sign: | N/A |
32
32
  | `planId` | *string* | :heavy_minus_sign: | N/A |
33
33
  | `priority` | *number* | :heavy_minus_sign: | N/A |
34
+ | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
34
35
  | `scope` | [models.CreditGrantScope](../../sdk/models/credit-grant-scope.md) | :heavy_check_mark: | N/A |
35
36
  | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
36
37
  | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-customer-request.md CHANGED
@@ -8,6 +8,11 @@ Request object for creating a new customer in the system
8
8
  import { CreateCustomerRequest } from "@flexprice/sdk/sdk/models";
9
9
 
10
10
  let value: CreateCustomerRequest = {
11
+ contactPersons: [
12
+ {
13
+ firstName: "Ryan",
14
+ },
15
+ ],
11
16
  externalId: "<id>",
12
17
  name: "<value>",
13
18
  };
@@ -25,6 +30,7 @@ let value: CreateCustomerRequest = {
25
30
  | `addressState` | *string* | :heavy_minus_sign: | address_state is the state, province, or region name with maximum 100 characters |
26
31
  | `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
32
  | `contact` | *string* | :heavy_minus_sign: | contact is an optional contact number for the customer (e.g. phone) |
33
+ | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_check_mark: | contact_persons are people at the customer; at most one may be primary |
28
34
  | `email` | *string* | :heavy_minus_sign: | email is the customer's email address and must be a valid email format if provided |
29
35
  | `externalId` | *string* | :heavy_check_mark: | external_id is the unique identifier from your system to reference this customer (required) |
30
36
  | `integrationEntityMapping` | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[] | :heavy_minus_sign: | integration_entity_mapping contains provider integration mappings for this customer |
package/docs/sdk/models/create-scheduled-task-request.md CHANGED
@@ -7,7 +7,7 @@ import { CreateScheduledTaskRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: CreateScheduledTaskRequest = {
9
9
  connectionId: "<id>",
10
- entityType: "credit_usage",
10
+ entityType: "wallet_debits",
11
11
  interval: "30MIN",
12
12
  jobConfig: {},
13
13
  };
package/docs/sdk/models/customer-contact-person.md ADDED
@@ -0,0 +1,25 @@
1
+ # CustomerContactPerson
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { CustomerContactPerson } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: CustomerContactPerson = {
9
+ firstName: "Burley",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------ | ------------------ | ------------------ | ------------------ |
17
+ | `department` | *string* | :heavy_minus_sign: | N/A |
18
+ | `designation` | *string* | :heavy_minus_sign: | N/A |
19
+ | `email` | *string* | :heavy_minus_sign: | N/A |
20
+ | `firstName` | *string* | :heavy_check_mark: | N/A |
21
+ | `id` | *string* | :heavy_minus_sign: | N/A |
22
+ | `isPrimary` | *boolean* | :heavy_minus_sign: | N/A |
23
+ | `lastName` | *string* | :heavy_minus_sign: | N/A |
24
+ | `mobile` | *string* | :heavy_minus_sign: | N/A |
25
+ | `salutation` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/customer-response.md CHANGED
@@ -22,6 +22,7 @@ let value: CustomerResponse = {};
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
24
  | `contact` | *string* | :heavy_minus_sign: | Contact is an optional contact number for the customer (e.g. phone) |
25
+ | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_minus_sign: | N/A |
25
26
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
26
27
  | `createdBy` | *string* | :heavy_minus_sign: | N/A |
27
28
  | `email` | *string* | :heavy_minus_sign: | Email is the email of the customer |
package/docs/sdk/models/customer.md CHANGED
@@ -20,6 +20,7 @@ let value: Customer = {};
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
22
  | `contact` | *string* | :heavy_minus_sign: | Contact is an optional contact number for the customer (e.g. phone) |
23
+ | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_minus_sign: | N/A |
23
24
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
24
25
  | `createdBy` | *string* | :heavy_minus_sign: | N/A |
25
26
  | `email` | *string* | :heavy_minus_sign: | Email is the email of the customer |
package/docs/sdk/models/external-tax-details.md ADDED
@@ -0,0 +1,25 @@
1
+ # ExternalTaxDetails
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ExternalTaxDetails } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ExternalTaxDetails = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `calculationExpiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | CalculationExpiresAt is when the calculation can no longer be filed, RFC3339. |
16
+ | `calculationId` | *string* | :heavy_minus_sign: | CalculationID is the provider calculation this row was written from. Commit files it. |
17
+ | `displayName` | *string* | :heavy_minus_sign: | DisplayName is the engine's own name for the tax, such as<br/>"Integrated goods and services tax (IGST)". |
18
+ | `jurisdiction` | [models.TaxJurisdiction](../../sdk/models/tax-jurisdiction.md) | :heavy_minus_sign: | N/A |
19
+ | `percentage` | *string* | :heavy_minus_sign: | Percentage is the resolved rate, such as "18.0". This is what was charged, not the<br/>rate that would apply if the tax were imposed. |
20
+ | `reference` | *string* | :heavy_minus_sign: | Reference is what this row's provider transaction was filed under. It is unique across<br/>every transaction on the account, so it is also the only way back to a transaction whose<br/>id failed to land here. |
21
+ | `reversal` | [models.TaxReversal](../../sdk/models/tax-reversal.md) | :heavy_minus_sign: | N/A |
22
+ | `sourcing` | *string* | :heavy_minus_sign: | Sourcing is whether the jurisdiction followed the seller's address or the buyer's. |
23
+ | `taxCode` | *string* | :heavy_minus_sign: | TaxCode is the product tax category the engine priced against, such as txcd_10000000.<br/>It belongs to the line rather than the rate, so today every row on an invoice carries<br/>the account default. It only varies once tax is calculated per line item. |
24
+ | `taxType` | *string* | :heavy_minus_sign: | TaxType is the tax family, such as vat, igst or sales_tax. |
25
+ | `taxabilityReason` | *string* | :heavy_minus_sign: | TaxabilityReason is why the engine charged what it did, such as standard_rated or<br/>reverse_charge. Recorded, not yet rendered. |
package/docs/sdk/models/line-item-change.md CHANGED
@@ -15,6 +15,7 @@ let value: LineItemChange = {
15
15
  | Field | Type | Required | Description |
16
16
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
17
17
  | `amount` | *string* | :heavy_minus_sign: | Amount reprices the charge. Flat fee only for now. |
18
+ | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to the new line item created by this change. |
18
19
  | `effectiveDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
20
  | `id` | *string* | :heavy_check_mark: | N/A |
20
21
  | `quantity` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/modify-subscription-line-item.md CHANGED
@@ -13,6 +13,7 @@ let value: ModifySubscriptionLineItem = {};
13
13
  | Field | Type | Required | Description |
14
14
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
15
  | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `coupons` | [models.CouponRef](../../sdk/models/coupon-ref.md)[] | :heavy_minus_sign: | N/A |
16
17
  | `effectiveDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
18
  | `lineItemId` | *string* | :heavy_minus_sign: | N/A |
18
19
  | `quantity` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/scheduled-task-entity-type.md CHANGED
@@ -13,5 +13,5 @@ let value: ScheduledTaskEntityType = "invoice";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "events" | "invoice" | "credit_topups" | "credit_usage" | "usage_analytics" | "revenue_facts" | Unrecognized<string>
16
+ "events" | "invoice" | "credit_topups" | "wallet_debits" | "credit_usage" | "usage_analytics" | "revenue_facts" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/tax-applied-response.md CHANGED
@@ -19,15 +19,19 @@ let value: TaxAppliedResponse = {};
19
19
  | `entityId` | *string* | :heavy_minus_sign: | N/A |
20
20
  | `entityType` | [models.TaxRateEntityType](../../sdk/models/tax-rate-entity-type.md) | :heavy_minus_sign: | N/A |
21
21
  | `environmentId` | *string* | :heavy_minus_sign: | N/A |
22
+ | `externalTaxDetails` | [models.ExternalTaxDetails](../../sdk/models/external-tax-details.md) | :heavy_minus_sign: | N/A |
22
23
  | `id` | *string* | :heavy_minus_sign: | N/A |
23
24
  | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
24
25
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
26
+ | `provider` | [models.TaxProvider](../../sdk/models/tax-provider.md) | :heavy_minus_sign: | N/A |
25
27
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
26
28
  | `taxAmount` | *string* | :heavy_minus_sign: | N/A |
27
29
  | `taxAssociationId` | *string* | :heavy_minus_sign: | N/A |
28
30
  | `taxBehavior` | [models.TaxBehavior](../../sdk/models/tax-behavior.md) | :heavy_minus_sign: | N/A |
29
31
  | `taxRate` | [models.TaxRateResponse](../../sdk/models/tax-rate-response.md) | :heavy_minus_sign: | N/A |
30
- | `taxRateId` | *string* | :heavy_minus_sign: | N/A |
32
+ | `taxRateId` | *string* | :heavy_minus_sign: | Null when an external engine calculated the tax: there is no Flexprice rate to point at. |
33
+ | `taxTransactionId` | *string* | :heavy_minus_sign: | TaxTransactionID is the provider transaction recording the filed tax, stamped at commit. |
34
+ | `taxTransactionType` | [models.TaxTransactionType](../../sdk/models/tax-transaction-type.md) | :heavy_minus_sign: | N/A |
31
35
  | `taxableAmount` | *string* | :heavy_minus_sign: | N/A |
32
36
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
33
37
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/tax-exemption-reason-code.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { TaxExemptionReasonCode } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: TaxExemptionReasonCode = "no_tax_configured";
8
+ let value: TaxExemptionReasonCode = "not_subject_to_tax";
9
9
 
10
10
  // Open enum: unrecognized values are captured as Unrecognized<string>
11
11
  ```
@@ -13,5 +13,5 @@ let value: TaxExemptionReasonCode = "no_tax_configured";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "customer_exempt" | "no_tax_configured" | Unrecognized<string>
16
+ "customer_exempt" | "no_tax_configured" | "reverse_charge" | "not_collecting" | "not_subject_to_tax" | "not_supported" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/tax-jurisdiction.md ADDED
@@ -0,0 +1,18 @@
1
+ # TaxJurisdiction
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TaxJurisdiction } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TaxJurisdiction = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------ | ------------------ | ------------------ | ------------------ |
15
+ | `country` | *string* | :heavy_minus_sign: | N/A |
16
+ | `displayName` | *string* | :heavy_minus_sign: | N/A |
17
+ | `level` | *string* | :heavy_minus_sign: | N/A |
18
+ | `state` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/tax-provider.md ADDED
@@ -0,0 +1,17 @@
1
+ # TaxProvider
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TaxProvider } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TaxProvider = "stripe";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "flexprice" | "stripe" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/tax-rate-entity-type.md CHANGED
@@ -13,5 +13,5 @@ let value: TaxRateEntityType = "subscription";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "customer" | "subscription" | "invoice" | "tenant" | Unrecognized<string>
16
+ "customer" | "subscription" | "invoice" | "tenant" | "credit_note" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/tax-reversal-mode.md ADDED
@@ -0,0 +1,17 @@
1
+ # TaxReversalMode
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TaxReversalMode } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TaxReversalMode = "partial";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "full" | "partial" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/tax-reversal.md ADDED
@@ -0,0 +1,16 @@
1
+ # TaxReversal
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TaxReversal } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TaxReversal = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
15
+ | `mode` | [models.TaxReversalMode](../../sdk/models/tax-reversal-mode.md) | :heavy_minus_sign: | N/A |
16
+ | `originalTransaction` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/tax-transaction-type.md ADDED
@@ -0,0 +1,17 @@
1
+ # TaxTransactionType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TaxTransactionType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TaxTransactionType = "reversal";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "filing" | "reversal" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/top-up-coupon.md ADDED
@@ -0,0 +1,17 @@
1
+ # TopUpCoupon
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { TopUpCoupon } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: TopUpCoupon = {
9
+ couponCode: "<value>",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------ | ------------------ | ------------------ | ------------------ |
17
+ | `couponCode` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/top-up-wallet-request.md CHANGED
@@ -18,6 +18,7 @@ let value: TopUpWalletRequest = {
18
18
  | `bonusCreditsExpiryDateUtc` | *string* | :heavy_minus_sign: | bonus_credits_expiry_date_utc is the expiry (UTC, full precision) applied to the bonus<br/>credits transaction. Independent of expiry_date_utc, which governs the purchase credits.<br/>Only honored when bonus credits are actually granted (explicit BonusCreditsToAdd or slab). |
19
19
  | `bonusCreditsToAdd` | *string* | :heavy_minus_sign: | bonus_credits_to_add is an explicit override for the bonus credits granted alongside this<br/>purchase. When nil/omitted, the bonus is resolved from the tenant's<br/>bonus_credits_topup_config slabs (if enabled). When set, it must be greater than 0 and is<br/>used as-is, skipping slab resolution. To grant no bonus, omit this field entirely. |
20
20
  | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
21
+ | `coupons` | [models.TopUpCoupon](../../sdk/models/top-up-coupon.md)[] | :heavy_minus_sign: | N/A |
21
22
  | `creditsToAdd` | *string* | :heavy_minus_sign: | credits_to_add is the number of credits to add to the wallet |
22
23
  | `description` | *string* | :heavy_minus_sign: | description to add any specific details about the transaction |
23
24
  | `expiryDateUtc` | *string* | :heavy_minus_sign: | expiry_date_utc is the expiry date in UTC timezone<br/>ex 2025-01-01 00:00:00 UTC |
package/docs/sdk/models/update-customer-request-request.md CHANGED
@@ -6,7 +6,13 @@
6
6
  import { UpdateCustomerRequestRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: UpdateCustomerRequestRequest = {
9
- body: {},
9
+ body: {
10
+ contactPersons: [
11
+ {
12
+ firstName: "Ryan",
13
+ },
14
+ ],
15
+ },
10
16
  };
11
17
  ```
12
18
 
package/docs/sdk/models/update-customer-request.md CHANGED
@@ -7,7 +7,9 @@ Request object for updating an existing customer. All fields are optional - only
7
7
  ```typescript
8
8
  import { UpdateCustomerRequest } from "@flexprice/sdk/sdk/models";
9
9
 
10
- let value: UpdateCustomerRequest = {};
10
+ let value: UpdateCustomerRequest = {
11
+ contactPersons: [],
12
+ };
11
13
  ```
12
14
 
13
15
  ## Fields
@@ -22,6 +24,7 @@ let value: UpdateCustomerRequest = {};
22
24
  | `addressState` | *string* | :heavy_minus_sign: | address_state is the updated state, province, or region name with maximum 100 characters |
23
25
  | `billingCurrency` | *string* | :heavy_minus_sign: | billing_currency updates the invoicing currency; send "" to clear it back to the charge currency |
24
26
  | `contact` | *string* | :heavy_minus_sign: | contact is the updated contact number for the customer (e.g. phone) |
27
+ | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_check_mark: | contact_persons replaces the customer's contact persons when provided; at most one may be primary |
25
28
  | `email` | *string* | :heavy_minus_sign: | email is the updated email address and must be a valid email format if provided |
26
29
  | `externalId` | *string* | :heavy_minus_sign: | external_id is the updated external identifier for the customer |
27
30
  | `integrationEntityMapping` | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[] | :heavy_minus_sign: | integration_entity_mapping contains provider integration mappings for this customer |
package/docs/sdk/models/update-subscription-request.md CHANGED
@@ -13,6 +13,6 @@ let value: UpdateSubscriptionRequest = {};
13
13
  | Field | Type | Required | Description |
14
14
  | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
15
15
  | `cancelAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
16
- | `cancelAtPeriodEnd` | *boolean* | :heavy_minus_sign: | N/A |
16
+ | `cancelAtPeriodEnd` | *boolean* | :heavy_minus_sign: | Pointer so omitting the field leaves the stored value unchanged; sending it sets the flag. |
17
17
  | `parentSubscriptionId` | *string* | :heavy_minus_sign: | ParentSubscriptionID sets or clears the parent subscription. Omit to leave unchanged; send "" to clear. |
18
18
  | `status` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/wallet-transaction-response.md CHANGED
@@ -13,6 +13,7 @@ let value: WalletTransactionResponse = {};
13
13
  | Field | Type | Required | Description |
14
14
  | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `amount` | *string* | :heavy_minus_sign: | N/A |
16
+ | `consumptionBreakdown` | [models.WalletTxConsumption](../../sdk/models/wallet-tx-consumption.md)[] | :heavy_minus_sign: | ConsumptionBreakdown is set on debits: the credits drawn from each credit batch. |
16
17
  | `conversionRate` | *string* | :heavy_minus_sign: | conversion_rate is the conversion rate for the transaction to the currency |
17
18
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
19
  | `createdBy` | *string* | :heavy_minus_sign: | N/A |
@@ -34,6 +35,8 @@ let value: WalletTransactionResponse = {};
34
35
  | `priority` | *number* | :heavy_minus_sign: | N/A |
35
36
  | `referenceId` | *string* | :heavy_minus_sign: | N/A |
36
37
  | `referenceType` | [models.WalletTxReferenceType](../../sdk/models/wallet-tx-reference-type.md) | :heavy_minus_sign: | N/A |
38
+ | `sourceId` | *string* | :heavy_minus_sign: | N/A |
39
+ | `sourceType` | [models.WalletTxSourceType](../../sdk/models/wallet-tx-source-type.md) | :heavy_minus_sign: | N/A |
37
40
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
38
41
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
39
42
  | `topupConversionRate` | *string* | :heavy_minus_sign: | topup_conversion_rate is the conversion rate for the topup to the currency |
package/docs/sdk/models/wallet-tx-consumption.md ADDED
@@ -0,0 +1,16 @@
1
+ # WalletTxConsumption
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { WalletTxConsumption } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: WalletTxConsumption = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------- | --------------------- | --------------------- | --------------------- |
15
+ | `creditTransactionId` | *string* | :heavy_minus_sign: | N/A |
16
+ | `credits` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/wallet-tx-source-type.md ADDED
@@ -0,0 +1,15 @@
1
+ # WalletTxSourceType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { WalletTxSourceType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: WalletTxSourceType = "INVOICE";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "INVOICE"
15
+ ```