@polar-sh/sdk 0.48.0 → 0.49.0

package/src/models/components/customersubscription.ts

@@ -30,9 +30,9 @@ import {
 } from "./pendingsubscriptionupdate.js";
 import { ProductPrice, ProductPrice$inboundSchema } from "./productprice.js";
 import {
-  SubscriptionRecurringInterval,
-  SubscriptionRecurringInterval$inboundSchema,
-} from "./subscriptionrecurringinterval.js";
+  RecurringInterval,
+  RecurringInterval$inboundSchema,
+} from "./recurringinterval.js";
 import {
   SubscriptionStatus,
   SubscriptionStatus$inboundSchema,
@@ -63,7 +63,7 @@ export type CustomerSubscription = {
    * The currency of the subscription.
    */
   currency: string;
-  recurringInterval: SubscriptionRecurringInterval;
+  recurringInterval: RecurringInterval;
   /**
    * Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on.
    */
@@ -77,6 +77,14 @@ export type CustomerSubscription = {
    * The end timestamp of the current billing period.
    */
   currentPeriodEnd: Date;
+  /**
+   * The start timestamp of the current meter period, if the product has a meter cycle set. Metered credits are granted and overage is settled on this cadence.
+   */
+  currentMeterPeriodStart: Date | null;
+  /**
+   * The end timestamp of the current meter period, if the product has a meter cycle set. This is when credits next renew.
+   */
+  currentMeterPeriodEnd: Date | null;
   /**
    * The start timestamp of the trial period, if any.
    */
@@ -105,6 +113,22 @@ export type CustomerSubscription = {
    * The timestamp when the subscription ended.
    */
   endedAt: Date | null;
+  /**
+   * The timestamp when the subscription entered `past_due` status.
+   */
+  pastDueAt?: Date | null | undefined;
+  /**
+   * Whether the subscription will be paused at the end of the current period.
+   */
+  pauseAtPeriodEnd: boolean;
+  /**
+   * The timestamp when the subscription was paused.
+   */
+  pausedAt: Date | null;
+  /**
+   * The timestamp when a paused subscription is scheduled to automatically resume, if set.
+   */
+  resumesAt: Date | null;
   /**
    * The ID of the subscribed customer.
    */
@@ -174,7 +198,7 @@ export const CustomerSubscription$inboundSchema: z.ZodMiniType<
     id: z.string(),
     amount: z.int(),
     currency: z.string(),
-    recurring_interval: SubscriptionRecurringInterval$inboundSchema,
+    recurring_interval: RecurringInterval$inboundSchema,
     recurring_interval_count: z.int(),
     status: SubscriptionStatus$inboundSchema,
     current_period_start: z.pipe(
@@ -185,6 +209,12 @@ export const CustomerSubscription$inboundSchema: z.ZodMiniType<
       z.iso.datetime({ offset: true }),
       z.transform(v => new Date(v)),
     ),
+    current_meter_period_start: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    current_meter_period_end: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
     trial_start: z.nullable(
       z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
     ),
@@ -204,6 +234,19 @@ export const CustomerSubscription$inboundSchema: z.ZodMiniType<
     ended_at: z.nullable(
       z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
     ),
+    past_due_at: z.optional(
+      z.nullable(z.pipe(
+        z.iso.datetime({ offset: true }),
+        z.transform(v => new Date(v)),
+      )),
+    ),
+    pause_at_period_end: z.boolean(),
+    paused_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    resumes_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
     customer_id: z.string(),
     product_id: z.string(),
     discount_id: z.nullable(z.string()),
@@ -231,6 +274,8 @@ export const CustomerSubscription$inboundSchema: z.ZodMiniType<
       "recurring_interval_count": "recurringIntervalCount",
       "current_period_start": "currentPeriodStart",
       "current_period_end": "currentPeriodEnd",
+      "current_meter_period_start": "currentMeterPeriodStart",
+      "current_meter_period_end": "currentMeterPeriodEnd",
       "trial_start": "trialStart",
       "trial_end": "trialEnd",
       "cancel_at_period_end": "cancelAtPeriodEnd",
@@ -238,6 +283,10 @@ export const CustomerSubscription$inboundSchema: z.ZodMiniType<
       "started_at": "startedAt",
       "ends_at": "endsAt",
       "ended_at": "endedAt",
+      "past_due_at": "pastDueAt",
+      "pause_at_period_end": "pauseAtPeriodEnd",
+      "paused_at": "pausedAt",
+      "resumes_at": "resumesAt",
       "customer_id": "customerId",
       "product_id": "productId",
       "discount_id": "discountId",

package/src/models/components/customersubscriptionpause.ts

@@ -0,0 +1,55 @@
+/*
+ * 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";
+
+export type CustomerSubscriptionPause = {
+  /**
+   * Pause an active subscription at the end of the current period.
+   *
+   * @remarks
+   *
+   * Or cancel a scheduled pause on a subscription set to be paused at
+   * period end.
+   */
+  pauseAtPeriodEnd: boolean;
+  /**
+   * Date at which the paused subscription should automatically resume. If not set, it stays paused until resumed. Must be after the current period end.
+   */
+  resumesAt?: Date | null | undefined;
+};
+
+/** @internal */
+export type CustomerSubscriptionPause$Outbound = {
+  pause_at_period_end: boolean;
+  resumes_at?: string | null | undefined;
+};
+
+/** @internal */
+export const CustomerSubscriptionPause$outboundSchema: z.ZodMiniType<
+  CustomerSubscriptionPause$Outbound,
+  CustomerSubscriptionPause
+> = z.pipe(
+  z.object({
+    pauseAtPeriodEnd: z.boolean(),
+    resumesAt: z.optional(
+      z.nullable(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    ),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      pauseAtPeriodEnd: "pause_at_period_end",
+      resumesAt: "resumes_at",
+    });
+  }),
+);
+
+export function customerSubscriptionPauseToJSON(
+  customerSubscriptionPause: CustomerSubscriptionPause,
+): string {
+  return JSON.stringify(
+    CustomerSubscriptionPause$outboundSchema.parse(customerSubscriptionPause),
+  );
+}

package/src/models/components/customersubscriptionproduct.ts

@@ -27,9 +27,9 @@ import {
   ProductVisibility$inboundSchema,
 } from "./productvisibility.js";
 import {
-  SubscriptionRecurringInterval,
-  SubscriptionRecurringInterval$inboundSchema,
-} from "./subscriptionrecurringinterval.js";
+  RecurringInterval,
+  RecurringInterval$inboundSchema,
+} from "./recurringinterval.js";
 import { TrialInterval, TrialInterval$inboundSchema } from "./trialinterval.js";
 
 export type CustomerSubscriptionProductPrices =
@@ -69,11 +69,19 @@ export type CustomerSubscriptionProduct = {
   /**
    * The recurring interval of the product. If `None`, the product is a one-time purchase.
    */
-  recurringInterval: SubscriptionRecurringInterval | null;
+  recurringInterval: RecurringInterval | null;
   /**
    * Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.
    */
   recurringIntervalCount: number | null;
+  /**
+   * The meter cycle of the product, independent of the billing interval. If `None`, metered concerns follow the billing interval.
+   */
+  meterInterval: RecurringInterval | null;
+  /**
+   * Number of meter interval units. None when no meter cycle is set.
+   */
+  meterIntervalCount: number | null;
   /**
    * Whether the product is a subscription.
    */
@@ -139,8 +147,10 @@ export const CustomerSubscriptionProduct$inboundSchema: z.ZodMiniType<
     name: z.string(),
     description: z.nullable(z.string()),
     visibility: ProductVisibility$inboundSchema,
-    recurring_interval: z.nullable(SubscriptionRecurringInterval$inboundSchema),
+    recurring_interval: z.nullable(RecurringInterval$inboundSchema),
     recurring_interval_count: z.nullable(z.int()),
+    meter_interval: z.nullable(RecurringInterval$inboundSchema),
+    meter_interval_count: z.nullable(z.int()),
     is_recurring: z.boolean(),
     is_archived: z.boolean(),
     organization_id: z.string(),
@@ -162,6 +172,8 @@ export const CustomerSubscriptionProduct$inboundSchema: z.ZodMiniType<
       "trial_interval_count": "trialIntervalCount",
       "recurring_interval": "recurringInterval",
       "recurring_interval_count": "recurringIntervalCount",
+      "meter_interval": "meterInterval",
+      "meter_interval_count": "meterIntervalCount",
       "is_recurring": "isRecurring",
       "is_archived": "isArchived",
       "organization_id": "organizationId",

package/src/models/components/customersubscriptionresume.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type CustomerSubscriptionResume = {
+  /**
+   * Resume a paused subscription immediately, starting a new billing period and charging the customer.
+   */
+  resume: true;
+};
+
+/** @internal */
+export type CustomerSubscriptionResume$Outbound = {
+  resume: true;
+};
+
+/** @internal */
+export const CustomerSubscriptionResume$outboundSchema: z.ZodMiniType<
+  CustomerSubscriptionResume$Outbound,
+  CustomerSubscriptionResume
+> = z.object({
+  resume: z.literal(true),
+});
+
+export function customerSubscriptionResumeToJSON(
+  customerSubscriptionResume: CustomerSubscriptionResume,
+): string {
+  return JSON.stringify(
+    CustomerSubscriptionResume$outboundSchema.parse(customerSubscriptionResume),
+  );
+}

package/src/models/components/customersubscriptionupdate.ts

@@ -9,6 +9,16 @@ import {
   CustomerSubscriptionCancel$Outbound,
   CustomerSubscriptionCancel$outboundSchema,
 } from "./customersubscriptioncancel.js";
+import {
+  CustomerSubscriptionPause,
+  CustomerSubscriptionPause$Outbound,
+  CustomerSubscriptionPause$outboundSchema,
+} from "./customersubscriptionpause.js";
+import {
+  CustomerSubscriptionResume,
+  CustomerSubscriptionResume$Outbound,
+  CustomerSubscriptionResume$outboundSchema,
+} from "./customersubscriptionresume.js";
 import {
   CustomerSubscriptionUpdateClear,
   CustomerSubscriptionUpdateClear$Outbound,
@@ -28,6 +38,8 @@ import {
 export type CustomerSubscriptionUpdate =
   | CustomerSubscriptionUpdateProduct
   | CustomerSubscriptionUpdateSeats
+  | CustomerSubscriptionPause
+  | CustomerSubscriptionResume
   | CustomerSubscriptionUpdateClear
   | CustomerSubscriptionCancel;
 
@@ -35,6 +47,8 @@ export type CustomerSubscriptionUpdate =
 export type CustomerSubscriptionUpdate$Outbound =
   | CustomerSubscriptionUpdateProduct$Outbound
   | CustomerSubscriptionUpdateSeats$Outbound
+  | CustomerSubscriptionPause$Outbound
+  | CustomerSubscriptionResume$Outbound
   | CustomerSubscriptionUpdateClear$Outbound
   | CustomerSubscriptionCancel$Outbound;
 
@@ -45,6 +59,8 @@ export const CustomerSubscriptionUpdate$outboundSchema: z.ZodMiniType<
 > = smartUnion([
   CustomerSubscriptionUpdateProduct$outboundSchema,
   CustomerSubscriptionUpdateSeats$outboundSchema,
+  CustomerSubscriptionPause$outboundSchema,
+  CustomerSubscriptionResume$outboundSchema,
   CustomerSubscriptionUpdateClear$outboundSchema,
   CustomerSubscriptionCancel$outboundSchema,
 ]);

package/src/models/components/customersubscriptionupdateseats.ts

@@ -3,46 +3,26 @@
  */
 
 import * as z from "zod/v4-mini";
-import { remap as remap$ } from "../../lib/primitives.js";
-import {
-  SubscriptionProrationBehavior,
-  SubscriptionProrationBehavior$outboundSchema,
-} from "./subscriptionprorationbehavior.js";
 
 export type CustomerSubscriptionUpdateSeats = {
   /**
    * Update the number of seats for this subscription.
    */
   seats: number;
-  /**
-   * Determine how to handle the proration billing. If not provided, will use the default organization setting.
-   */
-  prorationBehavior?: SubscriptionProrationBehavior | null | undefined;
 };
 
 /** @internal */
 export type CustomerSubscriptionUpdateSeats$Outbound = {
   seats: number;
-  proration_behavior?: string | null | undefined;
 };
 
 /** @internal */
 export const CustomerSubscriptionUpdateSeats$outboundSchema: z.ZodMiniType<
   CustomerSubscriptionUpdateSeats$Outbound,
   CustomerSubscriptionUpdateSeats
-> = z.pipe(
-  z.object({
-    seats: z.int(),
-    prorationBehavior: z.optional(
-      z.nullable(SubscriptionProrationBehavior$outboundSchema),
-    ),
-  }),
-  z.transform((v) => {
-    return remap$(v, {
-      prorationBehavior: "proration_behavior",
-    });
-  }),
-);
+> = z.object({
+  seats: z.int(),
+});
 
 export function customerSubscriptionUpdateSeatsToJSON(
   customerSubscriptionUpdateSeats: CustomerSubscriptionUpdateSeats,

package/src/models/components/customerteam.ts

@@ -65,6 +65,10 @@ export type CustomerTeam = {
    * The name of the customer.
    */
   name: string | null;
+  /**
+   * The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.
+   */
+  billingName: string | null;
   billingAddress: Address | null;
   taxId: Array<string | TaxIDFormat | null> | null;
   locale?: string | null | undefined;
@@ -80,7 +84,7 @@ export type CustomerTeam = {
    * Timestamp for when the customer was soft deleted.
    */
   deletedAt: Date | null;
-  avatarUrl: string;
+  avatarUrl: string | null;
 };
 
 /** @internal */
@@ -132,6 +136,7 @@ export const CustomerTeam$inboundSchema: z.ZodMiniType<CustomerTeam, unknown> =
       email_verified: z.boolean(),
       type: z.literal("team"),
       name: z.nullable(z.string()),
+      billing_name: z.nullable(z.string()),
       billing_address: z.nullable(Address$inboundSchema),
       tax_id: z.nullable(
         z.array(
@@ -144,7 +149,7 @@ export const CustomerTeam$inboundSchema: z.ZodMiniType<CustomerTeam, unknown> =
       deleted_at: z.nullable(
         z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
       ),
-      avatar_url: z.string(),
+      avatar_url: z.nullable(z.string()),
     }),
     z.transform((v) => {
       return remap$(v, {
@@ -152,6 +157,7 @@ export const CustomerTeam$inboundSchema: z.ZodMiniType<CustomerTeam, unknown> =
         "modified_at": "modifiedAt",
         "external_id": "externalId",
         "email_verified": "emailVerified",
+        "billing_name": "billingName",
         "billing_address": "billingAddress",
         "tax_id": "taxId",
         "organization_id": "organizationId",
@@ -172,13 +178,14 @@ export type CustomerTeam$Outbound = {
   email_verified: boolean;
   type: "team";
   name: string | null;
+  billing_name: string | null;
   billing_address: Address$Outbound | null;
   tax_id: Array<string | string | null> | null;
   locale?: string | null | undefined;
   organization_id: string;
   default_payment_method_id?: string | null | undefined;
   deleted_at: string | null;
-  avatar_url: string;
+  avatar_url: string | null;
 };
 
 /** @internal */
@@ -196,6 +203,7 @@ export const CustomerTeam$outboundSchema: z.ZodMiniType<
     emailVerified: z.boolean(),
     type: z.literal("team"),
     name: z.nullable(z.string()),
+    billingName: z.nullable(z.string()),
     billingAddress: z.nullable(Address$outboundSchema),
     taxId: z.nullable(
       z.array(z.nullable(smartUnion([z.string(), TaxIDFormat$outboundSchema]))),
@@ -204,7 +212,7 @@ export const CustomerTeam$outboundSchema: z.ZodMiniType<
     organizationId: z.string(),
     defaultPaymentMethodId: z.optional(z.nullable(z.string())),
     deletedAt: z.nullable(z.pipe(z.date(), z.transform(v => v.toISOString()))),
-    avatarUrl: z.string(),
+    avatarUrl: z.nullable(z.string()),
   }),
   z.transform((v) => {
     return remap$(v, {
@@ -212,6 +220,7 @@ export const CustomerTeam$outboundSchema: z.ZodMiniType<
       modifiedAt: "modified_at",
       externalId: "external_id",
       emailVerified: "email_verified",
+      billingName: "billing_name",
       billingAddress: "billing_address",
       taxId: "tax_id",
       organizationId: "organization_id",

package/src/models/components/customerupdatedfields.ts

@@ -14,6 +14,7 @@ export type CustomerUpdatedFieldsMetadata = string | number | boolean;
 
 export type CustomerUpdatedFields = {
   name?: string | null | undefined;
+  billingName?: string | null | undefined;
   email?: string | null | undefined;
   billingAddress?: AddressDict | null | undefined;
   taxId?: string | null | undefined;
@@ -43,6 +44,7 @@ export const CustomerUpdatedFields$inboundSchema: z.ZodMiniType<
 > = z.pipe(
   z.object({
     name: z.optional(z.nullable(z.string())),
+    billing_name: z.optional(z.nullable(z.string())),
     email: z.optional(z.nullable(z.string())),
     billing_address: z.optional(z.nullable(AddressDict$inboundSchema)),
     tax_id: z.optional(z.nullable(z.string())),
@@ -54,6 +56,7 @@ export const CustomerUpdatedFields$inboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
+      "billing_name": "billingName",
       "billing_address": "billingAddress",
       "tax_id": "taxId",
     });

package/src/models/components/discountproduct.ts

@@ -16,9 +16,9 @@ import {
   ProductVisibility$inboundSchema,
 } from "./productvisibility.js";
 import {
-  SubscriptionRecurringInterval,
-  SubscriptionRecurringInterval$inboundSchema,
-} from "./subscriptionrecurringinterval.js";
+  RecurringInterval,
+  RecurringInterval$inboundSchema,
+} from "./recurringinterval.js";
 import { TrialInterval, TrialInterval$inboundSchema } from "./trialinterval.js";
 
 /**
@@ -58,11 +58,19 @@ export type DiscountProduct = {
   /**
    * The recurring interval of the product. If `None`, the product is a one-time purchase.
    */
-  recurringInterval: SubscriptionRecurringInterval | null;
+  recurringInterval: RecurringInterval | null;
   /**
    * Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.
    */
   recurringIntervalCount: number | null;
+  /**
+   * The meter cycle of the product, independent of the billing interval. If `None`, metered concerns follow the billing interval.
+   */
+  meterInterval: RecurringInterval | null;
+  /**
+   * Number of meter interval units. None when no meter cycle is set.
+   */
+  meterIntervalCount: number | null;
   /**
    * Whether the product is a subscription.
    */
@@ -97,8 +105,10 @@ export const DiscountProduct$inboundSchema: z.ZodMiniType<
     name: z.string(),
     description: z.nullable(z.string()),
     visibility: ProductVisibility$inboundSchema,
-    recurring_interval: z.nullable(SubscriptionRecurringInterval$inboundSchema),
+    recurring_interval: z.nullable(RecurringInterval$inboundSchema),
     recurring_interval_count: z.nullable(z.int()),
+    meter_interval: z.nullable(RecurringInterval$inboundSchema),
+    meter_interval_count: z.nullable(z.int()),
     is_recurring: z.boolean(),
     is_archived: z.boolean(),
     organization_id: z.string(),
@@ -111,6 +121,8 @@ export const DiscountProduct$inboundSchema: z.ZodMiniType<
       "trial_interval_count": "trialIntervalCount",
       "recurring_interval": "recurringInterval",
       "recurring_interval_count": "recurringIntervalCount",
+      "meter_interval": "meterInterval",
+      "meter_interval_count": "meterIntervalCount",
       "is_recurring": "isRecurring",
       "is_archived": "isArchived",
       "organization_id": "organizationId",

package/src/models/components/dispute.ts

@@ -7,6 +7,10 @@ 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 {
+  DisputeCustomer,
+  DisputeCustomer$inboundSchema,
+} from "./disputecustomer.js";
 import { DisputeStatus, DisputeStatus$inboundSchema } from "./disputestatus.js";
 
 /**
@@ -50,6 +54,18 @@ export type Dispute = {
    * Currency code of the dispute.
    */
   currency: string;
+  /**
+   * The reason for the dispute as reported by the card network (e.g. `fraudulent`, `product_not_received`). `None` until the processor reports it.
+   */
+  reason: string | null;
+  /**
+   * Deadline to submit evidence in response to the dispute. `None` when no response is required.
+   */
+  evidenceDueBy: Date | null;
+  /**
+   * Whether the evidence submission deadline has passed.
+   */
+  pastDue: boolean;
   /**
    * The ID of the order associated with the dispute.
    */
@@ -58,6 +74,11 @@ export type Dispute = {
    * The ID of the payment associated with the dispute.
    */
   paymentId: string;
+  customer: DisputeCustomer;
+  /**
+   * The ID of the support case for this dispute, if one was opened.
+   */
+  caseId: string | null;
 };
 
 /** @internal */
@@ -77,16 +98,26 @@ export const Dispute$inboundSchema: z.ZodMiniType<Dispute, unknown> = z.pipe(
     amount: z.int(),
     tax_amount: z.int(),
     currency: z.string(),
+    reason: z.nullable(z.string()),
+    evidence_due_by: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    past_due: z.boolean(),
     order_id: z.string(),
     payment_id: z.string(),
+    customer: DisputeCustomer$inboundSchema,
+    case_id: z.nullable(z.string()),
   }),
   z.transform((v) => {
     return remap$(v, {
       "created_at": "createdAt",
       "modified_at": "modifiedAt",
       "tax_amount": "taxAmount",
+      "evidence_due_by": "evidenceDueBy",
+      "past_due": "pastDue",
       "order_id": "orderId",
       "payment_id": "paymentId",
+      "case_id": "caseId",
     });
   }),
 );