@paid-ai/paid-node 1.8.0 → 2.0.0

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

@@ -0,0 +1,27 @@
+import type * as Paid from "../index.js";
+/**
+ * A cap in force on one of the customer's units, as the customer unit cap read returns it. `used` covers the unit and every unit under it.
+ */
+export interface CustomViewContextCap {
+    /** The cap, in credits of the currency. JSON number; exact within ±2^53. */
+    amount: number;
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    frequency: CustomViewContextCap.Frequency;
+    schedule: Paid.CustomerUnitCapSchedule;
+    /** The capped unit's externalId, as in `units`. */
+    externalId: string;
+    /** The credits currency this cap limits. */
+    creditsCurrencyId: string;
+    /** That currency's key, such as `agent_credits`. */
+    creditsCurrencyKey: string;
+    /** That currency's display name. */
+    creditsCurrencyName: string;
+    currentPeriod: Paid.CustomerUnitCapCurrentPeriod | null;
+}
+export declare namespace CustomViewContextCap {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    const Frequency: {
+        readonly Monthly: "MONTHLY";
+    };
+    type Frequency = (typeof Frequency)[keyof typeof Frequency];
+}

package/dist/cjs/api/types/CustomViewContextCap.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomViewContextCap = void 0;
+var CustomViewContextCap;
+(function (CustomViewContextCap) {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    CustomViewContextCap.Frequency = {
+        Monthly: "MONTHLY",
+    };
+})(CustomViewContextCap || (exports.CustomViewContextCap = CustomViewContextCap = {}));

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

@@ -0,0 +1,16 @@
+export interface CustomViewCustomerUnit {
+    /** Your stable identifier for this unit, unique within its customer. */
+    externalId: string;
+    /** Display name of the customer unit. */
+    name: string;
+    /** Your label for the kind of unit, such as department or team; null when unset. */
+    externalType: string | null;
+    /** The parent customer unit's externalId; null only for the root unit. */
+    parentExternalId: string | null;
+    /** True when this unit has no parent and is the customer's root unit. */
+    isRoot: boolean;
+    /** The unit's own setting. `false` marks it, and every unit under it, non-billable. Always `true` on the root. */
+    billable: boolean;
+    /** Whether new usage on this unit is billable now, once its ancestors are counted: `false` when the unit or any unit above it is non-billable. A change applies only to signals received afterwards, so it does not describe past usage. */
+    effectiveBillable: boolean;
+}

