@flexprice/sdk 2.1.30 → 2.1.34

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/grain.md

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

package/docs/sdk/models/grant-allowance-state.md

@@ -0,0 +1,27 @@
+# GrantAllowanceState
+
+## Example Usage
+
+```typescript
+import { GrantAllowanceState } from "@flexprice/sdk/sdk/models";
+
+let value: GrantAllowanceState = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `entitlementId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `grantId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `isActive`                                                                                    | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `lastComputedAt`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `measure`                                                                                     | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md)               | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `quota`                                                                                       | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `quotaCrossedAt`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `remaining`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | [models.EntitlementGrantStatus](../../sdk/models/entitlement-grant-status.md)                 | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `unlimited`                                                                                   | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `usage`                                                                                       | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `validFrom`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `validTo`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/grant-state.md

@@ -0,0 +1,15 @@
+# GrantState
+
+## Example Usage
+
+```typescript
+import { GrantState } from "@flexprice/sdk/sdk/models";
+
+let value: GrantState = {};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `allowances`                                                              | [models.GrantAllowanceState](../../sdk/models/grant-allowance-state.md)[] | :heavy_minus_sign:                                                        | N/A                                                                       |

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

@@ -21,6 +21,7 @@ let value: InvoiceFilter = {};
 | `expand`                                                                                                                                                                         | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | N/A                                                                                                                                                                              |
 | `externalCustomerId`                                                                                                                                                             | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | external_customer_id filters invoices for a customer using your system's customer identifier<br/>This is the ID you provided when creating the customer in FlexPrice             |
 | `filters`                                                                                                                                                                        | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                                                                                                                 | :heavy_minus_sign:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `finalizedAtGte`                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                    | :heavy_minus_sign:                                                                                                                                                               | finalized_at_gte filters invoices finalized at or after the given instant                                                                                                        |
 | `invoiceIds`                                                                                                                                                                     | *string*[]                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                               | invoice_ids restricts results to invoices with the specified IDs<br/>Use this to retrieve specific invoices when you know their exact identifiers                                |
 | `invoiceStatus`                                                                                                                                                                  | [models.InvoiceStatus](../../sdk/models/invoice-status.md)[]                                                                                                                     | :heavy_minus_sign:                                                                                                                                                               | invoice_status filters by the current state of invoices in their lifecycle<br/>Multiple statuses can be specified to include invoices in any of the listed states                |
 | `invoiceType`                                                                                                                                                                    | [models.InvoiceType](../../sdk/models/invoice-type.md)                                                                                                                           | :heavy_minus_sign:                                                                                                                                                               | N/A                                                                                                                                                                              |
@@ -37,4 +38,5 @@ let value: InvoiceFilter = {};
 | `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                                                                                                                                                                              |
 | `subscriptionCustomerId`                                                                                                                                                         | *string*[]                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                               | subscription_customer_id filters invoices by the subscription owner's customer ID                                                                                                |
-| `subscriptionId`                                                                                                                                                                 | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | subscription_id filters invoices generated for a specific subscription<br/>Only returns invoices that were created as part of the specified subscription's billing               |
+| `subscriptionId`                                                                                                                                                                 | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | subscription_id filters invoices generated for a specific subscription<br/>Only returns invoices that were created as part of the specified subscription's billing               |
+| `voidedAtGte`                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                    | :heavy_minus_sign:                                                                                                                                                               | voided_at_gte filters invoices voided at or after the given instant                                                                                                              |

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

@@ -128,6 +128,7 @@ let value: InvoiceResponse = {
 | `billingPeriod`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | billing_period describes the billing period this invoice covers (e.g., "January 2024", "Q1 2024")                                                                                                                                 |
 | `billingReason`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | billing_reason indicates why this invoice was generated (e.g., "subscription_billing", "manual_charge")                                                                                                                           |
 | `billingSequence`                                                                                                                                                                                                                 | *number*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | billing_sequence is the sequential number indicating the billing cycle for subscription invoices                                                                                                                                  |
+| `checkoutSession`                                                                                                                                                                                                                 | [models.CheckoutSessionResponse](../../sdk/models/checkout-session-response.md)                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `couponApplications`                                                                                                                                                                                                              | [models.CouponApplicationResponse](../../sdk/models/coupon-application-response.md)[]                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                | coupon_applications contains the coupon applications associated with this invoice (overrides embedded field)                                                                                                                      |
 | `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                                                                                                                                                                                                                               |
@@ -157,6 +158,7 @@ let value: InvoiceResponse = {
 | `periodStart`                                                                                                                                                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                | period_start is the start date of the billing period covered by this invoice                                                                                                                                                      |
 | `recalculatedInvoiceId`                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | recalculated_invoice_id is the ID of the replacement invoice created when this invoice was voided and recalculated.<br/>When set, it forms a parent→child link from this (voided) invoice to the new replacement invoice.         |
 | `refundedAmount`                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | refunded_amount is the total sum of credit notes of type "refund".<br/>These are actual refunds issued to the customer.                                                                                                           |
+| `sourceType`                                                                                                                                                                                                                      | [models.InvoiceSourceType](../../sdk/models/invoice-source-type.md)                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `status`                                                                                                                                                                                                                          | [models.Status](../../sdk/models/status.md)                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `subscription`                                                                                                                                                                                                                    | [models.SubscriptionResponse](../../sdk/models/subscription-response.md)                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `subscriptionCustomerId`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | subscription_customer_id is the subscription owner's customer ID (Subscription.CustomerID).<br/>It may differ from customer_id when the subscription uses an invoicing customer. Set internally; nullable in DB.                  |

package/docs/sdk/models/invoice-source-type.md

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

package/docs/sdk/models/line-item-change.md

@@ -0,0 +1,20 @@
+# LineItemChange
+
+## Example Usage
+
+```typescript
+import { LineItemChange } from "@flexprice/sdk/sdk/models";
+
+let value: LineItemChange = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | Amount reprices the charge. Flat fee only for now.                                            |
+| `effectiveDate`                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `quantity`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/line-item-grouping.md

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

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/metric.md

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

package/docs/sdk/models/modify-subscription-line-item.md

@@ -12,6 +12,7 @@ let value: ModifySubscriptionLineItem = {};
 
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `amount`                                                                                      | *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                                                                                           |
 | `lineItemId`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `quantity`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

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

@@ -13,4 +13,5 @@ let value: ModifySubscriptionParams = {};
 | Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
 | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
 | `lineItemModifications`                                                                  | [models.ModifySubscriptionLineItem](../../sdk/models/modify-subscription-line-item.md)[] | :heavy_minus_sign:                                                                       | N/A                                                                                      |
+| `modifyType`                                                                             | [models.ModifySubscriptionType](../../sdk/models/modify-subscription-type.md)            | :heavy_minus_sign:                                                                       | N/A                                                                                      |
 | `subscriptionId`                                                                         | *string*                                                                                 | :heavy_minus_sign:                                                                       | N/A                                                                                      |

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

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

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

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

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

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

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

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

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

@@ -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/preview-subscription-modify-request.md

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