@usehercules/sdk 1.11.0 → 1.12.0

package/resources/commerce/customers/balance-transactions.d.ts

@@ -0,0 +1,4 @@
+import { APIResource } from "../../../core/resource.js";
+export declare class BalanceTransactions extends APIResource {
+}
+//# sourceMappingURL=balance-transactions.d.ts.map

package/resources/commerce/customers/balance-transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance-transactions.d.ts","sourceRoot":"","sources":["../../../src/resources/commerce/customers/balance-transactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,mBAAoB,SAAQ,WAAW;CAAG"}

package/resources/commerce/customers/balance-transactions.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BalanceTransactions = void 0;
+const resource_1 = require("../../../core/resource.js");
+class BalanceTransactions extends resource_1.APIResource {
+}
+exports.BalanceTransactions = BalanceTransactions;
+//# sourceMappingURL=balance-transactions.js.map

package/resources/commerce/customers/balance-transactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance-transactions.js","sourceRoot":"","sources":["../../../src/resources/commerce/customers/balance-transactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,MAAa,mBAAoB,SAAQ,sBAAW;CAAG;AAAvD,kDAAuD"}

package/resources/commerce/customers/balance-transactions.mjs

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+export class BalanceTransactions extends APIResource {
+}
+//# sourceMappingURL=balance-transactions.mjs.map

package/resources/commerce/customers/balance-transactions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance-transactions.mjs","sourceRoot":"","sources":["../../../src/resources/commerce/customers/balance-transactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAEtB,MAAM,OAAO,mBAAoB,SAAQ,WAAW;CAAG"}

package/resources/{beta/commerce → commerce/customers}/customers.d.mts

@@ -1,40 +1,73 @@
 import { APIResource } from "../../../core/resource.mjs";
