@stackbe/sdk 0.8.5 → 0.8.6

package/dist/index.d.mts

@@ -756,6 +756,27 @@ interface CustomerInvoicesResponse {
     invoices: CustomerInvoice[];
     hasMore: boolean;
 }
+interface CustomerPaymentMethod {
+    hasPaymentMethod: boolean;
+    card: {
+        brand: string;
+        last4: string;
+        expMonth: number;
+        expYear: number;
+    } | null;
+}
+interface BillingPortalSession {
+    url: string;
+}
+interface UpcomingInvoice {
+    amountDue: number;
+    currency: string;
+    dueDate: string | null;
+    lines: Array<{
+        description: string;
+        amount: number;
+    }>;
+}
 declare class CustomersClient {
     private http;
     private appId;
@@ -879,6 +900,55 @@ declare class CustomersClient {
     getInvoices(customerId: string, options?: {
         limit?: number;
     }): Promise<CustomerInvoicesResponse>;
+    /**
+     * Get the customer's saved payment method (card) from Stripe.
+     *
+     * @example
+     * ```typescript
+     * const paymentMethod = await stackbe.customers.getPaymentMethod('cust_123');
+     *
+     * if (paymentMethod.hasPaymentMethod && paymentMethod.card) {
+     *   console.log(`${paymentMethod.card.brand} ending in ${paymentMethod.card.last4}`);
+     *   console.log(`Expires: ${paymentMethod.card.expMonth}/${paymentMethod.card.expYear}`);
+     * }
+     * ```
+     */
+    getPaymentMethod(customerId: string): Promise<CustomerPaymentMethod>;
+    /**
+     * Create a Stripe billing portal session for the customer.
+     * Redirect the customer to the returned URL to let them manage their billing.
+     *
+     * @example
+     * ```typescript
+     * const { url } = await stackbe.customers.createBillingPortalSession('cust_123', {
+     *   returnUrl: 'https://myapp.com/account'
+     * });
+     *
+     * // Redirect customer to Stripe billing portal
+     * window.location.href = url;
+     * ```
+     */
+    createBillingPortalSession(customerId: string, options?: {
+        returnUrl?: string;
+    }): Promise<BillingPortalSession>;
+    /**
+     * Get the customer's upcoming invoice preview (next charge).
+     * Returns null if the customer has no active subscription.
+     *
+     * @example
+     * ```typescript
+     * const upcoming = await stackbe.customers.getUpcomingInvoice('cust_123');
+     *
+     * if (upcoming) {
+     *   console.log(`Next charge: $${upcoming.amountDue} ${upcoming.currency}`);
+     *   console.log(`Due: ${upcoming.dueDate}`);
+     *   upcoming.lines.forEach(line => {
+     *     console.log(`  ${line.description}: $${line.amount}`);
+     *   });
+     * }
+     * ```
+     */
+    getUpcomingInvoice(customerId: string): Promise<UpcomingInvoice | null>;
 }
 
 declare class CheckoutClient {
@@ -2146,4 +2216,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 CustomerInvoice, type CustomerInvoicesResponse, type CustomerSubscriptionHistory, type CustomerSubscriptionHistoryResponse, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestImage, 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 };
+export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, type AnyWebhookEvent, AuthClient, type BillingPortalSession, 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 CustomerInvoice, type CustomerInvoicesResponse, type CustomerPaymentMethod, type CustomerSubscriptionHistory, type CustomerSubscriptionHistoryResponse, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestImage, 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 UpcomingInvoice, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };

package/dist/index.d.ts

@@ -756,6 +756,27 @@ interface CustomerInvoicesResponse {
     invoices: CustomerInvoice[];
     hasMore: boolean;
 }
