@nangohq/types/dist/plans/db.d.ts

Types used in Nango applications

import type { Timestamps } from '../db.js';
export interface DBPlan extends Timestamps {
    id: number;
    account_id: number;
    name: 'free' | 'starter' | 'starter-legacy' | 'growth' | 'scale-legacy' | 'growth-legacy' | 'enterprise';
    stripe_customer_id: string | null;
    stripe_payment_id: string | null;
    orb_customer_id: string | null;
    orb_subscription_id: string | null;
    orb_future_plan: string | null;
    orb_future_plan_at: Date | null;
    trial_start_at: Date | null;
    trial_end_at: Date | null;
    trial_extension_count: number;
    trial_end_notified_at: Date | null;
    trial_expired: boolean | null;
    /**
     * Limit the number of total non-deleted connections
     * Set to null to remove limit
     * @default null
     */
    connections_max: number | null;
    /**
     * Limit the number of environments that can be created
     * @default 2
     */
    environments_max: number;
    /**
     * Limit the number of actions that can be triggered in a month
     * @default 1000
     */
    monthly_actions_max: number | null;
    /**
     * Limit the amount of monthly active records (Records created or updated in a month)
     * @default 5000
     */
    monthly_active_records_max: number | null;
    /**
     * Limit the minimum frequency of a sync
     * Not used yet
     * @default 86400
     */
    sync_frequency_secs_min: number;
    /**
     * Enable or disabled sync variant
     * @default false
     */
    has_sync_variants: boolean;
    /**
     * Enable or disabled open telemetry export
     * @default false
     */
    has_otel: boolean;
    /**
     * Change the applied rate limit for the public API
     * @default "m"
     */
    api_rate_limit_size: 's' | 'm' | 'l' | 'xl' | '2xl' | '3xl' | '4xl';
    /**
     * Enable or disable machine auto idling
     * @default true
     */
    auto_idle: boolean;
}