@flexprice/sdk 2.1.1 → 2.1.2

package/src/sdk/models/meter-usage-analytics-request.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  AggregationType,
+  AggregationType$outboundSchema,
+} from "./aggregation-type.js";
+import { WindowSize, WindowSize$outboundSchema } from "./window-size.js";
+
+export type MeterUsageAnalyticsRequest = {
+  aggregationType: AggregationType;
+  billingAnchor?: Date | undefined;
+  endTime: Date;
+  externalCustomerId: string;
+  meterIds: Array<string>;
+  startTime: Date;
+  windowSize?: WindowSize | undefined;
+};
+
+/** @internal */
+export type MeterUsageAnalyticsRequest$Outbound = {
+  aggregation_type: string;
+  billing_anchor?: string | undefined;
+  end_time: string;
+  external_customer_id: string;
+  meter_ids: Array<string>;
+  start_time: string;
+  window_size?: string | undefined;
+};
+
+/** @internal */
+export const MeterUsageAnalyticsRequest$outboundSchema: z.ZodMiniType<
+  MeterUsageAnalyticsRequest$Outbound,
+  MeterUsageAnalyticsRequest
+> = z.pipe(
+  z.object({
+    aggregationType: AggregationType$outboundSchema,
+    billingAnchor: z.optional(
+      z.pipe(z.date(), z.transform(v => v.toISOString())),
+    ),
+    endTime: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    externalCustomerId: z.string(),
+    meterIds: z.array(z.string()),
+    startTime: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    windowSize: z.optional(WindowSize$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      aggregationType: "aggregation_type",
+      billingAnchor: "billing_anchor",
+      endTime: "end_time",
+      externalCustomerId: "external_customer_id",
+      meterIds: "meter_ids",
+      startTime: "start_time",
+      windowSize: "window_size",
+    });
+  }),
+);
+
+export function meterUsageAnalyticsRequestToJSON(
+  meterUsageAnalyticsRequest: MeterUsageAnalyticsRequest,
+): string {
+  return JSON.stringify(
+    MeterUsageAnalyticsRequest$outboundSchema.parse(meterUsageAnalyticsRequest),
+  );
+}

package/src/sdk/models/meter-usage-analytics-response.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  MeterUsageQueryResponse,
+  MeterUsageQueryResponse$inboundSchema,
+} from "./meter-usage-query-response.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type MeterUsageAnalyticsResponse = {
+  items?: Array<MeterUsageQueryResponse> | undefined;
+};
+
+/** @internal */
+export const MeterUsageAnalyticsResponse$inboundSchema: z.ZodMiniType<
+  MeterUsageAnalyticsResponse,
+  unknown
+> = z.object({
+  items: types.optional(z.array(MeterUsageQueryResponse$inboundSchema)),
+});
+
+export function meterUsageAnalyticsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MeterUsageAnalyticsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MeterUsageAnalyticsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MeterUsageAnalyticsResponse' from JSON`,
+  );
+}

package/src/sdk/models/meter-usage-point.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type MeterUsagePoint = {
+  eventCount?: number | undefined;
+  timestamp?: string | undefined;
+  value?: string | undefined;
+};
+
+/** @internal */
+export const MeterUsagePoint$inboundSchema: z.ZodMiniType<
+  MeterUsagePoint,
+  unknown
+> = z.pipe(
+  z.object({
+    event_count: types.optional(types.number()),
+    timestamp: types.optional(types.string()),
+    value: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "event_count": "eventCount",
+    });
+  }),
+);
+
+export function meterUsagePointFromJSON(
+  jsonString: string,
+): SafeParseResult<MeterUsagePoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MeterUsagePoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MeterUsagePoint' from JSON`,
+  );
+}

package/src/sdk/models/meter-usage-query-request.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  AggregationType,
+  AggregationType$outboundSchema,
+} from "./aggregation-type.js";
+import { WindowSize, WindowSize$outboundSchema } from "./window-size.js";
+
+export type MeterUsageQueryRequest = {
+  aggregationType: AggregationType;
+  billingAnchor?: Date | undefined;
+  endTime: Date;
+  externalCustomerId: string;
+  meterId: string;
+  startTime: Date;
+  windowSize?: WindowSize | undefined;
+};
+
+/** @internal */
+export type MeterUsageQueryRequest$Outbound = {
+  aggregation_type: string;
+  billing_anchor?: string | undefined;
+  end_time: string;
+  external_customer_id: string;
+  meter_id: string;
+  start_time: string;
+  window_size?: string | undefined;
+};
+
+/** @internal */
+export const MeterUsageQueryRequest$outboundSchema: z.ZodMiniType<
+  MeterUsageQueryRequest$Outbound,
+  MeterUsageQueryRequest
+> = z.pipe(
+  z.object({
+    aggregationType: AggregationType$outboundSchema,
+    billingAnchor: z.optional(
+      z.pipe(z.date(), z.transform(v => v.toISOString())),
+    ),
+    endTime: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    externalCustomerId: z.string(),
+    meterId: z.string(),
+    startTime: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    windowSize: z.optional(WindowSize$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      aggregationType: "aggregation_type",
+      billingAnchor: "billing_anchor",
+      endTime: "end_time",
+      externalCustomerId: "external_customer_id",
+      meterId: "meter_id",
+      startTime: "start_time",
+      windowSize: "window_size",
+    });
+  }),
+);
+
+export function meterUsageQueryRequestToJSON(
+  meterUsageQueryRequest: MeterUsageQueryRequest,
+): string {
+  return JSON.stringify(
+    MeterUsageQueryRequest$outboundSchema.parse(meterUsageQueryRequest),
+  );
+}

package/src/sdk/models/meter-usage-query-response.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  AggregationType,
+  AggregationType$inboundSchema,
+} from "./aggregation-type.js";
+import {
+  MeterUsagePoint,
+  MeterUsagePoint$inboundSchema,
+} from "./meter-usage-point.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type MeterUsageQueryResponse = {
+  aggregationType?: AggregationType | undefined;
+  eventCount?: number | undefined;
+  meterId?: string | undefined;
+  points?: Array<MeterUsagePoint> | undefined;
+  totalValue?: string | undefined;
+};
+
+/** @internal */
+export const MeterUsageQueryResponse$inboundSchema: z.ZodMiniType<
+  MeterUsageQueryResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    aggregation_type: types.optional(AggregationType$inboundSchema),
+    event_count: types.optional(types.number()),
+    meter_id: types.optional(types.string()),
+    points: types.optional(z.array(MeterUsagePoint$inboundSchema)),
+    total_value: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "aggregation_type": "aggregationType",
+      "event_count": "eventCount",
+      "meter_id": "meterId",
+      "total_value": "totalValue",
+    });
+  }),
+);
+
+export function meterUsageQueryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MeterUsageQueryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MeterUsageQueryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MeterUsageQueryResponse' from JSON`,
+  );
+}

package/src/sdk/models/preview-subscription-modify-op.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  ExecuteSubscriptionModifyRequest,
+  ExecuteSubscriptionModifyRequest$Outbound,
+  ExecuteSubscriptionModifyRequest$outboundSchema,
+} from "./execute-subscription-modify-request.js";
+
+export type PreviewSubscriptionModifyRequest = {
+  /**
+   * Subscription ID
+   */
+  id: string;
+  /**
+   * Modification preview request
+   */
+  body: ExecuteSubscriptionModifyRequest;
+};
+
+/** @internal */
+export type PreviewSubscriptionModifyRequest$Outbound = {
+  id: string;
+  body: ExecuteSubscriptionModifyRequest$Outbound;
+};
+
+/** @internal */
+export const PreviewSubscriptionModifyRequest$outboundSchema: z.ZodMiniType<
+  PreviewSubscriptionModifyRequest$Outbound,
+  PreviewSubscriptionModifyRequest
+> = z.object({
+  id: z.string(),
+  body: ExecuteSubscriptionModifyRequest$outboundSchema,
+});
+
+export function previewSubscriptionModifyRequestToJSON(
+  previewSubscriptionModifyRequest: PreviewSubscriptionModifyRequest,
+): string {
+  return JSON.stringify(
+    PreviewSubscriptionModifyRequest$outboundSchema.parse(
+      previewSubscriptionModifyRequest,
+    ),
+  );
+}

