npm - @flexprice/sdk - Versions diffs - 2.1.17 → 2.1.18 - Mend

@flexprice/sdk 2.1.17 → 2.1.18

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 (393) hide show

package/docs/sdk/models/inheritance-action.md ADDED Viewed

@@ -0,0 +1,15 @@
+# InheritanceAction
+## Example Usage
+```typescript
+import { InheritanceAction } from "@flexprice/sdk/sdk/models";
+let value: InheritanceAction = "remove";
+```
+## Values
+```typescript
+"add" | "remove"
+```

package/docs/sdk/models/line-item-commitment-config.md CHANGED Viewed

@@ -10,12 +10,13 @@ let value: LineItemCommitmentConfig = {};
 ## Fields
-| Field                                                                                                            | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
-| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
-| `commitmentAmount`                                                                                               | *number*                                                                                                         | :heavy_minus_sign:                                                                                               | CommitmentAmount is the minimum amount committed for this line item                                              |
-| `commitmentDuration`                                                                                             | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                       | :heavy_minus_sign:                                                                                               | N/A                                                                                                              |
-| `commitmentQuantity`                                                                                             | *number*                                                                                                         | :heavy_minus_sign:                                                                                               | CommitmentQuantity is the minimum quantity committed for this line item                                          |
-| `commitmentType`                                                                                                 | [models.CommitmentType](../../sdk/models/commitment-type.md)                                                     | :heavy_minus_sign:                                                                                               | N/A                                                                                                              |
-| `enableTrueUp`                                                                                                   | *boolean*                                                                                                        | :heavy_minus_sign:                                                                                               | EnableTrueUp determines if true-up fee should be applied when usage is below commitment                          |
-| `isWindowCommitment`                                                                                             | *boolean*                                                                                                        | :heavy_minus_sign:                                                                                               | IsWindowCommitment determines if commitment is applied per window (e.g., per day) rather than per billing period |
-| `overageFactor`                                                                                                  | *number*                                                                                                         | :heavy_minus_sign:                                                                                               | OverageFactor is a multiplier applied to usage beyond the commitment                                             |
+| Field                                                                                                                                                                                                                                       | Type                                                                                                                                                                                                                                        | Required                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                 |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `commitmentAmount`                                                                                                                                                                                                                          | *number*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | CommitmentAmount is the minimum amount committed for this line item                                                                                                                                                                         |
+| `commitmentDuration`                                                                                                                                                                                                                        | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
+| `commitmentQuantity`                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | CommitmentQuantity is the minimum quantity committed for this line item                                                                                                                                                                     |
+| `commitmentTimeBuckets`                                                                                                                                                                                                                     | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[]                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                          | CommitmentTimeBuckets defines per-bucket commitment + inline price for<br/>windows whose start UTC hour falls within each configured bucket. Each<br/>bucket carries its own price (materialized by the service). Requires<br/>IsWindowCommitment=true. |
+| `commitmentType`                                                                                                                                                                                                                            | [models.CommitmentType](../../sdk/models/commitment-type.md)                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
+| `enableTrueUp`                                                                                                                                                                                                                              | *boolean*                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | EnableTrueUp determines if true-up fee should be applied when usage is below commitment                                                                                                                                                     |
+| `isWindowCommitment`                                                                                                                                                                                                                        | *boolean*                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | IsWindowCommitment determines if commitment is applied per window (e.g., per day) rather than per billing period                                                                                                                            |
+| `overageFactor`                                                                                                                                                                                                                             | *number*                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | OverageFactor is a multiplier applied to usage beyond the commitment                                                                                                                                                                        |

package/docs/sdk/models/list-coupon-associations-request.md ADDED Viewed

@@ -0,0 +1,19 @@
+# ListCouponAssociationsRequest
+## Example Usage
+```typescript
+import { ListCouponAssociationsRequest } from "@flexprice/sdk/sdk/models";
+let value: ListCouponAssociationsRequest = {};
+```
+## Fields
+| Field                                     | Type                                      | Required                                  | Description                               |
+| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
+| `subscriptionIds`                         | *string*[]                                | :heavy_minus_sign:                        | Filter by subscription IDs (max 100)      |
+| `couponIds`                               | *string*[]                                | :heavy_minus_sign:                        | Filter by coupon IDs (max 100)            |
+| `activeOnly`                              | *boolean*                                 | :heavy_minus_sign:                        | Return only currently active associations |
+| `limit`                                   | *number*                                  | :heavy_minus_sign:                        | Page size                                 |
+| `offset`                                  | *number*                                  | :heavy_minus_sign:                        | Page offset                               |

