@paygentic/sdk 0.9.13 → 0.9.14

package/src/models/editsubscriptionintervalsresponse.ts

@@ -0,0 +1,87 @@
+/*
+ * 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";
+import {
+  SubscriptionInterval,
+  SubscriptionInterval$inboundSchema,
+} from "./subscriptioninterval.js";
+
+export type EditSubscriptionIntervalsResponseLineItems = {
+  /**
+   * Number of distinct prices that gained a line item as this timeline edit was re-derived into billing.
+   */
+  created: number;
+  /**
+   * Number of distinct prices whose future/uninvoiced line items were removed as this timeline edit was re-derived into billing.
+   */
+  removed: number;
+  /**
+   * True when the timeline edit was saved but the line-item re-derive failed. The edit is not rolled back, and the re-derive is retried automatically. Resubmitting the same request retries it sooner.
+   */
+  syncFailed?: boolean | undefined;
+};
+
+export type EditSubscriptionIntervalsResponse = {
+  /**
+   * The timeline's effective price intervals after applying the op set, ordered by start date.
+   */
+  intervals: Array<SubscriptionInterval>;
+  /**
+   * True when the op set resolved to no change and nothing was written.
+   */
+  unchanged: boolean;
+  lineItems: EditSubscriptionIntervalsResponseLineItems;
+};
+
+/** @internal */
+export const EditSubscriptionIntervalsResponseLineItems$inboundSchema:
+  z.ZodType<EditSubscriptionIntervalsResponseLineItems, z.ZodTypeDef, unknown> =
+    z.object({
+      created: z.number().int(),
+      removed: z.number().int(),
+      syncFailed: z.boolean().optional(),
+    });
+
+export function editSubscriptionIntervalsResponseLineItemsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EditSubscriptionIntervalsResponseLineItems,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EditSubscriptionIntervalsResponseLineItems$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EditSubscriptionIntervalsResponseLineItems' from JSON`,
+  );
+}
+
+/** @internal */
+export const EditSubscriptionIntervalsResponse$inboundSchema: z.ZodType<
+  EditSubscriptionIntervalsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  intervals: z.array(SubscriptionInterval$inboundSchema),
+  unchanged: z.boolean(),
+  lineItems: z.lazy(() =>
+    EditSubscriptionIntervalsResponseLineItems$inboundSchema
+  ),
+});
+
+export function editSubscriptionIntervalsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EditSubscriptionIntervalsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EditSubscriptionIntervalsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EditSubscriptionIntervalsResponse' from JSON`,
+  );
+}

package/src/models/index.ts

@@ -30,6 +30,8 @@ export * from "./createusagediscountadjustment.js";
 export * from "./currencybreakdownentry.js";
 export * from "./customer.js";
 export * from "./customerpaymentsession.js";
+export * from "./editsubscriptionintervalsrequest.js";
+export * from "./editsubscriptionintervalsresponse.js";
 export * from "./entitlementdetail.js";
 export * from "./entitlementlistitem.js";
 export * from "./entitlementstatus.js";
@@ -117,9 +119,15 @@ export * from "./staticentitlementlistitem.js";
 export * from "./subscription.js";
 export * from "./subscriptionadjustment.js";
 export * from "./subscriptionadjustmentsresponse.js";
+export * from "./subscriptioninterval.js";
+export * from "./subscriptionintervaladdop.js";
+export * from "./subscriptionintervaleditop.js";
+export * from "./subscriptionintervalremoveop.js";
+export * from "./subscriptionintervalsresponse.js";
 export * from "./subscriptionmetadata.js";
 export * from "./subscriptionportal.js";
 export * from "./subscriptionreconciliation.js";
+export * from "./subscriptionversionpolicy.js";
 export * from "./testclock.js";
 export * from "./transitionplanversionrequest.js";
 export * from "./updateapprovalrequest.js";

package/src/models/operations/createsubscription.ts

