@stardeckai/autumn-js 0.1.85

package/dist/next/client/cusTypes-BgJmgZt6.d.ts

@@ -0,0 +1,215 @@
+import { A as AppEnv, a as ProductItem, c as ProductItemInterval } from './prodTypes-G6W3NUPg.js';
+import { z } from 'zod/v4';
+
+declare enum ProductStatus {
+    Active = "active",
+    Expired = "expired",
+    Trialing = "trialing",
+    Scheduled = "scheduled",
+    PastDue = "past_due"
+}
+type CustomerExpandOption = "invoices" | "rewards" | "trials_used" | "entities" | "referrals" | "payment_method";
+
+type EntityExpandOption = "invoices";
+
+interface DeleteEntityResult {
+    success: boolean;
+}
+interface GetEntityParams {
+    expand?: EntityExpandOption[];
+}
+interface Entity {
+    id: string;
+    name: string;
+    customer_id: string;
+    created_at: number;
+    env: string;
+    products: CustomerProduct[];
+    features: Record<string, CustomerFeature>;
+    invoices?: CustomerInvoice[];
+}
+
+declare const CustomerBillingControlsSchema: z.ZodObject<{
+    auto_topups: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        threshold: z.ZodNumber;
+        quantity: z.ZodNumber;
+        purchase_limit: z.ZodOptional<z.ZodObject<{
+            interval: z.ZodEnum<{
+                hour: "hour";
+                day: "day";
+                week: "week";
+                month: "month";
+            }>;
+            interval_count: z.ZodDefault<z.ZodNumber>;
+            limit: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type CustomerBillingControls = z.infer<typeof CustomerBillingControlsSchema>;
+declare const CoreCusFeatureSchema: z.ZodObject<{
+    unlimited: z.ZodOptional<z.ZodBoolean>;
+    interval: z.ZodOptional<z.ZodEnum<typeof ProductItemInterval>>;
+    balance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    usage: z.ZodOptional<z.ZodNumber>;
+    included_usage: z.ZodOptional<z.ZodNumber>;
+    next_reset_at: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    overage_allowed: z.ZodOptional<z.ZodBoolean>;
+    usage_limit: z.ZodOptional<z.ZodNumber>;
+    rollovers: z.ZodOptional<z.ZodObject<{
+        balance: z.ZodNumber;
+        expires_at: z.ZodNumber;
+    }, z.core.$strip>>;
+    breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        interval: z.ZodEnum<typeof ProductItemInterval>;
+        balance: z.ZodOptional<z.ZodNumber>;
+        usage: z.ZodOptional<z.ZodNumber>;
+        included_usage: z.ZodOptional<z.ZodNumber>;
+        next_reset_at: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        credit_amount: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type CoreCustomerFeature = z.infer<typeof CoreCusFeatureSchema>;
+interface CustomerFeature extends CoreCustomerFeature {
+    id: string;
+    name: string;
+    type: "static" | "single_use" | "continuous_use";
+}
+interface CustomerReferral {
+    program_id: string;
+    customer: {
+        id: string;
+        name: string | null;
+        email: string | null;
+    };
+    reward_applied: boolean;
+    created_at: number;
+}
+interface CustomerProduct {
+    id: string;
+    name: string | null;
+    group: string | null;
+    status: ProductStatus;
+    started_at: number;
+    canceled_at: number | null;
+    version: number;
+    subscription_ids?: string[] | null;
+    current_period_start?: number | null;
+    current_period_end?: number | null;
+    trial_ends_at?: number;
+    entity_id?: string;
+    is_add_on: boolean;
+    is_default: boolean;
+    items: ProductItem[];
+}
+interface Customer {
+    id: string | null;
+    created_at: number;
+    name: string | null;
+    email: string | null;
+    fingerprint: string | null;
+    stripe_id: string | null;
+    env: AppEnv;
+    metadata: Record<string, any>;
+    send_email_receipts: boolean;
+    billing_controls: CustomerBillingControls;
+    products: CustomerProduct[];
+    features: Record<string, CustomerFeature>;
+    payment_method?: any;
+    referrals?: CustomerReferral[];
+}
+/**
+ * Maps expand option strings to their corresponding types.
+ * Used for conditional type expansion based on the expand parameter.
+ */
+interface CustomerExpandedFields {
+    invoices: CustomerInvoice[];
+    entities: Entity[];
+    referrals: CustomerReferral[];
+    rewards: unknown;
+    trials_used: unknown;
+    payment_method: unknown;
+}
+/**
+ * Utility type that creates a Customer with additional expanded fields
+ * based on the expand array passed to the API.
+ *
+ * @example
+ * // Base customer without expanded fields
+ * type Base = ExpandedCustomer<[]>;
+ *
+ * // Customer with invoices and entities expanded
+ * type WithExpansion = ExpandedCustomer<['invoices', 'entities']>;
+ * // Result: Customer & { invoices: CustomerInvoice[]; entities: Entity[] }
+ */
+type ExpandedCustomer<T extends readonly CustomerExpandOption[] = readonly []> = Customer & {
+    [K in T[number]]: CustomerExpandedFields[K];
+};
+declare const CustomerDataSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+type CustomerData = z.infer<typeof CustomerDataSchema>;
+declare const CreateCustomerParamsSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    expand: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        invoices: "invoices";
+        rewards: "rewards";
+        trials_used: "trials_used";
+        entities: "entities";
+        referrals: "referrals";
+        payment_method: "payment_method";
+    }>>>;
+    stripe_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    auto_enable_plan_id: z.ZodOptional<z.ZodString>;
+    billing_controls: z.ZodOptional<z.ZodObject<{
+        auto_topups: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            feature_id: z.ZodString;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            threshold: z.ZodNumber;
+            quantity: z.ZodNumber;
+            purchase_limit: z.ZodOptional<z.ZodObject<{
+                interval: z.ZodEnum<{
+                    hour: "hour";
+                    day: "day";
+                    week: "week";
+                    month: "month";
+                }>;
+                interval_count: z.ZodDefault<z.ZodNumber>;
+                limit: z.ZodNumber;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type CreateCustomerParamsBase = z.infer<typeof CreateCustomerParamsSchema>;
+/**
+ * Generic version of CreateCustomerParams that preserves the expand array type
+ * for proper ExpandedCustomer inference.
+ */
+interface CreateCustomerParams<T extends readonly CustomerExpandOption[] = readonly []> extends Omit<CreateCustomerParamsBase, "expand"> {
+    expand?: T;
+}
+interface BillingPortalResult {
+    customer_id: string;
+    url: string;
+}
+interface CustomerInvoice {
+    product_ids: string[];
+    stripe_id: string;
+    status: string;
+    total: number;
+    currency: string;
+    created_at: number;
+    hosted_invoice_url: string;
+}
+
+export type { BillingPortalResult as B, CustomerData as C, DeleteEntityResult as D, Entity as E, GetEntityParams as G, Customer as a, CustomerExpandOption as b, ExpandedCustomer as c, CreateCustomerParams as d };

package/dist/next/client/cusTypes-BngiltFz.d.mts

@@ -0,0 +1,215 @@
+import { A as AppEnv, a as ProductItem, c as ProductItemInterval } from './prodTypes-G6W3NUPg.mjs';
+import { z } from 'zod/v4';
+
+declare enum ProductStatus {
+    Active = "active",
+    Expired = "expired",
+    Trialing = "trialing",
+    Scheduled = "scheduled",
+    PastDue = "past_due"
+}
+type CustomerExpandOption = "invoices" | "rewards" | "trials_used" | "entities" | "referrals" | "payment_method";
+
+type EntityExpandOption = "invoices";
+
+interface DeleteEntityResult {
+    success: boolean;
+}
+interface GetEntityParams {
+    expand?: EntityExpandOption[];
+}
+interface Entity {
+    id: string;
+    name: string;
+    customer_id: string;
+    created_at: number;
+    env: string;
+    products: CustomerProduct[];
+    features: Record<string, CustomerFeature>;
+    invoices?: CustomerInvoice[];
+}
+
+declare const CustomerBillingControlsSchema: z.ZodObject<{
+    auto_topups: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        threshold: z.ZodNumber;
+        quantity: z.ZodNumber;
+        purchase_limit: z.ZodOptional<z.ZodObject<{
+            interval: z.ZodEnum<{
+                hour: "hour";
+                day: "day";
+                week: "week";
+                month: "month";
+            }>;
+            interval_count: z.ZodDefault<z.ZodNumber>;
+            limit: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type CustomerBillingControls = z.infer<typeof CustomerBillingControlsSchema>;
+declare const CoreCusFeatureSchema: z.ZodObject<{
+    unlimited: z.ZodOptional<z.ZodBoolean>;
+    interval: z.ZodOptional<z.ZodEnum<typeof ProductItemInterval>>;
+    balance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    usage: z.ZodOptional<z.ZodNumber>;
+    included_usage: z.ZodOptional<z.ZodNumber>;
+    next_reset_at: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    overage_allowed: z.ZodOptional<z.ZodBoolean>;
+    usage_limit: z.ZodOptional<z.ZodNumber>;
+    rollovers: z.ZodOptional<z.ZodObject<{
+        balance: z.ZodNumber;
+        expires_at: z.ZodNumber;
+    }, z.core.$strip>>;
+    breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        interval: z.ZodEnum<typeof ProductItemInterval>;
+        balance: z.ZodOptional<z.ZodNumber>;
+        usage: z.ZodOptional<z.ZodNumber>;
+        included_usage: z.ZodOptional<z.ZodNumber>;
+        next_reset_at: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        credit_amount: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type CoreCustomerFeature = z.infer<typeof CoreCusFeatureSchema>;
+interface CustomerFeature extends CoreCustomerFeature {
+    id: string;
+    name: string;
+    type: "static" | "single_use" | "continuous_use";
+}
+interface CustomerReferral {
+    program_id: string;
+    customer: {
+        id: string;
+        name: string | null;
+        email: string | null;
+    };
+    reward_applied: boolean;
+    created_at: number;
+}
+interface CustomerProduct {
+    id: string;
+    name: string | null;
+    group: string | null;
+    status: ProductStatus;
+    started_at: number;
+    canceled_at: number | null;
+    version: number;
+    subscription_ids?: string[] | null;
+    current_period_start?: number | null;
+    current_period_end?: number | null;
+    trial_ends_at?: number;
+    entity_id?: string;
+    is_add_on: boolean;
+    is_default: boolean;
+    items: ProductItem[];
+}
+interface Customer {
+    id: string | null;
+    created_at: number;
+    name: string | null;
+    email: string | null;
+    fingerprint: string | null;
+    stripe_id: string | null;
+    env: AppEnv;
+    metadata: Record<string, any>;
+    send_email_receipts: boolean;
+    billing_controls: CustomerBillingControls;
+    products: CustomerProduct[];
+    features: Record<string, CustomerFeature>;
+    payment_method?: any;
+    referrals?: CustomerReferral[];
+}
+/**
+ * Maps expand option strings to their corresponding types.
+ * Used for conditional type expansion based on the expand parameter.
+ */
+interface CustomerExpandedFields {
+    invoices: CustomerInvoice[];
+    entities: Entity[];
+    referrals: CustomerReferral[];
+    rewards: unknown;
+    trials_used: unknown;
+    payment_method: unknown;
+}
+/**
+ * Utility type that creates a Customer with additional expanded fields
+ * based on the expand array passed to the API.
+ *
+ * @example
+ * // Base customer without expanded fields
+ * type Base = ExpandedCustomer<[]>;
+ *
+ * // Customer with invoices and entities expanded
+ * type WithExpansion = ExpandedCustomer<['invoices', 'entities']>;
+ * // Result: Customer & { invoices: CustomerInvoice[]; entities: Entity[] }
+ */
+type ExpandedCustomer<T extends readonly CustomerExpandOption[] = readonly []> = Customer & {
+    [K in T[number]]: CustomerExpandedFields[K];
+};
+declare const CustomerDataSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+type CustomerData = z.infer<typeof CustomerDataSchema>;
+declare const CreateCustomerParamsSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    expand: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        invoices: "invoices";
+        rewards: "rewards";
+        trials_used: "trials_used";
+        entities: "entities";
+        referrals: "referrals";
+        payment_method: "payment_method";
+    }>>>;
+    stripe_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    auto_enable_plan_id: z.ZodOptional<z.ZodString>;
+    billing_controls: z.ZodOptional<z.ZodObject<{
+        auto_topups: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            feature_id: z.ZodString;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            threshold: z.ZodNumber;
+            quantity: z.ZodNumber;
+            purchase_limit: z.ZodOptional<z.ZodObject<{
+                interval: z.ZodEnum<{
+                    hour: "hour";
+                    day: "day";
+                    week: "week";
+                    month: "month";
+                }>;
+                interval_count: z.ZodDefault<z.ZodNumber>;
+                limit: z.ZodNumber;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type CreateCustomerParamsBase = z.infer<typeof CreateCustomerParamsSchema>;
+/**
+ * Generic version of CreateCustomerParams that preserves the expand array type
+ * for proper ExpandedCustomer inference.
+ */
+interface CreateCustomerParams<T extends readonly CustomerExpandOption[] = readonly []> extends Omit<CreateCustomerParamsBase, "expand"> {
+    expand?: T;
+}
+interface BillingPortalResult {
+    customer_id: string;
+    url: string;
+}
+interface CustomerInvoice {
+    product_ids: string[];
+    stripe_id: string;
+    status: string;
+    total: number;
+    currency: string;
+    created_at: number;
+    hosted_invoice_url: string;
+}
+
+export type { BillingPortalResult as B, CustomerData as C, DeleteEntityResult as D, Entity as E, GetEntityParams as G, Customer as a, CustomerExpandOption as b, ExpandedCustomer as c, CreateCustomerParams as d };

package/dist/next/client/error-DHbclCVh.d.mts

@@ -0,0 +1,17 @@
+interface ErrorResponse {
+    message: string;
+    code: string;
+}
+declare class AutumnError extends Error {
+    readonly message: string;
+    readonly code: string;
+    constructor(response: ErrorResponse);
+    static fromError(error: any): AutumnError;
+    toString(): string;
+    toJSON(): {
+        message: string;
+        code: string;
+    };
+}
+
+export { AutumnError as A };

package/dist/next/client/error-DHbclCVh.d.ts

@@ -0,0 +1,17 @@
+interface ErrorResponse {
+    message: string;
+    code: string;
+}
+declare class AutumnError extends Error {
+    readonly message: string;
+    readonly code: string;
+    constructor(response: ErrorResponse);
+    static fromError(error: any): AutumnError;
+    toString(): string;
+    toJSON(): {
+        message: string;
+        code: string;
+    };
+}
+
+export { AutumnError as A };

package/dist/next/client/hooks/useAutumn.d.mts

@@ -0,0 +1,20 @@
+import { A as AttachParams, T as TrackParams, a as TrackResult, C as CancelParams, b as CancelResult, O as OpenBillingPortalParams, S as SetupPaymentParams, c as SetupPaymentResult, d as CheckoutParams } from '../clientAttachTypes-CZ0FmsbF.mjs';
+import { A as AutumnPromise } from '../response-DKQ_cb7U.mjs';
+import { B as BillingPortalResult } from '../cusTypes-BngiltFz.mjs';
+import '../prodTypes-G6W3NUPg.mjs';
+import 'zod/v4';
+import '../error-DHbclCVh.mjs';
+
+declare const useAutumn: () => {
+    attach: (params: AttachParams) => Promise<any>;
+    track: (params: TrackParams) => AutumnPromise<TrackResult>;
+    cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
+    openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
+    setupPayment: (params?: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
+    checkout: (params: CheckoutParams) => Promise<{
+        data: any;
+        error: any;
+    }>;
+};
+
+export { useAutumn };

package/dist/next/client/hooks/useAutumn.d.ts

@@ -0,0 +1,20 @@
+import { A as AttachParams, T as TrackParams, a as TrackResult, C as CancelParams, b as CancelResult, O as OpenBillingPortalParams, S as SetupPaymentParams, c as SetupPaymentResult, d as CheckoutParams } from '../clientAttachTypes-Dczm087t.js';
+import { A as AutumnPromise } from '../response-CLgEplsF.js';
+import { B as BillingPortalResult } from '../cusTypes-BgJmgZt6.js';
+import '../prodTypes-G6W3NUPg.js';
+import 'zod/v4';
+import '../error-DHbclCVh.js';
+
+declare const useAutumn: () => {
+    attach: (params: AttachParams) => Promise<any>;
+    track: (params: TrackParams) => AutumnPromise<TrackResult>;
+    cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
+    openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
+    setupPayment: (params?: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
+    checkout: (params: CheckoutParams) => Promise<{
+        data: any;
+        error: any;
+    }>;
+};
+
+export { useAutumn };

package/dist/next/client/hooks/useAutumn.js

@@ -0,0 +1,17 @@
+"use client";
+
+import {
+  AutumnContext,
+  useAutumnContext
+} from "../../../libraries/react/AutumnContext";
+import { useAutumnBase } from "../../../libraries/react/hooks/helpers/useAutumnBase";
+const useAutumn = () => {
+  const context = useAutumnContext({
+    AutumnContext,
+    name: "useAutumn"
+  });
+  return useAutumnBase({ context, client: context.client });
+};
+export {
+  useAutumn
+};

package/dist/next/client/hooks/useAutumn.mjs

@@ -0,0 +1,17 @@
+"use client";
+
+import {
+  AutumnContext,
+  useAutumnContext
+} from "../../../libraries/react/AutumnContext";
+import { useAutumnBase } from "../../../libraries/react/hooks/helpers/useAutumnBase";
+const useAutumn = () => {
+  const context = useAutumnContext({
+    AutumnContext,
+    name: "useAutumn"
+  });
+  return useAutumnBase({ context, client: context.client });
+};
+export {
+  useAutumn
+};

package/dist/next/client/hooks/useCustomer.d.mts

@@ -0,0 +1,89 @@
+import { b as CustomerExpandOption, c as ExpandedCustomer, B as BillingPortalResult, E as Entity } from '../cusTypes-BngiltFz.mjs';
+import { A as AttachParams, f as CheckResult, T as TrackParams, a as TrackResult, C as CancelParams, b as CancelResult, S as SetupPaymentParams, c as SetupPaymentResult, O as OpenBillingPortalParams, d as CheckoutParams, e as CheckParams } from '../clientAttachTypes-CZ0FmsbF.mjs';
+import { A as AttachResult, C as CheckoutResult, a as CreateEntityParams, b as CreateReferralCodeResult, R as RedeemReferralCodeResult } from '../clientEntTypes-jltPLNQ5.mjs';
+import { A as AutumnPromise, S as Success } from '../response-DKQ_cb7U.mjs';
+import { A as AutumnError } from '../error-DHbclCVh.mjs';
+import { SWRConfiguration } from 'swr';
+import { z } from 'zod/v4';
+import '../prodTypes-G6W3NUPg.mjs';
+
+declare const CreateReferralCodeParamsSchema: z.ZodObject<{
+    programId: z.ZodString;
+}, z.core.$strip>;
+type CreateReferralCodeParams = z.infer<typeof CreateReferralCodeParamsSchema>;
+declare const RedeemReferralCodeParamsSchema: z.ZodObject<{
+    code: z.ZodString;
+}, z.core.$strip>;
+type RedeemReferralCodeParams = z.infer<typeof RedeemReferralCodeParamsSchema>;
+
+interface UseCustomerResult<T extends readonly CustomerExpandOption[] = readonly []> {
+    /** The current customer data including subscription and feature information */
+    customer: ExpandedCustomer<T> | null;
+    /** Whether customer data is currently being loaded */
+    isLoading: boolean;
+    /** Any error that occurred while fetching customer data */
+    error: AutumnError | null;
+    /**
+     * Attaches a product to the current customer, enabling access and handling billing.
+     * Activates a product and applies all product items with automatic payment handling.
+     */
+    attach: (params: AttachParams) => AutumnPromise<AttachResult | CheckResult>;
+    /**
+     * Tracks usage events for metered features.
+     * Records feature usage and updates customer balances server-side.
+     */
+    track: (params: TrackParams) => AutumnPromise<TrackResult>;
+    /**
+     * Cancels a customer's subscription or product attachment.
+     * Can cancel immediately or at the end of the billing cycle.
+     */
+    cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
+    /**
+     * Sets up a payment method for the customer.
+     * Collects payment information without immediately charging.
+     */
+    setupPayment: (params?: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
+    /**
+     * Opens the Stripe billing portal for the customer.
+     * Allows customers to manage their subscription and payment methods.
+     */
+    openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
+    /**
+     * Initiates a checkout flow for product purchase.
+     * Handles payment collection and redirects to Stripe checkout when needed.
+     */
+    checkout: (params: CheckoutParams) => AutumnPromise<CheckoutResult>;
+    /** Refetches the customer data from the server */
+    refetch: () => Promise<ExpandedCustomer<T> | null>;
+    /**
+     * Creates new entities for granular feature tracking.
+     * Entities allow per-user or per-workspace feature limits.
+     */
+    createEntity: (params: CreateEntityParams | CreateEntityParams[]) => AutumnPromise<Entity | Entity[]>;
+    /**
+     * Creates a referral code for the customer.
+     * Generates codes that can be shared for referral programs.
+     */
+    createReferralCode: (params: CreateReferralCodeParams) => AutumnPromise<CreateReferralCodeResult>;
+    /**
+     * Redeems a referral code for the customer.
+     * Applies referral benefits when a valid code is provided.
+     */
+    redeemReferralCode: (params: RedeemReferralCodeParams) => AutumnPromise<RedeemReferralCodeResult>;
+    /**
+     * Checks if a customer has access to a feature and shows paywalls if needed.
+     * Client-side feature gating with optional dialog display for upgrades.
+     */
+    check: (params: CheckParams) => Success<CheckResult>;
+}
+interface UseCustomerParams<T extends readonly CustomerExpandOption[] = readonly []> {
+    errorOnNotFound?: boolean;
+    expand?: T;
+    swrConfig?: SWRConfiguration;
+    /** Extra key(s) appended to the SWR query key that trigger a refetch when any value changes. */
+    extraQueryKeys?: (string | null | undefined)[];
+}
+
+declare const useCustomer: <const T extends readonly CustomerExpandOption[] = readonly []>(params?: UseCustomerParams<T>) => UseCustomerResult<T>;
+
+export { useCustomer };