@polar-sh/sdk 0.44.0 → 0.45.1

package/src/models/components/benefitfeatureflagsubscriber.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BenefitFeatureFlagSubscriberProperties,
+  BenefitFeatureFlagSubscriberProperties$inboundSchema,
+} from "./benefitfeatureflagsubscriberproperties.js";
+import {
+  BenefitSubscriberOrganization,
+  BenefitSubscriberOrganization$inboundSchema,
+} from "./benefitsubscriberorganization.js";
+import {
+  MetadataOutputType,
+  MetadataOutputType$inboundSchema,
+} from "./metadataoutputtype.js";
+
+export type BenefitFeatureFlagSubscriber = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  type: "feature_flag";
+  /**
+   * The description of the benefit.
+   */
+  description: string;
+  /**
+   * Whether the benefit is selectable when creating a product.
+   */
+  selectable: boolean;
+  /**
+   * Whether the benefit is deletable.
+   */
+  deletable: boolean;
+  /**
+   * The ID of the organization owning the benefit.
+   */
+  organizationId: string;
+  metadata: { [k: string]: MetadataOutputType };
+  organization: BenefitSubscriberOrganization;
+  /**
+   * Properties available to subscribers for a benefit of type `feature_flag`.
+   */
+  properties: BenefitFeatureFlagSubscriberProperties;
+};
+
+/** @internal */
+export const BenefitFeatureFlagSubscriber$inboundSchema: z.ZodMiniType<
+  BenefitFeatureFlagSubscriber,
+  unknown
+> = z.pipe(
+  z.object({
+    id: z.string(),
+    created_at: z.pipe(
+      z.iso.datetime({ offset: true }),
+      z.transform(v => new Date(v)),
+    ),
+    modified_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    type: z.literal("feature_flag"),
+    description: z.string(),
+    selectable: z.boolean(),
+    deletable: z.boolean(),
+    organization_id: z.string(),
+    metadata: z.record(z.string(), MetadataOutputType$inboundSchema),
+    organization: BenefitSubscriberOrganization$inboundSchema,
+    properties: BenefitFeatureFlagSubscriberProperties$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "modified_at": "modifiedAt",
+      "organization_id": "organizationId",
+    });
+  }),
+);
+
+export function benefitFeatureFlagSubscriberFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitFeatureFlagSubscriber, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitFeatureFlagSubscriber$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitFeatureFlagSubscriber' from JSON`,
+  );
+}

package/src/models/components/benefitfeatureflagsubscriberproperties.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Properties available to subscribers for a benefit of type `feature_flag`.
+ */
+export type BenefitFeatureFlagSubscriberProperties = {};
+
+/** @internal */
+export const BenefitFeatureFlagSubscriberProperties$inboundSchema:
+  z.ZodMiniType<BenefitFeatureFlagSubscriberProperties, unknown> = z.object({});
+
+export function benefitFeatureFlagSubscriberPropertiesFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitFeatureFlagSubscriberProperties, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BenefitFeatureFlagSubscriberProperties$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitFeatureFlagSubscriberProperties' from JSON`,
+  );
+}

