@buildbase/sdk 0.0.23 → 0.0.25

package/dist/types/api/currency-utils.d.ts

@@ -1,44 +0,0 @@
-/**
- * Centralized formatting for subscription/quota display: cents, overage rates, included + overage text.
- * Currency must be provided by the caller (e.g. workspace.billingCurrency, plan.currency, or selected currency).
- */
-/** Common currency display (code or symbol). Use lowercase Stripe codes (usd, eur, etc.). */
-export declare const CURRENCY_DISPLAY: Record<string, string>;
-/** Currency code to flag emoji (country/region associated with the currency). Use for dropdowns. */
-export declare const CURRENCY_FLAG: Record<string, string>;
-/** Get flag emoji for a currency code. Returns empty string when unknown or empty. */
-export declare function getCurrencyFlag(currency: string): string;
-/** Get currency symbol for display. Use lowercase Stripe codes (usd, eur). Returns code when unknown; empty string when currency is empty. */
-export declare function getCurrencySymbol(currency: string): string;
-/** Allowed plan/pricing currency codes (must match server ALLOWED_BILLING_CURRENCIES). Use for dropdowns and validation. */
-export declare const PLAN_CURRENCY_CODES: readonly ["usd", "eur", "gbp", "jpy", "cad", "aud", "chf", "cny", "hkd", "sgd", "inr", "mxn", "brl", "nzd", "sek", "nok", "dkk", "pln", "thb"];
-/** Options for plan currency select: { value, label } with symbol. Use in CreateOrEditPlan and anywhere a currency dropdown is needed. */
-export declare const PLAN_CURRENCY_OPTIONS: {
-    value: "usd" | "eur" | "gbp" | "jpy" | "cad" | "aud" | "chf" | "cny" | "hkd" | "sgd" | "inr" | "mxn" | "brl" | "nzd" | "sek" | "nok" | "dkk" | "pln" | "thb";
-    label: string;
-}[];
-/** Format cents as money string (e.g. 1999, "usd" -> "$19.99"). Caller must pass currency (e.g. from plan or workspace). */
-export declare function formatCents(cents: number, currency: string): string;
-/**
- * Format overage rate for display. When unitSize > 1: "$1.00/1,000 units"; else "$1.00/unit".
- * Returns null if overageCents is missing or negative.
- */
-export declare function formatOverageRate(overageCents: number | undefined, unitSize: number | undefined, currency: string): string | null;
-/**
- * Format overage rate with optional unit label for comparison/preview UIs.
- * e.g. formatOverageRateWithLabel(50, 1000, "video") -> "$0.50/1,000 videos"
- *      formatOverageRateWithLabel(46, 1, "video") -> "$0.46/video"
- * When unitLabel is omitted, falls back to formatOverageRate behavior.
- */
-export declare function formatOverageRateWithLabel(overageCents: number | undefined, unitSize: number | undefined, unitLabel: string | undefined, currency: string): string | null;
-/**
- * Get singular unit label from item name or slug (e.g. "Videos" -> "video", "reels" -> "reel").
- * Used for quota display in comparison and preview.
- */
-export declare function getQuotaUnitLabelFromName(nameOrSlug: string): string;
-/**
- * Format quota "included + overage" for display.
- * When unitSize >= 2: "Included: 1,000, after that $1.00/1,000 emails".
- * Otherwise: "Included: 5, after that $0.30/image".
- */
-export declare function formatQuotaIncludedOverage(included: number | undefined, overageCents: number | undefined, unitLabel: string, currency: string, unitSize?: number): string;

package/dist/types/api/index.d.ts

