@checkbox-site/node 0.0.0-stage → 0.1.0

package/dist/generated/types.d.ts

@@ -0,0 +1,4436 @@
+/** The API version these types describe (sent as Checkbox-Version by default). */
+export declare const API_VERSION = "2026-10-30";
+/** Every API version the server knows, oldest first. */
+export declare const API_VERSIONS: readonly ["2026-10-30"];
+export type ApiVersion = (typeof API_VERSIONS)[number];
+/** `T` with the keys `K` required. */
+export type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: Exclude<T[P], undefined>;
+};
+/** What the caller (often an AI agent) should do next. */
+export interface NextAction {
+    /** Stable machine-readable action type, e.g. "verify_domain", "create_site", "wait". */
+    type: string;
+    /** One sentence telling the caller what to do next. */
+    message: string;
+    /** operationId of the API call to make next (also the SDK method name). */
+    operation_id?: string;
+    /** The MCP tool that performs operation_id on the Checkbox MCP server (`call_api` when there is no dedicated tool). */
+    mcp_tool?: string;
+    /** Documentation or dashboard URL for the step, when there is one. */
+    url?: string;
+}
+/** Every non-2xx response has this shape. */
+export interface Error {
+    /** Error details. */
+    error: {
+        /** Category of the error. */
+        type: "invalid_request_error" | "authentication_error" | "permission_error" | "rate_limit_error" | "idempotency_error" | "api_error";
+        /** Stable error code (see the error code list in the docs). Never changes meaning. */
+        code: string;
+        /** Human- and LLM-readable explanation. */
+        message: string;
+        /** The parameter the error relates to, when there is one. */
+        param?: string;
+        /** Link to the documentation of this error code. */
+        doc_url: string;
+        /** Id of the request (also in the Request-Id header). Quote it to support. */
+        request_id: string;
+        next_action?: NextAction;
+    };
+}
+/** The single next thing the agent should do. */
+export interface SetupNextAction {
+    /** Stable action type: install_snippet, set_site_url, deploy_and_verify, register_policies, fix_policy_url, verify, wait, store_stripe_test_key, register_checkout_config, start_test_run, wait_for_test_run, fix_test_run, apply_compliance_plan, review_plan, verify_domain, complete_setup, done. */
+    type: string;
+    /** One or two sentences telling the agent exactly what to do. */
+    message: string;
+    /** The API operation (SDK method) that performs or checks the step. */
+    operation_id?: string;
+    /** The MCP tool that performs operation_id (`call_api` when there is no dedicated tool). */
+    mcp_tool?: string;
+    /** The equivalent `checkbox` CLI command, when there is one. */
+    command?: string;
+    /** Documentation or dashboard URL for the step. */
+    url?: string;
+}
+/** A pending device login (RFC 8628 style). */
+export interface DeviceAuthorization {
+    /** String representing the object's type. Always "device_authorization". */
+    object: "device_authorization";
+    /** Secret code the CLI polls with (keep it private). */
+    device_code: string;
+    /** Code the human sees and confirms in the browser. */
+    user_code: string;
+    /** Page the human opens. */
+    verification_uri: string;
+    /** Same page with the code filled in: open this. */
+    verification_uri_complete: string;
+    /** Seconds until the codes expire. */
+    expires_in: number;
+    /** Seconds to wait between createDeviceToken polls. */
+    interval: number;
+    next_action: SetupNextAction;
+}
+/** Who is setting up Checkbox. */
+export interface SetupClient {
+    /** Client program. */
+    name?: string;
+    /** Client version. */
+    version?: string;
+    /** The AI agent driving the client, when known (shown to the human). */
+    agent?: string;
+    /** Operating system. */
+    os?: string;
+}
+/** What the CLI is about to set up (display only). */
+export interface DeviceAuthorizationParams {
+    client?: SetupClient;
+    /** Site URL detected in the project (shown on the approval screen; the test-mode site is created for it). */
+    site_url?: string;
+    /** Project name. */
+    project_name?: string;
+    /** Detected framework. */
+    framework?: string;
+    /** Package manager. */
+    package_manager?: string;
+    /** Detected billing platform. */
+    billing_platform?: string;
+    /** Also ask for live-mode keys (live mode activates after domain verification). */
+    live?: boolean;
+    /** A HINT of the Stripe TEST key found in the project ("sk_test_…a1b2" — never the key). The human is asked once whether Checkbox may use it for synthetic test subscriptions. */
+    stripe_test_key_hint?: string;
+}
+/** Keys issued after the human approved the device login. Returned exactly once. */
+export interface DeviceToken {
+    /** String representing the object's type. Always "device_token". */
+    object: "device_token";
+    /** Always "bearer". */
+    token_type: "bearer";
+    /** Test-mode secret key (ck_test_…), shown once. Store it in CHECKBOX_SECRET_KEY (server side only; never commit it). */
+    secret_key: string;
+    /** Test-mode publishable key (pk_test_…) for the browser. */
+    publishable_key: string;
+    /** Live-mode secret key when the human approved live keys (works for live routes after domain verification). */
+    live_secret_key: string | null;
+    /** Live-mode publishable key. */
+    live_publishable_key: string | null;
+    /** The account the keys belong to. */
+    account: {
+        /** Unique identifier of the account (acct_…). */
+        id: string;
+        /** Account (organization) name. */
+        name: string;
+        /** Email of the person who approved. */
+        email: string | null;
+    };
+    /** The setup session to continue with (retrieveSetupSession / updateSetupSession). */
+    setup_session: string;
+    /** The test-mode site created for site_url, if any. */
+    site: string | null;
+    /** What the human approved. */
+    consents: {
+        /** The human allowed Checkbox to use the project's Stripe TEST key (send it with createTestCredential). */
+        stripe_test_key: boolean;
+        /** Live keys were issued. */
+        live_keys: boolean;
+    };
+    next_action: SetupNextAction;
+}
+/** A subscription plan as the merchant sells it. */
+export interface SetupPlan {
+    /** Plan name. */
+    name?: string;
+    /** Recurring charge in minor units. */
+    amount?: number;
+    /** ISO currency code. */
+    currency?: string;
+    /** Billing interval. */
+    interval?: "day" | "week" | "month" | "year";
+    /** Intervals per billing period. */
+    interval_count?: number;
+    /** Free-trial days (0 = none). */
+    trial_days?: number;
+}
+/** One step of the setup checklist. */
+export interface SetupStep {
+    /** Stable step key. */
+    key: "account" | "site" | "snippet" | "policies" | "checks" | "lifecycle_test" | "fixes" | "domain" | "owner_notified";
+    /** Human-readable title. */
+    title: string;
+    /** done; pending (waiting on Checkbox or a deploy); action_required (the agent must act: see next_action); skipped; failed. */
+    status: "done" | "pending" | "action_required" | "skipped" | "failed";
+    /** What is true now, in one sentence. */
+    summary: string;
+    next_action: SetupNextAction | null;
+}
+/** What an AI coding agent set up for a project, as a checklist with one next_action. Loop: apply next_action, call verifySetupSession, repeat until next_action.type is "done". */
+export interface SetupSession {
+    /** Unique identifier of the setup session (setup_…). */
+    id: string;
+    /** String representing the object's type. Always "setup_session". */
+    object: "setup_session";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** open while the agent works; completed after completeSetupSession (checks keep running). */
+    status: "open" | "completed" | "canceled";
+    /** When the human approved the setup. Unix timestamp in seconds. */
+    created: number;
+    /** Last change. Unix timestamp in seconds. */
+    updated: number;
+    /** The Checkbox account. */
+    account: string;
+    /** The test-mode site (null until a site URL is known). */
+    site: string | null;
+    /** The live-mode site, once created. */
+    live_site: string | null;
+    /** Who set it up. */
+    client: {
+        /** Client program. */
+        name: string | null;
+        /** Client version. */
+        version: string | null;
+        /** AI agent, when known. */
+        agent: string | null;
+    };
+    /** Facts about the codebase the agent reported (framework, layout_file, checkout_code…). */
+    project: Record<string, unknown>;
+    /** The business as registered. */
+    business: {
+        /** Site URL. */
+        site_url: string | null;
+        /** Checkout / pricing page. */
+        checkout_url: string | null;
+        /** Account page. */
+        account_url: string | null;
+        /** Terms of service. */
+        terms_url: string | null;
+        /** Privacy policy. */
+        privacy_url: string | null;
+        /** Refund policy. */
+        refund_url: string | null;
+        /** Cancellation policy. */
+        cancellation_url: string | null;
+        /** Support email. */
+        support_email: string | null;
+        /** Merchant (brand) name used in generated legal copy (the site name). */
+        merchant_name: string | null;
+        /** Billing platform. */
+        billing_platform: string | null;
+        /** Plans. */
+        plans: Array<SetupPlan>;
+    };
+    /** Policy / pricing links Checkbox found in the site's HTML (terms_url, privacy_url, refund_url, cancellation_url, pricing_url, account_url). */
+    discovered: Record<string, string>;
+    /** Install details. */
+    install: {
+        /** The exact tag to put in <head> on every page. */
+        script_tag: string | null;
+        /** Public snippet key of the site. */
+        snippet_key: string | null;
+        /** Test-mode publishable key (pk_test_…) for Checkbox Elements in the browser. */
+        publishable_key: string | null;
+        /** BCC this address on subscription emails (acknowledgment, reminders) so they are checked. */
+        inbound_email: string | null;
+        /** File the agent added the snippet to. */
+        installed_in: string | null;
+        /** Whether Checkbox saw the snippet on the live site at the last verify (null: not checked). */
+        detected_on_site: boolean | null;
+    };
+    /** Policy documents Checkbox fetched (checked by terms.* checks). */
+    policies: Array<{
+        /** terms, privacy, refund or cancellation. */
+        kind: string;
+        /** URL fetched. */
+        url: string;
+        /** Fetch result. */
+        status: "fetched" | "failed";
+        /** When it was fetched. Unix timestamp in seconds. */
+        fetched: number;
+        /** Why the fetch failed. */
+        error: string | null;
+        /** Evidence record of the stored page (ev_…). */
+        evidence: string | null;
+    }>;
+    /** Stripe test mode for lifecycle test runs. */
+    stripe: {
+        /** Whether the human allowed Checkbox to use the project's Stripe TEST key for synthetic subscriptions. */
+        test_key_consent: boolean;
+        /** Hint of the key the CLI found (never the key). */
+        test_key_hint: string | null;
+        /** Whether a Stripe test-mode key is stored for test runs. */
+        test_credential_stored: boolean;
+        /** Registered Checkout Session param sets. */
+        checkout_configs: number;
+        /** Restricted-key recommendation. */
+        restricted_key: {
+            /** true while no restricted (rk_test_) key is stored. */
+            recommended: boolean;
+            /** Why. */
+            reason: string;
+            /** Where to create it. */
+            create_url: string;
+            /** Least-privilege permissions. */
+            permissions: Array<{
+                /** Stripe resource. */
+                resource: string;
+                /** Access. */
+                access: "read" | "write";
+            }>;
+        };
+    };
+    /** Latest lifecycle test run of the site. */
+    test_run: {
+        /** Unique identifier of the test run (run_…). */
+        id: string;
+        /** queued, running, succeeded, failed or canceled. */
+        status: string;
+        /** When it started. Unix timestamp in seconds. */
+        created: number;
+    } | null;
+    /** Latest verdict of the test-mode site. */
+    compliance: {
+        /** 0-100. */
+        score: number;
+        /** No critical/high failure open. */
+        insurable: boolean;
+        /** When it was evaluated. Unix timestamp in seconds. */
+        evaluated: number;
+        /** Open failing findings. */
+        failing: number;
+        /** Open needs-review findings. */
+        needs_review: number;
+        /** Most urgent open findings (details: retrieveFinding; ordered tasks: `checkbox plan --json`). */
+        top_findings: Array<{
+            /** Unique identifier of the finding (fnd_…). */
+            id: string;
+            /** Check id. */
+            check_id: string;
+            /** fail or needs_review. */
+            status: string;
+            /** critical, high, medium or low. */
+            severity: string;
+            /** What is wrong. */
+            title: string;
+        }>;
+    } | null;
+    /** The setup checklist, in order. */
+    steps: Array<SetupStep>;
+    next_action: SetupNextAction;
+    /** Whether the human got the summary email. */
+    owner_notified: boolean;
+    /** The summary email: sent, or not_configured when this deployment has no SMTP (null before completeSetupSession). */
+    owner_email: "sent" | "not_configured" | null;
+    /** Dashboard page with the setup timeline (for the human). */
+    review_url: string;
+}
+/** A place in the builder's code relevant to compliance. */
+export interface SetupCodeRef {
+    /** Path relative to the project root. */
+    file: string;
+    /** 1-based line number. */
+    line?: number;
+    /** What was found: stripe_checkout_session, stripe_payment_link, stripe_pricing_table, stripe_elements, subscribe_button, shopify_checkout… */
+    kind: string;
+    /** The matching source line (trimmed). */
+    snippet?: string;
+}
+/** What the agent learned or changed. */
+export interface SetupSessionUpdate {
+    /** Public URL of the site (production, or a preview deployment). */
+    site_url?: string;
+    /** Page where customers subscribe (pricing page or checkout). */
+    checkout_url?: string;
+    /** Account page where subscribers manage / cancel. */
+    account_url?: string;
+    /** Terms of service page. Checkbox fetches and checks it. */
+    terms_url?: string;
+    /** Privacy policy page. */
+    privacy_url?: string;
+    /** Refund policy page. */
+    refund_url?: string;
+    /** Cancellation policy page (if separate from the Terms). */
+    cancellation_url?: string;
+    /** Support address subscribers can write to. */
+    support_email?: string;
+    /** The brand subscribers know (it names the seller in generated disclosures and emails). Default: the site's host name, which the plan asks you to replace. */
+    merchant_name?: string;
+    /** Billing platform. */
+    billing_platform?: "stripe" | "shopify" | "recharge" | "chargebee" | "recurly" | "paddle" | "woocommerce" | "custom";
+    /** Plans and prices (sets the free-trial and term facts the law depends on). */
+    plans?: Array<SetupPlan>;
+    /** Facts about the builder's codebase. */
+    project?: {
+        /** Project name (package.json name). */
+        name?: string;
+        /** Detected framework: nextjs-app, nextjs-pages, remix, sveltekit, nuxt, astro, express, html, shopify-theme… */
+        framework?: string;
+        /** npm, pnpm, yarn or bun. */
+        package_manager?: string;
+        /** Project root (display only). */
+        root?: string;
+        /** Root layout / template where the snippet belongs. */
+        layout_file?: string;
+        /** File the keys were written to. */
+        env_file?: string;
+        /** Static files directory (for /.well-known). */
+        public_dir?: string;
+        /** Where checkout sessions / payment links are created. */
+        checkout_code?: Array<SetupCodeRef>;
+        /** Where the subscribe / pay buttons are rendered. */
+        pay_buttons?: Array<SetupCodeRef>;
+    };
+    /** File the snippet tag was added to. */
+    snippet_installed_in?: string;
+    /** File the API keys were written to (never committed). */
+    env_written?: string;
+    /** Live-mode site (site_…) you created with the live key, so the checklist tracks its domain verification. */
+    live_site?: string;
+    client?: SetupClient;
+    /** Fetch the policy pages again even when their URLs did not change (after editing them). */
+    refetch_policies?: boolean;
+}
+/** A page of setup sessions, newest first. */
+export interface SetupSessionList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Setup sessions, newest first. */
+    data: Array<SetupSession>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** Result of verifySetupSession, with the updated session. */
+export interface SetupVerification {
+    /** String representing the object's type. Always "setup_verification". */
+    object: "setup_verification";
+    /** What Checkbox saw on the site. */
+    homepage: {
+        /** Whether the site loaded. */
+        ok: boolean;
+        /** Whether the snippet is live. */
+        snippet_detected: boolean | null;
+        /** Why the site could not be loaded. */
+        error: string | null;
+    };
+    /** Policies fetched now. */
+    policies: Array<{
+        /** Policy kind. */
+        kind: string;
+        /** Fetched. */
+        ok: boolean;
+        /** Error. */
+        error: string | null;
+    }>;
+    /** Synthetic-shopper scan. */
+    scan: {
+        /** Whether a scan was queued now. */
+        queued: boolean;
+        /** The queued scan (scan_…). */
+        scan: string | null;
+        /** Why not. */
+        reason: string | null;
+    };
+    /** Whether compliance was re-evaluated now. */
+    evaluated: boolean;
+    setup_session: SetupSession;
+}
+/** The Checkbox account behind the API key. */
+export interface Account {
+    /** Unique identifier of the account (acct_…). */
+    id: string;
+    /** String representing the object's type. Always "account". */
+    object: "account";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Organization name. */
+    name: string;
+    /** Contact email. */
+    email: string | null;
+    /** API version the account is pinned to (default for requests without Checkbox-Version). */
+    api_version: string;
+    /** Live-mode activation. Test mode never needs it. */
+    activation: {
+        /** active: live mode is on; pending: verify a site domain; suspended: contact support. */
+        status: "active" | "pending" | "suspended";
+        /** How the account was activated. */
+        method: "domain" | "staff" | "grandfathered" | null;
+        /** The verified domain that activated it. */
+        domain: string | null;
+        /** When live mode was activated. Unix timestamp in seconds. */
+        activated_at: number | null;
+    };
+    /** Fair-use limits (everything is free; these only prevent abuse). */
+    limits: {
+        /** Fair-use limit of active sites per mode. */
+        max_sites: number;
+        /** Active sites in this mode. */
+        sites: number;
+        /** Fair-use API rate limit per mode. */
+        requests_per_minute: number;
+    };
+    /** The key that made this request. */
+    key: {
+        /** Kind of key used for this request. */
+        type: "secret" | "restricted" | "publishable";
+        /** Role the key acts with. */
+        role: "admin" | "member" | "viewer";
+        /** Restricted keys: resource permissions. */
+        scopes: Record<string, "read" | "write"> | null;
+        /** A legacy sk_live_ organization key. */
+        legacy: boolean;
+    };
+    /** Publishable key (pk_…) of this mode for the browser snippet / elements. */
+    publishable_key: string;
+    /** Commercial status. */
+    billing: {
+        /** Checkbox is free to use. */
+        plan: "free";
+        /** The compliance warranty is not offered yet (waitlist only; no coverage). */
+        warranty: "coming_soon";
+    };
+    /** When the account was created. Unix timestamp in seconds. */
+    created: number;
+    next_action: NextAction | null;
+}
+/** Business facts that decide which legal requirements apply. */
+export interface SiteFacts {
+    /** The offer starts with a free trial. */
+    has_free_trial?: boolean;
+    /** Trial length in days. */
+    trial_days?: number;
+    /** Billing term in months (12 for annual plans). */
+    term_months?: number;
+    /** Customers sign up online (enables online-cancellation rules). */
+    online_signup?: boolean;
+    /** The subscription ships physical goods. */
+    sells_goods?: boolean;
+    /** Notices are sent by email. */
+    notice_channel_email?: boolean;
+    /** Price increases need consent or allow a refund (NY). */
+    price_increase_consent_or_refund?: boolean;
+    /** Accepted payment methods (debit / ACH bring in Reg E). */
+    payment_methods?: Array<"card" | "debit" | "ach" | "wallet" | "other">;
+}
+/** Scheduled monitoring. */
+export interface SiteMonitoring {
+    /** Scheduled re-scans are on. */
+    enabled: boolean;
+    /** Re-scan interval (0 = off). */
+    interval_minutes: number;
+    /** Monitoring waits for a verified domain: live-mode activation, or in test mode a host that is not localhost or a domain the account verified. */
+    held_for_activation: boolean;
+    /** Last scheduled or manual scan. Unix timestamp in seconds. */
+    last_scanned: number | null;
+    /** Scans and monitoring wait until every URL Checkbox visits for the site (site, checkout, account, steps) is on a domain the account verified. See verify_domains. */
+    held_for_domain_verification: boolean;
+    /** Domains to verify before Checkbox scans the site (first: createDomainVerification for the site's own domain). */
+    verify_domains: Array<string>;
+}
+/** Latest verdict; null until the first evaluation. */
+export type SiteCompliance = {
+    /** Compliance score 0-100 (one decimal place). */
+    score: number;
+    /** No critical/high obligation failing or unverified. */
+    insurable: boolean;
+    /** When the latest evaluation ran. Unix timestamp in seconds. */
+    evaluated: number;
+    /** Open findings whose latest status is fail. */
+    open_findings: number;
+    /** Open findings waiting for a human look. */
+    needs_review: number;
+} | null;
+/** What to install on the merchant site. */
+export interface SiteInstall {
+    /** Paste into the <head> of every page (or let `checkbox init` do it). */
+    script_tag: string;
+    /** Public key of the snippet (also the inbound email local part). */
+    snippet_key: string;
+    /** The site's inbound address (public: it is the snippet key). Emails copied here are stored as evidence. To confirm a due notice from any sender, BCC that notice's own bcc address (listDueNotices). */
+    inbound_email: string;
+    /** Billing-platform webhook URLs (platform -> URL). */
+    webhook_urls: Record<string, string>;
+}
+/** Most recent scan (only with expand[]=latest_scan). */
+export interface Scan {
+    /** Unique identifier of the scan (scan_…). */
+    id: string;
+    /** String representing the object's type. Always "scan". */
+    object: "scan";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The scanned site. */
+    site: string;
+    /** queued → running → completed | failed. */
+    status: "queued" | "running" | "completed" | "failed";
+    /** What started the scan. */
+    trigger: "manual" | "scheduled" | "page_changed" | "api";
+    /** States the synthetic shopper visited from (empty for evaluation-only runs). */
+    regions: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Why the scan failed. */
+    error: string | null;
+    /** Partial failures of a scan that still produced results. */
+    warnings: Array<string>;
+    /** The evaluation this scan produced (null until evaluated). */
+    evaluation: string | null;
+    /** Score of that evaluation (0-100, one decimal place). */
+    score: number | null;
+    /** Insurable flag of that evaluation. */
+    insurable: boolean | null;
+    /** When the scan started. Unix timestamp in seconds. */
+    started: number | null;
+    /** When the scan finished. Unix timestamp in seconds. */
+    finished: number | null;
+    /** When the scan was queued. Unix timestamp in seconds. */
+    created: number;
+}
+/** Domain verification (only with expand[]=domain_verification). */
+export interface DomainVerification {
+    /** Unique identifier of the domain verification (dv_…). */
+    id: string;
+    /** String representing the object's type. Always "domain_verification". */
+    object: "domain_verification";
+    /** The site. */
+    site: string;
+    /** Domain of the site URL. */
+    domain: string | null;
+    /** not_started until createDomainVerification; verified once the TXT record or file was found. */
+    status: "not_started" | "pending" | "verified";
+    /** How control was proven. */
+    method: "dns_txt" | "well_known" | null;
+    /** When it was verified. Unix timestamp in seconds. */
+    verified_at: number | null;
+    /** Last check. Unix timestamp in seconds. */
+    last_checked: number | null;
+    /** Why the last check failed. */
+    last_error: string | null;
+    /** Publish this DNS record (option 1). */
+    dns_record: {
+        /** Record type. */
+        type: "TXT";
+        /** Record name. */
+        name: string;
+        /** Record value. */
+        value: string;
+    } | null;
+    /** Or serve this file (option 2). */
+    file: {
+        /** Serve the file here. */
+        url: string;
+        /** Exact file contents. */
+        contents: string;
+    } | null;
+    /** Configured scan URLs outside the verified domain (certificates cover only the domain). */
+    scan_target_problems: Array<string>;
+    /** Whether live mode is activated for the account. */
+    account_activated: boolean;
+    /** What to do next; null when verified. */
+    next_action: {
+        /** Stable action type. */
+        type: string;
+        /** What to do next. */
+        message: string;
+        /** Operation to call next. */
+        operation_id?: string;
+        /** The MCP tool that performs operation_id (`call_api` when there is no dedicated tool). */
+        mcp_tool?: string;
+    } | null;
+}
+/** A subscription business Checkbox monitors. */
+export interface Site {
+    /** Unique identifier of the site (site_…). */
+    id: string;
+    /** String representing the object's type. Always "site". */
+    object: "site";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Display name. */
+    name: string;
+    /** Base URL. */
+    url: string;
+    /** Billing platform. */
+    platform: "stripe" | "shopify" | "recharge" | "chargebee" | "recurly" | "paddle" | "woocommerce" | "custom";
+    /** Evaluated jurisdictions (empty = all). */
+    jurisdictions: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    facts: SiteFacts;
+    /** Synthetic-shopper configuration (secrets are never returned). */
+    checkout: {
+        /** Checkout entry page. */
+        url: string;
+        /** States scanned from. */
+        regions: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+        /** Devices scanned. */
+        devices: Array<"desktop" | "mobile">;
+        /** Number of configured checkout steps. */
+        checkout_steps: number;
+        /** A synthetic sign-up is configured. */
+        completes_purchase: boolean;
+        /** A test account for the cancellation test is configured. */
+        has_test_account: boolean;
+        /** The test account as configured (the password is write-only and never returned). */
+        test_account: {
+            /** Login page. */
+            login_url: string;
+            /** Test subscriber email. */
+            email: string;
+        } | null;
+        /** Number of explicit cancellation steps. */
+        cancel_steps: number;
+        /** Public account / cancellation page visited on every scan. */
+        account_url: string | null;
+        /** Terms of service page read on every scan. */
+        terms_url: string | null;
+    };
+    monitoring: SiteMonitoring;
+    compliance: SiteCompliance;
+    install: SiteInstall;
+    /** Archived (soft-deleted); evidence is retained. */
+    archived: boolean;
+    /** When the site was created. Unix timestamp in seconds. */
+    created: number;
+    latest_scan?: Scan;
+    domain_verification?: DomainVerification;
+}
+/** A page of sites, newest first. */
+export interface SiteList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Sites, newest first. */
+    data: Array<Site>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** One synthetic-shopper step. */
+export type ScanStep = {
+    /** Navigate to a URL. */
+    action: "goto";
+    /** URL to open. */
+    url: string;
+} | {
+    /** Click an element (by CSS selector or visible text). */
+    action: "click";
+    /** CSS selector of the element. */
+    selector?: string;
+    /** Visible text of the element (used when no selector). */
+    text?: string;
+} | {
+    /** Type into an input (fill) or choose an option (select). */
+    action: "fill" | "select";
+    /** CSS selector of the input. */
+    selector: string;
+    /** Value; {{email}}, {{password}} and {{promoCode}} are substituted. */
+    value: string;
+} | {
+    /** Wait for a time or an element. */
+    action: "wait";
+    /** Milliseconds to wait. */
+    ms?: number;
+    /** Wait until this element appears. */
+    selector?: string;
+} | {
+    /** Record the current page as evidence. */
+    action: "capture";
+    /** What the page is. */
+    page_kind: "checkout" | "account" | "cancel" | "pricing" | "confirmation" | "other";
+    /** Label shown in the dashboard. */
+    label?: string;
+};
+/** How the synthetic shopper completes a real (free) sign-up. */
+export interface SitePurchase {
+    /** Steps that complete a sign-up after the checkout page. */
+    steps: Array<ScanStep>;
+    /** 100%-off promo code used for the synthetic sign-up (write-only). */
+    promo_code?: string;
+}
+/** A test customer account the synthetic shopper uses to try cancelling online. */
+export interface SiteTestAccount {
+    /** Login page of the test customer account. */
+    login_url: string;
+    /** Test account email. */
+    email: string;
+    /** Test account password (write-only; encrypted at rest). */
+    password: string;
+    /** Custom login steps. */
+    login_steps?: Array<ScanStep>;
+    /** Optional page on your site that re-activates the test subscription (a test-only route). The cancellation test really cancels the test account; the scanner opens this page after logging in, before cancelling, so every run starts subscribed. Without it, a run after a completed cancellation reports "already cancelled by an earlier scan" (needs review). */
+    reset_url?: string;
+}
+export interface CreateSiteParams {
+    /** Display name. */
+    name?: string;
+    /** Base URL of the business website. */
+    url: string;
+    /** Billing platform. */
+    platform?: "stripe" | "shopify" | "recharge" | "chargebee" | "recurly" | "paddle" | "woocommerce" | "custom";
+    /** Jurisdictions to evaluate (empty = all US laws). */
+    jurisdictions?: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    facts?: SiteFacts;
+    /** Page with the subscribe button (defaults to url). Not a Stripe-hosted session link. */
+    checkout_url?: string;
+    /** Public account or cancellation page. Visited on every scan, even without a test account, so offline-only cancellation instructions are seen. null clears it. */
+    account_url?: string | null;
+    /** Terms of service page. Checkbox reads it on every scan (rendering JavaScript, so single-page apps work) and checks its renewal and cancellation terms. null clears it. */
+    terms_url?: string | null;
+    /** Steps to reach the final pre-payment screen. */
+    checkout_steps?: Array<ScanStep>;
+    purchase?: SitePurchase;
+    test_account?: SiteTestAccount;
+    /** Explicit cancellation steps (otherwise auto-discovered). */
+    cancel_steps?: Array<ScanStep>;
+    /** States the synthetic shopper visits from. */
+    regions?: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Devices to emulate. */
+    devices?: Array<"desktop" | "mobile">;
+    /** Scheduled re-scan interval (0 = off, minimum 60). Default 1440 in live mode, 0 in test mode. */
+    monitoring_interval_minutes?: number;
+}
+export interface UpdateSiteParams {
+    /** Display name. */
+    name?: string;
+    /** Base URL of the business website. */
+    url?: string;
+    /** Billing platform. */
+    platform?: "stripe" | "shopify" | "recharge" | "chargebee" | "recurly" | "paddle" | "woocommerce" | "custom";
+    /** Jurisdictions to evaluate (empty = all US laws). */
+    jurisdictions?: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    facts?: SiteFacts;
+    /** Page with the subscribe button (defaults to url). Not a Stripe-hosted session link. */
+    checkout_url?: string;
+    /** Public account or cancellation page. Visited on every scan, even without a test account, so offline-only cancellation instructions are seen. null clears it. */
+    account_url?: string | null;
+    /** Terms of service page. Checkbox reads it on every scan (rendering JavaScript, so single-page apps work) and checks its renewal and cancellation terms. null clears it. */
+    terms_url?: string | null;
+    /** Steps to reach the final pre-payment screen. */
+    checkout_steps?: Array<ScanStep>;
+    purchase?: SitePurchase;
+    test_account?: SiteTestAccount;
+    /** Explicit cancellation steps (otherwise auto-discovered). */
+    cancel_steps?: Array<ScanStep>;
+    /** States the synthetic shopper visits from. */
+    regions?: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Devices to emulate. */
+    devices?: Array<"desktop" | "mobile">;
+    /** Scheduled re-scan interval (0 = off, minimum 60). Default 1440 in live mode, 0 in test mode. */
+    monitoring_interval_minutes?: number;
+}
+/** A billing-platform connection of a site. */
+export interface Integration {
+    /** String representing the object's type. Always "integration". */
+    object: "integration";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** Billing platform. */
+    platform: string;
+    /** connected or error. */
+    status: string;
+    /** When the platform settings were last read. Unix timestamp in seconds. */
+    last_synced: number | null;
+    /** A problem worth fixing, e.g. a test-mode key on a live site. */
+    warning: string | null;
+}
+export interface ConnectBillingPlatformParams {
+    /** Billing platform. */
+    platform: "stripe" | "recharge" | "shopify";
+    /** Read-only credentials. Stripe: { "secretKey": "rk_test_…" } (a restricted key with read access; rk_test_ in test mode). Recharge: { "apiToken": "…" }. Shopify: { "shop": "store.myshopify.com", "accessToken": "shpat_…" }. */
+    credentials: Record<string, string>;
+}
+/** A page of scans, newest first. */
+export interface ScanList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Scans, newest first. */
+    data: Array<Scan>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** One check of an evaluation. */
+export interface CheckSummary {
+    /** Check id. */
+    check_id: string;
+    /** Title. */
+    title: string;
+    /** Result. */
+    status: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Severity. */
+    severity: "critical" | "high" | "medium" | "low";
+    /** Lifecycle stage. */
+    stage: "signup" | "confirmation" | "reminder" | "cancellation" | "config";
+}
+/** A compliance verdict for a site at a point in time. */
+export interface Evaluation {
+    /** Unique identifier of the evaluation (eval_…). */
+    id: string;
+    /** String representing the object's type. Always "evaluation". */
+    object: "evaluation";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The evaluated site. */
+    site: string;
+    /** The scan row this evaluation belongs to. */
+    scan: string;
+    /** Compliance score 0-100 (severity-weighted, one decimal place, e.g. 82.5). */
+    score: number;
+    /** No critical/high check failing, no critical check undecided, no high check without evidence. */
+    insurable: boolean;
+    /** Legal catalog / rules version used. */
+    rules_version: string;
+    /** When it was evaluated. Unix timestamp in seconds. */
+    evaluated: number;
+    /** Newest synthetic-shopper observation it used. Unix timestamp in seconds. */
+    observed: number | null;
+    /** Counts per status. */
+    summary: {
+        /** Passing checks. */
+        pass: number;
+        /** Failing checks. */
+        fail: number;
+        /** Checks needing a human look. */
+        needs_review: number;
+        /** Checks that do not apply. */
+        not_applicable: number;
+    };
+    /** Checks that keep the site from being insurable. */
+    blockers: Array<CheckSummary>;
+    /** Every check evaluated. */
+    checks: Array<CheckSummary>;
+}
+/** A page of evaluations, newest first. */
+export interface EvaluationList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Evaluations, newest first. */
+    data: Array<Evaluation>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A legal requirement a finding checks. */
+export interface RequirementRef {
+    /** Requirement id in the legal catalog. */
+    id: string;
+    /** Jurisdiction of the law. */
+    jurisdiction: "US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY";
+    /** Legal citation. */
+    citation: string;
+    /** What the law requires, in short. */
+    title: string;
+    /** Official source of the text. */
+    source_url: string;
+}
+/** How to fix the finding (see also the fixes resource and compliance plans). */
+export type Remediation = {
+    /** What to change. */
+    summary: string;
+    /** Steps to fix it. */
+    steps: Array<string>;
+    /** Platform the steps are written for. */
+    platform: string | null;
+    /** Suggested disclosure text. */
+    suggested_copy: string | null;
+    /** Code snippet, when there is one. */
+    snippet: {
+        /** Language of the code. */
+        language: string;
+        /** Code to apply. */
+        code: string;
+    } | null;
+} | null;
+/** The latest result of one legal check for a site. */
+export interface Finding {
+    /** Unique identifier of the finding (fnd_…). */
+    id: string;
+    /** String representing the object's type. Always "finding". */
+    object: "finding";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** Stable id of the legal check. */
+    check_id: string;
+    /** Short title. */
+    title: string;
+    /** What was observed. */
+    detail: string;
+    /** Lifecycle stage. */
+    stage: "signup" | "confirmation" | "reminder" | "cancellation" | "config";
+    /** Strictest severity among the applicable requirements. */
+    severity: "critical" | "high" | "medium" | "low";
+    /** Latest check result. */
+    status: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Triage state. */
+    state: "open" | "acknowledged" | "resolved" | "accepted_risk";
+    /** Triage note. */
+    note: string | null;
+    /** Jurisdictions whose laws this check applies. */
+    jurisdictions: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** The legal requirements behind the check, with citations. */
+    requirements: Array<RequirementRef>;
+    remediation: Remediation;
+    /** Confidence 0-1 of the check result. */
+    confidence: number;
+    /** Ids of the captures / emails / evidence records supporting the result. */
+    evidence_refs: Array<string>;
+    /** Check-specific details (failing regions/devices/URLs, measurements, quotes). */
+    details: Record<string, unknown>;
+    /** Scan that produced the latest result. */
+    scan: string | null;
+    /** First time the check was evaluated. Unix timestamp in seconds. */
+    first_seen: number;
+    /** Latest evaluation. Unix timestamp in seconds. */
+    last_seen: number;
+    /** When it was resolved. Unix timestamp in seconds. */
+    resolved_at: number | null;
+}
+/** A page of findings, most urgent first. */
+export interface FindingList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Findings, most urgent first. */
+    data: Array<Finding>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** One legal requirement behind a task. */
+export interface PlanCitation {
+    /** Requirement id in the legal catalog. */
+    id: string;
+    /** Jurisdiction. */
+    jurisdiction: string;
+    /** Legal citation. */
+    citation: string;
+    /** Official source. */
+    source_url: string;
+}
+/** A machine-applicable edit of the merchant's source, anchored to an element Checkbox observed. */
+export interface PlanEdit {
+    /** Edit operation for `checkbox fix --file` (or your own editor). */
+    op: "insert_before" | "insert_after" | "remove_attribute" | "replace_text" | "append";
+    /** The element the edit is anchored to. */
+    target: {
+        /** CSS selector observed on the rendered page (ids are the most stable anchor). */
+        selector: string | null;
+        /** Visible text of the anchor element. */
+        text: string | null;
+        /** HTML tag of the anchor element. */
+        tag: string | null;
+    };
+    /** Markup / text to insert or the replacement text. */
+    content: string | null;
+    /** For remove_attribute: the attribute to remove. */
+    attribute: string | null;
+}
+/** What the caller (usually an AI coding agent) should do next. */
+export interface PlanNextAction {
+    /** Stable action type: apply_task, provide_facts, verify_task, answer_question, ask_human_to_confirm, connect_billing_in_dashboard, wait_for_verification, run_first_check, review_wont_fix, done. */
+    type: string;
+    /** One or two sentences telling the agent exactly what to do now. */
+    description: string;
+    /** The task the action is about, when there is one. */
+    task: string | null;
+    /** operationId of the API call to make (also the SDK method name). */
+    operation_id: string | null;
+    /** The MCP tool that performs operation_id (`call_api` when there is no dedicated tool). */
+    mcp_tool?: string | null;
+    /** HTTP method and path of that call. */
+    endpoint: string | null;
+    /** Equivalent CLI command. */
+    command: string | null;
+}
+/** One ordered compliance task: the requirement, where to change, the exact change and how to verify it. */
+export interface Task {
+    /** Unique identifier of the task (task_…). */
+    id: string;
+    /** String representing the object's type. Always "task". */
+    object: "task";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** Stable key of the task within the site (the id is derived from site + key). */
+    key: string;
+    /** Short imperative title. */
+    title: string;
+    /** open (apply the change), in_progress (an agent claimed it), verifying (a verification is waiting for a confirming observation), done, wont_fix (the merchant declined, with a reason), manual (needs a human answer: see question). */
+    status: "open" | "in_progress" | "verifying" | "done" | "wont_fix" | "manual";
+    /** Strictest severity among the task's legal checks. */
+    priority: "critical" | "high" | "medium" | "low";
+    /** Position in the plan (1 = do first). Dependency-aware. */
+    order: number;
+    /** Legal checks this task makes pass. */
+    check_ids: Array<string>;
+    /** Open findings the task resolves. */
+    findings: Array<string>;
+    /** The legal requirement. */
+    requirement: {
+        /** Jurisdictions whose laws require it. */
+        jurisdictions: Array<string>;
+        /** Main citations, joined. */
+        citation: string;
+        /** Every requirement behind the task. */
+        citations: Array<PlanCitation>;
+        /** What the law requires, in one or two sentences. */
+        plain_language: string;
+    };
+    /** What Checkbox observed (why this task exists). */
+    why: string;
+    /** Where to make the change. */
+    where: {
+        /** Where the change is made. */
+        kind: "code" | "stripe_setting" | "email_template" | "policy_page" | "dns" | "checkbox_setting" | "billing_platform";
+        /** Likely source file (reported by `checkbox init` / updateSetupSession, else a framework convention). */
+        file_hint: string | null;
+        /** Page (or settings page) where the problem was observed / the change is made. */
+        url: string | null;
+        /** CSS selector of the element to change, as observed on the rendered page. */
+        selector: string | null;
+        /** Stripe object / setting to change (stripe_setting tasks). */
+        stripe_object: string | null;
+    };
+    /** The exact change. */
+    change: {
+        /** patch (code edit; content is a unified-diff template), copy (exact text), stripe_params (JSON to merge into a Stripe API call), config (a setting: content is the request body of operation_id), needs_facts (Checkbox needs facts before it can write exact copy: content is the body of operation_id to send them; never a patch with placeholders), manual (a human does it). */
+        type: "patch" | "copy" | "stripe_params" | "config" | "needs_facts" | "manual";
+        /** The change itself: unified-diff template, exact copy, or JSON params. Generated from the merchant's real terms and verified against the rules engine where possible. */
+        content: string;
+        /** Language of content (html, json, text, markdown, liquid, bash). */
+        language: string | null;
+        /** How to apply it and what must stay true. */
+        explanation: string;
+        /** Machine-applicable edits (`checkbox fix <task> --file <path>` turns them into an exact diff of your file). */
+        edits: Array<PlanEdit>;
+        /** The generated text was run through the rules engine on a model of the changed page and passes. */
+        engine_verified: boolean;
+        /** config / needs_facts: the API operation to send content to (its request body, validated against that operation). */
+        operation_id: string | null;
+        /** HTTP method and path of operation_id. */
+        endpoint: string | null;
+    };
+    /** How to verify the task. */
+    verify: {
+        /** How Checkbox re-checks it. */
+        method: "page_fetch" | "policy_refetch" | "stripe_params" | "email_copy" | "platform_sync" | "attestation" | "evaluation" | "test_run";
+        /** What to call after applying the change. */
+        how: string;
+        /** What Checkbox must observe for the task to be done. */
+        expected: string;
+    };
+    /** What Checkbox needs before it can give the exact change (observation: it has not seen the page / email yet; facts: plan, price, cancel URL or merchant name). The title stays the same either way. */
+    blocked_on: string | null;
+    /** Done / declined tasks: verified (its checks pass), no_longer_applicable (its checks no longer apply, e.g. the data source changed), superseded, declined. */
+    closed_reason: "verified" | "no_longer_applicable" | "superseded" | "declined" | null;
+    /** Tasks to finish first (their result changes this task's content). */
+    depends_on: Array<string>;
+    /** Unfinished tasks among depends_on. */
+    blocked_by: Array<string>;
+    /** For manual tasks: the human question; answer with answerTask. */
+    question: {
+        /** The question for the human (manual tasks only). */
+        text: string;
+        /** Accepted answers. */
+        options: Array<string>;
+        /** Why a machine cannot answer it. */
+        why: string;
+        /** What the answer changes. */
+        effect: string;
+    } | null;
+    /** The recorded answer of a manual task. */
+    answer: {
+        /** The recorded answer. */
+        value: string;
+        /** Note given with the answer. */
+        note: string | null;
+        /** When it was answered. Unix timestamp in seconds. */
+        answered: number;
+        /** A person confirmed the answer while signed in to Checkbox (dashboard or the emailed link). Attestations ("yes", "confirmed") count only then; an API key alone cannot attest. */
+        confirmed_by_human: boolean;
+        /** Answer recorded by an agent and waiting for the human: the link they open to confirm it. */
+        pending_confirmation_url: string | null;
+    } | null;
+    /** A decision recorded with updateTask. */
+    decision: {
+        /** Decision. */
+        status: "in_progress" | "wont_fix";
+        /** Reason given. */
+        reason: string | null;
+    } | null;
+    /** The newest verification of the task (retrieveVerification for the details). */
+    last_verification: {
+        /** Unique identifier of the verification (ver_…). */
+        id: string;
+        /** Result. */
+        status: "pending" | "passed" | "failed";
+        /** When it was requested. Unix timestamp in seconds. */
+        created: number;
+    } | null;
+    next_action: PlanNextAction;
+    /** When the task first appeared. Unix timestamp in seconds. */
+    first_seen: number;
+    /** When it was done. Unix timestamp in seconds. */
+    done_at: number | null;
+}
+/** The ordered, machine-readable list of changes that makes a site compliant, recomputed from its latest evaluation. */
+export interface CompliancePlan {
+    /** Unique identifier of the compliance plan (plan_…). */
+    id: string;
+    /** String representing the object's type. Always "compliance_plan". */
+    object: "compliance_plan";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** action_required (an agent can apply open tasks now), verifying (changes applied; waiting for confirming observations), compliant (every applicable check Checkbox could observe passes — an automated assessment, not a legal determination; see coverage for what was not observed), blocked (only human answers or declined critical tasks remain). */
+    status: "action_required" | "verifying" | "compliant" | "blocked";
+    /** Compliance score 0-100 of the latest evaluation. */
+    score: number | null;
+    /** Preview flag the planned Checkbox Warranty will key on (no checks failing at high severity). No warranty or insurance is offered yet; this is not an underwriting decision. */
+    insurable: boolean | null;
+    /** The evaluation the plan was built from (null before the first check). */
+    evaluation: string | null;
+    /** When that evaluation ran. Unix timestamp in seconds. */
+    evaluated: number | null;
+    /** Two or three sentences for an LLM: where the site stands and what comes next. */
+    summary: string;
+    /** Tasks per status. */
+    counts: {
+        /** Open tasks. */
+        open: number;
+        /** Claimed tasks. */
+        in_progress: number;
+        /** Tasks waiting for a confirming observation. */
+        verifying: number;
+        /** Tasks waiting for a human answer. */
+        manual: number;
+        /** Done tasks. */
+        done: number;
+        /** Declined tasks. */
+        wont_fix: number;
+    };
+    /** Tasks in the order to do them (done tasks last). */
+    tasks: Array<Task>;
+    /** What the assessment rests on. Tell the human about not_observed and attested items; never call the site "compliant" without them. */
+    coverage: {
+        /** Lifecycle stages Checkbox observed (signup, acknowledgment_email, reminders, cancellation, policies, billing_settings). */
+        observed: Array<string>;
+        /** Stages Checkbox has no observation of: their checks cannot fail, so passing says nothing about them. */
+        not_observed: Array<string>;
+        /** Task keys resting on a human confirmation instead of an observation. */
+        attested: Array<string>;
+        /** A billing platform is connected (dashboard). */
+        billing_connected: boolean;
+    };
+    next_action: PlanNextAction;
+    /** Rules / catalog version of the evaluation. */
+    rules_version: string | null;
+    /** Automated assessment; not legal advice. */
+    disclaimer: string;
+    /** When the plan was computed. Unix timestamp in seconds. */
+    generated: number;
+}
+export interface UpdateTaskParams {
+    /** in_progress claims the task (other agents see it), wont_fix declines it (needs reason; a declined critical/high task keeps the plan from being compliant), not_applicable records that the task does not apply to this business (needs reason, e.g. "no price changes are planned"; the task closes as no_longer_applicable and does not block the plan), open clears any of them. */
+    status: "open" | "in_progress" | "wont_fix" | "not_applicable";
+    /** Why (required for wont_fix). */
+    reason?: string;
+}
+export interface AnswerTaskParams {
+    /** One of the task's question.options (yes / no, or confirmed / needs_change). */
+    answer: string;
+    /** Context from the human (stored with the attestation). */
+    note?: string;
+}
+/** Expected vs observed for one check. */
+export interface VerificationCheck {
+    /** Check id. */
+    check_id: string;
+    /** Status the task needs. */
+    expected: string;
+    /** Status observed (pass, fail, needs_review, not_applicable, unknown). */
+    observed: string;
+    /** Where the observation comes from: evaluation, static_fetch, html, stripe_params, email, policy_fetch. */
+    source: string;
+    /** What was observed. */
+    detail: string;
+}
+/** A re-check of one task (or the whole site) after the agent applied changes. */
+export interface Verification {
+    /** Unique identifier of the verification (ver_…). */
+    id: string;
+    /** String representing the object's type. Always "verification". */
+    object: "verification";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** The task verified (null for a whole-site verification). */
+    task: string | null;
+    /** One task or the whole site. */
+    scope: "task" | "site";
+    /** pending (waiting for the confirming scan / re-evaluation), passed (Checkbox observed the expected result), failed (it did not: see diff). */
+    status: "pending" | "passed" | "failed";
+    /** How it was re-checked. */
+    method: "page_fetch" | "policy_refetch" | "stripe_params" | "email_copy" | "platform_sync" | "attestation" | "evaluation" | "test_run";
+    /** The fast pre-check run immediately (seconds). A failing pre-check fails the verification at once. */
+    precheck: {
+        /** static_fetch, html, stripe_params, email or policy_fetch. */
+        source: string;
+        /** Pre-check verdict for the task's checks. */
+        verdict: "pass" | "fail" | "needs_review";
+        /** What was fetched. */
+        url: string | null;
+        /** What the pre-check can and cannot confirm. */
+        note: string;
+    } | null;
+    /** Confirming scan queued by the verification. */
+    scan: string | null;
+    /** Expected vs observed per check. */
+    checks: Array<VerificationCheck>;
+    /** Only the checks whose observation differs from the expectation. */
+    diff: Array<VerificationCheck>;
+    /** Plan status after this verification (null while pending). */
+    plan_status: "action_required" | "verifying" | "compliant" | "blocked" | null;
+    next_action: PlanNextAction;
+    /** When it was requested. Unix timestamp in seconds. */
+    created: number;
+    /** When it resolved. Unix timestamp in seconds. */
+    completed: number | null;
+    /** A pending verification fails (timed_out) after this. Unix timestamp in seconds. */
+    expires: number;
+}
+export interface VerifyTaskParams {
+    /** page_fetch tasks: the rendered page HTML before you deploy, at most ~900 KB (request bodies are limited to 1 MB). Pre-check only; the confirming scan runs on the live page. */
+    html?: string;
+    /** stripe_params tasks: exactly what your code now passes to stripe.checkout.sessions.create. */
+    stripe_checkout_session?: Record<string, unknown>;
+    /** email_copy tasks: the new email template (pre-check; the real email confirms). */
+    email?: {
+        /** Email kind (default: from the task). */
+        kind?: "acknowledgment" | "trial_reminder" | "renewal_reminder" | "price_change" | "annual_terms" | "charge_notice" | "cancellation_confirmation";
+        /** Subject. */
+        subject: string;
+        /** Plain-text body. */
+        text?: string;
+        /** HTML body. */
+        html?: string;
+    };
+    /** Re-check a task that is already done (or declined) instead of returning its last result: Checkbox evaluates the site again now and queues a confirming scan, so a regression shows up (pilot: a cancel page switched to phone-only stayed "passed"). */
+    recheck?: boolean;
+}
+/** A page of verifications, newest first. */
+export interface VerificationList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Verifications, newest first. */
+    data: Array<Verification>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A concrete change to apply. */
+export interface FixArtifact {
+    /** Artifact id. */
+    id: string;
+    /** Title. */
+    title: string;
+    /** Kind of change. */
+    kind: "code" | "markup" | "liquid" | "script";
+    /** Language. */
+    language: string;
+    /** Suggested file. */
+    filename: string | null;
+    /** The code / markup to apply. */
+    code: string;
+    /** Unified-diff view of the change. */
+    diff: string | null;
+}
+/** An engine-verified, platform-specific fix. */
+export interface Fix {
+    /** Unique identifier of the fix (fix_…). */
+    id: string;
+    /** String representing the object's type. Always "fix". */
+    object: "fix";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** Finding this fix addresses (null for site-level fix plans). */
+    finding: string | null;
+    /** Area of the fix. */
+    group: "signup" | "cancellation" | "other";
+    /** stripe_checkout, stripe_payment_link, shopify, html or hosted_cancellation. */
+    kind: string | null;
+    /** Title. */
+    title: string;
+    /** What the fix does. */
+    summary: string;
+    /** Checks it addresses. */
+    check_ids: Array<string>;
+    /** Steps. */
+    steps: Array<string>;
+    /** Code / markup to apply. */
+    artifacts: Array<FixArtifact>;
+    /** Verified disclosure texts (snake_case keys). */
+    texts: Record<string, unknown> | null;
+    /** One-click option available in the dashboard, when there is one. */
+    one_click: Record<string, unknown> | null;
+    /** How the engine verified the fixed texts pass the checks. */
+    verification: Record<string, unknown> | null;
+    /** Why parts of the fix could not be generated (e.g. plan terms unknown). */
+    problems: Array<string>;
+    remediation: Remediation;
+}
+/** A page of fix plans. */
+export interface FixList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Fix plans. */
+    data: Array<Fix>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A record in the tamper-evident evidence vault. */
+export interface Evidence {
+    /** Unique identifier of the evidence (ev_…). */
+    id: string;
+    /** String representing the object's type. Always "evidence". */
+    object: "evidence";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Site the evidence belongs to. */
+    site: string;
+    /** What was recorded. */
+    kind: "screenshot" | "html" | "page_capture" | "email_raw" | "platform_config" | "lifecycle_event" | "evaluation";
+    /** MIME type of the content. */
+    content_type: string;
+    /** Bytes. */
+    size: number;
+    /** SHA-256 of the content (hex). */
+    sha256: string;
+    /** Hash chaining this record to the previous one (tamper evidence). */
+    chain_hash: string;
+    /** Chain hash of the previous record. */
+    prev_chain_hash: string | null;
+    /** When it was stored. Unix timestamp in seconds. */
+    stored: number;
+    /** Capture metadata (URL, region, device, scan…). */
+    meta: Record<string, unknown>;
+    /** Download the raw content (downloadEvidenceContent, same auth). */
+    content_url: string;
+}
+/** A page of evidence records, newest first. */
+export interface EvidenceList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Evidence records, newest first. */
+    data: Array<Evidence>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** Result of re-hashing a site's evidence chain. */
+export interface EvidenceChainVerification {
+    /** String representing the object's type. Always "evidence_chain_verification". */
+    object: "evidence_chain_verification";
+    /** Verified site. */
+    site: string;
+    /** Every record re-hashed and the chain is intact. */
+    ok: boolean;
+    /** Records checked. */
+    checked: number;
+    /** Id of the first record that failed verification. */
+    broken_at: string | null;
+    /** Why verification failed. */
+    reason: string | null;
+    /** Current chain head hash. */
+    head: string | null;
+}
+/** A signed monitoring certificate: the site met every critical and high obligation for the required streak of days. It is not insurance. */
+export interface Certificate {
+    /** Unique identifier of the certificate (cert_…). */
+    id: string;
+    /** String representing the object's type. Always "certificate". */
+    object: "certificate";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Certified site. */
+    site: string;
+    /** active while monitoring keeps the site insurable; lapses automatically otherwise. */
+    status: "active" | "lapsed" | "revoked" | "superseded";
+    /** Verified domain frozen into the certificate. */
+    domain: string;
+    /** Issue time. Unix timestamp in seconds. */
+    issued: number;
+    /** Expiry (renewed automatically while compliant). Unix timestamp in seconds. */
+    valid_until: number;
+    /** Last renewal. Unix timestamp in seconds. */
+    renewed: number | null;
+    /** When it lapsed or was revoked. Unix timestamp in seconds. */
+    ended: number | null;
+    /** Public reason code shown on the verification page when it ended. */
+    public_reason: string | null;
+    /** Public verification page. */
+    verify_url: string;
+    /** Trust badge for the merchant site. */
+    badge: {
+        /** Badge image. */
+        svg_url: string;
+        /** Badge script. */
+        script_url: string;
+        /** HTML to embed the badge. */
+        embed_html: string;
+    };
+}
+/** A page of certificates, newest first. */
+export interface CertificateList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Certificates, newest first. */
+    data: Array<Certificate>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** Checkbox Notices for a site: the legally required emails Checkbox sends on the merchant's behalf. */
+export interface NoticeSettings {
+    /** Unique identifier of the notice settings (ntcs_…). */
+    id: string;
+    /** String representing the object's type. Always "notice_settings". */
+    object: "notice_settings";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** merchant ("You send", the default): you send the required emails and Checkbox tells you what and when (listDueNotices, notice.due), checks your templates and confirms each send. checkbox: Checkbox sends them for you (enabled_kinds). */
+    mode: "merchant" | "checkbox";
+    /** The site's inbound address. Copies to it confirm a notice only when your sending domain authenticates them (DKIM/SPF, a trusted sending domain) and they go to the subscriber; to confirm any copy, BCC each due notice's own bcc address instead (listDueNotices / the notice.due webhook). */
+    bcc: string;
+    /** mode checkbox: the notices Checkbox sends for the merchant. */
+    enabled_kinds: Array<"acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change">;
+    /** Brand shown in notices (defaults to the site name). */
+    brand_name: string | null;
+    /** Product name used in notices. */
+    product_name: string | null;
+    /** Logo URL (https). */
+    logo_url: string | null;
+    /** Reply-to / support address. */
+    support_email: string | null;
+    /** Where subscribers cancel online (site domain, hosted cancellation page or billing portal). */
+    cancel_url: string | null;
+    /** Hex brand colour. */
+    brand_color: string | null;
+    /** Mailbox name of the sender. */
+    from_local_part: string;
+    /** Confirmed cancellation policy (required before notices go out). */
+    policy: {
+        /** When a cancellation takes effect. */
+        cancel_timing: "period_end" | "immediately";
+        /** When the policy was confirmed. Unix timestamp in seconds. */
+        confirmed: number;
+    } | null;
+    /** Sending address, when one is available. */
+    sender: {
+        /** From header. */
+        from: string;
+        /** Sent from the merchant's verified domain. */
+        own_domain: boolean;
+    } | null;
+    /** Custom sending domain status (set it up in the dashboard). */
+    sending_domain: {
+        /** Custom sending domain. */
+        domain: string | null;
+        /** none, pending, verified or failed. */
+        status: string;
+    };
+    /** This Checkbox deployment can send email. */
+    delivery_configured: boolean;
+    /** Every notice kind. */
+    kinds: Array<{
+        /** Notice kind. */
+        kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change";
+        /** Label. */
+        label: string;
+        /** What it is and when it is sent. */
+        description: string;
+        /** Checkbox sends it. */
+        enabled: boolean;
+        /** Legal checks it satisfies. */
+        check_ids: Array<string>;
+    }>;
+    /** Last change. Unix timestamp in seconds. */
+    updated: number | null;
+    next_action: NextAction | null;
+}
+export interface UpdateNoticeSettingsParams {
+    /** merchant: you send the emails (Checkbox tracks them); checkbox: Checkbox sends them. Turning an enabled_kinds notice on implies checkbox. */
+    mode?: "merchant" | "checkbox";
+    /** Notices to send (turning one on needs cancel_url, a confirmed policy and a connected Stripe/Recharge account). trial_reminder is accepted as an alias of trial_ending. */
+    enabled_kinds?: Array<"acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change" | "trial_reminder">;
+    /** Brand name. */
+    brand_name?: string | null;
+    /** Product name. */
+    product_name?: string | null;
+    /** Logo URL (https). */
+    logo_url?: string | null;
+    /** Support address. */
+    support_email?: string | null;
+    /** Online cancellation URL. */
+    cancel_url?: string | null;
+    /** Hex colour. */
+    brand_color?: string | null;
+    /** Sender mailbox name. */
+    from_local_part?: string;
+    /** Cancellation policy the notices state. */
+    policy?: {
+        /** When a cancellation takes effect (must match your Terms). */
+        cancel_timing: "period_end" | "immediately";
+        /** Confirms this matches your Terms and your cancellation flow. */
+        confirm: true;
+    } | null;
+}
+/** Copy-ready email for this subscriber. It passes the preflight email check for its kind when every field is filled. */
+export interface RenderedNoticeEmail {
+    /** Checkbox template the email was rendered from (GET /v1/notices/templates). */
+    template_id: string;
+    /** Subject, merge fields filled. */
+    subject: string;
+    /** Plain-text body, merge fields filled. */
+    text: string;
+    /** HTML body, merge fields filled (values HTML-escaped). */
+    html: string;
+    /** Merge fields Checkbox could not fill (e.g. cancel_url until you set it); fill them before sending. */
+    missing_fields: Array<string>;
+}
+/** An email the merchant owes a subscriber, legally required (required: true) or recommended ("You send" mode): what, when, the copy-ready email and how to confirm it was sent. */
+export interface DueNotice {
+    /** Unique identifier of the due notice (ntd_…). */
+    id: string;
+    /** String representing the object's type. Always "due_notice". */
+    object: "due_notice";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** acknowledgment, trial_ending, renewal_reminder, annual_terms, price_change or cancellation_confirmation. */
+    kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change" | "cancellation_confirmation";
+    /** Human label of the kind. */
+    label: string;
+    /** true: a law in requirement_ids makes this email mandatory, and an overdue one fails the matching compliance check. false: Checkbox recommends it (cancellation confirmations: no statute sets a deadline), it never fails a check. */
+    required: boolean;
+    /** upcoming (not time to send yet), due (send it on send_date), sent, overdue (window closed without proof it was sent), canceled (no longer owed) or missed (you recorded that it was not sent). */
+    status: "upcoming" | "due" | "sent" | "overdue" | "canceled" | "missed";
+    /** Who the notice is for. */
+    subscriber: {
+        /** Billing platform. */
+        platform: string;
+        /** The subscription id on the billing platform. */
+        subscription: string;
+        /** The customer id on the billing platform. */
+        customer: string | null;
+        /** The customer's name on the billing platform, when known. */
+        name: string | null;
+        /** Masked recipient (Checkbox never returns the address; look it up by customer). */
+        email_masked: string | null;
+        /** US state of the subscriber's billing address, when the billing platform shares it. The billing address is a proxy for where the subscriber lives: when one send can satisfy every state the site sells in, the window covers them all; otherwise it is this state's. null = every state the site sells in. */
+        region: string | null;
+    };
+    /** Earliest moment the notice satisfies the law (send no earlier). Equal to window_end for an "exactly N days before" rule: send on that day. Unix timestamp in seconds. */
+    window_start: number;
+    /** Latest moment the notice satisfies the law (send no later). Unix timestamp in seconds. */
+    window_end: number;
+    /** Recommended send time, inside the window (away from its edges). notice.due is delivered at this time. Unix timestamp in seconds. */
+    send_at: number;
+    /** Recommended send date (YYYY-MM-DD, UTC). */
+    send_date: string;
+    /** The event the notice announces: sign-up, trial end, renewal, new price or cancellation. Unix timestamp in seconds. */
+    anchor: number;
+    /** Jurisdictions whose rules set this window. */
+    jurisdictions: Array<string>;
+    /** Catalog requirements that make the notice mandatory. */
+    requirement_ids: Array<string>;
+    /** Citations of those requirements. */
+    citations: Array<string>;
+    email: RenderedNoticeEmail;
+    /** This notice's own BCC address (it carries a secret token: do not publish it). BCC it when you send the email: Checkbox marks this notice sent with the copy as evidence. A copy that arrives before window_start does not count. */
+    bcc: string;
+    /** Proof it was sent; null until then. */
+    sent: {
+        /** When it was sent. Unix timestamp in seconds. */
+        at: number;
+        /** How Checkbox learned it was sent: your API call, a matching BCC copy, or the dashboard. */
+        source: "api" | "bcc" | "dashboard";
+        /** Sent after the window closed (it does not satisfy the window). */
+        late: boolean;
+        /** Your email provider's message id, when given. */
+        provider_message_id: string | null;
+        /** Evidence record of the BCC copy (ev_…), when matched by BCC. */
+        evidence: string | null;
+    } | null;
+    /** Set when you recorded an overdue notice as not sent (markNoticeMissed); null otherwise. */
+    missed: {
+        /** When you recorded it as missed. Unix timestamp in seconds. */
+        at: number;
+        /** Your note, when given. */
+        reason: string | null;
+    } | null;
+    /** When Checkbox first computed the notice. Unix timestamp in seconds. */
+    created: number;
+    /** Last change. Unix timestamp in seconds. */
+    updated: number;
+    next_action: NextAction | null;
+}
+/** A page of due notices, soonest send date first. */
+export interface DueNoticeList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Due notices, soonest send date first. */
+    data: Array<DueNotice>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A copy-ready email template for a required notice. Filled with representative values it passes the preflight email check for its kind in every jurisdiction. */
+export interface NoticeTemplate {
+    /** Template id (`<variant>.v1`); due notices name the one they were rendered from. */
+    id: string;
+    /** Notice kind. */
+    kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change" | "cancellation_confirmation";
+    /** Variant within the kind (acknowledgment vs acknowledgment_trial, cancellation_confirmation vs _immediate). */
+    variant: string;
+    /** Human label. */
+    label: string;
+    /** When this kind is sent. */
+    when: string;
+    /** When this variant applies. */
+    use_when: string;
+    /** Subject with {{merge_fields}}. */
+    subject: string;
+    /** Plain-text body with {{merge_fields}}. */
+    text: string;
+    /** HTML body with {{merge_fields}} (escape values when you fill them). */
+    html: string;
+    /** Merge fields the template uses. */
+    merge_fields: Array<string>;
+    /** The kind to pass to checkEmail (/v1/checks/email) for this template. */
+    check_kind: string;
+    /** BCC address for this kind (when ?site= is given). */
+    bcc?: string;
+}
+/** Copy-ready templates for every required notice. */
+export interface NoticeTemplateList {
+    /** Always "list". */
+    object: "list";
+    /** Every template. */
+    data: Array<NoticeTemplate>;
+    /** Every merge field a template may use. */
+    merge_fields: Array<{
+        /** Field name. */
+        name: string;
+        /** What it holds. */
+        description: string;
+    }>;
+    /** Always false. */
+    has_more: boolean;
+    /** URL of this list. */
+    url: string;
+}
+/** Result of checking a merchant's own notice template. */
+export interface NoticeTemplateCheck {
+    /** Always "notice_template_check". */
+    object: "notice_template_check";
+    /** Notice kind checked. */
+    kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change" | "cancellation_confirmation";
+    /** pass, fail or needs_review. */
+    verdict: string;
+    /** Verdict per engine check. */
+    checks: Array<{
+        /** Engine check. */
+        check_id: string;
+        /** pass, fail, needs_review or not_applicable. */
+        status: string;
+        /** Why. */
+        explanation: string;
+    }>;
+    /** Merge fields Checkbox does not know (left unfilled). */
+    unknown_fields: Array<string>;
+    /** Input warnings. */
+    warnings: Array<{
+        /** Code. */
+        code: string;
+        /** Message. */
+        message: string;
+    }>;
+    /** The email as checked (merge fields filled with the site's plan and sample dates). */
+    filled: {
+        /** Subject as checked. */
+        subject: string;
+        /** Text as checked. */
+        text: string;
+        /** HTML as checked. */
+        html?: string;
+    };
+    next_action: NextAction;
+}
+/** Your template for one notice kind (text, html or both). */
+export interface CheckNoticeTemplateParams {
+    /** Site whose plan, brand, cancel URL and jurisdictions fill the merge fields and scope the check. */
+    site: string;
+    /** Which notice the template is for. */
+    kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change" | "cancellation_confirmation";
+    /** Your subject (merge fields allowed). */
+    subject: string;
+    /** Your plain-text body (merge fields allowed). */
+    text?: string;
+    /** Your HTML body (merge fields allowed). */
+    html?: string;
+}
+export interface MarkNoticeSentParams {
+    /** Your email provider's message id (Resend / Postmark / SES), stored as proof. */
+    provider_message_id?: string;
+    /** When it was sent (unix seconds). Default: now. A time after the window closed records the notice as sent late; a time before window_start is refused (too early to count), and so is a time before an overdue notice became overdue. */
+    sent_at?: number;
+}
+export interface MarkNoticeMissedParams {
+    /** Why it was not sent (kept with the record). */
+    reason?: string;
+}
+/** One changed requirement. */
+export interface LawChange {
+    /** Requirement id in the legal catalog. */
+    requirement_id: string;
+    /** added, removed, modified, effective or sunset. */
+    change: string;
+    /** Jurisdiction. */
+    jurisdiction: "US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY";
+    /** Legal citation. */
+    citation: string;
+    /** Requirement title. */
+    title: string;
+    /** Plain-English summary. */
+    summary: string | null;
+    /** Effective date (YYYY-MM-DD). */
+    effective_date: string | null;
+    /** Sunset date (YYYY-MM-DD). */
+    sunset_date: string | null;
+    /** Official source. */
+    source_url: string | null;
+}
+/** How a law change affected one site. */
+export interface LawSiteImpact {
+    /** Affected site. */
+    site: string;
+    /** What changed for the site. */
+    summary: string;
+    /** Score before the change (0-100, one decimal place). */
+    score_before: number | null;
+    /** Score after re-evaluation (0-100, one decimal place). */
+    score_after: number | null;
+    /** Checks whose result changed or that the change touches. */
+    affected_checks: Array<{
+        /** Check id. */
+        check_id: string;
+        /** Title. */
+        title: string;
+        /** Severity. */
+        severity: "critical" | "high" | "medium" | "low";
+        /** Status before. */
+        before: "pass" | "fail" | "needs_review" | "not_applicable" | null;
+        /** Status after. */
+        after: "pass" | "fail" | "needs_review" | "not_applicable" | null;
+    }>;
+    /** When the site was re-evaluated. Unix timestamp in seconds. */
+    evaluated: number;
+}
+/** A change in the law Checkbox applies, and its effect on your sites. */
+export interface LawUpdate {
+    /** Unique identifier of the law update (law_…). */
+    id: string;
+    /** String representing the object's type. Always "law_update". */
+    object: "law_update";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** catalog_change: Checkbox updated the legal catalog; effective / sunset: a dated rule started or ended. */
+    source: "catalog_change" | "effective" | "sunset";
+    /** Date of the change (YYYY-MM-DD). */
+    date: string;
+    /** What changed. */
+    summary: string;
+    /** Jurisdictions changed. */
+    jurisdictions: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Changed requirements. */
+    changes: Array<LawChange>;
+    /** Effects on this account's sites (in this mode). */
+    impacts: Array<LawSiteImpact>;
+    /** When Checkbox recorded the change. Unix timestamp in seconds. */
+    created: number;
+}
+/** A page of law updates, newest first. */
+export interface LawUpdateList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Law updates, newest first. */
+    data: Array<LawUpdate>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A legal requirement a check enforces. */
+export interface CheckRequirementRef {
+    /** Requirement id in the legal catalog. */
+    id: string;
+    /** Jurisdiction. */
+    jurisdiction: "US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY";
+    /** Legal citation. */
+    citation: string;
+    /** Requirement title. */
+    title: string;
+    /** Official source. */
+    source_url: string;
+}
+/** One engine check and its verdict. */
+export interface CheckVerdict {
+    /** Stable id of the check. */
+    check_id: string;
+    /** pass, fail, needs_review (a human or more data must decide) or not_applicable. */
+    status: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Severity. */
+    severity: "critical" | "high" | "medium" | "low";
+    /** What the check requires. */
+    title: string;
+    /** What the engine observed. */
+    explanation: string;
+    /** Confidence 0..1. */
+    confidence: number;
+    /** Requirements this check enforces under the requested jurisdictions. */
+    requirements: Array<CheckRequirementRef>;
+    /** How to fix a failing / unclear check. */
+    fix?: string;
+    /** Page checks on static HTML: the engine status on the estimated layout. */
+    static_estimate?: "pass" | "fail" | "needs_review" | "not_applicable";
+}
+/** Verdict per legal requirement. */
+export type CheckRequirementVerdict = CheckRequirementRef & {
+    /** Worst status among the requirement’s checks. */
+    status: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Checks that enforce it. */
+    check_ids: Array<string>;
+};
+/** A note about the input (never a compliance verdict). */
+export interface CheckWarning {
+    /** Stable warning code. */
+    code: string;
+    /** Explanation. */
+    message: string;
+    /** Related parameter. */
+    param?: string;
+}
+/** A compliant replacement, verified by the engine. */
+export interface CheckReplacement {
+    /** Compliant disclosure generated from the plan terms (locked wording). */
+    disclosure_text: string;
+    /** Label for the unchecked, required consent checkbox. */
+    consent_label: string;
+    /** Purchase button label that itself states the renewal. */
+    button_text: string;
+    /** Drop-in markup: disclosure (set off in a box) + unchecked required checkbox + button. */
+    html: string;
+    /** Placeholders left to fill (e.g. {{cancel_url}}). */
+    placeholders: Array<string>;
+    /** The engine passes every targeted sign-up check on a page using this replacement. */
+    verified: boolean;
+    /** Targeted checks that still do not pass with it (normally empty). */
+    remaining_checks: Array<string>;
+    /** sha256 of disclosure + consent label. */
+    sha256: string;
+}
+/** Verdict on a checkout disclosure plus a verified replacement. */
+export interface DisclosureCheckResult {
+    /** Id of this check run (chk_…). Checks are stateless and not stored. */
+    id: string;
+    /** String representing the object's type. Always "check_result". */
+    object: "check_result";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When the check ran. Unix timestamp in seconds. */
+    created: number;
+    /** Which check ran. */
+    kind: "disclosure" | "stripe_checkout_session" | "stripe_payment_link" | "email" | "page";
+    /** Overall: fail if any check fails, else needs_review if any needs review, else pass (not_applicable when nothing applies). */
+    verdict: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Counts by status. */
+    summary: {
+        /** Checks passing. */
+        pass: number;
+        /** Checks failing. */
+        fail: number;
+        /** Checks needing review. */
+        needs_review: number;
+        /** Checks not applicable. */
+        not_applicable: number;
+    };
+    /** Every evaluated check. */
+    checks: Array<CheckVerdict>;
+    /** Verdict per legal requirement (federal first, then by state). */
+    requirements: Array<CheckRequirementVerdict>;
+    /** Notes about the input. */
+    warnings: Array<CheckWarning>;
+    /** Jurisdictions evaluated. */
+    jurisdictions: "all" | Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Date the law was evaluated at. */
+    as_of: string;
+    /** Version of the check implementations. */
+    rules_version: string;
+    /** Version of the legal catalog. */
+    catalog_version: string;
+    /** sha256 of the canonical legal catalog. */
+    catalog_hash: string;
+    /** Not legal advice. */
+    disclaimer: string;
+    next_action: NextAction;
+    replacement: CheckReplacement;
+}
+/** A checkout disclosure to check before it ships. */
+export interface DisclosureCheckParams {
+    /** The disclosure shown next to the purchase button, exactly as rendered. */
+    text: string;
+    /** Brand shown to subscribers; used in generated text. */
+    merchant_name?: string;
+    /** Plan / product name. */
+    plan_name?: string;
+    /** Recurring price in major units (19.99). Or give `amount` in minor units. */
+    price?: number | string;
+    /** Recurring price in minor units (1999 = $19.99), Stripe style. */
+    amount?: number;
+    /** Three-letter ISO currency (default usd). */
+    currency?: string;
+    /** Billing interval: day, week, month or year (required). */
+    interval: string;
+    /** Number of intervals between charges (default 1). */
+    interval_count?: number;
+    /** Free-trial length in days (0 or absent = no trial). */
+    trial_days?: number;
+    /** https URL where subscribers cancel online (used in generated text; a {{cancel_url}} placeholder otherwise). */
+    cancel_url?: string;
+    /** When a cancellation takes effect (default period_end). */
+    cancel_timing?: "period_end" | "immediately";
+    /** Label of the purchase button (default "Subscribe", or "Start free trial" with a trial). */
+    button_text?: string;
+    /** Other text next to the button (order summary), if any. */
+    order_summary?: string;
+    /** Where you sell: "all" (default) or state codes ("US-CA", "CA", "US-NY"; "US-FED" is always included). */
+    jurisdictions?: "all" | Array<string>;
+    /** Where and how the disclosure is shown. */
+    placement?: {
+        /** The disclosure is shown before / above the purchase button (default true). */
+        above_button?: boolean;
+        /** The disclosure is on the same page as the payment form and button (default true). */
+        same_page_as_payment?: boolean;
+        /** Rendered font size of the disclosure (default 14). */
+        font_size_px?: number;
+        /** WCAG contrast ratio of the text against its background (default ≈14.7). */
+        contrast_ratio?: number;
+        /** The disclosure is bold / semibold. */
+        bold?: boolean;
+        /** The disclosure is set off in a bordered or shaded box. */
+        boxed?: boolean;
+        /** Font size of the surrounding body text (default 14). */
+        body_font_size_px?: number;
+    };
+    /** The consent checkbox, if any. Omitted = no checkbox. */
+    consent?: {
+        /** A checkbox the customer must tick to agree to the renewal terms. */
+        checkbox: boolean;
+        /** The checkbox is ticked by default. */
+        prechecked?: boolean;
+        /** The checkbox label (default "I agree to the automatic renewal terms above."). */
+        label?: string;
+        /** The form cannot be submitted without ticking it (default true). */
+        required?: boolean;
+    };
+    /** Evaluate the law as of this date (YYYY-MM-DD, default today). */
+    as_of?: string;
+}
+/** RFC 6902 operation. */
+export interface JsonPatchOperation {
+    /** JSON Patch operation. */
+    op: "add" | "replace" | "remove";
+    /** JSON Pointer into params. */
+    path: string;
+    /** Value to set. */
+    value?: unknown;
+}
+/** Verdict on Checkout Session params plus corrected params. */
+export interface StripeCheckoutSessionCheckResult {
+    /** Id of this check run (chk_…). Checks are stateless and not stored. */
+    id: string;
+    /** String representing the object's type. Always "check_result". */
+    object: "check_result";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When the check ran. Unix timestamp in seconds. */
+    created: number;
+    /** Which check ran. */
+    kind: "disclosure" | "stripe_checkout_session" | "stripe_payment_link" | "email" | "page";
+    /** Overall: fail if any check fails, else needs_review if any needs review, else pass (not_applicable when nothing applies). */
+    verdict: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Counts by status. */
+    summary: {
+        /** Checks passing. */
+        pass: number;
+        /** Checks failing. */
+        fail: number;
+        /** Checks needing review. */
+        needs_review: number;
+        /** Checks not applicable. */
+        not_applicable: number;
+    };
+    /** Every evaluated check. */
+    checks: Array<CheckVerdict>;
+    /** Verdict per legal requirement (federal first, then by state). */
+    requirements: Array<CheckRequirementVerdict>;
+    /** Notes about the input. */
+    warnings: Array<CheckWarning>;
+    /** Jurisdictions evaluated. */
+    jurisdictions: "all" | Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Date the law was evaluated at. */
+    as_of: string;
+    /** Version of the check implementations. */
+    rules_version: string;
+    /** Version of the legal catalog. */
+    catalog_version: string;
+    /** sha256 of the canonical legal catalog. */
+    catalog_hash: string;
+    /** Not legal advice. */
+    disclaimer: string;
+    next_action: NextAction;
+    /** The fix. */
+    correction: {
+        /** JSON Patch turning params into corrected_params (empty: nothing to change). */
+        patch: Array<JsonPatchOperation>;
+        /** The full params with the fix applied. */
+        corrected_params: Record<string, unknown>;
+        /** Engine verification of corrected_params. */
+        verification: {
+            /** Each check before and after the fix. */
+            checks: Array<{
+                /** Check id. */
+                check_id: string;
+                /** Status with params. */
+                before: string;
+                /** Status with corrected_params. */
+                after: string;
+            }>;
+            /** No check fails after the fix (conspicuousness on Stripe styling excepted). */
+            passes: boolean;
+            /** Checks still failing / unclear after the fix. */
+            remaining_checks: Array<string>;
+            /** What Stripe params cannot fix. */
+            note: string;
+        };
+        /** Placeholders left in the messages. */
+        placeholders: Array<string>;
+    };
+}
+/** What Stripe params do not say: merchant_name, cancel_url, and price / interval when line_items reference a Price id. */
+export interface CheckPlanTerms {
+    /** Brand shown to subscribers; used in generated text. */
+    merchant_name?: string;
+    /** Plan / product name. */
+    plan_name?: string;
+    /** Recurring price in major units (19.99). Or give `amount` in minor units. */
+    price?: number | string;
+    /** Recurring price in minor units (1999 = $19.99), Stripe style. */
+    amount?: number;
+    /** Three-letter ISO currency (default usd). */
+    currency?: string;
+    /** Billing interval: day, week, month or year. */
+    interval?: string;
+    /** Number of intervals between charges (default 1). */
+    interval_count?: number;
+    /** Free-trial length in days (0 or absent = no trial). */
+    trial_days?: number;
+    /** https URL where subscribers cancel online (used in generated text; a {{cancel_url}} placeholder otherwise). */
+    cancel_url?: string;
+    /** When a cancellation takes effect (default period_end). */
+    cancel_timing?: "period_end" | "immediately";
+}
+/** Stripe params to check before they ship. */
+export interface StripeCheckParams {
+    /** Exactly the object your code passes to Stripe (checkout.sessions.create / paymentLinks.create), or a retrieved Payment Link. */
+    params: Record<string, unknown>;
+    merchant?: CheckPlanTerms;
+    /** Where you sell: "all" (default) or state codes ("US-CA", "CA", "US-NY"; "US-FED" is always included). */
+    jurisdictions?: "all" | Array<string>;
+    /** Evaluate the law as of this date (YYYY-MM-DD, default today). */
+    as_of?: string;
+}
+/** Verdict on Payment Link params plus corrected params. */
+export interface StripePaymentLinkCheckResult {
+    /** Id of this check run (chk_…). Checks are stateless and not stored. */
+    id: string;
+    /** String representing the object's type. Always "check_result". */
+    object: "check_result";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When the check ran. Unix timestamp in seconds. */
+    created: number;
+    /** Which check ran. */
+    kind: "disclosure" | "stripe_checkout_session" | "stripe_payment_link" | "email" | "page";
+    /** Overall: fail if any check fails, else needs_review if any needs review, else pass (not_applicable when nothing applies). */
+    verdict: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Counts by status. */
+    summary: {
+        /** Checks passing. */
+        pass: number;
+        /** Checks failing. */
+        fail: number;
+        /** Checks needing review. */
+        needs_review: number;
+        /** Checks not applicable. */
+        not_applicable: number;
+    };
+    /** Every evaluated check. */
+    checks: Array<CheckVerdict>;
+    /** Verdict per legal requirement (federal first, then by state). */
+    requirements: Array<CheckRequirementVerdict>;
+    /** Notes about the input. */
+    warnings: Array<CheckWarning>;
+    /** Jurisdictions evaluated. */
+    jurisdictions: "all" | Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Date the law was evaluated at. */
+    as_of: string;
+    /** Version of the check implementations. */
+    rules_version: string;
+    /** Version of the legal catalog. */
+    catalog_version: string;
+    /** sha256 of the canonical legal catalog. */
+    catalog_hash: string;
+    /** Not legal advice. */
+    disclaimer: string;
+    next_action: NextAction;
+    /** The fix. */
+    correction: {
+        /** JSON Patch turning params into corrected_params (empty: nothing to change). */
+        patch: Array<JsonPatchOperation>;
+        /** The full params with the fix applied. */
+        corrected_params: Record<string, unknown>;
+        /** Engine verification of corrected_params. */
+        verification: {
+            /** Each check before and after the fix. */
+            checks: Array<{
+                /** Check id. */
+                check_id: string;
+                /** Status with params. */
+                before: string;
+                /** Status with corrected_params. */
+                after: string;
+            }>;
+            /** No check fails after the fix (conspicuousness on Stripe styling excepted). */
+            passes: boolean;
+            /** Checks still failing / unclear after the fix. */
+            remaining_checks: Array<string>;
+            /** What Stripe params cannot fix. */
+            note: string;
+        };
+        /** Placeholders left in the messages. */
+        placeholders: Array<string>;
+        /** For an existing link (params.id): params for stripe.paymentLinks.update (same URL). */
+        update_params?: Record<string, unknown>;
+        /** Stripe cannot add the consent checkbox to an existing link: create a new link with corrected_params. */
+        needs_new_link_for_consent: boolean;
+    };
+}
+/** Verdict on a lifecycle email plus a verified template. */
+export interface EmailCheckResult {
+    /** Id of this check run (chk_…). Checks are stateless and not stored. */
+    id: string;
+    /** String representing the object's type. Always "check_result". */
+    object: "check_result";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When the check ran. Unix timestamp in seconds. */
+    created: number;
+    /** Which check ran. */
+    kind: "disclosure" | "stripe_checkout_session" | "stripe_payment_link" | "email" | "page";
+    /** Overall: fail if any check fails, else needs_review if any needs review, else pass (not_applicable when nothing applies). */
+    verdict: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Counts by status. */
+    summary: {
+        /** Checks passing. */
+        pass: number;
+        /** Checks failing. */
+        fail: number;
+        /** Checks needing review. */
+        needs_review: number;
+        /** Checks not applicable. */
+        not_applicable: number;
+    };
+    /** Every evaluated check. */
+    checks: Array<CheckVerdict>;
+    /** Verdict per legal requirement (federal first, then by state). */
+    requirements: Array<CheckRequirementVerdict>;
+    /** Notes about the input. */
+    warnings: Array<CheckWarning>;
+    /** Jurisdictions evaluated. */
+    jurisdictions: "all" | Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Date the law was evaluated at. */
+    as_of: string;
+    /** Version of the check implementations. */
+    rules_version: string;
+    /** Version of the legal catalog. */
+    catalog_version: string;
+    /** sha256 of the canonical legal catalog. */
+    catalog_hash: string;
+    /** Not legal advice. */
+    disclaimer: string;
+    next_action: NextAction;
+    /** The email kind checked. */
+    email_kind: string;
+    /** Requirements that make this email mandatory for this plan (empty: not legally required). */
+    required_by: Array<string>;
+    /** A compliant template generated from the plan terms. */
+    template: {
+        /** Compliant subject. */
+        subject: string;
+        /** Compliant plain-text body. */
+        text: string;
+        /** The same body as HTML. */
+        html: string;
+        /** Per-subscriber merge tags your sender fills. */
+        merge_tags: Array<string>;
+        /** Values you have not given yet. */
+        placeholders: Array<string>;
+        /** The engine passes this kind’s checks on the template. */
+        verified: boolean;
+        /** Checks the template does not pass (normally empty). */
+        remaining_checks: Array<string>;
+    };
+}
+/** A lifecycle email to check before it is wired in. */
+export interface EmailCheckParams {
+    /** Which lifecycle email this is (the same names verifyTask, the plan and the X-Checkbox-Kind header use; trial_ending is an alias of trial_reminder, as in Notices). */
+    kind: "acknowledgment" | "trial_reminder" | "trial_ending" | "renewal_reminder" | "price_change" | "annual_terms" | "charge_notice" | "cancellation_confirmation";
+    /** Subject line. */
+    subject: string;
+    /** Plain-text body (give text, html or both). */
+    text?: string;
+    /** HTML body. */
+    html?: string;
+    /** The plan the email is about (price, interval and cancel_url at least). */
+    terms: CheckPlanTerms & {
+        /** price_change only: the OLD price before the change, major units. price / amount is the NEW price the email announces. */
+        previous_price?: number | string;
+        /** Price before a price change, minor units. */
+        previous_amount?: number;
+        /** Support email / URL shown in the generated template. */
+        support_contact?: string;
+    };
+    /** Where you sell: "all" (default) or state codes ("US-CA", "CA", "US-NY"; "US-FED" is always included). */
+    jurisdictions?: "all" | Array<string>;
+    /** Evaluate the law as of this date (YYYY-MM-DD, default today). */
+    as_of?: string;
+}
+/** Verdict on a checkout page. */
+export interface PageCheckResult {
+    /** Id of this check run (chk_…). Checks are stateless and not stored. */
+    id: string;
+    /** String representing the object's type. Always "check_result". */
+    object: "check_result";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When the check ran. Unix timestamp in seconds. */
+    created: number;
+    /** Which check ran. */
+    kind: "disclosure" | "stripe_checkout_session" | "stripe_payment_link" | "email" | "page";
+    /** Overall: fail if any check fails, else needs_review if any needs review, else pass (not_applicable when nothing applies). */
+    verdict: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Counts by status. */
+    summary: {
+        /** Checks passing. */
+        pass: number;
+        /** Checks failing. */
+        fail: number;
+        /** Checks needing review. */
+        needs_review: number;
+        /** Checks not applicable. */
+        not_applicable: number;
+    };
+    /** Every evaluated check. */
+    checks: Array<CheckVerdict>;
+    /** Verdict per legal requirement (federal first, then by state). */
+    requirements: Array<CheckRequirementVerdict>;
+    /** Notes about the input. */
+    warnings: Array<CheckWarning>;
+    /** Jurisdictions evaluated. */
+    jurisdictions: "all" | Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Date the law was evaluated at. */
+    as_of: string;
+    /** Version of the check implementations. */
+    rules_version: string;
+    /** Version of the legal catalog. */
+    catalog_version: string;
+    /** sha256 of the canonical legal catalog. */
+    catalog_hash: string;
+    /** Not legal advice. */
+    disclaimer: string;
+    next_action: NextAction;
+    /** Whether html was given or fetched from url. */
+    source: "html" | "url";
+    /** What was read from the page. */
+    extraction: {
+        /** How the page was read. */
+        mode: "static_html";
+        /** Page URL used. */
+        url: string;
+        /** Purchase buttons found (primary first). */
+        purchase_buttons: Array<string>;
+        /** Text blocks that read like subscription terms. */
+        disclosures: Array<string>;
+        /** Checkboxes found. */
+        checkboxes: Array<{
+            /** Label. */
+            label: string;
+            /** Checked by default. */
+            prechecked: boolean;
+            /** Required. */
+            required: boolean;
+        }>;
+        /** Terms / cancellation / account links found. */
+        links: Array<{
+            /** Link text. */
+            text: string;
+            /** Target. */
+            href: string;
+        }>;
+        /** What a static read cannot measure. */
+        limitations: Array<string>;
+    };
+    replacement?: CheckReplacement;
+}
+/** A checkout page to check. */
+export interface PageCheckParams {
+    /** Checkout page HTML (rendered, after JavaScript, for client-side apps). Give html or url. */
+    html?: string;
+    /** Fetch this live page instead (live mode, activated accounts only; public addresses only). */
+    url?: string;
+    /** What the page is (default checkout). */
+    page_kind?: "checkout" | "pricing";
+    terms?: CheckPlanTerms;
+    /** Where you sell: "all" (default) or state codes ("US-CA", "CA", "US-NY"; "US-FED" is always included). */
+    jurisdictions?: "all" | Array<string>;
+    /** Evaluate the law as of this date (YYYY-MM-DD, default today). */
+    as_of?: string;
+}
+/** One notice to send. */
+export interface ScheduledNotice {
+    /** Notice kind. */
+    kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change";
+    /** What the notice announces. */
+    occasion: string;
+    /** Date of the event (YYYY-MM-DD, UTC). */
+    anchor_date: string;
+    /** Recommended send date (YYYY-MM-DD, UTC). */
+    send_date: string;
+    /** Recommended send time. Unix timestamp in seconds. */
+    send_at: number;
+    /** Earliest compliant send time. Unix seconds. */
+    window_opens_at: number;
+    /** Latest compliant send time. Unix seconds. */
+    window_closes_at: number;
+    /** Days before the event (0 = right away). */
+    days_before: number;
+    /** Jurisdictions whose window this send satisfies. */
+    jurisdictions: Array<string>;
+    /** Requirements behind the timing. */
+    requirement_ids: Array<string>;
+    /** Citations of those requirements. */
+    citations: Array<string>;
+    /** No requirement states a window; Checkbox’s default window was used. */
+    default_window: boolean;
+}
+/** When each legally required notice must be sent. */
+export interface NoticeScheduleResult {
+    /** Id of this check run (chk_…). */
+    id: string;
+    /** String representing the object's type. Always "notice_schedule". */
+    object: "notice_schedule";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When computed. Unix seconds. */
+    created: number;
+    /** Sign-up date planned for. */
+    start_date: string;
+    /** Every legally required notice, in send order. */
+    notices: Array<ScheduledNotice>;
+    /** Notice kinds no applicable requirement demands for this plan. */
+    not_required: Array<{
+        /** Notice kind. */
+        kind: string;
+        /** Why it is not required. */
+        reason: string;
+    }>;
+    /** Jurisdictions planned for. */
+    jurisdictions: "all" | Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+    /** Date the law was applied at. */
+    as_of: string;
+    /** Version of the check implementations. */
+    rules_version: string;
+    /** Version of the legal catalog. */
+    catalog_version: string;
+    /** sha256 of the canonical legal catalog. */
+    catalog_hash: string;
+    /** Not legal advice. */
+    disclaimer: string;
+    next_action: NextAction;
+}
+/** A subscription to plan the legally required notices for. */
+export interface NoticeScheduleParams {
+    terms: CheckPlanTerms;
+    /** Sign-up date of the subscription to plan for (default today). */
+    start_date?: string;
+    /** A planned price change to schedule the notice for. */
+    price_change?: {
+        /** Date the new price is first charged. */
+        effective_date: string;
+        /** New recurring price, major units. */
+        new_price?: number;
+    };
+    /** How many renewals to plan (default: one year of renewals). */
+    cycles?: number;
+    /** Payment methods offered (some notices apply only to debit / ACH). */
+    payment_methods?: Array<"card" | "debit" | "ach" | "wallet" | "other">;
+    /** Where you sell: "all" (default) or state codes ("US-CA", "CA", "US-NY"; "US-FED" is always included). */
+    jurisdictions?: "all" | Array<string>;
+    /** Evaluate the law as of this date (YYYY-MM-DD, default today). */
+    as_of?: string;
+}
+export interface ElementsRelease {
+    /** Semver of the bundle. */
+    version: string;
+    /** Immutable URL of this version. */
+    url: string;
+    /** Subresource Integrity hash (integrity attribute). */
+    integrity: string;
+    /** Bytes. */
+    size: number;
+}
+/** Released Checkbox Elements bundles and their SRI hashes. */
+export interface ElementsManifest {
+    /** String representing the object's type. Always "elements_manifest". */
+    object: "elements_manifest";
+    latest: ElementsRelease;
+    /** Every released version, newest first. */
+    versions: Array<ElementsRelease>;
+    /** Ready-to-paste <script> tag for the latest version. */
+    script_tag: string;
+    /** Custom element name. */
+    element_tag: string;
+    /** Documentation. */
+    docs_url: string;
+}
+/** Locked automatic-renewal disclosure + consent wording for a site, rendered by <checkbox-disclosure disclosure="disc_…">. */
+export interface Disclosure {
+    /** Unique identifier of the disclosure (disc_…). */
+    id: string;
+    /** String representing the object's type. Always "disclosure". */
+    object: "disclosure";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Creation time. Unix timestamp in seconds. */
+    created: number;
+    /** Site. */
+    site: string;
+    /** Terms stated (DisclosureTerms). */
+    terms: Record<string, unknown>;
+    /** Locked disclosure text. */
+    text: string;
+    /** Locked consent checkbox label. */
+    consent_label: string;
+    /** sha256 of text + "\n" + consent_label. */
+    texts_sha256: string;
+    /** Rules version that generated and verified the wording. */
+    rules_version: string;
+    /** Rules-engine verification of the element on your checkout (secret-key responses only). */
+    verification: {
+        /** Every targeted sign-up check passes on the modelled checkout. */
+        passes: boolean;
+        /** from_capture (your scanned checkout) or synthetic. */
+        modelled: string;
+        /** Checks that would still not pass. */
+        remaining: Array<string>;
+        /** Per-check before / after. */
+        checks: Array<{
+            /** Sign-up check id. */
+            check_id: string;
+            /** Status on the checkout today. */
+            before: string;
+            /** Status with the element installed. */
+            after: string;
+        }>;
+    } | null;
+    /** Markup to paste directly above your pay button. */
+    element_html?: string;
+    /** <script> tag (pinned version, SRI) for the page <head>. */
+    script_tag?: string;
+    /** The publishable key for this mode (safe to embed in pages). */
+    publishable_key?: string;
+    next_action?: NextAction;
+}
+/** Terms to state. Omitted values come from the billing connection; cancel_url defaults to the hosted cancellation page. */
+export interface DisclosureTerms {
+    /** Brand shown to subscribers. */
+    merchant_name?: string;
+    /** Recurring charge in minor units (1999 = $19.99). */
+    amount?: number;
+    /** Three-letter ISO currency code. */
+    currency?: string;
+    /** Billing interval. */
+    interval?: "day" | "week" | "month" | "year";
+    /** Intervals per charge (default 1). */
+    interval_count?: number;
+    /** Free-trial length in days (0 or absent: no trial). */
+    trial_days?: number;
+    /** https address where subscribers cancel online. */
+    cancel_url?: string;
+    /** When a cancellation takes effect (default period_end). */
+    cancel_timing?: "period_end" | "immediately";
+}
+export interface DisclosureCreateParams {
+    /** site_… the disclosure is for. */
+    site: string;
+    /** Price / plan id from the site's billing connection (Stripe price_…) when it offers several. */
+    plan?: string;
+    terms?: DisclosureTerms;
+}
+/** Proof that a subscriber affirmatively consented to the exact automatic-renewal terms shown. */
+export interface Consent {
+    /** Unique identifier of the consent (cons_…). */
+    id: string;
+    /** String representing the object's type. Always "consent". */
+    object: "consent";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When Checkbox recorded the consent. Unix timestamp in seconds. */
+    created: number;
+    /** Site the consent belongs to. */
+    site: string;
+    /** What the subscriber saw. */
+    disclosure: {
+        /** disc_… when a server-issued disclosure was shown. */
+        id: string | null;
+        /** Disclosure text shown. */
+        text: string;
+        /** Consent checkbox label shown. */
+        consent_label: string;
+        /** sha256 of the disclosure text. */
+        sha256: string;
+        /** sha256 of disclosure + "\n" + consent label (the hash Fixes uses). */
+        texts_sha256: string;
+        /** The texts equal Checkbox's locked wording for the terms (or the disclosure's). */
+        matches_locked_text: boolean;
+    };
+    /** Terms the disclosure states (DisclosureTerms). */
+    terms: Record<string, unknown>;
+    /** Checkbox state. */
+    checkbox: {
+        /** Always true. */
+        checked: boolean;
+        /** The box was pre-ticked (consent then is not affirmative). */
+        initially_checked: boolean;
+        /** Ticking was required. */
+        required: boolean;
+    };
+    /** Page of the consent. */
+    page_url: string | null;
+    /** Origin of the browser request (null for server-recorded consents). */
+    origin: string | null;
+    /** sha256 of the browser User-Agent header. */
+    user_agent_sha256: string | null;
+    /** Your subscriber reference (set once, by a secret key only: createConsent from your server or updateConsent). Browser-recorded consents start with null. */
+    customer_reference: string | null;
+    /** Reference the page sent with a publishable key (customer-reference attribute). Unverified: anyone holding the public key can send any value, so bind the real subscription with updateConsent from your server. */
+    client_reference: string | null;
+    /** elements: recorded by the browser element; api: by your server. */
+    source: "elements" | "api";
+    /** elements.js version. */
+    element_version: string | null;
+    /** Device time (unix seconds). */
+    client_timestamp: number | null;
+    /** On-screen measurement summary (null for server-recorded consents). */
+    presentation: {
+        /** Guard-rail violations measured on screen. */
+        violations: Array<string>;
+        /** Safe styles replaced the theme. */
+        fallback_applied: boolean;
+        /** Font size. */
+        font_size_px: number | null;
+        /** Contrast ratio. */
+        contrast_ratio: number | null;
+        /** Above the pay button. */
+        above_submit: boolean | null;
+        /** Gap to the pay button. */
+        gap_px: number | null;
+        /** Set off by a border. */
+        boxed: boolean;
+        /** Visible. */
+        visible: boolean;
+    } | null;
+    /** Your key/value pairs. */
+    metadata: Record<string, string>;
+    /** rcpt_… consent receipt recorded with this consent (what the subscriber saw), when the element sent one. */
+    receipt?: string | null;
+    /** Tamper-evident evidence record (verify with verifyEvidenceChain). */
+    evidence: {
+        /** ev_… of the evidence record holding the full consent document. */
+        id: string | null;
+        /** sha256 of the evidence document. */
+        sha256: string | null;
+        /** Position in the site's hash chain. */
+        chain_hash: string | null;
+    };
+    /** Page capture fed to the compliance evaluation from this consent, when a new one was stored. */
+    corroborating_capture?: string | null;
+    next_action: NextAction;
+}
+/** What <checkbox-disclosure> measured on screen (sent by the element). */
+export interface ConsentPresentationInput {
+    /** Rendered disclosure font size. */
+    font_size_px?: number | null;
+    /** Page body font size. */
+    body_font_size_px?: number;
+    /** Minimum the element enforces. */
+    min_font_size_px?: number;
+    /** Rendered font weight. */
+    font_weight?: number | null;
+    /** Rendered text color. */
+    color?: string | null;
+    /** Effective background color. */
+    background_color?: string | null;
+    /** WCAG contrast ratio of the text. */
+    contrast_ratio?: number | null;
+    /** Cumulative opacity. */
+    opacity?: number;
+    /** The disclosure was visible. */
+    visible?: boolean;
+    /** The disclosure was set off by a border. */
+    boxed?: boolean;
+    /** The disclosure sat above the pay button. */
+    above_submit?: boolean | null;
+    /** Vertical gap to the pay button. */
+    gap_px?: number | null;
+    /** Disclosure box on the page. */
+    rect?: {
+        /** Page x (CSS px). */
+        x: number;
+        /** Page y (CSS px). */
+        y: number;
+        /** Width (CSS px). */
+        width: number;
+        /** Height (CSS px). */
+        height: number;
+    } | null;
+    /** Pay button on the page. */
+    submit_rect?: {
+        /** Page x (CSS px). */
+        x: number;
+        /** Page y (CSS px). */
+        y: number;
+        /** Width (CSS px). */
+        width: number;
+        /** Height (CSS px). */
+        height: number;
+    } | null;
+    /** Pay button label. */
+    submit_text?: string | null;
+    /** Viewport size. */
+    viewport?: {
+        /** Viewport width (CSS px). */
+        width: number;
+        /** Viewport height (CSS px). */
+        height: number;
+    } | null;
+    /** Guard-rail violations the element detected. */
+    violations?: Array<string>;
+    /** The element replaced the theme with safe styles. */
+    fallback_applied?: boolean;
+}
+export interface ConsentCreateParams {
+    /** site_… the consent belongs to. Optional with a publishable key (resolved from the page Origin); required with a secret key. */
+    site?: string;
+    /** disc_… of the server-issued disclosure that was shown, if any. */
+    disclosure?: string;
+    terms: WithRequired<DisclosureTerms, "merchant_name" | "amount" | "currency" | "interval" | "cancel_url">;
+    /** The exact disclosure text the subscriber saw. */
+    disclosure_text: string;
+    /** The exact label of the consent checkbox. */
+    consent_label: string;
+    /** Checkbox state. */
+    checkbox: {
+        /** The box was ticked when the consent was recorded (must be true). */
+        checked: boolean;
+        /** The box was ticked before the subscriber touched it (default false). */
+        initially_checked?: boolean;
+        /** Ticking the box was required to subscribe (default true). */
+        required?: boolean;
+    };
+    /** Page the consent was given on (fragment removed). */
+    page_url?: string;
+    /** Your id for the subscriber: Stripe customer / Checkout Session / subscription id. Not an email address: no raw personal data is needed. */
+    customer_reference?: string;
+    /** Unix seconds on the subscriber's device (informational; `created` is the server time). */
+    client_timestamp?: number;
+    /** elements.js version that rendered the disclosure. */
+    element_version?: string;
+    presentation?: ConsentPresentationInput;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata?: Record<string, string>;
+    /** Consent receipt captured with the consent (sent by <checkbox-disclosure> 1.1+): recorded as a receipt linked to this consent. */
+    receipt?: {
+        /** Structured snapshot of the element and pay button at submit (see createReceipt). */
+        snapshot: Record<string, unknown>;
+        /** Capture token (rct_…) from createReceiptToken (the receipt-token attribute). */
+        token?: string;
+    };
+}
+export interface ConsentUpdateParams {
+    /** Attach your subscriber reference (only while none is set). */
+    customer_reference?: string;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata?: Record<string, string>;
+}
+/** A page of consents, newest first. */
+export interface ConsentList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Consents, newest first. */
+    data: Array<Consent>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A short-lived capture token that binds browser receipts to a checkout your server knows about. */
+export interface ReceiptToken {
+    /** Unique identifier of the receipt token (rtok_…). */
+    id: string;
+    /** String representing the object's type. Always "receipt_token". */
+    object: "receipt_token";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When the token was minted. Unix timestamp in seconds. */
+    created: number;
+    /** When the token stops binding receipts. Unix timestamp in seconds. */
+    expires: number;
+    /** Site the token is valid for. */
+    site: string;
+    /** The capture token. Returned only once: render it into the checkout page (data-receipt-token on the disclosure or form, or receipt-token on <checkbox-disclosure>). It is short-lived and only binds receipts, so it is safe in the page. */
+    token: string;
+    /** Copied onto bound receipts. */
+    customer_reference: string | null;
+    /** Stripe Checkout Session id, when given. */
+    checkout_session: string | null;
+    /** Receipts the token may bind. */
+    max_uses: number;
+    /** Ready-to-paste attribute for the disclosure region or form. */
+    html_attribute: string;
+    /** Your key/value pairs. */
+    metadata: Record<string, string>;
+    next_action: NextAction;
+}
+export interface ReceiptTokenCreateParams {
+    /** site_… whose checkout page will present the token. */
+    site: string;
+    /** Your id for the subscriber (Stripe customer id, your user id, order id). Copied onto the receipt as the verified customer_reference. */
+    customer_reference?: string;
+    /** Stripe Checkout Session id when you already created it (links the Stripe record to this receipt). Or put the token id in the session's metadata.checkbox_receipt_token. */
+    checkout_session?: string;
+    /** The subscriber's email address; only an HMAC-SHA-256 under your account's own key is stored (listReceipts?email= finds receipts by it). Still personal data: covered by retention and eraseReceipts. */
+    email?: string;
+    /** Seconds until the token expires (default 3600). */
+    expires_in?: number;
+    /** Receipts the token may bind (default 1: the subscriber can read the token in the page, so mint one per checkout attempt; raise it for checkouts that legitimately submit several times). */
+    max_uses?: number;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata?: Record<string, string>;
+}
+/** The Checkout Session as Stripe recorded it (Stripe-hosted checkouts and Payment Links). */
+export type ReceiptStripeRecord = {
+    /** Checkout Session id. */
+    checkout_session: string;
+    /** Payment Link id when the session came from one. */
+    payment_link: string | null;
+    /** When Stripe created the session (unix seconds). */
+    session_created: number | null;
+    /** When Stripe reported the session completed (unix seconds). */
+    completed: number | null;
+    /** consent_collection.terms_of_service on the session. */
+    terms_of_service: "required" | "none" | "unknown";
+    /** consent.terms_of_service === "accepted" as Stripe recorded it. */
+    terms_of_service_accepted: boolean | null;
+    /** Merchant text Stripe showed on the hosted page. */
+    custom_text: {
+        /** custom_text.submit.message. */
+        submit: string | null;
+        /** custom_text.terms_of_service_acceptance.message. */
+        terms_of_service_acceptance: string | null;
+        /** custom_text.after_submit.message. */
+        after_submit: string | null;
+    };
+    /** Recurring price in minor units. */
+    amount: number | null;
+    /** Currency. */
+    currency: string | null;
+    /** Billing interval. */
+    interval: string | null;
+    /** Intervals per charge. */
+    interval_count: number | null;
+    /** Free-trial days. */
+    trial_days: number | null;
+    /** Subscription id. */
+    subscription: string | null;
+} | null;
+/** A consent receipt: a tamper-evident record of what one subscriber saw next to the pay button and agreed to at checkout. Evidence you can produce; not a legal opinion. */
+export interface Receipt {
+    /** Unique identifier of the receipt (rcpt_…). */
+    id: string;
+    /** String representing the object's type. Always "receipt". */
+    object: "receipt";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** When Checkbox recorded the receipt (server time). Unix timestamp in seconds. */
+    created: number;
+    /** Site the receipt belongs to. */
+    site: string;
+    /** elements: <checkbox-disclosure>; snippet: /r.js; api: your server; stripe_*: reconstructed from Stripe's record of a Stripe-hosted page. */
+    source: "elements" | "snippet" | "api" | "stripe_checkout" | "stripe_payment_link";
+    /** bound: the browser presented a valid capture token your server minted; unbound: no (valid) token, so the receipt is a client claim; server: recorded by your server or reconstructed from Stripe. */
+    binding: "bound" | "unbound" | "server";
+    /** true when built from Stripe's record instead of the page the subscriber saw (lower evidentiary weight). */
+    reconstructed: boolean;
+    /** How the record was obtained, strongest first. Not a legal assessment. */
+    evidentiary_weight: "direct_capture" | "direct_capture_unbound" | "server_record" | "reconstructed_from_stripe";
+    /** Disclosure detection. */
+    detection: {
+        /** How the disclosure region was found. */
+        method: "elements" | "marked" | "auto" | "server" | "stripe";
+        /** Confidence that the region is the disclosure. */
+        confidence: "high" | "medium" | "low";
+    };
+    /** Verified subscriber reference (from the capture token, your server, or Stripe). */
+    customer_reference: string | null;
+    /** Reference the page claimed (unverified). */
+    client_reference: string | null;
+    /** HMAC-SHA-256 (keyed per account) of the subscriber's lowercased email, when your server gave one. Personal data: erased with the receipt. */
+    email_sha256: string | null;
+    /** Stripe Checkout Session id. */
+    checkout_session: string | null;
+    /** Subscription id, when known. */
+    subscription: string | null;
+    /** cons_… recorded with this receipt by <checkbox-disclosure>. */
+    consent: string | null;
+    /** For Stripe-hosted checkouts: the rcpt_… captured on your page before the redirect. */
+    pre_checkout_receipt: string | null;
+    /** Page (origin + path, query string removed). */
+    page_url: string | null;
+    /** Page / browser language. */
+    language: string | null;
+    /** Device + browser family (never the full user agent). */
+    user_agent_class: string | null;
+    /** Viewport at submit. */
+    viewport: {
+        /** CSS px. */
+        width: number;
+        /** CSS px. */
+        height: number;
+    } | null;
+    /** Device clock at capture (unix seconds; informational). */
+    client_timestamp: number | null;
+    /** What the disclosure said and how it was shown. */
+    disclosure: {
+        /** Disclosure text the subscriber saw (personal data redacted). */
+        text: string;
+        /** SHA-256 of the text. */
+        sha256: string;
+        /** How the disclosure was presented (null fields: not measured). */
+        presentation: {
+            /** Rendered font size of the disclosure text. */
+            font_size_px: number | null;
+            /** Rendered font weight. */
+            font_weight: number | null;
+            /** Text color. */
+            color: string | null;
+            /** Effective background color. */
+            background_color: string | null;
+            /** WCAG contrast ratio of text over background. */
+            contrast_ratio: number | null;
+            /** The disclosure was visible. */
+            visible: boolean | null;
+            /** Set off from surrounding content (border or own background). */
+            set_off: boolean | null;
+            /** Fully inside the first screen of the page. */
+            above_fold: boolean | null;
+            /** Placed above the submit button. */
+            above_submit: boolean | null;
+            /** Gap between the disclosure and the submit button (CSS px). */
+            distance_to_submit_px: number | null;
+        };
+    };
+    /** The consent checkbox (null: none found). */
+    checkbox: {
+        /** A consent checkbox was found. */
+        present: boolean;
+        /** It was ticked at submit. */
+        checked: boolean;
+        /** Its label as captured. Null for receipts reconstructed from Stripe: Stripe's record has no checkbox wording, so none is claimed. */
+        label: string | null;
+        /** It was required. */
+        required: boolean;
+    } | null;
+    /** Label of the button the subscriber pressed (null when not observed, e.g. Stripe-hosted pages). */
+    submit_label: string | null;
+    stripe: ReceiptStripeRecord;
+    /** Things a reviewer should know: unbound, token_invalid, token_expired, token_used_up, token_site_mismatch, low_confidence_detection, disclosure_not_found, below_fold, not_above_submit, far_from_submit, low_contrast, small_font, hidden, hidden_text (text was present but not visibly rendered; left out), typed_text_masked, checkbox_unchecked, no_consent_checkbox, client_clock_skew, implausible_render_gap, reconstructed, no_pre_checkout_snapshot, linked_by_client_nonce, multiple_pre_checkout_candidates, stripe_mode_mismatch, no_terms_of_service_consent, no_custom_text, test_mode, unsigned. */
+    flags: Array<string>;
+    /** Tamper evidence. verifyReceipt checks all of it. */
+    integrity: {
+        /** SHA-256 of the canonical JSON receipt (keys sorted, no whitespace) — also the evidence record's content hash. */
+        receipt_sha256: string;
+        /** ev_… record that chains the receipt into the site's evidence vault. */
+        evidence: string | null;
+        /** Chain hash of that record. */
+        chain_hash: string | null;
+        /** Ed25519 key that signed the receipt (published at /.well-known/checkbox-keys.json). */
+        public_key_id: string | null;
+        /** When it was signed (unix seconds). */
+        signed: number | null;
+    };
+    /** When the receipt is deleted under your retention setting. Unix timestamp in seconds. */
+    retain_until: number;
+    /** PNG of what the subscriber saw, re-rendered from the snapshot (renderReceipt, same auth). */
+    render_url: string;
+    next_action: NextAction;
+}
+export interface ReceiptCreateParams {
+    /** site_… the receipt belongs to. Optional with a publishable key (resolved from the page Origin); required with a secret key. */
+    site?: string;
+    /** The structured snapshot captured by /r.js or <checkbox-disclosure> (version 1): the disclosure region's text, sanitized subtree and computed styles, the consent checkbox state and label, the submit label, layout, viewport, page URL without query string, language and user-agent class. Validated strictly and re-sanitized by the server; it never contains form-field values. */
+    snapshot: Record<string, unknown>;
+    /** Capture token (rct_…) your server minted for this checkout with createReceiptToken. Binds the receipt to that checkout; without it the receipt is accepted but flagged "unbound". */
+    token?: string;
+    /** A reference the page claims for the subscriber (unverified; kept apart from customer_reference). */
+    client_reference?: string;
+    /** Random nonce the snippet also put in a Payment Link's client_reference_id (ckbx_<nonce>), linking this pre-checkout snapshot to the Stripe record. */
+    capture_nonce?: string;
+    /** Secret keys only: your id for the subscriber (Stripe customer / subscription / Checkout Session id). Not an email address. */
+    customer_reference?: string;
+    /** Secret keys only: the Stripe Checkout Session id this receipt belongs to. */
+    checkout_session?: string;
+    /** Secret keys only: the subscriber's email address. Only an HMAC-SHA-256 of it (lowercased, trimmed; keyed per account) is stored. */
+    email?: string;
+}
+/** A page of receipts, newest first. */
+export interface ReceiptList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Receipts, newest first. */
+    data: Array<Receipt>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** Result of erasing a subscriber's receipts. */
+export interface ReceiptErasure {
+    /** String representing the object's type. Always "receipt_erasure". */
+    object: "receipt_erasure";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Receipts deleted. Their signed copies in the evidence vault remain but hold only a salted commitment to the identifiers, which can no longer be opened. */
+    erased: number;
+}
+export interface ReceiptErasureParams {
+    /** Erase receipts with this customer_reference. */
+    customer_reference?: string;
+    /** Erase receipts recorded with this email (hashed before the lookup). */
+    email?: string;
+    /** Erase receipts of this Stripe Checkout Session. */
+    checkout_session?: string;
+    /** Only this site_…. */
+    site?: string;
+}
+/** Result of re-checking a receipt's hash, signature and evidence chain. */
+export interface ReceiptVerification {
+    /** String representing the object's type. Always "receipt_verification". */
+    object: "receipt_verification";
+    /** Unique identifier of the receipt (rcpt_…). */
+    receipt: string;
+    /** Every check passed. */
+    verified: boolean;
+    /** Individual checks. */
+    checks: {
+        /** Content hash. */
+        content: {
+            /** The stored receipt hashes to receipt_sha256. */
+            ok: boolean;
+            /** Detail. */
+            message: string;
+        };
+        /** Signature. */
+        signature: {
+            /** Checkbox's Ed25519 signature over the receipt hash verifies. */
+            ok: boolean;
+            /** Detail. */
+            message: string;
+        };
+        /** Hash chain. */
+        chain: {
+            /** The site's evidence chain (which includes the receipt) verifies end to end. */
+            ok: boolean;
+            /** Detail. */
+            message: string;
+        };
+        /** Shown values vs. the signed document. */
+        index: {
+            /** What this API, the dashboard, the image and the bundle show (binding, source, text, snapshot, flags, identifiers) matches the signed document. */
+            ok: boolean;
+            /** Detail (index_mismatch names the fields that differ). */
+            message: string;
+            /** Identifiers attached after signing (e.g. checkout_session once Stripe confirmed the checkout): not covered by the signature. */
+            linked_after_signing: Array<string>;
+        };
+    };
+    /** The receipt hash that was checked. */
+    receipt_sha256: string;
+    /** When the check ran. Unix timestamp in seconds. */
+    verified_at: number;
+    /** How to verify without Checkbox: download exportReceipt and run its verify.mjs. */
+    offline: string;
+}
+/** Consent-receipt collection and retention for the account (per mode). */
+export interface ReceiptSettings {
+    /** String representing the object's type. Always "receipt_settings". */
+    object: "receipt_settings";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Receipts are collected. Off by default: turn on after adding the receipts paragraph to your privacy policy (browser receipts answer 403 receipts_disabled when off; Elements consents are recorded without a receipt). */
+    enabled: boolean;
+    /** Days a receipt is kept (default 1461 = 4 years: the California Unfair Competition Law limitation period; pending attorney review). */
+    retention_days: number;
+    /** Last change. Unix timestamp in seconds. */
+    updated: number | null;
+}
+export interface ReceiptSettingsUpdateParams {
+    /** Turn receipt collection on or off. */
+    enabled?: boolean;
+    /** Days to keep receipts (30–3653). Applies to new receipts. */
+    retention_days?: number;
+}
+/** A billing-platform TEST-mode key Checkbox uses for synthetic test subscriptions. Stored encrypted; never live mode. */
+export interface TestCredential {
+    /** Unique identifier of the test credential (tcred_…). */
+    id: string;
+    /** String representing the object's type. Always "test_credential". */
+    object: "test_credential";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site the key belongs to. */
+    site: string;
+    /** Kind of key. Always "stripe_test" (a Stripe TEST-mode restricted or secret key). */
+    type: "stripe_test";
+    /** The key's prefix and last four characters; the key itself is never returned. */
+    key_hint: string;
+    /** Whether Stripe accepted the key when it was stored. */
+    verified: boolean;
+    /** When a test run last used the key. Unix timestamp in seconds. */
+    last_used: number | null;
+    /** Last error Stripe returned for the key, if any. */
+    last_error: string | null;
+    /** When the key was stored. Unix timestamp in seconds. */
+    created: number;
+}
+/** A page of stored test-mode keys. */
+export interface TestCredentialList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Stored test-mode keys. */
+    data: Array<TestCredential>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A deleted test credential. */
+export interface DeletedTestCredential {
+    /** Unique identifier of the test credential (tcred_…). */
+    id: string;
+    /** String representing the deleted object's type. Always "test_credential". */
+    object: "test_credential";
+    /** Always true. */
+    deleted: true;
+}
+/** Checkout Session parameters your code uses, registered so test runs mirror exactly your checkout into Stripe test mode. */
+export interface StripeCheckoutConfig {
+    /** Unique identifier of the stripe checkout config (scc_…). */
+    id: string;
+    /** String representing the object's type. Always "stripe_checkout_config". */
+    object: "stripe_checkout_config";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site the config belongs to. */
+    site: string;
+    /** Your name for the config. */
+    name: string | null;
+    /** The mirrored Checkout Session parameters (the subset of what your code passes to stripe.checkout.sessions.create that shapes what customers see). */
+    params: Record<string, unknown>;
+    /** sha256 of the canonical params; changes whenever the registered parameters change. */
+    params_hash: string;
+    /** Parameters that were dropped because they are not mirrored (customer, URLs, metadata…). */
+    ignored_params: Array<string>;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata: Record<string, string>;
+    /** When the config was registered. Unix timestamp in seconds. */
+    created: number;
+}
+/** A page of registered checkout configs, newest first. */
+export interface StripeCheckoutConfigList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Registered checkout configs, newest first. */
+    data: Array<StripeCheckoutConfig>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A deleted stripe checkout config. */
+export interface DeletedStripeCheckoutConfig {
+    /** Unique identifier of the stripe checkout config (scc_…). */
+    id: string;
+    /** String representing the deleted object's type. Always "stripe_checkout_config". */
+    object: "stripe_checkout_config";
+    /** Always true. */
+    deleted: true;
+}
+/** How to fix a failing check. */
+export type TestRunRemediation = {
+    /** What the law requires and what to change. */
+    summary: string;
+    /** Steps to fix it. */
+    steps: Array<string>;
+    /** Compliant copy to use, when there is one. */
+    suggested_copy: string | null;
+    /** Code that applies the fix, when there is one. */
+    snippet: {
+        /** Language of the code. */
+        language: string;
+        /** Code that applies the fix. */
+        code: string;
+    } | null;
+} | null;
+/** An agent-readable fix: what to change, where, and how to verify (run again). */
+export type TestRunFix = {
+    /** What to change, in one sentence. */
+    summary: string;
+    /** Ordered instructions for the builder's agent. */
+    steps: Array<string>;
+    /** Where the change goes (Stripe Dashboard URL, file, component). */
+    where?: string;
+    /** API call that applies or retries the fix (SDK method name). */
+    operation_id?: string;
+    /** Exact Stripe parameters to use, when the fix is a Stripe setting or object. */
+    stripe_params?: Record<string, unknown>;
+    /** Shell command that applies the fix (Stripe CLI), when there is one. */
+    command?: string;
+    /** Documentation for the fix. */
+    docs_url?: string;
+} | null;
+/** One observed lifecycle step of a test run. */
+export interface TestRunStep {
+    /** Stable step key: credentials, checkout_config, checkout_page, subscribe, acknowledgment_email, trial_reminder, renewal, cancel_online, cancellation_email, cleanup. */
+    key: string;
+    /** Human-readable step title. */
+    title: string;
+    /** passed: observed and compliant; failed: a check failed or the step broke the run; warning: could not be fully observed (see code and fix); skipped: not applicable or turned off. */
+    status: "pending" | "running" | "passed" | "failed" | "warning" | "skipped";
+    /** What was observed, in one or two sentences. */
+    summary: string | null;
+    /** When the step started. Unix timestamp in seconds. */
+    started: number | null;
+    /** When the step finished. Unix timestamp in seconds. */
+    finished: number | null;
+    /** Checks this step produces evidence for. */
+    check_ids: Array<string>;
+    /** Check results judged from this run's observations (test-clock time). */
+    checks: Array<{
+        /** Machine check id (see listRules / the legal catalog). */
+        check_id: string;
+        /** pass, fail, needs_review or not_applicable, judged from this run's observations. */
+        status: string;
+        /** What was observed. */
+        message: string;
+        /** critical, high, medium or low. */
+        severity: string | null;
+        remediation: TestRunRemediation;
+    }>;
+    /** Step-specific facts: URLs, ids, timings (e.g. sent_days_before for reminders), hashes. */
+    observations: Record<string, unknown>;
+    /** Evidence records (screenshots, page captures, raw emails) behind the step. */
+    evidence: Array<string>;
+    /** Warning or failure code of the step (stable): key_missing, key_not_test_mode, key_invalid, key_permission_missing, checkout_config_missing, price_not_in_test_mode, checkout_session_failed, checkout_page_unreadable, checkout_not_completed, subscription_create_failed, test_clock_failed, no_email_received_within, reminder_not_received, portal_not_configured, cancel_not_completed, cancellation_email_not_received, scan_config_missing, domain_not_verified, scanner_failed, stripe_api_error, timeout, canceled, internal_error. */
+    code: string | null;
+    fix: TestRunFix;
+}
+/** A synthetic test subscription that observes the whole subscription lifecycle in test mode and reports each step with evidence, check results and fixes. */
+export interface TestRun {
+    /** Unique identifier of the test run (run_…). */
+    id: string;
+    /** String representing the object's type. Always "test_run". */
+    object: "test_run";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site under test. */
+    site: string;
+    /** stripe: Stripe test mode with a test clock; generic: any site with a test coupon / test account (no time travel). */
+    type: "stripe" | "generic";
+    /** succeeded means the run finished (steps may still have failing checks); failed means it stopped early (see failure). */
+    status: "queued" | "running" | "succeeded" | "failed" | "canceled";
+    /** Internal phase (prepare, checkout, await_ack, advance, settle, cancel, await_cancel_email, finalize, done). */
+    phase: string;
+    /** Always true: runs use the billing platform's test mode; nothing is charged. */
+    test_mode: true;
+    /** Email address of the synthetic test subscriber; mail sent there is captured as evidence. */
+    inbox_address: string;
+    /** When the run was created. Unix timestamp in seconds. */
+    created: number;
+    /** When the worker started it. Unix timestamp in seconds. */
+    started: number | null;
+    /** When it finished. Unix timestamp in seconds. */
+    finished: number | null;
+    /** Lifecycle steps in order. */
+    steps: Array<TestRunStep>;
+    /** Why the run stopped (failed / canceled runs). */
+    failure: {
+        /** Stable failure code: key_missing, key_not_test_mode, key_invalid, key_permission_missing, checkout_config_missing, price_not_in_test_mode, checkout_session_failed, checkout_page_unreadable, checkout_not_completed, subscription_create_failed, test_clock_failed, no_email_received_within, reminder_not_received, portal_not_configured, cancel_not_completed, cancellation_email_not_received, scan_config_missing, domain_not_verified, scanner_failed, stripe_api_error, timeout, canceled, internal_error. */
+        code: string;
+        /** What went wrong. */
+        message: string;
+        /** Code-specific details (e.g. prices: the exact parameters to create in test mode). */
+        detail: Record<string, unknown>;
+        fix: TestRunFix;
+    } | null;
+    /** Outcome of a finished run. */
+    result: {
+        /** Compliance score (0-100) of the observed steps alone. */
+        score: number | null;
+        /** Counts. */
+        summary: {
+            /** Checks that passed. */
+            passed: number;
+            /** Checks that failed. */
+            failed: number;
+            /** Checks that need review. */
+            needs_review: number;
+            /** Steps that could not be fully observed. */
+            warnings: number;
+        };
+        /** Every check result of the run. */
+        checks: Array<{
+            /** Check id. */
+            check_id: string;
+            /** Result. */
+            status: string;
+            /** Step key that observed it. */
+            step: string;
+        }>;
+        /** What the run added to the site's continuous monitoring (provenance test_run). */
+        monitoring: {
+            /** The scanned checkout counts in continuous monitoring (mirrored config matches live). */
+            checkout_page_counted: boolean;
+            /** The cancellation flow counts in continuous monitoring. */
+            cancellation_flow_counted: boolean;
+            /** Emails added to the site's evidence (labelled test_run). */
+            emails_counted: number;
+            /** Reminder occasions added with their observed timing. */
+            reminder_events: number;
+            /** Why something was kept in the run report only. */
+            notes: Array<string>;
+        };
+    } | null;
+    /** Stripe test-mode objects of the run (type stripe). */
+    stripe: {
+        /** Stripe test clock (deleted at the end). */
+        test_clock: string | null;
+        /** Test customer (the synthetic subscriber). */
+        customer: string | null;
+        /** Test subscription. */
+        subscription: string | null;
+        /** Mirrored test-mode Checkout Session. */
+        checkout_session: string | null;
+        /** Where the checkout configuration came from. */
+        mirrored_from: "registered" | "live" | "request" | null;
+        /** Registered config used (scc_…). */
+        checkout_config: string | null;
+        /** Compliance fingerprint of the mirrored checkout. */
+        config_hash: string | null;
+        /** Whether the mirrored checkout matches your latest live checkout (null: no live connection to compare). */
+        matches_live: boolean | null;
+        /** Whether the test clock (with its customer and subscription) was deleted. */
+        cleaned_up: boolean;
+    } | null;
+    next_action: NextAction;
+}
+/** A page of test runs, newest first. */
+export interface TestRunList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Test runs, newest first. */
+    data: Array<TestRun>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** Where Checkbox sends signed event notifications (Checkbox-Signature: t=…,v1=…). */
+export interface WebhookEndpoint {
+    /** Unique identifier of the webhook endpoint (we_…). */
+    id: string;
+    /** String representing the object's type. Always "webhook_endpoint". */
+    object: "webhook_endpoint";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** HTTPS URL Checkbox POSTs events to. */
+    url: string;
+    /** Your description. */
+    description: string | null;
+    /** Event types sent to this endpoint ("*" = all). */
+    enabled_events: Array<string>;
+    /** Disabled endpoints receive nothing. */
+    status: "enabled" | "disabled";
+    /** API version events are rendered with. */
+    api_version: string;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata: Record<string, string>;
+    /** Signing secret (whsec_…). Only returned when the endpoint is created or the secret is rolled; store it. */
+    secret?: string;
+    /** When the endpoint was created. Unix timestamp in seconds. */
+    created: number;
+}
+/** A page of webhook endpoints, newest first. */
+export interface WebhookEndpointList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Webhook endpoints, newest first. */
+    data: Array<WebhookEndpoint>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** A deleted webhook endpoint. */
+export interface DeletedWebhookEndpoint {
+    /** Unique identifier of the webhook endpoint (we_…). */
+    id: string;
+    /** String representing the deleted object's type. Always "webhook_endpoint". */
+    object: "webhook_endpoint";
+    /** Always true. */
+    deleted: true;
+}
+/** Something that happened in the account. Delivered to webhook endpoints and listed by listEvents (kept 30 days). */
+export interface Event {
+    /** Unique identifier of the event (evt_…). */
+    id: string;
+    /** String representing the object's type. Always "event". */
+    object: "event";
+    /** Event type: site.score_changed, site.insurable_changed, finding.created, finding.resolved, scan.completed, scan.failed, law.changed, certificate.issued, certificate.lapsed, certificate.revoked, notice.sent, notice.due, notice.overdue, consent.created, receipt.created, test_run.completed, test_run.failed, plan.updated, site.compliant, task.verified. */
+    type: string;
+    /** API version used to render data.object. */
+    api_version: string;
+    /** When the event happened. Unix timestamp in seconds. */
+    created: number;
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** Event payload. */
+    data: {
+        /** The object the event is about (a site, finding, scan, certificate, law_update or notice), as the API returns it. */
+        object: Record<string, unknown>;
+        /** For *_changed events: the previous values of the changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+    /** Webhook deliveries not yet acknowledged. */
+    pending_webhooks: number;
+    /** What caused the event. */
+    request: {
+        /** API request that caused the event (null for automatic changes). */
+        id: string | null;
+        /** Idempotency-Key of that request. */
+        idempotency_key: string | null;
+    };
+}
+/** A page of events, newest first. */
+export interface EventList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Events, newest first. */
+    data: Array<Event>;
+    /** Whether more items exist after this page. Pass the last id as starting_after to fetch them. */
+    has_more: boolean;
+    /** The URL of this list. */
+    url: string;
+}
+/** Feedback sent to the Checkbox team. */
+export interface Feedback {
+    /** Unique identifier of the feedback (fb_…). */
+    id: string;
+    /** String representing the object's type. Always "feedback". */
+    object: "feedback";
+    /** Kind of feedback. */
+    type: "bug" | "idea" | "question";
+    /** open until Checkbox staff reply or close it. */
+    status: "open" | "replied" | "closed";
+    /** When it was received. Unix timestamp in seconds. */
+    created: number;
+}
+export interface FeedbackParams {
+    /** bug: something is broken; idea: a missing feature or improvement; question: something unclear. Default idea. */
+    type?: "bug" | "idea" | "question";
+    /** What you tried, what happened and what you expected (at most 5000 characters). */
+    message: string;
+    /** Optional context that helps us reproduce it. */
+    context?: {
+        /** Site id the feedback is about. */
+        site?: string;
+        /** Request-Id of the API call it is about. */
+        request_id?: string;
+        /** MCP tool or CLI command involved. */
+        tool?: string;
+        /** The agent or client sending it. */
+        agent?: string;
+    };
+}
+/** A compliance plan without task content (webhook payload). */
+export interface CompliancePlanSummary {
+    /** Unique identifier of the compliance plan (plan_…). */
+    id: string;
+    /** String representing the object's type. Always "compliance_plan". */
+    object: "compliance_plan";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** action_required (an agent can apply open tasks now), verifying (changes applied; waiting for confirming observations), compliant (every applicable check Checkbox could observe passes — an automated assessment, not a legal determination; see coverage for what was not observed), blocked (only human answers or declined critical tasks remain). */
+    status: "action_required" | "verifying" | "compliant" | "blocked";
+    /** Compliance score 0-100 of the latest evaluation. */
+    score: number | null;
+    /** Preview flag the planned Checkbox Warranty will key on (no checks failing at high severity). No warranty or insurance is offered yet; this is not an underwriting decision. */
+    insurable: boolean | null;
+    /** Two or three sentences for an LLM: where the site stands and what comes next. */
+    summary: string;
+    /** Tasks per status. */
+    counts: {
+        /** Open tasks. */
+        open: number;
+        /** Claimed tasks. */
+        in_progress: number;
+        /** Tasks waiting for a confirming observation. */
+        verifying: number;
+        /** Tasks waiting for a human answer. */
+        manual: number;
+        /** Done tasks. */
+        done: number;
+        /** Declined tasks. */
+        wont_fix: number;
+    };
+    next_action: PlanNextAction;
+    /** What the assessment rests on. Tell the human about not_observed and attested items; never call the site "compliant" without them. */
+    coverage: {
+        /** Lifecycle stages Checkbox observed (signup, acknowledgment_email, reminders, cancellation, policies, billing_settings). */
+        observed: Array<string>;
+        /** Stages Checkbox has no observation of: their checks cannot fail, so passing says nothing about them. */
+        not_observed: Array<string>;
+        /** Task keys resting on a human confirmation instead of an observation. */
+        attested: Array<string>;
+        /** A billing platform is connected (dashboard). */
+        billing_connected: boolean;
+    };
+    /** When the plan was computed. Unix timestamp in seconds. */
+    generated: number;
+    /** Tasks (id, key, status, priority, title) in plan order. */
+    tasks: Array<{
+        /** Unique identifier of the task (task_…). */
+        id: string;
+        /** Task key. */
+        key: string;
+        /** Task status. */
+        status: "open" | "in_progress" | "verifying" | "done" | "wont_fix" | "manual";
+        /** Priority. */
+        priority: "critical" | "high" | "medium" | "low";
+        /** Title. */
+        title: string;
+    }>;
+}
+/** A legally required notice Checkbox sent for the merchant. */
+export interface Notice {
+    /** Unique identifier of the notice (ntc_…). */
+    id: string;
+    /** String representing the object's type. Always "notice". */
+    object: "notice";
+    /** true for live-mode objects, false for test mode (ck_test_ keys act on an isolated sandbox). */
+    livemode: boolean;
+    /** The site. */
+    site: string;
+    /** Notice kind. */
+    kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change";
+    /** Delivery status. */
+    status: "claimed" | "sent" | "failed" | "bounced" | "skipped";
+    /** Billing platform of the subscription. */
+    platform: string;
+    /** Billing-platform subscription id. */
+    subscription: string;
+    /** Masked recipient address. */
+    recipient: string | null;
+    /** Subject line. */
+    subject: string | null;
+    /** When it was sent. Unix timestamp in seconds. */
+    sent: number | null;
+    /** Sent after the legal window opened late (e.g. the subscription was imported late). */
+    late: boolean;
+    /** Evidence record of the sent email. */
+    evidence: string | null;
+}
+/** Parameters of `device.token()` (createDeviceToken). */
+export interface CreateDeviceTokenParams {
+    /** The device_code from createDeviceAuthorization. */
+    device_code: string;
+}
+/** Parameters of `setupSessions.list()` (listSetupSessions). */
+export interface ListSetupSessionsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+}
+/** Parameters of `account.update()` (updateAccount). */
+export interface UpdateAccountParams {
+    /** API version to pin. */
+    api_version?: string;
+}
+/** Parameters of `sites.list()` (listSites). */
+export interface ListSitesParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** true lists only archived sites. */
+    archived?: "true" | "false";
+}
+/** Parameters of `sites.retrieve()` (retrieveSite). */
+export interface RetrieveSiteParams {
+    /** Related objects to include inline: latest_scan, domain_verification. Pass as expand[]=name. */
+    expand?: Array<"latest_scan" | "domain_verification">;
+}
+/** Parameters of `domainVerifications.create()` (createDomainVerification). */
+export interface CreateDomainVerificationParams {
+    /** Issue a new token (invalidates the old one). */
+    rotate?: boolean;
+}
+/** Parameters of `scans.create()` (createScan). */
+export interface CreateScanParams {
+    /** States to scan from (default: the site configuration). */
+    regions?: Array<"US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY">;
+}
+/** Parameters of `scans.list()` (listScans). */
+export interface ListScansParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only objects of this site (site_…). */
+    site?: string;
+}
+/** Parameters of `evaluations.create()` (createEvaluation). */
+export type CreateEvaluationParams = Record<string, unknown>;
+/** Parameters of `evaluations.list()` (listEvaluations). */
+export interface ListEvaluationsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only objects of this site (site_…). */
+    site?: string;
+}
+/** Parameters of `findings.list()` (listFindings). */
+export interface ListFindingsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only objects of this site (site_…). */
+    site?: string;
+    /** Only this check status. */
+    status?: "pass" | "fail" | "needs_review" | "not_applicable";
+    /** Only this triage state. */
+    state?: "open" | "acknowledged" | "resolved" | "accepted_risk";
+}
+/** Parameters of `findings.update()` (updateFinding). */
+export interface UpdateFindingParams {
+    /** New triage state. */
+    state: "open" | "acknowledged" | "resolved" | "accepted_risk";
+    /** Why (kept with the finding). */
+    note?: string;
+}
+/** Parameters of `tasks.verify()` (verifyTask). */
+export type VerifyTaskRequestParams = VerifyTaskParams & {
+    /** Long-poll: wait up to this many seconds (0-30) for the verification to resolve before answering. */
+    wait?: number | null;
+};
+/** Parameters of `sites.verify()` (verifySite). */
+export interface VerifySiteParams {
+    /** Long-poll: wait up to this many seconds (0-30) for the verification to resolve before answering. */
+    wait?: number | null;
+}
+/** Parameters of `verifications.retrieve()` (retrieveVerification). */
+export interface RetrieveVerificationParams {
+    /** Long-poll: wait up to this many seconds (0-30) for the verification to resolve before answering. */
+    wait?: number | null;
+}
+/** Parameters of `verifications.list()` (listVerifications). */
+export interface ListVerificationsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only this task (task_…). */
+    task?: string;
+}
+/** Parameters of `fixes.retrieve()` (retrieveFindingFix). */
+export interface RetrieveFindingFixParams {
+    /** Billing-platform plan/price id to write the disclosure for. */
+    plan?: string;
+    /** Cancellation URL to state (defaults to the hosted page or billing portal). */
+    cancel_url?: string;
+    /** Where the sign-up happens (default: detected). */
+    target?: "stripe_checkout" | "stripe_payment_link" | "shopify" | "html";
+}
+/** Parameters of `fixes.list()` (listSiteFixes). */
+export interface ListSiteFixesParams {
+    /** Billing-platform plan/price id to write the disclosure for. */
+    plan?: string;
+    /** Cancellation URL to state (defaults to the hosted page or billing portal). */
+    cancel_url?: string;
+    /** Where the sign-up happens (default: detected). */
+    target?: "stripe_checkout" | "stripe_payment_link" | "shopify" | "html";
+}
+/** Parameters of `evidence.list()` (listEvidence). */
+export interface ListEvidenceParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Site (site_…). Required. */
+    site: string;
+    /** Only this kind. */
+    kind?: "screenshot" | "html" | "page_capture" | "email_raw" | "platform_config" | "lifecycle_event" | "evaluation";
+}
+/** Parameters of `evidence.verifyChain()` (verifyEvidenceChain). */
+export type VerifyEvidenceChainParams = Record<string, unknown>;
+/** Parameters of `certificates.list()` (listCertificates). */
+export interface ListCertificatesParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only objects of this site (site_…). */
+    site?: string;
+}
+/** Parameters of `certificates.create()` (createCertificate). */
+export type CreateCertificateParams = Record<string, unknown>;
+/** Parameters of `certificates.revoke()` (revokeCertificate). */
+export interface RevokeCertificateParams {
+    /** Private reason. */
+    reason: string;
+}
+/** Parameters of `notices.listDue()` (listDueNotices). */
+export interface ListDueNoticesParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only this site (site_…). Default: every site of the account. */
+    site?: string;
+    /** Comma-separated statuses (upcoming, due, sent, overdue, canceled, missed). Default: upcoming,due,overdue — what still needs sending. */
+    status?: string;
+    /** Comma-separated kinds (acknowledgment, trial_ending, renewal_reminder, annual_terms, price_change, cancellation_confirmation). */
+    kind?: string;
+    /** Only notices for this billing-platform subscription id. */
+    subscription?: string;
+}
+/** Parameters of `notices.listTemplates()` (listNoticeTemplates). */
+export interface ListNoticeTemplatesParams {
+    /** Site (site_…) whose BCC addresses to include. */
+    site?: string;
+}
+/** Parameters of `lawUpdates.list()` (listLawUpdates). */
+export interface ListLawUpdatesParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only changes on or after this date (YYYY-MM-DD). */
+    since?: string;
+}
+/** Parameters of `consents.list()` (listConsents). */
+export interface ListConsentsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only this site's consents. */
+    site?: string;
+    /** Only consents with this customer reference. */
+    customer_reference?: string;
+    /** Only consents to this disclosure. */
+    disclosure?: string;
+    /** Created at or after (unix seconds). */
+    created_gte?: number | null;
+    /** Created at or before (unix seconds). */
+    created_lte?: number | null;
+}
+/** Parameters of `receipts.list()` (listReceipts). */
+export interface ListReceiptsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only receipts of this site. */
+    site?: string;
+    /** Only receipts for this subscriber reference. */
+    customer_reference?: string;
+    /** Only receipts of this Stripe Checkout Session. */
+    checkout_session?: string;
+    /** Only receipts whose email hash matches this address (hashed before the lookup). */
+    email?: string;
+    /** Only this source. */
+    source?: "elements" | "snippet" | "api" | "stripe_checkout" | "stripe_payment_link";
+    /** Only this binding. */
+    binding?: "bound" | "unbound" | "server";
+    /** Created at or after (unix seconds). */
+    created_gte?: number | null;
+    /** Created at or before (unix seconds). */
+    created_lte?: number | null;
+}
+/** Parameters of `testCredentials.create()` (createTestCredential). */
+export interface CreateTestCredentialParams {
+    /** Kind of key. Only "stripe_test". */
+    type: "stripe_test";
+    /** The Stripe test-mode restricted (rk_test_…) or secret (sk_test_…) key. Stored encrypted; never returned. */
+    secret_key: string;
+}
+/** Parameters of `stripeCheckoutConfigs.create()` (createStripeCheckoutConfig). */
+export interface CreateStripeCheckoutConfigParams {
+    /** The Checkout Session parameters (mode "subscription", line_items, custom_text, consent_collection, subscription_data…). */
+    params: Record<string, unknown>;
+    /** Your name for it. */
+    name?: string;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata?: Record<string, string>;
+}
+/** Parameters of `stripeCheckoutConfigs.list()` (listStripeCheckoutConfigs). */
+export interface ListStripeCheckoutConfigsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+}
+/** Parameters of `testRuns.create()` (createTestRun). */
+export interface CreateTestRunParams {
+    /** stripe (default when a Stripe test key is stored or the site uses Stripe) or generic (test coupon / test account, no time travel). */
+    type?: "stripe" | "generic";
+    /** How long to wait for each email (acknowledgment, reminders, cancellation), 15-900 seconds (default 120). */
+    email_wait_seconds?: number;
+    /** Advance a Stripe test clock through the trial end and the first renewal (default true). */
+    advance_time?: boolean;
+    /** Cancel online at the end (default true). */
+    cancel?: boolean;
+    /** State the synthetic shopper visits from (default: the site's first scan region). */
+    region?: "US-FED" | "US-AL" | "US-AK" | "US-AZ" | "US-AR" | "US-CA" | "US-CO" | "US-CT" | "US-DE" | "US-DC" | "US-FL" | "US-GA" | "US-HI" | "US-ID" | "US-IL" | "US-IN" | "US-IA" | "US-KS" | "US-KY" | "US-LA" | "US-ME" | "US-MD" | "US-MA" | "US-MI" | "US-MN" | "US-MS" | "US-MO" | "US-MT" | "US-NE" | "US-NV" | "US-NH" | "US-NJ" | "US-NM" | "US-NY" | "US-NC" | "US-ND" | "US-OH" | "US-OK" | "US-OR" | "US-PA" | "US-RI" | "US-SC" | "US-SD" | "US-TN" | "US-TX" | "US-UT" | "US-VT" | "US-VA" | "US-WA" | "US-WV" | "US-WI" | "US-WY";
+    /** Stripe options. */
+    stripe?: {
+        /** Registered checkout config (scc_…) to mirror; default: the newest one, else your latest live Checkout Session. */
+        checkout_config?: string;
+        /** A test-mode price to subscribe to when nothing is registered. */
+        price?: string;
+        /** Trial for `price` (registered configs carry their own). */
+        trial_period_days?: number;
+        /** Live price id -> test-mode price id, when they differ. */
+        price_map?: Record<string, string>;
+        /** Steps that complete your hosted checkout with card 4242 4242 4242 4242 when it differs from Stripe's default page. */
+        checkout_steps?: Array<ScanStep>;
+        /** Cancel on your own page instead of the Stripe customer portal (it must work for the test subscriber). */
+        cancel_url?: string;
+    };
+    /** Generic (non-Stripe) options. */
+    generic?: {
+        /** Checkout page (default: the site's scan settings). */
+        checkout_url?: string;
+        /** Steps to reach the final pre-payment screen. */
+        checkout_steps?: Array<ScanStep>;
+        /** Complete a real sign-up with a test coupon. */
+        complete_purchase?: {
+            /** Steps that complete a sign-up ({{email}} is the run inbox, {{promoCode}} the code). */
+            steps: Array<ScanStep>;
+            /** 100%-off test coupon (stored encrypted, never returned). */
+            promo_code?: string;
+        };
+        /** Test account used to cancel online. */
+        account?: {
+            /** Login page of the test account. */
+            login_url: string;
+            /** Test account email; "{{inbox}}" = the run inbox (use it when the sign-up creates the account). */
+            email: string;
+            /** Test account password (stored encrypted, never returned); default: the site's scan settings. */
+            password?: string;
+            /** Custom login steps. */
+            login_steps?: Array<ScanStep>;
+        };
+        /** Explicit cancellation steps (otherwise auto-discovered). */
+        cancel_steps?: Array<ScanStep>;
+    };
+}
+/** Parameters of `testRuns.list()` (listTestRuns). */
+export interface ListTestRunsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+}
+/** Parameters of `webhookEndpoints.create()` (createWebhookEndpoint). */
+export interface CreateWebhookEndpointParams {
+    /** HTTPS URL. */
+    url: string;
+    /** Event types to send, or ["*"] for all: site.score_changed, site.insurable_changed, finding.created, finding.resolved, scan.completed, scan.failed, law.changed, certificate.issued, certificate.lapsed, certificate.revoked, notice.sent, notice.due, notice.overdue, consent.created, receipt.created, test_run.completed, test_run.failed, plan.updated, site.compliant, task.verified. */
+    enabled_events: Array<string>;
+    /** Description. */
+    description?: string;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata?: Record<string, string>;
+}
+/** Parameters of `webhookEndpoints.list()` (listWebhookEndpoints). */
+export interface ListWebhookEndpointsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+}
+/** Parameters of `webhookEndpoints.update()` (updateWebhookEndpoint). */
+export interface UpdateWebhookEndpointParams {
+    /** HTTPS URL. */
+    url?: string;
+    /** Event types to send, or ["*"] for all: site.score_changed, site.insurable_changed, finding.created, finding.resolved, scan.completed, scan.failed, law.changed, certificate.issued, certificate.lapsed, certificate.revoked, notice.sent, notice.due, notice.overdue, consent.created, receipt.created, test_run.completed, test_run.failed, plan.updated, site.compliant, task.verified. */
+    enabled_events?: Array<string>;
+    /** Description (null clears it). */
+    description?: string | null;
+    /** true disables the endpoint, false enables it. */
+    disabled?: boolean;
+    /** Up to 20 key/value string pairs you can attach to the object. */
+    metadata?: Record<string, string>;
+}
+/** Parameters of `webhookEndpoints.rollSecret()` (rollWebhookEndpointSecret). */
+export type RollWebhookEndpointSecretParams = Record<string, unknown>;
+/** Parameters of `events.list()` (listEvents). */
+export interface ListEventsParams {
+    /** Number of objects to return, 1-100 (default 10). */
+    limit?: number;
+    /** Cursor: an object id; returns the objects after it (older). */
+    starting_after?: string;
+    /** Cursor: an object id; returns the objects before it (newer). */
+    ending_before?: string;
+    /** Only this type; a trailing * matches a prefix (finding.*). */
+    type?: string;
+    /** Only events created at or after this unix time. */
+    created_gte?: number | null;
+    /** Only events created at or before this unix time. */
+    created_lte?: number | null;
+}
+/** `plan.updated`: A site's compliance plan changed (its status or a task's status); data.object is the plan without task content — GET the plan and follow next_action. */
+export type PlanUpdatedEvent = Event & {
+    /** Event type. */
+    type?: "plan.updated";
+    data?: {
+        object: CompliancePlanSummary;
+        /** plan.updated: the previous status and score. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `task.verified`: A compliance-plan task verification resolved (passed or failed); data.object is the verification with expected vs observed per check. */
+export type TaskVerifiedEvent = Event & {
+    /** Event type. */
+    type?: "task.verified";
+    data?: {
+        object: Verification;
+        /** plan.updated: the previous status and score. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `notice.due`: An email the merchant sends itself ("You send" mode) reached its recommended send date: data.object is the due_notice with the window, send_at, the copy-ready email and its BCC address. Send it now (inside the window), then call markNoticeSent (or BCC the copy). required tells a legally required email from a recommended one. */
+export type NoticeDueEvent = Event & {
+    /** Event type. */
+    type?: "notice.due";
+    data?: {
+        object: Notice;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `notice.overdue`: A due_notice's window closed without proof it was sent (no markNoticeSent call, no matching BCC copy). For a required notice the compliance check fails until it is sent (late) or recorded as missed. */
+export type NoticeOverdueEvent = Event & {
+    /** Event type. */
+    type?: "notice.overdue";
+    data?: {
+        object: Notice;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `receipt.created`: A consent receipt was recorded: what a subscriber saw next to the pay button and agreed to (or, for Stripe-hosted checkouts, what Stripe recorded); data.object is the receipt. */
+export type ReceiptCreatedEvent = Event & {
+    /** Event type. */
+    type?: "receipt.created";
+    data?: {
+        object: Receipt;
+        /** Not used for receipt events. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `test_run.completed`: A lifecycle test run finished; data.object is the test_run with every step's observations, check results and fixes. */
+export type TestRunCompletedEvent = Event & {
+    /** Event type. */
+    type?: "test_run.completed";
+    data?: {
+        object: TestRun;
+        /** Not used for test_run events. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `test_run.failed`: A lifecycle test run stopped early; data.object.failure has the code, message and fix. */
+export type TestRunFailedEvent = Event & {
+    /** Event type. */
+    type?: "test_run.failed";
+    data?: {
+        object: TestRun;
+        /** Not used for test_run events. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `site.score_changed`: A site's compliance score changed (data.previous_attributes.score has the old score). */
+export type SiteScoreChangedEvent = Event & {
+    /** Event type. */
+    type?: "site.score_changed";
+    data?: {
+        object: Site;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `site.insurable_changed`: A site became insurable or stopped being insurable. */
+export type SiteInsurableChangedEvent = Event & {
+    /** Event type. */
+    type?: "site.insurable_changed";
+    data?: {
+        object: Site;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `finding.created`: A check started failing (new finding, or a resolved / passing one failing again). */
+export type FindingCreatedEvent = Event & {
+    /** Event type. */
+    type?: "finding.created";
+    data?: {
+        object: Finding;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `finding.resolved`: A failing or undecided check now passes or no longer applies. */
+export type FindingResolvedEvent = Event & {
+    /** Event type. */
+    type?: "finding.resolved";
+    data?: {
+        object: Finding;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `scan.completed`: A scan finished (the evaluation may follow in a separate site.score_changed event). */
+export type ScanCompletedEvent = Event & {
+    /** Event type. */
+    type?: "scan.completed";
+    data?: {
+        object: Scan;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `scan.failed`: A scan failed; data.object.error says why. */
+export type ScanFailedEvent = Event & {
+    /** Event type. */
+    type?: "scan.failed";
+    data?: {
+        object: Scan;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `law.changed`: A law change Checkbox applies affected one of your sites (data.object is the law update with that site's impact). */
+export type LawChangedEvent = Event & {
+    /** Event type. */
+    type?: "law.changed";
+    data?: {
+        object: LawUpdate;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `certificate.issued`: A monitoring certificate was issued. */
+export type CertificateIssuedEvent = Event & {
+    /** Event type. */
+    type?: "certificate.issued";
+    data?: {
+        object: Certificate;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `certificate.lapsed`: A certificate lapsed (the site stopped meeting the requirements). */
+export type CertificateLapsedEvent = Event & {
+    /** Event type. */
+    type?: "certificate.lapsed";
+    data?: {
+        object: Certificate;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `certificate.revoked`: A certificate was revoked. */
+export type CertificateRevokedEvent = Event & {
+    /** Event type. */
+    type?: "certificate.revoked";
+    data?: {
+        object: Certificate;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `notice.sent`: Checkbox sent a legally required notice (acknowledgment, reminder, price change) for the merchant. */
+export type NoticeSentEvent = Event & {
+    /** Event type. */
+    type?: "notice.sent";
+    data?: {
+        object: Notice;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `consent.created`: A subscriber gave affirmative consent to the automatic-renewal terms through Checkbox Elements (or your server recorded one); data.object is the consent. */
+export type ConsentCreatedEvent = Event & {
+    /** Event type. */
+    type?: "consent.created";
+    data?: {
+        object: Consent;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** `site.compliant`: A site's compliance plan became compliant: nothing is left to apply, verify or answer; data.object is the site. */
+export type SiteCompliantEvent = Event & {
+    /** Event type. */
+    type?: "site.compliant";
+    data?: {
+        object: Site;
+        /** Previous values of changed fields. */
+        previous_attributes?: Record<string, unknown>;
+    };
+};
+/** Every event Checkbox delivers to webhook endpoints, discriminated by `type`. */
+export type WebhookEvent = PlanUpdatedEvent | TaskVerifiedEvent | NoticeDueEvent | NoticeOverdueEvent | ReceiptCreatedEvent | TestRunCompletedEvent | TestRunFailedEvent | SiteScoreChangedEvent | SiteInsurableChangedEvent | FindingCreatedEvent | FindingResolvedEvent | ScanCompletedEvent | ScanFailedEvent | LawChangedEvent | CertificateIssuedEvent | CertificateLapsedEvent | CertificateRevokedEvent | NoticeSentEvent | ConsentCreatedEvent | SiteCompliantEvent;
+/** Every webhook event type. */
+export declare const WEBHOOK_EVENT_TYPES: readonly ["plan.updated", "task.verified", "notice.due", "notice.overdue", "receipt.created", "test_run.completed", "test_run.failed", "site.score_changed", "site.insurable_changed", "finding.created", "finding.resolved", "scan.completed", "scan.failed", "law.changed", "certificate.issued", "certificate.lapsed", "certificate.revoked", "notice.sent", "consent.created", "site.compliant"];
+export type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
+/** Stable error codes (`error.code`), with HTTP status, type and meaning. Codes are never renamed. */
+export declare const ERROR_CODES: {
+    readonly parameter_invalid: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "A parameter has an invalid value; `param` names it.";
+    };
+    readonly parameter_missing: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "A required parameter is missing; `param` names it.";
+    };
+    readonly parameter_unknown: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "The request has a parameter this endpoint does not accept.";
+    };
+    readonly body_invalid_json: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "The request body is not valid JSON.";
+    };
+    readonly url_not_allowed: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "A URL points to a private, local or otherwise unreachable address.";
+    };
+    readonly api_version_invalid: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "The Checkbox-Version header names an unknown API version.";
+    };
+    readonly idempotency_key_invalid: {
+        readonly status: 400;
+        readonly type: "idempotency_error";
+        readonly description: "The Idempotency-Key header is empty or longer than 255 characters.";
+    };
+    readonly idempotency_key_reused: {
+        readonly status: 400;
+        readonly type: "idempotency_error";
+        readonly description: "The Idempotency-Key was already used with different parameters within 24 hours.";
+    };
+    readonly test_key_missing: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "A Stripe test run needs a Stripe TEST-mode key stored for the site (createTestCredential).";
+    };
+    readonly test_key_not_test_mode: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "The billing key is a live-mode (or malformed) key; test runs only accept test-mode keys (rk_test_… / sk_test_…).";
+    };
+    readonly test_key_rejected: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "Stripe rejected the test-mode key or it lacks a permission test runs need; `message` names it.";
+    };
+    readonly authorization_pending: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "Device login: the human has not approved yet. Keep polling createDeviceToken every `interval` seconds.";
+    };
+    readonly slow_down: {
+        readonly status: 400;
+        readonly type: "rate_limit_error";
+        readonly description: "Device login: polling too fast. Add 5 seconds to the interval and keep polling.";
+    };
+    readonly expired_token: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "Device login: the device code expired (15 minutes) or was already used. Start again with createDeviceAuthorization.";
+    };
+    readonly device_code_invalid: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "Device login: the device code is unknown.";
+    };
+    readonly access_denied: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "Device login: the human clicked Deny. Do not retry without asking them.";
+    };
+    readonly api_key_missing: {
+        readonly status: 401;
+        readonly type: "authentication_error";
+        readonly description: "No API key was provided (Authorization: Bearer ck_…).";
+    };
+    readonly api_key_invalid: {
+        readonly status: 401;
+        readonly type: "authentication_error";
+        readonly description: "The API key is unknown, revoked or expired.";
+    };
+    readonly publishable_key_not_allowed: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "A publishable key (pk_…) cannot call this endpoint; use a secret key on your server.";
+    };
+    readonly origin_not_allowed: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "A publishable-key request came from a page (Origin) that is not on one of the site's domains (base URL or checkout URL).";
+    };
+    readonly insufficient_scope: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "The restricted key lacks the scope this endpoint needs.";
+    };
+    readonly insufficient_role: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "The key (or the person who created it) does not have a role that allows this action.";
+    };
+    readonly account_not_activated: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "Live mode needs an activated account: verify the domain of one of your sites (or use a test key).";
+    };
+    readonly test_mode_domain_unverified: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "Test mode only scans, monitors, fetches and test-runs localhost or domains the account has verified; verify the domain (createDomainVerification) or send the HTML instead.";
+    };
+    readonly test_mode_scan_budget_exhausted: {
+        readonly status: 429;
+        readonly type: "rate_limit_error";
+        readonly description: "No longer returned (round 6): test mode has no scan budget for unverified domains any more, they are refused with test_mode_domain_unverified. Kept so older clients still recognise the code.";
+    };
+    readonly domain_not_verified: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "Checkbox only scans, monitors, fetches and test-runs websites the account has verified (DNS TXT record or /.well-known file): every target host (site, checkout, account and policy URLs) must be on a verified domain. `next_action` says which domain to verify.";
+    };
+    readonly account_suspended: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "The account was suspended by Checkbox staff; contact support.";
+    };
+    readonly resource_missing: {
+        readonly status: 404;
+        readonly type: "invalid_request_error";
+        readonly description: "No object with this id exists in this mode of the account.";
+    };
+    readonly route_not_found: {
+        readonly status: 404;
+        readonly type: "invalid_request_error";
+        readonly description: "No such endpoint. See /v1/openapi.json for the list.";
+    };
+    readonly resource_conflict: {
+        readonly status: 409;
+        readonly type: "invalid_request_error";
+        readonly description: "The object is in a state that does not allow this action.";
+    };
+    readonly scan_already_queued: {
+        readonly status: 409;
+        readonly type: "invalid_request_error";
+        readonly description: "A scan of this site is already queued or running.";
+    };
+    readonly consent_reference_locked: {
+        readonly status: 409;
+        readonly type: "invalid_request_error";
+        readonly description: "The consent already carries a different customer_reference; references are set once and never changed.";
+    };
+    readonly test_run_in_progress: {
+        readonly status: 409;
+        readonly type: "invalid_request_error";
+        readonly description: "The site already has a queued or running test run; wait for it (retrieveTestRun) or cancel it (cancelTestRun).";
+    };
+    readonly idempotency_key_in_use: {
+        readonly status: 409;
+        readonly type: "idempotency_error";
+        readonly description: "A request with this Idempotency-Key is still being processed; retry shortly.";
+    };
+    readonly resource_archived: {
+        readonly status: 410;
+        readonly type: "invalid_request_error";
+        readonly description: "The object is archived; restore it before changing it.";
+    };
+    readonly body_too_large: {
+        readonly status: 413;
+        readonly type: "invalid_request_error";
+        readonly description: "The request body is too large.";
+    };
+    readonly content_type_unsupported: {
+        readonly status: 415;
+        readonly type: "invalid_request_error";
+        readonly description: "Send JSON bodies with Content-Type: application/json.";
+    };
+    readonly site_limit_reached: {
+        readonly status: 403;
+        readonly type: "invalid_request_error";
+        readonly description: "The account reached its fair-use site limit (default 25); contact support to raise it.";
+    };
+    readonly webhook_endpoint_limit_reached: {
+        readonly status: 403;
+        readonly type: "invalid_request_error";
+        readonly description: "The account reached the maximum number of webhook endpoints (16 per mode).";
+    };
+    readonly plan_required: {
+        readonly status: 402;
+        readonly type: "invalid_request_error";
+        readonly description: "Only when billing is enabled on this deployment: the feature needs a paid plan.";
+    };
+    readonly rate_limit_exceeded: {
+        readonly status: 429;
+        readonly type: "rate_limit_error";
+        readonly description: "Too many requests; slow down and retry after the Retry-After header.";
+    };
+    readonly receipts_disabled: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "Consent receipts are turned off for this account (updateReceiptSettings enabled=true turns them on).";
+    };
+    readonly feature_unavailable: {
+        readonly status: 503;
+        readonly type: "api_error";
+        readonly description: "The feature is not configured on this deployment (for example the database migration is missing).";
+    };
+    readonly internal_error: {
+        readonly status: 500;
+        readonly type: "api_error";
+        readonly description: "Something went wrong on Checkbox's side. Retrying with the same Idempotency-Key is safe.";
+    };
+};
+export type ErrorCode = keyof typeof ERROR_CODES;
+/** A downloaded file (evidence content). */
+export interface CheckboxFile {
+    /** Raw bytes. */
+    data: Uint8Array;
+    /** Content-Type of the response. */
+    contentType: string | null;
+    /** Content-Disposition file name, when given. */
+    filename: string | null;
+}