@flexprice/sdk 2.1.38 → 2.1.40

package/src/sdk/customers.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { customersCreateCustomerPortalSession } from "../funcs/customers-create-customer-portal-session.js";
 import { customersCreateCustomer } from "../funcs/customers-create-customer.js";
 import { customersDeleteCustomer } from "../funcs/customers-delete-customer.js";
 import { customersGetCustomerByExternalId } from "../funcs/customers-get-customer-by-external-id.js";
@@ -110,6 +111,23 @@ export class Customers extends ClientSDK {
     ));
   }
 
+  /**
+   * Create customer portal session
+   *
+   * @remarks
+   * Use when sending a customer to their self-serve billing portal (invoices, usage, payment methods). Returns a short-lived URL and token scoped to that customer.
+   */
+  async createCustomerPortalSession(
+    externalId: string,
+    options?: RequestOptions,
+  ): Promise<models.PortalSessionResponse> {
+    return unwrapAsync(customersCreateCustomerPortalSession(
+      this,
+      externalId,
+      options,
+    ));
+  }
+
   /**
    * Query customers
    *

package/src/sdk/models/analytics-view-definition.ts

@@ -30,6 +30,11 @@ import {
   AnalyticsVariable$Outbound,
   AnalyticsVariable$outboundSchema,
 } from "./analytics-variable.js";
+import {
+  Family,
+  Family$inboundSchema,
+  Family$outboundSchema,
+} from "./family.js";
 import {
   Metric,
   Metric$inboundSchema,
@@ -40,6 +45,7 @@ import { Shape, Shape$inboundSchema, Shape$outboundSchema } from "./shape.js";
 
 export type AnalyticsViewDefinition = {
   dimensions?: Array<string> | undefined;
+  family?: Family | undefined;
   filters?: Array<AnalyticsFilter> | undefined;
   limit?: number | undefined;
   metrics: Array<Metric>;
@@ -55,6 +61,7 @@ export const AnalyticsViewDefinition$inboundSchema: z.ZodMiniType<
   unknown
 > = z.object({
   dimensions: types.optional(z.array(types.string())),
+  family: types.optional(Family$inboundSchema),
   filters: types.optional(z.array(AnalyticsFilter$inboundSchema)),
   limit: types.optional(types.number()),
   metrics: z.array(Metric$inboundSchema),
@@ -66,6 +73,7 @@ export const AnalyticsViewDefinition$inboundSchema: z.ZodMiniType<
 /** @internal */
 export type AnalyticsViewDefinition$Outbound = {
   dimensions?: Array<string> | undefined;
+  family?: string | undefined;
   filters?: Array<AnalyticsFilter$Outbound> | undefined;
   limit?: number | undefined;
   metrics: Array<string>;
@@ -81,6 +89,7 @@ export const AnalyticsViewDefinition$outboundSchema: z.ZodMiniType<
   AnalyticsViewDefinition
 > = z.object({
   dimensions: z.optional(z.array(z.string())),
+  family: z.optional(Family$outboundSchema),
   filters: z.optional(z.array(AnalyticsFilter$outboundSchema)),
   limit: z.optional(z.int()),
   metrics: z.array(Metric$outboundSchema),

package/src/sdk/models/create-customer-portal-session-op.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 CreateCustomerPortalSessionRequest = {
+  /**
+   * Customer external ID
+   */
+  externalId: string;
+};
+
+/** @internal */
+export type CreateCustomerPortalSessionRequest$Outbound = {
+  external_id: string;
+};
+
+/** @internal */
+export const CreateCustomerPortalSessionRequest$outboundSchema: z.ZodMiniType<
+  CreateCustomerPortalSessionRequest$Outbound,
+  CreateCustomerPortalSessionRequest
+> = z.pipe(
+  z.object({
+    externalId: z.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      externalId: "external_id",
+    });
+  }),
+);
+
+export function createCustomerPortalSessionRequestToJSON(
+  createCustomerPortalSessionRequest: CreateCustomerPortalSessionRequest,
+): string {
+  return JSON.stringify(
+    CreateCustomerPortalSessionRequest$outboundSchema.parse(
+      createCustomerPortalSessionRequest,
+    ),
+  );
+}

package/src/sdk/models/family.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const Family = {
+  Usage: "usage",
+  Billing: "billing",
+} as const;
+export type Family = OpenEnum<typeof Family>;
+
+/** @internal */
+export const Family$inboundSchema: z.ZodMiniType<Family, unknown> = openEnums
+  .inboundSchema(Family);
+/** @internal */
+export const Family$outboundSchema: z.ZodMiniType<string, Family> = openEnums
+  .outboundSchema(Family);

package/src/sdk/models/index.ts

@@ -134,6 +134,7 @@ export * from "./create-coupon-request.js";
 export * from "./create-credit-grant-request.js";
 export * from "./create-credit-note-line-item-request.js";
 export * from "./create-credit-note-request.js";
+export * from "./create-customer-portal-session-op.js";
 export * from "./create-customer-request.js";
 export * from "./create-entitlement-request.js";
 export * from "./create-entity-integration-mapping-request.js";
@@ -258,6 +259,7 @@ export * from "./external-tax-details.js";
 export * from "./fact-status.js";
 export * from "./failure-point-type.js";
 export * from "./failure-point.js";
+export * from "./family.js";
 export * from "./feature-filter.js";
 export * from "./feature-response.js";
 export * from "./feature-type.js";
@@ -459,6 +461,9 @@ export * from "./override-line-item-request.js";
 export * from "./pagination-response.js";
 export * from "./pause-mode.js";
 export * from "./pause-status.js";
+export * from "./pause-subscription-op.js";
+export * from "./pause-subscription-request.js";
+export * from "./pause-subscription-response.js";
 export * from "./pay-invoice-params.js";
 export * from "./payment-action-type.js";
 export * from "./payment-action.js";
@@ -480,6 +485,7 @@ export * from "./plan-response.js";
 export * from "./plan-summary.js";
 export * from "./plan.js";
 export * from "./point-bucket.js";
+export * from "./portal-session-response.js";
 export * from "./preview-subscription-change-op.js";
 export * from "./preview-subscription-modify-op.js";
 export * from "./preview-subscription-plan-change-v2-op.js";
@@ -524,6 +530,9 @@ export * from "./reporting-unit.js";
 export * from "./reset-usage.js";
 export * from "./response-validation-error.js";
 export * from "./resume-mode.js";
+export * from "./resume-subscription-op.js";
+export * from "./resume-subscription-request.js";
+export * from "./resume-subscription-response.js";
 export * from "./retry-refund-op.js";
 export * from "./revenue-allocation-policy.js";
 export * from "./revenue-analytics-request.js";
@@ -592,6 +601,7 @@ export * from "./subscription-line-item-response.js";
 export * from "./subscription-modification-action.js";
 export * from "./subscription-modify-response.js";
 export * from "./subscription-modify-type.js";
+export * from "./subscription-pause-response.js";
 export * from "./subscription-phase-create-request.js";
 export * from "./subscription-phase-response.js";
 export * from "./subscription-price-create-request.js";

package/src/sdk/models/invoice-billing-reason.ts

@@ -15,6 +15,8 @@ export const InvoiceBillingReason = {
   Manual: "MANUAL",
   AutoInvoiceThreshold: "AUTO_INVOICE_THRESHOLD",
   WalletAutoTopup: "WALLET_AUTO_TOPUP",
+  SubscriptionPaused: "SUBSCRIPTION_PAUSED",
+  SubscriptionResume: "SUBSCRIPTION_RESUME",
 } as const;
 export type InvoiceBillingReason = ClosedEnum<typeof InvoiceBillingReason>;
 

package/src/sdk/models/metric.ts

@@ -9,6 +9,7 @@ import { OpenEnum } from "../../types/enums.js";
 export const Metric = {
   UsageQuantity: "usage_quantity",
   EventCount: "event_count",
+  InvoiceTotal: "invoice_total",
 } as const;
 export type Metric = OpenEnum<typeof Metric>;
 

package/src/sdk/models/modify-subscription-params.ts

@@ -18,6 +18,10 @@ export type ModifySubscriptionParams = {
   lineItemModifications?: Array<ModifySubscriptionLineItem> | undefined;
   modifyType?: ModifySubscriptionType | undefined;
   subscriptionId?: string | undefined;
+  /**
+   * TrialEndAt is where a trial_end checkout starts the first paid period.
+   */
+  trialEndAt?: Date | undefined;
 };
 
 /** @internal */
@@ -27,6 +31,7 @@ export type ModifySubscriptionParams$Outbound = {
     | undefined;
   modify_type?: string | undefined;
   subscription_id?: string | undefined;
+  trial_end_at?: string | undefined;
 };
 
 /** @internal */
@@ -40,12 +45,14 @@ export const ModifySubscriptionParams$outboundSchema: z.ZodMiniType<
     ),
     modifyType: z.optional(ModifySubscriptionType$outboundSchema),
     subscriptionId: z.optional(z.string()),
