@flexprice/sdk 2.1.2 → 2.1.4

package/docs/sdk/models/changed-invoice-action.md

@@ -0,0 +1,19 @@
+# ChangedInvoiceAction
+
+created (proration invoice) | wallet_credit (downgrade credit)
+
+## Example Usage
+
+```typescript
+import { ChangedInvoiceAction } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedInvoiceAction = "created";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"created" | "wallet_credit" | Unrecognized<string>
+```

package/docs/sdk/models/changed-invoice-status.md

@@ -0,0 +1,19 @@
+# ChangedInvoiceStatus
+
+preview | issued | INITIATED | PENDING | PROCESSING | SUCCEEDED | OVERPAID | FAILED | REFUNDED | PARTIALLY_REFUNDED
+
+## Example Usage
+
+```typescript
+import { ChangedInvoiceStatus } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedInvoiceStatus = "preview";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"preview" | "issued" | Unrecognized<string>
+```

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

@@ -5,13 +5,26 @@
 ```typescript
 import { ChangedInvoice } from "@flexprice/sdk/sdk/models";
 
-let value: ChangedInvoice = {};
+let value: ChangedInvoice = {
+  invoice: {
+    subscription: {
+      latestInvoice: {
+        subscription: {
+          plan: {},
+        },
+      },
+      plan: {},
+    },
+  },
+};
 ```
 
 ## Fields
 
-| Field                       | Type                        | Required                    | Description                 |
-| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
-| `action`                    | *string*                    | :heavy_minus_sign:          | "created" \| "wallet_credit" |
-| `id`                        | *string*                    | :heavy_minus_sign:          | N/A                         |
-| `status`                    | *string*                    | :heavy_minus_sign:          | N/A                         |
+| Field                                                                                                               | Type                                                                                                                | Required                                                                                                            | Description                                                                                                         |
+| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `action`                                                                                                            | [models.ChangedInvoiceAction](../../sdk/models/changed-invoice-action.md)                                           | :heavy_minus_sign:                                                                                                  | created (proration invoice) \| wallet_credit (downgrade credit)                                                     |
+| `id`                                                                                                                | *string*                                                                                                            | :heavy_minus_sign:                                                                                                  | N/A                                                                                                                 |
+| `invoice`                                                                                                           | [models.InvoiceResponse](../../sdk/models/invoice-response.md)                                                      | :heavy_minus_sign:                                                                                                  | N/A                                                                                                                 |
+| `status`                                                                                                            | [models.ChangedInvoiceStatus](../../sdk/models/changed-invoice-status.md)                                           | :heavy_minus_sign:                                                                                                  | preview \| issued \| INITIATED \| PENDING \| PROCESSING \| SUCCEEDED \| OVERPAID \| FAILED \| REFUNDED \| PARTIALLY_REFUNDED |
+| `walletTransaction`                                                                                                 | [models.WalletTransactionResponse](../../sdk/models/wallet-transaction-response.md)                                 | :heavy_minus_sign:                                                                                                  | N/A                                                                                                                 |

package/docs/sdk/models/changed-line-item-action.md

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

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

@@ -12,7 +12,7 @@ let value: ChangedLineItem = {};
 
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `changeAction`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | "created" \| "updated" \| "ended"                                                             |
+| `changeAction`                                                                                | [models.ChangedLineItemAction](../../sdk/models/changed-line-item-action.md)                  | :heavy_minus_sign:                                                                            | created \| updated \| ended                                                                   |
 | `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `priceId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/changed-resources.md

@@ -5,7 +5,22 @@
 ```typescript
 import { ChangedResources } from "@flexprice/sdk/sdk/models";
 
-let value: ChangedResources = {};
+let value: ChangedResources = {
+  invoices: [
+    {
+      invoice: {
+        subscription: {
+          latestInvoice: {
+            subscription: {
+              plan: {},
+            },
+          },
+          plan: {},
+        },
+      },
+    },
+  ],
+};
 ```
 
 ## Fields

package/docs/sdk/models/changed-subscription-action.md

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

package/docs/sdk/models/changed-subscription.md

@@ -10,8 +10,8 @@ let value: ChangedSubscription = {};
 
 ## Fields
 
-| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
-| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
-| `action`                                                             | *string*                                                             | :heavy_minus_sign:                                                   | "created" \| "updated"                                               |
-| `id`                                                                 | *string*                                                             | :heavy_minus_sign:                                                   | N/A                                                                  |
-| `status`                                                             | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign:                                                   | N/A                                                                  |
+| Field                                                                               | Type                                                                                | Required                                                                            | Description                                                                         |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `action`                                                                            | [models.ChangedSubscriptionAction](../../sdk/models/changed-subscription-action.md) | :heavy_minus_sign:                                                                  | created \| updated                                                                  |
+| `id`                                                                                | *string*                                                                            | :heavy_minus_sign:                                                                  | N/A                                                                                 |
+| `status`                                                                            | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                | :heavy_minus_sign:                                                                  | N/A                                                                                 |