@@ -117,6 +117,10 @@ export type CreateSubscriptionRequest = {
    * Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.
    */
   sessionExpiryMinutes?: number | undefined;
+  /**
+   * How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.
+   */
+  versionPolicy?: models.SubscriptionVersionPolicy | undefined;
   /**
    * Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.
    */
@@ -215,6 +219,7 @@ export type CreateSubscriptionRequest$Outbound = {
   renewalReminderDays?: number | null | undefined;
   paymentTermDays?: number | undefined;
   sessionExpiryMinutes?: number | undefined;
+  versionPolicy?: string | undefined;
   metadata?: { [k: string]: models.SubscriptionMetadata$Outbound } | undefined;
 };
 
@@ -240,6 +245,7 @@ export const CreateSubscriptionRequest$outboundSchema: z.ZodType<
   renewalReminderDays: z.nullable(z.number().int()).optional(),
   paymentTermDays: z.number().int().optional(),
   sessionExpiryMinutes: z.number().optional(),
+  versionPolicy: models.SubscriptionVersionPolicy$outboundSchema.optional(),
   metadata: z.record(models.SubscriptionMetadata$outboundSchema).optional(),
 });
 

package/src/models/operations/editsubscriptionintervals.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+
+export type EditSubscriptionIntervalsRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+  editSubscriptionIntervalsRequest: models.EditSubscriptionIntervalsRequest;
+};
+
+/** @internal */
+export type EditSubscriptionIntervalsRequest$Outbound = {
+  id: string;
+  EditSubscriptionIntervalsRequest:
+    models.EditSubscriptionIntervalsRequest$Outbound;
+};
+
+/** @internal */
+export const EditSubscriptionIntervalsRequest$outboundSchema: z.ZodType<
+  EditSubscriptionIntervalsRequest$Outbound,
+  z.ZodTypeDef,
+  EditSubscriptionIntervalsRequest
+> = z.object({
+  id: z.string(),
+  editSubscriptionIntervalsRequest:
+    models.EditSubscriptionIntervalsRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    editSubscriptionIntervalsRequest: "EditSubscriptionIntervalsRequest",
+  });
+});
+
+export function editSubscriptionIntervalsRequestToJSON(
+  editSubscriptionIntervalsRequest: EditSubscriptionIntervalsRequest,
+): string {
+  return JSON.stringify(
+    EditSubscriptionIntervalsRequest$outboundSchema.parse(
+      editSubscriptionIntervalsRequest,
+    ),
+  );
+}

package/src/models/operations/getrevenue.ts

