@flexprice/sdk 2.1.38 → 2.1.40

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

@@ -0,0 +1,123 @@
+/*
+ * 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 { PauseMode, PauseMode$inboundSchema } from "./pause-mode.js";
+import { PauseStatus, PauseStatus$inboundSchema } from "./pause-status.js";
+import { ResumeMode, ResumeMode$inboundSchema } from "./resume-mode.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import { Status, Status$inboundSchema } from "./status.js";
+
+/**
+ * Response object containing subscription pause information
+ */
+export type SubscriptionPauseResponse = {
+  createdAt?: Date | undefined;
+  createdBy?: string | undefined;
+  /**
+   * EnvironmentID is the environment identifier for the pause
+   */
+  environmentId?: string | undefined;
+  /**
+   * ID is the unique identifier for the subscription pause
+   */
+  id?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  /**
+   * OriginalPeriodEnd is the end of the billing period when the pause was created
+   */
+  originalPeriodEnd?: Date | undefined;
+  /**
+   * OriginalPeriodStart is the start of the billing period when the pause was created
+   */
+  originalPeriodStart?: Date | undefined;
+  /**
+   * PauseEnd is when the pause will end (null for indefinite)
+   */
+  pauseEnd?: Date | undefined;
+  pauseMode?: PauseMode | undefined;
+  /**
+   * PauseStart is when the pause actually started
+   */
+  pauseStart?: Date | undefined;
+  pauseStatus?: PauseStatus | undefined;
+  /**
+   * Reason is the reason for pausing
+   */
+  reason?: string | undefined;
+  resumeMode?: ResumeMode | undefined;
+  /**
+   * ResumedAt is when the pause was actually ended (if manually resumed)
+   */
+  resumedAt?: Date | undefined;
+  status?: Status | undefined;
+  /**
+   * SubscriptionID is the identifier for the subscription
+   */
+  subscriptionId?: string | undefined;
+  tenantId?: string | undefined;
+  updatedAt?: Date | undefined;
+  updatedBy?: string | undefined;
+};
+
+/** @internal */
+export const SubscriptionPauseResponse$inboundSchema: z.ZodMiniType<
+  SubscriptionPauseResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: types.optional(types.date()),
+    created_by: types.optional(types.string()),
+    environment_id: types.optional(types.string()),
+    id: types.optional(types.string()),
+    metadata: types.optional(z.record(z.string(), types.string())),
+    original_period_end: types.optional(types.date()),
+    original_period_start: types.optional(types.date()),
+    pause_end: types.optional(types.date()),
+    pause_mode: types.optional(PauseMode$inboundSchema),
+    pause_start: types.optional(types.date()),
+    pause_status: types.optional(PauseStatus$inboundSchema),
+    reason: types.optional(types.string()),
+    resume_mode: types.optional(ResumeMode$inboundSchema),
+    resumed_at: types.optional(types.date()),
+    status: types.optional(Status$inboundSchema),
+    subscription_id: types.optional(types.string()),
+    tenant_id: types.optional(types.string()),
+    updated_at: types.optional(types.date()),
+    updated_by: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "created_by": "createdBy",
+      "environment_id": "environmentId",
+      "original_period_end": "originalPeriodEnd",
+      "original_period_start": "originalPeriodStart",
+      "pause_end": "pauseEnd",
+      "pause_mode": "pauseMode",
+      "pause_start": "pauseStart",
+      "pause_status": "pauseStatus",
+      "resume_mode": "resumeMode",
+      "resumed_at": "resumedAt",
+      "subscription_id": "subscriptionId",
+      "tenant_id": "tenantId",
+      "updated_at": "updatedAt",
+      "updated_by": "updatedBy",
+    });
+  }),
+);
+
+export function subscriptionPauseResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionPauseResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionPauseResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionPauseResponse' from JSON`,
+  );
+}

package/src/sdk/subscriptions.ts

@@ -21,12 +21,14 @@ import { subscriptionsGetSubscriptionV2 } from "../funcs/subscriptions-get-subsc
 import { subscriptionsGetSubscription } from "../funcs/subscriptions-get-subscription.js";
 import { subscriptionsListAllSubscriptionSchedules } from "../funcs/subscriptions-list-all-subscription-schedules.js";
 import { subscriptionsListSubscriptionSchedules } from "../funcs/subscriptions-list-subscription-schedules.js";
+import { subscriptionsPauseSubscription } from "../funcs/subscriptions-pause-subscription.js";
 import { subscriptionsPreviewSubscriptionChange } from "../funcs/subscriptions-preview-subscription-change.js";
 import { subscriptionsPreviewSubscriptionModify } from "../funcs/subscriptions-preview-subscription-modify.js";
 import { subscriptionsPreviewSubscriptionPlanChangeV2 } from "../funcs/subscriptions-preview-subscription-plan-change-v2.js";
 import { subscriptionsQuerySubscriptionLineItems } from "../funcs/subscriptions-query-subscription-line-items.js";
 import { subscriptionsQuerySubscription } from "../funcs/subscriptions-query-subscription.js";
 import { subscriptionsRemoveSubscriptionAddon } from "../funcs/subscriptions-remove-subscription-addon.js";
+import { subscriptionsResumeSubscription } from "../funcs/subscriptions-resume-subscription.js";
 import { subscriptionsUpdateSubscriptionLineItem } from "../funcs/subscriptions-update-subscription-line-item.js";
 import { subscriptionsUpdateSubscription } from "../funcs/subscriptions-update-subscription.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -503,6 +505,44 @@ export class Subscriptions extends ClientSDK {
     ));
   }
 
+  /**
+   * Pause subscription
+   *
+   * @remarks
+   * Use when a customer stops temporarily. Pauses an active subscription now: usage and arrear fixed charges up to the pause are billed on a closing invoice, and every paused period after it gets a $0 skipped invoice.
+   */
+  async pauseSubscription(
+    id: string,
+    body: models.PauseSubscriptionRequest,
+    options?: RequestOptions,
+  ): Promise<models.PauseSubscriptionResponse> {
+    return unwrapAsync(subscriptionsPauseSubscription(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * Resume subscription
+   *
+   * @remarks
+   * Use when a paused customer comes back. Resumes a paused subscription now on its existing billing anchor: the first period runs from the resume to the next billing date and its advance charges are invoiced at once.
+   */
+  async resumeSubscription(
+    id: string,
+    body: models.ResumeSubscriptionRequest,
+    options?: RequestOptions,
+  ): Promise<models.ResumeSubscriptionResponse> {
+    return unwrapAsync(subscriptionsResumeSubscription(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
   /**
    * List subscription schedules
    *