@flexprice/sdk 2.1.1 → 2.1.2

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

@@ -12,11 +12,12 @@ let value: SubscriptionPhaseCreateRequest = {
 
 ## Fields
 
-| Field                                                                                                                                                     | Type                                                                                                                                                      | Required                                                                                                                                                  | Description                                                                                                                                               |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `coupons`                                                                                                                                                 | *string*[]                                                                                                                                                | :heavy_minus_sign:                                                                                                                                        | Coupons represents subscription-level coupons to be applied to this phase                                                                                 |
-| `endDate`                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                             | :heavy_minus_sign:                                                                                                                                        | N/A                                                                                                                                                       |
-| `lineItemCoupons`                                                                                                                                         | Record<string, *string*[]>                                                                                                                                | :heavy_minus_sign:                                                                                                                                        | LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)                                                                    |
-| `metadata`                                                                                                                                                | Record<string, *string*>                                                                                                                                  | :heavy_minus_sign:                                                                                                                                        | N/A                                                                                                                                                       |
-| `overrideLineItems`                                                                                                                                       | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                        | :heavy_minus_sign:                                                                                                                                        | OverrideLineItems allows customizing specific prices for this phase<br/>If not provided, phase will use the same line items as the subscription (plan prices) |
-| `startDate`                                                                                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                             | :heavy_check_mark:                                                                                                                                        | N/A                                                                                                                                                       |
+| Field                                                                                                                                                             | Type                                                                                                                                                              | Required                                                                                                                                                          | Description                                                                                                                                                       |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `coupons`                                                                                                                                                         | *string*[]                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | Coupons represents subscription-level coupons to be applied to this phase                                                                                         |
+| `endDate`                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
+| `lineItemCoupons`                                                                                                                                                 | Record<string, *string*[]>                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)                                                                            |
+| `lineItems`                                                                                                                                                       | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[]                                                           | :heavy_minus_sign:                                                                                                                                                | LineItems are extra line items to add during this phase, primarily one-time charges.<br/>Each item's start_date defaults to the phase's start_date when not provided. |
+| `metadata`                                                                                                                                                        | Record<string, *string*>                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
+| `overrideLineItems`                                                                                                                                               | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                                | :heavy_minus_sign:                                                                                                                                                | OverrideLineItems allows customizing specific prices for this phase<br/>If not provided, phase will use the same line items as the subscription (plan prices)     |
+| `startDate`                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_check_mark:                                                                                                                                                | N/A                                                                                                                                                               |

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

@@ -6,10 +6,9 @@
 import { SubscriptionPriceCreateRequest } from "@flexprice/sdk/sdk/models";
 
 let value: SubscriptionPriceCreateRequest = {
-  billingCadence: "ONETIME",
-  billingModel: "FLAT_FEE",
-  billingPeriod: "MONTHLY",
-  invoiceCadence: "ADVANCE",
+  billingModel: "PACKAGE",
+  billingPeriod: "ANNUAL",
+  invoiceCadence: "ARREAR",
   priceUnitType: "CUSTOM",
   type: "FIXED",
 };
