@flexprice/sdk 2.1.25 → 2.1.26

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 (181) hide show
  1. package/docs/sdk/models/billing-period-behaviour.md +17 -0
  2. package/docs/sdk/models/billing-period-config.md +18 -0
  3. package/docs/sdk/models/credit-grant-application-response.md +1 -1
  4. package/docs/sdk/models/entitlement-response.md +1 -1
  5. package/docs/sdk/models/entity-change-behaviour.md +2 -2
  6. package/docs/sdk/models/entity-change-policy.md +4 -4
  7. package/docs/sdk/models/entity-change-result.md +6 -6
  8. package/docs/sdk/models/invoice-sync-settings.md +6 -4
  9. package/docs/sdk/models/list-usage-records-response.md +16 -0
  10. package/docs/sdk/models/metadata-custom-field-source.md +17 -0
  11. package/docs/sdk/models/metadata-custom-field.md +17 -0
  12. package/docs/sdk/models/on-pending-schedule-policy.md +15 -0
  13. package/docs/sdk/models/plan-price-sync-status-response.md +17 -0
  14. package/docs/sdk/models/plan-response.md +1 -0
  15. package/docs/sdk/models/price-feature-response.md +15 -0
  16. package/docs/sdk/models/price-response.md +1 -0
  17. package/docs/sdk/models/subscription-change-billing-period-result.md +18 -0
  18. package/docs/sdk/models/subscription-change-conflict-policies.md +15 -0
  19. package/docs/sdk/models/subscription-change-entity-type.md +17 -0
  20. package/docs/sdk/models/subscription-change-v2-request.md +11 -8
  21. package/docs/sdk/models/subscription-change-v2-response.md +16 -14
  22. package/docs/sdk/models/usage-record-filter-order.md +15 -0
  23. package/docs/sdk/models/usage-record-filter.md +31 -0
  24. package/docs/sdk/models/usage-record-response.md +33 -0
  25. package/docs/sdk/models/usage-record-sync-entry.md +20 -0
  26. package/docs/sdks/prices/README.md +1 -1
  27. package/docs/sdks/subscriptions/README.md +3 -1
  28. package/docs/sdks/usagerecords/README.md +78 -0
  29. package/esm/funcs/prices-get-price-by-lookup-key.js +1 -1
  30. package/esm/funcs/prices-get-price-by-lookup-key.js.map +1 -1
  31. package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.d.ts +3 -1
  32. package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.d.ts.map +1 -1
  33. package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.js +3 -1
  34. package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.js.map +1 -1
  35. package/esm/funcs/usage-records-post-usage-records-search.d.ts +17 -0
  36. package/esm/funcs/usage-records-post-usage-records-search.d.ts.map +1 -0
  37. package/esm/funcs/usage-records-post-usage-records-search.js +83 -0
  38. package/esm/funcs/usage-records-post-usage-records-search.js.map +1 -0
  39. package/esm/lib/config.d.ts +3 -3
  40. package/esm/lib/config.js +3 -3
  41. package/esm/sdk/models/billing-period-behaviour.d.ts +13 -0
  42. package/esm/sdk/models/billing-period-behaviour.d.ts.map +1 -0
  43. package/esm/sdk/models/billing-period-behaviour.js +14 -0
  44. package/esm/sdk/models/billing-period-behaviour.js.map +1 -0
  45. package/esm/sdk/models/billing-period-config.d.ts +20 -0
  46. package/esm/sdk/models/billing-period-config.d.ts.map +1 -0
  47. package/esm/sdk/models/billing-period-config.js +25 -0
  48. package/esm/sdk/models/billing-period-config.js.map +1 -0
  49. package/esm/sdk/models/credit-grant-application-response.d.ts +1 -1
  50. package/esm/sdk/models/credit-grant-application-response.js +1 -1
  51. package/esm/sdk/models/entitlement-response.d.ts +1 -1
  52. package/esm/sdk/models/entitlement-response.js +1 -1
  53. package/esm/sdk/models/entity-change-behaviour.d.ts +1 -0
  54. package/esm/sdk/models/entity-change-behaviour.d.ts.map +1 -1
  55. package/esm/sdk/models/entity-change-behaviour.js +1 -0
  56. package/esm/sdk/models/entity-change-behaviour.js.map +1 -1
  57. package/esm/sdk/models/entity-change-policy.d.ts +3 -0
  58. package/esm/sdk/models/entity-change-policy.d.ts.map +1 -1
  59. package/esm/sdk/models/entity-change-policy.js.map +1 -1
  60. package/esm/sdk/models/entity-change-result.d.ts +2 -2
  61. package/esm/sdk/models/entity-change-result.d.ts.map +1 -1
  62. package/esm/sdk/models/entity-change-result.js +2 -2
  63. package/esm/sdk/models/entity-change-result.js.map +1 -1
  64. package/esm/sdk/models/index.d.ts +14 -0
  65. package/esm/sdk/models/index.d.ts.map +1 -1
  66. package/esm/sdk/models/index.js +14 -0
  67. package/esm/sdk/models/index.js.map +1 -1
  68. package/esm/sdk/models/invoice-sync-settings.d.ts +17 -0
  69. package/esm/sdk/models/invoice-sync-settings.d.ts.map +1 -1
  70. package/esm/sdk/models/invoice-sync-settings.js +5 -0
  71. package/esm/sdk/models/invoice-sync-settings.js.map +1 -1
  72. package/esm/sdk/models/list-usage-records-response.d.ts +13 -0
  73. package/esm/sdk/models/list-usage-records-response.d.ts.map +1 -0
  74. package/esm/sdk/models/list-usage-records-response.js +17 -0
  75. package/esm/sdk/models/list-usage-records-response.js.map +1 -0
  76. package/esm/sdk/models/metadata-custom-field-source.d.ts +10 -0
  77. package/esm/sdk/models/metadata-custom-field-source.d.ts.map +1 -0
  78. package/esm/sdk/models/metadata-custom-field-source.js +11 -0
  79. package/esm/sdk/models/metadata-custom-field-source.js.map +1 -0
  80. package/esm/sdk/models/metadata-custom-field.d.ts +13 -0
  81. package/esm/sdk/models/metadata-custom-field.d.ts.map +1 -0
  82. package/esm/sdk/models/metadata-custom-field.js +22 -0
  83. package/esm/sdk/models/metadata-custom-field.js.map +1 -0
  84. package/esm/sdk/models/on-pending-schedule-policy.d.ts +10 -0
  85. package/esm/sdk/models/on-pending-schedule-policy.d.ts.map +1 -0
  86. package/esm/sdk/models/on-pending-schedule-policy.js +11 -0
  87. package/esm/sdk/models/on-pending-schedule-policy.js.map +1 -0
  88. package/esm/sdk/models/plan-price-sync-status-response.d.ts +12 -0
  89. package/esm/sdk/models/plan-price-sync-status-response.d.ts.map +1 -0
  90. package/esm/sdk/models/plan-price-sync-status-response.js +22 -0
  91. package/esm/sdk/models/plan-price-sync-status-response.js.map +1 -0
  92. package/esm/sdk/models/plan-response.d.ts +2 -0
  93. package/esm/sdk/models/plan-response.d.ts.map +1 -1
  94. package/esm/sdk/models/plan-response.js +3 -0
  95. package/esm/sdk/models/plan-response.js.map +1 -1
  96. package/esm/sdk/models/price-feature-response.d.ts +11 -0
  97. package/esm/sdk/models/price-feature-response.d.ts.map +1 -0
  98. package/esm/sdk/models/price-feature-response.js +20 -0
  99. package/esm/sdk/models/price-feature-response.js.map +1 -0
  100. package/esm/sdk/models/price-response.d.ts +2 -0
  101. package/esm/sdk/models/price-response.d.ts.map +1 -1
  102. package/esm/sdk/models/price-response.js +2 -0
  103. package/esm/sdk/models/price-response.js.map +1 -1
  104. package/esm/sdk/models/subscription-change-billing-period-result.d.ts +14 -0
  105. package/esm/sdk/models/subscription-change-billing-period-result.d.ts.map +1 -0
  106. package/esm/sdk/models/subscription-change-billing-period-result.js +25 -0
  107. package/esm/sdk/models/subscription-change-billing-period-result.js.map +1 -0
  108. package/esm/sdk/models/subscription-change-conflict-policies.d.ts +13 -0
  109. package/esm/sdk/models/subscription-change-conflict-policies.d.ts.map +1 -0
  110. package/esm/sdk/models/subscription-change-conflict-policies.js +18 -0
  111. package/esm/sdk/models/subscription-change-conflict-policies.js.map +1 -0
  112. package/esm/sdk/models/subscription-change-entity-type.d.ts +13 -0
  113. package/esm/sdk/models/subscription-change-entity-type.d.ts.map +1 -0
  114. package/esm/sdk/models/subscription-change-entity-type.js +14 -0
  115. package/esm/sdk/models/subscription-change-entity-type.js.map +1 -0
  116. package/esm/sdk/models/subscription-change-v2-request.d.ts +9 -0
  117. package/esm/sdk/models/subscription-change-v2-request.d.ts.map +1 -1
  118. package/esm/sdk/models/subscription-change-v2-request.js +9 -0
  119. package/esm/sdk/models/subscription-change-v2-request.js.map +1 -1
  120. package/esm/sdk/models/subscription-change-v2-response.d.ts +9 -0
  121. package/esm/sdk/models/subscription-change-v2-response.d.ts.map +1 -1
  122. package/esm/sdk/models/subscription-change-v2-response.js +5 -0
  123. package/esm/sdk/models/subscription-change-v2-response.js.map +1 -1
  124. package/esm/sdk/models/usage-record-filter.d.ts +67 -0
  125. package/esm/sdk/models/usage-record-filter.d.ts.map +1 -0
  126. package/esm/sdk/models/usage-record-filter.js +49 -0
  127. package/esm/sdk/models/usage-record-filter.js.map +1 -0
  128. package/esm/sdk/models/usage-record-response.d.ts +32 -0
  129. package/esm/sdk/models/usage-record-response.d.ts.map +1 -0
  130. package/esm/sdk/models/usage-record-response.js +50 -0
  131. package/esm/sdk/models/usage-record-response.js.map +1 -0
  132. package/esm/sdk/models/usage-record-sync-entry.d.ts +32 -0
  133. package/esm/sdk/models/usage-record-sync-entry.d.ts.map +1 -0
  134. package/esm/sdk/models/usage-record-sync-entry.js +28 -0
  135. package/esm/sdk/models/usage-record-sync-entry.js.map +1 -0
  136. package/esm/sdk/sdk.d.ts +3 -0
  137. package/esm/sdk/sdk.d.ts.map +1 -1
  138. package/esm/sdk/sdk.js +5 -0
  139. package/esm/sdk/sdk.js.map +1 -1
  140. package/esm/sdk/subscriptions.d.ts +3 -1
  141. package/esm/sdk/subscriptions.d.ts.map +1 -1
  142. package/esm/sdk/subscriptions.js +3 -1
  143. package/esm/sdk/subscriptions.js.map +1 -1
  144. package/esm/sdk/usage-records.d.ts +12 -0
  145. package/esm/sdk/usage-records.d.ts.map +1 -0
  146. package/esm/sdk/usage-records.js +18 -0
  147. package/esm/sdk/usage-records.js.map +1 -0
  148. package/jsr.json +1 -1
  149. package/package.json +1 -1
  150. package/src/funcs/prices-get-price-by-lookup-key.ts +1 -1
  151. package/src/funcs/subscriptions-execute-subscription-plan-change-v2.ts +3 -1
  152. package/src/funcs/usage-records-post-usage-records-search.ts +172 -0
  153. package/src/lib/config.ts +3 -3
  154. package/src/sdk/models/billing-period-behaviour.ts +25 -0
  155. package/src/sdk/models/billing-period-config.ts +57 -0
  156. package/src/sdk/models/credit-grant-application-response.ts +2 -2
  157. package/src/sdk/models/entitlement-response.ts +2 -2
  158. package/src/sdk/models/entity-change-behaviour.ts +1 -0
  159. package/src/sdk/models/entity-change-policy.ts +3 -0
  160. package/src/sdk/models/entity-change-result.ts +5 -5
  161. package/src/sdk/models/index.ts +14 -0
  162. package/src/sdk/models/invoice-sync-settings.ts +26 -0
  163. package/src/sdk/models/list-usage-records-response.ts +41 -0
  164. package/src/sdk/models/metadata-custom-field-source.ts +21 -0
  165. package/src/sdk/models/metadata-custom-field.ts +47 -0
  166. package/src/sdk/models/on-pending-schedule-policy.ts +19 -0
  167. package/src/sdk/models/plan-price-sync-status-response.ts +44 -0
  168. package/src/sdk/models/plan-response.ts +9 -0
  169. package/src/sdk/models/price-feature-response.ts +43 -0
  170. package/src/sdk/models/price-response.ts +6 -0
  171. package/src/sdk/models/subscription-change-billing-period-result.ts +52 -0
  172. package/src/sdk/models/subscription-change-conflict-policies.ts +44 -0
  173. package/src/sdk/models/subscription-change-entity-type.ts +24 -0
  174. package/src/sdk/models/subscription-change-v2-request.ts +30 -0
  175. package/src/sdk/models/subscription-change-v2-response.ts +18 -0
  176. package/src/sdk/models/usage-record-filter.ts +130 -0
  177. package/src/sdk/models/usage-record-response.ts +93 -0
  178. package/src/sdk/models/usage-record-sync-entry.ts +70 -0
  179. package/src/sdk/sdk.ts +6 -0
  180. package/src/sdk/subscriptions.ts +3 -1
  181. package/src/sdk/usage-records.ts +27 -0