package/dist/cjs/api/types/CustomViewCustomerUnit.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,57 @@
+import type * as Paid from "../index.js";
+/**
+ * What these rows were read for. The render bundle receives this object as `context` in the `paid:data` message.
+ */
+export interface CustomViewDataContext {
+    /** Context version. 2 adds the selected unit's `name`, the unit directory (`units`, `unitsTotal`, `unitsTruncated`) and unit caps (`caps`, `capsTotal`, `capsTruncated`, `capsUnavailable`); absent on version 1. Later versions only add fields. */
+    version?: number;
+    unitSelection: Paid.CustomViewUnitSelection;
+    /** Default date range for the view's queries. Use `{period_start:DateTime}` / `{period_end:DateTime}` placeholders in your SQL to make the range adjustable. Either relative (unit+amount) or absolute (start+end). */
+    period: CustomViewDataContext.Period | null;
+    /** The viewing customer's active units, for labelling rows by name, type, parent and billability. Sent only for hierarchy-enabled, customer-scoped views. At most 1,000, oldest first; see `unitsTruncated`. */
+    units?: Paid.CustomViewCustomerUnit[];
+    /** How many active units the customer has, including any left out of `units`. */
+    unitsTotal?: number;
+    /** True when the customer has more than 1,000 active units and `units` holds only the first 1,000. Label any other unit by its externalId. */
+    unitsTruncated?: boolean;
+    /** Caps in force on the customer's active units, one per unit and credits currency, sent with `units`. At most 25, in directory order; see `capsTruncated`. Absent when `capsUnavailable` is true. */
+    caps?: Paid.CustomViewContextCap[];
+    /** How many caps are in force, including any left out of `caps`. */
+    capsTotal?: number;
+    /** True when more than 25 caps are in force and `caps` holds only the first 25. */
+    capsTruncated?: boolean;
+    /** True when cap usage could not be read in time. The view's rows are unaffected; show the view without caps. */
+    capsUnavailable?: boolean;
+}
+export declare namespace CustomViewDataContext {
+    /**
+     * Default date range for the view's queries. Use `{period_start:DateTime}` / `{period_end:DateTime}` placeholders in your SQL to make the range adjustable. Either relative (unit+amount) or absolute (start+end).
+     */
+    interface Period {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        kind: Period.Kind;
+        /** relative only: the unit of the rolling window. */
+        unit?: Period.Unit;
+        /** relative only: how many units back from today (e.g. unit 'day', amount 30 = last 30 days). */
+        amount?: number;
+        /** absolute only: inclusive start date (YYYY-MM-DD). */
+        start?: string;
+        /** absolute only: inclusive end date (YYYY-MM-DD). */
+        end?: string;
+    }
+    namespace Period {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        const Kind: {
+            readonly Relative: "relative";
+            readonly Absolute: "absolute";
+        };
+        type Kind = (typeof Kind)[keyof typeof Kind];
+        /** relative only: the unit of the rolling window. */
+        const Unit: {
+            readonly Day: "day";
+            readonly Month: "month";
+            readonly Year: "year";
+        };
+        type Unit = (typeof Unit)[keyof typeof Unit];
+    }
+}

package/dist/cjs/api/types/CustomViewDataContext.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomViewDataContext = void 0;
+var CustomViewDataContext;
+(function (CustomViewDataContext) {
+    let Period;
+    (function (Period) {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        Period.Kind = {
+            Relative: "relative",
+            Absolute: "absolute",
+        };
+        /** relative only: the unit of the rolling window. */
+        Period.Unit = {
+            Day: "day",
+            Month: "month",
+            Year: "year",
+        };
+    })(Period = CustomViewDataContext.Period || (CustomViewDataContext.Period = {}));
+})(CustomViewDataContext || (exports.CustomViewDataContext = CustomViewDataContext = {}));

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

