@paid-ai/paid-node 1.7.0 → 1.8.0

package/dist/esm/api/resources/customers/client/Client.d.mts

@@ -43,7 +43,65 @@ export declare class Customers {
     createCustomer(request: Paid.CreateCustomerRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __createCustomer;
     /**
-     * Get a customer by ID
+     * List alternate external identifiers that resolve to a customer by Paid display ID.
+     *
+     * @param {Paid.ListCustomerAliasesRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.listCustomerAliases({
+     *         id: "cus_abc123"
+     *     })
+     */
+    listCustomerAliases(request: Paid.ListCustomerAliasesRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerAliasListResponse>;
+    private __listCustomerAliases;
+    /**
+     * Create an alternate external identifier for a customer by Paid display ID.
+     *
+     * @param {Paid.CreateCustomerAliasRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.createCustomerAlias({
+     *         id: "cus_abc123",
+     *         body: {
+     *             alias: "child-customer-1"
+     *         }
+     *     })
+     */
+    createCustomerAlias(request: Paid.CreateCustomerAliasRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerAlias>;
+    private __createCustomerAlias;
+    /**
+     * Remove an alternate external identifier from a customer by Paid display ID.
+     *
+     * @param {Paid.DeleteCustomerAliasRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.deleteCustomerAlias({
+     *         id: "cus_abc123",
+     *         alias: "child-customer-1"
+     *     })
+     */
+    deleteCustomerAlias(request: Paid.DeleteCustomerAliasRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.EmptyResponse>;
+    private __deleteCustomerAlias;
+    /**
+     * Get a customer by Paid display ID. Use the value returned as `customer.id`, for example `cus_abc123`. If you have your own customer ID, use `GET /api/v2/customers/external/{externalId}`.
      *
      * @param {Paid.GetCustomerByIdRequest} request
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
@@ -54,13 +112,13 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.getCustomerById({
-     *         id: "id"
+     *         id: "cus_abc123"
      *     })
      */
     getCustomerById(request: Paid.GetCustomerByIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __getCustomerById;
     /**
-     * Update a customer by ID
+     * Update a customer by Paid display ID. Use the value returned as `customer.id`, for example `cus_abc123`. If you have your own customer ID, use `PUT /api/v2/customers/external/{externalId}`.
      *
      * @param {Paid.UpdateCustomerByIdRequest} request
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
@@ -72,14 +130,14 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.updateCustomerById({
-     *         id: "id",
+     *         id: "cus_abc123",
      *         body: {}
      *     })
      */
     updateCustomerById(request: Paid.UpdateCustomerByIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
     private __updateCustomerById;
     /**
-     * Delete a customer by ID
+     * Delete a customer by Paid display ID. Use the value returned as `customer.id`, for example `cus_abc123`. If you have your own customer ID, use `DELETE /api/v2/customers/external/{externalId}`.
      *
      * @param {Paid.DeleteCustomerByIdRequest} request
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
@@ -91,11 +149,86 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.deleteCustomerById({
-     *         id: "id"
+     *         id: "cus_abc123"
      *     })
      */
     deleteCustomerById(request: Paid.DeleteCustomerByIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.EmptyResponse>;
     private __deleteCustomerById;
+    /**
+     * Get the current customer state by Paid display ID
+     *
+     * @param {Paid.GetCustomerStateByIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.getCustomerStateById({
+     *         id: "cus_abc123"
+     *     })
+     */
+    getCustomerStateById(request: Paid.GetCustomerStateByIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerState>;
+    private __getCustomerStateById;
+    /**
+     * List alternate external identifiers that resolve to a customer by external ID.
+     *
+     * @param {Paid.ListCustomerAliasesByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.listCustomerAliasesByExternalId({
+     *         externalId: "customer_123"
+     *     })
+     */
+    listCustomerAliasesByExternalId(request: Paid.ListCustomerAliasesByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerAliasListResponse>;
+    private __listCustomerAliasesByExternalId;
+    /**
+     * Create an alternate external identifier for a customer by external ID.
+     *
+     * @param {Paid.CreateCustomerAliasByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.createCustomerAliasByExternalId({
+     *         externalId: "customer_123",
+     *         body: {
+     *             alias: "child-customer-1"
+     *         }
+     *     })
+     */
+    createCustomerAliasByExternalId(request: Paid.CreateCustomerAliasByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerAlias>;
+    private __createCustomerAliasByExternalId;
+    /**
+     * Remove an alternate external identifier from a customer by external ID.
+     *
+     * @param {Paid.DeleteCustomerAliasByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.deleteCustomerAliasByExternalId({
+     *         externalId: "customer_123",
+     *         alias: "child-customer-1"
+     *     })
+     */
+    deleteCustomerAliasByExternalId(request: Paid.DeleteCustomerAliasByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.EmptyResponse>;
+    private __deleteCustomerAliasByExternalId;
     /**
      * Get a customer by external ID
      *
@@ -108,7 +241,7 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.getCustomerByExternalId({
-     *         externalId: "externalId"
+     *         externalId: "customer_123"
      *     })
      */
     getCustomerByExternalId(request: Paid.GetCustomerByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.Customer>;
@@ -126,7 +259,7 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.updateCustomerByExternalId({
-     *         externalId: "externalId",
+     *         externalId: "customer_123",
      *         body: {}
      *     })
      */
@@ -145,13 +278,30 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.deleteCustomerByExternalId({
-     *         externalId: "externalId"
+     *         externalId: "customer_123"
      *     })
      */
     deleteCustomerByExternalId(request: Paid.DeleteCustomerByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.EmptyResponse>;
     private __deleteCustomerByExternalId;
     /**
-     * Get current customer credit balances grouped by currency
+     * Primary integration endpoint for agents and programmatic clients using their own customer IDs. Use the value you stored on `customer.externalId`, for example `customer_123`.
+     *
+     * @param {Paid.GetCustomerStateByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.getCustomerStateByExternalId({
+     *         externalId: "customer_123"
+     *     })
+     */
+    getCustomerStateByExternalId(request: Paid.GetCustomerStateByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerState>;
+    private __getCustomerStateByExternalId;
+    /**
+     * Get current customer credit balances grouped by currency for a Paid customer display ID. Use the value returned as `customer.id`, for example `cus_abc123`. If you have your own customer ID, use `/api/v2/customers/external/{externalId}/credits/balances`.
      *
      * @param {Paid.GetCustomerCreditBalancesRequest} request
      * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
@@ -162,11 +312,35 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.getCustomerCreditBalances({
-     *         id: "id"
+     *         id: "cus_abc123"
      *     })
      */
     getCustomerCreditBalances(request: Paid.GetCustomerCreditBalancesRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CreditBalanceListResponse>;
     private __getCustomerCreditBalances;
+    /**
+     * Immediately grant credits to a customer using an active credit currency key.
+     *
+     * @param {Paid.GrantCustomerCreditsRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.grantCustomerCredits({
+     *         id: "cus_abc123",
+     *         body: {
+     *             creditCurrencyKey: "api_credits",
+     *             amount: 10000,
+     *             startsAt: "2026-06-05T12:00:00Z",
+     *             expiresAt: "2026-12-31T23:59:59Z"
+     *         }
+     *     })
+     */
+    grantCustomerCredits(request: Paid.GrantCustomerCreditsRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.GrantCustomerCreditsResponse>;
+    private __grantCustomerCredits;
     /**
      * Get current customer credit balances grouped by currency, looked up by external ID
      *
@@ -179,11 +353,71 @@ export declare class Customers {
      *
      * @example
      *     await client.customers.getCustomerCreditBalancesByExternalId({
-     *         externalId: "externalId"
+     *         externalId: "customer_123"
      *     })
      */
     getCustomerCreditBalancesByExternalId(request: Paid.GetCustomerCreditBalancesByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CreditBalanceListResponse>;
     private __getCustomerCreditBalancesByExternalId;
+    /**
+     * List credit consumption that was recorded before a matching credit pool existed — for example usage that arrived before an invoice was paid or before a new period's credits were granted. Entries leave this list once they are applied to a pool or settled. Use the value returned as `customer.id`, for example `cus_abc123`. If you have your own customer ID, use `/api/v2/customers/external/{externalId}/credits/pending-consumption`.
+     *
+     * @param {Paid.ListCustomerPendingCreditConsumptionRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.listCustomerPendingCreditConsumption({
+     *         id: "cus_abc123"
+     *     })
+     */
+    listCustomerPendingCreditConsumption(request: Paid.ListCustomerPendingCreditConsumptionRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.PendingCreditConsumptionListResponse>;
+    private __listCustomerPendingCreditConsumption;
+    /**
+     * List credit consumption recorded before a matching credit pool existed, for a customer looked up by external ID.
+     *
+     * @param {Paid.ListCustomerPendingCreditConsumptionByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.listCustomerPendingCreditConsumptionByExternalId({
+     *         externalId: "customer_123"
+     *     })
+     */
+    listCustomerPendingCreditConsumptionByExternalId(request: Paid.ListCustomerPendingCreditConsumptionByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.PendingCreditConsumptionListResponse>;
+    private __listCustomerPendingCreditConsumptionByExternalId;
+    /**
+     * Immediately grant credits to a customer looked up by external ID using an active credit currency key.
+     *
+     * @param {Paid.GrantCustomerCreditsByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.grantCustomerCreditsByExternalId({
+     *         externalId: "customer_123",
+     *         body: {
+     *             creditCurrencyKey: "api_credits",
+     *             amount: 10000,
+     *             startsAt: "2026-06-05T12:00:00Z",
+     *             expiresAt: "2026-12-31T23:59:59Z"
+     *         }
+     *     })
+     */
+    grantCustomerCreditsByExternalId(request: Paid.GrantCustomerCreditsByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.GrantCustomerCreditsResponse>;
+    private __grantCustomerCreditsByExternalId;
     /**
      * Create or update a customer user using customer and user external IDs
      *
@@ -203,5 +437,335 @@ export declare class Customers {
      */
     upsertCustomerUserByExternalId(request: Paid.UpsertCustomerUserRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUser>;
     private __upsertCustomerUserByExternalId;
+    /**
+     * Lists the customer's units as a flat list, newest last; assemble the tree from `parentExternalId` (`null` on the root unit, `isRoot: true`). Deleted units are hidden unless `status=DELETED` is given. Filter by `externalType`, or by `parentExternalId` for one level of the tree. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.ListCustomerUnitsByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.listCustomerUnitsByExternalId({
+     *         externalId: "customer_123",
+     *         parentExternalId: "dept-rnd"
+     *     })
+     */
+    listCustomerUnitsByExternalId(request: Paid.ListCustomerUnitsByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitListResponse>;
+    private __listCustomerUnitsByExternalId;
+    /**
+     * Creates a unit for this customer. `externalId` is your own key for it: required, unique within the customer and immutable; every unit route addresses the unit by it, and `name` defaults to it. Omit `parentExternalId` to create the customer's root unit (its first unit; `409 ROOT_EXISTS` if it already has one — a customer created with an external id usable as a unit key already has its root, keyed by that external id, so name it as the parent instead); otherwise the parent must exist (`409 PARENT_NOT_FOUND`) and be ACTIVE. Units are never created implicitly: a signal that names a unit before it exists is accepted and its spend attaches to the unit once you create it with that key. `409` also when the externalId is taken (`CUSTOMER_UNIT_EXISTS`), the tree would get too deep, or the customer is on seat-based billing. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.CreateCustomerUnitByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.createCustomerUnitByExternalId({
+     *         externalId: "customer_123",
+     *         body: {
+     *             externalId: "team-research"
+     *         }
+     *     })
+     */
+    createCustomerUnitByExternalId(request: Paid.CreateCustomerUnitByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __createCustomerUnitByExternalId;
+    /**
+     * Returns one unit of this customer by its `externalId`, including a deleted one. `404` when the unit does not exist or belongs to another customer. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.GetCustomerUnitByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.getCustomerUnitByExternalId({
+     *         externalId: "customer_123",
+     *         externalCustomerUnitId: "team-research"
+     *     })
+     */
+    getCustomerUnitByExternalId(request: Paid.GetCustomerUnitByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __getCustomerUnitByExternalId;
+    /**
+     * Soft-deletes a unit: it stays readable with `status: DELETED` and cannot be reactivated. Spend history that references it is kept, and signals that keep naming it are still attributed to it. `409` while the unit has ACTIVE children or a cap in force or scheduled; the root follows the same rules, and once it is deleted a new root can be created. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.DeleteCustomerUnitByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.deleteCustomerUnitByExternalId({
+     *         externalId: "customer_123",
+     *         externalCustomerUnitId: "team-research"
+     *     })
+     */
+    deleteCustomerUnitByExternalId(request: Paid.DeleteCustomerUnitByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __deleteCustomerUnitByExternalId;
+    /**
+     * Renames, re-types, re-parents or annotates a unit, the root included. `externalId` cannot change. Re-parenting (`parentExternalId`) moves the unit with everything under it. Spend already recorded keeps naming the unit it landed on; caps are evaluated on the current tree, so from the move on the unit's spend in the running cap period counts toward its new ancestors' caps and no longer toward the old ones. `409` for a deleted unit, a parent that does not exist or is not ACTIVE, a move of the root (`ROOT_UNIT_IMMOVABLE`), a move under the unit's own subtree, or a tree that would get too deep. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.UpdateCustomerUnitByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.updateCustomerUnitByExternalId({
+     *         externalId: "customer_123",
+     *         externalCustomerUnitId: "team-research",
+     *         body: {}
+     *     })
+     */
+    updateCustomerUnitByExternalId(request: Paid.UpdateCustomerUnitByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __updateCustomerUnitByExternalId;
+    /**
+     * Lists the customer's units as a flat list, newest last; assemble the tree from `parentExternalId` (`null` on the root unit, `isRoot: true`). Deleted units are hidden unless `status=DELETED` is given. Filter by `externalType`, or by `parentExternalId` for one level of the tree. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.ListCustomerUnitsRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.listCustomerUnits({
+     *         id: "cus_abc123",
+     *         parentExternalId: "dept-rnd"
+     *     })
+     */
+    listCustomerUnits(request: Paid.ListCustomerUnitsRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitListResponse>;
+    private __listCustomerUnits;
+    /**
+     * Creates a unit for this customer. `externalId` is your own key for it: required, unique within the customer and immutable; every unit route addresses the unit by it, and `name` defaults to it. Omit `parentExternalId` to create the customer's root unit (its first unit; `409 ROOT_EXISTS` if it already has one — a customer created with an external id usable as a unit key already has its root, keyed by that external id, so name it as the parent instead); otherwise the parent must exist (`409 PARENT_NOT_FOUND`) and be ACTIVE. Units are never created implicitly: a signal that names a unit before it exists is accepted and its spend attaches to the unit once you create it with that key. `409` also when the externalId is taken (`CUSTOMER_UNIT_EXISTS`), the tree would get too deep, or the customer is on seat-based billing. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.CreateCustomerUnitRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.createCustomerUnit({
+     *         id: "cus_abc123",
+     *         body: {
+     *             externalId: "team-research"
+     *         }
+     *     })
+     */
+    createCustomerUnit(request: Paid.CreateCustomerUnitRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __createCustomerUnit;
+    /**
+     * Returns one unit of this customer by its `externalId`, including a deleted one. `404` when the unit does not exist or belongs to another customer. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.GetCustomerUnitRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.getCustomerUnit({
+     *         id: "cus_abc123",
+     *         externalCustomerUnitId: "team-research"
+     *     })
+     */
+    getCustomerUnit(request: Paid.GetCustomerUnitRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __getCustomerUnit;
+    /**
+     * Soft-deletes a unit: it stays readable with `status: DELETED` and cannot be reactivated. Spend history that references it is kept, and signals that keep naming it are still attributed to it. `409` while the unit has ACTIVE children or a cap in force or scheduled; the root follows the same rules, and once it is deleted a new root can be created. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.DeleteCustomerUnitRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.deleteCustomerUnit({
+     *         id: "cus_abc123",
+     *         externalCustomerUnitId: "team-research"
+     *     })
+     */
+    deleteCustomerUnit(request: Paid.DeleteCustomerUnitRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __deleteCustomerUnit;
+    /**
+     * Renames, re-types, re-parents or annotates a unit, the root included. `externalId` cannot change. Re-parenting (`parentExternalId`) moves the unit with everything under it. Spend already recorded keeps naming the unit it landed on; caps are evaluated on the current tree, so from the move on the unit's spend in the running cap period counts toward its new ancestors' caps and no longer toward the old ones. `409` for a deleted unit, a parent that does not exist or is not ACTIVE, a move of the root (`ROOT_UNIT_IMMOVABLE`), a move under the unit's own subtree, or a tree that would get too deep. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.UpdateCustomerUnitRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.updateCustomerUnit({
+     *         id: "cus_abc123",
+     *         externalCustomerUnitId: "team-research",
+     *         body: {}
+     *     })
+     */
+    updateCustomerUnit(request: Paid.UpdateCustomerUnitRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnit>;
+    private __updateCustomerUnit;
+    /**
+     * Returns the cap in force on this customer unit for one credits currency, with usage in the current period when available. Select the currency with `creditsCurrencyId`; it may be omitted only when the organization has exactly one credits currency, which is then used and echoed back. `404` when the customer or the unit does not exist, or the unit has no cap in force for that currency. The usage figures are advisory: other spend may land between this read and the next burn. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.GetCustomerUnitCapByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.getCustomerUnitCapByExternalId({
+     *         externalId: "customer_123",
+     *         externalCustomerUnitId: "tenant-a",
+     *         creditsCurrencyId: "7f4f5d4c-55e9-4d5b-a3e7-c9eb3d2d01bf"
+     *     })
+     */
+    getCustomerUnitCapByExternalId(request: Paid.GetCustomerUnitCapByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitCapResponse>;
+    private __getCustomerUnitCapByExternalId;
+    /**
+     * Sets the cap on this customer unit for one credits currency by recording a new cap version; earlier versions are kept and never modified, and the newest version wins where they overlap. The new version applies from `effectiveFrom` (default now) and its periods are anchored on that day of the month. Select the currency with `creditsCurrencyId` in the body; it may be omitted only when the organization has exactly one credits currency. A cap on the customer's root unit is the customer-wide cap. `404` when the customer or the unit does not exist. `409` for customers on seat-based billing. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.SetCustomerUnitCapByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.setCustomerUnitCapByExternalId({
+     *         externalId: "customer_123",
+     *         externalCustomerUnitId: "tenant-a",
+     *         body: {
+     *             amount: 10000
+     *         }
+     *     })
+     */
+    setCustomerUnitCapByExternalId(request: Paid.SetCustomerUnitCapByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitCapSetResponse>;
+    private __setCustomerUnitCapByExternalId;
+    /**
+     * Ends the cap on this customer unit for one credits currency by setting `effectiveUntil` to now on every open version — the one in force, older overlapping versions still open, and versions scheduled to start later — so nothing can resurface or activate afterwards; nothing is deleted and history is kept. Select the currency with `creditsCurrencyId`; it may be omitted only when the organization has exactly one credits currency. `404` when the customer or the unit does not exist, or there is no open version for that currency. Addresses the customer by your external customer id.
+     *
+     * @param {Paid.EndCustomerUnitCapByExternalIdRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.endCustomerUnitCapByExternalId({
+     *         externalId: "customer_123",
+     *         externalCustomerUnitId: "tenant-a",
+     *         creditsCurrencyId: "7f4f5d4c-55e9-4d5b-a3e7-c9eb3d2d01bf"
+     *     })
+     */
+    endCustomerUnitCapByExternalId(request: Paid.EndCustomerUnitCapByExternalIdRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitCapEndResponse>;
+    private __endCustomerUnitCapByExternalId;
+    /**
+     * Returns the cap in force on this customer unit for one credits currency, with usage in the current period when available. Select the currency with `creditsCurrencyId`; it may be omitted only when the organization has exactly one credits currency, which is then used and echoed back. `404` when the customer or the unit does not exist, or the unit has no cap in force for that currency. The usage figures are advisory: other spend may land between this read and the next burn. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.GetCustomerUnitCapRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.getCustomerUnitCap({
+     *         id: "cus_abc123",
+     *         externalCustomerUnitId: "tenant-a",
+     *         creditsCurrencyId: "7f4f5d4c-55e9-4d5b-a3e7-c9eb3d2d01bf"
+     *     })
+     */
+    getCustomerUnitCap(request: Paid.GetCustomerUnitCapRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitCapResponse>;
+    private __getCustomerUnitCap;
+    /**
+     * Sets the cap on this customer unit for one credits currency by recording a new cap version; earlier versions are kept and never modified, and the newest version wins where they overlap. The new version applies from `effectiveFrom` (default now) and its periods are anchored on that day of the month. Select the currency with `creditsCurrencyId` in the body; it may be omitted only when the organization has exactly one credits currency. A cap on the customer's root unit is the customer-wide cap. `404` when the customer or the unit does not exist. `409` for customers on seat-based billing. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.SetCustomerUnitCapRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.setCustomerUnitCap({
+     *         id: "cus_abc123",
+     *         externalCustomerUnitId: "tenant-a",
+     *         body: {
+     *             amount: 10000
+     *         }
+     *     })
+     */
+    setCustomerUnitCap(request: Paid.SetCustomerUnitCapRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitCapSetResponse>;
+    private __setCustomerUnitCap;
+    /**
+     * Ends the cap on this customer unit for one credits currency by setting `effectiveUntil` to now on every open version — the one in force, older overlapping versions still open, and versions scheduled to start later — so nothing can resurface or activate afterwards; nothing is deleted and history is kept. Select the currency with `creditsCurrencyId`; it may be omitted only when the organization has exactly one credits currency. `404` when the customer or the unit does not exist, or there is no open version for that currency. Use the value returned as `customer.id`, for example `cus_abc123`; if you have your own customer ID, use the `/api/v2/customers/external/{externalId}/…` twin.
+     *
+     * @param {Paid.EndCustomerUnitCapRequest} request
+     * @param {Customers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.customers.endCustomerUnitCap({
+     *         id: "cus_abc123",
+     *         externalCustomerUnitId: "tenant-a",
+     *         creditsCurrencyId: "7f4f5d4c-55e9-4d5b-a3e7-c9eb3d2d01bf"
+     *     })
+     */
+    endCustomerUnitCap(request: Paid.EndCustomerUnitCapRequest, requestOptions?: Customers.RequestOptions): core.HttpResponsePromise<Paid.CustomerUnitCapEndResponse>;
+    private __endCustomerUnitCap;
     protected _getAuthorizationHeader(): Promise<string>;
 }