package/docs/sdk/models/billing-period-behaviour.md ADDED
@@ -0,0 +1,17 @@
1
+ # BillingPeriodBehaviour
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingPeriodBehaviour } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingPeriodBehaviour = "unchanged";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "unchanged" | "anchor_at_effect" | "anchor_at_config" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/billing-period-config.md ADDED
@@ -0,0 +1,18 @@
1
+ # BillingPeriodConfig
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { BillingPeriodConfig } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: BillingPeriodConfig = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
16
+ | `billingCycle` | [models.BillingCycle](../../sdk/models/billing-cycle.md) | :heavy_minus_sign: | N/A |
17
+ | `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
18
+ | `billingPeriodUnit` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/credit-grant-application-response.md CHANGED
@@ -18,7 +18,7 @@ let value: CreditGrantApplicationResponse = {};
18
18
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
19
  | `createdBy` | *string* | :heavy_minus_sign: | N/A |
20
20
  | `creditGrantId` | *string* | :heavy_minus_sign: | N/A |
21
- | `credits` | *number* | :heavy_minus_sign: | N/A |
21
+ | `credits` | *string* | :heavy_minus_sign: | N/A |
22
22
  | `environmentId` | *string* | :heavy_minus_sign: | N/A |
23
23
  | `failureReason` | *string* | :heavy_minus_sign: | N/A |
24
24
  | `id` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/entitlement-response.md CHANGED
@@ -59,7 +59,7 @@ let value: EntitlementResponse = {
59
59
  | `grantDurationUnit` | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md) | :heavy_minus_sign: | N/A |
60
60
  | `grantDurationValue` | *number* | :heavy_minus_sign: | N/A |
61
61
  | `grantMeasure` | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md) | :heavy_minus_sign: | N/A |
62
- | `grantQuota` | *number* | :heavy_minus_sign: | N/A |
62
+ | `grantQuota` | *string* | :heavy_minus_sign: | N/A |
63
63
  | `id` | *string* | :heavy_minus_sign: | N/A |
64
64
  | `isEnabled` | *boolean* | :heavy_minus_sign: | N/A |
65
65
  | `isSoftLimit` | *boolean* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/entity-change-behaviour.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { EntityChangeBehaviour } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: EntityChangeBehaviour = "carry";
8
+ let value: EntityChangeBehaviour = "drop";
9
9
 
10
10
  // Open enum: unrecognized values are captured as Unrecognized<string>
11
11
  ```
