@stackbe/sdk 0.8.1 → 0.8.3

package/dist/index.d.mts

@@ -372,14 +372,19 @@ interface CheckoutSessionResponse {
     /** Expiration time */
     expiresAt: string;
 }
+interface SubscriptionPlan {
+    id: string;
+    name: string;
+    priceCents: number;
+    currency: string;
+    interval: 'month' | 'year';
+}
 interface SubscriptionWithPlan extends Subscription {
-    plan: {
-        id: string;
-        name: string;
-        price: number;
-        interval: 'month' | 'year';
-        currency: string;
-    };
+    plan: SubscriptionPlan;
+}
+interface GetSubscriptionOptions {
+    /** Related objects to expand inline. Supported: plan */
+    expand?: ('plan')[];
 }
 interface CancelSubscriptionOptions {
     /** Cancel immediately or at end of billing period */
@@ -899,24 +904,34 @@ declare class SubscriptionsClient {
      * const subscription = await stackbe.subscriptions.get('cust_123');
      *
      * if (subscription) {
-     *   console.log(`Plan: ${subscription.plan.name}`);
      *   console.log(`Status: ${subscription.status}`);
      *   console.log(`Renews: ${subscription.currentPeriodEnd}`);
      * } else {
      *   console.log('No active subscription');
      * }
+     *
+     * // With expanded plan details
+     * const sub = await stackbe.subscriptions.get('cust_123', { expand: ['plan'] });
+     * if (sub) {
+     *   console.log(`Plan: ${sub.plan.name}`);
+     *   console.log(`Price: $${sub.plan.priceCents / 100}/${sub.plan.interval}`);
+     * }
      * ```
      */
-    get(customerId: string): Promise<SubscriptionWithPlan | null>;
+    get(customerId: string, options?: GetSubscriptionOptions): Promise<SubscriptionWithPlan | null>;
     /**
      * Get a subscription by ID.
      *
      * @example
      * ```typescript
      * const subscription = await stackbe.subscriptions.getById('sub_123');
+     *
+     * // With expanded plan details
+     * const sub = await stackbe.subscriptions.getById('sub_123', { expand: ['plan'] });
+     * console.log(`Plan: ${sub.plan.name}`);
      * ```
      */
-    getById(subscriptionId: string): Promise<SubscriptionWithPlan>;
+    getById(subscriptionId: string, options?: GetSubscriptionOptions): Promise<SubscriptionWithPlan>;
     /**
      * List all subscriptions for a customer.
      *
@@ -1416,7 +1431,14 @@ declare class ProductsClient {
 interface FeatureRequest {
     id: string;
     title: string;
+    /** @deprecated Use featureDetails instead */
     description?: string;
+    /** What currently happens (the current behavior you want to change) */
+    currentBehavior?: string;
+    /** Detailed description of the requested feature */
+    featureDetails?: string;
+    /** Why this feature is important */
+    whyItMatters?: string;
     status: 'new' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
     category?: string;
     authorId: string;
@@ -1435,10 +1457,17 @@ interface FeatureRequestComment {
 }
 interface CreateFeatureRequestOptions {
     title: string;
-    description?: string;
+    /** What currently happens (the current behavior you want to change) */
+    currentBehavior?: string;
+    /** Detailed description of the requested feature */
+    featureDetails?: string;
+    /** Why this feature is important */
+    whyItMatters?: string;
     category?: string;
     /** Customer ID for server-side creation with API key */
     customerId?: string;
+    /** @deprecated Use featureDetails instead */
+    description?: string;
 }
 interface ListFeatureRequestsOptions {
     status?: 'new' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
@@ -1523,14 +1552,16 @@ declare class FeatureRequestsClient {
      * // With customer session token
      * const request = await stackbe.featureRequests.create({
      *   title: 'Dark mode support',
-     *   description: 'Would love to have a dark theme option',
+     *   currentBehavior: 'The app only has a light theme',
+     *   featureDetails: 'Add a toggle to switch between light and dark themes',
+     *   whyItMatters: 'Reduces eye strain when working at night',
      *   category: 'UI',
      * });
      *
      * // With API key (server-side)
      * const request = await stackbe.featureRequests.create({
      *   title: 'Dark mode support',
-     *   description: 'Would love to have a dark theme option',
+     *   featureDetails: 'Add a toggle to switch between light and dark themes',
      *   customerId: 'cust_123',
      * });
      * ```
@@ -2042,4 +2073,4 @@ declare class StackBE {
     }): (req: any, res: any, next: any) => Promise<any>;
 }
 