@@ -1,12 +0,0 @@
-export type { IBetaConfig } from '../components/beta/api';
-/** Central SDK APIs – all extend BaseApi for shared URL/auth/request handling. */
-export { BaseApi } from '../lib/api-base';
-export type { IBaseApiConfig } from '../lib/api-base';
-export { SettingsApi } from '../providers/os/api';
-export { UserApi } from '../providers/user/api';
-export { WorkspaceApi } from '../providers/workspace/api';
-/** Currency utilities */
-export { CURRENCY_DISPLAY, CURRENCY_FLAG, PLAN_CURRENCY_CODES, PLAN_CURRENCY_OPTIONS, formatCents, formatOverageRate, formatOverageRateWithLabel, formatQuotaIncludedOverage, getCurrencyFlag, getCurrencySymbol, getQuotaUnitLabelFromName, } from './currency-utils';
-/** Pricing variant (multi-currency) utilities */
-export { getAvailableCurrenciesFromPlans, getBasePriceCents, getBillingIntervalAndCurrencyFromPriceId, getDisplayCurrency, getPricingVariant, getQuotaDisplayWithVariant, getQuotaOverageCents, getStripePriceIdForInterval, } from './pricing-variant-utils';
-export type { PlanVersionWithPricingVariants, QuotaDisplayWithOverage, } from './pricing-variant-utils';

package/dist/types/api/pricing-variant-utils.d.ts

@@ -1,66 +0,0 @@
-/**
- * Helpers for multi-currency plan version pricing (pricingVariants).
- */
-import type { BillingInterval, IPlanVersion, IPlanVersionWithPlan, IPricingVariant } from './types';
-/** Get the pricing variant for a currency, or null if not available. */
-export declare function getPricingVariant(planVersion: IPlanVersion, currency: string): IPricingVariant | null;
-/**
- * Get base price in cents for a plan version and currency/interval.
- */
-export declare function getBasePriceCents(planVersion: IPlanVersion, currency: string, interval: BillingInterval): number | null;
-/**
- * Get Stripe price ID for the given plan version, currency, and interval.
- */
-export declare function getStripePriceIdForInterval(planVersion: IPlanVersion, currency: string, interval: BillingInterval): string | null;
-/**
- * Get overage amount in cents for a quota in a given currency and interval.
- * Returns undefined if not defined in the pricing variant.
- */
-export declare function getQuotaOverageCents(planVersion: IPlanVersion, currency: string, quotaSlug: string, interval: BillingInterval): number | undefined;
-/**
- * Get display currency for a plan version when using a given currency.
- * Returns the requested currency if the variant exists; otherwise plan.currency or null.
- */
-export declare function getDisplayCurrency(planVersion: IPlanVersionWithPlan, currency: string): string;
-/** Minimal shape for extracting currencies (IPlanVersionWithPlan or IPublicPlanVersion). */
-export type PlanVersionWithPricingVariants = {
-    pricingVariants?: IPricingVariant[];
-};
-/**
- * Collect all unique currency codes from plan versions (from their pricingVariants).
- * Use for currency selector. Accepts IPlanVersionWithPlan[] or IPublicPlanVersion[].
- */
-export declare function getAvailableCurrenciesFromPlans(planVersions: PlanVersionWithPricingVariants[]): string[];
-/**
- * Quota display shape: included count and optional overage (cents) and unitSize from plan + variant.
- */
-export type QuotaDisplayWithOverage = {
-    included: number;
-    overage?: number;
-    unitSize?: number;
-} | null;
-/**
- * Get quota display value for a slug/interval, merging plan version quotas (included, unitSize)
- * with pricing variant overage (cents) when available.
- */
-export declare function getQuotaDisplayWithVariant(planVersion: IPlanVersion, currency: string, quotaSlug: string, interval: BillingInterval): QuotaDisplayWithOverage;
-/**
- * Resolve billing interval and currency from a Stripe price ID by checking all plan versions' pricingVariants.
- */
-export declare function getBillingIntervalAndCurrencyFromPriceId(priceId: string | null | undefined, planVersions: IPlanVersionWithPlan[]): {
-    interval: BillingInterval;
-    currency: string;
-} | null;
-/** Get per-seat pricing config for a plan version and currency. Null if not enabled. */
-export declare function getSeatPricing(planVersion: IPlanVersion, currency: string): IPricingVariant['seatPricing'] | null;
-/** Get per-seat price in cents for a billing interval. Null if seat pricing not enabled. */
-export declare function getPerSeatPriceCents(planVersion: IPlanVersion, currency: string, interval: BillingInterval): number | null;
-/** Calculate billable seats: max(0, currentSeats - includedSeats). */
-export declare function calculateBillableSeats(currentSeatCount: number, includedSeats: number): number;
-/** Calculate total seat overage cost in cents. Null if seat pricing not enabled. */
-export declare function calculateSeatOverageCents(planVersion: IPlanVersion, currency: string, interval: BillingInterval, currentSeatCount: number): number | null;
-/**
- * Calculate total subscription price in cents: base + seat overage (if enabled).
- * Does not include metered usage (billed at period end).
- */
-export declare function calculateTotalSubscriptionCents(planVersion: IPlanVersion, currency: string, interval: BillingInterval, currentSeatCount?: number): number | null;