+    trialEndAt: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
   }),
   z.transform((v) => {
     return remap$(v, {
       lineItemModifications: "line_item_modifications",
       modifyType: "modify_type",
       subscriptionId: "subscription_id",
+      trialEndAt: "trial_end_at",
     });
   }),
 );

package/src/sdk/models/modify-subscription-type.ts

@@ -8,6 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 export const ModifySubscriptionType = {
   QuantityChange: "quantity_change",
   LineItemChange: "line_item_change",
+  TrialEnd: "trial_end",
 } as const;
 export type ModifySubscriptionType = ClosedEnum<typeof ModifySubscriptionType>;
 

package/src/sdk/models/pause-subscription-op.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  PauseSubscriptionRequest,
+  PauseSubscriptionRequest$Outbound,
+  PauseSubscriptionRequest$outboundSchema,
+} from "./pause-subscription-request.js";
+
+export type PauseSubscriptionRequestRequest = {
+  /**
+   * Subscription ID
+   */
+  id: string;
+  /**
+   * Pause subscription request
+   */
+  body: PauseSubscriptionRequest;
+};
+
+/** @internal */
+export type PauseSubscriptionRequestRequest$Outbound = {
+  id: string;
+  body: PauseSubscriptionRequest$Outbound;
+};
+
+/** @internal */
+export const PauseSubscriptionRequestRequest$outboundSchema: z.ZodMiniType<
+  PauseSubscriptionRequestRequest$Outbound,
+  PauseSubscriptionRequestRequest
+> = z.object({
+  id: z.string(),
+  body: PauseSubscriptionRequest$outboundSchema,
+});
+
+export function pauseSubscriptionRequestRequestToJSON(
+  pauseSubscriptionRequestRequest: PauseSubscriptionRequestRequest,
+): string {
+  return JSON.stringify(
+    PauseSubscriptionRequestRequest$outboundSchema.parse(
+      pauseSubscriptionRequestRequest,
+    ),
+  );
+}

