@moovio/sdk 26.5.0 → 26.5.3

package/src/models/components/onboardinginviterequest.ts

@@ -50,7 +50,7 @@ export type OnboardingInviteRequest = {
    */
   grantScopes?: Array<ApplicationScope> | undefined;
   /**
-   *   List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this
+   *   List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/reference/) you intend to request for this
    *
    * @remarks
    *   account. These values are used to determine what information to collect from the user during onboarding.

package/src/models/components/patchtransfer.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PatchTransfer = {
+  /**
+   * Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
+   */
   metadata?: { [k: string]: string } | null | undefined;
   /**
    * Optional alias from a foreign/external system which can be used to reference this resource.

package/src/models/components/paymentlink.ts

@@ -92,8 +92,8 @@ export type PaymentLink = {
    *
    * In API versions before `2026.07.00`, this was a required field.
    *
-   * In API version `2026.07.00` and beyond, this field is required for `fixed` payment amount types and omitted
-   * for `open` payment amount types.
+   * In API version `2026.07.00` and beyond, this field is present for `payment` and `payout` links and omitted
+   * for `customAmountPayment` links, where the payor chooses the amount.
    */
   amount: Amount;
   /**

package/src/models/components/paymentlinkpayoutdetails.ts

@@ -17,6 +17,12 @@ import {
   PayoutRecipient$Outbound,
   PayoutRecipient$outboundSchema,
 } from "./payoutrecipient.js";
+import {
+  PushOptions,
+  PushOptions$inboundSchema,
+  PushOptions$Outbound,
+  PushOptions$outboundSchema,
+} from "./pushoptions.js";
 
 export type PaymentLinkPayoutDetails = {
   /**
@@ -36,6 +42,15 @@ export type PaymentLinkPayoutDetails = {
    * Optional free-form metadata for the transfer.
    */
   metadata?: { [k: string]: string } | undefined;
+  /**
+   * Delivery options for push-to-card payouts. Only applies when `allowedMethods` includes `push-to-card`.
+   *
+   * @remarks
+   *
+   * The `deferred` speed and `deferredBy` apply to `push-to-card` only. Other push methods
+   * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
+   */
+  pushOptions?: PushOptions | undefined;
 };
 
 /** @internal */
@@ -47,12 +62,14 @@ export const PaymentLinkPayoutDetails$inboundSchema: z.ZodType<
   allowedMethods: z.array(DisbursementPaymentMethodType$inboundSchema),
   recipient: PayoutRecipient$inboundSchema,
   metadata: z.record(z.string()).optional(),
+  pushOptions: PushOptions$inboundSchema.optional(),
 });
 /** @internal */
 export type PaymentLinkPayoutDetails$Outbound = {
   allowedMethods: Array<string>;
   recipient: PayoutRecipient$Outbound;
   metadata?: { [k: string]: string } | undefined;
+  pushOptions?: PushOptions$Outbound | undefined;
 };
 
 /** @internal */
@@ -64,6 +81,7 @@ export const PaymentLinkPayoutDetails$outboundSchema: z.ZodType<
   allowedMethods: z.array(DisbursementPaymentMethodType$outboundSchema),
   recipient: PayoutRecipient$outboundSchema,
   metadata: z.record(z.string()).optional(),
+  pushOptions: PushOptions$outboundSchema.optional(),
 });
 
 export function paymentLinkPayoutDetailsToJSON(

package/src/models/components/paymentlinkpayoutdetailsupdate.ts

@@ -17,6 +17,12 @@ import {
   PayoutRecipient$Outbound,
   PayoutRecipient$outboundSchema,
 } from "./payoutrecipient.js";
+import {
+  PushOptionsUpdate,
+  PushOptionsUpdate$inboundSchema,
+  PushOptionsUpdate$Outbound,
+  PushOptionsUpdate$outboundSchema,
+} from "./pushoptionsupdate.js";
 
 export type PaymentLinkPayoutDetailsUpdate = {
   /**
@@ -36,6 +42,15 @@ export type PaymentLinkPayoutDetailsUpdate = {
    * Optional free-form metadata for the transfer.
    */
   metadata?: { [k: string]: string } | undefined;
+  /**
+   * Delivery options for push-to-card payouts. Only applies when `allowedMethods` includes `push-to-card`.
+   *
+   * @remarks
+   *
+   * The `deferred` speed and `deferredBy` apply to `push-to-card` only. Other push methods
+   * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
+   */
+  pushOptions?: PushOptionsUpdate | undefined;
 };
 
 /** @internal */
@@ -48,12 +63,14 @@ export const PaymentLinkPayoutDetailsUpdate$inboundSchema: z.ZodType<
     .optional(),
   recipient: PayoutRecipient$inboundSchema.optional(),
   metadata: z.record(z.string()).optional(),
+  pushOptions: PushOptionsUpdate$inboundSchema.optional(),
 });
 /** @internal */
 export type PaymentLinkPayoutDetailsUpdate$Outbound = {
   allowedMethods?: Array<string> | undefined;
   recipient?: PayoutRecipient$Outbound | undefined;
   metadata?: { [k: string]: string } | undefined;
+  pushOptions?: PushOptionsUpdate$Outbound | undefined;
 };
 
 /** @internal */
