@chatarmin/os 1.5.9 → 1.8.0

package/dist/index.d.ts

@@ -1,6 +1,12 @@
-import type { AppRouter } from "@chatarmin/api";
+import type { AppRouter } from "@chatarmin/api/trpc-types";
 import { type CompaniesClient } from "./companies";
+import { type BillingClient } from "./billing";
+import { type FeaturesClient } from "./features";
+export { webhooks, constructProductWebhookEvent, generateTestWebhookHeaders, OsWebhookSignatureVerificationError, WEBHOOK_ID_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, } from "./webhooks";
+export type { ConstructProductWebhookEventOptions, ProductWebhookEventPayload, ProductWebhookHeaders, VerifiedProductWebhookEvent, } from "./webhooks";
 export type { CompaniesClient, CompanyAssignee, CompanyAssignees, CreateCompanyInput, CreateCompanyResult, GetCompanyInput, LinkedCompany, ListCompaniesInput, ListCompaniesResult, ListLinkedCompaniesInput, ListLinkedCompaniesResult, ProductCompany, UpdateCompanyResult, } from "./companies";
+export type { BillingClient, BillingInvoiceSummary, BillingOverview, BillingProfileSummary, BillingSubscriptionSummary, ClaimCheckoutInput, ClaimCheckoutResult, CreateBillingPortalSessionInput, EnsureFeatureSubscriptionInput, EnsureFeatureSubscriptionResult, GetBillingOverviewInput, GetUsageInput, LinkSubscriptionInput, LinkSubscriptionResult, ListBillingInvoicesOptions, PeriodOffsetRange, RelinkBillingProfileInput, ResolveInvoicePaymentUrlInput, SetUsageInput, SyncCompanyFromStripeInput, SyncCompanyFromStripeResult, UsageAggregate, UsageCycleBucket, UsageCycleSummary, UsagePoint, UsageQueryResult, UsageRecord, UsageSubscriptionItem, UsageResult, } from "./billing";
+export type { ExternalOrgFeatureAccessItem, FeatureAccessByExternalOrgIdResult, FeatureAccessItem, FeatureBillingDetails, FeatureCheckByExternalOrgIdResult, FeatureCheckInput, FeatureCheckResult, FeatureSetAccessInput, FeatureSetAccessResult, FeaturesClient, ListFeatureAccessInput, } from "./features";
 /**
  * Configuration options for the ChatarminOS SDK client.
  */
@@ -40,202 +46,6 @@ export declare class ChatarminOSError extends Error {
         details: ChatarminOSErrorDetails;
     };
 }