@@ -13,5 +13,5 @@ let value: EntityChangeBehaviour = "carry";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "carry" | "drop" | Unrecognized<string>
16
+ "carry" | "drop" | "add" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/entity-change-policy.md CHANGED
@@ -10,7 +10,7 @@ let value: EntityChangePolicy = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
15
- | `defaultBehaviour` | [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md) | :heavy_minus_sign: | N/A |
16
- | `overrides` | Record<string, [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md)> | :heavy_minus_sign: | Overrides is keyed by addon_associations.id (instance), not catalogue addon_id. |
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `defaultBehaviour` | [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md) | :heavy_minus_sign: | N/A |
16
+ | `overrides` | Record<string, [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md)> | :heavy_minus_sign: | Overrides is keyed by addon_associations.id (instance), not catalogue addon_id.<br/>That is the id an EntityChangeResult reports as EntityID. |
package/docs/sdk/models/entity-change-result.md CHANGED
@@ -10,9 +10,9 @@ let value: EntityChangeResult = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
15
- | `behaviour` | [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md) | :heavy_minus_sign: | N/A |
16
- | `entityId` | *string* | :heavy_minus_sign: | N/A |
17
- | `entityType` | [models.SubscriptionLineItemEntityType](../../sdk/models/subscription-line-item-entity-type.md) | :heavy_minus_sign: | N/A |
18
- | `referenceId` | *string* | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
15
+ | `behaviour` | [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md) | :heavy_minus_sign: | N/A |
16
+ | `entityId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `entityType` | [models.SubscriptionChangeEntityType](../../sdk/models/subscription-change-entity-type.md) | :heavy_minus_sign: | N/A |
18
+ | `referenceId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/invoice-sync-settings.md CHANGED
@@ -10,7 +10,9 @@ let value: InvoiceSyncSettings = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
15
- | `normalizeFixedTo` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
16
- | `servicePeriodCustomFields` | [models.ServicePeriodCustomFields](../../sdk/models/service-period-custom-fields.md) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `metadataCustomFields` | [models.MetadataCustomField](../../sdk/models/metadata-custom-field.md)[] | :heavy_minus_sign: | MetadataCustomFields copies metadata values onto Zoho invoice custom fields<br/>verbatim. |
16
+ | `normalizeFixedTo` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
17
+ | `servicePeriodCustomFields` | [models.ServicePeriodCustomFields](../../sdk/models/service-period-custom-fields.md) | :heavy_minus_sign: | N/A |
18
+ | `submitForApproval` | *boolean* | :heavy_minus_sign: | SubmitForApproval submits the synced invoice into the merchant's Zoho Books approval<br/>flow before recording payment. Zoho rejects payments on draft invoices, and merchants<br/>configure a Zoho auto-approval rule for FlexPrice-sent invoices, so we submit, wait for<br/>that rule to fire, then pay. |
package/docs/sdk/models/list-usage-records-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListUsageRecordsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListUsageRecordsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListUsageRecordsResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
15
+ | `items` | [models.UsageRecordResponse](../../sdk/models/usage-record-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/metadata-custom-field-source.md ADDED
@@ -0,0 +1,17 @@
1
+ # MetadataCustomFieldSource
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { MetadataCustomFieldSource } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: MetadataCustomFieldSource = "invoice";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "customer" | "invoice" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/metadata-custom-field.md ADDED
@@ -0,0 +1,17 @@
1
+ # MetadataCustomField
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { MetadataCustomField } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: MetadataCustomField = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
15
+ | `field` | *string* | :heavy_minus_sign: | N/A |
16
+ | `metadataKey` | *string* | :heavy_minus_sign: | N/A |
17
+ | `source` | [models.MetadataCustomFieldSource](../../sdk/models/metadata-custom-field-source.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/on-pending-schedule-policy.md ADDED
@@ -0,0 +1,15 @@
1
+ # OnPendingSchedulePolicy
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { OnPendingSchedulePolicy } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: OnPendingSchedulePolicy = "reject";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "reject" | "supersede"
15
+ ```
package/docs/sdk/models/plan-price-sync-status-response.md ADDED
@@ -0,0 +1,17 @@
1
+ # PlanPriceSyncStatusResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PlanPriceSyncStatusResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PlanPriceSyncStatusResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
15
+ | `currentSequence` | *number* | :heavy_minus_sign: | N/A |
16
+ | `synced` | *boolean* | :heavy_minus_sign: | N/A |
17
+ | `unsyncedSubscriptionCount` | *number* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/plan-response.md CHANGED
@@ -72,6 +72,7 @@ let value: PlanResponse = {
72
72
  | `lookupKey` | *string* | :heavy_minus_sign: | N/A |
73
73
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
74
74
  | `name` | *string* | :heavy_minus_sign: | N/A |
75
+ | `priceSyncStatus` | [models.PlanPriceSyncStatusResponse](../../sdk/models/plan-price-sync-status-response.md) | :heavy_minus_sign: | N/A |
75
76
  | `prices` | [models.PriceResponse](../../sdk/models/price-response.md)[] | :heavy_minus_sign: | TODO: Add inline addons |
76
77
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
77
78
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-feature-response.md ADDED
@@ -0,0 +1,15 @@
1
+ # PriceFeatureResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PriceFeatureResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PriceFeatureResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
15
+ | `reportingUnit` | [models.ReportingUnit](../../sdk/models/reporting-unit.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/price-response.md CHANGED
@@ -58,6 +58,7 @@ let value: PriceResponse = {
58
58
  | `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
59
59
  | `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
60
60
  | `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
61
+ | `feature` | [models.PriceFeatureResponse](../../sdk/models/price-feature-response.md) | :heavy_minus_sign: | N/A |
61
62
  | `group` | [models.GroupResponse](../../sdk/models/group-response.md) | :heavy_minus_sign: | N/A |
62
63
  | `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
63
64
  | `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
package/docs/sdk/models/subscription-change-billing-period-result.md ADDED
@@ -0,0 +1,18 @@
1
+ # SubscriptionChangeBillingPeriodResult
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionChangeBillingPeriodResult } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionChangeBillingPeriodResult = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `behaviour` | [models.BillingPeriodBehaviour](../../sdk/models/billing-period-behaviour.md) | :heavy_minus_sign: | N/A |
16
+ | `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
+ | `currentPeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
+ | `currentPeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-change-conflict-policies.md ADDED
@@ -0,0 +1,15 @@
1
+ # SubscriptionChangeConflictPolicies
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionChangeConflictPolicies } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionChangeConflictPolicies = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
15
+ | `onPendingSchedule` | [models.OnPendingSchedulePolicy](../../sdk/models/on-pending-schedule-policy.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-change-entity-type.md ADDED
@@ -0,0 +1,17 @@
1
+ # SubscriptionChangeEntityType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionChangeEntityType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionChangeEntityType = "addon";
9
+
10
+ // Open enum: unrecognized values are captured as Unrecognized<string>
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "plan" | "addon" | "credit_grant" | "entitlement" | "entitlement_grant" | Unrecognized<string>
17
+ ```
package/docs/sdk/models/subscription-change-v2-request.md CHANGED
@@ -13,11 +13,14 @@ let value: SubscriptionChangeV2Request = {
13
13
 
14
14
  ## Fields
15
15
 
16
- | Field | Type | Required | Description |
17
- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
18
- | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
19
- | `entityPolicies` | [models.SubscriptionChangeEntityPolicies](../../sdk/models/subscription-change-entity-policies.md) | :heavy_minus_sign: | N/A |
20
- | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
21
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
22
- | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_check_mark: | N/A |
23
- | `targetPlanId` | *string* | :heavy_check_mark: | N/A |
16
+ | Field | Type | Required | Description |
17
+ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
18
+ | `billingPeriodBehaviour` | [models.BillingPeriodBehaviour](../../sdk/models/billing-period-behaviour.md) | :heavy_minus_sign: | N/A |
19
+ | `billingPeriodConfig` | [models.BillingPeriodConfig](../../sdk/models/billing-period-config.md) | :heavy_minus_sign: | N/A |
20
+ | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
21
+ | `entityPolicies` | [models.SubscriptionChangeEntityPolicies](../../sdk/models/subscription-change-entity-policies.md) | :heavy_minus_sign: | N/A |
22
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
23
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
24
+ | `onConflictPolicies` | [models.SubscriptionChangeConflictPolicies](../../sdk/models/subscription-change-conflict-policies.md) | :heavy_minus_sign: | N/A |
25
+ | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_check_mark: | N/A |
26
+ | `targetPlanId` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/subscription-change-v2-response.md CHANGED
@@ -235,17 +235,19 @@ let value: SubscriptionChangeV2Response = {
235
235
 
236
236
  ## Fields
237
237
 
238
- | Field | Type | Required | Description |
239
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
240
- | `changeType` | [models.SubscriptionChangeType](../../sdk/models/subscription-change-type.md) | :heavy_minus_sign: | N/A |
241
- | `changedResources` | [models.ChangedResources](../../sdk/models/changed-resources.md) | :heavy_minus_sign: | N/A |
242
- | `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
243
- | `entityChanges` | [models.EntityChangeResult](../../sdk/models/entity-change-result.md)[] | :heavy_minus_sign: | N/A |
244
- | `fromPlan` | [models.PlanSummary](../../sdk/models/plan-summary.md) | :heavy_minus_sign: | N/A |
245
- | `isScheduled` | *boolean* | :heavy_minus_sign: | IsScheduled is true when the change was deferred to the period end instead<br/>of being applied immediately. |
246
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
247
- | `scheduleId` | *string* | :heavy_minus_sign: | N/A |
248
- | `scheduledAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
249
- | `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
250
- | `toPlan` | [models.PlanSummary](../../sdk/models/plan-summary.md) | :heavy_minus_sign: | N/A |
251
- | `warnings` | *string*[] | :heavy_minus_sign: | N/A |
238
+ | Field | Type | Required | Description |
239
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
240
+ | `billingPeriod` | [models.SubscriptionChangeBillingPeriodResult](../../sdk/models/subscription-change-billing-period-result.md) | :heavy_minus_sign: | N/A |
241
+ | `changeType` | [models.SubscriptionChangeType](../../sdk/models/subscription-change-type.md) | :heavy_minus_sign: | N/A |
242
+ | `changedResources` | [models.ChangedResources](../../sdk/models/changed-resources.md) | :heavy_minus_sign: | N/A |
243
+ | `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
244
+ | `entityChanges` | [models.EntityChangeResult](../../sdk/models/entity-change-result.md)[] | :heavy_minus_sign: | N/A |
245
+ | `fromPlan` | [models.PlanSummary](../../sdk/models/plan-summary.md) | :heavy_minus_sign: | N/A |
246
+ | `isScheduled` | *boolean* | :heavy_minus_sign: | IsScheduled is true when the change was deferred to the period end instead<br/>of being applied immediately. |
247
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
248
+ | `scheduleId` | *string* | :heavy_minus_sign: | N/A |
249
+ | `scheduledAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
250
+ | `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
251
+ | `supersededSchedules` | *string*[] | :heavy_minus_sign: | SupersededSchedules lists the plan-change schedules this request cancelled under<br/>on_conflict_policies.on_pending_schedule. Preview reports what execute would cancel. |
252
+ | `toPlan` | [models.PlanSummary](../../sdk/models/plan-summary.md) | :heavy_minus_sign: | N/A |
253
+ | `warnings` | *string*[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/usage-record-filter-order.md ADDED
@@ -0,0 +1,15 @@
1
+ # UsageRecordFilterOrder
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UsageRecordFilterOrder } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UsageRecordFilterOrder = "desc";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "asc" | "desc"
15
+ ```
package/docs/sdk/models/usage-record-filter.md ADDED
@@ -0,0 +1,31 @@
1
+ # UsageRecordFilter
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UsageRecordFilter } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UsageRecordFilter = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
16
+ | `customerExternalId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
18
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
+ | `expand` | *string* | :heavy_minus_sign: | N/A |
20
+ | `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | Generic predicate and ordering escape hatch, for comparisons that have no dedicated field<br/>below — a range such as period_end at or after a cutoff goes here. |
21
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
22
+ | `offset` | *number* | :heavy_minus_sign: | N/A |
23
+ | `order` | [models.UsageRecordFilterOrder](../../sdk/models/usage-record-filter-order.md) | :heavy_minus_sign: | N/A |
24
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
25
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Exact-match on the window boundaries. Together with SubscriptionID these identify a single row:<br/>they are the columns the table's unique index is built on. |
26
+ | `planId` | *string* | :heavy_minus_sign: | N/A |
27
+ | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
28
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
29
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
30
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
31
+ | `synced` | *boolean* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/usage-record-response.md ADDED
@@ -0,0 +1,33 @@
1
+ # UsageRecordResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { UsageRecordResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: UsageRecordResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `amount` | *number* | :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
+ | `currency` | *string* | :heavy_minus_sign: | N/A |
19
+ | `customerExternalId` | *string* | :heavy_minus_sign: | N/A |
20
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
21
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
22
+ | `id` | *string* | :heavy_minus_sign: | N/A |
23
+ | `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
24
+ | `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
25
+ | `planId` | *string* | :heavy_minus_sign: | N/A |
26
+ | `quantity` | *number* | :heavy_minus_sign: | N/A |
27
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
28
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
29
+ | `synced` | *boolean* | :heavy_minus_sign: | N/A |
30
+ | `syncs` | Record<string, [models.UsageRecordSyncEntry](../../sdk/models/usage-record-sync-entry.md)> | :heavy_minus_sign: | N/A |
31
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
32
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
33
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |