@paygentic/sdk 0.9.14 → 0.9.15

package/src/models/editsubscriptionintervalsresponse.ts

@@ -10,6 +10,10 @@ import {
   SubscriptionInterval,
   SubscriptionInterval$inboundSchema,
 } from "./subscriptioninterval.js";
+import {
+  SubscriptionIntervalChange,
+  SubscriptionIntervalChange$inboundSchema,
+} from "./subscriptionintervalchange.js";
 
 export type EditSubscriptionIntervalsResponseLineItems = {
   /**
@@ -36,6 +40,10 @@ export type EditSubscriptionIntervalsResponse = {
    */
   unchanged: boolean;
   lineItems: EditSubscriptionIntervalsResponseLineItems;
+  /**
+   * The record this edit wrote. Null when the edit changed nothing.
+   */
+  intervalChange: SubscriptionIntervalChange | null;
 };
 
 /** @internal */
@@ -74,6 +82,7 @@ export const EditSubscriptionIntervalsResponse$inboundSchema: z.ZodType<
   lineItems: z.lazy(() =>
     EditSubscriptionIntervalsResponseLineItems$inboundSchema
   ),
+  intervalChange: z.nullable(SubscriptionIntervalChange$inboundSchema),
 });
 
 export function editSubscriptionIntervalsResponseFromJSON(

package/src/models/index.ts

@@ -9,6 +9,7 @@ export * from "./billablemetric.js";
 export * from "./billingschedule.js";
 export * from "./booleanentitlementdetail.js";
 export * from "./booleanentitlementlistitem.js";
+export * from "./changereason.js";
 export * from "./cost.js";
 export * from "./costreportgroup.js";
 export * from "./costreportresponse.js";
@@ -30,7 +31,7 @@ export * from "./createusagediscountadjustment.js";
 export * from "./currencybreakdownentry.js";
 export * from "./customer.js";
 export * from "./customerpaymentsession.js";
-export * from "./editsubscriptionintervalsrequest.js";
+export * from "./editsubscriptionintervalsrequestunion.js";
 export * from "./editsubscriptionintervalsresponse.js";
 export * from "./entitlementdetail.js";
 export * from "./entitlementlistitem.js";
@@ -44,6 +45,7 @@ export * from "./fee.js";
 export * from "./grant.js";
 export * from "./groupinvoicesummary.js";
 export * from "./grouptrendentry.js";
+export * from "./intervalchangemetadata.js";
 export * from "./invoice.js";
 export * from "./invoicecategorysummary.js";
 export * from "./invoicelineitem.js";
@@ -95,7 +97,6 @@ export * from "./pricetax.js";
 export * from "./product.js";
 export * from "./profitabilityrow.js";
 export * from "./profitabilitysummaryresponse.js";
-export * from "./profitabilitytrend.js";
 export * from "./purchasegrantrequest.js";
 export * from "./purchasegrantresponse.js";
 export * from "./ratetype.js";
@@ -121,6 +122,10 @@ export * from "./subscriptionadjustment.js";
 export * from "./subscriptionadjustmentsresponse.js";
 export * from "./subscriptioninterval.js";
 export * from "./subscriptionintervaladdop.js";
+export * from "./subscriptionintervalchange.js";
+export * from "./subscriptionintervalchangecopy.js";
+export * from "./subscriptionintervalchangeentry.js";
+export * from "./subscriptionintervalchangesresponse.js";
 export * from "./subscriptionintervaleditop.js";
 export * from "./subscriptionintervalremoveop.js";
 export * from "./subscriptionintervalsresponse.js";

package/src/models/intervalchangemetadata.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type IntervalChangeMetadata = string | number | boolean;
+
+/** @internal */
+export const IntervalChangeMetadata$inboundSchema: z.ZodType<
+  IntervalChangeMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.boolean()]);
+/** @internal */
+export type IntervalChangeMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const IntervalChangeMetadata$outboundSchema: z.ZodType<
+  IntervalChangeMetadata$Outbound,
+  z.ZodTypeDef,
+  IntervalChangeMetadata
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function intervalChangeMetadataToJSON(
+  intervalChangeMetadata: IntervalChangeMetadata,
+): string {
+  return JSON.stringify(
+    IntervalChangeMetadata$outboundSchema.parse(intervalChangeMetadata),
+  );
+}
+export function intervalChangeMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<IntervalChangeMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IntervalChangeMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IntervalChangeMetadata' from JSON`,
+  );
+}

package/src/models/invoice.ts

@@ -210,6 +210,10 @@ export type Invoice = {
    * When the invoice was paid (null if not yet paid)
    */
   paidAt?: Date | null | undefined;
+  /**
+   * When the invoice was issued, in the subscription's effective time (test-clock time on a test clock). Revenue and profitability windows count the invoice by this instant. Null until the invoice is issued.
+   */
+  issuedAt?: Date | null | undefined;
   /**
    * Payment due date snapshotted at invoice-create time as the issue date + subscription.paymentTermDays, anchored to midnight UTC. Null only for invoices created before this feature shipped (no backfill).
    */
@@ -381,6 +385,9 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
     paidAt: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),
+    issuedAt: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
     dueAt: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),

package/src/models/operations/createsubscription.ts

@@ -125,6 +125,18 @@ export type CreateSubscriptionRequest = {
    * Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.
    */
   metadata?: { [k: string]: models.SubscriptionMetadata } | undefined;
+  /**
+   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   */
+  changeReason?: models.ChangeReason | undefined;
+  /**
+   * A free-text note on why these intervals are changing.
+   */
+  changeDescription?: string | undefined;
+  /**
+   * Your own key-value data about the change, such as a CRM deal ID.
+   */
+  changeMetadata?: { [k: string]: models.IntervalChangeMetadata } | undefined;
 };
 
 /** @internal */
@@ -221,6 +233,11 @@ export type CreateSubscriptionRequest$Outbound = {
   sessionExpiryMinutes?: number | undefined;
   versionPolicy?: string | undefined;
   metadata?: { [k: string]: models.SubscriptionMetadata$Outbound } | undefined;
+  changeReason?: string | undefined;
+  changeDescription?: string | undefined;
+  changeMetadata?:
+    | { [k: string]: models.IntervalChangeMetadata$Outbound }
+    | undefined;
 };
 
 /** @internal */
@@ -247,6 +264,10 @@ export const CreateSubscriptionRequest$outboundSchema: z.ZodType<
   sessionExpiryMinutes: z.number().optional(),
   versionPolicy: models.SubscriptionVersionPolicy$outboundSchema.optional(),
   metadata: z.record(models.SubscriptionMetadata$outboundSchema).optional(),
