@flexprice/sdk 2.1.25 → 2.1.30

package/docs/sdk/models/list-subscription-schedules-request.md

@@ -6,7 +6,7 @@
 import { ListSubscriptionSchedulesRequest } from "@flexprice/sdk/sdk/models";
 
 let value: ListSubscriptionSchedulesRequest = {
-  subscriptionId: "<id>",
+  id: "<id>",
 };
 ```
 
@@ -14,4 +14,4 @@ let value: ListSubscriptionSchedulesRequest = {
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `subscriptionId`   | *string*           | :heavy_check_mark: | Subscription ID    |
+| `id`               | *string*           | :heavy_check_mark: | Subscription ID    |

package/docs/sdk/models/list-usage-records-response.md

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

package/docs/sdk/models/metadata-custom-field-source.md

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

package/docs/sdk/models/metadata-custom-field.md

@@ -0,0 +1,17 @@
+# MetadataCustomField
+
+## Example Usage
+
+```typescript
+import { MetadataCustomField } from "@flexprice/sdk/sdk/models";
+
+let value: MetadataCustomField = {};
+```
+
+## Fields
+
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `field`                                                                              | *string*                                                                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `metadataKey`                                                                        | *string*                                                                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `source`                                                                             | [models.MetadataCustomFieldSource](../../sdk/models/metadata-custom-field-source.md) | :heavy_minus_sign:                                                                   | N/A                                                                                  |

package/docs/sdk/models/meter-aggregation.md

@@ -10,11 +10,11 @@ let value: MeterAggregation = {};
 
 ## Fields
 
-| Field                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                               |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `bucketSize`                                                                                                                                                                                                                                                                                              | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                       |
-| `expression`                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | Expression is an optional CEL expression to compute per-event quantity from event.properties.<br/>When set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).                                                                                        |
-| `field`                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | Field is the key in $event.properties on which the aggregation is to be applied<br/>For ex if the aggregation type is sum for API usage, the field could be "duration_ms"<br/>Ignored when Expression is set.                                                                                             |
-| `groupBy`                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | GroupBy is the property name in event.properties to group by before aggregating.<br/>Currently only supported for MAX aggregation with bucket_size.<br/>When set, aggregation is applied per unique value of this property within each bucket,<br/>then the per-group results are summed to produce the bucket total. |
-| `multiplier`                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | Multiplier is the multiplier for the aggregation<br/>For ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000<br/>to scale up by a factor of 1000. If not provided, it will be null.                                                                             |
-| `type`                                                                                                                                                                                                                                                                                                    | [models.AggregationType](../../sdk/models/aggregation-type.md)                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                       |
+| Field                                                                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                               |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bucketSize`                                                                                                                                                                                                                                                                                                                                              | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                       |
+| `expression`                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Expression is an optional CEL expression to compute per-event quantity from event.properties.<br/>When set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).                                                                                                                                        |
+| `field`                                                                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Field is the key in $event.properties on which the aggregation is to be applied<br/>For ex if the aggregation type is sum for API usage, the field could be "duration_ms"<br/>Ignored when Expression is set.                                                                                                                                             |
+| `groupBy`                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | GroupBy is the property name in event.properties to group by before aggregating.<br/>Requires MAX aggregation. Windowing comes from the price, so this no longer<br/>implies a meter-level bucket_size.<br/>When set, aggregation is applied per unique value of this property within each bucket,<br/>then the per-group results are summed to produce the bucket total. |
+| `multiplier`                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Multiplier is the multiplier for the aggregation<br/>For ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000<br/>to scale up by a factor of 1000. If not provided, it will be null.                                                                                                                             |
+| `type`                                                                                                                                                                                                                                                                                                                                                    | [models.AggregationType](../../sdk/models/aggregation-type.md)                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                       |

package/docs/sdk/models/on-pending-schedule-policy.md

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

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/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/plan-price-sync-status-response.md

@@ -0,0 +1,17 @@
+# PlanPriceSyncStatusResponse
+
+## Example Usage
+
+```typescript
+import { PlanPriceSyncStatusResponse } from "@flexprice/sdk/sdk/models";
+
+let value: PlanPriceSyncStatusResponse = {};
+```
+
+## Fields
+
+| Field                       | Type                        | Required                    | Description                 |
+| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
+| `currentSequence`           | *number*                    | :heavy_minus_sign:          | N/A                         |
+| `synced`                    | *boolean*                   | :heavy_minus_sign:          | N/A                         |
+| `unsyncedSubscriptionCount` | *number*                    | :heavy_minus_sign:          | N/A                         |

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