package/src/sdk/models/pause-subscription-request.ts

@@ -0,0 +1,64 @@
+/*
+ * 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 {
+  ProrationBehavior,
+  ProrationBehavior$outboundSchema,
+} from "./proration-behavior.js";
+
+/**
+ * Pauses an active subscription now. Usage and arrear fixed charges up to the pause are billed on a closing invoice.
+ */
+export type PauseSubscriptionRequest = {
+  /**
+   * Metadata stored on the pause
+   *
+   * @remarks
+   * @Example {"requested_by": "customer", "channel": "support_ticket"}
+   */
+  metadata?: { [k: string]: string } | undefined;
+  prorationBehavior?: ProrationBehavior | undefined;
+  /**
+   * Reason for pausing the subscription
+   *
+   * @remarks
+   * @Description Optional reason for the pause. Maximum 255 characters
+   * @Example "Customer requested temporary suspension"
+   */
+  reason?: string | undefined;
+};
+
+/** @internal */
+export type PauseSubscriptionRequest$Outbound = {
+  metadata?: { [k: string]: string } | undefined;
+  proration_behavior?: string | undefined;
+  reason?: string | undefined;
+};
+
+/** @internal */
+export const PauseSubscriptionRequest$outboundSchema: z.ZodMiniType<
+  PauseSubscriptionRequest$Outbound,
+  PauseSubscriptionRequest
+> = z.pipe(
+  z.object({
+    metadata: z.optional(z.record(z.string(), z.string())),
+    prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
+    reason: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      prorationBehavior: "proration_behavior",
+    });
+  }),
+);
+
+export function pauseSubscriptionRequestToJSON(
+  pauseSubscriptionRequest: PauseSubscriptionRequest,
+): string {
+  return JSON.stringify(
+    PauseSubscriptionRequest$outboundSchema.parse(pauseSubscriptionRequest),
+  );
+}

package/src/sdk/models/pause-subscription-response.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  SubscriptionPauseResponse,
+  SubscriptionPauseResponse$inboundSchema,
+} from "./subscription-pause-response.js";
+import {
+  SubscriptionResponse,
+  SubscriptionResponse$inboundSchema,
+} from "./subscription-response.js";
+
+/**
+ * The paused subscription and its pause
+ */
+export type PauseSubscriptionResponse = {
+  /**
+   * Response object containing subscription pause information
+   */
+  pause?: SubscriptionPauseResponse | undefined;
+  subscription?: SubscriptionResponse | undefined;
+};
+
+/** @internal */
+export const PauseSubscriptionResponse$inboundSchema: z.ZodMiniType<
+  PauseSubscriptionResponse,
+  unknown
+> = z.object({
+  pause: types.optional(SubscriptionPauseResponse$inboundSchema),
+  subscription: types.optional(SubscriptionResponse$inboundSchema),
+});
+
+export function pauseSubscriptionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PauseSubscriptionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PauseSubscriptionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PauseSubscriptionResponse' from JSON`,
+  );
+}

