@nozle-js/react 0.11.0 → 0.12.0

package/dist/index.d.cts

@@ -448,25 +448,169 @@ interface SortablePlan {
  */
 declare function sortPlansByPrice<T extends SortablePlan>(plans: T[]): T[];
 
-interface Plan {
+type PricingInterval = "weekly" | "monthly" | "quarterly" | "semiannual" | "yearly";
+type PricingPrivilege = CatalogPrivilege;
+type PricingEntitlement = CatalogEntitlement;
+interface PricingPlan {
     code: string;
     name: string;
     amount_cents: number;
     amount_currency: string;
-    interval: string;
+    interval: PricingInterval | (string & {});
     description?: string | null;
-    /** The public catalog also returns these. They are absent from an older or reduced response. */
-    entitlements?: CatalogEntitlement[];
+    pending_deletion?: boolean;
+    plan_family_code?: string | null;
+    /** Present in the public catalog. Absent from an older or reduced response. */
+    entitlements?: PricingEntitlement[];
     credit_grant_rules?: CatalogCreditGrantRule[];
     charges?: CatalogCharge[];
 }
-/** The public plan catalog, read with the publishable key and cached by TanStack Query. */
+/** Display settings of one feature on a family's pricing card. */
+interface PricingFamilyFeature {
+    code: string;
+    name?: string | null;
+    description?: string | null;
+    show_on_pricing?: boolean;
+    show_description?: boolean;
+    display_position?: number | null;
+}
+interface PricingFamily {
+    code: string;
+    name: string;
+    description?: string | null;
+    show_on_pricing?: boolean;
+    pricing_position?: number | null;
+    pricing_highlighted?: boolean;
+    badge_text?: string | null;
+    cta_text?: string | null;
+    /** Codes of the family's plans, ordered weekly to yearly. */
+    plan_codes: string[];
+    features?: PricingFamilyFeature[];
+}
+/** The `GET /api/v1/plans` payload. `families` is absent on older APIs. */
+interface PricingCatalog {
+    plans: PricingPlan[];
+    families?: PricingFamily[] | null;
+}
+interface PricingFeature {
+    label: string;
+    description?: string | null;
+}
+/**
+ * Feature overrides: a record keyed by family code or plan code, or an array
+ * aligned to the cards in display order.
+ */
+type PricingFeatureOverrides = Record<string, Array<string | PricingFeature>> | Array<Array<string | PricingFeature> | undefined>;
+interface PricingIntervalOption {
+    interval: PricingInterval;
+    label: string;
+    /** Best whole-percent saving of any visible family against its monthly plan. */
+    savingsPercent: number | null;
+}
+interface PricingCard {
+    /** Family code, or the plan code when the catalog has no families. */
+    key: string;
+    /** Null when the catalog has no families (older APIs). */
+    family: PricingFamily | null;
+    /** The family's live plans, ordered weekly to yearly. */
+    plans: PricingPlan[];
+    /** The plan shown, checked out and passed to `onSelect`. */
+    plan: PricingPlan;
+    /** True when the family has no plan for the requested interval. */
+    isFallbackInterval: boolean;
+    name: string;
+    description: string | null;
+    /**
+     * Family cards: the per-month equivalent of the plan's price, for example
+     * "$40.83". Without families: the plan's price, for example "$14.99".
+     */
+    price: string;
+    /** "/mo" on family cards; the plan's own interval ("/quarter") without families. */
+    pricePeriod: string;
+    /**
+     * Family cards: for example "Billed $490 yearly · save 17%" or "Billed
+     * monthly". Empty without families.
+     */
+    billing: string;
+    /** Whole-percent saving against the family's monthly plan, when positive. */
+    savingsPercent: number | null;
+    features: PricingFeature[];
+    highlighted: boolean;
+    /** Badge text when highlighted, otherwise null. */
+    badge: string | null;
+    /** Call-to-action text (family `cta_text` or "Get {name}"). */
+    cta: string;
+    /** The family code or one of its plan codes is listed in `contactSales`. */
+    enterprise: boolean;
+}
+interface GetPricingCardsOptions {
+    /**
+     * Interval to show ("annual" is accepted for "yearly"). Defaults to
+     * monthly when offered, else the first available interval. Without
+     * families, plans of other intervals are left out only when an interval
+     * is given.
+     */
+    interval?: PricingInterval | "annual" | null;
+    locale?: string;
+    /** Family code or plan code to highlight instead of `pricing_highlighted`. */
+    highlight?: string | null;
+    /**
+     * Badge on the highlighted card, replacing the family's `badge_text`
+     * (default "Most Popular"). `null` shows no badge.
+     */
+    badge?: string | null;
+    features?: PricingFeatureOverrides;
+    /**
+     * Codes of families or plans sold on request. Their card's `enterprise` is
+     * true. Without families they also stay visible whatever the interval and
+     * come last.
+     */
+    contactSales?: readonly string[];
+    /**
+     * Orders the plans of a catalog without families. By default they are
+     * sorted by base price, cheapest first, with `contactSales` plans last.
+     * Families are ordered by `pricing_position`.
+     */
+    sort?: (a: PricingPlan, b: PricingPlan) => number;
+}
+/** Intervals offered by the visible cards, ordered weekly to yearly. */
+declare function getAvailableIntervals(catalog: PricingCatalog): PricingInterval[];
+/**
+ * Options for an interval switch: each available interval with its label
+ * and the best family saving against the family's monthly plan.
+ */
+declare function getPricingIntervalOptions(catalog: PricingCatalog): PricingIntervalOption[];
+/**
+ * The interval to show first: `preferred` ("annual" means "yearly") when it
+ * is available, otherwise monthly when available, otherwise the first one.
+ */
+declare function getDefaultInterval(catalog: PricingCatalog, preferred?: string | null): PricingInterval | null;
+/**
+ * Pricing cards in display order for one interval: the selected plan of each
+ * visible family (or the nearest interval's plan when the family has none for
+ * it), its per-month price and billing line, its features, the highlight,
+ * badge and call to action. Without families each live plan is a card.
+ */
+declare function getPricingCards(catalog: PricingCatalog, options?: GetPricingCardsOptions): PricingCard[];
+
+/**
+ * A plan from the public catalog (`GET /api/v1/plans`). The catalog also returns entitlements, credit
+ * grants and charges; they are absent from an older or reduced response.
+ */
+type Plan = PricingPlan;
+/**
+ * The public plan catalog, read with the publishable key and cached by TanStack Query. `families` is
+ * null when the API returns no `families` key (older APIs); pass `{ plans, families }` to
+ * `getPricingCards` either way.
+ */
 declare function usePlans(): {
-    plans: Plan[];
+    plans: PricingPlan[];
+    families: PricingFamily[] | null;
     isLoading: boolean;
     error: Error | null;
     refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
-        plans: Plan[];
+        plans: PricingPlan[];
+        families: PricingFamily[] | null;
         nozleBranding: boolean;
     }, Error>>;
 };
@@ -888,57 +1032,64 @@ interface UseCheckoutResult$1 {
 }
 declare function useCheckout$1(): UseCheckoutResult$1;
 
-interface PricingPlan {
-    code: string;
-    name: string;
-    amount_cents: number;
-    amount_currency: string;
-    interval: string;
-    description?: string | null;
-    /** Present in the public catalog. The table turns these into each card's feature list. */
-    entitlements?: CatalogEntitlement[];
-    credit_grant_rules?: CatalogCreditGrantRule[];
-    charges?: CatalogCharge[];
-}
 interface PricingTableProps {
     currentPlanCode?: string;
+    /** Plans to show instead of fetching the catalog. */
     plans?: PricingPlan[];
     /**
-     * Optional. By default each card lists what its plan gives, read from the catalog. Pass an array
-     * (aligned to the rendered plan order) or an object keyed by plan code to replace the lines of
-     * a plan.
+     * Plan families for `plans`. When omitted with `plans`, each plan is its
+     * own card, as with older APIs.
+     */
+    families?: PricingFamily[] | null;
+    /**
+     * Optional. By default each card lists its family's features with values
+     * from the selected plan, or, without families, what the plan gives. Pass
+     * an object keyed by family code or plan code, or an array aligned to the
+     * rendered cards, to replace the lines of a card.
      */
-    features?: string[][] | Record<string, string[]>;
+    features?: PricingFeatureOverrides;
     /**
-     * Optional. Orders the plans. By default they are sorted by base price, cheapest first, with
-     * `contactSalesPlans` last.
+     * Optional. Orders the plans of a catalog without families. By default
+     * they are sorted by base price, cheapest first, with `contactSalesPlans`
+     * last. Families are ordered by their `pricing_position`.
      */
     sort?: (a: PricingPlan, b: PricingPlan) => number;
-    onSelect?: (plan: PricingPlan) => void;
+    /** Called with the selected interval's plan and its family (null without families). */
+    onSelect?: (plan: PricingPlan, family: PricingFamily | null) => void;
     returnUrl?: string;
     onStripeClientSecret?: (clientSecret: string) => void;
     onCheckoutResult?: (result: CheckoutResult) => void;
     onCheckoutError?: (error: Error) => void;
+    /** Show the interval switch when several intervals exist. Defaults to true. */
     showToggle?: boolean;
-    /** Code of the plan to highlight. */
+    /** Interval shown first ("annual" is accepted for "yearly"). Defaults to monthly when offered. */
+    defaultInterval?: PricingInterval | 'annual';
+    /** Family code or plan code to highlight. Overrides the family's `pricing_highlighted`. */
     highlightPlan?: string;
     /**
      * How the highlighted card stands out: `outline` (default) draws a border in `colorHighlight`;
      * `filled` paints the card in `colorHighlight` and its text and button in `colorHighlightForeground`.
      */
     highlightStyle?: 'outline' | 'filled';
-    /** Badge on the highlighted card. Default "Most Popular"; pass `null` for no badge. */
+    /**
+     * Badge on the highlighted card. Replaces the family's `badge_text`; without either it is
+     * "Most Popular". Pass `null` for no badge.
+     */
     highlightLabel?: string | null;
     className?: string;
     /**
-     * Codes of plans sold on request. Their card shows "Custom" instead of a price and a "Contact Sales"
-     * button, which opens `enterpriseEmail` when set.
+     * Codes of plans (or plan families) sold on request. Their card shows "Custom" instead of a price
+     * and a "Contact Sales" button, which opens `enterpriseEmail` when set.
      */
     contactSalesPlans?: string[];
     enterpriseEmail?: string;
+    /** Text next to the Annual option, replacing the computed "Save N%". */
+    annualDiscountLabel?: string;
+    /** Locale for prices and feature values. Defaults to `en-US`. */
+    locale?: string;
     appearance?: Appearance;
 }
-declare function PricingTable({ currentPlanCode, plans: propPlans, features, sort, onSelect, returnUrl, onStripeClientSecret, onCheckoutResult, onCheckoutError, showToggle, highlightPlan, highlightStyle, highlightLabel, className, contactSalesPlans, enterpriseEmail, appearance, }: PricingTableProps): React__default.ReactElement;
+declare function PricingTable({ currentPlanCode, plans: propPlans, families: propFamilies, features, sort, onSelect, returnUrl, onStripeClientSecret, onCheckoutResult, onCheckoutError, showToggle, defaultInterval, highlightPlan, highlightStyle, highlightLabel, className, contactSalesPlans, enterpriseEmail, annualDiscountLabel, locale: localeProp, appearance, }: PricingTableProps): React__default.ReactElement;
 
 /**
  * PlanCard — Individual pricing plan card component.
@@ -1412,4 +1563,4 @@ interface UsageTrendProps {
 }
 declare function UsageTrend({ periods, featureCode, isLoading, error, emptyMessage, appearance, }: UsageTrendProps): React__default.ReactElement;
 
-export { Appearance, BillingContext, type BillingContextValue, type BillingFetch, BillingPortal, BillingPortalError, type BillingPortalProps, type BillingPortalSession, BillingProvider, type BillingProviderProps, BillingRequestError, type BillingSubscription, type CancellationActions, type CancellationApplyInput, CancellationControl, type CancellationControlProps, type CancellationInput, type CancellationOperation, type CancellationPreview, type CancellationSubscription, type CatalogCharge, type CatalogCreditGrantRule, type CatalogEntitlement, type Plan as CatalogPlan, type CatalogPrivilege, type ChargeUsageData, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type CheckoutStatus, type CheckoutSubscriptionResult, type ComparisonFeature, type ComparisonRow, type CompletedCheckoutResult, type CreateBillingPortalSession, type CreateCheckout, type CreateCheckoutInput, CreditBalance, type CreditBalanceData, type CreditBalanceProps, type CreditBalanceSource, CreditHistory, type CreditHistoryProps, type CreditOperationData, CurrentPlan, type CurrentPlanDetail, type CurrentPlanProps, type CustomerUsageData, ElementKey, type ElementProps, type EntitlementResult, FeatureGate, type FeatureGateProps, type GetCheckoutStatus, type HostedCheckoutResult, type InvoiceData, type InvoicePageData, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, type PlanChangeActions, type PlanChangeApplyInput, PlanChangeControl, type PlanChangeControlProps, type PlanChangeInput, type PlanChangeOperation, type PlanChangePreview, type PlanChangePreviewInput, type PlanChangeState, type PlanChangeWithdrawInput, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PortalPlan, PoweredByNozle, type PricingPlan, PricingTable, type PricingTableProps, type ProcessingCheckoutResult, type ProrationPreview, type RazorpayCheckoutResult, type RazorpayVerification, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, type UpgradePreview, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageBreakdown, type UsageBreakdownProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UsageResult, UsageTrend, type UsageTrendProps, type UseAppearance, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, type VerifyCheckout, comparisonRows, currentPlanMeters, getUsageMeterColor, planFeatures, sortPlansByPrice, usageItems, useAppearance, useBillingContext, useBillingRefresh, useCheckout, useCheckout$1 as useCheckoutSession, useCreditBalance, useCreditHistory, useEntitlement, useInvoiceDownload, useInvoices, useNozleBranding, useNozleClient, useOptionalBillingContext, usePlans, useSubscription, useUpgradePreview, useUsage };
+export { Appearance, BillingContext, type BillingContextValue, type BillingFetch, BillingPortal, BillingPortalError, type BillingPortalProps, type BillingPortalSession, BillingProvider, type BillingProviderProps, BillingRequestError, type BillingSubscription, type CancellationActions, type CancellationApplyInput, CancellationControl, type CancellationControlProps, type CancellationInput, type CancellationOperation, type CancellationPreview, type CancellationSubscription, type CatalogCharge, type CatalogCreditGrantRule, type CatalogEntitlement, type Plan as CatalogPlan, type CatalogPrivilege, type ChargeUsageData, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type CheckoutStatus, type CheckoutSubscriptionResult, type ComparisonFeature, type ComparisonRow, type CompletedCheckoutResult, type CreateBillingPortalSession, type CreateCheckout, type CreateCheckoutInput, CreditBalance, type CreditBalanceData, type CreditBalanceProps, type CreditBalanceSource, CreditHistory, type CreditHistoryProps, type CreditOperationData, CurrentPlan, type CurrentPlanDetail, type CurrentPlanProps, type CustomerUsageData, ElementKey, type ElementProps, type EntitlementResult, FeatureGate, type FeatureGateProps, type GetCheckoutStatus, type GetPricingCardsOptions, type HostedCheckoutResult, type InvoiceData, type InvoicePageData, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, type PlanChangeActions, type PlanChangeApplyInput, PlanChangeControl, type PlanChangeControlProps, type PlanChangeInput, type PlanChangeOperation, type PlanChangePreview, type PlanChangePreviewInput, type PlanChangeState, type PlanChangeWithdrawInput, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PortalPlan, PoweredByNozle, type PricingCard, type PricingCatalog, type PricingEntitlement, type PricingFamily, type PricingFamilyFeature, type PricingFeature, type PricingFeatureOverrides, type PricingInterval, type PricingIntervalOption, type PricingPlan, type PricingPrivilege, PricingTable, type PricingTableProps, type ProcessingCheckoutResult, type ProrationPreview, type RazorpayCheckoutResult, type RazorpayVerification, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, type UpgradePreview, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageBreakdown, type UsageBreakdownProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UsageResult, UsageTrend, type UsageTrendProps, type UseAppearance, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, type VerifyCheckout, comparisonRows, currentPlanMeters, getAvailableIntervals, getDefaultInterval, getPricingCards, getPricingIntervalOptions, getUsageMeterColor, planFeatures, sortPlansByPrice, usageItems, useAppearance, useBillingContext, useBillingRefresh, useCheckout, useCheckout$1 as useCheckoutSession, useCreditBalance, useCreditHistory, useEntitlement, useInvoiceDownload, useInvoices, useNozleBranding, useNozleClient, useOptionalBillingContext, usePlans, useSubscription, useUpgradePreview, useUsage };

package/dist/index.d.ts

@@ -448,25 +448,169 @@ interface SortablePlan {
  */
 declare function sortPlansByPrice<T extends SortablePlan>(plans: T[]): T[];
 
-interface Plan {
+type PricingInterval = "weekly" | "monthly" | "quarterly" | "semiannual" | "yearly";
+type PricingPrivilege = CatalogPrivilege;
+type PricingEntitlement = CatalogEntitlement;
+interface PricingPlan {
     code: string;
     name: string;
     amount_cents: number;
     amount_currency: string;
-    interval: string;
+    interval: PricingInterval | (string & {});
     description?: string | null;
-    /** The public catalog also returns these. They are absent from an older or reduced response. */
-    entitlements?: CatalogEntitlement[];
+    pending_deletion?: boolean;
+    plan_family_code?: string | null;
+    /** Present in the public catalog. Absent from an older or reduced response. */
+    entitlements?: PricingEntitlement[];
     credit_grant_rules?: CatalogCreditGrantRule[];
     charges?: CatalogCharge[];
 }
-/** The public plan catalog, read with the publishable key and cached by TanStack Query. */
+/** Display settings of one feature on a family's pricing card. */
+interface PricingFamilyFeature {
+    code: string;
+    name?: string | null;
+    description?: string | null;
+    show_on_pricing?: boolean;
+    show_description?: boolean;
+    display_position?: number | null;
+}
+interface PricingFamily {
+    code: string;
+    name: string;
+    description?: string | null;
+    show_on_pricing?: boolean;
+    pricing_position?: number | null;
+    pricing_highlighted?: boolean;
+    badge_text?: string | null;
+    cta_text?: string | null;
+    /** Codes of the family's plans, ordered weekly to yearly. */
+    plan_codes: string[];
+    features?: PricingFamilyFeature[];
+}
+/** The `GET /api/v1/plans` payload. `families` is absent on older APIs. */
+interface PricingCatalog {
+    plans: PricingPlan[];
+    families?: PricingFamily[] | null;
+}
+interface PricingFeature {
+    label: string;
+    description?: string | null;
+}
+/**
+ * Feature overrides: a record keyed by family code or plan code, or an array
+ * aligned to the cards in display order.
+ */
+type PricingFeatureOverrides = Record<string, Array<string | PricingFeature>> | Array<Array<string | PricingFeature> | undefined>;
+interface PricingIntervalOption {
+    interval: PricingInterval;
+    label: string;
+    /** Best whole-percent saving of any visible family against its monthly plan. */
+    savingsPercent: number | null;
+}
+interface PricingCard {
+    /** Family code, or the plan code when the catalog has no families. */
+    key: string;
+    /** Null when the catalog has no families (older APIs). */
+    family: PricingFamily | null;
+    /** The family's live plans, ordered weekly to yearly. */
+    plans: PricingPlan[];
+    /** The plan shown, checked out and passed to `onSelect`. */
+    plan: PricingPlan;
+    /** True when the family has no plan for the requested interval. */
+    isFallbackInterval: boolean;
+    name: string;
+    description: string | null;
+    /**
+     * Family cards: the per-month equivalent of the plan's price, for example
+     * "$40.83". Without families: the plan's price, for example "$14.99".
+     */
+    price: string;
+    /** "/mo" on family cards; the plan's own interval ("/quarter") without families. */
+    pricePeriod: string;
+    /**
+     * Family cards: for example "Billed $490 yearly · save 17%" or "Billed
+     * monthly". Empty without families.
+     */
+    billing: string;
+    /** Whole-percent saving against the family's monthly plan, when positive. */
+    savingsPercent: number | null;
+    features: PricingFeature[];
+    highlighted: boolean;
+    /** Badge text when highlighted, otherwise null. */
+    badge: string | null;
+    /** Call-to-action text (family `cta_text` or "Get {name}"). */
+    cta: string;
+    /** The family code or one of its plan codes is listed in `contactSales`. */
+    enterprise: boolean;
+}
+interface GetPricingCardsOptions {
+    /**
+     * Interval to show ("annual" is accepted for "yearly"). Defaults to
+     * monthly when offered, else the first available interval. Without
+     * families, plans of other intervals are left out only when an interval
+     * is given.
+     */
+    interval?: PricingInterval | "annual" | null;
+    locale?: string;
+    /** Family code or plan code to highlight instead of `pricing_highlighted`. */
+    highlight?: string | null;
+    /**
+     * Badge on the highlighted card, replacing the family's `badge_text`
+     * (default "Most Popular"). `null` shows no badge.
+     */
+    badge?: string | null;
+    features?: PricingFeatureOverrides;
+    /**
+     * Codes of families or plans sold on request. Their card's `enterprise` is
+     * true. Without families they also stay visible whatever the interval and
+     * come last.
+     */
+    contactSales?: readonly string[];
+    /**
+     * Orders the plans of a catalog without families. By default they are
+     * sorted by base price, cheapest first, with `contactSales` plans last.
+     * Families are ordered by `pricing_position`.
+     */
+    sort?: (a: PricingPlan, b: PricingPlan) => number;
+}
+/** Intervals offered by the visible cards, ordered weekly to yearly. */
+declare function getAvailableIntervals(catalog: PricingCatalog): PricingInterval[];
+/**
+ * Options for an interval switch: each available interval with its label
+ * and the best family saving against the family's monthly plan.
+ */
+declare function getPricingIntervalOptions(catalog: PricingCatalog): PricingIntervalOption[];
+/**
+ * The interval to show first: `preferred` ("annual" means "yearly") when it
+ * is available, otherwise monthly when available, otherwise the first one.
+ */
+declare function getDefaultInterval(catalog: PricingCatalog, preferred?: string | null): PricingInterval | null;
+/**
+ * Pricing cards in display order for one interval: the selected plan of each
+ * visible family (or the nearest interval's plan when the family has none for
+ * it), its per-month price and billing line, its features, the highlight,
+ * badge and call to action. Without families each live plan is a card.
+ */
+declare function getPricingCards(catalog: PricingCatalog, options?: GetPricingCardsOptions): PricingCard[];
+
+/**
+ * A plan from the public catalog (`GET /api/v1/plans`). The catalog also returns entitlements, credit
+ * grants and charges; they are absent from an older or reduced response.
+ */
+type Plan = PricingPlan;
+/**
+ * The public plan catalog, read with the publishable key and cached by TanStack Query. `families` is
+ * null when the API returns no `families` key (older APIs); pass `{ plans, families }` to
+ * `getPricingCards` either way.
+ */
 declare function usePlans(): {
-    plans: Plan[];
+    plans: PricingPlan[];
+    families: PricingFamily[] | null;
     isLoading: boolean;
     error: Error | null;
     refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
-        plans: Plan[];
+        plans: PricingPlan[];
+        families: PricingFamily[] | null;
         nozleBranding: boolean;
     }, Error>>;
 };
@@ -888,57 +1032,64 @@ interface UseCheckoutResult$1 {
 }
 declare function useCheckout$1(): UseCheckoutResult$1;
 
-interface PricingPlan {
-    code: string;
-    name: string;
-    amount_cents: number;
-    amount_currency: string;
-    interval: string;
-    description?: string | null;
-    /** Present in the public catalog. The table turns these into each card's feature list. */
-    entitlements?: CatalogEntitlement[];
-    credit_grant_rules?: CatalogCreditGrantRule[];
-    charges?: CatalogCharge[];
-}
 interface PricingTableProps {
     currentPlanCode?: string;
+    /** Plans to show instead of fetching the catalog. */
     plans?: PricingPlan[];
     /**
-     * Optional. By default each card lists what its plan gives, read from the catalog. Pass an array
-     * (aligned to the rendered plan order) or an object keyed by plan code to replace the lines of
-     * a plan.
+     * Plan families for `plans`. When omitted with `plans`, each plan is its
+     * own card, as with older APIs.
+     */
+    families?: PricingFamily[] | null;
+    /**
+     * Optional. By default each card lists its family's features with values
+     * from the selected plan, or, without families, what the plan gives. Pass
+     * an object keyed by family code or plan code, or an array aligned to the
+     * rendered cards, to replace the lines of a card.
      */
-    features?: string[][] | Record<string, string[]>;
+    features?: PricingFeatureOverrides;
     /**
-     * Optional. Orders the plans. By default they are sorted by base price, cheapest first, with
-     * `contactSalesPlans` last.
+     * Optional. Orders the plans of a catalog without families. By default
+     * they are sorted by base price, cheapest first, with `contactSalesPlans`
+     * last. Families are ordered by their `pricing_position`.
      */
     sort?: (a: PricingPlan, b: PricingPlan) => number;
-    onSelect?: (plan: PricingPlan) => void;
+    /** Called with the selected interval's plan and its family (null without families). */
+    onSelect?: (plan: PricingPlan, family: PricingFamily | null) => void;
     returnUrl?: string;
     onStripeClientSecret?: (clientSecret: string) => void;
     onCheckoutResult?: (result: CheckoutResult) => void;
     onCheckoutError?: (error: Error) => void;
+    /** Show the interval switch when several intervals exist. Defaults to true. */
     showToggle?: boolean;
-    /** Code of the plan to highlight. */
+    /** Interval shown first ("annual" is accepted for "yearly"). Defaults to monthly when offered. */
+    defaultInterval?: PricingInterval | 'annual';
+    /** Family code or plan code to highlight. Overrides the family's `pricing_highlighted`. */
     highlightPlan?: string;
     /**
      * How the highlighted card stands out: `outline` (default) draws a border in `colorHighlight`;
      * `filled` paints the card in `colorHighlight` and its text and button in `colorHighlightForeground`.
      */
     highlightStyle?: 'outline' | 'filled';
-    /** Badge on the highlighted card. Default "Most Popular"; pass `null` for no badge. */
+    /**
+     * Badge on the highlighted card. Replaces the family's `badge_text`; without either it is
+     * "Most Popular". Pass `null` for no badge.
+     */
     highlightLabel?: string | null;
     className?: string;
     /**
-     * Codes of plans sold on request. Their card shows "Custom" instead of a price and a "Contact Sales"
-     * button, which opens `enterpriseEmail` when set.
+     * Codes of plans (or plan families) sold on request. Their card shows "Custom" instead of a price
+     * and a "Contact Sales" button, which opens `enterpriseEmail` when set.
      */
     contactSalesPlans?: string[];
     enterpriseEmail?: string;
+    /** Text next to the Annual option, replacing the computed "Save N%". */
+    annualDiscountLabel?: string;
+    /** Locale for prices and feature values. Defaults to `en-US`. */
+    locale?: string;
     appearance?: Appearance;
 }
-declare function PricingTable({ currentPlanCode, plans: propPlans, features, sort, onSelect, returnUrl, onStripeClientSecret, onCheckoutResult, onCheckoutError, showToggle, highlightPlan, highlightStyle, highlightLabel, className, contactSalesPlans, enterpriseEmail, appearance, }: PricingTableProps): React__default.ReactElement;
+declare function PricingTable({ currentPlanCode, plans: propPlans, families: propFamilies, features, sort, onSelect, returnUrl, onStripeClientSecret, onCheckoutResult, onCheckoutError, showToggle, defaultInterval, highlightPlan, highlightStyle, highlightLabel, className, contactSalesPlans, enterpriseEmail, annualDiscountLabel, locale: localeProp, appearance, }: PricingTableProps): React__default.ReactElement;
 
 /**
  * PlanCard — Individual pricing plan card component.
@@ -1412,4 +1563,4 @@ interface UsageTrendProps {
 }
 declare function UsageTrend({ periods, featureCode, isLoading, error, emptyMessage, appearance, }: UsageTrendProps): React__default.ReactElement;
 
-export { Appearance, BillingContext, type BillingContextValue, type BillingFetch, BillingPortal, BillingPortalError, type BillingPortalProps, type BillingPortalSession, BillingProvider, type BillingProviderProps, BillingRequestError, type BillingSubscription, type CancellationActions, type CancellationApplyInput, CancellationControl, type CancellationControlProps, type CancellationInput, type CancellationOperation, type CancellationPreview, type CancellationSubscription, type CatalogCharge, type CatalogCreditGrantRule, type CatalogEntitlement, type Plan as CatalogPlan, type CatalogPrivilege, type ChargeUsageData, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type CheckoutStatus, type CheckoutSubscriptionResult, type ComparisonFeature, type ComparisonRow, type CompletedCheckoutResult, type CreateBillingPortalSession, type CreateCheckout, type CreateCheckoutInput, CreditBalance, type CreditBalanceData, type CreditBalanceProps, type CreditBalanceSource, CreditHistory, type CreditHistoryProps, type CreditOperationData, CurrentPlan, type CurrentPlanDetail, type CurrentPlanProps, type CustomerUsageData, ElementKey, type ElementProps, type EntitlementResult, FeatureGate, type FeatureGateProps, type GetCheckoutStatus, type HostedCheckoutResult, type InvoiceData, type InvoicePageData, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, type PlanChangeActions, type PlanChangeApplyInput, PlanChangeControl, type PlanChangeControlProps, type PlanChangeInput, type PlanChangeOperation, type PlanChangePreview, type PlanChangePreviewInput, type PlanChangeState, type PlanChangeWithdrawInput, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PortalPlan, PoweredByNozle, type PricingPlan, PricingTable, type PricingTableProps, type ProcessingCheckoutResult, type ProrationPreview, type RazorpayCheckoutResult, type RazorpayVerification, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, type UpgradePreview, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageBreakdown, type UsageBreakdownProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UsageResult, UsageTrend, type UsageTrendProps, type UseAppearance, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, type VerifyCheckout, comparisonRows, currentPlanMeters, getUsageMeterColor, planFeatures, sortPlansByPrice, usageItems, useAppearance, useBillingContext, useBillingRefresh, useCheckout, useCheckout$1 as useCheckoutSession, useCreditBalance, useCreditHistory, useEntitlement, useInvoiceDownload, useInvoices, useNozleBranding, useNozleClient, useOptionalBillingContext, usePlans, useSubscription, useUpgradePreview, useUsage };
+export { Appearance, BillingContext, type BillingContextValue, type BillingFetch, BillingPortal, BillingPortalError, type BillingPortalProps, type BillingPortalSession, BillingProvider, type BillingProviderProps, BillingRequestError, type BillingSubscription, type CancellationActions, type CancellationApplyInput, CancellationControl, type CancellationControlProps, type CancellationInput, type CancellationOperation, type CancellationPreview, type CancellationSubscription, type CatalogCharge, type CatalogCreditGrantRule, type CatalogEntitlement, type Plan as CatalogPlan, type CatalogPrivilege, type ChargeUsageData, Checkout, CheckoutButton, type CheckoutButtonProps, type CheckoutProps, type CheckoutResult, type CheckoutStatus, type CheckoutSubscriptionResult, type ComparisonFeature, type ComparisonRow, type CompletedCheckoutResult, type CreateBillingPortalSession, type CreateCheckout, type CreateCheckoutInput, CreditBalance, type CreditBalanceData, type CreditBalanceProps, type CreditBalanceSource, CreditHistory, type CreditHistoryProps, type CreditOperationData, CurrentPlan, type CurrentPlanDetail, type CurrentPlanProps, type CustomerUsageData, ElementKey, type ElementProps, type EntitlementResult, FeatureGate, type FeatureGateProps, type GetCheckoutStatus, type GetPricingCardsOptions, type HostedCheckoutResult, type InvoiceData, type InvoicePageData, LockedOverlay, type LockedOverlayProps, type NozleClient, type PaymentMethod, PaymentMethodDisplay, type PaymentMethodDisplayProps, PlanBadge, type PlanBadgeProps, PlanCard, type PlanCardProps, type PlanChangeActions, type PlanChangeApplyInput, PlanChangeControl, type PlanChangeControlProps, type PlanChangeInput, type PlanChangeOperation, type PlanChangePreview, type PlanChangePreviewInput, type PlanChangeState, type PlanChangeWithdrawInput, PlanComparison, type PlanComparisonProps, PlanGate, type PlanGateProps, type PortalPlan, PoweredByNozle, type PricingCard, type PricingCatalog, type PricingEntitlement, type PricingFamily, type PricingFamilyFeature, type PricingFeature, type PricingFeatureOverrides, type PricingInterval, type PricingIntervalOption, type PricingPlan, type PricingPrivilege, PricingTable, type PricingTableProps, type ProcessingCheckoutResult, type ProrationPreview, type RazorpayCheckoutResult, type RazorpayVerification, type ScheduledCheckoutResult, UpgradeButton, type UpgradeButtonProps, UpgradeModal, type UpgradeModalProps, type UpgradePreview, UpgradePrompt, type UpgradePromptProps, UsageAlert, type UsageAlertFeature, type UsageAlertProps, UsageBreakdown, type UsageBreakdownProps, UsageDashboard, type UsageDashboardFeature, type UsageDashboardProps, UsageGate, type UsageGateProps, UsageMeter, type UsageMeterProps, type UsageResult, UsageTrend, type UsageTrendProps, type UseAppearance, type UseCheckoutResult, type UseCheckoutResult$1 as UseCheckoutSessionResult, type VerifyCheckout, comparisonRows, currentPlanMeters, getAvailableIntervals, getDefaultInterval, getPricingCards, getPricingIntervalOptions, getUsageMeterColor, planFeatures, sortPlansByPrice, usageItems, useAppearance, useBillingContext, useBillingRefresh, useCheckout, useCheckout$1 as useCheckoutSession, useCreditBalance, useCreditHistory, useEntitlement, useInvoiceDownload, useInvoices, useNozleBranding, useNozleClient, useOptionalBillingContext, usePlans, useSubscription, useUpgradePreview, useUsage };