package/src/models/components/benefitfeatureflagupdate.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { smartUnion } from "../../types/smartUnion.js";
+import {
+  BenefitFeatureFlagProperties,
+  BenefitFeatureFlagProperties$Outbound,
+  BenefitFeatureFlagProperties$outboundSchema,
+} from "./benefitfeatureflagproperties.js";
+
+export type BenefitFeatureFlagUpdateMetadata =
+  | string
+  | number
+  | number
+  | boolean;
+
+export type BenefitFeatureFlagUpdate = {
+  /**
+   * Key-value object allowing you to store additional information.
+   *
+   * @remarks
+   *
+   * The key must be a string with a maximum length of **40 characters**.
+   * The value must be either:
+   *
+   * * A string with a maximum length of **500 characters**
+   * * An integer
+   * * A floating-point number
+   * * A boolean
+   *
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
+  /**
+   * The description of the benefit. Will be displayed on products having this benefit.
+   */
+  description?: string | null | undefined;
+  type: "feature_flag";
+  properties?: BenefitFeatureFlagProperties | null | undefined;
+};
+
+/** @internal */
+export type BenefitFeatureFlagUpdateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitFeatureFlagUpdateMetadata$outboundSchema: z.ZodMiniType<
+  BenefitFeatureFlagUpdateMetadata$Outbound,
+  BenefitFeatureFlagUpdateMetadata
+> = smartUnion([z.string(), z.int(), z.number(), z.boolean()]);
+
+export function benefitFeatureFlagUpdateMetadataToJSON(
+  benefitFeatureFlagUpdateMetadata: BenefitFeatureFlagUpdateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitFeatureFlagUpdateMetadata$outboundSchema.parse(
+      benefitFeatureFlagUpdateMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type BenefitFeatureFlagUpdate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
+  description?: string | null | undefined;
+  type: "feature_flag";
+  properties?: BenefitFeatureFlagProperties$Outbound | null | undefined;
+};
+
+/** @internal */
+export const BenefitFeatureFlagUpdate$outboundSchema: z.ZodMiniType<
+  BenefitFeatureFlagUpdate$Outbound,
+  BenefitFeatureFlagUpdate
+> = z.object({
+  metadata: z.optional(
+    z.record(
+      z.string(),
+      smartUnion([z.string(), z.int(), z.number(), z.boolean()]),
+    ),
+  ),
+  description: z.optional(z.nullable(z.string())),
+  type: z.literal("feature_flag"),
+  properties: z.optional(
+    z.nullable(BenefitFeatureFlagProperties$outboundSchema),
+  ),
+});
+
+export function benefitFeatureFlagUpdateToJSON(
+  benefitFeatureFlagUpdate: BenefitFeatureFlagUpdate,
+): string {
+  return JSON.stringify(
+    BenefitFeatureFlagUpdate$outboundSchema.parse(benefitFeatureFlagUpdate),
+  );
+}

package/src/models/components/benefitgrant.ts

@@ -25,6 +25,10 @@ import {
   BenefitGrantError,
   BenefitGrantError$inboundSchema,
 } from "./benefitgranterror.js";
+import {
+  BenefitGrantFeatureFlagProperties,
+  BenefitGrantFeatureFlagProperties$inboundSchema,
+} from "./benefitgrantfeatureflagproperties.js";
 import {
   BenefitGrantGitHubRepositoryProperties,
   BenefitGrantGitHubRepositoryProperties$inboundSchema,
@@ -41,7 +45,8 @@ export type Properties =
   | BenefitGrantGitHubRepositoryProperties
   | BenefitGrantDownloadablesProperties
   | BenefitGrantLicenseKeysProperties
-  | BenefitGrantCustomProperties;
+  | BenefitGrantCustomProperties
+  | BenefitGrantFeatureFlagProperties;
 
 export type BenefitGrant = {
   /**
@@ -107,7 +112,8 @@ export type BenefitGrant = {
     | BenefitGrantGitHubRepositoryProperties
     | BenefitGrantDownloadablesProperties
     | BenefitGrantLicenseKeysProperties
-    | BenefitGrantCustomProperties;
+    | BenefitGrantCustomProperties
+    | BenefitGrantFeatureFlagProperties;
 };
 
 /** @internal */
@@ -118,6 +124,7 @@ export const Properties$inboundSchema: z.ZodMiniType<Properties, unknown> =
     BenefitGrantDownloadablesProperties$inboundSchema,
     BenefitGrantLicenseKeysProperties$inboundSchema,
     BenefitGrantCustomProperties$inboundSchema,
+    BenefitGrantFeatureFlagProperties$inboundSchema,
   ]);
 
 export function propertiesFromJSON(
@@ -171,6 +178,7 @@ export const BenefitGrant$inboundSchema: z.ZodMiniType<BenefitGrant, unknown> =
         BenefitGrantDownloadablesProperties$inboundSchema,
         BenefitGrantLicenseKeysProperties$inboundSchema,
         BenefitGrantCustomProperties$inboundSchema,
+        BenefitGrantFeatureFlagProperties$inboundSchema,
       ]),
     }),
     z.transform((v) => {

package/src/models/components/benefitgrantfeatureflagproperties.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type BenefitGrantFeatureFlagProperties = {};
+
+/** @internal */
+export const BenefitGrantFeatureFlagProperties$inboundSchema: z.ZodMiniType<
+  BenefitGrantFeatureFlagProperties,
+  unknown
+> = z.object({});
+/** @internal */
+export type BenefitGrantFeatureFlagProperties$Outbound = {};
+
+/** @internal */
+export const BenefitGrantFeatureFlagProperties$outboundSchema: z.ZodMiniType<
+  BenefitGrantFeatureFlagProperties$Outbound,
+  BenefitGrantFeatureFlagProperties
+> = z.object({});
+
+export function benefitGrantFeatureFlagPropertiesToJSON(
+  benefitGrantFeatureFlagProperties: BenefitGrantFeatureFlagProperties,
+): string {
+  return JSON.stringify(
+    BenefitGrantFeatureFlagProperties$outboundSchema.parse(
+      benefitGrantFeatureFlagProperties,
+    ),
+  );
+}
+export function benefitGrantFeatureFlagPropertiesFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitGrantFeatureFlagProperties, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitGrantFeatureFlagProperties$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitGrantFeatureFlagProperties' from JSON`,
+  );
+}