-export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, type AnyWebhookEvent, AuthClient, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type CreateCheckoutOptions, type CreateCustomerOptions, type CreateEarlyAccessSignupOptions, type CreateFeatureRequestOptions, type CreateOrganizationOptions, type Customer, type CustomerCreatedEvent, type CustomerFeatureActivity, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestListResponse, FeatureRequestsClient, type InterestedCustomer, type InterestedCustomersResponse, type InviteMemberOptions, type ListEarlyAccessOptions, type ListFeatureRequestsOptions, type ListPlansOptions, type ListProductsOptions, type MagicLinkOptions, type MagicLinkResponse, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentSucceededEvent, type PaymentWebhookPayload, type Plan, PlansClient, type Product, ProductsClient, type SessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type TrackReferralResponse, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialStartedEvent, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };
+export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, type AnyWebhookEvent, AuthClient, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type CreateCheckoutOptions, type CreateCustomerOptions, type CreateEarlyAccessSignupOptions, type CreateFeatureRequestOptions, type CreateOrganizationOptions, type Customer, type CustomerCreatedEvent, type CustomerFeatureActivity, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestListResponse, FeatureRequestsClient, type GetSubscriptionOptions, type InterestedCustomer, type InterestedCustomersResponse, type InviteMemberOptions, type ListEarlyAccessOptions, type ListFeatureRequestsOptions, type ListPlansOptions, type ListProductsOptions, type MagicLinkOptions, type MagicLinkResponse, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentSucceededEvent, type PaymentWebhookPayload, type Plan, PlansClient, type Product, ProductsClient, type SessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionPlan, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type TrackReferralResponse, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialStartedEvent, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };

package/dist/index.d.ts

@@ -372,14 +372,19 @@ interface CheckoutSessionResponse {
     /** Expiration time */
     expiresAt: string;
 }
+interface SubscriptionPlan {
+    id: string;
+    name: string;
+    priceCents: number;
+    currency: string;
+    interval: 'month' | 'year';
+}
 interface SubscriptionWithPlan extends Subscription {
-    plan: {
-        id: string;
-        name: string;
-        price: number;
-        interval: 'month' | 'year';
-        currency: string;
-    };
+    plan: SubscriptionPlan;
+}
+interface GetSubscriptionOptions {
+    /** Related objects to expand inline. Supported: plan */
+    expand?: ('plan')[];
 }
 interface CancelSubscriptionOptions {
     /** Cancel immediately or at end of billing period */
@@ -899,24 +904,34 @@ declare class SubscriptionsClient {
      * const subscription = await stackbe.subscriptions.get('cust_123');
      *
      * if (subscription) {
-     *   console.log(`Plan: ${subscription.plan.name}`);
      *   console.log(`Status: ${subscription.status}`);
      *   console.log(`Renews: ${subscription.currentPeriodEnd}`);
      * } else {
      *   console.log('No active subscription');
      * }
+     *
+     * // With expanded plan details
+     * const sub = await stackbe.subscriptions.get('cust_123', { expand: ['plan'] });
+     * if (sub) {
+     *   console.log(`Plan: ${sub.plan.name}`);
+     *   console.log(`Price: $${sub.plan.priceCents / 100}/${sub.plan.interval}`);
+     * }
      * ```
      */
-    get(customerId: string): Promise<SubscriptionWithPlan | null>;
+    get(customerId: string, options?: GetSubscriptionOptions): Promise<SubscriptionWithPlan | null>;
     /**
      * Get a subscription by ID.
      *
      * @example
      * ```typescript
      * const subscription = await stackbe.subscriptions.getById('sub_123');
+     *
+     * // With expanded plan details
+     * const sub = await stackbe.subscriptions.getById('sub_123', { expand: ['plan'] });
+     * console.log(`Plan: ${sub.plan.name}`);
      * ```
      */
-    getById(subscriptionId: string): Promise<SubscriptionWithPlan>;
+    getById(subscriptionId: string, options?: GetSubscriptionOptions): Promise<SubscriptionWithPlan>;
     /**
      * List all subscriptions for a customer.
      *
@@ -1416,7 +1431,14 @@ declare class ProductsClient {
 interface FeatureRequest {
     id: string;
     title: string;
+    /** @deprecated Use featureDetails instead */
     description?: string;
+    /** What currently happens (the current behavior you want to change) */
+    currentBehavior?: string;
+    /** Detailed description of the requested feature */
+    featureDetails?: string;
+    /** Why this feature is important */
+    whyItMatters?: string;
     status: 'new' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
     category?: string;
     authorId: string;
@@ -1435,10 +1457,17 @@ interface FeatureRequestComment {
 }
 interface CreateFeatureRequestOptions {
     title: string;
-    description?: string;
+    /** What currently happens (the current behavior you want to change) */
+    currentBehavior?: string;
+    /** Detailed description of the requested feature */
+    featureDetails?: string;
+    /** Why this feature is important */
+    whyItMatters?: string;
     category?: string;
     /** Customer ID for server-side creation with API key */
     customerId?: string;
+    /** @deprecated Use featureDetails instead */
+    description?: string;
 }
 interface ListFeatureRequestsOptions {
     status?: 'new' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
@@ -1523,14 +1552,16 @@ declare class FeatureRequestsClient {
      * // With customer session token
      * const request = await stackbe.featureRequests.create({
      *   title: 'Dark mode support',
-     *   description: 'Would love to have a dark theme option',
+     *   currentBehavior: 'The app only has a light theme',
+     *   featureDetails: 'Add a toggle to switch between light and dark themes',
+     *   whyItMatters: 'Reduces eye strain when working at night',
      *   category: 'UI',
      * });
      *
      * // With API key (server-side)
      * const request = await stackbe.featureRequests.create({
      *   title: 'Dark mode support',
-     *   description: 'Would love to have a dark theme option',
+     *   featureDetails: 'Add a toggle to switch between light and dark themes',
      *   customerId: 'cust_123',
      * });
      * ```
@@ -2042,4 +2073,4 @@ declare class StackBE {
     }): (req: any, res: any, next: any) => Promise<any>;
 }
 