+interface CustomerPaymentMethod {
+    hasPaymentMethod: boolean;
+    card: {
+        brand: string;
+        last4: string;
+        expMonth: number;
+        expYear: number;
+    } | null;
+}
+interface BillingPortalSession {
+    url: string;
+}
+interface UpcomingInvoice {
+    amountDue: number;
+    currency: string;
+    dueDate: string | null;
+    lines: Array<{
+        description: string;
+        amount: number;
+    }>;
+}
 declare class CustomersClient {
     private http;
     private appId;
@@ -879,6 +900,55 @@ declare class CustomersClient {
     getInvoices(customerId: string, options?: {
         limit?: number;
     }): Promise<CustomerInvoicesResponse>;
+    /**
+     * Get the customer's saved payment method (card) from Stripe.
+     *
+     * @example
+     * ```typescript
+     * const paymentMethod = await stackbe.customers.getPaymentMethod('cust_123');
+     *
+     * if (paymentMethod.hasPaymentMethod && paymentMethod.card) {
+     *   console.log(`${paymentMethod.card.brand} ending in ${paymentMethod.card.last4}`);
+     *   console.log(`Expires: ${paymentMethod.card.expMonth}/${paymentMethod.card.expYear}`);
+     * }
+     * ```
+     */
+    getPaymentMethod(customerId: string): Promise<CustomerPaymentMethod>;
+    /**
+     * Create a Stripe billing portal session for the customer.
+     * Redirect the customer to the returned URL to let them manage their billing.
+     *
+     * @example
+     * ```typescript
+     * const { url } = await stackbe.customers.createBillingPortalSession('cust_123', {
+     *   returnUrl: 'https://myapp.com/account'
+     * });
+     *
+     * // Redirect customer to Stripe billing portal
+     * window.location.href = url;
+     * ```
+     */
+    createBillingPortalSession(customerId: string, options?: {
+        returnUrl?: string;
+    }): Promise<BillingPortalSession>;
+    /**
+     * Get the customer's upcoming invoice preview (next charge).
+     * Returns null if the customer has no active subscription.
+     *
+     * @example
+     * ```typescript
+     * const upcoming = await stackbe.customers.getUpcomingInvoice('cust_123');
+     *
+     * if (upcoming) {
+     *   console.log(`Next charge: $${upcoming.amountDue} ${upcoming.currency}`);
+     *   console.log(`Due: ${upcoming.dueDate}`);
+     *   upcoming.lines.forEach(line => {
+     *     console.log(`  ${line.description}: $${line.amount}`);
+     *   });
+     * }
+     * ```
+     */
+    getUpcomingInvoice(customerId: string): Promise<UpcomingInvoice | null>;
 }
 
 declare class CheckoutClient {
@@ -2146,4 +2216,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 CustomerInvoice, type CustomerInvoicesResponse, type CustomerSubscriptionHistory, type CustomerSubscriptionHistoryResponse, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestImage, 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 };
+export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, type AnyWebhookEvent, AuthClient, type BillingPortalSession, 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 CustomerInvoice, type CustomerInvoicesResponse, type CustomerPaymentMethod, type CustomerSubscriptionHistory, type CustomerSubscriptionHistoryResponse, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestImage, 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 UpcomingInvoice, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };

package/dist/index.js

@@ -651,6 +651,67 @@ var CustomersClient = class {
       params
     );
   }