@@ -31,6 +31,18 @@ export const GroupBy = {
  */
 export type GroupBy = ClosedEnum<typeof GroupBy>;
 
+/**
+ * Which date places revenue inside the window. 'issued' (default) counts whole invoices by their issue date, the basis revenue is recognised on. 'billingPeriod' counts invoice lines by the start of the period each line bills, so a window covering one billing period returns that period's charges, whichever invoices carry them: this month's advance fee and this month's arrears usage. Paid, outstanding and written-off follow each line's invoice; a refund splits across its invoice's lines by subtotal; payments not tied to an invoice are excluded because they bill no period.
+ */
+export const PeriodBasis = {
+  Issued: "issued",
+  BillingPeriod: "billingPeriod",
+} as const;
+/**
+ * Which date places revenue inside the window. 'issued' (default) counts whole invoices by their issue date, the basis revenue is recognised on. 'billingPeriod' counts invoice lines by the start of the period each line bills, so a window covering one billing period returns that period's charges, whichever invoices carry them: this month's advance fee and this month's arrears usage. Paid, outstanding and written-off follow each line's invoice; a refund splits across its invoice's lines by subtotal; payments not tied to an invoice are excluded because they bill no period.
+ */
+export type PeriodBasis = ClosedEnum<typeof PeriodBasis>;
+
 export type GetRevenueRequest = {
   /**
    * Start of the time range (ISO 8601 format)
@@ -64,6 +76,10 @@ export type GetRevenueRequest = {
    * Group invoice data by dimension. Allowed values: 'plan' (max 5 groups, top 4 + 'other' when exceeding), 'customer' (max 25 groups, top 24 + 'other' when exceeding, sorted by revenue descending), 'currency' (one entry per currency, primary currency first then alphabetical). Note: groupBy values are mutually exclusive — combining them returns a 400 error. When groupBy=currency is active, top-level netRevenue, invoices, and payments fields are omitted; currencyBreakdown is the sole data source.
    */
   groupBy?: GroupBy | undefined;
+  /**
+   * Which date places revenue inside the window. 'issued' (default) counts whole invoices by their issue date, the basis revenue is recognised on. 'billingPeriod' counts invoice lines by the start of the period each line bills, so a window covering one billing period returns that period's charges, whichever invoices carry them: this month's advance fee and this month's arrears usage. Paid, outstanding and written-off follow each line's invoice; a refund splits across its invoice's lines by subtotal; payments not tied to an invoice are excluded because they bill no period.
+   */
+  periodBasis?: PeriodBasis | undefined;
 };
 
 /** @internal */
@@ -75,6 +91,10 @@ export const GetRevenueBucketWidth$outboundSchema: z.ZodNativeEnum<
 export const GroupBy$outboundSchema: z.ZodNativeEnum<typeof GroupBy> = z
   .nativeEnum(GroupBy);
 
+/** @internal */
+export const PeriodBasis$outboundSchema: z.ZodNativeEnum<typeof PeriodBasis> = z
+  .nativeEnum(PeriodBasis);
+
 /** @internal */
 export type GetRevenueRequest$Outbound = {
   startTime: string;
@@ -85,6 +105,7 @@ export type GetRevenueRequest$Outbound = {
   subscriptionIds?: Array<string> | undefined;
   currency?: string | undefined;
   groupBy?: string | undefined;
+  periodBasis: string;
 };
 
 /** @internal */
@@ -101,6 +122,7 @@ export const GetRevenueRequest$outboundSchema: z.ZodType<
   subscriptionIds: z.array(z.string()).optional(),
   currency: z.string().optional(),
   groupBy: GroupBy$outboundSchema.optional(),
+  periodBasis: PeriodBasis$outboundSchema.default("issued"),
 });
 
 export function getRevenueRequestToJSON(

package/src/models/operations/getsubscriptionintervals.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetSubscriptionIntervalsRequest = {
+  /**
+   * The subscription ID
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetSubscriptionIntervalsRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetSubscriptionIntervalsRequest$outboundSchema: z.ZodType<
+  GetSubscriptionIntervalsRequest$Outbound,
+  z.ZodTypeDef,
+  GetSubscriptionIntervalsRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getSubscriptionIntervalsRequestToJSON(
+  getSubscriptionIntervalsRequest: GetSubscriptionIntervalsRequest,
+): string {
+  return JSON.stringify(
+    GetSubscriptionIntervalsRequest$outboundSchema.parse(
+      getSubscriptionIntervalsRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -41,6 +41,7 @@ export * from "./deletesubscriptionadjustment.js";
 export * from "./deletetestclock.js";
 export * from "./disconnectmerchantintegration.js";
 export * from "./downloadinvoicepdf.js";
+export * from "./editsubscriptionintervals.js";
 export * from "./generateportallink.js";
 export * from "./generatescheduleinvoices.js";
 export * from "./getapproval.js";
@@ -71,6 +72,7 @@ export * from "./getrevenue.js";
 export * from "./getsource.js";
 export * from "./getsourcerule.js";
 export * from "./getsubscription.js";
+export * from "./getsubscriptionintervals.js";
 export * from "./gettestclock.js";
 export * from "./getuser.js";
 export * from "./ingestevent.js";

package/src/models/operations/updatesubscription.ts

@@ -5,6 +5,7 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
+import * as models from "../index.js";
 
 export const UpdateSubscriptionStatus = {
   Active: "active",
@@ -55,6 +56,10 @@ export type UpdateSubscriptionRequestBody = {
    * Payment term in days ("Net X") applied to subsequently generated invoices: invoice dueAt = invoice issue date + paymentTermDays. A non-zero value is only valid alongside bankTransferOnly=true. Set 0 for "due on issue". Already-issued invoices keep their snapshotted dueAt.
    */
   paymentTermDays?: number | undefined;
+  /**
+   * How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.
+   */
+  versionPolicy?: models.SubscriptionVersionPolicy | undefined;
 };
 
 export type UpdateSubscriptionRequest = {
@@ -80,6 +85,7 @@ export type UpdateSubscriptionRequestBody$Outbound = {
   renewalReminderEnabled?: boolean | null | undefined;
   renewalReminderDays?: number | null | undefined;
   paymentTermDays?: number | undefined;
+  versionPolicy?: string | undefined;
 };
 
 /** @internal */
@@ -99,6 +105,7 @@ export const UpdateSubscriptionRequestBody$outboundSchema: z.ZodType<
   renewalReminderEnabled: z.nullable(z.boolean()).optional(),
   renewalReminderDays: z.nullable(z.number().int()).optional(),
   paymentTermDays: z.number().int().optional(),
+  versionPolicy: models.SubscriptionVersionPolicy$outboundSchema.optional(),
 });
 
 export function updateSubscriptionRequestBodyToJSON(

package/src/models/subscription.ts

@@ -11,6 +11,10 @@ import {
   SubscriptionMetadata,
   SubscriptionMetadata$inboundSchema,
 } from "./subscriptionmetadata.js";
+import {
+  SubscriptionVersionPolicy,
+  SubscriptionVersionPolicy$inboundSchema,
+} from "./subscriptionversionpolicy.js";
 
 export const SubscriptionObject = {
   Subscription: "subscription",
@@ -173,6 +177,10 @@ export type Subscription = {
    * The version number of the plan version referenced by planVersionId, as of subscription creation.
    */
   versionNumber?: number | undefined;
+  /**
+   * How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.
+   */
+  versionPolicy: SubscriptionVersionPolicy;
   /**
    * Deprecated. Legacy-only, not populated for new subscriptions.
    *
@@ -439,6 +447,7 @@ export const Subscription$inboundSchema: z.ZodType<
   planId: z.string(),
   planVersionId: z.string().optional(),
   versionNumber: z.number().int().optional(),
+  versionPolicy: SubscriptionVersionPolicy$inboundSchema,
   prefundAmount: z.string().optional(),
   minimumAccountBalance: z.string().optional(),
   startedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),

package/src/models/subscriptioninterval.ts

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * plan_line if the plan version has a line with this priceKey. subscription_owned if it does not, so the interval belongs to this subscription only. After an add, check the kind. A mistyped priceKey creates a subscription_owned interval.
+ */
+export const SubscriptionIntervalKind = {
+  PlanLine: "plan_line",
+  SubscriptionOwned: "subscription_owned",
+} as const;
+/**
+ * plan_line if the plan version has a line with this priceKey. subscription_owned if it does not, so the interval belongs to this subscription only. After an add, check the kind. A mistyped priceKey creates a subscription_owned interval.
+ */
+export type SubscriptionIntervalKind = ClosedEnum<
+  typeof SubscriptionIntervalKind
+>;
+
+export type SubscriptionIntervalQuantityTransition = {
+  effectiveDate: Date;
+  quantity: string;
+};
+
+export const SubscriptionIntervalBillingMode = {
+  Advance: "advance",
+  Arrears: "arrears",
+} as const;
+export type SubscriptionIntervalBillingMode = ClosedEnum<
+  typeof SubscriptionIntervalBillingMode
+>;
+
+/**
+ * A price interval of the subscription.
+ */
+export type SubscriptionInterval = {
+  id: string;
+  /**
+   * The catalog price this interval bills.
+   */
+  priceId: string;
+  /**
+   * Identifies the price line. An override keeps the key of the plan price that it replaces.
+   */
+  priceKey: string;
+  /**
+   * plan_line if the plan version has a line with this priceKey. subscription_owned if it does not, so the interval belongs to this subscription only. After an add, check the kind. A mistyped priceKey creates a subscription_owned interval.
+   */
+  kind: SubscriptionIntervalKind;
+  /**
+   * The plan version of this interval.
+   */
+  planVersionId: string;
+  /**
+   * Signed net unit price for each period, as a decimal string. Null means the interval bills the catalog price.
+   */
+  unitPrice: string | null;
+  /**
+   * Quantity at interval start, as a decimal string.
+   */
+  baseQuantity: string;
+  quantityTransitions: Array<SubscriptionIntervalQuantityTransition>;
+  /**
+   * ISO-8601 duration or 'one_off'
+   */
+  billingCadence: string;
+  billingMode: SubscriptionIntervalBillingMode;
+  /**
+   * The one-time date this interval bills on. Set iff billingCadence is 'one_off'; null for a recurring interval.
+   */
+  billDate: Date | null;
+  startDate: Date;
+  /**
+   * Null for an open-ended interval.
+   */
+  endDate: Date | null;
+};
+
+/** @internal */
+export const SubscriptionIntervalKind$inboundSchema: z.ZodNativeEnum<
+  typeof SubscriptionIntervalKind
+> = z.nativeEnum(SubscriptionIntervalKind);
+
+/** @internal */
+export const SubscriptionIntervalQuantityTransition$inboundSchema: z.ZodType<
+  SubscriptionIntervalQuantityTransition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  effectiveDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  quantity: z.string(),
+});
+
+export function subscriptionIntervalQuantityTransitionFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionIntervalQuantityTransition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscriptionIntervalQuantityTransition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionIntervalQuantityTransition' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubscriptionIntervalBillingMode$inboundSchema: z.ZodNativeEnum<
+  typeof SubscriptionIntervalBillingMode
+> = z.nativeEnum(SubscriptionIntervalBillingMode);
+
+/** @internal */
+export const SubscriptionInterval$inboundSchema: z.ZodType<
+  SubscriptionInterval,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  priceId: z.string(),
+  priceKey: z.string(),
+  kind: SubscriptionIntervalKind$inboundSchema,
+  planVersionId: z.string(),
+  unitPrice: z.nullable(z.string()),
+  baseQuantity: z.string(),
+  quantityTransitions: z.array(
+    z.lazy(() => SubscriptionIntervalQuantityTransition$inboundSchema),
+  ),
+  billingCadence: z.string(),
+  billingMode: SubscriptionIntervalBillingMode$inboundSchema,
+  billDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  startDate: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  endDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+});
+
+export function subscriptionIntervalFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionInterval, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionInterval$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionInterval' from JSON`,
+  );
+}