+  changeReason: models.ChangeReason$outboundSchema.optional(),
+  changeDescription: z.string().optional(),
+  changeMetadata: z.record(models.IntervalChangeMetadata$outboundSchema)
+    .optional(),
 });
 
 export function createSubscriptionRequestToJSON(

package/src/models/operations/editsubscriptionintervals.ts

@@ -11,14 +11,15 @@ export type EditSubscriptionIntervalsRequest = {
    * The subscription ID
    */
   id: string;
-  editSubscriptionIntervalsRequest: models.EditSubscriptionIntervalsRequest;
+  editSubscriptionIntervalsRequest:
+    models.EditSubscriptionIntervalsRequestUnion;
 };
 
 /** @internal */
 export type EditSubscriptionIntervalsRequest$Outbound = {
   id: string;
   EditSubscriptionIntervalsRequest:
-    models.EditSubscriptionIntervalsRequest$Outbound;
+    models.EditSubscriptionIntervalsRequestUnion$Outbound;
 };
 
 /** @internal */
@@ -29,7 +30,7 @@ export const EditSubscriptionIntervalsRequest$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   editSubscriptionIntervalsRequest:
-    models.EditSubscriptionIntervalsRequest$outboundSchema,
+    models.EditSubscriptionIntervalsRequestUnion$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     editSubscriptionIntervalsRequest: "EditSubscriptionIntervalsRequest",

package/src/models/operations/getcostreport.ts

@@ -81,6 +81,10 @@ export type GetCostReportRequest = {
    * When true, include prior-period comparison data in each group.
    */
   comparePriorPeriod?: boolean | undefined;
+  /**
+   * When true, leave out groups with neither cost nor usage in the period. They are dropped before ranking, so they take no top-N slot, do not appear in the 'Other' bucket and are not counted in `pagination.total`. `emptyGroupCount` says how many were left out.
+   */
+  excludeEmpty?: boolean | undefined;
   /**
    * Time window granularity for the time-series breakdown.
    */
@@ -132,6 +136,7 @@ export type GetCostReportRequest$Outbound = {
   filterGroupBy?: string | undefined;
   topN: number;
   comparePriorPeriod: boolean;
+  excludeEmpty: boolean;
   windowSize?: string | undefined;
   sort: string;
   sortDir: string;
@@ -155,6 +160,7 @@ export const GetCostReportRequest$outboundSchema: z.ZodType<
   filterGroupBy: z.string().optional(),
   topN: z.number().int().default(9),
   comparePriorPeriod: z.boolean().default(false),
+  excludeEmpty: z.boolean().default(false),
   windowSize: GetCostReportWindowSize$outboundSchema.optional(),
   sort: Sort$outboundSchema.default("totalCost"),
   sortDir: SortDir$outboundSchema.default("desc"),

package/src/models/operations/getprofitability.ts

@@ -3,22 +3,6 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
-
-/**
- * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
- */
-export const GetProfitabilityBucketWidth = {
-  Hour: "hour",
-  Day: "day",
-  Week: "week",
-} as const;
-/**
- * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
- */
-export type GetProfitabilityBucketWidth = ClosedEnum<
-  typeof GetProfitabilityBucketWidth
->;
 
 export type GetProfitabilityRequest = {
   /**
@@ -42,16 +26,15 @@ export type GetProfitabilityRequest = {
    */
   currency?: string | undefined;
   /**
-   * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
+   * When true, leave customers with neither revenue nor cost in the period out of `rows`. They are dropped before ranking, so they take no top-N slot and are not folded into the 'Other' row. `emptyCustomerCount` says how many there are either way.
    */
-  bucketWidth?: GetProfitabilityBucketWidth | undefined;
+  excludeEmpty?: boolean | undefined;
+  /**
+   * When true, also return in `emptyCustomers` the customers counted in `emptyCustomerCount` that `rows` does not carry, so a caller can show the complete customer list.
+   */
+  includeEmpty?: boolean | undefined;
 };
 
-/** @internal */
-export const GetProfitabilityBucketWidth$outboundSchema: z.ZodNativeEnum<
-  typeof GetProfitabilityBucketWidth
-> = z.nativeEnum(GetProfitabilityBucketWidth);
-
 /** @internal */
 export type GetProfitabilityRequest$Outbound = {
   merchantId: string;
@@ -59,7 +42,8 @@ export type GetProfitabilityRequest$Outbound = {
   to: string;
   topN: number;
   currency?: string | undefined;
-  bucketWidth: string;
+  excludeEmpty: boolean;
+  includeEmpty: boolean;
 };
 
 /** @internal */
@@ -73,7 +57,8 @@ export const GetProfitabilityRequest$outboundSchema: z.ZodType<
   to: z.date().transform(v => v.toISOString()),
   topN: z.number().int().default(10),
   currency: z.string().optional(),
-  bucketWidth: GetProfitabilityBucketWidth$outboundSchema.default("day"),
+  excludeEmpty: z.boolean().default(false),
+  includeEmpty: z.boolean().default(false),
 });
 
 export function getProfitabilityRequestToJSON(

package/src/models/operations/index.ts

@@ -89,6 +89,7 @@ export * from "./listentitlements.js";
 export * from "./listexternalreferences.js";
 export * from "./listfeatures.js";
 export * from "./listfees.js";
+export * from "./listintervalchanges.js";
 export * from "./listinvoicerefunds.js";
 export * from "./listinvoices.js";
 export * from "./listitems.js";
@@ -108,6 +109,7 @@ export * from "./listsourceevents.js";
 export * from "./listsourcerules.js";
 export * from "./listsources.js";
 export * from "./listsubscriptionadjustments.js";
+export * from "./listsubscriptionintervalchanges.js";
 export * from "./listsubscriptions.js";
 export * from "./listtestclocks.js";
 export * from "./mintplanversion.js";

package/src/models/operations/listintervalchanges.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as models from "../index.js";
+
+export type ListIntervalChangesRequest = {
+  /**
+   * Number of interval changes to return
+   */
+  limit?: string | undefined;
+  /**
+   * Number of interval changes to skip
+   */
+  offset?: string | undefined;
+  /**
+   * Only return changes recorded at or after this time
+   */
+  from?: Date | undefined;
+  /**
+   * Only return changes recorded before this time
+   */
+  to?: Date | undefined;
+  /**
+   * Only return changes with this reason.
+   */
+  changeReason?: models.ChangeReason | undefined;
+};
+
+/** @internal */
+export type ListIntervalChangesRequest$Outbound = {
+  limit: string;
+  offset: string;
+  from?: string | undefined;
+  to?: string | undefined;
+  changeReason?: string | undefined;
+};
+
+/** @internal */
+export const ListIntervalChangesRequest$outboundSchema: z.ZodType<
+  ListIntervalChangesRequest$Outbound,
+  z.ZodTypeDef,
+  ListIntervalChangesRequest
+> = z.object({
+  limit: z.string().default("10"),
+  offset: z.string().default("0"),
+  from: z.date().transform(v => v.toISOString()).optional(),
+  to: z.date().transform(v => v.toISOString()).optional(),
+  changeReason: models.ChangeReason$outboundSchema.optional(),
+});
+
+export function listIntervalChangesRequestToJSON(
+  listIntervalChangesRequest: ListIntervalChangesRequest,
+): string {
+  return JSON.stringify(
+    ListIntervalChangesRequest$outboundSchema.parse(listIntervalChangesRequest),
+  );
+}

package/src/models/operations/listsubscriptionintervalchanges.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListSubscriptionIntervalChangesRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  /**
+   * Number of interval changes to return
+   */
+  limit?: string | undefined;
+  /**
+   * Number of interval changes to skip
+   */
+  offset?: string | undefined;
+};
+
+/** @internal */
+export type ListSubscriptionIntervalChangesRequest$Outbound = {
+  id: string;
+  limit: string;
+  offset: string;
+};
+
+/** @internal */
+export const ListSubscriptionIntervalChangesRequest$outboundSchema: z.ZodType<
+  ListSubscriptionIntervalChangesRequest$Outbound,
+  z.ZodTypeDef,
+  ListSubscriptionIntervalChangesRequest
+> = z.object({
+  id: z.string(),
+  limit: z.string().default("10"),
+  offset: z.string().default("0"),
+});
+
+export function listSubscriptionIntervalChangesRequestToJSON(
+  listSubscriptionIntervalChangesRequest:
+    ListSubscriptionIntervalChangesRequest,
+): string {
+  return JSON.stringify(
+    ListSubscriptionIntervalChangesRequest$outboundSchema.parse(
+      listSubscriptionIntervalChangesRequest,
+    ),
+  );
+}

package/src/models/operations/terminatesubscription.ts

@@ -4,12 +4,17 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
 
 export type TerminateSubscriptionRequestBody = {
   /**
    * Cancellation explanation text. Sample values: 'Customer requested cancellation', 'Payment failure', 'Service migration', 'Contract expiration'
    */
   reason: string;
+  /**
+   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   */
+  changeReason?: models.ChangeReason | undefined;
 };
 
 export type TerminateSubscriptionRequest = {
@@ -23,6 +28,7 @@ export type TerminateSubscriptionRequest = {
 /** @internal */
 export type TerminateSubscriptionRequestBody$Outbound = {
   reason: string;
+  changeReason?: string | undefined;
 };
 
 /** @internal */
@@ -32,6 +38,7 @@ export const TerminateSubscriptionRequestBody$outboundSchema: z.ZodType<
   TerminateSubscriptionRequestBody
 > = z.object({
   reason: z.string(),
+  changeReason: models.ChangeReason$outboundSchema.optional(),
 });
 
 export function terminateSubscriptionRequestBodyToJSON(

package/src/models/profitabilityrow.ts

@@ -6,10 +6,6 @@ import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-import {
-  ProfitabilityTrend,
-  ProfitabilityTrend$inboundSchema,
-} from "./profitabilitytrend.js";
 
 export type ProfitabilityRow = {
   /**
@@ -36,10 +32,6 @@ export type ProfitabilityRow = {
    * Margin percent (profit / revenue × 100), with two decimals. Null when revenue is zero.
    */
   marginPct: string | null;
-  /**
-   * Per-customer revenue trend over the period. Null for the 'Other' row and when there's insufficient data.
-   */
-  trend: ProfitabilityTrend | null;
 };
 
 /** @internal */
@@ -54,7 +46,6 @@ export const ProfitabilityRow$inboundSchema: z.ZodType<
   totalCost: z.string(),
   profit: z.string(),
   marginPct: z.nullable(z.string()),
-  trend: z.nullable(ProfitabilityTrend$inboundSchema),
 });
 
 export function profitabilityRowFromJSON(

package/src/models/profitabilitysummaryresponse.ts

@@ -49,9 +49,25 @@ export type ProfitabilitySummaryResponse = {
    */
   currency: string;
   /**
-   * Top-N customer rows by profit descending, optionally followed by a single 'Other' row when more than topN customers contributed.
+   * Top-N customer rows by profit descending, optionally followed by a single 'Other' row when more than topN customers contributed. With `excludeEmpty=true`, customers with neither revenue nor cost in the period are left out.
    */
   rows: Array<ProfitabilityRow>;
+  /**
+   * The merchant's customers this summary scored, whether or not they made a row.
+   */
+  customerCount?: number | undefined;
+  /**
+   * Customers with neither revenue nor cost in the period, counted whether or not `excludeEmpty` left them out of `rows`. Null when a cost read failed: their cost was never established, so none is counted and `excludeEmpty` leaves nobody out.
+   */
+  emptyCustomerCount?: number | null | undefined;
+  /**
+   * Customers `rows` does not carry because a cost read failed (see `warnings`) and they had no revenue in the period. Null when every cost read settled.
+   */
+  unloadedCustomerCount?: number | null | undefined;
+  /**
+   * The customers `emptyCustomerCount` counts that `rows` does not carry, either as a row or folded into the 'Other' row, sorted by name, each reading zero with a null margin. Present only when `includeEmpty=true` and the count is answered. They are never ranked, never part of the top-N and never folded into the 'Other' row.
+   */
+  emptyCustomers?: Array<ProfitabilityRow> | undefined;
   /**
    * Non-fatal warnings collected during cost discovery (e.g. an individual cost query failed). Empty array on a clean run.
    */
@@ -122,6 +138,10 @@ export const ProfitabilitySummaryResponse$inboundSchema: z.ZodType<
   object: z.literal("profitability_summary"),
   currency: z.string(),
   rows: z.array(ProfitabilityRow$inboundSchema),
+  customerCount: z.number().int().optional(),
+  emptyCustomerCount: z.nullable(z.number().int()).optional(),
+  unloadedCustomerCount: z.nullable(z.number().int()).optional(),
+  emptyCustomers: z.array(ProfitabilityRow$inboundSchema).optional(),
   warnings: z.array(z.string()).optional(),
   revenueRange: z.nullable(
     z.lazy(() => ProfitabilitySummaryResponseRevenueRange$inboundSchema),

package/src/models/subscription.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { ClosedEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
@@ -113,6 +114,20 @@ export const SubscriptionStatusEnum = {
 } as const;
 export type SubscriptionStatusEnum = ClosedEnum<typeof SubscriptionStatusEnum>;
 
+/**
+ * Why the subscription was terminated. Null while it is not terminated.
+ */
+export const TerminationChangeReason = {
+  Commercial: "commercial",
+  Correction: "correction",
+  Migration: "migration",
+  Unspecified: "unspecified",
+} as const;
+/**
+ * Why the subscription was terminated. Null while it is not terminated.
+ */
+export type TerminationChangeReason = OpenEnum<typeof TerminationChangeReason>;
+
 export type Merchant = {
   id: string;
   name: string;
@@ -204,6 +219,10 @@ export type Subscription = {
    * Reason for termination
    */
   terminationReason?: string | undefined;
+  /**
+   * Why the subscription was terminated. Null while it is not terminated.
+   */
+  terminationChangeReason?: TerminationChangeReason | null | undefined;
   /**
    * Test clock ID if this subscription is attached to a test clock. Only present in non-production environments.
    */
@@ -358,6 +377,13 @@ export const SubscriptionStatusEnum$inboundSchema: z.ZodNativeEnum<
   typeof SubscriptionStatusEnum
 > = z.nativeEnum(SubscriptionStatusEnum);
 
+/** @internal */
+export const TerminationChangeReason$inboundSchema: z.ZodType<
+  TerminationChangeReason,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TerminationChangeReason);
+
 /** @internal */
 export const Merchant$inboundSchema: z.ZodType<
   Merchant,
@@ -457,6 +483,8 @@ export const Subscription$inboundSchema: z.ZodType<
   ).optional(),
   terminatedBy: z.string().optional(),
   terminationReason: z.string().optional(),
+  terminationChangeReason: z.nullable(TerminationChangeReason$inboundSchema)
+    .optional(),
   testClockId: z.string().optional(),
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   walletId: z.string().optional(),

package/src/models/subscriptionintervalchange.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { ChangeReason, ChangeReason$inboundSchema } from "./changereason.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  IntervalChangeMetadata,
+  IntervalChangeMetadata$inboundSchema,
+} from "./intervalchangemetadata.js";
+import {
+  SubscriptionIntervalChangeEntry,
+  SubscriptionIntervalChangeEntry$inboundSchema,
+} from "./subscriptionintervalchangeentry.js";
+
+/**
+ * The record of one change to a subscription's price intervals: what changed, and why.
+ */
+export type SubscriptionIntervalChange = {
+  id: string;
+  merchantId: string;
+  subscriptionId: string;
+  /**
+   * Why a change was made. `correction` fixes data to match what was agreed; `migration` moves a contract from another system; `commercial` is a real change to the deal. Defaults to `unspecified`.
+   */
+  changeReason: ChangeReason;
+  description: string | null;
+  /**
+   * Your own key-value data about the change, such as a CRM deal ID.
+   */
+  metadata: { [k: string]: IntervalChangeMetadata };
+  createdAt: Date;
+  /**
+   * One entry per interval the edit added, changed or removed.
+   */
+  intervals: Array<SubscriptionIntervalChangeEntry>;
+};
+
+/** @internal */
+export const SubscriptionIntervalChange$inboundSchema: z.ZodType<
+  SubscriptionIntervalChange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  merchantId: z.string(),
+  subscriptionId: z.string(),
+  changeReason: ChangeReason$inboundSchema,
+  description: z.nullable(z.string()),
+  metadata: z.record(IntervalChangeMetadata$inboundSchema),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  intervals: z.array(SubscriptionIntervalChangeEntry$inboundSchema),
+});
+
+export function subscriptionIntervalChangeFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionIntervalChange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionIntervalChange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionIntervalChange' from JSON`,
+  );
+}