package/docs/sdk/models/list-coupon-associations-response.md ADDED Viewed

@@ -0,0 +1,16 @@
+# ListCouponAssociationsResponse
+## Example Usage
+```typescript
+import { ListCouponAssociationsResponse } from "@flexprice/sdk/sdk/models";
+let value: ListCouponAssociationsResponse = {};
+```
+## Fields
+| Field                                                                                 | Type                                                                                  | Required                                                                              | Description                                                                           |
+| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| `items`                                                                               | [models.CouponAssociationResponse](../../sdk/models/coupon-association-response.md)[] | :heavy_minus_sign:                                                                    | N/A                                                                                   |
+| `pagination`                                                                          | [models.PaginationResponse](../../sdk/models/pagination-response.md)                  | :heavy_minus_sign:                                                                    | N/A                                                                                   |

package/docs/sdk/models/meter-usage-attribution.md ADDED Viewed

@@ -0,0 +1,17 @@
+# MeterUsageAttribution
+## Example Usage
+```typescript
+import { MeterUsageAttribution } from "@flexprice/sdk/sdk/models";
+let value: MeterUsageAttribution = {};
+```
+## Fields
+| Field                | Type                 | Required             | Description          |
+| -------------------- | -------------------- | -------------------- | -------------------- |
+| `externalCustomerId` | *string*             | :heavy_minus_sign:   | N/A                  |
+| `meterId`            | *string*             | :heavy_minus_sign:   | N/A                  |
+| `qtyTotal`           | *string*             | :heavy_minus_sign:   | N/A                  |

package/docs/sdk/models/preview-subscription-modify-request.md CHANGED Viewed

