@stackbe/sdk 0.5.0 → 0.6.0

package/dist/index.d.mts

@@ -184,6 +184,10 @@ interface Subscription {
     currentPeriodStart: string;
     currentPeriodEnd: string;
     cancelAtPeriodEnd: boolean;
+    /** When the subscription was paused (null if not paused) */
+    pausedAt?: string | null;
+    /** When the subscription will auto-resume (null = indefinite pause) */
+    resumesAt?: string | null;
     createdAt: string;
 }
 interface CustomerWithSubscription extends Customer {
@@ -378,6 +382,10 @@ interface SubscriptionWebhookPayload {
     currentPeriodEnd: string;
     cancelAtPeriodEnd: boolean;
     trialEnd?: string;
+    /** When the subscription was paused (null if not paused) */
+    pausedAt?: string | null;
+    /** When the subscription will auto-resume (null = indefinite pause) */
+    resumesAt?: string | null;
 }
 /** Customer webhook payload */
 interface CustomerWebhookPayload {
@@ -860,6 +868,50 @@ declare class SubscriptionsClient {
      * ```
      */
     isActive(customerId: string): Promise<boolean>;
+    /**
+     * Pause a subscription.
+     *
+     * Pauses billing collection for a subscription. The subscription remains
+     * active but no invoices are generated while paused. Use cases include:
+     * - Customer requests temporary pause (vacation, budget constraints)
+     * - Seasonal businesses with predictable downtime
+     * - Retention strategy: offer pause instead of cancel
+     *
+     * @example
+     * ```typescript
+     * // Pause indefinitely (until manually resumed)
+     * await stackbe.subscriptions.pause('sub_123');
+     *
+     * // Pause for 30 days (auto-resume)
+     * const resumeDate = new Date();
+     * resumeDate.setDate(resumeDate.getDate() + 30);
+     * await stackbe.subscriptions.pause('sub_123', { resumesAt: resumeDate });
+     *
+     * // Check if paused
+     * const sub = await stackbe.subscriptions.get('cust_123');
+     * if (sub?.pausedAt) {
+     *   console.log('Subscription is paused');
+     *   if (sub.resumesAt) {
+     *     console.log(`Will resume on ${sub.resumesAt}`);
+     *   }
+     * }
+     * ```
+     */
+    pause(subscriptionId: string, options?: {
+        resumesAt?: Date;
+    }): Promise<Subscription>;
+    /**
+     * Resume a paused subscription.
+     *
+     * Restarts billing collection for a paused subscription.
+     *
+     * @example
+     * ```typescript
+     * // Resume a paused subscription
+     * await stackbe.subscriptions.resume('sub_123');
+     * ```
+     */
+    resume(subscriptionId: string): Promise<Subscription>;
 }
 
 interface AuthClientOptions {

package/dist/index.d.ts

@@ -184,6 +184,10 @@ interface Subscription {
     currentPeriodStart: string;
     currentPeriodEnd: string;
     cancelAtPeriodEnd: boolean;
+    /** When the subscription was paused (null if not paused) */
+    pausedAt?: string | null;
+    /** When the subscription will auto-resume (null = indefinite pause) */
+    resumesAt?: string | null;
     createdAt: string;
 }
 interface CustomerWithSubscription extends Customer {
@@ -378,6 +382,10 @@ interface SubscriptionWebhookPayload {
     currentPeriodEnd: string;
     cancelAtPeriodEnd: boolean;
     trialEnd?: string;
+    /** When the subscription was paused (null if not paused) */
+    pausedAt?: string | null;
+    /** When the subscription will auto-resume (null = indefinite pause) */
+    resumesAt?: string | null;
 }
 /** Customer webhook payload */
 interface CustomerWebhookPayload {
@@ -860,6 +868,50 @@ declare class SubscriptionsClient {
      * ```
      */
     isActive(customerId: string): Promise<boolean>;
+    /**
+     * Pause a subscription.
+     *
+     * Pauses billing collection for a subscription. The subscription remains
+     * active but no invoices are generated while paused. Use cases include:
+     * - Customer requests temporary pause (vacation, budget constraints)
+     * - Seasonal businesses with predictable downtime
+     * - Retention strategy: offer pause instead of cancel
+     *
+     * @example
+     * ```typescript
+     * // Pause indefinitely (until manually resumed)
+     * await stackbe.subscriptions.pause('sub_123');
+     *
+     * // Pause for 30 days (auto-resume)
+     * const resumeDate = new Date();
+     * resumeDate.setDate(resumeDate.getDate() + 30);
+     * await stackbe.subscriptions.pause('sub_123', { resumesAt: resumeDate });
+     *
+     * // Check if paused
+     * const sub = await stackbe.subscriptions.get('cust_123');
+     * if (sub?.pausedAt) {
+     *   console.log('Subscription is paused');
+     *   if (sub.resumesAt) {
+     *     console.log(`Will resume on ${sub.resumesAt}`);
+     *   }
+     * }
+     * ```
+     */
+    pause(subscriptionId: string, options?: {
+        resumesAt?: Date;
+    }): Promise<Subscription>;
+    /**
+     * Resume a paused subscription.
+     *
+     * Restarts billing collection for a paused subscription.
+     *
+     * @example
+     * ```typescript
+     * // Resume a paused subscription
+     * await stackbe.subscriptions.resume('sub_123');
+     * ```
+     */
+    resume(subscriptionId: string): Promise<Subscription>;
 }
 
 interface AuthClientOptions {

package/dist/index.js

@@ -802,6 +802,59 @@ var SubscriptionsClient = class {
     const subscription = await this.get(customerId);
     return subscription !== null && (subscription.status === "active" || subscription.status === "trialing");
   }
+  /**
+   * Pause a subscription.
+   *
+   * Pauses billing collection for a subscription. The subscription remains
+   * active but no invoices are generated while paused. Use cases include:
+   * - Customer requests temporary pause (vacation, budget constraints)
+   * - Seasonal businesses with predictable downtime
+   * - Retention strategy: offer pause instead of cancel
+   *
+   * @example
+   * ```typescript
+   * // Pause indefinitely (until manually resumed)
+   * await stackbe.subscriptions.pause('sub_123');
+   *
+   * // Pause for 30 days (auto-resume)
+   * const resumeDate = new Date();
+   * resumeDate.setDate(resumeDate.getDate() + 30);
+   * await stackbe.subscriptions.pause('sub_123', { resumesAt: resumeDate });
+   *
+   * // Check if paused
+   * const sub = await stackbe.subscriptions.get('cust_123');
+   * if (sub?.pausedAt) {
+   *   console.log('Subscription is paused');
+   *   if (sub.resumesAt) {
+   *     console.log(`Will resume on ${sub.resumesAt}`);
+   *   }
+   * }
+   * ```
+   */
+  async pause(subscriptionId, options = {}) {
+    return this.http.post(
+      `/v1/subscriptions/${subscriptionId}/pause`,
+      {
+        resumesAt: options.resumesAt?.toISOString()
+      }
+    );
+  }
+  /**
+   * Resume a paused subscription.
+   *
+   * Restarts billing collection for a paused subscription.
+   *
+   * @example
+   * ```typescript
+   * // Resume a paused subscription
+   * await stackbe.subscriptions.resume('sub_123');
+   * ```
+   */
+  async resume(subscriptionId) {
+    return this.http.post(
+      `/v1/subscriptions/${subscriptionId}/resume`
+    );
+  }
 };
 
 // src/auth.ts

package/dist/index.mjs

@@ -769,6 +769,59 @@ var SubscriptionsClient = class {
     const subscription = await this.get(customerId);
     return subscription !== null && (subscription.status === "active" || subscription.status === "trialing");
   }
+  /**
+   * Pause a subscription.
+   *
+   * Pauses billing collection for a subscription. The subscription remains
+   * active but no invoices are generated while paused. Use cases include:
+   * - Customer requests temporary pause (vacation, budget constraints)
+   * - Seasonal businesses with predictable downtime
+   * - Retention strategy: offer pause instead of cancel
+   *
+   * @example
+   * ```typescript
+   * // Pause indefinitely (until manually resumed)
+   * await stackbe.subscriptions.pause('sub_123');
+   *
+   * // Pause for 30 days (auto-resume)
+   * const resumeDate = new Date();
+   * resumeDate.setDate(resumeDate.getDate() + 30);
+   * await stackbe.subscriptions.pause('sub_123', { resumesAt: resumeDate });
+   *
+   * // Check if paused
+   * const sub = await stackbe.subscriptions.get('cust_123');
+   * if (sub?.pausedAt) {
+   *   console.log('Subscription is paused');
+   *   if (sub.resumesAt) {
+   *     console.log(`Will resume on ${sub.resumesAt}`);
+   *   }
+   * }
+   * ```
+   */
+  async pause(subscriptionId, options = {}) {
+    return this.http.post(
+      `/v1/subscriptions/${subscriptionId}/pause`,
+      {
+        resumesAt: options.resumesAt?.toISOString()
+      }
+    );
+  }
+  /**
+   * Resume a paused subscription.
+   *
+   * Restarts billing collection for a paused subscription.
+   *
+   * @example
+   * ```typescript
+   * // Resume a paused subscription
+   * await stackbe.subscriptions.resume('sub_123');
+   * ```
+   */
+  async resume(subscriptionId) {
+    return this.http.post(
+      `/v1/subscriptions/${subscriptionId}/resume`
+    );
+  }
 };
 
 // src/auth.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackbe/sdk",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Official JavaScript/TypeScript SDK for StackBE - the billing backend for your side project",
   "main": "dist/index.js",
   "module": "dist/index.mjs",