@checkbox-site/node 0.2.0 → 0.2.2

package/dist/client.d.ts

@@ -45,7 +45,7 @@ export interface Checkbox extends ResourceInstances {
  */
 export declare class Checkbox implements RequestSender {
     #private;
-    static readonly VERSION = "0.2.0";
+    static readonly VERSION = "0.2.2";
     static readonly API_VERSION = "2026-10-30";
     static readonly errors: typeof errors;
     static readonly webhooks: Webhooks;
@@ -900,6 +900,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Revoke a certificate";
         };
+        readonly listNoticeSends: {
+            readonly operationId: "listNoticeSends";
+            readonly namespace: "noticeSends";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/notice_sends";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["limit", "kind", "subscription", "include_samples"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "notices:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: false;
+            readonly summary: "List Checkbox Notices sends";
+        };
         readonly retrieveNoticeSettings: {
             readonly operationId: "retrieveNoticeSettings";
             readonly namespace: "noticeSettings";

package/dist/generated/operations.d.ts

@@ -852,6 +852,23 @@ export declare const OPERATIONS: {
         readonly paginated: false;
         readonly summary: "Revoke a certificate";
     };
+    readonly listNoticeSends: {
+        readonly operationId: "listNoticeSends";
+        readonly namespace: "noticeSends";
+        readonly method: "list";
+        readonly httpMethod: "GET";
+        readonly path: "/v1/sites/{site}/notice_sends";
+        readonly pathParams: readonly ["site"];
+        readonly queryParams: readonly ["limit", "kind", "subscription", "include_samples"];
+        readonly body: false;
+        readonly idempotent: false;
+        readonly auth: true;
+        readonly scope: "notices:read";
+        readonly response: "json";
+        readonly list: true;
+        readonly paginated: false;
+        readonly summary: "List Checkbox Notices sends";
+    };
     readonly retrieveNoticeSettings: {
         readonly operationId: "retrieveNoticeSettings";
         readonly namespace: "noticeSettings";
@@ -2150,6 +2167,12 @@ export interface OperationTypes {
         } & T.RevokeCertificateParams;
         response: T.Certificate;
     };
+    listNoticeSends: {
+        args: {
+            site: string;
+        } & T.ListNoticeSendsParams;
+        response: T.NoticeSendList;
+    };
     retrieveNoticeSettings: {
         args: {
             site: string;
@@ -2607,7 +2630,7 @@ export declare class SitesResource extends Resource {
     /**
      * Connect a billing platform.
      *
-     * Connects the site's billing platform with read-only credentials (a Stripe restricted key, a Recharge token, a Shopify Admin API token, a Chargebee read-only API key, a Recurly private API key or a Paddle API key with read permissions), so Checkbox reads the customer-portal and reminder settings. Works for test-mode sites too (use an rk_test_ key). The credentials are validated by reading the settings once and stored encrypted.
+     * Connects the site's billing platform with the one restricted key (a Stripe restricted key, a Recharge token, a Shopify Admin API token, a Chargebee read-only API key, a Recurly private API key or a Paddle API key with read permissions), so Checkbox reads the customer-portal and reminder settings. Stripe: One Stripe restricted key per site: Read permissions for the checks, and Write permissions that Checkbox uses only after you click Approve on a fix, or in test mode (the one exception: Webhook Endpoints, used once to add Checkbox's webhook endpoint when you connect the key) (checklist: https://checkbox.site/docs/guides/stripe-key). A full secret key (sk_test_ / sk_live_) is refused on every path with test_key_not_restricted: use a restricted key. API keys and AI agents may connect TEST-mode keys (rk_test_…) only; a live key (rk_live_ / sk_live_) is refused with live_key_requires_dashboard, because only a person signed in to the Checkbox dashboard can connect one. The credentials are validated by reading the settings once and stored encrypted. When the key's Stripe account looks like another site's (the site's prices or Payment Links are not in it, or it is already connected in another workspace), nothing is connected and the error billing_account_mismatch asks the human to confirm; retry with confirm_account_mismatch: true only after they said yes; the key is then held until a person confirms the account in the dashboard (an agent cannot confirm it). The account owner is emailed about every key connected.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/integrations (operation `connectBillingPlatform`, scope `sites:write`)
@@ -2939,6 +2962,18 @@ export declare class CertificatesResource extends Resource {
      */
     revoke(certificate: string, params: T.RevokeCertificateParams, options?: RequestOptions): Promise<T.Certificate>;
 }
+/** `checkbox.noticeSends` */
+export declare class NoticeSendsResource extends Resource {
+    /**
+     * List Checkbox Notices sends.
+     *
+     * Read-only: the emails Checkbox Notices sent, or tried to send, for this site (newest first), with status and, for a failed or skipped send, why. A test run's email steps name these rows (notices_send_log). Samples ("Send a test") are left out unless include_samples=true.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @see GET /v1/sites/{site}/notice_sends (operation `listNoticeSends`, scope `notices:read`)
+     */
+    list(site: string, params?: T.ListNoticeSendsParams, options?: RequestOptions): Promise<T.NoticeSendList>;
+}
 /** `checkbox.noticeSettings` */
 export declare class NoticeSettingsResource extends Resource {
     /**
@@ -2953,7 +2988,7 @@ export declare class NoticeSettingsResource extends Resource {
     /**
      * Update notice settings.
      *
-     * Chooses who sends the required emails (mode: merchant = you send them and Checkbox tracks them, the default; checkbox = Checkbox sends them), and sets branding, cancel_url and the confirmed cancellation policy. add_kinds / remove_kinds turn single notices on or off and leave the others as they are; enabled_kinds replaces the whole list. In checkbox mode, turning a notice on requires cancel_url, a confirmed policy, a connected Stripe, Recharge, Chargebee, Recurly or Paddle account and a sending address; otherwise resource_conflict explains what is missing.
+     * Chooses who sends the required emails (mode: merchant = you send them and Checkbox tracks them, the default; checkbox = Checkbox sends them), and sets branding, cancel_url and the confirmed cancellation policy. add_kinds / remove_kinds turn single notices on or off and leave the others as they are; enabled_kinds replaces the whole list. In checkbox mode, turning a notice on requires cancel_url, a confirmed policy, a support email, a connected Stripe, Recharge, Chargebee, Recurly or Paddle account and a sending address; otherwise resource_conflict explains what is missing. The support email may be the Stripe account's public one (used automatically); the account owner's login address only after the human confirms it in the dashboard (support_email_to_confirm; an agent cannot confirm it). Turning notices on through the API never emails a real subscriber: on a test-mode site only test-run inboxes (and marked test copies to the owner) are emailed, and on a live site real subscribers are emailed only after a person confirms it once in the dashboard, after a preview (real_sends). The account owner is emailed when an agent turns notices on.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/notice_settings (operation `updateNoticeSettings`, scope `notices:write`, live mode needs an activated account)
@@ -2965,7 +3000,7 @@ export declare class NoticesResource extends Resource {
     /**
      * List due notices.
      *
-     * The legally required emails you owe subscribers (sites in "You send" mode, the default): kind, the subscriber (billing-platform ids), the legal window for the subscriber's state, the recommended send date, the copy-ready email and the BCC address. Default: everything not yet sent (upcoming, due, overdue), soonest first. Live keys list live subscribers' notices, test keys test-mode ones. Send each one on its send_date (inside its window), then call markNoticeSent (or BCC the notice's bcc address). Subscribe to the notice.due webhook to get each one on its send date.
+     * The legally required emails you owe subscribers (sites in "You send" mode, the default): kind, the subscriber (billing-platform ids), the legal window for the subscriber's state, the recommended send date, the email (ready to send once email.missing_fields is empty) and the BCC address. Default: everything not yet sent (upcoming, due, overdue), soonest first. Live keys list live subscribers' notices, test keys test-mode ones. Send each one on its send_date (inside its window), then call markNoticeSent (or BCC the notice's bcc address). Subscribe to the notice.due webhook to get each one on its send date.
      *
      * @see GET /v1/notices/due (operation `listDueNotices`, scope `notices:read`)
      */
@@ -2989,7 +3024,7 @@ export declare class NoticesResource extends Resource {
     /**
      * Retrieve a due notice.
      *
-     * One notice you owe a subscriber, with its window, recommended send date, copy-ready email, BCC address and send status.
+     * One notice you owe a subscriber, with its window, recommended send date, email (ready to send once email.missing_fields is empty), BCC address and send status.
      *
      * @param notice Unique identifier of the due notice (ntd_…).
      * @see GET /v1/notices/{notice} (operation `retrieveDueNotice`, scope `notices:read`)
@@ -3063,7 +3098,7 @@ export declare class ChecksResource extends Resource {
     /**
      * Check a subscription lifecycle email.
      *
-     * Checks the content of an acknowledgment (welcome) email, trial-ending reminder, renewal reminder, price-change notice, yearly terms reminder or cancellation confirmation against the requirements for that notice (renewal terms, amount, frequency, how to cancel, trial cancellation). The email is modelled as sent on time, so the verdict is about content; get send dates from checkNoticeSchedule. Prices are judged against what Stripe charges: with `site` (or, without it, the account's one site with Stripe connected) the plan fields come from the site's plans and the email is matched to the plan it names ("Annual") first; a price that contradicts it fails, and `warnings` say which site and plan were used. Returns `required_by` (requirements that make the email mandatory for this plan) and a `template` that passes the checks, with {{merge_tags}}, verified by the engine. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
+     * Checks the content of an acknowledgment (welcome) email, trial-ending reminder, renewal reminder, price-change notice, yearly terms reminder or cancellation confirmation against the requirements for that notice (renewal terms, amount, frequency, how to cancel, trial cancellation). The email is modelled as sent on time, so the verdict is about content; get send dates from checkNoticeSchedule. Prices are judged against what Stripe charges: with `site` (or, without it and without a price in terms, the account's one site with Stripe connected) the plan fields come from the site's plans and the email is matched to the plan it names ("Annual") first; a price that contradicts it fails, and `warnings` say which site and plan were used. Without `site`, a price you send in terms is judged as sent; when it differs from every plan of that site, the result is at most needs_review and Next is update_setup (update the site's plans first). Returns `required_by` (requirements that make the email mandatory for this plan) and a `template` that passes the checks, with {{merge_tags}}, verified by the engine. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
      *
      * @see POST /v1/checks/email (operation `checkEmail`, scope `checks:read`)
      */
@@ -3288,7 +3323,7 @@ export declare class TestCredentialsResource extends Resource {
     /**
      * Store a billing test-mode key.
      *
-     * Stores the site's Stripe TEST-mode key (rk_test_… preferred) used by test runs, after checking it with Stripe. Live keys are refused (test_key_not_test_mode). Least privilege: Write on Customers, Checkout Sessions, Subscriptions, Test clocks and Customer portal; Read on Prices, Products and Billing portal configuration. Replaces an existing key. Next: createTestRun.
+     * Stores the site's Stripe TEST-mode restricted key (rk_test_…), after checking it with Stripe the way the dashboard's Connect Stripe does. An agent may call this itself once the owner approved the setup; every store is logged on the site's setup timeline and Billing connection line, and the human can revoke it in one click. Live keys are refused (test_key_not_test_mode: a human adds live keys in the dashboard); the owner must have ticked "Let your agent store a Stripe test-mode key" on the approval page of the agent's sign-in or connection (else test_key_declined); a key whose Stripe account looks like another site's is refused with billing_account_mismatch (with confirm_account_mismatch: true the key is connected on hold until a person confirms the account in the dashboard; only a person can confirm it); secret keys (sk_test_…) are refused (test_key_not_restricted). On a test-mode site without a Stripe connection the key also becomes the site's Stripe connection: one key for checks, fixes (only after the human approves each) and test runs. The key's checklist: Customers: Write, Products: Read, Prices: Read, Coupons: Read, Subscriptions: Write, Test clocks: Write, Customer portal: Write, Checkout Sessions: Write, Payment Links: Write, Webhook Endpoints: Write. Replaces an existing key. Next: createTestRun.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/test_credentials (operation `createTestCredential`, scope `test_runs:write`)
@@ -3528,6 +3563,7 @@ export declare const RESOURCES: {
     readonly fixes: typeof FixesResource;
     readonly evidence: typeof EvidenceResource;
     readonly certificates: typeof CertificatesResource;
+    readonly noticeSends: typeof NoticeSendsResource;
     readonly noticeSettings: typeof NoticeSettingsResource;
     readonly notices: typeof NoticesResource;
     readonly lawUpdates: typeof LawUpdatesResource;

package/dist/generated/operations.js

@@ -851,6 +851,23 @@ export const OPERATIONS = {
         paginated: false,
         summary: "Revoke a certificate",
     },
+    listNoticeSends: {
+        operationId: "listNoticeSends",
+        namespace: "noticeSends",
+        method: "list",
+        httpMethod: "GET",
+        path: "/v1/sites/{site}/notice_sends",
+        pathParams: ["site"],
+        queryParams: ["limit", "kind", "subscription", "include_samples"],
+        body: false,
+        idempotent: false,
+        auth: true,
+        scope: "notices:read",
+        response: "json",
+        list: true,
+        paginated: false,
+        summary: "List Checkbox Notices sends",
+    },
     retrieveNoticeSettings: {
         operationId: "retrieveNoticeSettings",
         namespace: "noticeSettings",
@@ -2041,7 +2058,7 @@ export class SitesResource extends Resource {
     /**
      * Connect a billing platform.
      *
-     * Connects the site's billing platform with read-only credentials (a Stripe restricted key, a Recharge token, a Shopify Admin API token, a Chargebee read-only API key, a Recurly private API key or a Paddle API key with read permissions), so Checkbox reads the customer-portal and reminder settings. Works for test-mode sites too (use an rk_test_ key). The credentials are validated by reading the settings once and stored encrypted.
+     * Connects the site's billing platform with the one restricted key (a Stripe restricted key, a Recharge token, a Shopify Admin API token, a Chargebee read-only API key, a Recurly private API key or a Paddle API key with read permissions), so Checkbox reads the customer-portal and reminder settings. Stripe: One Stripe restricted key per site: Read permissions for the checks, and Write permissions that Checkbox uses only after you click Approve on a fix, or in test mode (the one exception: Webhook Endpoints, used once to add Checkbox's webhook endpoint when you connect the key) (checklist: https://checkbox.site/docs/guides/stripe-key). A full secret key (sk_test_ / sk_live_) is refused on every path with test_key_not_restricted: use a restricted key. API keys and AI agents may connect TEST-mode keys (rk_test_…) only; a live key (rk_live_ / sk_live_) is refused with live_key_requires_dashboard, because only a person signed in to the Checkbox dashboard can connect one. The credentials are validated by reading the settings once and stored encrypted. When the key's Stripe account looks like another site's (the site's prices or Payment Links are not in it, or it is already connected in another workspace), nothing is connected and the error billing_account_mismatch asks the human to confirm; retry with confirm_account_mismatch: true only after they said yes; the key is then held until a person confirms the account in the dashboard (an agent cannot confirm it). The account owner is emailed about every key connected.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/integrations (operation `connectBillingPlatform`, scope `sites:write`)
@@ -2441,6 +2458,20 @@ export class CertificatesResource extends Resource {
         return this._request(OPERATIONS.revokeCertificate, [certificate], params, options);
     }
 }
+/** `checkbox.noticeSends` */
+export class NoticeSendsResource extends Resource {
+    /**
+     * List Checkbox Notices sends.
+     *
+     * Read-only: the emails Checkbox Notices sent, or tried to send, for this site (newest first), with status and, for a failed or skipped send, why. A test run's email steps name these rows (notices_send_log). Samples ("Send a test") are left out unless include_samples=true.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @see GET /v1/sites/{site}/notice_sends (operation `listNoticeSends`, scope `notices:read`)
+     */
+    list(site, params, options) {
+        return this._request(OPERATIONS.listNoticeSends, [site], params, options);
+    }
+}
 /** `checkbox.noticeSettings` */
 export class NoticeSettingsResource extends Resource {
     /**
@@ -2457,7 +2488,7 @@ export class NoticeSettingsResource extends Resource {
     /**
      * Update notice settings.
      *
-     * Chooses who sends the required emails (mode: merchant = you send them and Checkbox tracks them, the default; checkbox = Checkbox sends them), and sets branding, cancel_url and the confirmed cancellation policy. add_kinds / remove_kinds turn single notices on or off and leave the others as they are; enabled_kinds replaces the whole list. In checkbox mode, turning a notice on requires cancel_url, a confirmed policy, a connected Stripe, Recharge, Chargebee, Recurly or Paddle account and a sending address; otherwise resource_conflict explains what is missing.
+     * Chooses who sends the required emails (mode: merchant = you send them and Checkbox tracks them, the default; checkbox = Checkbox sends them), and sets branding, cancel_url and the confirmed cancellation policy. add_kinds / remove_kinds turn single notices on or off and leave the others as they are; enabled_kinds replaces the whole list. In checkbox mode, turning a notice on requires cancel_url, a confirmed policy, a support email, a connected Stripe, Recharge, Chargebee, Recurly or Paddle account and a sending address; otherwise resource_conflict explains what is missing. The support email may be the Stripe account's public one (used automatically); the account owner's login address only after the human confirms it in the dashboard (support_email_to_confirm; an agent cannot confirm it). Turning notices on through the API never emails a real subscriber: on a test-mode site only test-run inboxes (and marked test copies to the owner) are emailed, and on a live site real subscribers are emailed only after a person confirms it once in the dashboard, after a preview (real_sends). The account owner is emailed when an agent turns notices on.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/notice_settings (operation `updateNoticeSettings`, scope `notices:write`, live mode needs an activated account)
@@ -2471,7 +2502,7 @@ export class NoticesResource extends Resource {
     /**
      * List due notices.
      *
-     * The legally required emails you owe subscribers (sites in "You send" mode, the default): kind, the subscriber (billing-platform ids), the legal window for the subscriber's state, the recommended send date, the copy-ready email and the BCC address. Default: everything not yet sent (upcoming, due, overdue), soonest first. Live keys list live subscribers' notices, test keys test-mode ones. Send each one on its send_date (inside its window), then call markNoticeSent (or BCC the notice's bcc address). Subscribe to the notice.due webhook to get each one on its send date.
+     * The legally required emails you owe subscribers (sites in "You send" mode, the default): kind, the subscriber (billing-platform ids), the legal window for the subscriber's state, the recommended send date, the email (ready to send once email.missing_fields is empty) and the BCC address. Default: everything not yet sent (upcoming, due, overdue), soonest first. Live keys list live subscribers' notices, test keys test-mode ones. Send each one on its send_date (inside its window), then call markNoticeSent (or BCC the notice's bcc address). Subscribe to the notice.due webhook to get each one on its send date.
      *
      * @see GET /v1/notices/due (operation `listDueNotices`, scope `notices:read`)
      */
@@ -2501,7 +2532,7 @@ export class NoticesResource extends Resource {
     /**
      * Retrieve a due notice.
      *
-     * One notice you owe a subscriber, with its window, recommended send date, copy-ready email, BCC address and send status.
+     * One notice you owe a subscriber, with its window, recommended send date, email (ready to send once email.missing_fields is empty), BCC address and send status.
      *
      * @param notice Unique identifier of the due notice (ntd_…).
      * @see GET /v1/notices/{notice} (operation `retrieveDueNotice`, scope `notices:read`)
@@ -2591,7 +2622,7 @@ export class ChecksResource extends Resource {
     /**
      * Check a subscription lifecycle email.
      *
-     * Checks the content of an acknowledgment (welcome) email, trial-ending reminder, renewal reminder, price-change notice, yearly terms reminder or cancellation confirmation against the requirements for that notice (renewal terms, amount, frequency, how to cancel, trial cancellation). The email is modelled as sent on time, so the verdict is about content; get send dates from checkNoticeSchedule. Prices are judged against what Stripe charges: with `site` (or, without it, the account's one site with Stripe connected) the plan fields come from the site's plans and the email is matched to the plan it names ("Annual") first; a price that contradicts it fails, and `warnings` say which site and plan were used. Returns `required_by` (requirements that make the email mandatory for this plan) and a `template` that passes the checks, with {{merge_tags}}, verified by the engine. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
+     * Checks the content of an acknowledgment (welcome) email, trial-ending reminder, renewal reminder, price-change notice, yearly terms reminder or cancellation confirmation against the requirements for that notice (renewal terms, amount, frequency, how to cancel, trial cancellation). The email is modelled as sent on time, so the verdict is about content; get send dates from checkNoticeSchedule. Prices are judged against what Stripe charges: with `site` (or, without it and without a price in terms, the account's one site with Stripe connected) the plan fields come from the site's plans and the email is matched to the plan it names ("Annual") first; a price that contradicts it fails, and `warnings` say which site and plan were used. Without `site`, a price you send in terms is judged as sent; when it differs from every plan of that site, the result is at most needs_review and Next is update_setup (update the site's plans first). Returns `required_by` (requirements that make the email mandatory for this plan) and a `template` that passes the checks, with {{merge_tags}}, verified by the engine. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
      *
      * @see POST /v1/checks/email (operation `checkEmail`, scope `checks:read`)
      */
@@ -2864,7 +2895,7 @@ export class TestCredentialsResource extends Resource {
     /**
      * Store a billing test-mode key.
      *
-     * Stores the site's Stripe TEST-mode key (rk_test_… preferred) used by test runs, after checking it with Stripe. Live keys are refused (test_key_not_test_mode). Least privilege: Write on Customers, Checkout Sessions, Subscriptions, Test clocks and Customer portal; Read on Prices, Products and Billing portal configuration. Replaces an existing key. Next: createTestRun.
+     * Stores the site's Stripe TEST-mode restricted key (rk_test_…), after checking it with Stripe the way the dashboard's Connect Stripe does. An agent may call this itself once the owner approved the setup; every store is logged on the site's setup timeline and Billing connection line, and the human can revoke it in one click. Live keys are refused (test_key_not_test_mode: a human adds live keys in the dashboard); the owner must have ticked "Let your agent store a Stripe test-mode key" on the approval page of the agent's sign-in or connection (else test_key_declined); a key whose Stripe account looks like another site's is refused with billing_account_mismatch (with confirm_account_mismatch: true the key is connected on hold until a person confirms the account in the dashboard; only a person can confirm it); secret keys (sk_test_…) are refused (test_key_not_restricted). On a test-mode site without a Stripe connection the key also becomes the site's Stripe connection: one key for checks, fixes (only after the human approves each) and test runs. The key's checklist: Customers: Write, Products: Read, Prices: Read, Coupons: Read, Subscriptions: Write, Test clocks: Write, Customer portal: Write, Checkout Sessions: Write, Payment Links: Write, Webhook Endpoints: Write. Replaces an existing key. Next: createTestRun.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/test_credentials (operation `createTestCredential`, scope `test_runs:write`)
@@ -3156,6 +3187,7 @@ export const RESOURCES = {
     fixes: FixesResource,
     evidence: EvidenceResource,
     certificates: CertificatesResource,
+    noticeSends: NoticeSendsResource,
     noticeSettings: NoticeSettingsResource,
     notices: NoticesResource,
     lawUpdates: LawUpdatesResource,

package/dist/generated/types.d.ts

@@ -161,7 +161,7 @@ export interface DeviceToken {
     site: string | null;
     /** What the human approved. */
     consents: {
-        /** The human allowed Checkbox to use the project's Stripe TEST key (send it with createTestCredential). */
+        /** The human allowed Checkbox to use the project's Stripe TEST key (store it with createTestCredential; it must be a restricted rk_test_ key). */
         stripe_test_key: boolean;
         /** Live keys were issued. */
         live_keys: boolean;
@@ -336,7 +336,7 @@ export interface SetupSession {
     discovered: Record<string, string>;
     /** Install details. */
     install: {
-        /** The exact tag to put in <head> on every page. */
+        /** The exact tag to put in <head> of the homepage, pricing, checkout / sign-up and account pages (not needed on every page). */
         script_tag: string | null;
         /** The site's public snippet key: the data-key of script_tag (and the local part of inbound_email). Use only this key in the snippet tag. */
         snippet_key: string | null;
@@ -388,7 +388,7 @@ export interface SetupSession {
     }>;
     /** Stripe test mode for lifecycle test runs. */
     stripe: {
-        /** Whether the human allowed Checkbox to use the project's Stripe TEST key for synthetic subscriptions. */
+        /** Whether the human ticked “Let your agent store a Stripe test-mode key” on the approval page (device login or OAuth connection). False: the agent may not store one (createTestCredential answers test_key_declined); the human adds it in the dashboard. Sessions started with a key the human made in the dashboard: true. */
         test_key_consent: boolean;
         /** Hint of the key the CLI found (never the key). */
         test_key_hint: string | null;
@@ -398,18 +398,20 @@ export interface SetupSession {
         checkout_configs: number;
         /** Restricted-key recommendation. */
         restricted_key: {
-            /** true while no restricted (rk_test_) key is stored. */
+            /** true while no restricted (rk_test_) key is stored. The agent stores it with createTestCredential. */
             recommended: boolean;
             /** Why. */
             reason: string;
             /** Where to create it. */
             create_url: string;
-            /** Least-privilege permissions. */
+            /** The one key checklist: every permission Checkbox uses (checks, fixes after the human approves, test runs). */
             permissions: Array<{
-                /** Stripe resource. */
+                /** Stripe resource, as the restricted-key screen names it. */
                 resource: string;
-                /** Access. */
+                /** Access to tick (write includes read). */
                 access: "read" | "write";
+                /** One line: why Checkbox needs it. */
+                why?: string;
             }>;
         };
     };
@@ -551,8 +553,8 @@ export interface SetupSessionUpdate {
     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";
+    /** Billing platform. lemon_squeezy: Checkbox checks your pages and emails (no billing connection). */
+    billing_platform?: "stripe" | "shopify" | "recharge" | "chargebee" | "recurly" | "paddle" | "lemon_squeezy" | "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. */
@@ -627,7 +629,7 @@ export interface SetupVerification {
     scan: {
         /** Whether a scan was queued now. */
         queued: boolean;
-        /** The queued scan (scan_…); with reason "already scanned", the newest scan (read it with retrieveScan). */
+        /** The queued scan (scan_…); with a reason, the scan still in progress ("a scan is running/queued": wait for it) or, with "already scanned", the newest scan (read it with retrieveScan). */
         scan: string | null;
         /** Why not. */
         reason: string | null;
@@ -760,6 +762,19 @@ export interface LegalHoldParams {
     /** Note stored with the hold (who asked, matter). */
     reason?: string;
 }
+/** An introductory price or coupon for one billing price (the same as Site settings → Your offer → Introductory price or coupon). */
+export interface SiteIntroOffer {
+    /** The billing-platform price the intro applies to (e.g. a Stripe price id). */
+    price_id: string;
+    /** The intro price per billing period, in minor units (900 = $9.00). Give exactly one of intro_amount, intro_percent_off or intro_amount_off. */
+    intro_amount?: number;
+    /** A coupon: percent off the regular price. */
+    intro_percent_off?: number;
+    /** A coupon: amount off per billing period, in minor units. */
+    intro_amount_off?: number;
+    /** How many billing periods the intro price lasts (default 1). */
+    intro_periods?: number;
+}
 /** Business facts that decide which legal requirements apply. */
 export interface SiteFacts {
     /** The offer starts with a free trial. */
@@ -782,6 +797,8 @@ export interface SiteFacts {
     payment_methods?: Array<"card" | "debit" | "ach" | "wallet" | "other">;
     /** Where shoppers pay and consent. stripe_checkout / payment_link: your pages redirect to a Stripe-hosted page, so consent is checked on Stripe (consent_collection and custom_text of your registered Checkout configs or Payment Links), and your pricing page needs no checkbox of its own. Unset: detected from pay buttons that link to checkout.stripe.com / buy.stripe.com. */
     checkout_type?: "own_page" | "stripe_checkout" | "payment_link";
+    /** Introductory prices or coupons per billing price (Site settings → Your offer). Every check, the plan, the Emails-tab templates and generated disclosures compare stated promos with them. Omit to keep the stored ones; [] clears them. A coupon must also exist in your live Stripe account before live sales. */
+    intro_offers?: Array<SiteIntroOffer>;
 }
 /** Scheduled monitoring. */
 export interface SiteMonitoring {
@@ -887,7 +904,7 @@ export type SiteCompliance = {
 } | null;
 /** What to install on the merchant site. */
 export interface SiteInstall {
-    /** Paste into the <head> of every page (or let `checkbox init` do it). */
+    /** Paste into the <head> of the homepage, pricing, checkout / sign-up and account pages (or let `checkbox init` do it). It sends only the renewal-relevant blocks of a page. */
     script_tag: string;
     /** Public key of the snippet (also the inbound email local part). */
     snippet_key: string;
@@ -1278,8 +1295,10 @@ export interface Integration {
 export interface ConnectBillingPlatformParams {
     /** Billing platform. */
     platform: "stripe" | "recharge" | "shopify" | "chargebee" | "recurly" | "paddle";
-    /** Read-only credentials, in snake_case like the rest of the API (the camelCase spellings, secretKey / apiToken / accessToken / apiKey, are accepted too). Stripe: { "secret_key": "rk_test_…" } (a restricted key with read access; rk_test_ in test mode). Recharge: { "api_token": "…" }. Shopify: { "shop": "store.myshopify.com", "access_token": "shpat_…" }. Chargebee: { "site": "acme", "api_key": "live_…" } (the site name before .chargebee.com and a read-only API key). Recurly: { "api_key": "…", "region": "us" } (a private API key of the site; region "eu" for sites hosted in Recurly’s EU data centre, default "us"). Paddle: { "api_key": "pdl_live_apikey_…" } (a Paddle Billing API key with read permissions; sandbox keys, pdl_sdbx_…, read the sandbox; "environment": "live" or "sandbox" only for older keys without that prefix). Checkbox only reads. */
+    /** Credentials, in snake_case like the rest of the API (the camelCase spellings, secretKey / apiToken / accessToken / apiKey, are accepted too). Stripe: { "secret_key": "rk_test_…" } (rk_test_ in test mode). One Stripe restricted key per site: Read permissions for the checks, and Write permissions that Checkbox uses only after you click Approve on a fix, or in test mode (the one exception: Webhook Endpoints, used once to add Checkbox's webhook endpoint when you connect the key). The checklist: Customers: Write, Products: Read, Prices: Read, Coupons: Read, Subscriptions: Write, Test clocks: Write, Customer portal: Write, Checkout Sessions: Write, Payment Links: Write, Webhook Endpoints: Write (https://checkbox.site/docs/guides/stripe-key). Recharge: { "api_token": "…" }. Shopify: { "shop": "store.myshopify.com", "access_token": "shpat_…" }. Chargebee: { "site": "acme", "api_key": "live_…" } (the site name before .chargebee.com and a read-only API key). Recurly: { "api_key": "…", "region": "us" } (a private API key of the site; region "eu" for sites hosted in Recurly’s EU data centre, default "us"). Paddle: { "api_key": "pdl_live_apikey_…" } (a Paddle Billing API key with read permissions; sandbox keys, pdl_sdbx_…, read the sandbox; "environment": "live" or "sandbox" only for older keys without that prefix). For the platforms other than Stripe, Checkbox only reads. */
     credentials: Record<string, string>;
+    /** Set true only after the human said yes to the billing_account_mismatch question ("This looks like <other site>’s Stripe account. Use it anyway?"). It only proposes the account: the key is connected on hold (nothing from it is used, no test runs) until a person confirms it in the Checkbox dashboard (site Overview: “It is this site’s account: use it”). Default false: such a key is not connected and nothing is evaluated. */
+    confirm_account_mismatch?: boolean;
 }
 /** A queued re-read of the site's billing-platform settings, followed by a re-evaluation. */
 export interface BillingSync {
@@ -1442,6 +1461,8 @@ export interface EvidenceItem {
     screenshot_ref?: string;
     /** When it was captured / received. */
     at?: string;
+    /** Set when a Checkbox test run recorded this page view (not a scan of your site). */
+    test_run_id?: string;
 }
 /** What a verdict was based on. Never a pass without it; needs_review says what is missing. */
 export interface VerdictEvidence {
@@ -1569,7 +1590,7 @@ export interface PlanEdit {
 }
 /** 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. */
+    /** Stable action type: apply_task, provide_facts, verify_task, answer_question, ask_human_to_confirm, connect_billing_in_dashboard, store_stripe_test_key, wait_for_verification, run_first_check, review_wont_fix, done_for_now (nothing left an agent can do in code now: the rest waits for a deploy / real send, and maybe the owner; the description lists both; finish the change), done. */
     type: string;
     /** One or two sentences telling the agent exactly what to do now. */
     description: string;
@@ -1670,8 +1691,8 @@ export interface Task {
     };
     /** 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;
+    /** Done / declined tasks: verified (its checks pass), no_longer_applicable (its checks no longer apply, e.g. the data source changed), superseded, declined, decided (the owner confirmed a decision, e.g. New York notices by email only: closed, but its checks are not verified). */
+    closed_reason: "verified" | "no_longer_applicable" | "superseded" | "declined" | "decided" | null;
     /** Tasks to finish first (their result changes this task's content). */
     depends_on: Array<string>;
     /** Unfinished tasks among depends_on. */
@@ -1745,7 +1766,7 @@ export interface CompliancePlan {
     site: string;
     /** action_required (an agent can apply open tasks now), verifying (changes applied; waiting for confirming observations), compliant (every required check passes or only waits for a live check — an automated assessment, not a legal determination; see compliance.pending_live_checks and coverage), blocked (only human answers ("Your call") or declined critical tasks remain). */
     status: "action_required" | "verifying" | "compliant" | "blocked";
-    /** The plan status in words to show a person: action_required "Fixes needed", verifying "Checking your changes", compliant "Checks pass", blocked "Your call". Show this, never the machine value (`compliant` is a status name, not a legal conclusion). */
+    /** The plan status in words to show a person: action_required "Fixes needed", verifying "Checking your changes", compliant "Checks pass", blocked "Your call"; while an agent works the site and everything left waits for a deploy or the owner (next_action done_for_now): "Waiting on deploy and you" or "Waiting on deploy". Show this, never the machine value (`compliant` is a status name, not a legal conclusion). */
     status_label?: string;
     /** The evaluation the plan was built from (null before the first check). */
     evaluation: string | null;
@@ -1798,6 +1819,24 @@ export interface CompliancePlan {
         billing_connected: boolean;
     };
     next_action: PlanNextAction;
+    /** Every open owner choice as ONE batched question (who sends the required emails, plus each question task such as the New York notice channel). Ask it once, early, in one message; the plan's next_action says the same. Absent when there is none. */
+    owner_questions?: {
+        /** How to ask them: once, in one message, while the fixes go on. */
+        description: string;
+        /** Every choice only the owner makes, together. */
+        questions: Array<{
+            /** "email_sender" (who sends the required emails), "notices_support_email" / "notices_cancel_timing" (what Checkbox Notices needs before it sends), or the id of the task whose question it is. */
+            id: string;
+            /** The question, in plain words for the owner. */
+            text: string;
+            /** The answers. */
+            options: Array<string>;
+            /** The tasks the answer settles. */
+            tasks: Array<string>;
+            /** What the agent does with each answer. */
+            on_answer: Record<string, string>;
+        }>;
+    };
     /** Evidence level per required email kind. A plan never reaches status compliant on template_checked emails. */
     email_verification: Array<{
         /** Email kind (acknowledgment, trial_ending, renewal_reminder, annual_terms, charge_notice, price_change, cancellation_confirmation). */
@@ -1928,7 +1967,7 @@ export interface Verification {
     diff: Array<VerificationCheck>;
     /** Plan status after this verification (null while pending). */
     plan_status: "action_required" | "verifying" | "compliant" | "blocked" | null;
-    /** The plan status in words to show a person: action_required "Fixes needed", verifying "Checking your changes", compliant "Checks pass", blocked "Your call". Show this, never the machine value (`compliant` is a status name, not a legal conclusion). */
+    /** The plan status in words to show a person: action_required "Fixes needed", verifying "Checking your changes", compliant "Checks pass", blocked "Your call"; while an agent works the site and everything left waits for a deploy or the owner (next_action done_for_now): "Waiting on deploy and you" or "Waiting on deploy". Show this, never the machine value (`compliant` is a status name, not a legal conclusion). */
     plan_status_label?: string | null;
     next_action: PlanNextAction;
     /** When it was requested. Unix timestamp in seconds. */
@@ -2175,6 +2214,54 @@ export interface CertificateList {
     /** The URL of this list. */
     url: string;
 }
+/** One email Checkbox Notices sent (or tried to send) for the site. */
+export interface NoticeSend {
+    /** Unique identifier of the notice (ntc_…). */
+    id: string;
+    /** String representing the object's type. Always "notice_send". */
+    object: "notice_send";
+    /** The site. */
+    site: string;
+    /** Notice kind. */
+    kind: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change" | "cancellation_confirmation" | "charge_notice";
+    /** sent: the provider accepted it; failed: will be retried while its window is open; skipped: not sent, error says why; bounced; claimed: being sent. */
+    status: "claimed" | "sent" | "failed" | "bounced" | "skipped";
+    /** A "Send a test" sample (never counts toward a check). */
+    sample: boolean;
+    /** Billing platform of the subscription. */
+    platform: string;
+    /** Billing-platform subscription id (null for a sample). */
+    subscription: string | null;
+    /** Masked recipient address. */
+    recipient: string | null;
+    /** Subject line. */
+    subject: string | null;
+    /** Sent after its window opened late. */
+    late: boolean;
+    /** Why it failed or was skipped. */
+    error: string | null;
+    /** Send attempts. */
+    attempts: number;
+    /** When it was due. Unix timestamp in seconds. */
+    due: number | null;
+    /** When it was sent. Unix timestamp in seconds. */
+    sent: number | null;
+    /** When the send was first claimed. Unix timestamp in seconds. */
+    created: number;
+    /** Evidence record of the sent email. */
+    evidence: string | null;
+}
+/** A page of checkbox notices sends, newest first. */
+export interface NoticeSendList {
+    /** String representing the object's type. Always "list". */
+    object: "list";
+    /** Checkbox Notices sends, newest first. */
+    data: Array<NoticeSend>;
+    /** 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_…). */
@@ -2197,8 +2284,12 @@ export interface NoticeSettings {
     product_name: string | null;
     /** Logo URL (https). */
     logo_url: string | null;
-    /** Reply-to / support address. */
+    /** Reply-to / support address every notice names as the business's contact. null until one is set (or while support_email_to_confirm waits for a person). */
     support_email: string | null;
+    /** The Checkbox account's login address (the owner's), offered as the support email but not used: Checkbox sends nothing with it, and does not save it, until a person confirms it once in the dashboard (Emails › Branding). Agents cannot confirm it; ask the human, or set a different support_email they chose. The Stripe account's public support email is used without asking. */
+    support_email_to_confirm: string | null;
+    /** Whether Checkbox Notices emails the site's real subscribers. test_mode: never (test-mode sites email only test-run inboxes and send the owner marked test copies). needs_confirmation: Notices are on, but nothing goes to real subscribers until a person confirms it once in the dashboard (Emails tab, after a preview); an API key or agent cannot confirm it. confirmed: they are emailed. off: Checkbox sends nothing. */
+    real_sends: "test_mode" | "confirmed" | "needs_confirmation" | "off";
     /** Where subscribers cancel online (site domain, hosted cancellation page or billing portal). */
     cancel_url: string | null;
     /** Hex brand colour. */
@@ -2267,7 +2358,7 @@ export interface UpdateNoticeSettingsParams {
     product_name?: string | null;
     /** Logo URL (https). */
     logo_url?: string | null;
-    /** Support address. */
+    /** Support address every notice names (required before Checkbox sends). Turning a notice on without one uses the Checkbox cancellation page's or the Stripe account's public support email. The Checkbox account's login address is never used without a person: setting it here answers resource_conflict (next_action confirm_support_email) until the human confirms it once in the dashboard (Emails › Branding). */
     support_email?: string | null;
     /** Online cancellation URL. */
     cancel_url?: string | null;
@@ -2283,7 +2374,7 @@ export interface UpdateNoticeSettingsParams {
         confirm: true;
     } | null;
 }
-/** Copy-ready email for this subscriber. It passes the preflight email check for its kind when every field is filled. */
+/** The email for this subscriber, rendered from Checkbox's template. Ready to send only when missing_fields is empty; it then passes the preflight email check for its kind. */
 export interface RenderedNoticeEmail {
     /** Checkbox template the email was rendered from (GET /v1/notices/templates). */
     template_id: string;
@@ -2293,10 +2384,10 @@ export interface RenderedNoticeEmail {
     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. */
+    /** Merge fields Checkbox could not fill (support_contact until a support email is confirmed, cancel_url when neither the notice settings nor the site name an account page). While this is not empty the email is NOT ready to send: fill each {{field}} first, or a check of the sent copy reopens its task naming the unfilled field. */
     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. */
+/** An email the merchant owes a subscriber, legally required (required: true) or recommended ("You send" mode): what, when, the email to send (ready once email.missing_fields is empty) and how to confirm it was sent. */
 export interface DueNotice {
     /** Unique identifier of the due notice (ntd_…). */
     id: string;
@@ -2625,6 +2716,8 @@ export interface CheckWarning {
 export interface CheckReplacement {
     /** Disclosure generated from the plan terms that passes the checks (locked wording). */
     disclosure_text: string;
+    /** The same terms as one short line, verified by the engine like disclosure_text (present only when it passes every targeted check); disclosure_text is then the fuller version. */
+    short_disclosure_text?: string;
     /** Label for the unchecked, required consent checkbox. */
     consent_label: string;
     /** Purchase button label that itself states the renewal. */
@@ -2711,8 +2804,8 @@ export interface DisclosureCheckParams {
     amount?: number;
     /** Three-letter ISO currency (default usd). */
     currency?: string;
-    /** Billing interval: day, week, month or year (required). */
-    interval: string;
+    /** Billing interval: day, week, month or year (required unless `site` gives the plan). */
+    interval?: string;
     /** Number of intervals between charges (default 1). */
     interval_count?: number;
     /** Free-trial length in days (0 or absent = no trial). */
@@ -2767,6 +2860,10 @@ export interface DisclosureCheckParams {
     };
     /** Evaluate the law as of this date (YYYY-MM-DD, default today). */
     as_of?: string;
+    /** Round 23: a site of yours (site_…): the disclosure is judged against the plan it states among the site's plans (the connected Stripe Prices win over plans typed in setup), with the site's merchant name, cancellation URL and jurisdictions, as verifyTask judges it. Plan fields you send are replaced by the plan's. "none" judges only what you send. */
+    site?: string;
+    /** With a site: judge the disclosure against this plan (name or Stripe Price id). An unknown plan is refused with the list of plans. */
+    plan?: string;
 }
 /** RFC 6902 operation. */
 export interface JsonPatchOperation {
@@ -3180,8 +3277,10 @@ export interface PageCheckParams {
         /** Plan name, as in setup plans[] (updateSetupSession; alias of plan_name). */
         name?: string;
     }>;
-    /** Where the shopper pays: own_page (a form on this page), stripe_checkout or payment_link (a Stripe-hosted page that collects consent, so no checkbox is needed here). Inferred from a purchase link to buy.stripe.com / checkout.stripe.com when absent. */
+    /** Where the shopper pays: own_page (a form on this page), stripe_checkout or payment_link (a Stripe-hosted page that collects consent, so no checkbox is needed here). Inferred from a purchase link to buy.stripe.com / checkout.stripe.com, or to one of payment_links, when absent. */
     checkout_type?: "own_page" | "stripe_checkout" | "payment_link";
+    /** Your Stripe Payment Link URLs (buy.stripe.com or your own domain). A link to one of them is the purchase button, and the purchase and consent complete on Stripe, so no checkbox is added on this page. With site, the Payment Links read from your connected Stripe account are added. */
+    payment_links?: Array<string>;
     /** A site of yours (site_…): the page is judged exactly as verifyTask judges it — against the site's plans (the connected Stripe Prices win over plans typed in setup), its jurisdictions and its checkout type. These replace terms, plans, jurisdictions and checkout_type when the site knows them. Without it, the one site of the account with Stripe connected gives the plans when there is exactly one (warning site_from_stripe says so). "none" judges only what you send. */
     site?: string;
     /** Where you sell: "all" (default) or state codes ("US-CA", "CA", "US-NY"; "US-FED" is always included). */
@@ -4191,6 +4290,7 @@ export interface TestCredential {
     last_error: string | null;
     /** When the key was stored. Unix timestamp in seconds. */
     created: number;
+    next_action?: NextAction;
 }
 /** A page of stored test-mode keys. */
 export interface TestCredentialList {
@@ -4238,6 +4338,7 @@ export interface StripeCheckoutConfig {
     metadata: Record<string, string>;
     /** When the config was registered. Unix timestamp in seconds. */
     created: number;
+    next_action?: NextAction;
 }
 /** A page of registered checkout configs, newest first. */
 export interface StripeCheckoutConfigList {
@@ -4482,8 +4583,8 @@ export interface TestRun {
             via: "merchant_flow" | "stripe_portal" | "cancel_url";
             /** false: nothing told Checkbox how customers cancel, so it used the Stripe portal (step warning cancel_flow_not_configured: the cancel itself worked). true also when inferred (inferred_from). */
             declared_by_merchant: boolean;
-            /** site_portal_link: no cancel_via was given, Stripe has cancellation on in the customer portal and your site links to it, so the portal was used as declared. registered_url: no cancel_via was given and the account or cancellation page you registered (account_url / cancellation_url) redirects or links to the Stripe customer portal, so the portal was used as declared. */
-            inferred_from?: "site_portal_link" | "registered_url" | null;
+            /** How the cancel path was chosen when none was passed. site_portal_link: Stripe has cancellation on in the customer portal and your site links to it, so the portal was used as declared. registered_url: the account or cancellation page you registered (account_url / cancellation_url) redirects or links to the Stripe customer portal. site_cancel_control: the cancel button or link the last scan found on a public page of your site was used. portal_default: no test account and no other cancel flow is set, and Stripe has cancellation on in the customer portal, so the portal was used (and remembered for this site). site_setting: an earlier run remembered the portal for this site. */
+            inferred_from?: "site_portal_link" | "registered_url" | "site_cancel_control" | "portal_default" | "site_setting" | null;
             /** Stripe showed a subscription set to cancel after the shopper's flow. */
             confirmed_in_stripe: boolean;
             /** The subscription Stripe showed canceled. */
@@ -4667,7 +4768,7 @@ export interface CompliancePlanSummary {
     site: string;
     /** action_required (an agent can apply open tasks now), verifying (changes applied; waiting for confirming observations), compliant (every required check passes or only waits for a live check — an automated assessment, not a legal determination; see compliance.pending_live_checks and coverage), blocked (only human answers ("Your call") or declined critical tasks remain). */
     status: "action_required" | "verifying" | "compliant" | "blocked";
-    /** The plan status in words to show a person: action_required "Fixes needed", verifying "Checking your changes", compliant "Checks pass", blocked "Your call". Show this, never the machine value (`compliant` is a status name, not a legal conclusion). */
+    /** The plan status in words to show a person: action_required "Fixes needed", verifying "Checking your changes", compliant "Checks pass", blocked "Your call"; while an agent works the site and everything left waits for a deploy or the owner (next_action done_for_now): "Waiting on deploy and you" or "Waiting on deploy". Show this, never the machine value (`compliant` is a status name, not a legal conclusion). */
     status_label?: string;
     /** Two or three sentences for an LLM: where the site stands and what comes next. */
     summary: string;
@@ -4915,6 +5016,17 @@ export interface RevokeCertificateParams {
     /** Private reason. */
     reason: string;
 }
+/** Parameters of `noticeSends.list()` (listNoticeSends). */
+export interface ListNoticeSendsParams {
+    /** At most this many rows (default 50). */
+    limit?: number;
+    /** Only this kind. */
+    kind?: "acknowledgment" | "trial_ending" | "renewal_reminder" | "annual_terms" | "price_change" | "cancellation_confirmation" | "charge_notice";
+    /** Only sends for this billing-platform subscription id. */
+    subscription?: string;
+    /** Include "Send a test" samples. */
+    include_samples?: "true" | "false";
+}
 /** Parameters of `notices.listDue()` (listDueNotices). */
 export interface ListDueNoticesParams {
     /** Number of objects to return, 1-100 (default 10). */
@@ -4999,10 +5111,12 @@ export interface ListReceiptsParams {
 }
 /** 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. */
+    /** Kind of key: "stripe_test" ("stripe" is accepted as the same). Always stored as a Stripe TEST-mode key. */
+    type: "stripe_test" | "stripe";
+    /** The Stripe test-mode restricted key (rk_test_…). Secret keys (sk_…) and live keys are refused. Stored encrypted; never returned. */
     secret_key: string;
+    /** Set true only after the human said yes: proposes the key even though its Stripe account looks like another site’s (billing_account_mismatch). It is connected on hold, and nothing from it is used, until a person confirms the account in the Checkbox dashboard (site Overview); next to a person’s Stripe connection it is refused. Default false. */
+    confirm_account_mismatch?: boolean;
 }
 /** Parameters of `stripeCheckoutConfigs.create()` (createStripeCheckoutConfig). */
 export interface CreateStripeCheckoutConfigParams {
@@ -5036,6 +5150,8 @@ export interface CreateTestRunParams {
     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";
+    /** Round 23: which plan to run, by the name of a registered checkout config or a Price id (price_…) its line_items use: the run mirrors that config (same as stripe.checkout_config). An unknown plan is refused with the list of registered configs. */
+    plan?: string;
     /** Stripe options. */
     stripe?: {
         /** Registered checkout config (scc_…) to mirror; default: the newest one, else your latest live Checkout Session. "none" skips the registered configs (mirror your live checkout, stripe.price or stripe.payment_link instead). */
@@ -5044,6 +5160,10 @@ export interface CreateTestRunParams {
         price?: string;
         /** Trial for `price` (registered configs carry their own). */
         trial_period_days?: number;
+        /** Mirror mode: a TEST-mode coupon id applied to the test subscription, so it has the same discount as your real subscribers (an intro price, for example). Its emails are then judged against that discount. Not with promotion_code. */
+        coupon?: string;
+        /** Mirror mode: a TEST-mode promotion code (promo_… id, or the code customers type) applied to the test subscription. Not with coupon. */
+        promotion_code?: string;
         /** 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. */
@@ -5115,7 +5235,7 @@ export interface ListTestRunsParams {
 }
 /** Parameters of `testRuns.retrieve()` (retrieveTestRun). */
 export interface RetrieveTestRunParams {
-    /** Long-poll: wait up to this many seconds (0-30) for the run to move on (status, phase or a step changes) before answering. */
+    /** Long-poll: wait up to this many seconds (0-30) for a meaningful change before answering: the run finishes, its status changes or a step starts or ends (not every internal phase change while the test clock moves). */
     wait?: number | null;
 }
 /** Parameters of `webhookEndpoints.create()` (createWebhookEndpoint). */
@@ -5188,7 +5308,7 @@ export type TaskVerifiedEvent = Event & {
         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. */
+/** `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 email (ready to send once email.missing_fields is empty) 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";
@@ -5418,12 +5538,22 @@ export declare const ERROR_CODES: {
     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 (a person adds it in the dashboard on the site's Proof page).";
+        readonly description: "A Stripe test run needs a Stripe TEST-mode key stored for the site: the agent stores the restricted test key (rk_test_…) with createTestCredential, or a person adds it in the dashboard.";
     };
     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 description: "The billing key is a live-mode (or malformed) key. Agents only store TEST-mode restricted keys (rk_test_…); a human adds live keys in the Checkbox dashboard.";
+    };
+    readonly test_key_not_restricted: {
+        readonly status: 400;
+        readonly type: "invalid_request_error";
+        readonly description: "The key is a full Stripe secret key (sk_test_… or sk_live_…), which is refused on every connect path (createTestCredential, connectBillingPlatform, the dashboard). Use a restricted key (rk_test_…) with the permissions on Checkbox's key checklist instead; `message` lists them.";
+    };
+    readonly test_key_declined: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "The owner did not tick “Let your agent store a Stripe test-mode key” on the approval page of this agent's sign-in (device login) or connection (OAuth). Nothing was stored. Ask them to allow it on the approval page (sign in again) or to add the key themselves in the dashboard.";
     };
     readonly test_key_rejected: {
         readonly status: 400;
@@ -5505,6 +5635,11 @@ export declare const ERROR_CODES: {
         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 live_key_requires_dashboard: {
+        readonly status: 403;
+        readonly type: "permission_error";
+        readonly description: "A live-mode Stripe key (rk_live_ / sk_live_) cannot be connected through the API or by an AI agent: only a person signed in to the Checkbox dashboard can connect one (and never on a test-mode site). Agents store restricted TEST keys (rk_test_…).";
+    };
     readonly account_suspended: {
         readonly status: 403;
         readonly type: "permission_error";
@@ -5535,6 +5670,11 @@ export declare const ERROR_CODES: {
         readonly type: "invalid_request_error";
         readonly description: "The consent already carries a different customer_reference; references are set once and never changed.";
     };
+    readonly billing_account_mismatch: {
+        readonly status: 409;
+        readonly type: "invalid_request_error";
+        readonly description: "The key's Stripe account looks like another site's (the site's prices or Payment Links are not in it, or it is already connected in another workspace), so nothing was stored or evaluated. Ask the human the question in `message`; retry with confirm_account_mismatch: true only if they say yes (that only proposes it: the key is held until a person confirms the account in the dashboard), else use this site's own key. `problems` lists what did not match.";
+    };
     readonly test_run_in_progress: {
         readonly status: 409;
         readonly type: "invalid_request_error";

package/dist/generated/types.js

@@ -18,8 +18,10 @@ export const ERROR_CODES = {
     api_version_invalid: { status: 400, type: "invalid_request_error", description: "The Checkbox-Version header names an unknown API version." },
     idempotency_key_invalid: { status: 400, type: "idempotency_error", description: "The Idempotency-Key header is empty or longer than 255 characters." },
     idempotency_key_reused: { status: 400, type: "idempotency_error", description: "The Idempotency-Key was already used with different parameters within 24 hours." },
-    test_key_missing: { status: 400, type: "invalid_request_error", description: "A Stripe test run needs a Stripe TEST-mode key stored for the site (a person adds it in the dashboard on the site's Proof page)." },
-    test_key_not_test_mode: { status: 400, type: "invalid_request_error", description: "The billing key is a live-mode (or malformed) key; test runs only accept test-mode keys (rk_test_… / sk_test_…)." },
+    test_key_missing: { status: 400, type: "invalid_request_error", description: "A Stripe test run needs a Stripe TEST-mode key stored for the site: the agent stores the restricted test key (rk_test_…) with createTestCredential, or a person adds it in the dashboard." },
+    test_key_not_test_mode: { status: 400, type: "invalid_request_error", description: "The billing key is a live-mode (or malformed) key. Agents only store TEST-mode restricted keys (rk_test_…); a human adds live keys in the Checkbox dashboard." },
+    test_key_not_restricted: { status: 400, type: "invalid_request_error", description: "The key is a full Stripe secret key (sk_test_… or sk_live_…), which is refused on every connect path (createTestCredential, connectBillingPlatform, the dashboard). Use a restricted key (rk_test_…) with the permissions on Checkbox's key checklist instead; `message` lists them." },
+    test_key_declined: { status: 403, type: "permission_error", description: "The owner did not tick “Let your agent store a Stripe test-mode key” on the approval page of this agent's sign-in (device login) or connection (OAuth). Nothing was stored. Ask them to allow it on the approval page (sign in again) or to add the key themselves in the dashboard." },
     test_key_rejected: { status: 400, type: "invalid_request_error", description: "Stripe rejected the test-mode key or it lacks a permission test runs need; `message` names it." },
     authorization_pending: { status: 400, type: "invalid_request_error", description: "Device login: the human has not approved yet. Keep polling createDeviceToken every `interval` seconds." },
     slow_down: { status: 400, type: "rate_limit_error", description: "Device login: polling too fast. Add 5 seconds to the interval and keep polling." },
@@ -36,12 +38,14 @@ export const ERROR_CODES = {
     test_mode_domain_unverified: { status: 403, type: "permission_error", 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." },
     test_mode_scan_budget_exhausted: { status: 429, type: "rate_limit_error", description: "No longer returned: 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." },
     domain_not_verified: { status: 403, type: "permission_error", 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." },
+    live_key_requires_dashboard: { status: 403, type: "permission_error", description: "A live-mode Stripe key (rk_live_ / sk_live_) cannot be connected through the API or by an AI agent: only a person signed in to the Checkbox dashboard can connect one (and never on a test-mode site). Agents store restricted TEST keys (rk_test_…)." },
     account_suspended: { status: 403, type: "permission_error", description: "The account was suspended by Checkbox staff; contact support." },
     resource_missing: { status: 404, type: "invalid_request_error", description: "No object with this id exists in this mode of the account." },
     route_not_found: { status: 404, type: "invalid_request_error", description: "No such endpoint. See /v1/openapi.json for the list." },
     resource_conflict: { status: 409, type: "invalid_request_error", description: "The object is in a state that does not allow this action." },
     scan_already_queued: { status: 409, type: "invalid_request_error", description: "A scan of this site is already queued or running." },
     consent_reference_locked: { status: 409, type: "invalid_request_error", description: "The consent already carries a different customer_reference; references are set once and never changed." },
+    billing_account_mismatch: { status: 409, type: "invalid_request_error", description: "The key's Stripe account looks like another site's (the site's prices or Payment Links are not in it, or it is already connected in another workspace), so nothing was stored or evaluated. Ask the human the question in `message`; retry with confirm_account_mismatch: true only if they say yes (that only proposes it: the key is held until a person confirms the account in the dashboard), else use this site's own key. `problems` lists what did not match." },
     test_run_in_progress: { status: 409, type: "invalid_request_error", description: "The site already has a queued or running test run; wait for it (retrieveTestRun) or cancel it (cancelTestRun)." },
     legal_hold_active: { status: 409, type: "invalid_request_error", description: "A legal hold is on for the account or the site: deleting data and shortening retention are refused until it is turned off (updateAccount / updateSite legal_hold)." },
     idempotency_key_in_use: { status: 409, type: "idempotency_error", description: "A request with this Idempotency-Key is still being processed; retry shortly." },

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** Version of this SDK (kept equal to packages/sdk-node/package.json "version"; a test checks it). */
-export declare const SDK_VERSION = "0.2.0";
+export declare const SDK_VERSION = "0.2.2";

package/dist/version.js

@@ -1,2 +1,2 @@
 /** Version of this SDK (kept equal to packages/sdk-node/package.json "version"; a test checks it). */
-export const SDK_VERSION = '0.2.0';
+export const SDK_VERSION = '0.2.2';

package/package.json

@@ -1,19 +1,29 @@
 {
   "name": "@checkbox-site/node",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Checkbox Node.js SDK: automatic-renewal-law compliance (ROSCA, California ARL, New York and other state laws) for subscription businesses. Zero dependencies. Published to npm as @checkbox-site/node.",
   "keywords": [
     "subscription",
+    "subscription-compliance",
     "auto-renewal",
+    "autorenewal",
     "automatic-renewal",
     "compliance",
     "rosca",
     "click-to-cancel",
     "california-arl",
+    "auto-renewal-law",
+    "auto-renewal-compliance",
+    "subscription-cancellation",
+    "renewal-reminder",
+    "stripe-subscriptions",
+    "ftc",
+    "negative-option",
     "stripe",
     "stripe-checkout",
     "checkout",
-    "cancellation"
+    "cancellation",
+    "mcp"
   ],
   "license": "MIT",
   "author": "Checkbox <support@checkbox.site>",