@@ -8,7 +8,7 @@ import { PreviewSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
 let value: PreviewSubscriptionModifyRequest = {
   id: "<id>",
   body: {
-    type: "grouped_invoicing",
+    type: "trial_end",
   },
 };
 ```

package/docs/sdk/models/price-filter.md CHANGED Viewed

@@ -13,6 +13,7 @@ let value: PriceFilter = {};
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
 | `allowExpiredPrices`                                                                          | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `billingPeriods`                                                                              | [models.BillingPeriod](../../sdk/models/billing-period.md)[]                                  | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `entityIds`                                                                                   | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `entityType`                                                                                  | [models.PriceEntityType](../../sdk/models/price-entity-type.md)                               | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/sub-modify-coupon-action.md ADDED Viewed

@@ -0,0 +1,15 @@
+# SubModifyCouponAction
+## Example Usage
+```typescript
+import { SubModifyCouponAction } from "@flexprice/sdk/sdk/models";
+let value: SubModifyCouponAction = "add";
+```
+## Values
+```typescript
+"add" | "remove"
+```

package/docs/sdk/models/sub-modify-coupon-params.md ADDED Viewed

@@ -0,0 +1,24 @@
+# SubModifyCouponParams
+## Example Usage
+```typescript
+import { SubModifyCouponParams } from "@flexprice/sdk/sdk/models";
+let value: SubModifyCouponParams = {
+  action: "add",
+};
+```
+## Fields
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `action`                                                                                      | [models.SubModifyCouponAction](../../sdk/models/sub-modify-coupon-action.md)                  | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `associationId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | Required when action="remove". ID of the CouponAssociation to soft-delete.                    |
+| `couponCode`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | Required for action="add". Coupon code of the coupon to attach.                               |
+| `effectiveDate`                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | Optional. When to apply the change; defaults to now if omitted.                               |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | Optional. When the coupon association ends.                                                   |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | Optional. When the coupon association starts; defaults to EffectiveDate.                      |
+| `subscriptionId`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | Optional. Apply at subscription level. Mutually exclusive with SubscriptionLineItemID.        |
+| `subscriptionLineItemId`                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | Optional. Apply at a specific line item. Mutually exclusive with SubscriptionID.              |

package/docs/sdk/models/sub-modify-inheritance-request.md CHANGED Viewed

@@ -10,6 +10,8 @@ let value: SubModifyInheritanceRequest = {};
 ## Fields
-| Field                                      | Type                                       | Required                                   | Description                                |
-| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
-| `externalCustomerIdsToInheritSubscription` | *string*[]                                 | :heavy_minus_sign:                         | N/A                                        |
+| Field                                                              | Type                                                               | Required                                                           | Description                                                        |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+| `action`                                                           | [models.InheritanceAction](../../sdk/models/inheritance-action.md) | :heavy_minus_sign:                                                 | N/A                                                                |
+| `externalCustomerIdsToInheritSubscription`                         | *string*[]                                                         | :heavy_minus_sign:                                                 | ExternalCustomerIDsToInheritSubscription is used for action="add". |
+| `externalCustomerIdsToRemove`                                      | *string*[]                                                         | :heavy_minus_sign:                                                 | ExternalCustomerIDsToRemove is used for action="remove".           |

package/docs/sdk/models/sub-modify-tax-action.md ADDED Viewed

@@ -0,0 +1,15 @@
+# SubModifyTaxAction
+## Example Usage
+```typescript
+import { SubModifyTaxAction } from "@flexprice/sdk/sdk/models";
+let value: SubModifyTaxAction = "remove";
+```
+## Values
+```typescript
+"add" | "remove"
+```

package/docs/sdk/models/sub-modify-tax-params.md ADDED Viewed

@@ -0,0 +1,20 @@
+# SubModifyTaxParams
+## Example Usage
+```typescript
+import { SubModifyTaxParams } from "@flexprice/sdk/sdk/models";
+let value: SubModifyTaxParams = {
+  action: "remove",
+};
+```
+## Fields
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `action`                                                                                      | [models.SubModifyTaxAction](../../sdk/models/sub-modify-tax-action.md)                        | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `associationId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | Required when action="remove". ID of the TaxAssociation to soft-delete.                       |
+| `effectiveDate`                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | Optional. When to apply the change; defaults to now if omitted.                               |
+| `taxRateId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | Required when action="add". ID of the active tax rate to attach.                              |

package/docs/sdk/models/subscription-coupon-input.md ADDED Viewed

@@ -0,0 +1,20 @@
+# SubscriptionCouponInput
+## Example Usage
+```typescript
+import { SubscriptionCouponInput } from "@flexprice/sdk/sdk/models";
+let value: SubscriptionCouponInput = {
+  couponCode: "<value>",
+};
+```
+## Fields
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `couponCode`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | CouponCode is the coupon's human-readable code (case-insensitive). Required.                  |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | EndDate is when the coupon ends; overrides duration_in_periods calculation.                   |
+| `priceId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | PriceID is the price ID of the line item to target; omit for subscription-level.              |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | StartDate is when the coupon starts; defaults to subscription/phase StartDate.                |

package/docs/sdk/models/subscription-line-item-response.md CHANGED Viewed

@@ -49,6 +49,7 @@ let value: SubscriptionLineItemResponse = {
 | `commitmentDuration`                                                                            | [models.BillingPeriod](../../sdk/models/billing-period.md)                                      | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentOverageFactor`                                                                       | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentQuantity`                                                                            | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
+| `commitmentTimeBuckets`                                                                         | [models.TimeOfDayBucket](../../sdk/models/time-of-day-bucket.md)[]                              | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentTrueUpEnabled`                                                                       | *boolean*                                                                                       | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentType`                                                                                | [models.CommitmentType](../../sdk/models/commitment-type.md)                                    | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentWindowed`                                                                            | *boolean*                                                                                       | :heavy_minus_sign:                                                                              | N/A                                                                                             |

package/docs/sdk/models/subscription-modify-type.md CHANGED Viewed

@@ -5,11 +5,11 @@
 ```typescript
 import { SubscriptionModifyType } from "@flexprice/sdk/sdk/models";
-let value: SubscriptionModifyType = "trial_end";
+let value: SubscriptionModifyType = "tax";
 ```
 ## Values
 ```typescript
-"inheritance" | "quantity_change" | "grouped_invoicing" | "trial_end"
+"inheritance" | "quantity_change" | "grouped_invoicing" | "trial_end" | "coupon" | "tax"
 ```

package/docs/sdk/models/subscription-phase-create-request.md CHANGED Viewed

@@ -14,10 +14,11 @@ let value: SubscriptionPhaseCreateRequest = {
 | Field                                                                                                                                                             | Type                                                                                                                                                              | Required                                                                                                                                                          | Description                                                                                                                                                       |
 | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `coupons`                                                                                                                                                         | *string*[]                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | Coupons represents subscription-level coupons to be applied to this phase                                                                                         |
+| `coupons`                                                                                                                                                         | *string*[]                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | Deprecated: use SubscriptionCoupons instead.                                                                                                                      |
 | `endDate`                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
-| `lineItemCoupons`                                                                                                                                                 | Record<string, *string*[]>                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)                                                                            |
+| `lineItemCoupons`                                                                                                                                                 | Record<string, *string*[]>                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | Deprecated: use SubscriptionCoupons instead.                                                                                                                      |
 | `lineItems`                                                                                                                                                       | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[]                                                           | :heavy_minus_sign:                                                                                                                                                | LineItems are extra line items to add during this phase, primarily one-time charges.<br/>Each item's start_date defaults to the phase's start_date when not provided. |
 | `metadata`                                                                                                                                                        | Record<string, *string*>                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
 | `overrideLineItems`                                                                                                                                               | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                                | :heavy_minus_sign:                                                                                                                                                | OverrideLineItems allows customizing specific prices for this phase<br/>If not provided, phase will use the same line items as the subscription (plan prices)     |
-| `startDate`                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_check_mark:                                                                                                                                                | N/A                                                                                                                                                               |
+| `startDate`                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_check_mark:                                                                                                                                                | N/A                                                                                                                                                               |
+| `subscriptionCoupons`                                                                                                                                             | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[]                                                                                 | :heavy_minus_sign:                                                                                                                                                | SubscriptionCoupons is the preferred way to attach coupons to this phase.                                                                                         |

package/docs/sdk/models/subscription-subscription-line-item.md CHANGED Viewed

@@ -19,6 +19,7 @@ let value: SubscriptionSubscriptionLineItem = {};
 | `commitmentDuration`                                                                            | [models.BillingPeriod](../../sdk/models/billing-period.md)                                      | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentOverageFactor`                                                                       | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentQuantity`                                                                            | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
+| `commitmentTimeBuckets`                                                                         | [models.TimeOfDayBucket](../../sdk/models/time-of-day-bucket.md)[]                              | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentTrueUpEnabled`                                                                       | *boolean*                                                                                       | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentType`                                                                                | [models.CommitmentType](../../sdk/models/commitment-type.md)                                    | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `commitmentWindowed`                                                                            | *boolean*                                                                                       | :heavy_minus_sign:                                                                              | N/A                                                                                             |

package/docs/sdk/models/tax-association-response.md CHANGED Viewed

@@ -16,12 +16,14 @@ let value: TaxAssociationResponse = {};
 | `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `createdBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `currency`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | Currency                                                                                      |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | EndDate is the optional date until which this association is active                           |
 | `entityId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | ID of the entity this tax rate applies to                                                     |
 | `entityType`                                                                                  | [models.TaxRateEntityType](../../sdk/models/tax-rate-entity-type.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | EnvironmentID is the ID of the environment this tax rate config belongs to                    |
 | `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | ID of the ent.                                                                                |
 | `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | Metadata holds the value of the "metadata" field.                                             |
 | `priority`                                                                                    | *number*                                                                                      | :heavy_minus_sign:                                                                            | Priority for tax resolution (lower number = higher priority)                                  |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | StartDate is the date from which this association is active                                   |
 | `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `taxRate`                                                                                     | [models.TaxRateResponse](../../sdk/models/tax-rate-response.md)                               | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `taxRateId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | Reference to the TaxRate entity                                                               |

package/docs/sdk/models/time-of-day-bucket.md ADDED Viewed

@@ -0,0 +1,22 @@
+# TimeOfDayBucket
+## Example Usage
+```typescript
+import { TimeOfDayBucket } from "@flexprice/sdk/sdk/models";
+let value: TimeOfDayBucket = {};
+```
+## Fields
+| Field                                                                                                                                             | Type                                                                                                                                              | Required                                                                                                                                          | Description                                                                                                                                       |
+| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `commitmentType`                                                                                                                                  | [models.CommitmentType](../../sdk/models/commitment-type.md)                                                                                      | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
+| `commitmentValue`                                                                                                                                 | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
+| `end`                                                                                                                                             | [models.Bucket](../../sdk/models/bucket.md)                                                                                                       | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
+| `id`                                                                                                                                              | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | ID is server-assigned. Stable for the lifetime of the line item;<br/>invoice breakdown and analytics responses reference this ID.                 |
+| `overageFactor`                                                                                                                                   | *number*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
+| `priceId`                                                                                                                                         | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | PriceID is the SUBSCRIPTION-scoped price created at bucket-creation time.<br/>Immutable post-create; changing pricing requires a successor line item. |
+| `start`                                                                                                                                           | [models.Bucket](../../sdk/models/bucket.md)                                                                                                       | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
+| `trueUpEnabled`                                                                                                                                   | *boolean*                                                                                                                                         | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |

package/docs/sdk/models/update-service-account-request-request.md ADDED Viewed

@@ -0,0 +1,21 @@
+# UpdateServiceAccountRequestRequest
+## Example Usage
+```typescript
+import { UpdateServiceAccountRequestRequest } from "@flexprice/sdk/sdk/models";
+let value: UpdateServiceAccountRequestRequest = {
+  id: "<id>",
+  body: {
+    name: "<value>",
+  },
+};
+```
+## Fields
+| Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `id`                                                                                     | *string*                                                                                 | :heavy_check_mark:                                                                       | Service Account ID                                                                       |
+| `body`                                                                                   | [models.UpdateServiceAccountRequest](../../sdk/models/update-service-account-request.md) | :heavy_check_mark:                                                                       | Update service account request                                                           |

package/docs/sdk/models/update-service-account-request.md ADDED Viewed

@@ -0,0 +1,17 @@
+# UpdateServiceAccountRequest
+## Example Usage
+```typescript
+import { UpdateServiceAccountRequest } from "@flexprice/sdk/sdk/models";
+let value: UpdateServiceAccountRequest = {
+  name: "<value>",
+};
+```
+## Fields
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |

package/docs/sdk/models/update-service-account-response.md ADDED Viewed

@@ -0,0 +1,21 @@
+# UpdateServiceAccountResponse
+## Example Usage
+```typescript
+import { UpdateServiceAccountResponse } from "@flexprice/sdk/sdk/models";
+let value: UpdateServiceAccountResponse = {};
+```
+## Fields
+| Field                                                        | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `email`                                                      | *string*                                                     | :heavy_minus_sign:                                           | Empty for service accounts                                   |
+| `id`                                                         | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `metadata`                                                   | Record<string, *string*>                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `name`                                                       | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `roles`                                                      | *string*[]                                                   | :heavy_minus_sign:                                           | N/A                                                          |
+| `tenant`                                                     | [models.TenantResponse](../../sdk/models/tenant-response.md) | :heavy_minus_sign:                                           | N/A                                                          |
+| `type`                                                       | [models.UserType](../../sdk/models/user-type.md)             | :heavy_minus_sign:                                           | N/A                                                          |

package/docs/sdk/models/update-subscription-line-item-request.md CHANGED Viewed

@@ -10,19 +10,20 @@ let value: UpdateSubscriptionLineItemRequest = {};
 ## Fields
-| Field                                                                         | Type                                                                          | Required                                                                      | Description                                                                   |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `amount`                                                                      | *string*                                                                      | :heavy_minus_sign:                                                            | Amount is the new price amount that overrides the original price              |
-| `billingModel`                                                                | [models.BillingModel](../../sdk/models/billing-model.md)                      | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `commitmentAmount`                                                            | *number*                                                                      | :heavy_minus_sign:                                                            | Commitment fields                                                             |
-| `commitmentDuration`                                                          | [models.BillingPeriod](../../sdk/models/billing-period.md)                    | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `commitmentOverageFactor`                                                     | *number*                                                                      | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `commitmentQuantity`                                                          | *number*                                                                      | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `commitmentTrueUpEnabled`                                                     | *boolean*                                                                     | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `commitmentType`                                                              | [models.CommitmentType](../../sdk/models/commitment-type.md)                  | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `commitmentWindowed`                                                          | *boolean*                                                                     | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `effectiveFrom`                                                               | *string*                                                                      | :heavy_minus_sign:                                                            | EffectiveFrom for the existing line item (if not provided, defaults to now)   |
-| `metadata`                                                                    | Record<string, *string*>                                                      | :heavy_minus_sign:                                                            | Metadata for the new line item                                                |
-| `tierMode`                                                                    | [models.BillingTier](../../sdk/models/billing-tier.md)                        | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `tiers`                                                                       | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[]             | :heavy_minus_sign:                                                            | Tiers determines the pricing tiers for this line item                         |
-| `transformQuantity`                                                           | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign:                                                            | N/A                                                                           |
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `amount`                                                                             | *string*                                                                             | :heavy_minus_sign:                                                                   | Amount is the new price amount that overrides the original price                     |
+| `billingModel`                                                                       | [models.BillingModel](../../sdk/models/billing-model.md)                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `commitmentAmount`                                                                   | *number*                                                                             | :heavy_minus_sign:                                                                   | Commitment fields                                                                    |
+| `commitmentDuration`                                                                 | [models.BillingPeriod](../../sdk/models/billing-period.md)                           | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `commitmentOverageFactor`                                                            | *number*                                                                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `commitmentQuantity`                                                                 | *number*                                                                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `commitmentTimeBuckets`                                                              | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[]    | :heavy_minus_sign:                                                                   | Pointer so an explicit empty array can clear existing buckets (omission keeps them). |
+| `commitmentTrueUpEnabled`                                                            | *boolean*                                                                            | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `commitmentType`                                                                     | [models.CommitmentType](../../sdk/models/commitment-type.md)                         | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `commitmentWindowed`                                                                 | *boolean*                                                                            | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `effectiveFrom`                                                                      | *string*                                                                             | :heavy_minus_sign:                                                                   | EffectiveFrom for the existing line item (if not provided, defaults to now)          |
+| `metadata`                                                                           | Record<string, *string*>                                                             | :heavy_minus_sign:                                                                   | Metadata for the new line item                                                       |
+| `tierMode`                                                                           | [models.BillingTier](../../sdk/models/billing-tier.md)                               | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `tiers`                                                                              | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[]                    | :heavy_minus_sign:                                                                   | Tiers determines the pricing tiers for this line item                                |
+| `transformQuantity`                                                                  | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md)        | :heavy_minus_sign:                                                                   | N/A                                                                                  |

package/docs/sdk/models/update-user-request.md CHANGED Viewed

@@ -12,4 +12,5 @@ let value: UpdateUserRequest = {};
 | Field                    | Type                     | Required                 | Description              |
 | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
-| `metadata`               | Record<string, *string*> | :heavy_minus_sign:       | N/A                      |
+| `metadata`               | Record<string, *string*> | :heavy_minus_sign:       | N/A                      |
+| `name`                   | *string*                 | :heavy_minus_sign:       | N/A                      |

package/docs/sdk/models/update-user-response.md CHANGED Viewed

@@ -15,6 +15,7 @@ let value: UpdateUserResponse = {};
 | `email`                                                      | *string*                                                     | :heavy_minus_sign:                                           | Empty for service accounts                                   |
 | `id`                                                         | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
 | `metadata`                                                   | Record<string, *string*>                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `name`                                                       | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
 | `roles`                                                      | *string*[]                                                   | :heavy_minus_sign:                                           | N/A                                                          |
 | `tenant`                                                     | [models.TenantResponse](../../sdk/models/tenant-response.md) | :heavy_minus_sign:                                           | N/A                                                          |
 | `type`                                                       | [models.UserType](../../sdk/models/user-type.md)             | :heavy_minus_sign:                                           | N/A                                                          |