@@ -20,7 +19,6 @@ let value: SubscriptionPriceCreateRequest = {
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
 | `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `billingCadence`                                                                              | [models.BillingCadence](../../sdk/models/billing-cadence.md)                                  | :heavy_check_mark:                                                                            | N/A                                                                                           |
 | `billingModel`                                                                                | [models.BillingModel](../../sdk/models/billing-model.md)                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
 | `billingPeriod`                                                                               | [models.BillingPeriod](../../sdk/models/billing-period.md)                                    | :heavy_check_mark:                                                                            | N/A                                                                                           |
 | `billingPeriodCount`                                                                          | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/window-size.md

@@ -5,7 +5,7 @@
 ```typescript
 import { WindowSize } from "@flexprice/sdk/sdk/models";
 
-let value: WindowSize = "6HOUR";
+let value: WindowSize = "12HOUR";
 
 // Open enum: unrecognized values are captured as Unrecognized<string>
 ```
@@ -13,5 +13,5 @@ let value: WindowSize = "6HOUR";
 ## Values
 
 ```typescript
-"MONTH" | "MINUTE" | "15MIN" | "30MIN" | "HOUR" | "3HOUR" | "6HOUR" | "12HOUR" | "DAY" | "WEEK" | Unrecognized<string>
+"MINUTE" | "15MIN" | "30MIN" | "HOUR" | "3HOUR" | "6HOUR" | "12HOUR" | "DAY" | "WEEK" | "MONTH" | Unrecognized<string>
 ```

package/docs/sdks/invoices/README.md

@@ -6,6 +6,7 @@
 
 * [getCustomerInvoiceSummary](#getcustomerinvoicesummary) - Get customer invoice summary
 * [createInvoice](#createinvoice) - Create one-off invoice
+* [getMeterUsagePreviewInvoice](#getmeterusagepreviewinvoice) - Get invoice preview using meter_usage data
 * [getInvoicePreview](#getinvoicepreview) - Get invoice preview
 * [queryInvoice](#queryinvoice) - Query invoices
 * [getInvoice](#getinvoice) - Get invoice
@@ -173,6 +174,81 @@ run();
 | models.ErrorsErrorResponse | 500                        | application/json           |
 | models.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
+## getMeterUsagePreviewInvoice
+
+Preview invoice using the meter_usage table for usage data instead of feature_usage.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getMeterUsagePreviewInvoice" method="post" path="/invoices/meter-usage-preview" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.invoices.getMeterUsagePreviewInvoice({
+    subscriptionId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { invoicesGetMeterUsagePreviewInvoice } from "@flexprice/sdk/funcs/invoices-get-meter-usage-preview-invoice.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await invoicesGetMeterUsagePreviewInvoice(flexprice, {
+    subscriptionId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("invoicesGetMeterUsagePreviewInvoice failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.GetPreviewInvoiceRequest](../../sdk/models/get-preview-invoice-request.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
 ## getInvoicePreview
 
 Use when showing a customer what they will be charged (e.g. preview before checkout or plan change). No invoice is created.

package/docs/sdks/meterusage/README.md

@@ -0,0 +1,182 @@
+# MeterUsage
+
+## Overview
+
+### Available Operations
+
+* [getMeterUsageAnalytics](#getmeterusageanalytics) - Get meter usage analytics
+* [queryMeterUsage](#querymeterusage) - Query meter usage
+
+## getMeterUsageAnalytics
+
+Query aggregated usage from meter_usage table for multiple meters
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getMeterUsageAnalytics" method="post" path="/meter-usage/analytics" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.meterUsage.getMeterUsageAnalytics({
+    aggregationType: "COUNT",
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterIds: [
+      "mtr_abc",
+      "mtr_def",
+    ],
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { meterUsageGetMeterUsageAnalytics } from "@flexprice/sdk/funcs/meter-usage-get-meter-usage-analytics.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await meterUsageGetMeterUsageAnalytics(flexprice, {
+    aggregationType: "COUNT",
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterIds: [
+      "mtr_abc",
+      "mtr_def",
+    ],
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("meterUsageGetMeterUsageAnalytics failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.MeterUsageAnalyticsRequest](../../sdk/models/meter-usage-analytics-request.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.MeterUsageAnalyticsResponse](../../sdk/models/meter-usage-analytics-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## queryMeterUsage
+
+Query aggregated usage from meter_usage table for a single meter with optional time-window bucketing
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="queryMeterUsage" method="post" path="/meter-usage/query" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.meterUsage.queryMeterUsage({
+    aggregationType: "WEIGHTED_SUM",
+    billingAnchor: new Date("2024-01-15T00:00:00Z"),
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterId: "mtr_abc",
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { meterUsageQueryMeterUsage } from "@flexprice/sdk/funcs/meter-usage-query-meter-usage.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await meterUsageQueryMeterUsage(flexprice, {
+    aggregationType: "WEIGHTED_SUM",
+    billingAnchor: new Date("2024-01-15T00:00:00Z"),
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterId: "mtr_abc",
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("meterUsageQueryMeterUsage failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.MeterUsageQueryRequest](../../sdk/models/meter-usage-query-request.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.MeterUsageQueryResponse](../../sdk/models/meter-usage-query-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/prices/README.md

@@ -28,15 +28,14 @@ const flexprice = new Flexprice({
 
 async function run() {
   const result = await flexprice.prices.createPrice({
-    billingCadence: "RECURRING",
-    billingModel: "PACKAGE",
-    billingPeriod: "HALF_YEARLY",
-    currency: "Serbian Dinar",
+    billingModel: "FLAT_FEE",
+    billingPeriod: "DAILY",
+    currency: "Dong",
     entityId: "<id>",
     entityType: "PRICE",
-    invoiceCadence: "ARREAR",
-    priceUnitType: "CUSTOM",
-    type: "USAGE",
+    invoiceCadence: "ADVANCE",
+    priceUnitType: "FIAT",
+    type: "FIXED",
   });
 
   console.log(result);
@@ -61,15 +60,14 @@ const flexprice = new FlexpriceCore({
 
 async function run() {
   const res = await pricesCreatePrice(flexprice, {
-    billingCadence: "RECURRING",
-    billingModel: "PACKAGE",
-    billingPeriod: "HALF_YEARLY",
-    currency: "Serbian Dinar",
+    billingModel: "FLAT_FEE",
+    billingPeriod: "DAILY",
+    currency: "Dong",
     entityId: "<id>",
     entityType: "PRICE",
-    invoiceCadence: "ARREAR",
-    priceUnitType: "CUSTOM",
-    type: "USAGE",
+    invoiceCadence: "ADVANCE",
+    priceUnitType: "FIAT",
+    type: "FIXED",
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/subscriptions/README.md

@@ -21,7 +21,8 @@
 * [getSubscriptionEntitlements](#getsubscriptionentitlements) - Get subscription entitlements
 * [getSubscriptionUpcomingGrants](#getsubscriptionupcominggrants) - Get upcoming credit grant applications
 * [createSubscriptionLineItem](#createsubscriptionlineitem) - Create subscription line item
-* [executeSubscriptionModify](#executesubscriptionmodify) - Add customers to subscription inheritance
+* [executeSubscriptionModify](#executesubscriptionmodify) - Execute subscription modification
+* [previewSubscriptionModify](#previewsubscriptionmodify) - Preview subscription modification
 * [pauseSubscription](#pausesubscription) - Pause a subscription
 * [listSubscriptionPauses](#listsubscriptionpauses) - List all pauses for a subscription
 * [resumeSubscription](#resumesubscription) - Resume a paused subscription
@@ -47,9 +48,8 @@ const flexprice = new Flexprice({
 
 async function run() {
   const result = await flexprice.subscriptions.createSubscription({
-    billingCadence: "ONETIME",
-    billingPeriod: "DAILY",
-    currency: "New Leu",
+    billingPeriod: "ONETIME",
+    currency: "Kwacha",
     planId: "<id>",
   });
 
@@ -75,9 +75,8 @@ const flexprice = new FlexpriceCore({
 
 async function run() {
   const res = await subscriptionsCreateSubscription(flexprice, {
-    billingCadence: "ONETIME",
-    billingPeriod: "DAILY",
-    currency: "New Leu",
+    billingPeriod: "ONETIME",
+    currency: "Kwacha",
     planId: "<id>",
   });
   if (res.ok) {
@@ -944,8 +943,8 @@ async function run() {
   const result = await flexprice.subscriptions.executeSubscriptionChange("<id>", {
     billingCadence: "RECURRING",
     billingCycle: "anniversary",
-    billingPeriod: "QUARTERLY",
-    prorationBehavior: "create_prorations",
+    billingPeriod: "ANNUAL",
+    prorationBehavior: "none",
     targetPlanId: "<id>",
   });
 
@@ -973,8 +972,8 @@ async function run() {
   const res = await subscriptionsExecuteSubscriptionChange(flexprice, "<id>", {
     billingCadence: "RECURRING",
     billingCycle: "anniversary",
-    billingPeriod: "QUARTERLY",
-    prorationBehavior: "create_prorations",
+    billingPeriod: "ANNUAL",
+    prorationBehavior: "none",
     targetPlanId: "<id>",
   });
   if (res.ok) {
@@ -1027,9 +1026,9 @@ const flexprice = new Flexprice({
 async function run() {
   const result = await flexprice.subscriptions.previewSubscriptionChange("<id>", {
     billingCadence: "RECURRING",
-    billingCycle: "calendar",
-    billingPeriod: "HALF_YEARLY",
-    prorationBehavior: "create_prorations",
+    billingCycle: "anniversary",
+    billingPeriod: "ONETIME",
+    prorationBehavior: "none",
     targetPlanId: "<id>",
   });
 
@@ -1056,9 +1055,9 @@ const flexprice = new FlexpriceCore({
 async function run() {
   const res = await subscriptionsPreviewSubscriptionChange(flexprice, "<id>", {
     billingCadence: "RECURRING",
-    billingCycle: "calendar",
-    billingPeriod: "HALF_YEARLY",
-    prorationBehavior: "create_prorations",
+    billingCycle: "anniversary",
+    billingPeriod: "ONETIME",
+    prorationBehavior: "none",
     targetPlanId: "<id>",
   });
   if (res.ok) {
@@ -1311,7 +1310,7 @@ run();
 
 ## executeSubscriptionModify
 
-Attach additional child customers (by external ID) to an active standalone or parent subscription; creates inherited skeleton subscriptions for each. The subscription must be active.
+Execute a mid-cycle subscription modification (inheritance or quantity change).
 
 ### Example Usage
 
@@ -1324,7 +1323,9 @@ const flexprice = new Flexprice({
 });
 
 async function run() {
-  const result = await flexprice.subscriptions.executeSubscriptionModify("<id>", {});
+  const result = await flexprice.subscriptions.executeSubscriptionModify("<id>", {
+    type: "inheritance",
+  });
 
   console.log(result);
 }
@@ -1347,7 +1348,9 @@ const flexprice = new FlexpriceCore({
 });
 
 async function run() {
-  const res = await subscriptionsExecuteSubscriptionModify(flexprice, "<id>", {});
+  const res = await subscriptionsExecuteSubscriptionModify(flexprice, "<id>", {
+    type: "inheritance",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -1364,14 +1367,90 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Subscription ID                                                                                                                                                                |
-| `body`                                                                                                                                                                         | [models.ExecuteSubscriptionInheritanceRequest](../../sdk/models/execute-subscription-inheritance-request.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | External customer IDs to inherit                                                                                                                                               |
+| `body`                                                                                                                                                                         | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | Modification request                                                                                                                                                           |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[models.SubscriptionResponse](../../sdk/models/subscription-response.md)\>**
+**Promise\<[models.SubscriptionModifyResponse](../../sdk/models/subscription-modify-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 404                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## previewSubscriptionModify
+
+Preview the impact of a mid-cycle subscription modification without committing changes.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="previewSubscriptionModify" method="post" path="/subscriptions/{id}/modify/preview" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.subscriptions.previewSubscriptionModify("<id>", {
+    type: "quantity_change",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { subscriptionsPreviewSubscriptionModify } from "@flexprice/sdk/funcs/subscriptions-preview-subscription-modify.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await subscriptionsPreviewSubscriptionModify(flexprice, "<id>", {
+    type: "quantity_change",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscriptionsPreviewSubscriptionModify failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Subscription ID                                                                                                                                                                |
+| `body`                                                                                                                                                                         | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | Modification preview request                                                                                                                                                   |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.SubscriptionModifyResponse](../../sdk/models/subscription-modify-response.md)\>**
 
 ### Errors