package/src/models/components/benefitgrantfeatureflagwebhook.ts

@@ -0,0 +1,262 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BenefitFeatureFlag,
+  BenefitFeatureFlag$inboundSchema,
+  BenefitFeatureFlag$Outbound,
+  BenefitFeatureFlag$outboundSchema,
+} from "./benefitfeatureflag.js";
+import {
+  BenefitGrantError,
+  BenefitGrantError$inboundSchema,
+  BenefitGrantError$Outbound,
+  BenefitGrantError$outboundSchema,
+} from "./benefitgranterror.js";
+import {
+  BenefitGrantFeatureFlagProperties,
+  BenefitGrantFeatureFlagProperties$inboundSchema,
+  BenefitGrantFeatureFlagProperties$Outbound,
+  BenefitGrantFeatureFlagProperties$outboundSchema,
+} from "./benefitgrantfeatureflagproperties.js";
+import {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+import {
+  Member,
+  Member$inboundSchema,
+  Member$Outbound,
+  Member$outboundSchema,
+} from "./member.js";
+
+export type BenefitGrantFeatureFlagWebhook = {
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the grant.
+   */
+  id: string;
+  /**
+   * The timestamp when the benefit was granted. If `None`, the benefit is not granted.
+   */
+  grantedAt?: Date | null | undefined;
+  /**
+   * Whether the benefit is granted.
+   */
+  isGranted: boolean;
+  /**
+   * The timestamp when the benefit was revoked. If `None`, the benefit is not revoked.
+   */
+  revokedAt?: Date | null | undefined;
+  /**
+   * Whether the benefit is revoked.
+   */
+  isRevoked: boolean;
+  /**
+   * The ID of the subscription that granted this benefit.
+   */
+  subscriptionId: string | null;
+  /**
+   * The ID of the order that granted this benefit.
+   */
+  orderId: string | null;
+  /**
+   * The ID of the customer concerned by this grant.
+   */
+  customerId: string;
+  /**
+   * The ID of the member concerned by this grant.
+   */
+  memberId?: string | null | undefined;
+  /**
+   * The ID of the benefit concerned by this grant.
+   */
+  benefitId: string;
+  /**
+   * The error information if the benefit grant failed with an unrecoverable error.
+   */
+  error?: BenefitGrantError | null | undefined;
+  /**
+   * A customer in an organization.
+   */
+  customer: Customer;
+  member?: Member | null | undefined;
+  /**
+   * A benefit of type `feature_flag`.
+   *
+   * @remarks
+   *
+   * Use it to grant feature flags with key-value metadata
+   * that can be queried via the API and webhooks.
+   */
+  benefit: BenefitFeatureFlag;
+  properties: BenefitGrantFeatureFlagProperties;
+  previousProperties?: BenefitGrantFeatureFlagProperties | null | undefined;
+};
+
+/** @internal */
+export const BenefitGrantFeatureFlagWebhook$inboundSchema: z.ZodMiniType<
+  BenefitGrantFeatureFlagWebhook,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: z.pipe(
+      z.iso.datetime({ offset: true }),
+      z.transform(v => new Date(v)),
+    ),
+    modified_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    id: z.string(),
+    granted_at: z.optional(
+      z.nullable(z.pipe(
+        z.iso.datetime({ offset: true }),
+        z.transform(v => new Date(v)),
+      )),
+    ),
+    is_granted: z.boolean(),
+    revoked_at: z.optional(
+      z.nullable(z.pipe(
+        z.iso.datetime({ offset: true }),
+        z.transform(v => new Date(v)),
+      )),
+    ),
+    is_revoked: z.boolean(),
+    subscription_id: z.nullable(z.string()),
+    order_id: z.nullable(z.string()),
+    customer_id: z.string(),
+    member_id: z.optional(z.nullable(z.string())),
+    benefit_id: z.string(),
+    error: z.optional(z.nullable(BenefitGrantError$inboundSchema)),
+    customer: Customer$inboundSchema,
+    member: z.optional(z.nullable(Member$inboundSchema)),
+    benefit: BenefitFeatureFlag$inboundSchema,
+    properties: BenefitGrantFeatureFlagProperties$inboundSchema,
+    previous_properties: z.optional(
+      z.nullable(BenefitGrantFeatureFlagProperties$inboundSchema),
+    ),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "modified_at": "modifiedAt",
+      "granted_at": "grantedAt",
+      "is_granted": "isGranted",
+      "revoked_at": "revokedAt",
+      "is_revoked": "isRevoked",
+      "subscription_id": "subscriptionId",
+      "order_id": "orderId",
+      "customer_id": "customerId",
+      "member_id": "memberId",
+      "benefit_id": "benefitId",
+      "previous_properties": "previousProperties",
+    });
+  }),
+);
+/** @internal */
+export type BenefitGrantFeatureFlagWebhook$Outbound = {
+  created_at: string;
+  modified_at: string | null;
+  id: string;
+  granted_at?: string | null | undefined;
+  is_granted: boolean;
+  revoked_at?: string | null | undefined;
+  is_revoked: boolean;
+  subscription_id: string | null;
+  order_id: string | null;
+  customer_id: string;
+  member_id?: string | null | undefined;
+  benefit_id: string;
+  error?: BenefitGrantError$Outbound | null | undefined;
+  customer: Customer$Outbound;
+  member?: Member$Outbound | null | undefined;
+  benefit: BenefitFeatureFlag$Outbound;
+  properties: BenefitGrantFeatureFlagProperties$Outbound;
+  previous_properties?:
+    | BenefitGrantFeatureFlagProperties$Outbound
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const BenefitGrantFeatureFlagWebhook$outboundSchema: z.ZodMiniType<
+  BenefitGrantFeatureFlagWebhook$Outbound,
+  BenefitGrantFeatureFlagWebhook
+> = z.pipe(
+  z.object({
+    createdAt: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    modifiedAt: z.nullable(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    id: z.string(),
+    grantedAt: z.optional(
+      z.nullable(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    ),
+    isGranted: z.boolean(),
+    revokedAt: z.optional(
+      z.nullable(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    ),
+    isRevoked: z.boolean(),
+    subscriptionId: z.nullable(z.string()),
+    orderId: z.nullable(z.string()),
+    customerId: z.string(),
+    memberId: z.optional(z.nullable(z.string())),
+    benefitId: z.string(),
+    error: z.optional(z.nullable(BenefitGrantError$outboundSchema)),
+    customer: Customer$outboundSchema,
+    member: z.optional(z.nullable(Member$outboundSchema)),
+    benefit: BenefitFeatureFlag$outboundSchema,
+    properties: BenefitGrantFeatureFlagProperties$outboundSchema,
+    previousProperties: z.optional(
+      z.nullable(BenefitGrantFeatureFlagProperties$outboundSchema),
+    ),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      createdAt: "created_at",
+      modifiedAt: "modified_at",
+      grantedAt: "granted_at",
+      isGranted: "is_granted",
+      revokedAt: "revoked_at",
+      isRevoked: "is_revoked",
+      subscriptionId: "subscription_id",
+      orderId: "order_id",
+      customerId: "customer_id",
+      memberId: "member_id",
+      benefitId: "benefit_id",
+      previousProperties: "previous_properties",
+    });
+  }),
+);
+
+export function benefitGrantFeatureFlagWebhookToJSON(
+  benefitGrantFeatureFlagWebhook: BenefitGrantFeatureFlagWebhook,
+): string {
+  return JSON.stringify(
+    BenefitGrantFeatureFlagWebhook$outboundSchema.parse(
+      benefitGrantFeatureFlagWebhook,
+    ),
+  );
+}
+export function benefitGrantFeatureFlagWebhookFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitGrantFeatureFlagWebhook, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitGrantFeatureFlagWebhook$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitGrantFeatureFlagWebhook' from JSON`,
+  );
+}