package/src/sdk/models/secret-provider.ts

@@ -14,6 +14,7 @@ export const SecretProvider = {
   Razorpay: "razorpay",
   Chargebee: "chargebee",
   Quickbooks: "quickbooks",
+  ZohoBooks: "zoho_books",
   Nomod: "nomod",
   Moyasar: "moyasar",
   Paddle: "paddle",

package/src/sdk/models/sub-modify-inheritance-request.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type SubModifyInheritanceRequest = {
+  externalCustomerIdsToInheritSubscription?: Array<string> | undefined;
+};
+
+/** @internal */
+export type SubModifyInheritanceRequest$Outbound = {
+  external_customer_ids_to_inherit_subscription?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SubModifyInheritanceRequest$outboundSchema: z.ZodMiniType<
+  SubModifyInheritanceRequest$Outbound,
+  SubModifyInheritanceRequest
+> = z.pipe(
+  z.object({
+    externalCustomerIdsToInheritSubscription: z.optional(z.array(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      externalCustomerIdsToInheritSubscription:
+        "external_customer_ids_to_inherit_subscription",
+    });
+  }),
+);
+
+export function subModifyInheritanceRequestToJSON(
+  subModifyInheritanceRequest: SubModifyInheritanceRequest,
+): string {
+  return JSON.stringify(
+    SubModifyInheritanceRequest$outboundSchema.parse(
+      subModifyInheritanceRequest,
+    ),
+  );
+}

package/src/sdk/models/sub-modify-quantity-change-request.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  LineItemQuantityChange,
+  LineItemQuantityChange$Outbound,
+  LineItemQuantityChange$outboundSchema,
+} from "./line-item-quantity-change.js";
+
+export type SubModifyQuantityChangeRequest = {
+  lineItems: Array<LineItemQuantityChange>;
+};
+
+/** @internal */
+export type SubModifyQuantityChangeRequest$Outbound = {
+  line_items: Array<LineItemQuantityChange$Outbound>;
+};
+
+/** @internal */
+export const SubModifyQuantityChangeRequest$outboundSchema: z.ZodMiniType<
+  SubModifyQuantityChangeRequest$Outbound,
+  SubModifyQuantityChangeRequest
+> = z.pipe(
+  z.object({
+    lineItems: z.array(LineItemQuantityChange$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      lineItems: "line_items",
+    });
+  }),
+);
+
+export function subModifyQuantityChangeRequestToJSON(
+  subModifyQuantityChangeRequest: SubModifyQuantityChangeRequest,
+): string {
+  return JSON.stringify(
+    SubModifyQuantityChangeRequest$outboundSchema.parse(
+      subModifyQuantityChangeRequest,
+    ),
+  );
+}

package/src/sdk/models/subscription-modify-response.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  ChangedResources,
+  ChangedResources$inboundSchema,
+} from "./changed-resources.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  SubscriptionResponse,
+  SubscriptionResponse$inboundSchema,
+} from "./subscription-response.js";
+
+export type SubscriptionModifyResponse = {
+  changedResources?: ChangedResources | undefined;
+  subscription?: SubscriptionResponse | undefined;
+};
+
+/** @internal */
+export const SubscriptionModifyResponse$inboundSchema: z.ZodMiniType<
+  SubscriptionModifyResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    changed_resources: types.optional(ChangedResources$inboundSchema),
+    subscription: types.optional(SubscriptionResponse$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "changed_resources": "changedResources",
+    });
+  }),
+);
+
+export function subscriptionModifyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionModifyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionModifyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionModifyResponse' from JSON`,
+  );
+}