package/src/sdk/models/portal-session-response.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type PortalSessionResponse = {
+  expiresAt?: Date | undefined;
+  token?: string | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const PortalSessionResponse$inboundSchema: z.ZodMiniType<
+  PortalSessionResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    expires_at: types.optional(types.date()),
+    token: types.optional(types.string()),
+    url: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "expires_at": "expiresAt",
+    });
+  }),
+);
+
+export function portalSessionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PortalSessionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PortalSessionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PortalSessionResponse' from JSON`,
+  );
+}

package/src/sdk/models/resume-subscription-op.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  ResumeSubscriptionRequest,
+  ResumeSubscriptionRequest$Outbound,
+  ResumeSubscriptionRequest$outboundSchema,
+} from "./resume-subscription-request.js";
+
+export type ResumeSubscriptionRequestRequest = {
+  /**
+   * Subscription ID
+   */
+  id: string;
+  /**
+   * Resume subscription request
+   */
+  body: ResumeSubscriptionRequest;
+};
+
+/** @internal */
+export type ResumeSubscriptionRequestRequest$Outbound = {
+  id: string;
+  body: ResumeSubscriptionRequest$Outbound;
+};
+
+/** @internal */
+export const ResumeSubscriptionRequestRequest$outboundSchema: z.ZodMiniType<
+  ResumeSubscriptionRequestRequest$Outbound,
+  ResumeSubscriptionRequestRequest
+> = z.object({
+  id: z.string(),
+  body: ResumeSubscriptionRequest$outboundSchema,
+});
+
+export function resumeSubscriptionRequestRequestToJSON(
+  resumeSubscriptionRequestRequest: ResumeSubscriptionRequestRequest,
+): string {
+  return JSON.stringify(
+    ResumeSubscriptionRequestRequest$outboundSchema.parse(
+      resumeSubscriptionRequestRequest,
+    ),
+  );
+}

package/src/sdk/models/resume-subscription-request.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 {
+  ProrationBehavior,
+  ProrationBehavior$outboundSchema,
+} from "./proration-behavior.js";
+
+/**
+ * Resumes a paused subscription now. The billing anchor is kept, so the first period runs from the resume time to the next billing date.
+ */
+export type ResumeSubscriptionRequest = {
+  /**
+   * Metadata merged into the pause
+   *
+   * @remarks
+   * @Example {"resumed_by": "admin"}
+   */
+  metadata?: { [k: string]: string } | undefined;
+  prorationBehavior?: ProrationBehavior | undefined;
+};
+
+/** @internal */
+export type ResumeSubscriptionRequest$Outbound = {
+  metadata?: { [k: string]: string } | undefined;
+  proration_behavior?: string | undefined;
+};
+
+/** @internal */
+export const ResumeSubscriptionRequest$outboundSchema: z.ZodMiniType<
+  ResumeSubscriptionRequest$Outbound,
+  ResumeSubscriptionRequest
+> = z.pipe(
+  z.object({
+    metadata: z.optional(z.record(z.string(), z.string())),
+    prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      prorationBehavior: "proration_behavior",
+    });
+  }),
+);
+
+export function resumeSubscriptionRequestToJSON(
+  resumeSubscriptionRequest: ResumeSubscriptionRequest,
+): string {
+  return JSON.stringify(
+    ResumeSubscriptionRequest$outboundSchema.parse(resumeSubscriptionRequest),
+  );
+}

package/src/sdk/models/resume-subscription-response.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  SubscriptionPauseResponse,
+  SubscriptionPauseResponse$inboundSchema,
+} from "./subscription-pause-response.js";
+import {
+  SubscriptionResponse,
+  SubscriptionResponse$inboundSchema,
+} from "./subscription-response.js";
+
+/**
+ * The resumed subscription and the pause it ended
+ */
+export type ResumeSubscriptionResponse = {
+  /**
+   * Response object containing subscription pause information
+   */
+  pause?: SubscriptionPauseResponse | undefined;
+  subscription?: SubscriptionResponse | undefined;
+};
+
+/** @internal */
+export const ResumeSubscriptionResponse$inboundSchema: z.ZodMiniType<
+  ResumeSubscriptionResponse,
+  unknown
+> = z.object({
+  pause: types.optional(SubscriptionPauseResponse$inboundSchema),
+  subscription: types.optional(SubscriptionResponse$inboundSchema),
+});
+
+export function resumeSubscriptionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ResumeSubscriptionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResumeSubscriptionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResumeSubscriptionResponse' from JSON`,
+  );
+}

package/src/sdk/models/shape.ts

@@ -9,6 +9,7 @@ import { OpenEnum } from "../../types/enums.js";
 export const Shape = {
   Timeseries: "timeseries",
   Breakdown: "breakdown",
+  Scalar: "scalar",
 } as const;
 export type Shape = OpenEnum<typeof Shape>;