package/src/models/components/benefitgrantwebhook.ts

@@ -25,6 +25,12 @@ import {
   BenefitGrantDownloadablesWebhook$Outbound,
   BenefitGrantDownloadablesWebhook$outboundSchema,
 } from "./benefitgrantdownloadableswebhook.js";
+import {
+  BenefitGrantFeatureFlagWebhook,
+  BenefitGrantFeatureFlagWebhook$inboundSchema,
+  BenefitGrantFeatureFlagWebhook$Outbound,
+  BenefitGrantFeatureFlagWebhook$outboundSchema,
+} from "./benefitgrantfeatureflagwebhook.js";
 import {
   BenefitGrantGitHubRepositoryWebhook,
   BenefitGrantGitHubRepositoryWebhook$inboundSchema,
@@ -50,7 +56,8 @@ export type BenefitGrantWebhook =
   | BenefitGrantGitHubRepositoryWebhook
   | BenefitGrantDownloadablesWebhook
   | BenefitGrantLicenseKeysWebhook
-  | BenefitGrantMeterCreditWebhook;
+  | BenefitGrantMeterCreditWebhook
+  | BenefitGrantFeatureFlagWebhook;
 
 /** @internal */
 export const BenefitGrantWebhook$inboundSchema: z.ZodMiniType<
@@ -63,6 +70,7 @@ export const BenefitGrantWebhook$inboundSchema: z.ZodMiniType<
   BenefitGrantDownloadablesWebhook$inboundSchema,
   BenefitGrantLicenseKeysWebhook$inboundSchema,
   BenefitGrantMeterCreditWebhook$inboundSchema,
+  BenefitGrantFeatureFlagWebhook$inboundSchema,
 ]);
 /** @internal */
 export type BenefitGrantWebhook$Outbound =