-/**
- * Input for checking feature access.
- */
-export interface FeatureCheckInput {
-    /** Company ID to check */
-    companyId: string;
-    /** Feature code (e.g., "ai_credit", "whatsapp_messages") */
-    featureCode: string;
-    /**
-     * Verify Stripe subscription is active for this feature.
-     * When true, the response includes subscription validation fields
-     * and `canUse` will be false if no active subscription exists.
-     * @default false
-     */
-    verifySubscription?: boolean;
-}
-/**
- * Billing details for a feature (when includeBillingDetails: true)
- */
-export interface FeatureBillingDetails {
-    /** Stripe subscription item ID */
-    stripeSubscriptionItemId: string | null;
-    /** Current billing period start */
-    currentPeriodStart: Date | null;
-    /** Current billing period end */
-    currentPeriodEnd: Date | null;
-    /** Unit amount in cents (e.g., 100 = $1.00) */
-    unitAmount: number | null;
-    /** Currency code (e.g., "usd") */
-    currency: string | null;
-    /** Billing interval (e.g., "month", "year") */
-    intervalUnit: string | null;
-    /** Usage type (e.g., "metered", "licensed") */
-    usageType: string | null;
-    /** Subscription status (e.g., "active", "trialing") */
-    subscriptionStatus: string | null;
-}
-/**
- * Input for listing feature access.
- */
-export interface ListFeatureAccessInput {
-    /** Company ID */
-    companyId: string;
-    /**
-     * Include billing details (Stripe price, usage, billing period).
-     * Adds a `billing` field to each feature with subscription linkage info.
-     * @default false
-     */
-    includeBillingDetails?: boolean;
-}
-/**
- * Result of a feature access check.
- */
-export interface FeatureCheckResult {
-    /** Feature code */
-    featureCode: string;
-    /** Whether the feature is enabled for this company */
-    isEnabled: boolean;
-    /** Whether this feature tracks quantity/usage */
-    hasQuantity: boolean;
-    /** Current usage count (for quantity-based features) */
-    currentUsage: number;
-    /** Maximum allowed quantity (null = unlimited) */
-    quantityLimit: number | null;
-    /** Included/free quantity before overage charges */
-    includedQuantity: number;
-    /** Remaining quantity before limit (null = unlimited) */
-    remaining: number | null;
-    /** Whether usage limit has been reached */
-    isAtLimit: boolean;
-    /** Whether the company can use this feature (enabled + not at limit + subscription if verified) */
-    canUse: boolean;
-    /** Whether an active Stripe subscription exists for this feature */
-    hasActiveSubscription?: boolean;
-    /** Stripe subscription status (active, trialing, canceled, etc.) */
-    subscriptionStatus?: string | null;
-    /** Stripe price ID from the subscription item */
-    stripePriceId?: string | null;
-    /** Stripe subscription ID */
-    stripeSubscriptionId?: string | null;
-}
-/**
- * Input for updating feature access with partial config merge.
- */
-export interface FeatureSetAccessInput {
-    /** Company ID to update (either this or externalOrgId required) */
-    companyId?: string;
-    /** Your product's external org ID (either this or companyId required) */
-    externalOrgId?: string;
-    /** Feature code to update */
-    featureCode: string;
-    /** Enable or disable the feature */
-    isEnabled?: boolean;
-    /** Maximum quantity allowed (for quantity-based features) */
-    quantityLimit?: number | null;
-    /** Included quantity before billing kicks in */
-    includedQuantity?: number | null;
-    /**
-     * Custom config values to merge with existing config.
-     * Only specified fields will be updated - other fields remain unchanged.
-     */
-    config?: Record<string, unknown>;
-    /** Source of the access change */
-    source?: "subscription" | "manual" | "trial" | "api";
-    /** When the access expires (null for no expiration) */
-    validUntil?: Date | null;
-}
-export interface SyncCompanyFromStripeInput {
-    companyId: string;
-    stripeCustomerId?: string;
-    forceReassign?: boolean;
-}
-export interface SyncCompanyFromStripeResult {
-    billingProfileId: string;
-    stripeCustomerId: string;
-    subscriptionsSynced: number;
-    subscriptionItemsSynced: number;
-    featuresLinked: number;
-    matchedMeters: number;
-}
-export interface EnsureFeatureSubscriptionInput {
-    companyId: string;
-    featureCode: string;
-    stripeSubscriptionId?: string;
-}
-export interface RelinkBillingProfileInput {
-    companyId: string;
-    stripeCustomerId: string;
-}
-export interface EnsureFeatureSubscriptionResult {
-    success: boolean;
-    subscriptionItemId: string | null;
-    stripePriceId: string | null;
-    stripeSubscriptionId: string | null;
-    action: "already_linked" | "linked_existing" | "created_new" | "failed";
-    error?: string;
-}
-/**
- * Input for setting usage to an absolute value.
- * Use for corrections when you know what the total usage SHOULD be.
- */
-export interface SetUsageInput {
-    /** Company ID */
-    companyId: string;
-    /** Feature code */
-    featureCode: string;
-    /** The absolute value to set usage to (must be >= 0) */
-    absoluteValue: number;
-    /** Reason for the set operation (required for audit trail) */
-    reason: string;
-    /** Admin user who performed the operation */
-    performedBy?: string;
-    /** Additional metadata (e.g., { ticketId: "SUPPORT-123" }) */
-    metadata?: Record<string, unknown>;
-}
-/**
- * Result from usage operations.
- */
-export interface UsageResult {
-    success: boolean;
-    featureCode: string;
-    previousUsage: number;
-    currentUsage: number;
-    delta: number;
-    quantityLimit: number | null;
-    remaining: number | null;
-    isAtLimit: boolean;
-    includedQuantity: number;
-    billableQuantity: number;
-    meterId: string;
-    eventId: string | null;
-}
-/**
- * Input for claiming a Stripe checkout subscription.
- */
-export interface ClaimCheckoutInput {
-    /** Company ID to link the subscription to */
-    companyId: string;
-    /** Stripe checkout session ID (cs_xxx) */
-    checkoutSessionId: string;
-}
-/**
- * Input for linking an existing Stripe subscription.
- */
-export interface LinkSubscriptionInput {
-    /** Company ID to link the subscription to */
-    companyId: string;
-    /** Stripe subscription ID (sub_xxx) */
-    stripeSubscriptionId: string;
-    /** Stripe customer ID (cus_xxx) - fetched from subscription if not provided */
-    stripeCustomerId?: string;
-    /** Tier code to apply features from (e.g., "free", "pro") */
-    tierCode?: string;
-    /** Display name for the subscription */
-    displayName?: string;
-}
 /**
  * Input for applying a tier to a company.
  */