package/dist/types/api/quota-utils.d.ts

@@ -1,24 +0,0 @@
-import type { BillingInterval, IQuotaByInterval } from './types';
-export type QuotaDisplayValue = {
-    included: number;
-    overage?: number;
-    unitSize?: number;
-} | null;
-/**
- * Normalize a per-interval quota value to a display shape for the given billing interval.
- */
-export declare function getQuotaDisplayValue(value: IQuotaByInterval | null | undefined, interval?: BillingInterval): QuotaDisplayValue;
-/** Options for formatting quota with price. */
-export interface FormatQuotaWithPriceOptions {
-    /** If true, overage is in cents (Stripe); format as dollars. Default true. */
-    overageInCents?: boolean;
-    /** Currency symbol override. When omitted, derived from `currency` (empty if no currency). */
-    currencySymbol?: string;
-    /** Stripe currency code (e.g. 'usd', 'inr'). Used to resolve symbol when currencySymbol is not set. */
-    currency?: string;
-}
-/**
- * Format a quota display value as "X included, then $Y.YY / unit" (e.g. "10 included, then $10.00 / video").
- * Assumes overage is the per-unit price (in cents when overageInCents is true).
- */
-export declare function formatQuotaWithPrice(value: QuotaDisplayValue, unitName: string, options?: FormatQuotaWithPriceOptions): string;

package/dist/types/api/types.d.ts

@@ -1,495 +0,0 @@
-export interface IDocument {
-    _id: string;
-    /** Optional; some APIs only return _id. Prefer _id for identity. */
-    id?: string;
-    createdAt: string;
-    updatedAt: string;
-    deleted: boolean;
-}
-export interface IAssetBucket {
-    name: string;
-    url: string;
-    path: string;
-}
-export interface IUser extends IDocument {
-    _id: string;
-    name: string;
-    email: string;
-    /** Profile image URL. Often omitted or empty from API. */
-    image?: string;
-    role: string;
-    /** ISO country code. May be omitted. */
-    country?: string;
-    /** IANA timezone. May be omitted. */
-    timezone?: string;
-    /** Language code. May be omitted. */
-    language?: string;
-    /** Currency code. May be omitted. */
-    currency?: string;
-    attributes?: Record<string, string | number | boolean>;
-}
-export interface IAsset extends IDocument {
-    _id: string;
-    createdAt: string;
-    updatedAt: string;
-    deleted: boolean;
-    name: string;
-    uniqueName: string;
-    mimeType: string;
-    size: number;
-    encoding: string;
-    bucket: {
-        name: string;
-        url: string;
-        path: string;
-    };
-    metadata: {
-        [key: string]: string | number | boolean | object | null;
-    };
-    image?: {
-        width: number;
-        height: number;
-    };
-    tags: string[];
-    public: boolean;
-    creator: string | IUser;
-}
-export type BillingInterval = 'monthly' | 'yearly' | 'quarterly';
-export interface ISubscription {
-    _id: string;
-    subscriptionStatus: 'active' | 'trialing' | 'canceled' | 'past_due' | 'paused' | 'incomplete' | 'unpaid';
-    stripePriceId?: string;
-    stripeCurrentPeriodEnd?: string;
-    cancelAtPeriodEnd: boolean;
-    billingInterval?: BillingInterval;
-    /** Trial start date (ISO string). Set when subscription is in trial. */
-    trialStart?: string;
-    /** Trial end date (ISO string). Set when subscription is in trial. */
-    trialEnd?: string;
-    /** When the subscription was canceled (ISO string). Soft-delete marker. */
-    canceledAt?: string;
-    /** Dunning state: 'none', 'notified', 'warning', 'final', 'suspended'. */
-    dunningState?: string;
-    /** Whether this subscription uses per-seat pricing. */
-    seatPricingEnabled?: boolean;
-    /** Current billable seat count. */
-    currentSeatCount?: number;
-    createdAt: string;
-    updatedAt: string;
-    plan?: {
-        _id: string;
-        name: string;
-        slug: string;
-        description?: string;
-        /** Stripe currency code (e.g. 'usd', 'inr', 'eur'). */
-        currency?: string;
-    };
-}
-export interface ISubscriptionItem {
-    _id: string;
-    type: 'feature' | 'limit' | 'quota';
-    name: string;
-    slug: string;
-    description?: string;
-    category: string;
-}
-/** Per-interval quota value (plan-group/versions and public plans schema). */
-export interface IQuotaIntervalValue {
-    included: number;
-    /** Overage price in cents. Omitted in public plans; use pricingVariant.quotaOverages for display. */
-    overage?: number;
-    /** Stripe price ID for overage. Omitted in public plans; use pricingVariant.quotaOveragePriceIds. */
-    priceId?: string;
-    /** Unit size for overage pricing (e.g. 1000 = price per 1000 units). */
-    unitSize?: number;
-}
-/** Quota defined per billing interval (new plan-group/versions schema) */
-export interface IQuotaByInterval {
-    monthly?: IQuotaIntervalValue;
-    yearly?: IQuotaIntervalValue;
-    quarterly?: IQuotaIntervalValue;
-}
-/** Base pricing per interval. Values are often in cents (Stripe); convert for display. */
-export interface IBasePricing {
-    monthly: number;
-    yearly: number;
-    quarterly: number;
-}
-/** Stripe price IDs per billing interval (for a single currency variant). */
-export interface IStripePricesByInterval {
-    monthlyPriceId?: string;
-    yearlyPriceId?: string;
-    quarterlyPriceId?: string;
-    monthly?: string;
-    yearly?: string;
-}
-/** Overage amounts in cents per interval, keyed by quota slug. Used in pricing variants. */
-export type IQuotaOveragesByInterval = Record<string, {
-    monthly?: number;
-    yearly?: number;
-    quarterly?: number;
-}>;
-/** Overage Stripe price IDs per interval, keyed by quota slug. Used in pricing variants. */
-export type IQuotaOveragePriceIdsByInterval = Record<string, {
-    monthly?: string;
-    yearly?: string;
-    quarterly?: string;
-}>;
-/**
- * Multi-currency pricing variant at plan version level.
- * Each plan version can have multiple variants (e.g. usd, eur, inr, sgd).
- */
-export interface IPricingVariant {
-    _id: string;
-    currency: string;
-    basePricing: IBasePricing;
-    stripePrices: IStripePricesByInterval;
-    /** Per-seat pricing config. When enabled, a second recurring item is on the subscription. */
-    seatPricing?: {
-        enabled: boolean;
-        includedSeats: number;
-        /** Maximum seats allowed. 0 or undefined = unlimited. */
-        maxSeats?: number;
-        perSeat: IBasePricing;
-    };
-    /** Stripe Price IDs for the per-seat recurring price. */
-    seatStripePrices?: IStripePricesByInterval;
-    /** Overage cents per quota slug per interval. */
-    quotaOverages?: IQuotaOveragesByInterval;
-    /** Stripe price IDs for overage per quota slug per interval. */
-    quotaOveragePriceIds?: IQuotaOveragePriceIdsByInterval;
-}
-export interface IPlanVersion {
-    _id: string;
-    version: number;
-    name: string;
-    status: 'draft' | 'published';
-    features?: Record<string, boolean>;
-    limits?: Record<string, number>;
-    /** Per-interval quotas (included, unitSize; overage from pricingVariant.quotaOverages). */
-    quotas?: Record<string, IQuotaByInterval>;
-    /** Multi-currency pricing. Each variant has currency, basePricing, stripePrices, quotaOverages. */
-    pricingVariants?: IPricingVariant[];
-    subscriptionItems?: ISubscriptionItem[];
-    isCurrent?: boolean;
-    isLegacy?: boolean;
-    archived?: boolean;
-    deleted?: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-    id?: string;
-    stripeProductId?: string;
-}
-/** Plan version summary (e.g. plan.latestVersion from subscription API) with subscriptionItems as IDs. */
-export interface IPlanVersionSummary extends Omit<IPlanVersion, 'subscriptionItems'> {
-    subscriptionItems?: string[];
-}
-export interface IPlan {
-    _id: string;
-    name: string;
-    slug: string;
-    description?: string;
-    /** Stripe currency code (e.g. 'usd', 'inr', 'eur'). Used for pricing display. */
-    currency?: string;
-    latestVersion?: IPlanVersionSummary;
-    archived?: boolean;
-    deleted?: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-    id?: string;
-}
-export interface IPlanGroupLatestVersion {
-    _id: string;
-    version: number;
-    planVersionIds: string[];
-    requiredItems: string[];
-    status: 'draft' | 'published';
-    isCurrent?: boolean;
-    isLegacy?: boolean;
-    archived?: boolean;
-    deleted?: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-    description?: string;
-}
-export interface IPlanGroup {
-    _id: string;
-    name: string;
-    slug: string;
-    description?: string;
-    latestVersion?: IPlanGroupLatestVersion;
-    archived?: boolean;
-    deleted?: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-    id?: string;
-}
-export interface IPlanGroupVersion {
-    _id: string;
-    version: number;
-    description?: string;
-    group?: {
-        _id: string;
-        name: string;
-        description?: string;
-    };
-    planVersionIds: IPlanVersionWithPlan[] | string[];
-    requiredItems?: string[];
-    status?: 'draft' | 'published';
-    isCurrent?: boolean;
-    isLegacy?: boolean;
-    archived?: boolean;
-    deleted?: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-    id?: string;
-}
-export interface ISubscriptionResponse {
-    subscription: ISubscription | null;
-    planVersion: IPlanVersion | null;
-    plan: IPlan | null;
-    group: IPlanGroup | null;
-    groupVersion: IPlanGroupVersion | null;
-}
-/** Plan version with nested plan info (name, slug, currency for display). */
-export interface IPlanVersionWithPlan extends IPlanVersion {
-    plan: IPlan;
-}
-/**
- * Plan group version with full plan versions (for GET .../plan-group/versions).
- * Each plan has plan, subscriptionItems, quotas (per-interval), pricingVariants.
- */
-export interface IPlanGroupVersionWithPlans {
-    _id: string;
-    version: number;
-    description?: string;
-    /** Full plan versions with nested plan (name, slug, currency). */
-    plans: IPlanVersionWithPlan[];
-    isCurrent?: boolean;
-    whatsNew?: {
-        newPlans: IPlanVersionWithPlan[];
-        updatedPlans: IPlanVersionWithPlan[];
-        removedPlans: IPlanVersionWithPlan[];
-    };
-}
-export interface IPlanGroupInfo {
-    _id: string;
-    name: string;
-    slug: string;
-    description?: string;
-}
-/** Response from GET workspaces/:id/subscription/plan-group (and by version). */
-export interface IPlanGroupResponse {
-    /** Plan group with latestVersion, archived, deleted, timestamps. May be null in some API responses. */
-    group: IPlanGroup | null;
-    /** Current group version with populated planVersionIds (or IDs). */
-    groupVersion: IPlanGroupVersion;
-    /** Full plan versions for display (subscriptionItems, pricingVariants, quotas). */
-    plans: IPlanVersionWithPlan[];
-}
-/**
- * Response from GET workspaces/:workspaceId/subscription/plan-group/versions.
- * Group summary plus current and available group versions; each version has plans with
- * per-interval quotas and pricingVariants.
- */
-export interface IPlanGroupVersionsResponse {
-    /** Plan group summary (_id, name, slug). */
-    group: IPlanGroupInfo;
-    /** Current group version (user's version when subscribed, or latest published when not). */
-    currentVersion: IPlanGroupVersionWithPlans;
-    /** Newer versions when user has subscription; empty when no subscription. */
-    availableVersions: IPlanGroupVersionWithPlans[];
-}
-/** Request body for POST .../workspaces/:id/subscription/checkout. Only these fields are allowed. */
-export interface ICheckoutSessionRequest {
-    planVersionId: string;
-    billingInterval?: BillingInterval;
-    currency?: string;
-    successUrl?: string;
-    cancelUrl?: string;
-}
-export interface ICheckoutSessionResponse {
-    /** Response type discriminator. Added for centralized checkout flow. */
-    type?: 'checkout' | 'trial_started' | 'existing';
-    success: boolean;
-    checkoutUrl: string;
-    sessionId: string;
-    message: string;
-    planVersion?: {
-        _id: string;
-        version: number;
-        name: string;
-    };
-}
-/** No-card trial started server-side; no redirect needed. */
-export interface ICheckoutTrialResult {
-    type: 'trial_started';
-    success: boolean;
-    checkoutUrl: null;
-    sessionId: null;
-    subscription: ISubscription;
-    message: string;
-}
-/** Workspace already has a matching active subscription. */
-export interface ICheckoutExistingResult {
-    type: 'existing';
-    success: boolean;
-    checkoutUrl: null;
-    sessionId: null;
-    message: string;
-    existingSubscription?: {
-        _id: string;
-        subscriptionStatus: string;
-        stripePriceId?: string;
-    };
-}
-/**
- * Discriminated union for POST /subscription/checkout responses.
- * - `checkout`: Stripe checkout session created, redirect user to checkoutUrl
- * - `trial_started`: No-card trial started server-side, no redirect needed
- * - `existing`: Workspace already has a matching subscription
- */
-export type CheckoutResult = (ICheckoutSessionResponse & {
-    type: 'checkout';
-}) | ICheckoutTrialResult | ICheckoutExistingResult;
-/** Request body for PATCH .../workspaces/:id/subscription. Only these fields are allowed. */
-export interface ISubscriptionUpdateRequest {
-    planVersionId: string;
-    billingInterval?: BillingInterval;
-    successUrl?: string;
-    cancelUrl?: string;
-}
-export interface ISubscriptionUpdateResponse {
-    _id: string;
-    subscriptionStatus: string;
-    workspace: string;
-    planVersion: string;
-    plan: string;
-    planGroup?: string;
-    planGroupVersion?: string;
-    cancelAtPeriodEnd: boolean;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface IPublicPlanItemCategory {
-    name: string;
-    slug: string;
-}
-export interface IPublicPlanItem {
-    _id: string;
-    name: string;
-    slug: string;
-    description?: string;
-    type: 'feature' | 'limit' | 'quota';
-    category: IPublicPlanItemCategory;
-}
-/**
- * Public plan version (e.g. from GET /api/v1/public/:orgId/plans/:slug).
- * Each plan has _id, name (plan display name), version, status, pricingVariants, quotas, features, limits.
- * Pricing is in cents (see response.notes).
- */
-export interface IPublicPlanVersion {
-    _id: string;
-    /** Plan display name (e.g. "Pro", "Base Plan"). */
-    name: string;
-    version: number;
-    status: 'draft' | 'published';
-    /** Multi-currency pricing. Use getBasePriceCents(plan, currency, interval) and getQuotaDisplayWithVariant for display. */
-    pricingVariants?: IPricingVariant[];
-    /** Keyed by item slug. Per-interval: included, unitSize; overage from pricingVariant.quotaOverages. */
-    quotas: Record<string, IQuotaByInterval>;
-    features: Record<string, boolean>;
-    limits: Record<string, number>;
-}
-export interface IPublicPlansResponse {
-    items: IPublicPlanItem[];
-    plans: IPublicPlanVersion[];
-    /** Optional note from API (e.g. "Pricing is in cents. Please convert to dollars for display."). */
-    notes?: string;
-}
-export type InvoiceStatus = 'draft' | 'open' | 'paid' | 'uncollectible' | 'void';
-export interface IInvoice {
-    id: string;
-    amount_due: number;
-    number: string | null;
-    amount_paid: number;
-    currency: string;
-    status: InvoiceStatus;
-    created: number;
-    due_date: number | null;
-    hosted_invoice_url: string;
-    invoice_pdf: string | null;
-    description: string | null;
-    subscription: string;
-}
-export interface IInvoiceListResponse {
-    success: boolean;
-    invoices: IInvoice[];
-    has_more: boolean;
-}
-export interface IInvoiceResponse {
-    success: boolean;
-    invoice: IInvoice;
-}
-/** Request body for POST .../workspaces/:id/subscription/usage */
-export interface IRecordUsageRequest {
-    quotaSlug: string;
-    quantity: number;
-    metadata?: Record<string, unknown>;
-    source?: string;
-    idempotencyKey?: string;
-}
-/** Response from POST .../workspaces/:id/subscription/usage */
-export interface IRecordUsageResponse {
-    used: number;
-    consumed: number;
-    included: number;
-    available: number;
-    overage: number;
-    billedAsync: boolean;
-}
-/** Single quota usage status (shared between status and all endpoints). */
-export interface IQuotaUsageStatus {
-    consumed: number;
-    included: number;
-    available: number;
-    overage: number;
-    hasOverage: boolean;
-}
-/** Response from GET .../workspaces/:id/subscription/usage/status?quotaSlug=X */
-export interface IQuotaUsageStatusResponse extends IQuotaUsageStatus {
-    quotaSlug: string;
-}
-/** Response from GET .../workspaces/:id/subscription/usage/all */
-export interface IAllQuotaUsageResponse {
-    quotas: Record<string, IQuotaUsageStatus>;
-}
-/** Single usage log entry from GET .../usage/logs */
-export interface IUsageLogEntry {
-    _id: string;
-    quotaSlug: string;
-    quantity: number;
-    source?: string;
-    workspace: string;
-    createdAt: string;
-    updatedAt: string;
-}
-/** Query parameters for GET .../workspaces/:id/subscription/usage/logs */
-export interface IUsageLogsQuery {
-    quotaSlug?: string;
-    from?: string;
-    to?: string;
-    source?: string;
-    page?: number;
-    limit?: number;
-}
-/** Paginated response from GET .../workspaces/:id/subscription/usage/logs */
-export interface IUsageLogsResponse {
-    docs: IUsageLogEntry[];
-    totalDocs: number;
-    limit: number;
-    page: number;
-    totalPages: number;
-    hasNextPage: boolean;
-    hasPrevPage: boolean;
-}