package/src/models/subscriptionintervaladdop.ts

@@ -0,0 +1,148 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export type SubscriptionIntervalAddOpQuantityTransition = {
+  effectiveDate: Date;
+  /**
+   * Non-negative decimal string.
+   */
+  quantity: string;
+};
+
+export const SubscriptionIntervalAddOpBillingMode = {
+  Advance: "advance",
+  Arrears: "arrears",
+} as const;
+export type SubscriptionIntervalAddOpBillingMode = ClosedEnum<
+  typeof SubscriptionIntervalAddOpBillingMode
+>;
+
+/**
+ * Adds an interval. If the plan version has a line with this priceKey, the interval overrides that line. If not, send priceId. The interval then belongs to this subscription only and keeps the rate that you write. A plan version change does not carry it forward, so it stops billing at the version boundary. If a later plan version adds the same priceKey, the change is refused until the plan drops the key or the interval ends on or before the boundary.
+ */
+export type SubscriptionIntervalAddOp = {
+  /**
+   * The price line that this interval bills. Use a priceKey from the plan version. A new key must start with a lowercase letter or a digit, use only lowercase letters, digits, hyphens, and underscores, and have 64 characters or fewer.
+   */
+  priceKey: string;
+  /**
+   * The catalog price to bill. Required if priceKey is not on the plan version. If it is on the plan, omit this field or send the price of that line. The price must belong to your merchant account.
+   */
+  priceId?: string | undefined;
+  /**
+   * Optional. If the subscription is on a different plan version, the request fails with 409.
+   */
+  planVersionId?: string | undefined;
+  /**
+   * Signed net unit price for each period, as a decimal string. Null bills the catalog price. For a subscription-only interval, null saves the current catalog price.
+   */
+  unitPrice: string | null;
+  /**
+   * Quantity at interval start, as a non-negative decimal string.
+   */
+  baseQuantity: string;
+  /**
+   * Step changes in quantity partway through the interval.
+   */
+  quantityTransitions?:
+    | Array<SubscriptionIntervalAddOpQuantityTransition>
+    | undefined;
+  /**
+   * ISO-8601 duration or 'one_off'
+   */
+  billingCadence: string;
+  billingMode: SubscriptionIntervalAddOpBillingMode;
+  /**
+   * Required when billingCadence is 'one_off'; must be absent otherwise.
+   */
+  billDate?: Date | null | undefined;
+  startDate: Date;
+  /**
+   * Null for an open-ended interval; when set, must be strictly after startDate.
+   */
+  endDate?: Date | null | undefined;
+};
+
+/** @internal */
+export type SubscriptionIntervalAddOpQuantityTransition$Outbound = {
+  effectiveDate: string;
+  quantity: string;
+};
+
+/** @internal */
+export const SubscriptionIntervalAddOpQuantityTransition$outboundSchema:
+  z.ZodType<
+    SubscriptionIntervalAddOpQuantityTransition$Outbound,
+    z.ZodTypeDef,
+    SubscriptionIntervalAddOpQuantityTransition
+  > = z.object({
+    effectiveDate: z.date().transform(v => v.toISOString()),
+    quantity: z.string(),
+  });
+
+export function subscriptionIntervalAddOpQuantityTransitionToJSON(
+  subscriptionIntervalAddOpQuantityTransition:
+    SubscriptionIntervalAddOpQuantityTransition,
+): string {
+  return JSON.stringify(
+    SubscriptionIntervalAddOpQuantityTransition$outboundSchema.parse(
+      subscriptionIntervalAddOpQuantityTransition,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscriptionIntervalAddOpBillingMode$outboundSchema:
+  z.ZodNativeEnum<typeof SubscriptionIntervalAddOpBillingMode> = z.nativeEnum(
+    SubscriptionIntervalAddOpBillingMode,
+  );
+
+/** @internal */
+export type SubscriptionIntervalAddOp$Outbound = {
+  priceKey: string;
+  priceId?: string | undefined;
+  planVersionId?: string | undefined;
+  unitPrice: string | null;
+  baseQuantity: string;
+  quantityTransitions?:
+    | Array<SubscriptionIntervalAddOpQuantityTransition$Outbound>
+    | undefined;
+  billingCadence: string;
+  billingMode: string;
+  billDate?: string | null | undefined;
+  startDate: string;
+  endDate?: string | null | undefined;
+};
+
+/** @internal */
+export const SubscriptionIntervalAddOp$outboundSchema: z.ZodType<
+  SubscriptionIntervalAddOp$Outbound,
+  z.ZodTypeDef,
+  SubscriptionIntervalAddOp
+> = z.object({
+  priceKey: z.string(),
+  priceId: z.string().optional(),
+  planVersionId: z.string().optional(),
+  unitPrice: z.nullable(z.string()),
+  baseQuantity: z.string(),
+  quantityTransitions: z.array(
+    z.lazy(() => SubscriptionIntervalAddOpQuantityTransition$outboundSchema),
+  ).optional(),
+  billingCadence: z.string(),
+  billingMode: SubscriptionIntervalAddOpBillingMode$outboundSchema,
+  billDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  startDate: z.date().transform(v => v.toISOString()),
+  endDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+});
+
+export function subscriptionIntervalAddOpToJSON(
+  subscriptionIntervalAddOp: SubscriptionIntervalAddOp,
+): string {
+  return JSON.stringify(
+    SubscriptionIntervalAddOp$outboundSchema.parse(subscriptionIntervalAddOp),
+  );
+}