-export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, type AnyWebhookEvent, AuthClient, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type CreateCheckoutOptions, type CreateCustomerOptions, type CreateEarlyAccessSignupOptions, type CreateFeatureRequestOptions, type CreateOrganizationOptions, type Customer, type CustomerCreatedEvent, type CustomerFeatureActivity, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestListResponse, FeatureRequestsClient, type InterestedCustomer, type InterestedCustomersResponse, type InviteMemberOptions, type ListEarlyAccessOptions, type ListFeatureRequestsOptions, type ListPlansOptions, type ListProductsOptions, type MagicLinkOptions, type MagicLinkResponse, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentSucceededEvent, type PaymentWebhookPayload, type Plan, PlansClient, type Product, ProductsClient, type SessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type TrackReferralResponse, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialStartedEvent, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };
+export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, type AnyWebhookEvent, AuthClient, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type CreateCheckoutOptions, type CreateCustomerOptions, type CreateEarlyAccessSignupOptions, type CreateFeatureRequestOptions, type CreateOrganizationOptions, type Customer, type CustomerCreatedEvent, type CustomerFeatureActivity, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestListResponse, FeatureRequestsClient, type GetSubscriptionOptions, type InterestedCustomer, type InterestedCustomersResponse, type InviteMemberOptions, type ListEarlyAccessOptions, type ListFeatureRequestsOptions, type ListPlansOptions, type ListProductsOptions, type MagicLinkOptions, type MagicLinkResponse, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentSucceededEvent, type PaymentWebhookPayload, type Plan, PlansClient, type Product, ProductsClient, type SessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionPlan, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type TrackReferralResponse, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialStartedEvent, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };

package/dist/index.js