@@ -66,6 +83,7 @@ export const PaymentLinkPayoutDetailsUpdate$outboundSchema: z.ZodType<
     .optional(),
   recipient: PayoutRecipient$outboundSchema.optional(),
   metadata: z.record(z.string()).optional(),
+  pushOptions: PushOptionsUpdate$outboundSchema.optional(),
 });
 
 export function paymentLinkPayoutDetailsUpdateToJSON(

package/src/models/components/payoutdetailserror.ts

@@ -12,11 +12,18 @@ import {
   PayoutRecipientError$Outbound,
   PayoutRecipientError$outboundSchema,
 } from "./payoutrecipienterror.js";
+import {
+  PushOptionsError,
+  PushOptionsError$inboundSchema,
+  PushOptionsError$Outbound,
+  PushOptionsError$outboundSchema,
+} from "./pushoptionserror.js";
 
 export type PayoutDetailsError = {
   allowedMethods?: string | undefined;
   recipient?: PayoutRecipientError | undefined;
   metadata?: string | undefined;
+  pushOptions?: PushOptionsError | undefined;
 };
 
 /** @internal */
@@ -28,12 +35,14 @@ export const PayoutDetailsError$inboundSchema: z.ZodType<
   allowedMethods: z.string().optional(),
   recipient: PayoutRecipientError$inboundSchema.optional(),
   metadata: z.string().optional(),
+  pushOptions: PushOptionsError$inboundSchema.optional(),
 });
 /** @internal */
 export type PayoutDetailsError$Outbound = {
   allowedMethods?: string | undefined;
   recipient?: PayoutRecipientError$Outbound | undefined;
   metadata?: string | undefined;
+  pushOptions?: PushOptionsError$Outbound | undefined;
 };
 
 /** @internal */
@@ -45,6 +54,7 @@ export const PayoutDetailsError$outboundSchema: z.ZodType<
   allowedMethods: z.string().optional(),
   recipient: PayoutRecipientError$outboundSchema.optional(),
   metadata: z.string().optional(),
+  pushOptions: PushOptionsError$outboundSchema.optional(),
 });
 
 export function payoutDetailsErrorToJSON(

package/src/models/components/pushdeliveryspeed.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Delivery speed options for push-to-card payouts.
+ */
+export const PushDeliverySpeed = {
+  Instant: "instant",
+  Deferred: "deferred",
+} as const;
+/**
+ * Delivery speed options for push-to-card payouts.
+ */
+export type PushDeliverySpeed = ClosedEnum<typeof PushDeliverySpeed>;
+
+/** @internal */
+export const PushDeliverySpeed$inboundSchema: z.ZodNativeEnum<
+  typeof PushDeliverySpeed
+> = z.nativeEnum(PushDeliverySpeed);
+/** @internal */
+export const PushDeliverySpeed$outboundSchema: z.ZodNativeEnum<
+  typeof PushDeliverySpeed
+> = PushDeliverySpeed$inboundSchema;

package/src/models/components/pushoptions.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 {
+  PushDeliverySpeed,
+  PushDeliverySpeed$inboundSchema,
+  PushDeliverySpeed$outboundSchema,
+} from "./pushdeliveryspeed.js";
+
+/**
+ * Delivery options for push-to-card payouts.
+ */
+export type PushOptions = {
+  /**
+   * Delivery speeds the recipient may choose from for `push-to-card`. Include `instant` to allow immediate
+   *
+   * @remarks
+   * delivery, `deferred` to allow delayed delivery, or both to let the recipient choose at checkout.
+   */
+  allowedSpeeds: Array<PushDeliverySpeed>;
+  /**
+   * Delay before delivering a deferred `push-to-card` payout. Required when `allowedSpeeds` includes `deferred`.
+   *
+   * @remarks
+   * Accepted values are `24h` or `48h`.
+   */
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptions$inboundSchema: z.ZodType<
+  PushOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allowedSpeeds: z.array(PushDeliverySpeed$inboundSchema),
+  deferredBy: z.string().optional(),
+});
+/** @internal */
+export type PushOptions$Outbound = {
+  allowedSpeeds: Array<string>;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptions$outboundSchema: z.ZodType<
+  PushOptions$Outbound,
+  z.ZodTypeDef,
+  PushOptions
+> = z.object({
+  allowedSpeeds: z.array(PushDeliverySpeed$outboundSchema),
+  deferredBy: z.string().optional(),
+});
+
+export function pushOptionsToJSON(pushOptions: PushOptions): string {
+  return JSON.stringify(PushOptions$outboundSchema.parse(pushOptions));
+}
+export function pushOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<PushOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushOptions' from JSON`,
+  );
+}

package/src/models/components/pushoptionserror.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 PushOptionsError = {
+  allowedSpeeds?: string | undefined;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsError$inboundSchema: z.ZodType<
+  PushOptionsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allowedSpeeds: z.string().optional(),
+  deferredBy: z.string().optional(),
+});
+/** @internal */
+export type PushOptionsError$Outbound = {
+  allowedSpeeds?: string | undefined;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsError$outboundSchema: z.ZodType<
+  PushOptionsError$Outbound,
+  z.ZodTypeDef,
+  PushOptionsError
+> = z.object({
+  allowedSpeeds: z.string().optional(),
+  deferredBy: z.string().optional(),
+});
+
+export function pushOptionsErrorToJSON(
+  pushOptionsError: PushOptionsError,
+): string {
+  return JSON.stringify(
+    PushOptionsError$outboundSchema.parse(pushOptionsError),
+  );
+}
+export function pushOptionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PushOptionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushOptionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushOptionsError' from JSON`,
+  );
+}

package/src/models/components/pushoptionsupdate.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 {
+  PushDeliverySpeed,
+  PushDeliverySpeed$inboundSchema,
+  PushDeliverySpeed$outboundSchema,
+} from "./pushdeliveryspeed.js";
+
+/**
+ * Delivery options for push-to-card payouts.
+ */
+export type PushOptionsUpdate = {
+  /**
+   * Delivery speeds the recipient may choose from for `push-to-card`. Include `instant` to allow immediate
+   *
+   * @remarks
+   * delivery, `deferred` to allow delayed delivery, or both to let the recipient choose at checkout.
+   */
+  allowedSpeeds?: Array<PushDeliverySpeed> | undefined;
+  /**
+   * Delay before delivering a deferred `push-to-card` payout. Required when `allowedSpeeds` includes `deferred`.
+   *
+   * @remarks
+   * Accepted values are `24h` or `48h`.
+   */
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsUpdate$inboundSchema: z.ZodType<
+  PushOptionsUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allowedSpeeds: z.array(PushDeliverySpeed$inboundSchema).optional(),
+  deferredBy: z.string().optional(),
+});
+/** @internal */
+export type PushOptionsUpdate$Outbound = {
+  allowedSpeeds?: Array<string> | undefined;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsUpdate$outboundSchema: z.ZodType<
+  PushOptionsUpdate$Outbound,
+  z.ZodTypeDef,
+  PushOptionsUpdate
+> = z.object({
+  allowedSpeeds: z.array(PushDeliverySpeed$outboundSchema).optional(),
+  deferredBy: z.string().optional(),
+});
+
+export function pushOptionsUpdateToJSON(
+  pushOptionsUpdate: PushOptionsUpdate,
+): string {
+  return JSON.stringify(
+    PushOptionsUpdate$outboundSchema.parse(pushOptionsUpdate),
+  );
+}
+export function pushOptionsUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<PushOptionsUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushOptionsUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushOptionsUpdate' from JSON`,
+  );
+}

package/src/models/components/requestcard.ts

@@ -6,23 +6,18 @@ 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 {
+  Address,
+  Address$inboundSchema,
+  Address$Outbound,
+  Address$outboundSchema,
+} from "./address.js";
 import {
   CardExpiration,
   CardExpiration$inboundSchema,
   CardExpiration$Outbound,
   CardExpiration$outboundSchema,
 } from "./cardexpiration.js";
-import {
-  CreateAuthorizedUser,
-  CreateAuthorizedUser$inboundSchema,
-  CreateAuthorizedUser$Outbound,
-  CreateAuthorizedUser$outboundSchema,
-} from "./createauthorizeduser.js";
-import {
-  IssuedCardFormFactor,
-  IssuedCardFormFactor$inboundSchema,
-  IssuedCardFormFactor$outboundSchema,
-} from "./issuedcardformfactor.js";
 import {
   IssuingControls,
   IssuingControls$inboundSchema,
@@ -31,19 +26,13 @@ import {
 } from "./issuingcontrols.js";
 
 export type RequestCard = {
-  fundingWalletID: string;
-  /**
-   * Fields for identifying an authorized individual.
-   */
-  authorizedUser: CreateAuthorizedUser;
-  /**
-   * Specifies the type of spend card to be issued. Presently supports virtual only, providing a digital number without a physical card.
-   */
-  formFactor: IssuedCardFormFactor;
+  authorizedUserAccountID?: string | undefined;
+  nickname?: string | undefined;
   /**
-   * An optional descriptive name for the card.
+   * Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
    */
-  memo?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  billingAddress?: Address | undefined;
   /**
    * The expiration date of the card or token.
    */
@@ -57,19 +46,19 @@ export const RequestCard$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  fundingWalletID: z.string(),
-  authorizedUser: CreateAuthorizedUser$inboundSchema,
-  formFactor: IssuedCardFormFactor$inboundSchema,
-  memo: z.string().optional(),
+  authorizedUserAccountID: z.string().optional(),
+  nickname: z.string().optional(),
+  metadata: z.record(z.string()).optional(),
+  billingAddress: Address$inboundSchema.optional(),
   expiration: CardExpiration$inboundSchema.optional(),
   controls: IssuingControls$inboundSchema.optional(),
 });
 /** @internal */
 export type RequestCard$Outbound = {
-  fundingWalletID: string;
-  authorizedUser: CreateAuthorizedUser$Outbound;
-  formFactor: string;
-  memo?: string | undefined;
+  authorizedUserAccountID?: string | undefined;
+  nickname?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  billingAddress?: Address$Outbound | undefined;
   expiration?: CardExpiration$Outbound | undefined;
   controls?: IssuingControls$Outbound | undefined;
 };
@@ -80,10 +69,10 @@ export const RequestCard$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RequestCard
 > = z.object({
-  fundingWalletID: z.string(),
-  authorizedUser: CreateAuthorizedUser$outboundSchema,
-  formFactor: IssuedCardFormFactor$outboundSchema,
-  memo: z.string().optional(),
+  authorizedUserAccountID: z.string().optional(),
+  nickname: z.string().optional(),
+  metadata: z.record(z.string()).optional(),
+  billingAddress: Address$outboundSchema.optional(),
   expiration: CardExpiration$outboundSchema.optional(),
   controls: IssuingControls$outboundSchema.optional(),
 });

package/src/models/components/termsofservice.ts

@@ -16,7 +16,7 @@ export type TermsOfService = {
    */
   acceptedDate: Date;
   /**
-   * The IP address from which the terms of service were accepted.
+   * The IP address (IPv4 or IPv6) from which the terms of service were accepted.
    */
   acceptedIP: string;
 };

package/src/models/components/transferconfig.ts

@@ -12,6 +12,12 @@ import {
   TipPresets$Outbound,
   TipPresets$outboundSchema,
 } from "./tippresets.js";
+import {
+  TransferControls,
+  TransferControls$inboundSchema,
+  TransferControls$Outbound,
+  TransferControls$outboundSchema,
+} from "./transfercontrols.js";
 
 /**
  * Configurable options for a transfer.
@@ -21,6 +27,7 @@ export type TransferConfig = {
    * Tip presets when calculating tips for a transfer.
    */
   tipPresets?: TipPresets | undefined;
+  transferControls?: Array<TransferControls> | undefined;
 };
 
 /** @internal */