@@ -72,6 +72,7 @@ let value: PlanResponse = {
 | `lookupKey`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `name`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `priceSyncStatus`                                                                             | [models.PlanPriceSyncStatusResponse](../../sdk/models/plan-price-sync-status-response.md)     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `prices`                                                                                      | [models.PriceResponse](../../sdk/models/price-response.md)[]                                  | :heavy_minus_sign:                                                                            | TODO: Add inline addons                                                                       |
 | `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

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

@@ -0,0 +1,15 @@
+# PriceFeatureResponse
+
+## Example Usage
+
+```typescript
+import { PriceFeatureResponse } from "@flexprice/sdk/sdk/models";
+
+let value: PriceFeatureResponse = {};
+```
+
+## Fields
+
+| Field                                                      | Type                                                       | Required                                                   | Description                                                |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `reportingUnit`                                            | [models.ReportingUnit](../../sdk/models/reporting-unit.md) | :heavy_minus_sign:                                         | N/A                                                        |

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                                                                                                                                                                                                                                                                  |
@@ -58,6 +59,7 @@ let value: PriceResponse = {
 | `entityId`                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | EntityID holds the value of the "entity_id" field.                                                                                                                                                                                                                   |
 | `entityType`                                                                                                                                                                                                                                                         | [models.PriceEntityType](../../sdk/models/price-entity-type.md)                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `environmentId`                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | EnvironmentID is the environment identifier for the price                                                                                                                                                                                                            |
+| `feature`                                                                                                                                                                                                                                                            | [models.PriceFeatureResponse](../../sdk/models/price-feature-response.md)                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `group`                                                                                                                                                                                                                                                              | [models.GroupResponse](../../sdk/models/group-response.md)                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `groupId`                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | GroupID references the group this price belongs to                                                                                                                                                                                                                   |
 | `id`                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | ID uuid identifier for the price                                                                                                                                                                                                                                     |

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/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-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/s3-job-config.md

@@ -18,5 +18,6 @@ let value: S3JobConfig = {};
 | `endpointUrl`                                                                | *string*                                                                     | :heavy_minus_sign:                                                           | Custom S3-compatible endpoint URL; must be https on a publicly routable host |
 | `exportMetadataFields`                                                       | [models.ExportMetadataField](../../sdk/models/export-metadata-field.md)[]    | :heavy_minus_sign:                                                           | Optional user-selected metadata columns                                      |
 | `keyPrefix`                                                                  | *string*                                                                     | :heavy_minus_sign:                                                           | Optional prefix for S3 keys (e.g., "flexprice-exports/")                     |
+| `provider`                                                                   | [models.SecretProvider](../../sdk/models/secret-provider.md)                 | :heavy_minus_sign:                                                           | N/A                                                                          |
 | `region`                                                                     | *string*                                                                     | :heavy_minus_sign:                                                           | AWS region (e.g., "us-west-2")                                               |
 | `usePathStyle`                                                               | *boolean*                                                                    | :heavy_minus_sign:                                                           | Use path-style addressing (required for MinIO)                               |

package/docs/sdk/models/secret-provider.md

@@ -5,7 +5,7 @@
 ```typescript
 import { SecretProvider } from "@flexprice/sdk/sdk/models";
 
-let value: SecretProvider = "moyasar";
+let value: SecretProvider = "nomod";
 
 // Open enum: unrecognized values are captured as Unrecognized<string>
 ```
@@ -13,5 +13,5 @@ let value: SecretProvider = "moyasar";
 ## Values
 
 ```typescript
-"flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | "whop" | "tabs" | "aws_marketplace" | "gcp_marketplace" | "azure_marketplace" | Unrecognized<string>
+"flexprice" | "stripe" | "s3" | "gcs" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | "whop" | "tabs" | "aws_marketplace" | "gcp_marketplace" | "azure_marketplace" | Unrecognized<string>
 ```

package/docs/sdk/models/storage-export-config.md

@@ -0,0 +1,20 @@
+# StorageExportConfig
+
+## Example Usage
+
+```typescript
+import { StorageExportConfig } from "@flexprice/sdk/sdk/models";
+
+let value: StorageExportConfig = {};
+```
+
+## Fields
+
+| Field                                                                       | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `bucket`                                                                    | *string*                                                                    | :heavy_minus_sign:                                                          | Storage bucket name                                                         |
+| `compression`                                                               | [models.S3CompressionType](../../sdk/models/s3-compression-type.md)         | :heavy_minus_sign:                                                          | N/A                                                                         |
+| `encryption`                                                                | [models.S3EncryptionType](../../sdk/models/s3-encryption-type.md)           | :heavy_minus_sign:                                                          | N/A                                                                         |
+| `isFlexpriceManaged`                                                        | *boolean*                                                                   | :heavy_minus_sign:                                                          | If true, use Flexprice-managed storage credentials instead of user-provided |
+| `keyPrefix`                                                                 | *string*                                                                    | :heavy_minus_sign:                                                          | Optional prefix for object keys (e.g., "flexprice-exports/")                |
+| `region`                                                                    | *string*                                                                    | :heavy_minus_sign:                                                          | Cloud region (e.g., "us-west-2"); unused for GCS                            |

package/docs/sdk/models/subscription-change-billing-period-result.md

@@ -0,0 +1,18 @@
+# SubscriptionChangeBillingPeriodResult
+
+## Example Usage
+
+```typescript
+import { SubscriptionChangeBillingPeriodResult } from "@flexprice/sdk/sdk/models";
+
+let value: SubscriptionChangeBillingPeriodResult = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `behaviour`                                                                                   | [models.BillingPeriodBehaviour](../../sdk/models/billing-period-behaviour.md)                 | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `billingAnchor`                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `currentPeriodEnd`                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `currentPeriodStart`                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/subscription-change-conflict-policies.md

@@ -0,0 +1,15 @@
+# SubscriptionChangeConflictPolicies
+
+## Example Usage
+
+```typescript
+import { SubscriptionChangeConflictPolicies } from "@flexprice/sdk/sdk/models";
+
+let value: SubscriptionChangeConflictPolicies = {};
+```
+
+## Fields
+
+| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `onPendingSchedule`                                                              | [models.OnPendingSchedulePolicy](../../sdk/models/on-pending-schedule-policy.md) | :heavy_minus_sign:                                                               | N/A                                                                              |

package/docs/sdk/models/subscription-change-entity-type.md

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