@flexprice/sdk 2.1.26 → 2.1.33

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

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

package/docs/sdk/models/on-existing-entity-policy.md

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

package/docs/sdk/models/override-entitlement-request.md

@@ -14,8 +14,15 @@ let value: OverrideEntitlementRequest = {
 
 | Field                                                                                                                     | Type                                                                                                                      | Required                                                                                                                  | Description                                                                                                               |
 | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
+| `aggregationMode`                                                                                                         | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                                     | :heavy_minus_sign:                                                                                                        | N/A                                                                                                                       |
 | `configValue`                                                                                                             | Record<string, *any*>                                                                                                     | :heavy_minus_sign:                                                                                                        | ConfigValue is the config value for config features                                                                       |
 | `entitlementId`                                                                                                           | *string*                                                                                                                  | :heavy_check_mark:                                                                                                        | EntitlementID references the plan/addon entitlement to override                                                           |
+| `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`                                                                                                              | *string*                                                                                                                  | :heavy_minus_sign:                                                                                                        | N/A                                                                                                                       |
+| `grantUnlimited`                                                                                                          | *boolean*                                                                                                                 | :heavy_minus_sign:                                                                                                        | N/A                                                                                                                       |
 | `isEnabled`                                                                                                               | *boolean*                                                                                                                 | :heavy_minus_sign:                                                                                                        | IsEnabled determines if the entitlement is enabled or disabled                                                            |
 | `staticValue`                                                                                                             | *string*                                                                                                                  | :heavy_minus_sign:                                                                                                        | StaticValue is the static value for static features                                                                       |
 | `usageLimit`                                                                                                              | *number*                                                                                                                  | :heavy_minus_sign:                                                                                                        | UsageLimit is the new usage limit (only these 3 fields can be overridden)<br/>For metered features, nil means unlimited usage |

package/docs/sdk/models/override-line-item-request.md

@@ -16,6 +16,7 @@ let value: OverrideLineItemRequest = {
 | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
 | `amount`                                                                                           | *string*                                                                                           | :heavy_minus_sign:                                                                                 | Amount is the new price amount that overrides the original price (optional)                        |
 | `billingModel`                                                                                     | [models.BillingModel](../../sdk/models/billing-model.md)                                           | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
+| `bucketSize`                                                                                       | [models.WindowSize](../../sdk/models/window-size.md)                                               | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
 | `priceId`                                                                                          | *string*                                                                                           | :heavy_check_mark:                                                                                 | PriceID references the plan price to override                                                      |
 | `priceUnitAmount`                                                                                  | *string*                                                                                           | :heavy_minus_sign:                                                                                 | PriceUnitAmount is the amount of the price unit (for CUSTOM type, FLAT_FEE/PACKAGE billing models) |
 | `priceUnitTiers`                                                                                   | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[]                                  | :heavy_minus_sign:                                                                                 | PriceUnitTiers are the tiers for the price unit (for CUSTOM type, TIERED billing model)            |

package/docs/sdk/models/pay-invoice-params.md

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

package/docs/sdk/models/payment-gateway-type.md

@@ -5,11 +5,11 @@
 ```typescript
 import { PaymentGatewayType } from "@flexprice/sdk/sdk/models";
 
-let value: PaymentGatewayType = "moyasar";
+let value: PaymentGatewayType = "paddle";
 ```
 
 ## Values
 
 ```typescript
-"stripe" | "razorpay" | "nomod" | "moyasar" | "paddle" | "whop"
+"stripe" | "razorpay" | "nomod" | "moyasar" | "paddle" | "whop" | "chargebee"
 ```

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

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

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

@@ -10,24 +10,25 @@ let value: PriceFilter = {};
 
 ## Fields
 
-| 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                                                                                           |
-| `expand`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `filters`                                                                                     | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                              | :heavy_minus_sign:                                                                            | DSL filters                                                                                   |
-| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `meterIds`                                                                                    | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `order`                                                                                       | [models.PriceFilterOrder](../../sdk/models/price-filter-order.md)                             | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `parentPriceId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `planIds`                                                                                     | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | Price override filtering fields                                                               |
-| `priceIds`                                                                                    | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `sort`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `startDateLt`                                                                                 | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `startTime`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `subscriptionId`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| 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                                                                                                                                                  |
+| `expand`                                                                                                                                             | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `filters`                                                                                                                                            | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                                                                                     | :heavy_minus_sign:                                                                                                                                   | DSL filters                                                                                                                                          |
+| `limit`                                                                                                                                              | *number*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `meterIds`                                                                                                                                           | *string*[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `offset`                                                                                                                                             | *number*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `order`                                                                                                                                              | [models.PriceFilterOrder](../../sdk/models/price-filter-order.md)                                                                                    | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `parentPriceId`                                                                                                                                      | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `planIds`                                                                                                                                            | *string*[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                   | Price override filtering fields                                                                                                                      |
+| `priceIds`                                                                                                                                           | *string*[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `sort`                                                                                                                                               | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `startDateLt`                                                                                                                                        | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `startTime`                                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                        | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `status`                                                                                                                                             | [models.Status](../../sdk/models/status.md)                                                                                                          | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `subscriptionId`                                                                                                                                     | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `updatedAfter`                                                                                                                                       | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | UpdatedAfter matches prices edited since the given time. TimeRangeFilter<br/>above filters on created_at, so it cannot see an edit to an existing<br/>price. |

package/docs/sdk/models/price-price.md

@@ -17,6 +17,7 @@ let value: PricePrice = {};
 | `billingModel`                                                                                                                                                                                                                                                       | [models.BillingModel](../../sdk/models/billing-model.md)                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `billingPeriod`                                                                                                                                                                                                                                                      | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `billingPeriodCount`                                                                                                                                                                                                                                                 | *number*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12                                                                                                                                                                                                 |
+| `bucketSize`                                                                                                                                                                                                                                                         | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `conversionRate`                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | ConversionRate is the conversion rate of the price unit to the fiat currency                                                                                                                                                                                         |
 | `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                                                                                                                                                                                                                                                                  |

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

@@ -46,6 +46,7 @@ let value: PriceResponse = {
 | `billingModel`                                                                                                                                                                                                                                                       | [models.BillingModel](../../sdk/models/billing-model.md)                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `billingPeriod`                                                                                                                                                                                                                                                      | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `billingPeriodCount`                                                                                                                                                                                                                                                 | *number*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12                                                                                                                                                                                                 |
+| `bucketSize`                                                                                                                                                                                                                                                         | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `conversionRate`                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | ConversionRate is the conversion rate of the price unit to the fiat currency                                                                                                                                                                                         |
 | `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                                                                                                                                                                                                                                                                  |

package/docs/sdk/models/process-credit-note-request.md

@@ -12,6 +12,7 @@ let value: ProcessCreditNoteRequest = {
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `id`               | *string*           | :heavy_check_mark: | Credit note ID     |
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `id`                                                                                 | *string*                                                                             | :heavy_check_mark:                                                                   | Credit note ID                                                                       |
+| `body`                                                                               | [models.FinalizeCreditNoteRequest](../../sdk/models/finalize-credit-note-request.md) | :heavy_minus_sign:                                                                   | Finalize options                                                                     |

package/docs/sdk/models/query-analytics-view-request.md

@@ -0,0 +1,19 @@
+# QueryAnalyticsViewRequest
+
+## Example Usage
+
+```typescript
+import { QueryAnalyticsViewRequest } from "@flexprice/sdk/sdk/models";
+
+let value: QueryAnalyticsViewRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+
+## Fields
+
+| Field                                                             | Type                                                              | Required                                                          | Description                                                       |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `id`                                                              | *string*                                                          | :heavy_check_mark:                                                | View ID                                                           |
+| `body`                                                            | [models.ViewQueryRequest](../../sdk/models/view-query-request.md) | :heavy_check_mark:                                                | View query request                                                |

package/docs/sdk/models/refund-destination.md

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

package/docs/sdk/models/refund-reason.md

@@ -0,0 +1,17 @@
+# RefundReason
+
+## Example Usage
+
+```typescript
+import { RefundReason } from "@flexprice/sdk/sdk/models";
+
+let value: RefundReason = "ORDER_CHANGE";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"DUPLICATE" | "FRAUDULENT" | "REQUESTED_BY_CUSTOMER" | "ORDER_CHANGE" | "SERVICE_ISSUE" | "OTHER" | Unrecognized<string>
+```

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

@@ -0,0 +1,45 @@
+# RefundResponse
+
+## Example Usage
+
+```typescript
+import { RefundResponse } from "@flexprice/sdk/sdk/models";
+
+let value: RefundResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `attempt`                                                                                     | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `cancelledAt`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :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                                                                                           |
+| `creditNoteId`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `currency`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `failedAt`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `failureReason`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `gatewayIdempotencyToken`                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `gatewayMetadata`                                                                             | Record<string, *any*>                                                                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `gatewayRefundId`                                                                             | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `gatewayTrackingId`                                                                           | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `idempotencyKey`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `initiatedAt`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `invoiceId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `paymentGateway`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `paymentId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `refundDestination`                                                                           | [models.RefundDestination](../../sdk/models/refund-destination.md)                            | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `refundDestinationId`                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `refundReason`                                                                                | [models.RefundReason](../../sdk/models/refund-reason.md)                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `refundStatus`                                                                                | [models.RefundStatus](../../sdk/models/refund-status.md)                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `settledAmount`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `succeededAt`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :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                                                                                           |

package/docs/sdk/models/refund-status.md

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

package/docs/sdk/models/refund-target.md

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

package/docs/sdk/models/remove-addon-ref.md

@@ -0,0 +1,18 @@
+# RemoveAddonRef
+
+## Example Usage
+
+```typescript
+import { RemoveAddonRef } from "@flexprice/sdk/sdk/models";
+
+let value: RemoveAddonRef = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `associationId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `effectiveDate`                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `prorationBehavior`                                                                           | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                            | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `reason`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/remove-addon-request.md

@@ -15,6 +15,7 @@ let value: RemoveAddonRequest = {
 | Field                                                                                                    | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
 | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
 | `addonAssociationId`                                                                                     | *string*                                                                                                 | :heavy_check_mark:                                                                                       | N/A                                                                                                      |
+| `changeAt`                                                                                               | [models.ScheduleType](../../sdk/models/schedule-type.md)                                                 | :heavy_minus_sign:                                                                                       | N/A                                                                                                      |
 | `effectiveDate`                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)            | :heavy_minus_sign:                                                                                       | EffectiveDate defaults to period end when nil; mid-period with create_prorations issues a wallet credit. |
 | `prorationBehavior`                                                                                      | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                                       | :heavy_minus_sign:                                                                                       | N/A                                                                                                      |
 | `reason`                                                                                                 | *string*                                                                                                 | :heavy_minus_sign:                                                                                       | N/A                                                                                                      |

package/docs/sdk/models/remove-user-request.md

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

package/docs/sdk/models/retry-refund-request.md

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

package/docs/sdk/models/revenue-allocation-policy.md

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

package/docs/sdk/models/revenue-analytics-request.md

@@ -0,0 +1,28 @@
+# RevenueAnalyticsRequest
+
+## Example Usage
+
+```typescript
+import { RevenueAnalyticsRequest } from "@flexprice/sdk/sdk/models";
+
+let value: RevenueAnalyticsRequest = {
+  startTime: new Date("2026-04-10T05:25:48.901Z"),
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                           |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `allocationPolicy`                                                                                                                                                                                                                                                                                                                                                    | [models.RevenueAllocationPolicy](../../sdk/models/revenue-allocation-policy.md)                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |
+| `currency`                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |
+| `customerIds`                                                                                                                                                                                                                                                                                                                                                         | *string*[]                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | Filters restrict the rows before aggregation.                                                                                                                                                                                                                                                                                                                         |
+| `endTime`                                                                                                                                                                                                                                                                                                                                                             | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |
+| `granularity`                                                                                                                                                                                                                                                                                                                                                         | [models.RevenueGranularity](../../sdk/models/revenue-granularity.md)                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |
+| `groupBy`                                                                                                                                                                                                                                                                                                                                                             | *string*[]                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | GroupBy dimensions: revenue_source, source (the event source recorded in<br/>meter_usage; requires customer_ids or subscription_ids), customer_id,<br/>subscription_id, price_id, meter_id, currency. revenue_source is always<br/>applied — every row says what kind of revenue it is — and requested<br/>dimensions are added on top.                               |
+| `includeAdjustments`                                                                                                                                                                                                                                                                                                                                                  | *boolean*                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | IncludeAdjustments breaks the non-obvious components — commitment<br/>true-ups, overage and revert (contra) rows — out as their own rows,<br/>each labeled with its kind in adjustment_type. Off, they fold into<br/>their parent buckets (true-up/overage into usage, reverts into their<br/>own source) so visible rows read as plain usage/fixed. Totals are<br/>identical either way. |
+| `meterIds`                                                                                                                                                                                                                                                                                                                                                            | *string*[]                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |
+| `priceIds`                                                                                                                                                                                                                                                                                                                                                            | *string*[]                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |
+| `startTime`                                                                                                                                                                                                                                                                                                                                                           | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                    | StartTime/EndTime bound the day range (inclusive days derived in UTC).<br/>EndTime is optional and defaults to now.                                                                                                                                                                                                                                                   |
+| `status`                                                                                                                                                                                                                                                                                                                                                              | [models.FactStatus](../../sdk/models/fact-status.md)                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |
+| `subscriptionIds`                                                                                                                                                                                                                                                                                                                                                     | *string*[]                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                                                                                                                                   |