@@ -1,5 +1,9 @@
 import type * as Paid from "../index.js";
 export interface CustomViewDetail {
+    /** Enable customer unit navigation for a customer-scoped view. Setting true requires customer hierarchies to be enabled for your organization, and every query must support unit selection. Existing views default to false. */
+    hierarchyEnabled?: boolean;
+    /** Send the customer's unit caps to the render bundle as `context.caps`. Needs `hierarchyEnabled` on a customer-scoped view. Turn it on only for views that draw cap usage: each load then reads cap usage from billing. Caps are spend policy, so an API key also needs `read:billing` to receive them in the data (they are left out otherwise) or to mint this view's embed token. Defaults to false. */
+    capsEnabled?: boolean;
     displayId: string;
     name: string;
     description: string | null;

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

@@ -1,8 +1,9 @@
 import type * as Paid from "../index.js";
 export interface CustomViewPreviewHarnessRequest {
+    context?: Paid.CustomViewDataContext;
     /** The raw, self-contained HTML render bundle to preview — the SAME string you would pass to createCustomView. Pass it verbatim; do NOT escape `</script>`, backticks, or quotes yourself (that is exactly what this endpoint does for you). */
     renderBundle: string;
-    /** Optional sample data keyed by query id (as getCustomViewData returns it), e.g. `{ "usage": [{ "day": "2026-01-01", "signals": "42" }] }`. Delivered to the bundle via the same `paid:data` message the real embed sends. Omit to preview the empty state. If these rows are fabricated (a data-restricted org), also set `sampleData: true` so the harness is marked with a sample-data banner. */
+    /** Optional sample data keyed by query id (the `data` field of a getCustomViewData response), e.g. `{ "usage": [{ "day": "2026-01-01", "signals": "42" }] }`. Delivered to the bundle via the same `paid:data` message the real embed sends. Omit to preview the empty state. If these rows are fabricated (a data-restricted org), also set `sampleData: true` so the harness is marked with a sample-data banner. */
     data?: Record<string, Record<string, unknown>[]>;
     /** For data-restricted orgs (API key without read:analytics, so the real data endpoints are blocked): a per-query column contract, keyed by query id, describing the columns each SQL returns. The server fabricates deterministic sample rows from it — no query runs, so no customer data is used — and marks the preview as sample data. Mutually exclusive with `data`. */
     synthetic?: Record<string, Paid.CustomViewPreviewHarnessColumn[]>;

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

@@ -1,4 +1,8 @@
 export interface CustomViewSummary {
+    /** Enable customer unit navigation for a customer-scoped view. Setting true requires customer hierarchies to be enabled for your organization, and every query must support unit selection. Existing views default to false. */
+    hierarchyEnabled?: boolean;
+    /** Send the customer's unit caps to the render bundle as `context.caps`. Needs `hierarchyEnabled` on a customer-scoped view. Turn it on only for views that draw cap usage: each load then reads cap usage from billing. Caps are spend policy, so an API key also needs `read:billing` to receive them in the data (they are left out otherwise) or to mint this view's embed token. Defaults to false. */
+    capsEnabled?: boolean;
     displayId: string;
     name: string;
     description: string | null;

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

@@ -0,0 +1,14 @@
+/**
+ * All customer activity, one unit's direct activity, or that unit and its current descendants. A display filter within the authorized customer, not an access restriction. In a data context, a selected unit also carries its display name.
+ */
+export type CustomViewUnitSelection = {
+    mode: "all";
+} | {
+    mode: "direct";
+    externalId: string;
+    name?: string | undefined;
+} | {
+    mode: "subtree";
+    externalId: string;
+    name?: string | undefined;
+};

package/dist/cjs/api/types/CustomViewUnitSelection.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -3,6 +3,8 @@ export interface CustomerAlias {
     alias: string;
     /** Paid customer display ID this alias resolves to. */
     customerId: string;
+    /** Your id of the customer unit signals carrying this alias land on: the unit the alias was created under, or the customer's root unit for a customer-level alias. `null` only while the customer has no root unit. */
+    customerUnitExternalId: string | null;
     name: string | null;
     description: string | null;
     createdAt: string;

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

@@ -0,0 +1,31 @@
+export interface CustomerApiKey {
+    /** The key's id. */
+    id: string;
+    name: string;
+    description: string | null;
+    /** Display id (`cus_…`) of the customer the key acts for. */
+    customerId: string | null;
+    /** That customer's id in your system, if it has one. */
+    customerExternalId: string | null;
+    /** What the key may do. */
+    scopes: string[];
+    /** The key's first characters, to recognise it in a list. */
+    keyPrefix: string;
+    /** The key's last four characters. */
+    last4: string;
+    /** `ACTIVE` until the key is revoked (`REVOKED`) or its expiry passes (`EXPIRED`). */
+    status: CustomerApiKey.Status;
+    createdAt: string;
+    lastUsedAt: string | null;
+    expiresAt: string | null;
+    revokedAt: string | null;
+}
+export declare namespace CustomerApiKey {
+    /** `ACTIVE` until the key is revoked (`REVOKED`) or its expiry passes (`EXPIRED`). */
+    const Status: {
+        readonly Active: "ACTIVE";
+        readonly Revoked: "REVOKED";
+        readonly Expired: "EXPIRED";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/CustomerApiKey.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerApiKey = void 0;
+var CustomerApiKey;
+(function (CustomerApiKey) {
+    /** `ACTIVE` until the key is revoked (`REVOKED`) or its expiry passes (`EXPIRED`). */
+    CustomerApiKey.Status = {
+        Active: "ACTIVE",
+        Revoked: "REVOKED",
+        Expired: "EXPIRED",
+    };
+})(CustomerApiKey || (exports.CustomerApiKey = CustomerApiKey = {}));

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

@@ -0,0 +1,8 @@
+export interface CustomerApiKeyCreate {
+    /** A label for the key, shown in lists and in the audit log. */
+    name: string;
+    /** Optional free text about where the key is used. */
+    description?: string;
+    /** Optional expiry (ISO 8601), which must be in the future. Without it the key works until it is revoked. */
+    expiresAt?: string;
+}

package/dist/cjs/api/types/CustomerApiKeyCreate.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,33 @@
+export interface CustomerApiKeyCreated {
+    /** The key's id. */
+    id: string;
+    name: string;
+    description: string | null;
+    /** Display id (`cus_…`) of the customer the key acts for. */
+    customerId: string | null;
+    /** That customer's id in your system, if it has one. */
+    customerExternalId: string | null;
+    /** What the key may do. */
+    scopes: string[];
+    /** The key's first characters, to recognise it in a list. */
+    keyPrefix: string;
+    /** The key's last four characters. */
+    last4: string;
+    /** `ACTIVE` until the key is revoked (`REVOKED`) or its expiry passes (`EXPIRED`). */
+    status: CustomerApiKeyCreated.Status;
+    createdAt: string;
+    lastUsedAt: string | null;
+    expiresAt: string | null;
+    revokedAt: string | null;
+    /** The secret. Returned only in this response and never again: store it now. Paid keeps only its hash. */
+    key: string;
+}
+export declare namespace CustomerApiKeyCreated {
+    /** `ACTIVE` until the key is revoked (`REVOKED`) or its expiry passes (`EXPIRED`). */
+    const Status: {
+        readonly Active: "ACTIVE";
+        readonly Revoked: "REVOKED";
+        readonly Expired: "EXPIRED";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/CustomerApiKeyCreated.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerApiKeyCreated = void 0;
+var CustomerApiKeyCreated;
+(function (CustomerApiKeyCreated) {
+    /** `ACTIVE` until the key is revoked (`REVOKED`) or its expiry passes (`EXPIRED`). */
+    CustomerApiKeyCreated.Status = {
+        Active: "ACTIVE",
+        Revoked: "REVOKED",
+        Expired: "EXPIRED",
+    };
+})(CustomerApiKeyCreated || (exports.CustomerApiKeyCreated = CustomerApiKeyCreated = {}));

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

@@ -0,0 +1,5 @@
+import type * as Paid from "../index.js";
+export interface CustomerApiKeyList {
+    data: Paid.CustomerApiKey[];
+    pagination: Paid.Pagination;
+}

package/dist/cjs/api/types/CustomerApiKeyList.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,2 +1,5 @@
 import type * as Paid from "../index.js";
+/**
+ * The customer, by Paid ID (`customerId`) or by your external ID (`externalCustomerId`).
+ */
 export type CustomerAttribution = Paid.CustomerById | Paid.CustomerByExternalId;

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

@@ -0,0 +1,24 @@
+export interface CustomerFundingInstructions {
+    /** Paid customer display id */
+    customerId: string;
+    currency: string;
+    /** Bank holding the virtual account, as issued by Stripe */
+    bankName: string;
+    /** Name the customer should address the transfer to */
+    accountHolderName: string;
+    /** ABA routing number */
+    routingNumber: string;
+    /** Account number unique to this customer */
+    accountNumber: string;
+    accountType: CustomerFundingInstructions.AccountType;
+    status: string;
+    /** What the customer must put in the transfer memo so the payment is matched to an invoice */
+    memo: string;
+    createdAt: string;
+}
+export declare namespace CustomerFundingInstructions {
+    const AccountType: {
+        readonly Checking: "checking";
+    };
+    type AccountType = (typeof AccountType)[keyof typeof AccountType];
+}

package/dist/cjs/api/types/CustomerFundingInstructions.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerFundingInstructions = void 0;
+var CustomerFundingInstructions;
+(function (CustomerFundingInstructions) {
+    CustomerFundingInstructions.AccountType = {
+        Checking: "checking",
+    };
+})(CustomerFundingInstructions || (exports.CustomerFundingInstructions = CustomerFundingInstructions = {}));

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

@@ -0,0 +1,4 @@
+export interface CustomerFundingInstructionsCreateRequest {
+    /** Currency of the virtual bank account. Only USD is supported today; defaults to USD. */
+    currency?: string;
+}

package/dist/cjs/api/types/CustomerFundingInstructionsCreateRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,25 +1,36 @@
 export interface CustomerUnit {
+    /** Paid's id for the unit (`cu_…`), unique within the organization and stable across renames of the customer. For reference only: no unit route accepts it, and routes and signals name a unit by its `externalId`. */
+    id: string;
     /** Your own id for the unit, unique within the customer; the identifier every unit route takes. */
     externalId: string;
+    /** Paid's id of the customer the unit belongs to (`cus_…`). `null` only for a legacy customer that has no Paid id; `customerExternalId` still names it. */
+    customerId: string | null;
+    /** Your external id of that customer, when it has one. */
+    customerExternalId: string | null;
     /** Display name. Never used to address the unit. */
     name: string;
     /** Your structural vocabulary for the unit. */
     externalType: string | null;
-    /** ACTIVE, or DELETED after a soft delete (one-way). */
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
     status: CustomerUnit.Status;
     /** `externalId` of the parent unit; `null` only on the customer's root unit. */
     parentExternalId: string | null;
     /** Whether this unit is the customer's root: the one unit without a parent. Derived from the missing parent, not stored. At most one active root per customer; the root cannot be moved, and once deleted a new root can be created. */
     isRoot: boolean;
+    /** The unit's own setting, as last created or updated: `false` marks it, and every unit under it, non-billable. Always `true` on the root. `effectiveBillable` says whether the unit is billable once its ancestors are counted. Usage on a non-billable unit is still recorded but not billed: it burns no credits, adds nothing to invoices or overage, and counts toward no cap, on a price whose usage comes from a meter (read from your events when the invoice closes) too. A meter's derived signal, and a correlation-window meter's window, follow the source event they take their unit from (the window's closing event, else its opening event): they are not billed when that event was not. Usage is still billed when it is sent with a customer API key, and on cost-plus pricing, which bills from costs that carry no unit. Only signals sent to `/api/v2/signals` that resolve to an active unit, by its key or through an alias on it, can be non-billable, and a change applies to signals received afterwards. */
+    billable: boolean;
+    /** Read-only. Whether the unit is billable in effect: `false` when the unit or any unit above it has `billable: false`. A unit cannot make itself billable under a non-billable ancestor, and moving a unit under one makes it non-billable. */
+    effectiveBillable: boolean;
     metadata: Record<string, unknown> | null;
     createdAt: string;
     updatedAt: string;
 }
 export declare namespace CustomerUnit {
-    /** ACTIVE, or DELETED after a soft delete (one-way). */
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
     const Status: {
         readonly Active: "ACTIVE";
         readonly Deleted: "DELETED";
+        readonly Draft: "DRAFT";
     };
     type Status = (typeof Status)[keyof typeof Status];
 }

package/dist/cjs/api/types/CustomerUnit.js

@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomerUnit = void 0;
 var CustomerUnit;
 (function (CustomerUnit) {
-    /** ACTIVE, or DELETED after a soft delete (one-way). */
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
     CustomerUnit.Status = {
         Active: "ACTIVE",
         Deleted: "DELETED",
+        Draft: "DRAFT",
     };
 })(CustomerUnit || (exports.CustomerUnit = CustomerUnit = {}));

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

@@ -1,7 +1,7 @@
 /**
- * The customer unit (a node in the customer's internal hierarchy) this usage belongs to. Optional; omit to attribute to the customer only.
+ * The customer unit (a node in the customer's internal hierarchy) this usage belongs to, by your key for the unit or by an alias that points at it. Paid's unit ID is not accepted. Sent with `customer`, the unit must belong to that customer. Omit to attribute to the customer only.
  */
 export interface CustomerUnitAttribution {
-    /** Your external customer unit ID. Cannot be `.` or `..`. */
+    /** Your external customer unit ID (the unit's key), or an alias that points at a unit. Cannot be `.` or `..`. */
     externalCustomerUnitId: string;
 }

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

@@ -0,0 +1,37 @@
+/**
+ * A customer unit as the organization-level routes return it: the customer-scoped unit shape without Paid's unit id.
+ */
+export interface CustomerUnitByKey {
+    /** Your own id for the unit, unique within the customer; the identifier every unit route takes. */
+    externalId: string;
+    /** Paid's id of the customer the unit belongs to (`cus_…`). `null` only for a legacy customer that has no Paid id; `customerExternalId` still names it. */
+    customerId: string | null;
+    /** Your external id of that customer, when it has one. */
+    customerExternalId: string | null;
+    /** Display name. Never used to address the unit. */
+    name: string;
+    /** Your structural vocabulary for the unit. */
+    externalType: string | null;
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
+    status: CustomerUnitByKey.Status;
+    /** `externalId` of the parent unit; `null` only on the customer's root unit. */
+    parentExternalId: string | null;
+    /** Whether this unit is the customer's root: the one unit without a parent. Derived from the missing parent, not stored. At most one active root per customer; the root cannot be moved, and once deleted a new root can be created. */
+    isRoot: boolean;
+    /** The unit's own setting, as last created or updated: `false` marks it, and every unit under it, non-billable. Always `true` on the root. `effectiveBillable` says whether the unit is billable once its ancestors are counted. Usage on a non-billable unit is still recorded but not billed: it burns no credits, adds nothing to invoices or overage, and counts toward no cap, on a price whose usage comes from a meter (read from your events when the invoice closes) too. A meter's derived signal, and a correlation-window meter's window, follow the source event they take their unit from (the window's closing event, else its opening event): they are not billed when that event was not. Usage is still billed when it is sent with a customer API key, and on cost-plus pricing, which bills from costs that carry no unit. Only signals sent to `/api/v2/signals` that resolve to an active unit, by its key or through an alias on it, can be non-billable, and a change applies to signals received afterwards. */
+    billable: boolean;
+    /** Read-only. Whether the unit is billable in effect: `false` when the unit or any unit above it has `billable: false`. A unit cannot make itself billable under a non-billable ancestor, and moving a unit under one makes it non-billable. */
+    effectiveBillable: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export declare namespace CustomerUnitByKey {
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
+    const Status: {
+        readonly Active: "ACTIVE";
+        readonly Deleted: "DELETED";
+        readonly Draft: "DRAFT";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/CustomerUnitByKey.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerUnitByKey = void 0;
+var CustomerUnitByKey;
+(function (CustomerUnitByKey) {
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
+    CustomerUnitByKey.Status = {
+        Active: "ACTIVE",
+        Deleted: "DELETED",
+        Draft: "DRAFT",
+    };
+})(CustomerUnitByKey || (exports.CustomerUnitByKey = CustomerUnitByKey = {}));

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

@@ -1,12 +1,14 @@
+import type * as Paid from "../index.js";
 /**
  * The cap version that was in force at the time of the call, now ended (`effectiveUntil` set). `null` when no version was in force — only scheduled versions were ended.
  */
 export interface CustomerUnitCapEndedPolicy {
     /** The cap, in credits of the currency. JSON number; exact within ±2^53. */
     amount: number;
-    /** Period length. Periods start on the day-of-month of `effectiveFrom` (UTC), clamped in shorter months. */
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
     frequency: CustomerUnitCapEndedPolicy.Frequency;
-    /** When this cap version started applying, and the anchor for its periods. */
+    schedule: Paid.CustomerUnitCapSchedule;
+    /** When this cap version started applying. The schedule independently defines its spend window. */
     effectiveFrom: string;
     /** When this cap version stopped applying (exclusive). */
     effectiveUntil: string;
@@ -16,7 +18,7 @@ export interface CustomerUnitCapEndedPolicy {
     source: string;
 }
 export declare namespace CustomerUnitCapEndedPolicy {
-    /** Period length. Periods start on the day-of-month of `effectiveFrom` (UTC), clamped in shorter months. */
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
     const Frequency: {
         readonly Monthly: "MONTHLY";
     };

package/dist/cjs/api/types/CustomerUnitCapEndedPolicy.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomerUnitCapEndedPolicy = void 0;
 var CustomerUnitCapEndedPolicy;
 (function (CustomerUnitCapEndedPolicy) {
-    /** Period length. Periods start on the day-of-month of `effectiveFrom` (UTC), clamped in shorter months. */
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
     CustomerUnitCapEndedPolicy.Frequency = {
         Monthly: "MONTHLY",
     };

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

@@ -1,12 +1,14 @@
+import type * as Paid from "../index.js";
 /**
  * The cap version in force now.
  */
 export interface CustomerUnitCapPolicy {
     /** The cap, in credits of the currency. JSON number; exact within ±2^53. */
     amount: number;
-    /** Period length. Periods start on the day-of-month of `effectiveFrom` (UTC), clamped in shorter months. */
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
     frequency: CustomerUnitCapPolicy.Frequency;
-    /** When this cap version started applying, and the anchor for its periods. */
+    schedule: Paid.CustomerUnitCapSchedule;
+    /** When this cap version started applying. The schedule independently defines its spend window. */
     effectiveFrom: string;
     /** When this cap version stopped applying (exclusive). `null` while it is open. */
     effectiveUntil: string | null;
@@ -16,7 +18,7 @@ export interface CustomerUnitCapPolicy {
     source: string;
 }
 export declare namespace CustomerUnitCapPolicy {
-    /** Period length. Periods start on the day-of-month of `effectiveFrom` (UTC), clamped in shorter months. */
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
     const Frequency: {
         readonly Monthly: "MONTHLY";
     };

package/dist/cjs/api/types/CustomerUnitCapPolicy.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomerUnitCapPolicy = void 0;
 var CustomerUnitCapPolicy;
 (function (CustomerUnitCapPolicy) {
-    /** Period length. Periods start on the day-of-month of `effectiveFrom` (UTC), clamped in shorter months. */
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
     CustomerUnitCapPolicy.Frequency = {
         Monthly: "MONTHLY",
     };

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

@@ -0,0 +1,26 @@
+import type * as Paid from "../index.js";
+/**
+ * The new version, or the existing version covering the requested effectiveFrom when changed is false. New versions are open; an existing version may have a finite end.
+ */
+export interface CustomerUnitCapSavedPolicy {
+    /** The cap, in credits of the currency. JSON number; exact within ±2^53. */
+    amount: number;
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    frequency: CustomerUnitCapSavedPolicy.Frequency;
+    schedule: Paid.CustomerUnitCapSchedule;
+    /** When this cap version started applying. The schedule independently defines its spend window. */
+    effectiveFrom: string;
+    /** When this cap version stopped applying (exclusive). `null` while it is open. */
+    effectiveUntil: string | null;
+    /** When this cap version was set. */
+    createdAt: string;
+    /** Where this cap version was set from. */
+    source: string;
+}
+export declare namespace CustomerUnitCapSavedPolicy {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    const Frequency: {
+        readonly Monthly: "MONTHLY";
+    };
+    type Frequency = (typeof Frequency)[keyof typeof Frequency];
+}

package/dist/cjs/api/types/CustomerUnitCapSavedPolicy.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerUnitCapSavedPolicy = void 0;
+var CustomerUnitCapSavedPolicy;
+(function (CustomerUnitCapSavedPolicy) {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    CustomerUnitCapSavedPolicy.Frequency = {
+        Monthly: "MONTHLY",
+    };
+})(CustomerUnitCapSavedPolicy || (exports.CustomerUnitCapSavedPolicy = CustomerUnitCapSavedPolicy = {}));