@@ -413,6 +223,10 @@ export interface OnboardResult {
  * @see https://os.chatarmin.com/docs for full documentation
  */
 export declare class ChatarminOS {
+    static webhooks: {
+        constructEvent: typeof import("./webhooks").constructProductWebhookEvent;
+        generateTestHeaders: typeof import("./webhooks").generateTestWebhookHeaders;
+    };
     private client;
     private call;
     /**
@@ -518,12 +332,12 @@ export declare class ChatarminOS {
         } & ContactInput) => Promise<{
             isNew: boolean;
             id: string;
-            role: string | null;
+            metadata: unknown;
             created_at: Date;
             updated_at: Date;
+            role: string | null;
             short_id: string | null;
             name: string | null;
-            metadata: unknown;
             is_primary: boolean;
             avatar_url: string | null;
         }>;
@@ -572,12 +386,12 @@ export declare class ChatarminOS {
          */
         list: (companyId: string, primaryOnly?: boolean) => Promise<{
             id: string;
-            role: string | null;
+            metadata: unknown;
             created_at: Date;
             updated_at: Date;
+            role: string | null;
             short_id: string | null;
             name: string | null;
-            metadata: unknown;
             is_primary: boolean;
             avatar_url: string | null;
         }[]>;
@@ -605,554 +419,9 @@ export declare class ChatarminOS {
      * }
      * ```
      */
-    get features(): {
-        /**
-         * Check if a company has access to a specific feature.
-         *
-         * Returns detailed access information including whether the feature
-         * is enabled, current usage, limits, and whether they can use more.
-         *
-         * @param input - Check parameters
-         * @param input.companyId - Company ID to check
-         * @param input.featureCode - Feature code (e.g., "ai_credit")
-         * @returns Detailed feature access information
-         *
-         * @example
-         * ```typescript
-         * const access = await os.features.check({
-         *   companyId: 'comp_xxx',
-         *   featureCode: 'ai_credit'
-         * })
-         *
-         * console.log({
-         *   enabled: access.isEnabled,
-         *   canUse: access.canUse,
-         *   usage: access.currentUsage,
-         *   limit: access.quantityLimit,
-         *   remaining: access.remaining,
-         *   included: access.includedQuantity
-         * })
-         * ```
-         */
-        check: (input: FeatureCheckInput) => Promise<FeatureCheckResult>;
-        /**
-         * List all features and their access status for a company.
-         *
-         * Returns a complete list of features with their current status,
-         * useful for displaying a company's full feature set or building
-         * a feature comparison view.
-         *
-         * @param input - Query parameters
-         * @returns Array of feature access records
-         *
-         * @example Basic usage
-         * ```typescript
-         * const features = await os.features.listAccess({ companyId: company.id })
-         *
-         * for (const f of features) {
-         *   console.log(`${f.featureName}: ${f.isEnabled ? '✓' : '✗'}`)
-         *   if (f.quantityLimit) {
-         *     console.log(`  Usage: ${f.currentUsage} / ${f.quantityLimit}`)
-         *   }
-         * }
-         * ```
-         *
-         * @example With billing details
-         * ```typescript
-         * const features = await os.features.listAccess({
-         *   companyId: company.id,
-         *   includeBillingDetails: true
-         * })
-         *
-         * for (const f of features) {
-         *   console.log(`${f.featureName}:`)
-         *   console.log(`  Usage: ${f.currentUsage} / ${f.quantityLimit}`)
-         *
-         *   if (f.billing) {
-         *     console.log(`  Price: ${f.billing.unitAmount / 100} ${f.billing.currency}`)
-         *     console.log(`  Period: ${f.billing.currentPeriodStart} to ${f.billing.currentPeriodEnd}`)
-         *     console.log(`  Status: ${f.billing.subscriptionStatus}`)
-         *   }
-         * }
-         * ```
-         */
-        listAccess: (input: ListFeatureAccessInput | string) => Promise<({
-            featureCode: string;
-            featureName: string;
-            description: string | null;
-            hasQuantity: boolean;
-            isEnabled: boolean;
-            quantityLimit: number | null;
-            includedQuantity: number;
-            currentUsage: number;
-            source: string;
-            validUntil: Date | null;
-            stripeSubscriptionItemId: string | null;
-            stripePriceId: string | null;
-            stripeSubscriptionId: string | null;
-            meterId: string | null;
-            configValues: Record<string, unknown>;
-        } | {
-            billing: {
-                stripeSubscriptionItemId: string | null;
-                currentPeriodStart: Date | null;
-                currentPeriodEnd: Date | null;
-                unitAmount: number | null;
-                currency: string | null;
-                intervalUnit: string | null;
-                usageType: string | null;
-                subscriptionStatus: string | null;
-            };
-            featureCode: string;
-            featureName: string;
-            description: string | null;
-            hasQuantity: boolean;
-            isEnabled: boolean;
-            quantityLimit: number | null;
-            includedQuantity: number;
-            currentUsage: number;
-            source: string;
-            validUntil: Date | null;
-            stripeSubscriptionItemId: string | null;
-            stripePriceId: string | null;
-            stripeSubscriptionId: string | null;
-            meterId: string | null;
-            configValues: Record<string, unknown>;
-        })[]>;
-        /**
-         * Update feature access for a company with partial config merge.
-         *
-         * This allows you to update individual feature configs without
-         * replacing all config values. Only the fields you specify in
-         * `config` will be updated - other fields remain unchanged.
-         *
-         * @param input - Update parameters
-         * @returns Updated feature access information
-         *
-         * @example Update by company ID
-         * ```typescript
-         * await os.features.setAccess({
-         *   companyId: 'comp_xxx',
-         *   featureCode: 'ai_credit',
-         *   isEnabled: true,
-         *   config: {
-         *     included_quantity: 500,
-         *     max_quantity: 1000
-         *   }
-         * })
-         * ```
-         *
-         * @example Update by your product's external org ID
-         * ```typescript
-         * await os.features.setAccess({
-         *   externalOrgId: 'org_abc123',
-         *   featureCode: 'ai_credit',
-         *   config: { tier_level: 'premium' }
-         * })
-         * ```
-         *
-         * @example Partial config update (only updates specified fields)
-         * ```typescript
-         * // Existing config: { tier_level: 'basic', max_seats: 5 }
-         * await os.features.setAccess({
-         *   companyId: 'comp_xxx',
-         *   featureCode: 'team_seats',
-         *   config: { max_seats: 10 }  // tier_level remains 'basic'
-         * })
-         * // New config: { tier_level: 'basic', max_seats: 10 }
-         * ```
-         */
-        setAccess: (input: FeatureSetAccessInput) => Promise<{
-            success: boolean;
-            featureCode: string;
-            companyId: string;
-            isEnabled: boolean;
-            quantityLimit: number | null;
-            includedQuantity: number | null;
-            configValues: {
-                [x: string]: unknown;
-            };
-            source: string;
-            validUntil: Date | null;
-            created: boolean;
-            updated: boolean;
-        }>;
-        /**
-         * Get all feature access using your product's external org ID.
-         *
-         * Convenience method when you know the external org ID but not
-         * the ChatarminOS company ID.
-         *
-         * @param externalOrgId - Your product's organization ID
-         * @returns All features with their access status and config values
-         *
-         * @example
-         * ```typescript
-         * const result = await os.features.getAccessByExternalOrgId('org_abc123')
-         *
-         * console.log(`Company: ${result.companyId}`)
-         * for (const f of result.features) {
-         *   console.log(`${f.featureCode}: ${f.isEnabled}`)
-         *   console.log(`  Config:`, f.configValues)
-         * }
-         * ```
-         */
-        getAccessByExternalOrgId: (externalOrgId: string) => Promise<{
-            companyId: string;
-            productLinkId: string;
-            externalOrgId: string;
-            features: {
-                featureCode: string;
-                featureName: string;
-                description: string | null;
-                hasQuantity: boolean;
-                isEnabled: boolean;
-                quantityLimit: number | null;
-                includedQuantity: number;
-                configValues: Record<string, unknown>;
-                source: string;
-                validUntil: Date | null;
-            }[];
-        }>;
-        /**
-         * Check specific feature access using your product's external org ID.
-         *
-         * @param externalOrgId - Your product's organization ID
-         * @param featureCode - Feature code to check
-         * @returns Detailed feature access including config values
-         *
-         * @example
-         * ```typescript
-         * const access = await os.features.checkByExternalOrgId(
-         *   'org_abc123',
-         *   'ai_credit'
-         * )
-         *
-         * if (access.canUse) {
-         *   console.log(`Remaining: ${access.remaining}`)
-         *   console.log(`Config:`, access.configValues)
-         * }
-         * ```
-         */
-        checkByExternalOrgId: (externalOrgId: string, featureCode: string) => Promise<{
-            featureCode: string;
-            companyId: string;
-            externalOrgId: string;
-            isEnabled: boolean;
-            hasQuantity: boolean;
-            currentUsage: number;
-            quantityLimit: number | null;
-            includedQuantity: number;
-            remaining: number | null;
-            isAtLimit: boolean;
-            canUse: boolean;
-            configValues: {};
-        } | {
-            configValues: Record<string, unknown>;
-            featureCode: string;
-            isEnabled: boolean;
-            hasQuantity: boolean;
-            currentUsage: number;
-            quantityLimit: number | null;
-            includedQuantity: number;
-            remaining: number | null;
-            isAtLimit: boolean;
-            canUse: boolean;
-            companyId: string;
-            productLinkId: string;
-            externalOrgId: string;
-        }>;
-    };
-    /**
-     * Billing, usage tracking, and subscription management.
-     *
-     * Set feature usage for billing, claim subscriptions from Stripe checkout,
-     * or link existing Stripe subscriptions to companies.
-     *
-     * @example Set Usage
-     * ```typescript
-     * await os.billing.setUsage({
-     *   companyId: company.id,
-     *   featureCode: 'ai_credit',
-     *   absoluteValue: 42,
-     *   reason: 'Synced current usage'
-     * })
-     * ```
-     *
-     * @example Claim Checkout Subscription
-     * ```typescript
-     * // After Stripe checkout completes
-     * const result = await os.billing.claimCheckout({
-     *   companyId: company.id,
-     *   checkoutSessionId: 'cs_xxx'
-     * })
-     * ```
-     *
-     * @example Link Existing Subscription
-     * ```typescript
-     * // When you create subscriptions on your Stripe account
-     * const result = await os.billing.linkSubscription({
-     *   companyId: company.id,
-     *   stripeSubscriptionId: 'sub_xxx',
-     *   tierCode: 'pro' // Apply tier features
-     * })
-     * ```
-     */
-    get billing(): {
-        /**
-         * Set usage to an absolute value.
-         *
-         * Use this for corrections when you know what the total usage SHOULD be.
-         * Creates a snapshot for audit trail. The delta (difference) is calculated
-         * automatically and synced to Stripe.
-         *
-         * @param input - Set usage parameters
-         * @returns Result with previous and new usage values
-         *
-         * @example Correct usage to 100 (was 150)
-         * ```typescript
-         * const result = await os.billing.setUsage({
-         *   companyId: 'comp_xxx',
-         *   featureCode: 'ai_credit',
-         *   absoluteValue: 100,
-         *   reason: 'Corrected after customer support review',
-         *   performedBy: 'admin@company.com'
-         * })
-         *
-         * console.log({
-         *   previousUsage: result.previousUsage, // 150
-         *   currentUsage: result.currentUsage,   // 100
-         *   delta: result.delta                   // -50
-         * })
-         * ```
-         */
-        setUsage: (input: SetUsageInput) => Promise<UsageResult>;
-        /**
-         * Get usage event history for a feature.
-         *
-         * Returns the history of usage events including increments, sets,
-         * and adjustments. Useful for auditing and debugging.
-         *
-         * @param companyId - Company ID
-         * @param featureCode - Feature code to get history for
-         * @param options - Query options
-         * @returns Array of usage events
-         *
-         * @example
-         * ```typescript
-         * const history = await os.billing.getUsageHistory(
-         *   'comp_xxx',
-         *   'ai_credit',
-         *   { limit: 20, eventType: 'adjustment' }
-         * )
-         *
-         * for (const event of history) {
-         *   console.log(`${event.event_type}: ${event.quantity} at ${event.event_time}`)
-         *   if (event.adjustment_reason) {
-         *     console.log(`  Reason: ${event.adjustment_reason}`)
-         *   }
-         * }
-         * ```
-         */
-        getUsageHistory: (companyId: string, featureCode: string, options?: {
-            limit?: number;
-            includeDelivered?: boolean;
-            eventType?: "increment" | "set" | "adjustment";
-        }) => Promise<{
-            id: string;
-            created_at: Date;
-            metadata: unknown;
-            billing_profile_id: string | null;
-            source: string;
-            idempotency_key: string;
-            event_type: string;
-            subscription_item_id: string | null;
-            feature_access_id: string | null;
-            meter_code: string;
-            quantity: number;
-            stripe_price_id: string | null;
-            event_time: Date;
-            previous_value: number | null;
-            adjustment_reason: string | null;
-            adjusts_event_id: string | null;
-            stripe_delivery_status: string;
-            stripe_delivery_attempts: number;
-            stripe_last_delivery_attempt_at: Date | null;
-            stripe_event_id: string | null;
-            stripe_delivery_error: string | null;
-            delivered_at: Date | null;
-            reconcile_target_key: string | null;
-            reconcile_period_start: Date | null;
-            reconcile_period_end: Date | null;
-            reconcile_current_stripe_quantity: number | null;
-        }[]>;
-        /**
-         * Claim a subscription from a completed Stripe Checkout Session.
-         *
-         * Use this after a user completes Stripe checkout in your product.
-         * This links the subscription and customer to the company in OS.
-         *
-         * @param input - Claim parameters
-         * @returns Result with subscription ID and claim status
-         *
-         * @example
-         * ```typescript
-         * // In your Stripe checkout success handler:
-         * const result = await os.billing.claimCheckout({
-         *   companyId: company.id,
-         *   checkoutSessionId: session.id // From Stripe callback
-         * })
-         *
-         * if (result.alreadyClaimed) {
-         *   console.log('Subscription was already claimed')
-         * } else {
-         *   console.log(`Claimed subscription: ${result.subscriptionId}`)
-         * }
-         * ```
-         */
-        claimCheckout: (input: ClaimCheckoutInput) => Promise<{
-            success: boolean;
-            subscriptionId: string;
-            alreadyClaimed: boolean;
-            status?: undefined;
-        } | {
-            success: boolean;
-            subscriptionId: string;
-            alreadyClaimed: boolean;
-            status: import("stripe").Stripe.Subscription.Status;
-        }>;
-        /**
-         * Link an existing Stripe subscription to a company.
-         *
-         * Use this when you create subscriptions on your product's Stripe
-         * account and want OS to track them. Optionally applies tier features.
-         *
-         * @param input - Link parameters
-         * @returns Result with subscription ID, link status, and features applied
-         *
-         * @example
-         * ```typescript
-         * // After creating subscription on your Stripe account:
-         * const result = await os.billing.linkSubscription({
-         *   companyId: company.id,
-         *   stripeSubscriptionId: 'sub_xxx',
-         *   stripeCustomerId: 'cus_xxx', // Optional
-         *   tierCode: 'pro', // Apply tier features
-         *   displayName: 'Pro Plan'
-         * })
-         *
-         * console.log({
-         *   subscriptionId: result.subscriptionId,
-         *   isNew: !result.alreadyLinked,
-         *   featuresApplied: result.featuresApplied
-         * })
-         * ```
-         */
-        linkSubscription: (input: LinkSubscriptionInput) => Promise<{
-            success: boolean;
-            subscriptionId: string;
-            alreadyLinked: boolean;
-            status?: undefined;
-            tierApplied?: undefined;
-            featuresApplied?: undefined;
-        } | {
-            success: boolean;
-            subscriptionId: string;
-            alreadyLinked: boolean;
-            status: import("stripe").Stripe.Subscription.Status;
-            tierApplied: boolean;
-            featuresApplied: number;
-        }>;
-        /**
-         * Get billing status for a company.
-         *
-         * Quick check for subscription status, active features, and
-         * billing profile information.
-         *
-         * @param companyId - Company ID to check
-         * @returns Billing status overview
-         *
-         * @example
-         * ```typescript
-         * const status = await os.billing.getStatus(company.id)
-         *
-         * console.log({
-         *   hasBilling: status.hasBillingProfile,
-         *   subscriptions: status.activeSubscriptions.length,
-         *   features: status.enabledFeaturesCount
-         * })
-         *
-         * // Check active tier
-         * if (status.activeSubscriptions[0]?.tier) {
-         *   console.log(`Current tier: ${status.activeSubscriptions[0].tier.name}`)
-         * }
-         * ```
-         */
-        getStatus: (companyId: string) => Promise<{
-            hasBillingProfile: boolean;
-            stripeCustomerId: string | null;
-            billingProfiles: {
-                id: string;
-                organization_id: string;
-                created_at: Date;
-                updated_at: Date;
-                short_id: string | null;
-                name: string;
-                metadata: unknown;
-                status: string;
-                company_id: string | null;
-                stripe_customer_id: string;
-                link_status: string;
-                default_currency: string;
-                has_payment_method: boolean;
-                subscription_status: string;
-                contract_start_at: Date | null;
-                contract_end_at: Date | null;
-                mrr_cents: number;
-                mrr_committed_cents: number;
-                mrr_usage_cents: number;
-                open_invoices_count: number;
-                open_amount_cents: number;
-                past_due_invoices_count: number;
-                past_due_amount_cents: number;
-                max_days_overdue: number;
-                last_synced_at: Date | null;
-                company_group_id: string | null;
-            }[];
-            activeSubscriptions: {
-                id: string;
-                billingProfileId: string;
-                status: string;
-                stripeSubscriptionId: string | null;
-                currentPeriodEnd: Date | null;
-                trialEnd: Date | null;
-                tier: {
-                    code: string;
-                    name: string | null;
-                } | null;
-            }[];
-            enabledFeaturesCount: number;
-        }>;
-        /**
-         * Sync billing profile, subscriptions, and feature access from Stripe.
-         */
-        syncCompanyFromStripe: (input: SyncCompanyFromStripeInput) => Promise<SyncCompanyFromStripeResult>;
-        /**
-         * Relink billing profile to a new Stripe customer (destructive).
-         */
-        relinkBillingProfile: (input: RelinkBillingProfileInput) => Promise<{
-            billingProfileId: string;
-            stripeCustomerId: string;
-            subscriptionsSynced: number;
-            subscriptionItemsSynced: number;
-            featuresLinked: number;
-            matchedMeters: number;
-        }>;
-        /**
-         * Ensure a feature is linked to an active Stripe subscription item.
-         */
-        ensureFeatureSubscription: (input: EnsureFeatureSubscriptionInput) => Promise<EnsureFeatureSubscriptionResult>;
-    };
+    get features(): FeaturesClient;
+    /** Billing, usage tracking, subscriptions, and customer billing surfaces. */
+    get billing(): BillingClient;
     /**
      * Manual link operations for associating external IDs with companies.
      *
@@ -1206,12 +475,12 @@ export declare class ChatarminOS {
             externalUserId?: string;
         }) => Promise<{
             id: string;
+            company_id: string | null;
+            status: string;
+            metadata: unknown;
             created_at: Date;
             updated_at: Date;
-            metadata: unknown;
-            status: string;
             product_id: string;
-            company_id: string | null;
             external_org_id: string;
             external_user_id: string | null;
             confidence: number | null;
@@ -1342,15 +611,15 @@ export declare class ChatarminOS {
                 configValues: unknown;
             }[];
             id: string;
+            metadata: unknown;
             created_at: Date;
             updated_at: Date;
             name: string;
-            metadata: unknown;
-            product_id: string;
-            code: string;
-            is_active: boolean;
             description: string | null;
             display_order: number;
+            code: string;
+            is_active: boolean;
+            product_id: string;
         }[]>;
         /**
          * Get detailed information about a specific tier.
@@ -1460,15 +729,15 @@ export declare class ChatarminOS {
                 configValues: unknown;
             }[];
             id: string;
+            metadata: unknown;
             created_at: Date;
             updated_at: Date;
             name: string;
-            metadata: unknown;
-            product_id: string;
-            code: string;
-            is_active: boolean;
             description: string | null;
             display_order: number;
+            code: string;
+            is_active: boolean;
+            product_id: string;
         }[]>;
         /**
          * Get detailed tier information by code.