@flexprice/sdk 2.1.20 → 2.1.25

package/docs/sdk/models/entitlement-grant-duration-unit.md

@@ -0,0 +1,17 @@
+# EntitlementGrantDurationUnit
+
+## Example Usage
+
+```typescript
+import { EntitlementGrantDurationUnit } from "@flexprice/sdk/sdk/models";
+
+let value: EntitlementGrantDurationUnit = "day";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"hour" | "day" | "week" | "subscription_period" | Unrecognized<string>
+```

package/docs/sdk/models/entitlement-grant-measure.md

@@ -0,0 +1,17 @@
+# EntitlementGrantMeasure
+
+## Example Usage
+
+```typescript
+import { EntitlementGrantMeasure } from "@flexprice/sdk/sdk/models";
+
+let value: EntitlementGrantMeasure = "quantity";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"quantity" | "amount" | Unrecognized<string>
+```

package/docs/sdk/models/entitlement-response.md

@@ -40,30 +40,37 @@ let value: EntitlementResponse = {
 
 ## Fields
 
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `addon`                                                                                       | [models.AddonResponse](../../sdk/models/addon-response.md)                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `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                                                                                           |
-| `displayOrder`                                                                                | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `entityId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `entityType`                                                                                  | [models.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `feature`                                                                                     | [models.FeatureResponse](../../sdk/models/feature-response.md)                                | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `featureId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `featureType`                                                                                 | [models.FeatureType](../../sdk/models/feature-type.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `isEnabled`                                                                                   | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `isSoftLimit`                                                                                 | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `parentEntitlementId`                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `plan`                                                                                        | [models.PlanResponse](../../sdk/models/plan-response.md)                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `planId`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | TODO: Remove this once we have a proper entitlement entity type                               |
-| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `staticValue`                                                                                 | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `updatedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `updatedBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `usageLimit`                                                                                  | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `usageResetPeriod`                                                                            | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md)      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| Field                                                                                                  | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `addon`                                                                                                | [models.AddonResponse](../../sdk/models/addon-response.md)                                             | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `aggregationMode`                                                                                      | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `configValue`                                                                                          | Record<string, *any*>                                                                                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `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                                                                                                    |
+| `displayOrder`                                                                                         | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `endDate`                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `entityId`                                                                                             | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `entityType`                                                                                           | [models.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                            | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `environmentId`                                                                                        | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `feature`                                                                                              | [models.FeatureResponse](../../sdk/models/feature-response.md)                                         | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `featureId`                                                                                            | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `featureType`                                                                                          | [models.FeatureType](../../sdk/models/feature-type.md)                                                 | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantAllocationBehavior`                                                                              | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md) | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantDurationUnit`                                                                                    | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md)             | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantDurationValue`                                                                                   | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantMeasure`                                                                                         | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md)                        | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantQuota`                                                                                           | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `id`                                                                                                   | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `isEnabled`                                                                                            | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `isSoftLimit`                                                                                          | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `parentEntitlementId`                                                                                  | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `plan`                                                                                                 | [models.PlanResponse](../../sdk/models/plan-response.md)                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `planId`                                                                                               | *string*                                                                                               | :heavy_minus_sign:                                                                                     | TODO: Remove this once we have a proper entitlement entity type                                        |
+| `startDate`                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `staticValue`                                                                                          | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `status`                                                                                               | [models.Status](../../sdk/models/status.md)                                                            | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `tenantId`                                                                                             | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `updatedAt`                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `updatedBy`                                                                                            | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `usageLimit`                                                                                           | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `usageResetPeriod`                                                                                     | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md)               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |

package/docs/sdk/models/entitlement-source.md

@@ -12,6 +12,7 @@ let value: EntitlementSource = {};
 
 | Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
 | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `configValue`                                                                            | Record<string, *any*>                                                                    | :heavy_minus_sign:                                                                       | N/A                                                                                      |
 | `entitlementId`                                                                          | *string*                                                                                 | :heavy_minus_sign:                                                                       | N/A                                                                                      |
 | `entityId`                                                                               | *string*                                                                                 | :heavy_minus_sign:                                                                       | N/A                                                                                      |
 | `entityName`                                                                             | *string*                                                                                 | :heavy_minus_sign:                                                                       | N/A                                                                                      |

package/docs/sdk/models/entity-change-behaviour.md

@@ -0,0 +1,17 @@
+# EntityChangeBehaviour
+
+## Example Usage
+
+```typescript
+import { EntityChangeBehaviour } from "@flexprice/sdk/sdk/models";
+
+let value: EntityChangeBehaviour = "carry";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"carry" | "drop" | Unrecognized<string>
+```

package/docs/sdk/models/entity-change-policy.md

@@ -0,0 +1,16 @@
+# EntityChangePolicy
+
+## Example Usage
+
+```typescript
+import { EntityChangePolicy } from "@flexprice/sdk/sdk/models";
+
+let value: EntityChangePolicy = {};
+```
+
+## Fields
+
+| Field                                                                                       | Type                                                                                        | Required                                                                                    | Description                                                                                 |
+| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| `defaultBehaviour`                                                                          | [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md)                 | :heavy_minus_sign:                                                                          | N/A                                                                                         |
+| `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.             |

package/docs/sdk/models/entity-change-result.md

@@ -0,0 +1,18 @@
+# EntityChangeResult
+
+## Example Usage
+
+```typescript
+import { EntityChangeResult } from "@flexprice/sdk/sdk/models";
+
+let value: EntityChangeResult = {};
+```
+
+## Fields
+
+| Field                                                                                           | Type                                                                                            | Required                                                                                        | Description                                                                                     |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `behaviour`                                                                                     | [models.EntityChangeBehaviour](../../sdk/models/entity-change-behaviour.md)                     | :heavy_minus_sign:                                                                              | N/A                                                                                             |
+| `entityId`                                                                                      | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
+| `entityType`                                                                                    | [models.SubscriptionLineItemEntityType](../../sdk/models/subscription-line-item-entity-type.md) | :heavy_minus_sign:                                                                              | N/A                                                                                             |
+| `referenceId`                                                                                   | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |

package/docs/sdk/models/error-code.md

@@ -13,5 +13,5 @@ let value: ErrorCode = "invalid_operation";
 ## Values
 
 ```typescript
-"http_client_error" | "system_error" | "internal_error" | "not_found" | "already_exists" | "version_conflict" | "validation_error" | "invalid_operation" | "permission_denied" | "database_error" | "service_unavailable" | "too_many_requests" | Unrecognized<string>
+"http_client_error" | "system_error" | "internal_error" | "not_found" | "already_exists" | "version_conflict" | "validation_error" | "invalid_operation" | "permission_denied" | "database_error" | "service_unavailable" | "too_many_requests" | "not_implemented" | Unrecognized<string>
 ```

package/docs/sdk/models/execute-subscription-modify-request.md

@@ -6,7 +6,7 @@
 import { ExecuteSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
 
 let value: ExecuteSubscriptionModifyRequest = {
-  type: "coupon",
+  type: "tax",
 };
 ```
 
@@ -14,6 +14,8 @@ let value: ExecuteSubscriptionModifyRequest = {
 
 | Field                                                                                             | Type                                                                                              | Required                                                                                          | Description                                                                                       |
 | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `addonParams`                                                                                     | [models.SubModifyAddonParams](../../sdk/models/sub-modify-addon-params.md)                        | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `checkout`                                                                                        | [models.CheckoutParams](../../sdk/models/checkout-params.md)                                      | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `couponParams`                                                                                    | [models.SubModifyCouponParams](../../sdk/models/sub-modify-coupon-params.md)                      | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `groupedInvoicingParams`                                                                          | [models.SubModifyGroupedInvoicingParams](../../sdk/models/sub-modify-grouped-invoicing-params.md) | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `inheritanceParams`                                                                               | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md)          | :heavy_minus_sign:                                                                                | N/A                                                                                               |

package/docs/sdk/models/execute-subscription-plan-change-v2-request.md

@@ -0,0 +1,22 @@
+# ExecuteSubscriptionPlanChangeV2Request
+
+## Example Usage
+
+```typescript
+import { ExecuteSubscriptionPlanChangeV2Request } from "@flexprice/sdk/sdk/models";
+
+let value: ExecuteSubscriptionPlanChangeV2Request = {
+  id: "<id>",
+  body: {
+    prorationBehavior: "none",
+    targetPlanId: "<id>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `id`                                                                                     | *string*                                                                                 | :heavy_check_mark:                                                                       | Subscription ID                                                                          |
+| `body`                                                                                   | [models.SubscriptionChangeV2Request](../../sdk/models/subscription-change-v2-request.md) | :heavy_check_mark:                                                                       | Plan change request                                                                      |

package/docs/sdk/models/feature-type.md

@@ -5,7 +5,7 @@
 ```typescript
 import { FeatureType } from "@flexprice/sdk/sdk/models";
 
-let value: FeatureType = "metered";
+let value: FeatureType = "boolean";
 
 // Open enum: unrecognized values are captured as Unrecognized<string>
 ```
@@ -13,5 +13,5 @@ let value: FeatureType = "metered";
 ## Values
 
 ```typescript
-"metered" | "boolean" | "static" | Unrecognized<string>
+"metered" | "boolean" | "static" | "config" | Unrecognized<string>
 ```

package/docs/sdk/models/filter-operator-type.md

@@ -5,11 +5,11 @@
 ```typescript
 import { FilterOperatorType } from "@flexprice/sdk/sdk/models";
 
-let value: FilterOperatorType = "lt";
+let value: FilterOperatorType = "gte";
 ```
 
 ## Values
 
 ```typescript
-"eq" | "contains" | "not_contains" | "gt" | "lt" | "in" | "not_in" | "before" | "after"
+"eq" | "contains" | "not_contains" | "gt" | "lt" | "gte" | "in" | "not_in" | "before" | "after"
 ```

package/docs/sdk/models/gcp-marketplace-agreement.md

@@ -0,0 +1,23 @@
+# GCPMarketplaceAgreement
+
+## Example Usage
+
+```typescript
+import { GCPMarketplaceAgreement } from "@flexprice/sdk/sdk/models";
+
+let value: GCPMarketplaceAgreement = {
+  accountId: "<id>",
+  metricName: "<value>",
+  serviceName: "<value>",
+  usageReportingId: "<id>",
+};
+```
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `accountId`                                                         | *string*                                                            | :heavy_check_mark:                                                  | writes the customer mapping; not read in the report payload         |
+| `metricName`                                                        | *string*                                                            | :heavy_check_mark:                                                  | -> services.report's metricName (always "{service_name}/usage_fee") |
+| `serviceName`                                                       | *string*                                                            | :heavy_check_mark:                                                  | -> services.report URL's service_name; identifies the product       |
+| `usageReportingId`                                                  | *string*                                                            | :heavy_check_mark:                                                  | -> services.report's consumerId; identifies the buyer               |

package/docs/sdk/models/get-addon-credit-grants-request.md

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

package/docs/sdk/models/get-alert-settings-request.md

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

package/docs/sdk/models/get-checkout-session-request.md

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

package/docs/sdk/models/get-cost-analytics-request.md

@@ -10,12 +10,14 @@ let value: GetCostAnalyticsRequest = {};
 
 ## Fields
 
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `expand`                                                                                      | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | Expand options - specify which entities to expand                                             |
-| `externalCustomerId`                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | Optional - for specific customer                                                              |
-| `featureIds`                                                                                  | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | Additional filters                                                                            |
-| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | Pagination                                                                                    |
-| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `startTime`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | Time range fields (optional - defaults to last 7 days if not provided)                        |
+| Field                                                                                                                                                                                                                                                                             | Type                                                                                                                                                                                                                                                                              | Required                                                                                                                                                                                                                                                                          | Description                                                                                                                                                                                                                                                                       |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `endTime`                                                                                                                                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                                                               |
+| `expand`                                                                                                                                                                                                                                                                          | *string*[]                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                | Expand options - specify which entities to expand                                                                                                                                                                                                                                 |
+| `externalCustomerId`                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                | Optional - for specific customer                                                                                                                                                                                                                                                  |
+| `featureIds`                                                                                                                                                                                                                                                                      | *string*[]                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                | Additional filters                                                                                                                                                                                                                                                                |
+| `includeChildren`                                                                                                                                                                                                                                                                 | *boolean*                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                | IncludeChildren, when true and ExternalCustomerID belongs to a parent<br/>customer, aggregates every inherited-child customer's usage into the<br/>revenue and cost totals. Default (false) restricts the query to the<br/>customer's own usage — mirrors the meter-usage analytics contract. |
+| `limit`                                                                                                                                                                                                                                                                           | *number*                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                | Pagination                                                                                                                                                                                                                                                                        |
+| `offset`                                                                                                                                                                                                                                                                          | *number*                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                                                               |
+| `propertyFilters`                                                                                                                                                                                                                                                                 | Record<string, *string*[]>                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                | Property filters to filter the events by the keys in `properties` field of the event                                                                                                                                                                                              |
+| `startTime`                                                                                                                                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                | Time range fields (optional - defaults to last 7 days if not provided)                                                                                                                                                                                                            |

package/docs/sdk/models/get-customer-entitlements-by-external-id-request.md

@@ -0,0 +1,17 @@
+# GetCustomerEntitlementsByExternalIDRequest
+
+## Example Usage
+
+```typescript
+import { GetCustomerEntitlementsByExternalIDRequest } from "@flexprice/sdk/sdk/models";
+
+let value: GetCustomerEntitlementsByExternalIDRequest = {
+  externalId: "<id>",
+};
+```
+
+## Fields
+
+| Field                | Type                 | Required             | Description          |
+| -------------------- | -------------------- | -------------------- | -------------------- |
+| `externalId`         | *string*             | :heavy_check_mark:   | Customer External ID |

package/docs/sdk/models/get-hugging-face-billing-data-request.md

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

package/docs/sdk/models/get-invoice-request.md

@@ -12,8 +12,9 @@ let value: GetInvoiceRequest = {
 
 ## Fields
 
-| Field                                                                                   | Type                                                                                    | Required                                                                                | Description                                                                             |
-| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `id`                                                                                    | *string*                                                                                | :heavy_check_mark:                                                                      | Invoice ID                                                                              |
-| `expandBySource`                                                                        | *boolean*                                                                               | :heavy_minus_sign:                                                                      | Include source-level price breakdown for usage line items (legacy)                      |
-| `groupBy`                                                                               | *string*[]                                                                              | :heavy_minus_sign:                                                                      | Group usage breakdown by specified fields (e.g., source, feature_id, properties.org_id) |
+| Field                                                                                                                  | Type                                                                                                                   | Required                                                                                                               | Description                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `id`                                                                                                                   | *string*                                                                                                               | :heavy_check_mark:                                                                                                     | Invoice ID                                                                                                             |
+| `expandBySource`                                                                                                       | *boolean*                                                                                                              | :heavy_minus_sign:                                                                                                     | Include source-level price breakdown for usage line items (legacy)                                                     |
+| `groupBy`                                                                                                              | *string*[]                                                                                                             | :heavy_minus_sign:                                                                                                     | Group usage breakdown by specified fields (e.g., source, feature_id, properties.org_id)                                |
+| `expand`                                                                                                               | *string*                                                                                                               | :heavy_minus_sign:                                                                                                     | Comma-separated related fields to include. Supports 'tax_applied.tax_rate' to attach rate details to each applied tax. |

package/docs/sdk/models/get-subscriptions-for-customer-request.md

@@ -0,0 +1,18 @@
+# GetSubscriptionsForCustomerRequest
+
+## Example Usage
+
+```typescript
+import { GetSubscriptionsForCustomerRequest } from "@flexprice/sdk/sdk/models";
+
+let value: GetSubscriptionsForCustomerRequest = {
+  externalId: "<id>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                   | Type                                                                                                                    | Required                                                                                                                | Description                                                                                                             |
+| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `externalId`                                                                                                            | *string*                                                                                                                | :heavy_check_mark:                                                                                                      | Customer External ID                                                                                                    |
+| `expand`                                                                                                                | *string*                                                                                                                | :heavy_minus_sign:                                                                                                      | Comma-separated fields to expand: subscription_line_items, subscription_line_items.meters, entitlements, plan, customer |

package/docs/sdk/models/get-usage-analytics-response.md

@@ -49,4 +49,6 @@ let value: GetUsageAnalyticsResponse = {
 | `currency`                                                              | *string*                                                                | :heavy_minus_sign:                                                      | N/A                                                                     |
 | `customAnalytics`                                                       | [models.CustomAnalyticItem](../../sdk/models/custom-analytic-item.md)[] | :heavy_minus_sign:                                                      | N/A                                                                     |
 | `items`                                                                 | [models.UsageAnalyticItem](../../sdk/models/usage-analytic-item.md)[]   | :heavy_minus_sign:                                                      | N/A                                                                     |
-| `totalCost`                                                             | *string*                                                                | :heavy_minus_sign:                                                      | N/A                                                                     |
+| `subtotal`                                                              | *string*                                                                | :heavy_minus_sign:                                                      | N/A                                                                     |
+| `totalCost`                                                             | *string*                                                                | :heavy_minus_sign:                                                      | TotalCost is the final cost after discount (Subtotal - TotalDiscount)   |
+| `totalDiscount`                                                         | *string*                                                                | :heavy_minus_sign:                                                      | N/A                                                                     |

package/docs/sdk/models/get-usage-by-meter-request.md

@@ -27,4 +27,5 @@ let value: GetUsageByMeterRequest = {
 | `filters`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Record<string, *string*[]>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `meterId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 123                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | `startTime`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 2024-11-09T00:00:00Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `timezone`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `windowSize`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |