@polar-sh/sdk 0.19.2 → 0.20.1

package/src/models/components/customerbenefitgrantgithubrepository.ts

@@ -19,6 +19,12 @@ import {
   BenefitGrantGitHubRepositoryProperties$Outbound,
   BenefitGrantGitHubRepositoryProperties$outboundSchema,
 } from "./benefitgrantgithubrepositoryproperties.js";
+import {
+  CustomerPortalCustomer,
+  CustomerPortalCustomer$inboundSchema,
+  CustomerPortalCustomer$Outbound,
+  CustomerPortalCustomer$outboundSchema,
+} from "./customerportalcustomer.js";
 
 export type CustomerBenefitGrantGitHubRepository = {
   /**
@@ -41,6 +47,7 @@ export type CustomerBenefitGrantGitHubRepository = {
   orderId: string | null;
   isGranted: boolean;
   isRevoked: boolean;
+  customer: CustomerPortalCustomer;
   benefit: BenefitGitHubRepositorySubscriber;
   properties: BenefitGrantGitHubRepositoryProperties;
 };
@@ -68,6 +75,7 @@ export const CustomerBenefitGrantGitHubRepository$inboundSchema: z.ZodType<
   order_id: z.nullable(z.string()),
   is_granted: z.boolean(),
   is_revoked: z.boolean(),
+  customer: CustomerPortalCustomer$inboundSchema,
   benefit: BenefitGitHubRepositorySubscriber$inboundSchema,
   properties: BenefitGrantGitHubRepositoryProperties$inboundSchema,
 }).transform((v) => {
@@ -98,6 +106,7 @@ export type CustomerBenefitGrantGitHubRepository$Outbound = {
   order_id: string | null;
   is_granted: boolean;
   is_revoked: boolean;
+  customer: CustomerPortalCustomer$Outbound;
   benefit: BenefitGitHubRepositorySubscriber$Outbound;
   properties: BenefitGrantGitHubRepositoryProperties$Outbound;
 };
@@ -119,6 +128,7 @@ export const CustomerBenefitGrantGitHubRepository$outboundSchema: z.ZodType<
   orderId: z.nullable(z.string()),
   isGranted: z.boolean(),
   isRevoked: z.boolean(),
+  customer: CustomerPortalCustomer$outboundSchema,
   benefit: BenefitGitHubRepositorySubscriber$outboundSchema,
   properties: BenefitGrantGitHubRepositoryProperties$outboundSchema,
 }).transform((v) => {

package/src/models/components/customerbenefitgrantgithubrepositoryupdate.ts

@@ -5,7 +5,6 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 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";
 import {
@@ -15,43 +14,11 @@ import {
   CustomerBenefitGrantGitHubRepositoryPropertiesUpdate$outboundSchema,
 } from "./customerbenefitgrantgithubrepositorypropertiesupdate.js";
 
-export const CustomerBenefitGrantGitHubRepositoryUpdateBenefitType = {
-  GithubRepository: "github_repository",
-} as const;
-export type CustomerBenefitGrantGitHubRepositoryUpdateBenefitType = ClosedEnum<
-  typeof CustomerBenefitGrantGitHubRepositoryUpdateBenefitType
->;
-
 export type CustomerBenefitGrantGitHubRepositoryUpdate = {
   benefitType?: "github_repository" | undefined;
   properties: CustomerBenefitGrantGitHubRepositoryPropertiesUpdate;
 };
 
-/** @internal */
-export const CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$inboundSchema:
-  z.ZodNativeEnum<
-    typeof CustomerBenefitGrantGitHubRepositoryUpdateBenefitType
-  > = z.nativeEnum(CustomerBenefitGrantGitHubRepositoryUpdateBenefitType);
-
-/** @internal */
-export const CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$outboundSchema:
-  z.ZodNativeEnum<
-    typeof CustomerBenefitGrantGitHubRepositoryUpdateBenefitType
-  > = CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$ {
-  /** @deprecated use `CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$inboundSchema` instead. */
-  export const inboundSchema =
-    CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$inboundSchema;
-  /** @deprecated use `CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$outboundSchema` instead. */
-  export const outboundSchema =
-    CustomerBenefitGrantGitHubRepositoryUpdateBenefitType$outboundSchema;
-}
-
 /** @internal */
 export const CustomerBenefitGrantGitHubRepositoryUpdate$inboundSchema:
   z.ZodType<CustomerBenefitGrantGitHubRepositoryUpdate, z.ZodTypeDef, unknown> =
@@ -78,7 +45,9 @@ export const CustomerBenefitGrantGitHubRepositoryUpdate$outboundSchema:
     z.ZodTypeDef,
     CustomerBenefitGrantGitHubRepositoryUpdate
   > = z.object({
-    benefitType: z.literal("github_repository").default("github_repository"),
+    benefitType: z.literal("github_repository").default(
+      "github_repository" as const,
+    ),
     properties:
       CustomerBenefitGrantGitHubRepositoryPropertiesUpdate$outboundSchema,
   }).transform((v) => {

package/src/models/components/customerbenefitgrantlicensekeys.ts

@@ -19,6 +19,12 @@ import {
   BenefitLicenseKeysSubscriber$Outbound,
   BenefitLicenseKeysSubscriber$outboundSchema,
 } from "./benefitlicensekeyssubscriber.js";
+import {
+  CustomerPortalCustomer,
+  CustomerPortalCustomer$inboundSchema,
+  CustomerPortalCustomer$Outbound,
+  CustomerPortalCustomer$outboundSchema,
+} from "./customerportalcustomer.js";
 
 export type CustomerBenefitGrantLicenseKeys = {
   /**
@@ -41,6 +47,7 @@ export type CustomerBenefitGrantLicenseKeys = {
   orderId: string | null;
   isGranted: boolean;
   isRevoked: boolean;
+  customer: CustomerPortalCustomer;
   benefit: BenefitLicenseKeysSubscriber;
   properties: BenefitGrantLicenseKeysProperties;
 };
@@ -68,6 +75,7 @@ export const CustomerBenefitGrantLicenseKeys$inboundSchema: z.ZodType<
   order_id: z.nullable(z.string()),
   is_granted: z.boolean(),
   is_revoked: z.boolean(),
+  customer: CustomerPortalCustomer$inboundSchema,
   benefit: BenefitLicenseKeysSubscriber$inboundSchema,
   properties: BenefitGrantLicenseKeysProperties$inboundSchema,
 }).transform((v) => {
@@ -98,6 +106,7 @@ export type CustomerBenefitGrantLicenseKeys$Outbound = {
   order_id: string | null;
   is_granted: boolean;
   is_revoked: boolean;
+  customer: CustomerPortalCustomer$Outbound;
   benefit: BenefitLicenseKeysSubscriber$Outbound;
   properties: BenefitGrantLicenseKeysProperties$Outbound;
 };
@@ -119,6 +128,7 @@ export const CustomerBenefitGrantLicenseKeys$outboundSchema: z.ZodType<
   orderId: z.nullable(z.string()),
   isGranted: z.boolean(),
   isRevoked: z.boolean(),
+  customer: CustomerPortalCustomer$outboundSchema,
   benefit: BenefitLicenseKeysSubscriber$outboundSchema,
   properties: BenefitGrantLicenseKeysProperties$outboundSchema,
 }).transform((v) => {

package/src/models/components/customerbenefitgrantlicensekeysupdate.ts

@@ -5,44 +5,13 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 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";
 
-export const CustomerBenefitGrantLicenseKeysUpdateBenefitType = {
-  LicenseKeys: "license_keys",
-} as const;
-export type CustomerBenefitGrantLicenseKeysUpdateBenefitType = ClosedEnum<
-  typeof CustomerBenefitGrantLicenseKeysUpdateBenefitType
->;
-
 export type CustomerBenefitGrantLicenseKeysUpdate = {
   benefitType?: "license_keys" | undefined;
 };
 
-/** @internal */
-export const CustomerBenefitGrantLicenseKeysUpdateBenefitType$inboundSchema:
-  z.ZodNativeEnum<typeof CustomerBenefitGrantLicenseKeysUpdateBenefitType> = z
-    .nativeEnum(CustomerBenefitGrantLicenseKeysUpdateBenefitType);
-
-/** @internal */
-export const CustomerBenefitGrantLicenseKeysUpdateBenefitType$outboundSchema:
-  z.ZodNativeEnum<typeof CustomerBenefitGrantLicenseKeysUpdateBenefitType> =
-    CustomerBenefitGrantLicenseKeysUpdateBenefitType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CustomerBenefitGrantLicenseKeysUpdateBenefitType$ {
-  /** @deprecated use `CustomerBenefitGrantLicenseKeysUpdateBenefitType$inboundSchema` instead. */
-  export const inboundSchema =
-    CustomerBenefitGrantLicenseKeysUpdateBenefitType$inboundSchema;
-  /** @deprecated use `CustomerBenefitGrantLicenseKeysUpdateBenefitType$outboundSchema` instead. */
-  export const outboundSchema =
-    CustomerBenefitGrantLicenseKeysUpdateBenefitType$outboundSchema;
-}
-
 /** @internal */
 export const CustomerBenefitGrantLicenseKeysUpdate$inboundSchema: z.ZodType<
   CustomerBenefitGrantLicenseKeysUpdate,
@@ -67,7 +36,7 @@ export const CustomerBenefitGrantLicenseKeysUpdate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CustomerBenefitGrantLicenseKeysUpdate
 > = z.object({
-  benefitType: z.literal("license_keys").default("license_keys"),
+  benefitType: z.literal("license_keys").default("license_keys" as const),
 }).transform((v) => {
   return remap$(v, {
     benefitType: "benefit_type",

package/src/models/components/customercancellationreason.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const CustomerCancellationReason = {
+  CustomerService: "customer_service",
+  LowQuality: "low_quality",
+  MissingFeatures: "missing_features",
+  SwitchedService: "switched_service",
+  TooComplex: "too_complex",
+  TooExpensive: "too_expensive",
+  Unused: "unused",
+  Other: "other",
+} as const;
+export type CustomerCancellationReason = ClosedEnum<
+  typeof CustomerCancellationReason
+>;
+
+/** @internal */
+export const CustomerCancellationReason$inboundSchema: z.ZodNativeEnum<
+  typeof CustomerCancellationReason
+> = z.nativeEnum(CustomerCancellationReason);
+
+/** @internal */
+export const CustomerCancellationReason$outboundSchema: z.ZodNativeEnum<
+  typeof CustomerCancellationReason
+> = CustomerCancellationReason$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerCancellationReason$ {
+  /** @deprecated use `CustomerCancellationReason$inboundSchema` instead. */
+  export const inboundSchema = CustomerCancellationReason$inboundSchema;
+  /** @deprecated use `CustomerCancellationReason$outboundSchema` instead. */
+  export const outboundSchema = CustomerCancellationReason$outboundSchema;
+}

package/src/models/components/customerordersubscription.ts

@@ -7,6 +7,11 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomerCancellationReason,
+  CustomerCancellationReason$inboundSchema,
+  CustomerCancellationReason$outboundSchema,
+} from "./customercancellationreason.js";
 import {
   SubscriptionRecurringInterval,
   SubscriptionRecurringInterval$inboundSchema,
@@ -38,13 +43,17 @@ export type CustomerOrderSubscription = {
   currentPeriodStart: Date;
   currentPeriodEnd: Date | null;
   cancelAtPeriodEnd: boolean;
+  canceledAt: Date | null;
   startedAt: Date | null;
+  endsAt: Date | null;
   endedAt: Date | null;
   customerId: string;
   productId: string;
   priceId: string;
   discountId: string | null;
   checkoutId: string | null;
+  customerCancellationReason: CustomerCancellationReason | null;
+  customerCancellationComment: string | null;
 };
 
 /** @internal */
@@ -69,9 +78,15 @@ export const CustomerOrderSubscription$inboundSchema: z.ZodType<
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
   cancel_at_period_end: z.boolean(),
+  canceled_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   started_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
+  ends_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   ended_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
@@ -80,6 +95,10 @@ export const CustomerOrderSubscription$inboundSchema: z.ZodType<
   price_id: z.string(),
   discount_id: z.nullable(z.string()),
   checkout_id: z.nullable(z.string()),
+  customer_cancellation_reason: z.nullable(
+    CustomerCancellationReason$inboundSchema,
+  ),
+  customer_cancellation_comment: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
@@ -88,13 +107,17 @@ export const CustomerOrderSubscription$inboundSchema: z.ZodType<
     "current_period_start": "currentPeriodStart",
     "current_period_end": "currentPeriodEnd",
     "cancel_at_period_end": "cancelAtPeriodEnd",
+    "canceled_at": "canceledAt",
     "started_at": "startedAt",
+    "ends_at": "endsAt",
     "ended_at": "endedAt",
     "customer_id": "customerId",
     "product_id": "productId",
     "price_id": "priceId",
     "discount_id": "discountId",
     "checkout_id": "checkoutId",
+    "customer_cancellation_reason": "customerCancellationReason",
+    "customer_cancellation_comment": "customerCancellationComment",
   });
 });
 
@@ -110,13 +133,17 @@ export type CustomerOrderSubscription$Outbound = {
   current_period_start: string;
   current_period_end: string | null;
   cancel_at_period_end: boolean;
+  canceled_at: string | null;
   started_at: string | null;
+  ends_at: string | null;
   ended_at: string | null;
   customer_id: string;
   product_id: string;
   price_id: string;
   discount_id: string | null;
   checkout_id: string | null;
+  customer_cancellation_reason: string | null;
+  customer_cancellation_comment: string | null;
 };
 
 /** @internal */
@@ -135,13 +162,19 @@ export const CustomerOrderSubscription$outboundSchema: z.ZodType<
   currentPeriodStart: z.date().transform(v => v.toISOString()),
   currentPeriodEnd: z.nullable(z.date().transform(v => v.toISOString())),
   cancelAtPeriodEnd: z.boolean(),
+  canceledAt: z.nullable(z.date().transform(v => v.toISOString())),
   startedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  endsAt: z.nullable(z.date().transform(v => v.toISOString())),
   endedAt: z.nullable(z.date().transform(v => v.toISOString())),
   customerId: z.string(),
   productId: z.string(),
   priceId: z.string(),
   discountId: z.nullable(z.string()),
   checkoutId: z.nullable(z.string()),
+  customerCancellationReason: z.nullable(
+    CustomerCancellationReason$outboundSchema,
+  ),
+  customerCancellationComment: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",
@@ -150,13 +183,17 @@ export const CustomerOrderSubscription$outboundSchema: z.ZodType<
     currentPeriodStart: "current_period_start",
     currentPeriodEnd: "current_period_end",
     cancelAtPeriodEnd: "cancel_at_period_end",
+    canceledAt: "canceled_at",
     startedAt: "started_at",
+    endsAt: "ends_at",
     endedAt: "ended_at",
     customerId: "customer_id",
     productId: "product_id",
     priceId: "price_id",
     discountId: "discount_id",
     checkoutId: "checkout_id",
+    customerCancellationReason: "customer_cancellation_reason",
+    customerCancellationComment: "customer_cancellation_comment",
   });
 });
 

package/src/models/components/customersession.ts

@@ -32,6 +32,7 @@ export type CustomerSession = {
   id: string;
   token: string;
   expiresAt: Date;
+  customerPortalUrl: string;
   customerId: string;
   /**
    * A customer in an organization.
@@ -52,6 +53,7 @@ export const CustomerSession$inboundSchema: z.ZodType<
   id: z.string(),
   token: z.string(),
   expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  customer_portal_url: z.string(),
   customer_id: z.string(),
   customer: Customer$inboundSchema,
 }).transform((v) => {
@@ -59,6 +61,7 @@ export const CustomerSession$inboundSchema: z.ZodType<
     "created_at": "createdAt",
     "modified_at": "modifiedAt",
     "expires_at": "expiresAt",
+    "customer_portal_url": "customerPortalUrl",
     "customer_id": "customerId",
   });
 });
@@ -70,6 +73,7 @@ export type CustomerSession$Outbound = {
   id: string;
   token: string;
   expires_at: string;
+  customer_portal_url: string;
   customer_id: string;
   customer: Customer$Outbound;
 };
@@ -85,6 +89,7 @@ export const CustomerSession$outboundSchema: z.ZodType<
   id: z.string(),
   token: z.string(),
   expiresAt: z.date().transform(v => v.toISOString()),
+  customerPortalUrl: z.string(),
   customerId: z.string(),
   customer: Customer$outboundSchema,
 }).transform((v) => {
@@ -92,6 +97,7 @@ export const CustomerSession$outboundSchema: z.ZodType<
     createdAt: "created_at",
     modifiedAt: "modified_at",
     expiresAt: "expires_at",
+    customerPortalUrl: "customer_portal_url",
     customerId: "customer_id",
   });
 });

package/src/models/components/customersubscription.ts

@@ -7,6 +7,11 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomerCancellationReason,
+  CustomerCancellationReason$inboundSchema,
+  CustomerCancellationReason$outboundSchema,
+} from "./customercancellationreason.js";
 import {
   CustomerSubscriptionProduct,
   CustomerSubscriptionProduct$inboundSchema,
@@ -50,13 +55,17 @@ export type CustomerSubscription = {
   currentPeriodStart: Date;
   currentPeriodEnd: Date | null;
   cancelAtPeriodEnd: boolean;
+  canceledAt: Date | null;
   startedAt: Date | null;
+  endsAt: Date | null;
   endedAt: Date | null;
   customerId: string;
   productId: string;
   priceId: string;
   discountId: string | null;
   checkoutId: string | null;
+  customerCancellationReason: CustomerCancellationReason | null;
+  customerCancellationComment: string | null;
   /**
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -87,9 +96,15 @@ export const CustomerSubscription$inboundSchema: z.ZodType<
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
   cancel_at_period_end: z.boolean(),
+  canceled_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   started_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
+  ends_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   ended_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
@@ -98,6 +113,10 @@ export const CustomerSubscription$inboundSchema: z.ZodType<
   price_id: z.string(),
   discount_id: z.nullable(z.string()),
   checkout_id: z.nullable(z.string()),
+  customer_cancellation_reason: z.nullable(
+    CustomerCancellationReason$inboundSchema,
+  ),
+  customer_cancellation_comment: z.nullable(z.string()),
   user_id: z.string(),
   product: CustomerSubscriptionProduct$inboundSchema,
   price: ProductPrice$inboundSchema,
@@ -109,13 +128,17 @@ export const CustomerSubscription$inboundSchema: z.ZodType<
     "current_period_start": "currentPeriodStart",
     "current_period_end": "currentPeriodEnd",
     "cancel_at_period_end": "cancelAtPeriodEnd",
+    "canceled_at": "canceledAt",
     "started_at": "startedAt",
+    "ends_at": "endsAt",
     "ended_at": "endedAt",
     "customer_id": "customerId",
     "product_id": "productId",
     "price_id": "priceId",
     "discount_id": "discountId",
     "checkout_id": "checkoutId",
+    "customer_cancellation_reason": "customerCancellationReason",
+    "customer_cancellation_comment": "customerCancellationComment",
     "user_id": "userId",
   });
 });
@@ -132,13 +155,17 @@ export type CustomerSubscription$Outbound = {
   current_period_start: string;
   current_period_end: string | null;
   cancel_at_period_end: boolean;
+  canceled_at: string | null;
   started_at: string | null;
+  ends_at: string | null;
   ended_at: string | null;
   customer_id: string;
   product_id: string;
   price_id: string;
   discount_id: string | null;
   checkout_id: string | null;
+  customer_cancellation_reason: string | null;
+  customer_cancellation_comment: string | null;
   user_id: string;
   product: CustomerSubscriptionProduct$Outbound;
   price: ProductPrice$Outbound;
@@ -160,13 +187,19 @@ export const CustomerSubscription$outboundSchema: z.ZodType<
   currentPeriodStart: z.date().transform(v => v.toISOString()),
   currentPeriodEnd: z.nullable(z.date().transform(v => v.toISOString())),
   cancelAtPeriodEnd: z.boolean(),
+  canceledAt: z.nullable(z.date().transform(v => v.toISOString())),
   startedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  endsAt: z.nullable(z.date().transform(v => v.toISOString())),
   endedAt: z.nullable(z.date().transform(v => v.toISOString())),
   customerId: z.string(),
   productId: z.string(),
   priceId: z.string(),
   discountId: z.nullable(z.string()),
   checkoutId: z.nullable(z.string()),
+  customerCancellationReason: z.nullable(
+    CustomerCancellationReason$outboundSchema,
+  ),
+  customerCancellationComment: z.nullable(z.string()),
   userId: z.string(),
   product: CustomerSubscriptionProduct$outboundSchema,
   price: ProductPrice$outboundSchema,
@@ -178,13 +211,17 @@ export const CustomerSubscription$outboundSchema: z.ZodType<
     currentPeriodStart: "current_period_start",
     currentPeriodEnd: "current_period_end",
     cancelAtPeriodEnd: "cancel_at_period_end",
+    canceledAt: "canceled_at",
     startedAt: "started_at",
+    endsAt: "ends_at",
     endedAt: "ended_at",
     customerId: "customer_id",
     productId: "product_id",
     priceId: "price_id",
     discountId: "discount_id",
     checkoutId: "checkout_id",
+    customerCancellationReason: "customer_cancellation_reason",
+    customerCancellationComment: "customer_cancellation_comment",
     userId: "user_id",
   });
 });

package/src/models/components/customersubscriptioncancel.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomerCancellationReason,
+  CustomerCancellationReason$inboundSchema,
+  CustomerCancellationReason$outboundSchema,
+} from "./customercancellationreason.js";
+
+export type CustomerSubscriptionCancel = {
+  /**
+   * Cancel an active subscription once the current period ends.
+   *
+   * @remarks
+   *
+   * Or uncancel a subscription currently set to be revoked at period end.
+   */
+  cancelAtPeriodEnd?: boolean | null | undefined;
+  /**
+   * Customers reason for cancellation.
+   *
+   * @remarks
+   *
+   * * `too_expensive`: Too expensive for the customer.
+   * * `missing_features`: Customer is missing certain features.
+   * * `switched_service`: Customer switched to another service.
+   * * `unused`: Customer is not using it enough.
+   * * `customer_service`: Customer is not satisfied with the customer service.
+   * * `low_quality`: Customer is unhappy with the quality.
+   * * `too_complex`: Customer considers the service too complicated.
+   * * `other`: Other reason(s).
+   */
+  cancellationReason?: CustomerCancellationReason | null | undefined;
+  /**
+   * Customer feedback and why they decided to cancel.
+   */
+  cancellationComment?: string | null | undefined;
+};
+
+/** @internal */
+export const CustomerSubscriptionCancel$inboundSchema: z.ZodType<
+  CustomerSubscriptionCancel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cancel_at_period_end: z.nullable(z.boolean()).optional(),
+  cancellation_reason: z.nullable(CustomerCancellationReason$inboundSchema)
+    .optional(),
+  cancellation_comment: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "cancel_at_period_end": "cancelAtPeriodEnd",
+    "cancellation_reason": "cancellationReason",
+    "cancellation_comment": "cancellationComment",
+  });
+});
+
+/** @internal */
+export type CustomerSubscriptionCancel$Outbound = {
+  cancel_at_period_end?: boolean | null | undefined;
+  cancellation_reason?: string | null | undefined;
+  cancellation_comment?: string | null | undefined;
+};
+
+/** @internal */
+export const CustomerSubscriptionCancel$outboundSchema: z.ZodType<
+  CustomerSubscriptionCancel$Outbound,
+  z.ZodTypeDef,
+  CustomerSubscriptionCancel
+> = z.object({
+  cancelAtPeriodEnd: z.nullable(z.boolean()).optional(),
+  cancellationReason: z.nullable(CustomerCancellationReason$outboundSchema)
+    .optional(),
+  cancellationComment: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    cancelAtPeriodEnd: "cancel_at_period_end",
+    cancellationReason: "cancellation_reason",
+    cancellationComment: "cancellation_comment",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerSubscriptionCancel$ {
+  /** @deprecated use `CustomerSubscriptionCancel$inboundSchema` instead. */
+  export const inboundSchema = CustomerSubscriptionCancel$inboundSchema;
+  /** @deprecated use `CustomerSubscriptionCancel$outboundSchema` instead. */
+  export const outboundSchema = CustomerSubscriptionCancel$outboundSchema;
+  /** @deprecated use `CustomerSubscriptionCancel$Outbound` instead. */
+  export type Outbound = CustomerSubscriptionCancel$Outbound;
+}
+
+export function customerSubscriptionCancelToJSON(
+  customerSubscriptionCancel: CustomerSubscriptionCancel,
+): string {
+  return JSON.stringify(
+    CustomerSubscriptionCancel$outboundSchema.parse(customerSubscriptionCancel),
+  );
+}
+
+export function customerSubscriptionCancelFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerSubscriptionCancel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerSubscriptionCancel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerSubscriptionCancel' from JSON`,
+  );
+}