@flexprice/sdk 2.1.33 → 2.1.34

package/docs/sdk/models/checkout-params.md

@@ -6,7 +6,7 @@
 import { CheckoutParams } from "@flexprice/sdk/sdk/models";
 
 let value: CheckoutParams = {
-  paymentProvider: "razorpay",
+  paymentProvider: "chargebee",
 };
 ```
 

package/docs/sdk/models/checkout-payment-provider.md

@@ -13,5 +13,5 @@ let value: CheckoutPaymentProvider = "razorpay";
 ## Values
 
 ```typescript
-"razorpay" | "chargebee" | Unrecognized<string>
+"razorpay" | "chargebee" | "stripe" | Unrecognized<string>
 ```

package/docs/sdk/models/configuration-details.md

@@ -0,0 +1,15 @@
+# ConfigurationDetails
+
+## Example Usage
+
+```typescript
+import { ConfigurationDetails } from "@flexprice/sdk/sdk/models";
+
+let value: ConfigurationDetails = {};
+```
+
+## Fields
+
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `planChange`                                                                         | [models.PlanChangeScheduleDetails](../../sdk/models/plan-change-schedule-details.md) | :heavy_minus_sign:                                                                   | N/A                                                                                  |

package/docs/sdk/models/cost-analytic-item.md

@@ -17,7 +17,7 @@ let value: CostAnalyticItem = {};
 | `currency`                                           | *string*                                             | :heavy_minus_sign:                                   | Metadata                                             |
 | `customerId`                                         | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
 | `externalCustomerId`                                 | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
-| `meter`                                              | [models.MeterMeter](../../sdk/models/meter-meter.md) | :heavy_minus_sign:                                   | N/A                                                  |
+| `meter`                                              | [models.Meter](../../sdk/models/meter.md)            | :heavy_minus_sign:                                   | N/A                                                  |
 | `meterId`                                            | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
 | `meterName`                                          | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
 | `price`                                              | [models.PricePrice](../../sdk/models/price-price.md) | :heavy_minus_sign:                                   | N/A                                                  |

package/docs/sdk/models/create-fx-rate-request.md

@@ -0,0 +1,27 @@
+# CreateFXRateRequest
+
+## Example Usage
+
+```typescript
+import { CreateFXRateRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateFXRateRequest = {
+  fromCurrency: "<value>",
+  scope: "tenant",
+  toCurrency: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | [models.FXRateSource](../../sdk/models/fx-rate-source.md)                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `toCurrency`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/sdk/models/delete-fx-rate-request.md

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

package/docs/sdk/models/execution-details.md

@@ -0,0 +1,15 @@
+# ExecutionDetails
+
+## Example Usage
+
+```typescript
+import { ExecutionDetails } from "@flexprice/sdk/sdk/models";
+
+let value: ExecutionDetails = {};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `planChange`                                                                       | [models.PlanChangeScheduleResult](../../sdk/models/plan-change-schedule-result.md) | :heavy_minus_sign:                                                                 | N/A                                                                                |

package/docs/sdk/models/fx-rate-filter-order.md

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

package/docs/sdk/models/fx-rate-filter.md

@@ -0,0 +1,28 @@
+# FXRateFilter
+
+## Example Usage
+
+```typescript
+import { FXRateFilter } from "@flexprice/sdk/sdk/models";
+
+let value: FXRateFilter = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `expand`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `filters`                                                                                     | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                              | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fxRateIds`                                                                                   | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `order`                                                                                       | [models.FXRateFilterOrder](../../sdk/models/fx-rate-filter-order.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sort`                                                                                        | [models.SortCondition](../../sdk/models/sort-condition.md)[]                                  | :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                                                                                           |
+| `toCurrency`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/fx-rate-response.md

@@ -0,0 +1,31 @@
+# FXRateResponse
+
+## Example Usage
+
+```typescript
+import { FXRateResponse } from "@flexprice/sdk/sdk/models";
+
+let value: FXRateResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `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                                                                                           |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | [models.FXRateSource](../../sdk/models/fx-rate-source.md)                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `startDate`                                                                                   | [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                                                                                           |
+| `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `toCurrency`                                                                                  | *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/fx-rate-scope.md

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

package/docs/sdk/models/fx-rate-source.md

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

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

@@ -7,11 +7,15 @@ import { GetEventRequest } from "@flexprice/sdk/sdk/models";
 
 let value: GetEventRequest = {
   id: "<id>",
+  externalCustomerId: "<id>",
 };
 ```
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `id`               | *string*           | :heavy_check_mark: | Event ID           |
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `id`                                                                               | *string*                                                                           | :heavy_check_mark:                                                                 | Event ID                                                                           |
+| `externalCustomerId`                                                               | *string*                                                                           | :heavy_check_mark:                                                                 | External customer ID the event was ingested with                                   |
+| `startTime`                                                                        | *string*                                                                           | :heavy_minus_sign:                                                                 | Start of the event timestamp window (RFC3339); defaults to 14 days before end_time |
+| `endTime`                                                                          | *string*                                                                           | :heavy_minus_sign:                                                                 | End of the event timestamp window (RFC3339); defaults to now                       |

package/docs/sdk/models/get-fx-rate-request.md

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

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

@@ -10,9 +10,12 @@ let value: ListAllSubscriptionSchedulesRequest = {};
 
 ## Fields
 
-| Field                            | Type                             | Required                         | Description                      |
-| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
-| `pendingOnly`                    | *boolean*                        | :heavy_minus_sign:               | Filter to pending schedules only |
-| `subscriptionId`                 | *string*                         | :heavy_minus_sign:               | Filter by subscription ID        |
-| `limit`                          | *number*                         | :heavy_minus_sign:               | Limit results                    |
-| `offset`                         | *number*                         | :heavy_minus_sign:               | Offset for pagination            |
+| Field                                                                                                                      | Type                                                                                                                       | Required                                                                                                                   | Description                                                                                                                |
+| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `pendingOnly`                                                                                                              | *boolean*                                                                                                                  | :heavy_minus_sign:                                                                                                         | Filter to pending schedules only                                                                                           |
+| `subscriptionId`                                                                                                           | *string*                                                                                                                   | :heavy_minus_sign:                                                                                                         | Filter by subscription ID                                                                                                  |
+| `subscriptionIds`                                                                                                          | *string*[]                                                                                                                 | :heavy_minus_sign:                                                                                                         | Filter by subscription IDs                                                                                                 |
+| `scheduleType`                                                                                                             | [models.ListAllSubscriptionSchedulesScheduleType](../../sdk/models/list-all-subscription-schedules-schedule-type.md)[]     | :heavy_minus_sign:                                                                                                         | Filter by schedule type                                                                                                    |
+| `scheduleStatus`                                                                                                           | [models.ListAllSubscriptionSchedulesScheduleStatus](../../sdk/models/list-all-subscription-schedules-schedule-status.md)[] | :heavy_minus_sign:                                                                                                         | Filter by schedule status                                                                                                  |
+| `limit`                                                                                                                    | *number*                                                                                                                   | :heavy_minus_sign:                                                                                                         | Limit results                                                                                                              |
+| `offset`                                                                                                                   | *number*                                                                                                                   | :heavy_minus_sign:                                                                                                         | Offset for pagination                                                                                                      |

package/docs/sdk/models/list-all-subscription-schedules-schedule-status.md

@@ -0,0 +1,15 @@
+# ListAllSubscriptionSchedulesScheduleStatus
+
+## Example Usage
+
+```typescript
+import { ListAllSubscriptionSchedulesScheduleStatus } from "@flexprice/sdk/sdk/models";
+
+let value: ListAllSubscriptionSchedulesScheduleStatus = "executed";
+```
+
+## Values
+
+```typescript
+"pending" | "executing" | "executed" | "cancelled" | "failed"
+```

package/docs/sdk/models/list-all-subscription-schedules-schedule-type.md

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

package/docs/sdk/models/list-customer-payment-methods-request.md

@@ -0,0 +1,18 @@
+# ListCustomerPaymentMethodsRequest
+
+## Example Usage
+
+```typescript
+import { ListCustomerPaymentMethodsRequest } from "@flexprice/sdk/sdk/models";
+
+let value: ListCustomerPaymentMethodsRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field                           | Type                            | Required                        | Description                     |
+| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
+| `id`                            | *string*                        | :heavy_check_mark:              | Customer ID                     |
+| `providers`                     | *string*[]                      | :heavy_minus_sign:              | Limit to these payment gateways |

package/docs/sdk/models/list-fx-rates-response.md

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

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

@@ -10,8 +10,8 @@ let value: MatchedMeter = {};
 
 ## Fields
 
-| Field                                                | Type                                                 | Required                                             | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
-| `eventName`                                          | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
-| `meter`                                              | [models.MeterMeter](../../sdk/models/meter-meter.md) | :heavy_minus_sign:                                   | N/A                                                  |
-| `meterId`                                            | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
+| Field                                     | Type                                      | Required                                  | Description                               |
+| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
+| `eventName`                               | *string*                                  | :heavy_minus_sign:                        | N/A                                       |
+| `meter`                                   | [models.Meter](../../sdk/models/meter.md) | :heavy_minus_sign:                        | N/A                                       |
+| `meterId`                                 | *string*                                  | :heavy_minus_sign:                        | N/A                                       |

package/docs/sdk/models/{meter-meter.md → meter.md}

@@ -1,11 +1,11 @@
-# MeterMeter
+# Meter
 
 ## Example Usage
 
 ```typescript
-import { MeterMeter } from "@flexprice/sdk/sdk/models";
+import { Meter } from "@flexprice/sdk/sdk/models";
 
-let value: MeterMeter = {};
+let value: Meter = {};
 ```
 
 ## Fields

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

@@ -6,10 +6,12 @@
 import { PaymentGatewayType } from "@flexprice/sdk/sdk/models";
 
 let value: PaymentGatewayType = "paddle";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
 ```
 
 ## Values
 
 ```typescript
-"stripe" | "razorpay" | "nomod" | "moyasar" | "paddle" | "whop" | "chargebee"
+"stripe" | "razorpay" | "nomod" | "moyasar" | "paddle" | "whop" | "chargebee" | Unrecognized<string>
 ```

package/docs/sdk/models/payment-method-status.md

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

package/docs/sdk/models/plan-change-schedule-details.md

@@ -0,0 +1,17 @@
+# PlanChangeScheduleDetails
+
+## Example Usage
+
+```typescript
+import { PlanChangeScheduleDetails } from "@flexprice/sdk/sdk/models";
+
+let value: PlanChangeScheduleDetails = {};
+```
+
+## Fields
+
+| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `billingPeriodBehaviour`                                                                           | [models.BillingPeriodBehaviour](../../sdk/models/billing-period-behaviour.md)                      | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
+| `entityPolicies`                                                                                   | [models.SubscriptionChangeEntityPolicies](../../sdk/models/subscription-change-entity-policies.md) | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
+| `targetPlanId`                                                                                     | *string*                                                                                           | :heavy_minus_sign:                                                                                 | N/A                                                                                                |

package/docs/sdk/models/plan-change-schedule-result.md

@@ -0,0 +1,20 @@
+# PlanChangeScheduleResult
+
+## Example Usage
+
+```typescript
+import { PlanChangeScheduleResult } from "@flexprice/sdk/sdk/models";
+
+let value: PlanChangeScheduleResult = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `changeType`                                                                                  | *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                                                                                           |
+| `fromPlanId`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `previousSubscriptionId`                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | previous_subscription_id is set when the change replaced the subscription with a new one      |
+| `subscriptionId`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `toPlanId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

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

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

package/docs/sdk/models/provider-saved-payment-methods.md

@@ -0,0 +1,17 @@
+# ProviderSavedPaymentMethods
+
+## Example Usage
+
+```typescript
+import { ProviderSavedPaymentMethods } from "@flexprice/sdk/sdk/models";
+
+let value: ProviderSavedPaymentMethods = {};
+```
+
+## Fields
+
+| Field                                                                   | Type                                                                    | Required                                                                | Description                                                             |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| `error`                                                                 | [models.ProviderError](../../sdk/models/provider-error.md)              | :heavy_minus_sign:                                                      | N/A                                                                     |
+| `items`                                                                 | [models.SavedPaymentMethod](../../sdk/models/saved-payment-method.md)[] | :heavy_minus_sign:                                                      | N/A                                                                     |
+| `provider`                                                              | [models.PaymentGatewayType](../../sdk/models/payment-gateway-type.md)   | :heavy_minus_sign:                                                      | N/A                                                                     |

package/docs/sdk/models/recurring-payment-status.md

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

package/docs/sdk/models/saved-card-details.md

@@ -0,0 +1,18 @@
+# SavedCardDetails
+
+## Example Usage
+
+```typescript
+import { SavedCardDetails } from "@flexprice/sdk/sdk/models";
+
+let value: SavedCardDetails = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `brand`            | *string*           | :heavy_minus_sign: | N/A                |
+| `expMonth`         | *number*           | :heavy_minus_sign: | N/A                |
+| `expYear`          | *number*           | :heavy_minus_sign: | N/A                |
+| `last4`            | *string*           | :heavy_minus_sign: | N/A                |