package/src/sdk/models/subscription-modify-type.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const SubscriptionModifyType = {
+  Inheritance: "inheritance",
+  QuantityChange: "quantity_change",
+} as const;
+export type SubscriptionModifyType = ClosedEnum<typeof SubscriptionModifyType>;
+
+/** @internal */
+export const SubscriptionModifyType$outboundSchema: z.ZodMiniEnum<
+  typeof SubscriptionModifyType
+> = z.enum(SubscriptionModifyType);

package/src/sdk/models/subscription-phase-create-request.ts

@@ -4,6 +4,11 @@
 
 import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  CreateSubscriptionLineItemRequest,
+  CreateSubscriptionLineItemRequest$Outbound,
+  CreateSubscriptionLineItemRequest$outboundSchema,
+} from "./create-subscription-line-item-request.js";
 import {
   OverrideLineItemRequest,
   OverrideLineItemRequest$Outbound,
@@ -20,6 +25,13 @@ export type SubscriptionPhaseCreateRequest = {
    * LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)
    */
   lineItemCoupons?: { [k: string]: Array<string> } | undefined;
+  /**
+   * LineItems are extra line items to add during this phase, primarily one-time charges.
+   *
+   * @remarks
+   * Each item's start_date defaults to the phase's start_date when not provided.
+   */
+  lineItems?: Array<CreateSubscriptionLineItemRequest> | undefined;
   metadata?: { [k: string]: string } | undefined;
   /**
    * OverrideLineItems allows customizing specific prices for this phase
@@ -36,6 +48,7 @@ export type SubscriptionPhaseCreateRequest$Outbound = {
   coupons?: Array<string> | undefined;
   end_date?: string | undefined;
   line_item_coupons?: { [k: string]: Array<string> } | undefined;
+  line_items?: Array<CreateSubscriptionLineItemRequest$Outbound> | undefined;
   metadata?: { [k: string]: string } | undefined;
   override_line_items?: Array<OverrideLineItemRequest$Outbound> | undefined;
   start_date: string;
@@ -50,6 +63,9 @@ export const SubscriptionPhaseCreateRequest$outboundSchema: z.ZodMiniType<
     coupons: z.optional(z.array(z.string())),
     endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     lineItemCoupons: z.optional(z.record(z.string(), z.array(z.string()))),
+    lineItems: z.optional(
+      z.array(CreateSubscriptionLineItemRequest$outboundSchema),
+    ),
     metadata: z.optional(z.record(z.string(), z.string())),
     overrideLineItems: z.optional(
       z.array(OverrideLineItemRequest$outboundSchema),
@@ -60,6 +76,7 @@ export const SubscriptionPhaseCreateRequest$outboundSchema: z.ZodMiniType<
     return remap$(v, {
       endDate: "end_date",
       lineItemCoupons: "line_item_coupons",
+      lineItems: "line_items",
       overrideLineItems: "override_line_items",
       startDate: "start_date",
     });

package/src/sdk/models/subscription-price-create-request.ts

@@ -4,10 +4,6 @@
 
 import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
-import {
-  BillingCadence,
-  BillingCadence$outboundSchema,
-} from "./billing-cadence.js";
 import { BillingModel, BillingModel$outboundSchema } from "./billing-model.js";
 import {
   BillingPeriod,
@@ -41,7 +37,6 @@ import {
 
 export type SubscriptionPriceCreateRequest = {
   amount?: string | undefined;
-  billingCadence: BillingCadence;
   billingModel: BillingModel;
   billingPeriod: BillingPeriod;
   billingPeriodCount?: number | undefined;
@@ -67,7 +62,6 @@ export type SubscriptionPriceCreateRequest = {
 /** @internal */
 export type SubscriptionPriceCreateRequest$Outbound = {
   amount?: string | undefined;
-  billing_cadence: string;
   billing_model: string;
   billing_period: string;
   billing_period_count?: number | undefined;
@@ -97,7 +91,6 @@ export const SubscriptionPriceCreateRequest$outboundSchema: z.ZodMiniType<
 > = z.pipe(
   z.object({
     amount: z.optional(z.string()),
-    billingCadence: BillingCadence$outboundSchema,
     billingModel: BillingModel$outboundSchema,
     billingPeriod: BillingPeriod$outboundSchema,
     billingPeriodCount: z.optional(z.int()),
@@ -121,7 +114,6 @@ export const SubscriptionPriceCreateRequest$outboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
-      billingCadence: "billing_cadence",
       billingModel: "billing_model",
       billingPeriod: "billing_period",
       billingPeriodCount: "billing_period_count",

package/src/sdk/models/window-size.ts

@@ -7,7 +7,6 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 
 export const WindowSize = {
-  Month: "MONTH",
   Minute: "MINUTE",
   FifteenMIN: "15MIN",
   ThirtyMIN: "30MIN",
@@ -17,6 +16,7 @@ export const WindowSize = {
   TwelveHOUR: "12HOUR",
   Day: "DAY",
   Week: "WEEK",
+  Month: "MONTH",
 } as const;
 export type WindowSize = OpenEnum<typeof WindowSize>;
 

package/src/sdk/sdk.ts

@@ -16,6 +16,7 @@ import { Features } from "./features.js";
 import { Groups } from "./groups.js";
 import { Integrations } from "./integrations.js";
 import { Invoices } from "./invoices.js";
+import { MeterUsage } from "./meter-usage.js";
 import { Payments } from "./payments.js";
 import { Plans } from "./plans.js";
 import { PriceUnits } from "./price-units.js";
@@ -104,6 +105,11 @@ export class Flexprice extends ClientSDK {
     return (this._integrations ??= new Integrations(this._options));
   }
 
+  private _meterUsage?: MeterUsage;
+  get meterUsage(): MeterUsage {
+    return (this._meterUsage ??= new MeterUsage(this._options));
+  }
+
   private _payments?: Payments;
   get payments(): Payments {
     return (this._payments ??= new Payments(this._options));

package/src/sdk/subscriptions.ts

@@ -23,6 +23,7 @@ import { subscriptionsListSubscriptionPauses } from "../funcs/subscriptions-list
 import { subscriptionsListSubscriptionSchedules } from "../funcs/subscriptions-list-subscription-schedules.js";
 import { subscriptionsPauseSubscription } from "../funcs/subscriptions-pause-subscription.js";
 import { subscriptionsPreviewSubscriptionChange } from "../funcs/subscriptions-preview-subscription-change.js";
+import { subscriptionsPreviewSubscriptionModify } from "../funcs/subscriptions-preview-subscription-modify.js";
 import { subscriptionsQuerySubscription } from "../funcs/subscriptions-query-subscription.js";
 import { subscriptionsRemoveSubscriptionAddon } from "../funcs/subscriptions-remove-subscription-addon.js";
 import { subscriptionsResumeSubscription } from "../funcs/subscriptions-resume-subscription.js";
@@ -341,16 +342,16 @@ export class Subscriptions extends ClientSDK {
   }
 
   /**
-   * Add customers to subscription inheritance
+   * Execute subscription modification
    *
    * @remarks
-   * 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).
    */
   async executeSubscriptionModify(
     id: string,
-    body: models.ExecuteSubscriptionInheritanceRequest,
+    body: models.ExecuteSubscriptionModifyRequest,
     options?: RequestOptions,
-  ): Promise<models.SubscriptionResponse> {
+  ): Promise<models.SubscriptionModifyResponse> {
     return unwrapAsync(subscriptionsExecuteSubscriptionModify(
       this,
       id,
@@ -359,6 +360,25 @@ export class Subscriptions extends ClientSDK {
     ));
   }
 
+  /**
+   * Preview subscription modification
+   *
+   * @remarks
+   * Preview the impact of a mid-cycle subscription modification without committing changes.
+   */
+  async previewSubscriptionModify(
+    id: string,
+    body: models.ExecuteSubscriptionModifyRequest,
+    options?: RequestOptions,
+  ): Promise<models.SubscriptionModifyResponse> {
+    return unwrapAsync(subscriptionsPreviewSubscriptionModify(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
   /**
    * Pause a subscription
    *