package/docs/sdk/models/clone-environment-request-request.md

@@ -0,0 +1,19 @@
+# CloneEnvironmentRequestRequest
+
+## Example Usage
+
+```typescript
+import { CloneEnvironmentRequestRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneEnvironmentRequestRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+
+## Fields
+
+| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `id`                                                                            | *string*                                                                        | :heavy_check_mark:                                                              | Source Environment ID                                                           |
+| `body`                                                                          | [models.CloneEnvironmentRequest](../../sdk/models/clone-environment-request.md) | :heavy_check_mark:                                                              | Clone configuration                                                             |

package/docs/sdk/models/clone-environment-request.md

@@ -0,0 +1,17 @@
+# CloneEnvironmentRequest
+
+## Example Usage
+
+```typescript
+import { CloneEnvironmentRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneEnvironmentRequest = {};
+```
+
+## Fields
+
+| Field                                                                                                                                                                  | Type                                                                                                                                                                   | Required                                                                                                                                                               | Description                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`                                                                                                                                                                 | *string*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | Name of the new environment (required when target_environment_id is not provided)                                                                                      |
+| `targetEnvironmentId`                                                                                                                                                  | *string*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | TargetEnvironmentID is the ID of an existing environment to clone into (optional).<br/>When provided, Name and Type are ignored. When omitted, Name and Type are required. |
+| `type`                                                                                                                                                                 | [models.EnvironmentType](../../sdk/models/environment-type.md)                                                                                                         | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |

package/docs/sdk/models/clone-feature-request-request.md

@@ -0,0 +1,19 @@
+# CloneFeatureRequestRequest
+
+## Example Usage
+
+```typescript
+import { CloneFeatureRequestRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneFeatureRequestRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+
+## Fields
+
+| Field                                                                   | Type                                                                    | Required                                                                | Description                                                             |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| `id`                                                                    | *string*                                                                | :heavy_check_mark:                                                      | Source Feature ID                                                       |
+| `body`                                                                  | [models.CloneFeatureRequest](../../sdk/models/clone-feature-request.md) | :heavy_check_mark:                                                      | Clone configuration                                                     |

package/docs/sdk/models/clone-feature-request.md

@@ -0,0 +1,18 @@
+# CloneFeatureRequest
+
+## Example Usage
+
+```typescript
+import { CloneFeatureRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneFeatureRequest = {};
+```
+
+## Fields
+
+| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `description`                                                         | *string*                                                              | :heavy_minus_sign:                                                    | Description overrides the source feature's description when provided  |
+| `lookupKey`                                                           | *string*                                                              | :heavy_minus_sign:                                                    | LookupKey is required and must be unique across published features    |
+| `metadata`                                                            | Record<string, *string*>                                              | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `name`                                                                | *string*                                                              | :heavy_minus_sign:                                                    | Name is required and must be different from the source feature's name |

package/docs/sdk/models/{post-plans-id-clone-request.md → clone-plan-request-request.md}

@@ -1,11 +1,11 @@
-# PostPlansIdCloneRequest
+# ClonePlanRequestRequest
 
 ## Example Usage
 
 ```typescript
-import { PostPlansIdCloneRequest } from "@flexprice/sdk/sdk/models";
+import { ClonePlanRequestRequest } from "@flexprice/sdk/sdk/models";
 
-let value: PostPlansIdCloneRequest = {
+let value: ClonePlanRequestRequest = {
   id: "<id>",
   body: {},
 };

package/docs/sdk/models/create-subscription-request.md

@@ -14,40 +14,41 @@ let value: CreateSubscriptionRequest = {
 
 ## Fields
 
-| Field                                                                                                                                             | Type                                                                                                                                              | Required                                                                                                                                          | Description                                                                                                                                       |
-| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `addons`                                                                                                                                          | [models.AddAddonToSubscriptionRequest](../../sdk/models/add-addon-to-subscription-request.md)[]                                                   | :heavy_minus_sign:                                                                                                                                | Addons represents addons to be added to the subscription during creation                                                                          |
-| `billingCycle`                                                                                                                                    | [models.BillingCycle](../../sdk/models/billing-cycle.md)                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `billingPeriod`                                                                                                                                   | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                        | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               |
-| `billingPeriodCount`                                                                                                                              | *number*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `collectionMethod`                                                                                                                                | [models.CollectionMethod](../../sdk/models/collection-method.md)                                                                                  | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `commitmentAmount`                                                                                                                                | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | CommitmentAmount is the minimum amount a customer commits to paying for a billing period                                                          |
-| `commitmentDuration`                                                                                                                              | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                        | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `coupons`                                                                                                                                         | *string*[]                                                                                                                                        | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `creditGrants`                                                                                                                                    | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[]                                                              | :heavy_minus_sign:                                                                                                                                | Credit grants to be applied when subscription is created                                                                                          |
-| `currency`                                                                                                                                        | *string*                                                                                                                                          | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               |
-| `customerId`                                                                                                                                      | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | customer_id is the flexprice customer id<br/>and it is prioritized over external_customer_id in case both are provided.                           |
-| `customerTimezone`                                                                                                                                | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | Timezone of the customer.<br/>If not set, the default value is UTC.                                                                               |
-| `enableTrueUp`                                                                                                                                    | *boolean*                                                                                                                                         | :heavy_minus_sign:                                                                                                                                | Enable Commitment True Up Fee                                                                                                                     |
-| `endDate`                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                     | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `externalCustomerId`                                                                                                                              | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | external_customer_id is the customer id in your DB<br/>and must be same as what you provided as external_id while creating the customer in flexprice. |
-| `gatewayPaymentMethodId`                                                                                                                          | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `inheritance`                                                                                                                                     | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md)                                                       | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `lineItemCommitments`                                                                                                                             | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)>                                                | :heavy_minus_sign:                                                                                                                                | LineItemCommitments allows setting commitment configuration per line item (keyed by price_id)                                                     |
-| `lineItemCoupons`                                                                                                                                 | Record<string, *string*[]>                                                                                                                        | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `lineItems`                                                                                                                                       | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[]                                           | :heavy_minus_sign:                                                                                                                                | LineItems are extra line items to add at creation (each with price_id or price), in addition to plan prices                                       |
-| `lookupKey`                                                                                                                                       | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `metadata`                                                                                                                                        | Record<string, *string*>                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `overageFactor`                                                                                                                                   | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | OverageFactor is a multiplier applied to usage beyond the commitment amount                                                                       |
-| `overrideEntitlements`                                                                                                                            | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[]                                                           | :heavy_minus_sign:                                                                                                                                | OverrideEntitlements allows customizing specific entitlements for this subscription                                                               |
-| `overrideLineItems`                                                                                                                               | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                | :heavy_minus_sign:                                                                                                                                | OverrideLineItems allows customizing specific prices for this subscription                                                                        |
-| `paymentBehavior`                                                                                                                                 | [models.PaymentBehavior](../../sdk/models/payment-behavior.md)                                                                                    | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `paymentTerms`                                                                                                                                    | [models.PaymentTerms](../../sdk/models/payment-terms.md)                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `phases`                                                                                                                                          | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[]                                                  | :heavy_minus_sign:                                                                                                                                | Phases represents subscription phases to be created with the subscription                                                                         |
-| `planId`                                                                                                                                          | *string*                                                                                                                                          | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               |
-| `prorationBehavior`                                                                                                                               | [models.ProrationBehavior](../../sdk/models/proration-behavior.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                                                                                                                                               |
-| `subscriptionStatus`                                                                                                                              | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                                                                              | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `taxRateOverrides`                                                                                                                                | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                                 | :heavy_minus_sign:                                                                                                                                | tax_rate_overrides is the tax rate overrides	to be applied to the subscription                                                                    |
-| `trialEnd`                                                                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                     | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `trialStart`                                                                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                     | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
+| Field                                                                                                                                                                                                                                                                                                                                                                            | Type                                                                                                                                                                                                                                                                                                                                                                             | Required                                                                                                                                                                                                                                                                                                                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                      |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `addons`                                                                                                                                                                                                                                                                                                                                                                         | [models.AddAddonToSubscriptionRequest](../../sdk/models/add-addon-to-subscription-request.md)[]                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | Addons represents addons to be added to the subscription during creation                                                                                                                                                                                                                                                                                                         |
+| `billingAnchor`                                                                                                                                                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | BillingAnchor overrides the derived billing anchor when billing_cycle is anniversary.<br/>For monthly billing, the day-of-month (and time-of-day) define cycle boundaries: if start_date<br/>is before that day in the month, the first billing period ends on the next occurrence of that<br/>day in the same month (a shorter first period); subsequent periods follow the usual interval. |
+| `billingCycle`                                                                                                                                                                                                                                                                                                                                                                   | [models.BillingCycle](../../sdk/models/billing-cycle.md)                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `billingPeriod`                                                                                                                                                                                                                                                                                                                                                                  | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `billingPeriodCount`                                                                                                                                                                                                                                                                                                                                                             | *number*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `collectionMethod`                                                                                                                                                                                                                                                                                                                                                               | [models.CollectionMethod](../../sdk/models/collection-method.md)                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `commitmentAmount`                                                                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | CommitmentAmount is the minimum amount a customer commits to paying for a billing period                                                                                                                                                                                                                                                                                         |
+| `commitmentDuration`                                                                                                                                                                                                                                                                                                                                                             | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `coupons`                                                                                                                                                                                                                                                                                                                                                                        | *string*[]                                                                                                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `creditGrants`                                                                                                                                                                                                                                                                                                                                                                   | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[]                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | Credit grants to be applied when subscription is created                                                                                                                                                                                                                                                                                                                         |
+| `currency`                                                                                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `customerId`                                                                                                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | customer_id is the flexprice customer id<br/>and it is prioritized over external_customer_id in case both are provided.                                                                                                                                                                                                                                                          |
+| `customerTimezone`                                                                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | Timezone of the customer.<br/>If not set, the default value is UTC.                                                                                                                                                                                                                                                                                                              |
+| `enableTrueUp`                                                                                                                                                                                                                                                                                                                                                                   | *boolean*                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | Enable Commitment True Up Fee                                                                                                                                                                                                                                                                                                                                                    |
+| `endDate`                                                                                                                                                                                                                                                                                                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `externalCustomerId`                                                                                                                                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | external_customer_id is the customer id in your DB<br/>and must be same as what you provided as external_id while creating the customer in flexprice.                                                                                                                                                                                                                            |
+| `gatewayPaymentMethodId`                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `inheritance`                                                                                                                                                                                                                                                                                                                                                                    | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md)                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `lineItemCommitments`                                                                                                                                                                                                                                                                                                                                                            | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)>                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | LineItemCommitments allows setting commitment configuration per line item (keyed by price_id)                                                                                                                                                                                                                                                                                    |
+| `lineItemCoupons`                                                                                                                                                                                                                                                                                                                                                                | Record<string, *string*[]>                                                                                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `lineItems`                                                                                                                                                                                                                                                                                                                                                                      | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[]                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | LineItems are extra line items to add at creation (each with price_id or price), in addition to plan prices                                                                                                                                                                                                                                                                      |
+| `lookupKey`                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `metadata`                                                                                                                                                                                                                                                                                                                                                                       | Record<string, *string*>                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `overageFactor`                                                                                                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | OverageFactor is a multiplier applied to usage beyond the commitment amount                                                                                                                                                                                                                                                                                                      |
+| `overrideEntitlements`                                                                                                                                                                                                                                                                                                                                                           | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[]                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | OverrideEntitlements allows customizing specific entitlements for this subscription                                                                                                                                                                                                                                                                                              |
+| `overrideLineItems`                                                                                                                                                                                                                                                                                                                                                              | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | OverrideLineItems allows customizing specific prices for this subscription                                                                                                                                                                                                                                                                                                       |
+| `paymentBehavior`                                                                                                                                                                                                                                                                                                                                                                | [models.PaymentBehavior](../../sdk/models/payment-behavior.md)                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `paymentTerms`                                                                                                                                                                                                                                                                                                                                                                   | [models.PaymentTerms](../../sdk/models/payment-terms.md)                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `phases`                                                                                                                                                                                                                                                                                                                                                                         | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[]                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | Phases represents subscription phases to be created with the subscription                                                                                                                                                                                                                                                                                                        |
+| `planId`                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `prorationBehavior`                                                                                                                                                                                                                                                                                                                                                              | [models.ProrationBehavior](../../sdk/models/proration-behavior.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                                                                                                                                                                                                                                                                                                                                                                              |
+| `subscriptionStatus`                                                                                                                                                                                                                                                                                                                                                             | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `taxRateOverrides`                                                                                                                                                                                                                                                                                                                                                               | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | tax_rate_overrides is the tax rate overrides	to be applied to the subscription                                                                                                                                                                                                                                                                                                   |
+| `trialEnd`                                                                                                                                                                                                                                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |
+| `trialStart`                                                                                                                                                                                                                                                                                                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                                                                                                              |

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

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

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

@@ -6,6 +6,22 @@
 import { SubscriptionModifyResponse } from "@flexprice/sdk/sdk/models";
 
 let value: SubscriptionModifyResponse = {
+  changedResources: {
+    invoices: [
+      {
+        invoice: {
+          subscription: {
+            latestInvoice: {
+              subscription: {
+                plan: {},
+              },
+            },
+            plan: {},
+          },
+        },
+      },
+    ],
+  },
   subscription: {
     latestInvoice: {
       subscription: {