+  // ==================== Billing Self-Service ====================
+  /**
+   * Get the customer's saved payment method (card) from Stripe.
+   *
+   * @example
+   * ```typescript
+   * const paymentMethod = await stackbe.customers.getPaymentMethod('cust_123');
+   *
+   * if (paymentMethod.hasPaymentMethod && paymentMethod.card) {
+   *   console.log(`${paymentMethod.card.brand} ending in ${paymentMethod.card.last4}`);
+   *   console.log(`Expires: ${paymentMethod.card.expMonth}/${paymentMethod.card.expYear}`);
+   * }
+   * ```
+   */
+  async getPaymentMethod(customerId) {
+    return this.http.get(
+      `/v1/apps/${this.appId}/customers/${customerId}/payment-method`
+    );
+  }
+  /**
+   * Create a Stripe billing portal session for the customer.
+   * Redirect the customer to the returned URL to let them manage their billing.
+   *
+   * @example
+   * ```typescript
+   * const { url } = await stackbe.customers.createBillingPortalSession('cust_123', {
+   *   returnUrl: 'https://myapp.com/account'
+   * });
+   *
+   * // Redirect customer to Stripe billing portal
+   * window.location.href = url;
+   * ```
+   */
+  async createBillingPortalSession(customerId, options) {
+    return this.http.post(
+      `/v1/apps/${this.appId}/customers/${customerId}/billing-portal`,
+      { returnUrl: options?.returnUrl }
+    );
+  }
+  /**
+   * Get the customer's upcoming invoice preview (next charge).
+   * Returns null if the customer has no active subscription.
+   *
+   * @example
+   * ```typescript
+   * const upcoming = await stackbe.customers.getUpcomingInvoice('cust_123');
+   *
+   * if (upcoming) {
+   *   console.log(`Next charge: $${upcoming.amountDue} ${upcoming.currency}`);
+   *   console.log(`Due: ${upcoming.dueDate}`);
+   *   upcoming.lines.forEach(line => {
+   *     console.log(`  ${line.description}: $${line.amount}`);
+   *   });
+   * }
+   * ```
+   */
+  async getUpcomingInvoice(customerId) {
+    return this.http.get(
+      `/v1/apps/${this.appId}/customers/${customerId}/upcoming-invoice`
+    );
+  }
 };
 
 // src/checkout.ts

package/dist/index.mjs

@@ -612,6 +612,67 @@ var CustomersClient = class {
       params
     );
   }
+  // ==================== Billing Self-Service ====================
+  /**
+   * Get the customer's saved payment method (card) from Stripe.
+   *
+   * @example
+   * ```typescript
+   * const paymentMethod = await stackbe.customers.getPaymentMethod('cust_123');
+   *
+   * if (paymentMethod.hasPaymentMethod && paymentMethod.card) {
+   *   console.log(`${paymentMethod.card.brand} ending in ${paymentMethod.card.last4}`);
+   *   console.log(`Expires: ${paymentMethod.card.expMonth}/${paymentMethod.card.expYear}`);
+   * }
+   * ```
+   */
+  async getPaymentMethod(customerId) {
+    return this.http.get(
+      `/v1/apps/${this.appId}/customers/${customerId}/payment-method`
+    );
+  }
+  /**
+   * Create a Stripe billing portal session for the customer.
+   * Redirect the customer to the returned URL to let them manage their billing.
+   *
+   * @example
+   * ```typescript
+   * const { url } = await stackbe.customers.createBillingPortalSession('cust_123', {
+   *   returnUrl: 'https://myapp.com/account'
+   * });
+   *
+   * // Redirect customer to Stripe billing portal
+   * window.location.href = url;
+   * ```
+   */
+  async createBillingPortalSession(customerId, options) {
+    return this.http.post(
+      `/v1/apps/${this.appId}/customers/${customerId}/billing-portal`,
+      { returnUrl: options?.returnUrl }
+    );
+  }
+  /**
+   * Get the customer's upcoming invoice preview (next charge).
+   * Returns null if the customer has no active subscription.
+   *
+   * @example
+   * ```typescript
+   * const upcoming = await stackbe.customers.getUpcomingInvoice('cust_123');
+   *
+   * if (upcoming) {
+   *   console.log(`Next charge: $${upcoming.amountDue} ${upcoming.currency}`);
+   *   console.log(`Due: ${upcoming.dueDate}`);
+   *   upcoming.lines.forEach(line => {
+   *     console.log(`  ${line.description}: $${line.amount}`);
+   *   });
+   * }
+   * ```
+   */
+  async getUpcomingInvoice(customerId) {
+    return this.http.get(
+      `/v1/apps/${this.appId}/customers/${customerId}/upcoming-invoice`
+    );
+  }
 };
 
 // src/checkout.ts

package/package.json

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