@@ -738,19 +738,29 @@ var SubscriptionsClient = class {
    * const subscription = await stackbe.subscriptions.get('cust_123');
    *
    * if (subscription) {
-   *   console.log(`Plan: ${subscription.plan.name}`);
    *   console.log(`Status: ${subscription.status}`);
    *   console.log(`Renews: ${subscription.currentPeriodEnd}`);
    * } else {
    *   console.log('No active subscription');
    * }
+   *
+   * // With expanded plan details
+   * const sub = await stackbe.subscriptions.get('cust_123', { expand: ['plan'] });
+   * if (sub) {
+   *   console.log(`Plan: ${sub.plan.name}`);
+   *   console.log(`Price: $${sub.plan.priceCents / 100}/${sub.plan.interval}`);
+   * }
    * ```
    */
-  async get(customerId) {
+  async get(customerId, options) {
     try {
+      const params = { customerId };
+      if (options?.expand?.length) {
+        params.expand = options.expand.join(",");
+      }
       return await this.http.get(
         `/v1/subscriptions/current`,
-        { customerId }
+        params
       );
     } catch (error) {
       if (error instanceof Error && "statusCode" in error && error.statusCode === 404) {
@@ -765,10 +775,18 @@ var SubscriptionsClient = class {
    * @example
    * ```typescript
    * const subscription = await stackbe.subscriptions.getById('sub_123');
+   *
+   * // With expanded plan details
+   * const sub = await stackbe.subscriptions.getById('sub_123', { expand: ['plan'] });
+   * console.log(`Plan: ${sub.plan.name}`);
    * ```
    */
-  async getById(subscriptionId) {
-    return this.http.get(`/v1/subscriptions/${subscriptionId}`);
+  async getById(subscriptionId, options) {
+    const params = {};
+    if (options?.expand?.length) {
+      params.expand = options.expand.join(",");
+    }
+    return this.http.get(`/v1/subscriptions/${subscriptionId}`, params);
   }
   /**
    * List all subscriptions for a customer.
@@ -1541,14 +1559,16 @@ var FeatureRequestsClient = class {
    * // With customer session token
    * const request = await stackbe.featureRequests.create({
    *   title: 'Dark mode support',
-   *   description: 'Would love to have a dark theme option',
+   *   currentBehavior: 'The app only has a light theme',
+   *   featureDetails: 'Add a toggle to switch between light and dark themes',
+   *   whyItMatters: 'Reduces eye strain when working at night',
    *   category: 'UI',
    * });
    *
    * // With API key (server-side)
    * const request = await stackbe.featureRequests.create({
    *   title: 'Dark mode support',
-   *   description: 'Would love to have a dark theme option',
+   *   featureDetails: 'Add a toggle to switch between light and dark themes',
    *   customerId: 'cust_123',
    * });
    * ```

package/dist/index.mjs

@@ -699,19 +699,29 @@ var SubscriptionsClient = class {
    * const subscription = await stackbe.subscriptions.get('cust_123');
    *
    * if (subscription) {
-   *   console.log(`Plan: ${subscription.plan.name}`);
    *   console.log(`Status: ${subscription.status}`);
    *   console.log(`Renews: ${subscription.currentPeriodEnd}`);
    * } else {
    *   console.log('No active subscription');
    * }
+   *
+   * // With expanded plan details
+   * const sub = await stackbe.subscriptions.get('cust_123', { expand: ['plan'] });
+   * if (sub) {
+   *   console.log(`Plan: ${sub.plan.name}`);
+   *   console.log(`Price: $${sub.plan.priceCents / 100}/${sub.plan.interval}`);
+   * }
    * ```
    */
-  async get(customerId) {
+  async get(customerId, options) {
     try {
+      const params = { customerId };
+      if (options?.expand?.length) {
+        params.expand = options.expand.join(",");
+      }
       return await this.http.get(
         `/v1/subscriptions/current`,
-        { customerId }
+        params
       );
     } catch (error) {
       if (error instanceof Error && "statusCode" in error && error.statusCode === 404) {
@@ -726,10 +736,18 @@ var SubscriptionsClient = class {
    * @example
    * ```typescript
    * const subscription = await stackbe.subscriptions.getById('sub_123');
+   *
+   * // With expanded plan details
+   * const sub = await stackbe.subscriptions.getById('sub_123', { expand: ['plan'] });
+   * console.log(`Plan: ${sub.plan.name}`);
    * ```
    */
-  async getById(subscriptionId) {
-    return this.http.get(`/v1/subscriptions/${subscriptionId}`);
+  async getById(subscriptionId, options) {
+    const params = {};
+    if (options?.expand?.length) {
+      params.expand = options.expand.join(",");
+    }
+    return this.http.get(`/v1/subscriptions/${subscriptionId}`, params);
   }
   /**
    * List all subscriptions for a customer.
@@ -1502,14 +1520,16 @@ var FeatureRequestsClient = class {
    * // With customer session token
    * const request = await stackbe.featureRequests.create({
    *   title: 'Dark mode support',
-   *   description: 'Would love to have a dark theme option',
+   *   currentBehavior: 'The app only has a light theme',
+   *   featureDetails: 'Add a toggle to switch between light and dark themes',
+   *   whyItMatters: 'Reduces eye strain when working at night',
    *   category: 'UI',
    * });
    *
    * // With API key (server-side)
    * const request = await stackbe.featureRequests.create({
    *   title: 'Dark mode support',
-   *   description: 'Would love to have a dark theme option',
+   *   featureDetails: 'Add a toggle to switch between light and dark themes',
    *   customerId: 'cust_123',
    * });
    * ```

package/package.json

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