@paid-ai/paid-node 1.7.1 → 2.0.0

package/dist/esm/api/types/Customer.d.mts

@@ -1,5 +1,6 @@
 import type * as Paid from "../index.mjs";
 export interface Customer {
+    /** Stable Paid customer display ID. Use this value as the `{id}` path parameter for customer routes, for example `GET /api/v2/customers/cus_abc123/state`. */
     id: string;
     name: string;
     legalName: string | null;
@@ -7,12 +8,23 @@ export interface Customer {
     phone: string;
     website: string;
     externalId: string | null;
-    billingAddress?: Paid.CustomerBillingAddress | null;
+    billingAddress: Paid.CustomerBillingAddressResponse | null;
     creationState: Paid.CustomerCreationState;
+    /** Customer status: churned when the customer is marked as churned, active otherwise. */
+    status: Customer.Status;
     churnDate: string | null;
     vatNumber: string | null;
     metadata: Record<string, unknown> | null;
-    defaultCurrency: string;
+    defaultCurrency: Paid.CurrencyCode;
+    connections: Paid.CustomerConnections;
     createdAt: string;
     updatedAt: string;
 }
+export declare namespace Customer {
+    /** Customer status: churned when the customer is marked as churned, active otherwise. */
+    const Status: {
+        readonly Active: "active";
+        readonly Churned: "churned";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/Customer.mjs

@@ -1,2 +1,9 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var Customer;
+(function (Customer) {
+    /** Customer status: churned when the customer is marked as churned, active otherwise. */
+    Customer.Status = {
+        Active: "active",
+        Churned: "churned",
+    };
+})(Customer || (Customer = {}));

package/dist/esm/api/types/CustomerAlias.d.mts

@@ -0,0 +1,12 @@
+export interface CustomerAlias {
+    /** Alternate external identifier that resolves to the customer. */
+    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;
+    updatedAt: string;
+}

package/dist/esm/api/types/CustomerAlias.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerAliasCreateRequest.d.mts

@@ -0,0 +1,8 @@
+export interface CustomerAliasCreateRequest {
+    /** Alternate external identifier that should resolve to this customer. */
+    alias: string;
+    /** Optional display name for this alias. */
+    name?: string;
+    /** Optional note describing where this alias comes from. */
+    description?: string;
+}

package/dist/esm/api/types/CustomerAliasCreateRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerAliasListResponse.d.mts

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

package/dist/esm/api/types/CustomerAliasListResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerApiKey.d.mts

@@ -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/esm/api/types/CustomerApiKey.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export 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 || (CustomerApiKey = {}));

package/dist/esm/api/types/CustomerApiKeyCreate.d.mts

@@ -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/esm/api/types/CustomerApiKeyCreate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerApiKeyCreated.d.mts

@@ -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/esm/api/types/CustomerApiKeyCreated.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export 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 || (CustomerApiKeyCreated = {}));

package/dist/esm/api/types/CustomerApiKeyList.d.mts

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

package/dist/esm/api/types/CustomerApiKeyList.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerAttribution.d.mts

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

package/dist/{cjs/api/types/CustomerBillingAddress.d.ts → esm/api/types/CustomerBillingAddressInput.d.mts}

@@ -1,4 +1,4 @@
-export interface CustomerBillingAddress {
+export interface CustomerBillingAddressInput {
     line1?: string;
     line2?: string;
     city?: string;

package/dist/esm/api/types/CustomerBillingAddressInput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerBillingAddressResponse.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Customer billing address, or null when no address is set.
+ */
+export interface CustomerBillingAddressResponse {
+    line1?: string;
+    line2?: string;
+    city?: string;
+    state?: string;
+    zipCode?: string;
+    country?: string;
+}

package/dist/esm/api/types/CustomerBillingAddressResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerConnections.d.mts

@@ -0,0 +1,7 @@
+import type * as Paid from "../index.mjs";
+/**
+ * Linked external system IDs for this customer.
+ */
+export interface CustomerConnections {
+    stripe: Paid.StripeConnection | null;
+}

package/dist/esm/api/types/CustomerConnections.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerFundingInstructions.d.mts

@@ -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/esm/api/types/CustomerFundingInstructions.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerFundingInstructions;
+(function (CustomerFundingInstructions) {
+    CustomerFundingInstructions.AccountType = {
+        Checking: "checking",
+    };
+})(CustomerFundingInstructions || (CustomerFundingInstructions = {}));

package/dist/esm/api/types/CustomerFundingInstructionsCreateRequest.d.mts

@@ -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/esm/api/types/CustomerFundingInstructionsCreateRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerState.d.mts

@@ -0,0 +1,10 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerState {
+    customer: Paid.CustomerStateCustomer;
+    defaultCurrency: Paid.CurrencyCode;
+    orders: Paid.CustomerStateOrder[];
+    seats: Paid.CustomerStateSeats;
+    checkoutLinks: Paid.CustomerStateCheckoutLink[];
+    credits: Paid.CustomerStateCreditSummary;
+    timestamp: string;
+}

package/dist/esm/api/types/CustomerState.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerStateCheckoutLink.d.mts

@@ -0,0 +1,18 @@
+export interface CustomerStateCheckoutLink {
+    id: string;
+    url: string;
+    status: CustomerStateCheckoutLink.Status;
+    productIds: string[];
+    singleUse: boolean;
+    allowedCurrencies: string[];
+    expiresAt: string | null;
+}
+export declare namespace CustomerStateCheckoutLink {
+    const Status: {
+        readonly Active: "active";
+        readonly Completed: "completed";
+        readonly Expired: "expired";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/CustomerStateCheckoutLink.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerStateCheckoutLink;
+(function (CustomerStateCheckoutLink) {
+    CustomerStateCheckoutLink.Status = {
+        Active: "active",
+        Completed: "completed",
+        Expired: "expired",
+        Archived: "archived",
+    };
+})(CustomerStateCheckoutLink || (CustomerStateCheckoutLink = {}));

package/dist/esm/api/types/CustomerStateCreditBalance.d.mts

@@ -0,0 +1,6 @@
+export interface CustomerStateCreditBalance {
+    creditsCurrencyId: string;
+    currencyName: string;
+    currencyKey: string;
+    balance: number;
+}

package/dist/esm/api/types/CustomerStateCreditBalance.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerStateCreditSummary.d.mts

@@ -0,0 +1,4 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerStateCreditSummary {
+    balances: Paid.CustomerStateCreditBalance[];
+}

package/dist/esm/api/types/CustomerStateCreditSummary.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerStateCustomer.d.mts

@@ -0,0 +1,8 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerStateCustomer {
+    /** Stable Paid customer display ID. Use this value as the `{id}` path parameter for customer routes, for example `GET /api/v2/customers/cus_abc123/state`. */
+    id: string;
+    name: string;
+    externalId: string | null;
+    billingAddress: Paid.CustomerBillingAddressResponse | null;
+}

package/dist/esm/api/types/CustomerStateCustomer.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerStateOrder.d.mts

@@ -0,0 +1,21 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerStateOrder {
+    id: string;
+    externalId: string | null;
+    name: string;
+    state: CustomerStateOrder.State;
+    currency: Paid.CurrencyCode;
+    startDate: string;
+    endDate: string | null;
+    /** When the order stops applying; null means no scheduled end. */
+    effectiveUntil: string | null;
+}
+export declare namespace CustomerStateOrder {
+    const State: {
+        readonly Draft: "draft";
+        readonly Active: "active";
+        readonly Paused: "paused";
+        readonly Ended: "ended";
+    };
+    type State = (typeof State)[keyof typeof State];
+}

package/dist/esm/api/types/CustomerStateOrder.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerStateOrder;
+(function (CustomerStateOrder) {
+    CustomerStateOrder.State = {
+        Draft: "draft",
+        Active: "active",
+        Paused: "paused",
+        Ended: "ended",
+    };
+})(CustomerStateOrder || (CustomerStateOrder = {}));

package/dist/esm/api/types/CustomerStateProductRef.d.mts

@@ -0,0 +1,5 @@
+export interface CustomerStateProductRef {
+    id: string;
+    externalId: string | null;
+    name: string;
+}

package/dist/esm/api/types/CustomerStateProductRef.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerStateSeat.d.mts

@@ -0,0 +1,17 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerStateSeat {
+    /** Seat UUID. Seats do not currently have display IDs; use this value as `{seatId}` with the order seat assignment endpoints. */
+    id: string;
+    orderId: string;
+    product: Paid.CustomerStateProductRef;
+    status: CustomerStateSeat.Status;
+    assignee: Paid.CustomerStateSeatAssignee | null;
+    credits: Paid.CustomerStateCreditSummary;
+}
+export declare namespace CustomerStateSeat {
+    const Status: {
+        readonly Assigned: "assigned";
+        readonly Unassigned: "unassigned";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/CustomerStateSeat.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerStateSeat;
+(function (CustomerStateSeat) {
+    CustomerStateSeat.Status = {
+        Assigned: "assigned",
+        Unassigned: "unassigned",
+    };
+})(CustomerStateSeat || (CustomerStateSeat = {}));

package/dist/esm/api/types/CustomerStateSeatAssignee.d.mts

@@ -0,0 +1,6 @@
+export interface CustomerStateSeatAssignee {
+    id: string;
+    externalId: string;
+    name: string | null;
+    email: string | null;
+}

package/dist/esm/api/types/CustomerStateSeatAssignee.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerStateSeats.d.mts

@@ -0,0 +1,7 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerStateSeats {
+    total: number;
+    assigned: number;
+    unassigned: number;
+    data: Paid.CustomerStateSeat[];
+}

package/dist/esm/api/types/CustomerStateSeats.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnit.d.mts

@@ -0,0 +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; 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; 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/esm/api/types/CustomerUnit.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerUnit;
+(function (CustomerUnit) {
+    /** 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 || (CustomerUnit = {}));

package/dist/esm/api/types/CustomerUnitAttribution.d.mts

@@ -0,0 +1,7 @@
+/**
+ * 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 (the unit's key), or an alias that points at a unit. Cannot be `.` or `..`. */
+    externalCustomerUnitId: string;
+}

package/dist/esm/api/types/CustomerUnitAttribution.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitByKey.d.mts

@@ -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/esm/api/types/CustomerUnitByKey.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export 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 || (CustomerUnitByKey = {}));

package/dist/esm/api/types/CustomerUnitCapCurrentPeriod.d.mts

@@ -0,0 +1,11 @@
+import type * as Paid from "../index.mjs";
+/**
+ * Usage in the current period, when the returned version is in force now and usage is available; otherwise `null`.
+ */
+export interface CustomerUnitCapCurrentPeriod {
+    window: Paid.CustomerUnitCapPeriod;
+    /** Credits of this currency spent by this unit and its descendants during the window. JSON number; exact within ±2^53. */
+    used: number;
+    /** `amount - used`; negative once the cap is exceeded. Advisory: spend may land between this read and the next burn. */
+    remaining: number;
+}

package/dist/esm/api/types/CustomerUnitCapCurrentPeriod.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitCapEndResponse.d.mts

@@ -0,0 +1,12 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerUnitCapEndResponse {
+    /** Your own id for the unit (its `externalId`), the identifier the unit and cap routes take. */
+    externalCustomerUnitId: string;
+    /** The Paid display id of the customer the unit belongs to. */
+    customerId: string;
+    /** The credits currency this cap limits. The cap's `amount` is in this currency's credits. */
+    creditsCurrencyId: string;
+    policy: Paid.CustomerUnitCapEndedPolicy | null;
+    /** How many versions were closed by this call: the one in force, older overlapping versions still open, and scheduled versions. At least 1. */
+    endedVersions: number;
+}

package/dist/esm/api/types/CustomerUnitCapEndResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};