@@ -71,7 +79,8 @@ export type BenefitGrantWebhook$Outbound =
   | BenefitGrantGitHubRepositoryWebhook$Outbound
   | BenefitGrantDownloadablesWebhook$Outbound
   | BenefitGrantLicenseKeysWebhook$Outbound
-  | BenefitGrantMeterCreditWebhook$Outbound;
+  | BenefitGrantMeterCreditWebhook$Outbound
+  | BenefitGrantFeatureFlagWebhook$Outbound;
 
 /** @internal */
 export const BenefitGrantWebhook$outboundSchema: z.ZodMiniType<
@@ -84,6 +93,7 @@ export const BenefitGrantWebhook$outboundSchema: z.ZodMiniType<
   BenefitGrantDownloadablesWebhook$outboundSchema,
   BenefitGrantLicenseKeysWebhook$outboundSchema,
   BenefitGrantMeterCreditWebhook$outboundSchema,
+  BenefitGrantFeatureFlagWebhook$outboundSchema,
 ]);
 
 export function benefitGrantWebhookToJSON(

package/src/models/components/benefittype.ts

@@ -13,6 +13,7 @@ export const BenefitType = {
   Downloadables: "downloadables",
   LicenseKeys: "license_keys",
   MeterCredit: "meter_credit",
+  FeatureFlag: "feature_flag",
 } as const;
 export type BenefitType = OpenEnum<typeof BenefitType>;
 

package/src/models/components/cardpayment.ts

@@ -52,7 +52,7 @@ export type CardPayment = {
    */
   declineReason: string | null;
   /**
-   * Human-reasable error message, if the payment was declined.
+   * Human-readable error message, if the payment was declined.
    */
   declineMessage: string | null;
   /**