+import * as BalanceTransactionsAPI from "./balance-transactions.mjs";
+import { BalanceTransactions } from "./balance-transactions.mjs";
 import { APIPromise } from "../../../core/api-promise.mjs";
 import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
 import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class Customers extends APIResource {
+    balanceTransactions: BalanceTransactionsAPI.BalanceTransactions;
     /**
      * Creates a new billable customer. A customer represents the entity in your app
      * that will be charged—typically a user, organization, or project. Hercules
      * recommends creating a customer immediately after creating the corresponding
      * entity in your app.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.create();
+     * ```
      */
     create(body?: CustomerCreateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
     /**
      * Updates an existing customer. Use this to modify contact information or billing
      * address. Only provided fields are updated; omitted fields remain unchanged.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.update(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     update(customerID: string, body?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
     /**
      * Retrieves a paginated list of all customers. Customers are the billable entities
      * in your app—typically users, organizations, or projects.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customer of client.commerce.customers.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomersCursorIDPage, Customer>;
-    /**
-     * Permanently deletes a customer. This also cancels any active subscriptions. This
-     * action cannot be undone.
-     */
-    delete(customerID: string, options?: RequestOptions): APIPromise<void>;
     /**
      * Generates a URL to a hosted billing portal where the customer can view invoices,
      * update payment methods, and manage billing details. Redirect the customer to the
      * returned URL.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.commerce.customers.billingPortal(
+     *     'cus_1234567890',
+     *   );
+     * ```
      */
     billingPortal(customerID: string, body?: CustomerBillingPortalParams | null | undefined, options?: RequestOptions): APIPromise<CustomerBillingPortalResponse>;
     /**
      * Retrieves a customer by ID. Returns the customer object including contact
      * information, billing address, active subscriptions, recent invoices, and saved
      * payment methods.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.get(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     get(customerID: string, options?: RequestOptions): APIPromise<CustomerGetResponse>;
 }
@@ -45,7 +78,7 @@ export type CustomersCursorIDPage = CursorIDPage<Customer>;
  */
 export interface Customer {
     /**
-     * Unique identifier for the topic subscription
+     * Unique identifier for the customer
      */
     id: string;
     /**
@@ -113,7 +146,7 @@ export interface CustomerBillingPortalResponse {
  */
 export interface CustomerGetResponse {
     /**
-     * Unique identifier for the topic subscription
+     * Unique identifier for the customer
      */
     id: string;
     /**
@@ -124,6 +157,11 @@ export interface CustomerGetResponse {
      * The customer's billing address
      */
     address?: CustomerAddress | null;
+    /**
+     * Current customer balance in cents (negative = credit available to apply to
+     * future invoices)
+     */
+    balance?: number;
     /**
      * The customer's email address for receipts and notifications
      */
@@ -155,7 +193,7 @@ export declare namespace CustomerGetResponse {
      */
     interface Invoice {
         /**
-         * Unique identifier for the topic subscription
+         * Unique identifier for the invoice
          */
         id: string;
         /**
@@ -224,7 +262,7 @@ export declare namespace CustomerGetResponse {
      */
     interface PaymentMethod {
         /**
-         * Unique identifier for the topic subscription
+         * Unique identifier for the payment method
          */
         id: string;
         /**
@@ -272,7 +310,7 @@ export declare namespace CustomerGetResponse {
      */
     interface Subscription {
         /**
-         * Unique identifier for the topic subscription
+         * Unique identifier for the subscription
          */
         id: string;
         /**
@@ -322,7 +360,7 @@ export declare namespace CustomerGetResponse {
          */
         interface Product {
             /**
-             * Unique identifier for the topic subscription
+             * Unique identifier for the product
              */
             id: string;
             /**
@@ -335,7 +373,7 @@ export declare namespace CustomerGetResponse {
          */
         interface Variant {
             /**
-             * Unique identifier for the topic subscription
+             * Unique identifier for the variant
              */
             id: string;
             /**
@@ -439,5 +477,6 @@ export interface CustomerBillingPortalParams {
 }
 export declare namespace Customers {
     export { type Customer as Customer, type CustomerAddress as CustomerAddress, type CustomerBillingPortalResponse as CustomerBillingPortalResponse, type CustomerGetResponse as CustomerGetResponse, type CustomersCursorIDPage as CustomersCursorIDPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerBillingPortalParams as CustomerBillingPortalParams, };
+    export { BalanceTransactions as BalanceTransactions };
 }
 //# sourceMappingURL=customers.d.mts.map

package/resources/commerce/customers/customers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.mts","sourceRoot":"","sources":["../../../src/resources/commerce/customers/customers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,sBAAsB;OAC3B,EAAE,mBAAmB,EAAE;OACvB,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,mBAAmB,EAAE,sBAAsB,CAAC,mBAAmB,CACA;IAE/D;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1G;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAI/C;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGnF;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;CACzD;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,eAAe,GAAG,IAAI,CAAC;KACtE;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QAEnE;;WAEG;QACH,IAAI,CAAC,EAAE,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,oBAAoB,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B;;WAEG;QACH,MAAM,EACF,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,oBAAoB,GACpB,UAAU,GACV,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EAAE,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACvD"}

package/resources/{beta/commerce → commerce/customers}/customers.d.ts

@@ -1,40 +1,73 @@
 import { APIResource } from "../../../core/resource.js";
+import * as BalanceTransactionsAPI from "./balance-transactions.js";
+import { BalanceTransactions } from "./balance-transactions.js";
 import { APIPromise } from "../../../core/api-promise.js";
 import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../core/pagination.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Customers extends APIResource {
+    balanceTransactions: BalanceTransactionsAPI.BalanceTransactions;
     /**
      * Creates a new billable customer. A customer represents the entity in your app
      * that will be charged—typically a user, organization, or project. Hercules
      * recommends creating a customer immediately after creating the corresponding
      * entity in your app.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.create();
+     * ```
      */
     create(body?: CustomerCreateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
     /**
      * Updates an existing customer. Use this to modify contact information or billing
      * address. Only provided fields are updated; omitted fields remain unchanged.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.update(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     update(customerID: string, body?: CustomerUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Customer>;
     /**
      * Retrieves a paginated list of all customers. Customers are the billable entities
      * in your app—typically users, organizations, or projects.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customer of client.commerce.customers.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomersCursorIDPage, Customer>;
-    /**
-     * Permanently deletes a customer. This also cancels any active subscriptions. This
-     * action cannot be undone.
-     */
-    delete(customerID: string, options?: RequestOptions): APIPromise<void>;
     /**
      * Generates a URL to a hosted billing portal where the customer can view invoices,
      * update payment methods, and manage billing details. Redirect the customer to the
      * returned URL.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.commerce.customers.billingPortal(
+     *     'cus_1234567890',
+     *   );
+     * ```
      */
     billingPortal(customerID: string, body?: CustomerBillingPortalParams | null | undefined, options?: RequestOptions): APIPromise<CustomerBillingPortalResponse>;
     /**
      * Retrieves a customer by ID. Returns the customer object including contact
      * information, billing address, active subscriptions, recent invoices, and saved
      * payment methods.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.get(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     get(customerID: string, options?: RequestOptions): APIPromise<CustomerGetResponse>;
 }
@@ -45,7 +78,7 @@ export type CustomersCursorIDPage = CursorIDPage<Customer>;
  */
 export interface Customer {
     /**
-     * Unique identifier for the topic subscription
+     * Unique identifier for the customer
      */
     id: string;
     /**
@@ -113,7 +146,7 @@ export interface CustomerBillingPortalResponse {
  */
 export interface CustomerGetResponse {
     /**
-     * Unique identifier for the topic subscription
+     * Unique identifier for the customer
      */
     id: string;
     /**
@@ -124,6 +157,11 @@ export interface CustomerGetResponse {
      * The customer's billing address
      */
     address?: CustomerAddress | null;
+    /**
+     * Current customer balance in cents (negative = credit available to apply to
+     * future invoices)
+     */
+    balance?: number;
     /**
      * The customer's email address for receipts and notifications
      */
@@ -155,7 +193,7 @@ export declare namespace CustomerGetResponse {
      */
     interface Invoice {
         /**
-         * Unique identifier for the topic subscription
+         * Unique identifier for the invoice
          */
         id: string;
         /**
@@ -224,7 +262,7 @@ export declare namespace CustomerGetResponse {
      */
     interface PaymentMethod {
         /**
-         * Unique identifier for the topic subscription
+         * Unique identifier for the payment method
          */
         id: string;
         /**
@@ -272,7 +310,7 @@ export declare namespace CustomerGetResponse {
      */
     interface Subscription {
         /**
-         * Unique identifier for the topic subscription
+         * Unique identifier for the subscription
          */
         id: string;
         /**
@@ -322,7 +360,7 @@ export declare namespace CustomerGetResponse {
          */
         interface Product {
             /**
-             * Unique identifier for the topic subscription
+             * Unique identifier for the product
              */
             id: string;
             /**
@@ -335,7 +373,7 @@ export declare namespace CustomerGetResponse {
          */
         interface Variant {
             /**
-             * Unique identifier for the topic subscription
+             * Unique identifier for the variant
              */
             id: string;
             /**
@@ -439,5 +477,6 @@ export interface CustomerBillingPortalParams {
 }
 export declare namespace Customers {
     export { type Customer as Customer, type CustomerAddress as CustomerAddress, type CustomerBillingPortalResponse as CustomerBillingPortalResponse, type CustomerGetResponse as CustomerGetResponse, type CustomersCursorIDPage as CustomersCursorIDPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerBillingPortalParams as CustomerBillingPortalParams, };
+    export { BalanceTransactions as BalanceTransactions };
 }
 //# sourceMappingURL=customers.d.ts.map

package/resources/commerce/customers/customers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.ts","sourceRoot":"","sources":["../../../src/resources/commerce/customers/customers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,sBAAsB;OAC3B,EAAE,mBAAmB,EAAE;OACvB,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,mBAAmB,EAAE,sBAAsB,CAAC,mBAAmB,CACA;IAE/D;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1G;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IAIvB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAI/C;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGnF;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;CACzD;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,eAAe,GAAG,IAAI,CAAC;KACtE;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QAEnE;;WAEG;QACH,IAAI,CAAC,EAAE,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,oBAAoB,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;QAE9B;;WAEG;QACH,MAAM,EACF,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,oBAAoB,GACpB,UAAU,GACV,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EAAE,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACvD"}

package/resources/{beta/commerce → commerce/customers}/customers.js

@@ -2,16 +2,27 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Customers = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
 const resource_1 = require("../../../core/resource.js");
+const BalanceTransactionsAPI = tslib_1.__importStar(require("./balance-transactions.js"));
+const balance_transactions_1 = require("./balance-transactions.js");
 const pagination_1 = require("../../../core/pagination.js");
-const headers_1 = require("../../../internal/headers.js");
 const path_1 = require("../../../internal/utils/path.js");
 class Customers extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.balanceTransactions = new BalanceTransactionsAPI.BalanceTransactions(this._client);
+    }
     /**
      * Creates a new billable customer. A customer represents the entity in your app
      * that will be charged—typically a user, organization, or project. Hercules
      * recommends creating a customer immediately after creating the corresponding
      * entity in your app.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.create();
+     * ```
      */
     create(body = {}, options) {
         return this._client.post('/v1/commerce/customers', { body, ...options });
@@ -19,6 +30,13 @@ class Customers extends resource_1.APIResource {
     /**
      * Updates an existing customer. Use this to modify contact information or billing
      * address. Only provided fields are updated; omitted fields remain unchanged.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.update(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     update(customerID, body = {}, options) {
         return this._client.patch((0, path_1.path) `/v1/commerce/customers/${customerID}`, { body, ...options });
@@ -26,24 +44,30 @@ class Customers extends resource_1.APIResource {
     /**
      * Retrieves a paginated list of all customers. Customers are the billable entities
      * in your app—typically users, organizations, or projects.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customer of client.commerce.customers.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/commerce/customers', (pagination_1.CursorIDPage), { query, ...options });
     }
-    /**
-     * Permanently deletes a customer. This also cancels any active subscriptions. This
-     * action cannot be undone.
-     */
-    delete(customerID, options) {
-        return this._client.delete((0, path_1.path) `/v1/commerce/customers/${customerID}`, {
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
     /**
      * Generates a URL to a hosted billing portal where the customer can view invoices,
      * update payment methods, and manage billing details. Redirect the customer to the
      * returned URL.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.commerce.customers.billingPortal(
+     *     'cus_1234567890',
+     *   );
+     * ```
      */
     billingPortal(customerID, body = {}, options) {
         return this._client.post((0, path_1.path) `/v1/commerce/customers/${customerID}/billing_portal`, { body, ...options });
@@ -52,10 +76,18 @@ class Customers extends resource_1.APIResource {
      * Retrieves a customer by ID. Returns the customer object including contact
      * information, billing address, active subscriptions, recent invoices, and saved
      * payment methods.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.get(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     get(customerID, options) {
         return this._client.get((0, path_1.path) `/v1/commerce/customers/${customerID}`, options);
     }
 }
 exports.Customers = Customers;
+Customers.BalanceTransactions = balance_transactions_1.BalanceTransactions;
 //# sourceMappingURL=customers.js.map

package/resources/commerce/customers/customers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../src/resources/commerce/customers/customers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,0FAAiE;AACjE,oEAA6D;AAE7D,4DAA8F;AAE9F,0DAAoD;AAEpD,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,wBAAmB,GACjB,IAAI,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2FjE,CAAC;IAzFC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAgD,EAAE,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAkB,EAClB,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,yBAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,UAAkB,EAClB,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF;AA7FD,8BA6FC;AAgfD,SAAS,CAAC,mBAAmB,GAAG,0CAAmB,CAAC"}

package/resources/{beta/commerce → commerce/customers}/customers.mjs

@@ -1,14 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../../core/resource.mjs";
+import * as BalanceTransactionsAPI from "./balance-transactions.mjs";
+import { BalanceTransactions } from "./balance-transactions.mjs";
 import { CursorIDPage } from "../../../core/pagination.mjs";
-import { buildHeaders } from "../../../internal/headers.mjs";
 import { path } from "../../../internal/utils/path.mjs";
 export class Customers extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.balanceTransactions = new BalanceTransactionsAPI.BalanceTransactions(this._client);
+    }
     /**
      * Creates a new billable customer. A customer represents the entity in your app
      * that will be charged—typically a user, organization, or project. Hercules
      * recommends creating a customer immediately after creating the corresponding
      * entity in your app.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.create();
+     * ```
      */
     create(body = {}, options) {
         return this._client.post('/v1/commerce/customers', { body, ...options });
@@ -16,6 +26,13 @@ export class Customers extends APIResource {
     /**
      * Updates an existing customer. Use this to modify contact information or billing
      * address. Only provided fields are updated; omitted fields remain unchanged.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.update(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     update(customerID, body = {}, options) {
         return this._client.patch(path `/v1/commerce/customers/${customerID}`, { body, ...options });
@@ -23,24 +40,30 @@ export class Customers extends APIResource {
     /**
      * Retrieves a paginated list of all customers. Customers are the billable entities
      * in your app—typically users, organizations, or projects.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customer of client.commerce.customers.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/commerce/customers', (CursorIDPage), { query, ...options });
     }
-    /**
-     * Permanently deletes a customer. This also cancels any active subscriptions. This
-     * action cannot be undone.
-     */
-    delete(customerID, options) {
-        return this._client.delete(path `/v1/commerce/customers/${customerID}`, {
-            ...options,
-            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-        });
-    }
     /**
      * Generates a URL to a hosted billing portal where the customer can view invoices,
      * update payment methods, and manage billing details. Redirect the customer to the
      * returned URL.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.commerce.customers.billingPortal(
+     *     'cus_1234567890',
+     *   );
+     * ```
      */
     billingPortal(customerID, body = {}, options) {
         return this._client.post(path `/v1/commerce/customers/${customerID}/billing_portal`, { body, ...options });
@@ -49,9 +72,17 @@ export class Customers extends APIResource {
      * Retrieves a customer by ID. Returns the customer object including contact
      * information, billing address, active subscriptions, recent invoices, and saved
      * payment methods.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.commerce.customers.get(
+     *   'cus_1234567890',
+     * );
+     * ```
      */
     get(customerID, options) {
         return this._client.get(path `/v1/commerce/customers/${customerID}`, options);
     }
 }
+Customers.BalanceTransactions = BalanceTransactions;
 //# sourceMappingURL=customers.mjs.map

package/resources/commerce/customers/customers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.mjs","sourceRoot":"","sources":["../../../src/resources/commerce/customers/customers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,sBAAsB;OAC3B,EAAE,mBAAmB,EAAE;OAEvB,EAAE,YAAY,EAAwC;OAEtD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,wBAAmB,GACjB,IAAI,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2FjE,CAAC;IAzFC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAgD,EAAE,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAkB,EAClB,OAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,0BAA0B,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,YAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,UAAkB,EAClB,OAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,UAAU,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF;AAgfD,SAAS,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}

package/resources/commerce/customers/index.d.mts

@@ -0,0 +1,3 @@
+export { BalanceTransactions } from "./balance-transactions.mjs";
+export { Customers, type Customer, type CustomerAddress, type CustomerBillingPortalResponse, type CustomerGetResponse, type CustomerCreateParams, type CustomerUpdateParams, type CustomerListParams, type CustomerBillingPortalParams, type CustomersCursorIDPage, } from "./customers.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/commerce/customers/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/commerce/customers/index.ts"],"names":[],"mappings":"OAEO,EAAE,mBAAmB,EAAE;OACvB,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,6BAA6B,EAClC,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,GAC3B"}

package/resources/commerce/customers/index.d.ts

@@ -0,0 +1,3 @@
+export { BalanceTransactions } from "./balance-transactions.js";
+export { Customers, type Customer, type CustomerAddress, type CustomerBillingPortalResponse, type CustomerGetResponse, type CustomerCreateParams, type CustomerUpdateParams, type CustomerListParams, type CustomerBillingPortalParams, type CustomersCursorIDPage, } from "./customers.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/commerce/customers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/commerce/customers/index.ts"],"names":[],"mappings":"OAEO,EAAE,mBAAmB,EAAE;OACvB,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,6BAA6B,EAClC,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,GAC3B"}

package/resources/commerce/customers/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Customers = exports.BalanceTransactions = void 0;
+var balance_transactions_1 = require("./balance-transactions.js");
+Object.defineProperty(exports, "BalanceTransactions", { enumerable: true, get: function () { return balance_transactions_1.BalanceTransactions; } });
+var customers_1 = require("./customers.js");
+Object.defineProperty(exports, "Customers", { enumerable: true, get: function () { return customers_1.Customers; } });
+//# sourceMappingURL=index.js.map

package/resources/commerce/customers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/commerce/customers/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kEAA6D;AAApD,2HAAA,mBAAmB,OAAA;AAC5B,4CAWqB;AAVnB,sGAAA,SAAS,OAAA"}

package/resources/commerce/customers/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { BalanceTransactions } from "./balance-transactions.mjs";
+export { Customers, } from "./customers.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/commerce/customers/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/commerce/customers/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,mBAAmB,EAAE;OACvB,EACL,SAAS,GAUV"}

package/resources/commerce/customers.d.mts

@@ -0,0 +1,2 @@
+export * from "./customers/index.mjs";
+//# sourceMappingURL=customers.d.mts.map

package/resources/commerce/customers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.mts","sourceRoot":"","sources":["../../src/resources/commerce/customers.ts"],"names":[],"mappings":""}

package/resources/commerce/customers.d.ts

@@ -0,0 +1,2 @@
+export * from "./customers/index.js";
+//# sourceMappingURL=customers.d.ts.map

package/resources/commerce/customers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.ts","sourceRoot":"","sources":["../../src/resources/commerce/customers.ts"],"names":[],"mappings":""}