@@ -30,10 +37,12 @@ export const TransferConfig$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   tipPresets: TipPresets$inboundSchema.optional(),
+  transferControls: z.array(TransferControls$inboundSchema).optional(),
 });
 /** @internal */
 export type TransferConfig$Outbound = {
   tipPresets?: TipPresets$Outbound | undefined;
+  transferControls?: Array<TransferControls$Outbound> | undefined;
 };
 
 /** @internal */
@@ -43,6 +52,7 @@ export const TransferConfig$outboundSchema: z.ZodType<
   TransferConfig
 > = z.object({
   tipPresets: TipPresets$outboundSchema.optional(),
+  transferControls: z.array(TransferControls$outboundSchema).optional(),
 });
 
 export function transferConfigToJSON(transferConfig: TransferConfig): string {

package/src/models/components/transfercontrols.ts

@@ -0,0 +1,85 @@
+/*
+ * 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";
+
+/**
+ * Controls for transfers created through a given partner
+ */
+export type TransferControls = {
+  /**
+   * ID of the merchant account.
+   */
+  accountID: string;
+  /**
+   * ID of the partner account.
+   */
+  partnerAccountID: string;
+  /**
+   * Indicates if the account is configured for debt repayment.
+   */
+  debtRepayment: boolean;
+  /**
+   * Indicates if the account is allowed to set dynamic descriptors on transfers.
+   */
+  allowDynamicDescriptor: boolean;
+  /**
+   * Indicates if the account is allowed to apply surcharges to transfers.
+   */
+  allowSurcharge: boolean;
+};
+
+/** @internal */
+export const TransferControls$inboundSchema: z.ZodType<
+  TransferControls,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  partnerAccountID: z.string(),
+  debtRepayment: z.boolean(),
+  allowDynamicDescriptor: z.boolean(),
+  allowSurcharge: z.boolean(),
+});
+/** @internal */
+export type TransferControls$Outbound = {
+  accountID: string;
+  partnerAccountID: string;
+  debtRepayment: boolean;
+  allowDynamicDescriptor: boolean;
+  allowSurcharge: boolean;
+};
+
+/** @internal */
+export const TransferControls$outboundSchema: z.ZodType<
+  TransferControls$Outbound,
+  z.ZodTypeDef,
+  TransferControls
+> = z.object({
+  accountID: z.string(),
+  partnerAccountID: z.string(),
+  debtRepayment: z.boolean(),
+  allowDynamicDescriptor: z.boolean(),
+  allowSurcharge: z.boolean(),
+});
+
+export function transferControlsToJSON(
+  transferControls: TransferControls,
+): string {
+  return JSON.stringify(
+    TransferControls$outboundSchema.parse(transferControls),
+  );
+}
+export function transferControlsFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferControls, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferControls$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferControls' from JSON`,
+  );
+}

package/src/models/components/updateinvoice.ts

@@ -33,14 +33,14 @@ export type UpdateInvoice = {
   invoiceDate?: Date | null | undefined;
   dueDate?: Date | null | undefined;
   /**
-   * The status can be updated to one of the following values under specific conditions:
+   *   The status can be updated to one of the following values under specific conditions:
    *
    * @remarks
-   * - `canceled`: Can only be set if the current status is `draft`, `unpaid`, or `overdue`. Canceling an invoice
-   *   indicates the invoice is no longer expected to be paid (e.g., the charge was waived or terms changed).
-   *   Canceled invoices still appear in list results by default and remain part of the invoice history.
-   *   To completely discard an invoice created by mistake, use the delete endpoint instead.
-   * - `unpaid`: Can only be set if the current status is `draft`. Setting the status to `unpaid` finalizes the invoice and sends an email with a payment link to the customer.
+   *   - `canceled`: Can only be set if the current status is `draft`, `unpaid`, or `overdue`. Canceling an invoice
+   *     indicates the invoice is no longer expected to be paid (e.g., the charge was waived or terms changed).
+   *     Canceled invoices still appear in list results by default and remain part of the invoice history.
+   *     To completely discard an invoice created by mistake, use the delete endpoint instead.
+   *   - `unpaid`: Can only be set if the current status is `draft`. Setting the status to `unpaid` finalizes the invoice and sends an email with a payment link to the customer.
    */
   status?: InvoiceStatus | undefined;
   taxAmount?: AmountDecimalUpdate | undefined;