@metronome/sdk 3.0.0 → 3.5.0

package/src/resources/v1/contracts/contracts.ts

@@ -374,6 +374,83 @@ export class Contracts extends APIResource {
     return this._client.post('/v1/contracts/createHistoricalInvoices', { body, ...options });
   }
 
+  /**
+   * Retrieve the combined current balance across any grouping of credits and commits
+   * for a customer in a single API call.
+   *
+   * - Display real-time available balance to customers in billing dashboards
+   * - Build finance dashboards showing credit utilization across customer segments
+   * - Validate expected vs. actual balance during billing reconciliation
+   *
+   * ### Key response fields:
+   *
+   * - `balance`: The combined net balance available to use at this moment across all
+   *   matching commits and credits
+   * - `credit_type_id`: The credit type (fiat or custom pricing unit) the balance is
+   *   denominated in
+   *
+   * ### Filtering options:
+   *
+   * Balance filters allow you to scope the calculation to specific subsets of
+   * commits and credits. When using multiple filter objects, they are OR'd together
+   * — if a commit or credit matches any filter, it's included in the net balance.
+   * Within a single filter object, all specified conditions are AND'd together.
+   *
+   * - **Balance types**: Include any combination of `PREPAID_COMMIT`,
+   *   `POSTPAID_COMMIT`, and `CREDIT` (e.g., `["PREPAID_COMMIT", "CREDIT"]` to
+   *   exclude postpaid commits). If not specified, all balance types are included.
+   * - **Specific IDs**: Target exact commit or credit IDs for precise balance
+   *   queries
+   * - **Custom fields**: Filter by custom field key-value pairs; when multiple pairs
+   *   are provided, commits must match all of them
+   *
+   * **Example**: To get the balance of all free-trial credits OR all
+   * signup-promotion commits, you'd pass two filter objects — one filtering for
+   * CREDIT with custom field campaign: free-trial, and another filtering for
+   * PREPAID_COMMIT with custom field campaign: signup-promotion.
+   *
+   * ### Usage guidelines:
+   *
+   * - **Balance ledger details**: Use the
+   *   [listBalances](https://docs.metronome.com/api-reference/credits-and-commits/list-balances)
+   *   endpoint instead to understand detailed ledger drawdowns for each individual
+   *   balance
+   * - **Draft invoice handling**: Use `invoice_inclusion_mode` to control whether
+   *   pending draft invoice deductions are included (`FINALIZED_AND_DRAFT`, the
+   *   default) or excluded (`FINALIZED`) from the balance calculation
+   * - **Account hierarchies**: When querying a child customer, shared commits from
+   *   parent contracts are not included — query the parent customer directly to see
+   *   shared commit balances
+   * - **Negative balances**: Manual ledger entries can cause negative segment
+   *   balances; these are treated as zero when calculating the net balance
+   * - **Credit types**: If `credit_type_id` is not specified, the balance defaults
+   *   to USD (cents)
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.contracts.getNetBalance({
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *   filters: [
+   *     {
+   *       balance_types: ['CREDIT'],
+   *       custom_fields: { campaign: 'free-trial' },
+   *     },
+   *     {
+   *       balance_types: ['PREPAID_COMMIT', 'POSTPAID_COMMIT'],
+   *       custom_fields: { campaign: 'signup-promotion' },
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  getNetBalance(
+    body: ContractGetNetBalanceParams,
+    options?: RequestOptions,
+  ): APIPromise<ContractGetNetBalanceResponse> {
+    return this._client.post('/v1/contracts/customerBalances/getNetBalance', { body, ...options });
+  }
+
   /**
    * Retrieve a comprehensive view of all available balances (commits and credits)
    * for a customer. This endpoint provides real-time visibility into prepaid funds,
@@ -400,6 +477,9 @@ export class Contracts extends APIResource {
    *
    * ### Usage guidelines:
    *
+   * - Use the
+   *   [getNetBalance](https://docs.metronome.com/api-reference/credits-and-commits/get-the-net-balance-of-a-customer)
+   *   endpoint to retrieve a single combined current balance
    * - Date filtering: Use `effective_before` to include only balances with access
    *   before a specific date (exclusive)
    * - Set `include_balance=true` for calculated balance amounts on each commit or
@@ -624,6 +704,26 @@ export interface ContractCreateHistoricalInvoicesResponse {
   data: Array<InvoicesAPI.Invoice>;
 }
 
+export interface ContractGetNetBalanceResponse {
+  data: ContractGetNetBalanceResponse.Data;
+}
+
+export namespace ContractGetNetBalanceResponse {
+  export interface Data {
+    /**
+     * The combined net balance that the customer has access to use at this moment
+     * across all pertinent commits and credits.
+     */
+    balance: number;
+
+    /**
+     * The ID of the credit type (can be fiat or a custom pricing unit) that the
+     * balance is for.
+     */
+    credit_type_id: string;
+  }
+}
+
 export type ContractListBalancesResponse = Shared.Commit | Shared.Credit;
 
 export interface ContractRetrieveRateScheduleResponse {
@@ -763,12 +863,20 @@ export interface ContractCreateParams {
 
   overrides?: Array<ContractCreateParams.Override>;
 
-  prepaid_balance_threshold_configuration?: Shared.PrepaidBalanceThresholdConfiguration;
+  /**
+   * Selects the package linked to the specified alias as of the contract's start
+   * date. Mutually exclusive with package_id.
+   */
+  package_alias?: string;
 
   /**
-   * Priority of the contract.
+   * If provided, provisions a customer on a package instead of creating a
+   * traditional contract. When specified, only customer_id, starting_at, package_id,
+   * and uniqueness_key are allowed.
    */
-  priority?: number;
+  package_id?: string;
+
+  prepaid_balance_threshold_configuration?: Shared.PrepaidBalanceThresholdConfiguration;
 
   /**
    * This field's availability is dependent on your client's configuration.
@@ -1124,7 +1232,7 @@ export namespace ContractCreateParams {
        * not wish Metronome to calculate tax on your behalf. Leaving this field blank
        * will default to NONE.
        */
-      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'AVALARA' | 'PRECALCULATED';
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
     }
 
     export namespace PaymentGateConfig {
@@ -1228,6 +1336,11 @@ export namespace ContractCreateParams {
 
     rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
 
+    /**
+     * Fraction of unused segments that will be rolled over. Must be between 0 and 1.
+     */
+    rollover_fraction?: number;
+
     /**
      * List of filters that determine what kind of customer usage draws down a commit
      * or credit. A customer's usage needs to meet the condition of at least one of the
@@ -1399,8 +1512,7 @@ export namespace ContractCreateParams {
     parent_behavior?: HierarchyConfiguration.ParentBehavior;
 
     /**
-     * Account hierarchy M3 - Indicates which customer should pay for the child's
-     * invoice charges
+     * Indicates which customer should pay for the child's invoice charges
      *
      * **SELF**: The child pays for its own invoice charges
      *
@@ -1409,8 +1521,8 @@ export namespace ContractCreateParams {
     payer?: 'SELF' | 'PARENT';
 
     /**
-     * Account hierarchy M3 - Indicates the behavior of the child's invoice statements
-     * on the parent's invoices.
+     * Indicates the behavior of the child's invoice statements on the parent's
+     * invoices.
      *
      * **CONSOLIDATE**: Child's invoice statements will be added to parent's
      * consolidated invoices
@@ -1430,8 +1542,8 @@ export namespace ContractCreateParams {
 
     export interface ParentBehavior {
       /**
-       * Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
-       * generated by the parent in a customer hierarchy
+       * Indicates the desired behavior of consolidated invoices generated by the parent
+       * in a customer hierarchy
        *
        * **CONCATENATE**: Statements on the invoices of child customers will be appended
        * to the consolidated invoice
@@ -1559,21 +1671,13 @@ export namespace ContractCreateParams {
        * commits created by the specified recurring commit ids.
        */
       recurring_commit_ids?: Array<string>;
-
-      /**
-       * Can only be used for commit specific overrides. Must be used in conjunction with
-       * one of `product_id`, `product_tags`, `pricing_group_values`, or
-       * `presentation_group_values`. If provided, the override will only apply to
-       * credits created by the specified recurring credit ids.
-       */
-      recurring_credit_ids?: Array<string>;
     }
 
     /**
      * Required for OVERWRITE type.
      */
     export interface OverwriteRate {
-      rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+      rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'TIERED_PERCENTAGE' | 'CUSTOM';
 
       credit_type_id?: string;
 
@@ -2754,7 +2858,7 @@ export namespace ContractAmendParams {
        * not wish Metronome to calculate tax on your behalf. Leaving this field blank
        * will default to NONE.
        */
-      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'AVALARA' | 'PRECALCULATED';
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
     }
 
     export namespace PaymentGateConfig {
@@ -2858,6 +2962,11 @@ export namespace ContractAmendParams {
 
     rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
 
+    /**
+     * Fraction of unused segments that will be rolled over. Must be between 0 and 1.
+     */
+    rollover_fraction?: number;
+
     /**
      * List of filters that determine what kind of customer usage draws down a commit
      * or credit. A customer's usage needs to meet the condition of at least one of the
@@ -3140,21 +3249,13 @@ export namespace ContractAmendParams {
        * commits created by the specified recurring commit ids.
        */
       recurring_commit_ids?: Array<string>;
-
-      /**
-       * Can only be used for commit specific overrides. Must be used in conjunction with
-       * one of `product_id`, `product_tags`, `pricing_group_values`, or
-       * `presentation_group_values`. If provided, the override will only apply to
-       * credits created by the specified recurring credit ids.
-       */
-      recurring_credit_ids?: Array<string>;
     }
 
     /**
      * Required for OVERWRITE type.
      */
     export interface OverwriteRate {
-      rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+      rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'TIERED_PERCENTAGE' | 'CUSTOM';
 
       credit_type_id?: string;
 
@@ -3483,6 +3584,32 @@ export namespace ContractCreateHistoricalInvoicesParams {
   }
 }
 
+export interface ContractGetNetBalanceParams {
+  /**
+   * The ID of the customer.
+   */
+  customer_id: string;
+
+  /**
+   * The ID of the credit type (can be fiat or a custom pricing unit) to get the
+   * balance for. Defaults to USD (cents) if not specified.
+   */
+  credit_type_id?: string;
+
+  /**
+   * Balance filters are OR'd together, so if a given commit or credit matches any of
+   * the filters, it will be included in the net balance.
+   */
+  filters?: Array<Shared.BalanceFilter>;
+
+  /**
+   * Controls which invoices are considered when calculating the remaining balance.
+   * `FINALIZED` considers only deductions from finalized invoices.
+   * `FINALIZED_AND_DRAFT` also includes deductions from pending draft invoices.
+   */
+  invoice_inclusion_mode?: 'FINALIZED' | 'FINALIZED_AND_DRAFT';
+}
+
 export interface ContractListBalancesParams extends BodyCursorPageParams {
   customer_id: string;
 
@@ -3729,6 +3856,7 @@ export declare namespace Contracts {
     type ContractAmendResponse as ContractAmendResponse,
     type ContractArchiveResponse as ContractArchiveResponse,
     type ContractCreateHistoricalInvoicesResponse as ContractCreateHistoricalInvoicesResponse,
+    type ContractGetNetBalanceResponse as ContractGetNetBalanceResponse,
     type ContractListBalancesResponse as ContractListBalancesResponse,
     type ContractRetrieveRateScheduleResponse as ContractRetrieveRateScheduleResponse,
     type ContractRetrieveSubscriptionQuantityHistoryResponse as ContractRetrieveSubscriptionQuantityHistoryResponse,
@@ -3742,6 +3870,7 @@ export declare namespace Contracts {
     type ContractAmendParams as ContractAmendParams,
     type ContractArchiveParams as ContractArchiveParams,
     type ContractCreateHistoricalInvoicesParams as ContractCreateHistoricalInvoicesParams,
+    type ContractGetNetBalanceParams as ContractGetNetBalanceParams,
     type ContractListBalancesParams as ContractListBalancesParams,
     type ContractRetrieveRateScheduleParams as ContractRetrieveRateScheduleParams,
     type ContractRetrieveSubscriptionQuantityHistoryParams as ContractRetrieveSubscriptionQuantityHistoryParams,

package/src/resources/v1/contracts/index.ts

@@ -8,6 +8,7 @@ export {
   type ContractAmendResponse,
   type ContractArchiveResponse,
   type ContractCreateHistoricalInvoicesResponse,
+  type ContractGetNetBalanceResponse,
   type ContractListBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
   type ContractRetrieveSubscriptionQuantityHistoryResponse,
@@ -20,6 +21,7 @@ export {
   type ContractAmendParams,
   type ContractArchiveParams,
   type ContractCreateHistoricalInvoicesParams,
+  type ContractGetNetBalanceParams,
   type ContractListBalancesParams,
   type ContractRetrieveRateScheduleParams,
   type ContractRetrieveSubscriptionQuantityHistoryParams,

package/src/resources/v1/contracts/named-schedules.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * Named schedules are used for storing custom data that can change over time. Named schedules are often used in custom pricing logic.
+ */
 export class NamedSchedules extends APIResource {
   /**
    * Get a named schedule for the given rate card. This endpoint's availability is

package/src/resources/v1/contracts/products.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * Products are the items that customers purchase.
+ */
 export class Products extends APIResource {
   /**
    * Create a new product object. Products in Metronome represent your company's

package/src/resources/v1/contracts/rate-cards/named-schedules.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../../core/api-promise';
 import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 
+/**
+ * Named schedules are used for storing custom data that can change over time. Named schedules are often used in custom pricing logic.
+ */
 export class NamedSchedules extends APIResource {
   /**
    * Get a named schedule for the given contract. This endpoint's availability is

package/src/resources/v1/contracts/rate-cards/product-orders.ts

@@ -5,6 +5,9 @@ import * as Shared from '../../../shared';
 import { APIPromise } from '../../../../core/api-promise';
 import { RequestOptions } from '../../../../internal/request-options';
 
+/**
+ * Rate cards are used to define default pricing for products.
+ */
 export class ProductOrders extends APIResource {
   /**
    * The ordering of products on a rate card determines the order in which the

package/src/resources/v1/contracts/rate-cards/rate-cards.ts

@@ -32,6 +32,9 @@ import { APIPromise } from '../../../../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../../../../core/pagination';
 import { RequestOptions } from '../../../../internal/request-options';
 
+/**
+ * Rate cards are used to define default pricing for products.
+ */
 export class RateCards extends APIResource {
   productOrders: ProductOrdersAPI.ProductOrders = new ProductOrdersAPI.ProductOrders(this._client);
   rates: RatesAPI.Rates = new RatesAPI.Rates(this._client);

package/src/resources/v1/contracts/rate-cards/rates.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../../../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../../../../core/pagination';
 import { RequestOptions } from '../../../../internal/request-options';
 
+/**
+ * Rate cards are used to define default pricing for products.
+ */
 export class Rates extends APIResource {
   /**
    * Understand the rate schedule at a given timestamp, optionally filtering the list
@@ -153,7 +156,7 @@ export interface RateAddResponse {
 
 export namespace RateAddResponse {
   export interface Data {
-    rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'CUSTOM' | 'TIERED';
+    rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'CUSTOM' | 'TIERED' | 'TIERED_PERCENTAGE';
 
     /**
      * A distinct rate on the rate card. You can choose to use this rate rather than
@@ -271,7 +274,7 @@ export interface RateAddParams {
    */
   rate_card_id: string;
 
-  rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+  rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'TIERED_PERCENTAGE' | 'CUSTOM';
 
   /**
    * inclusive effective date
@@ -353,7 +356,7 @@ export namespace RateAddManyParams {
      */
     product_id: string;
 
-    rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+    rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'TIERED_PERCENTAGE' | 'CUSTOM';
 
     /**
      * inclusive effective date

package/src/resources/v1/credit-grants.ts

@@ -13,6 +13,9 @@ import {
 } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * [Credit grants](https://docs.metronome.com/invoicing/how-billing-works/manage-credits/) adjust a customer balance for prepayments, reimbursements, promotions, and so on. Use these endpoints to create, retrieve, update, and delete credit grants.
+ */
 export class CreditGrants extends APIResource {
   /**
    * Create a new credit grant. This is a Plans (deprecated) endpoint. New clients

package/src/resources/v1/custom-fields.ts

@@ -10,6 +10,9 @@ import {
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * [Custom fields](https://docs.metronome.com/integrations/custom-fields/) enable adding additional data to Metronome entities. Use these endpoints to create, retrieve, update, and delete custom fields.
+ */
 export class CustomFields extends APIResource {
   /**
    * Creates a new custom field key for a given entity (e.g. billable metric,

package/src/resources/v1/customers/alerts.ts

@@ -11,6 +11,9 @@ import {
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * [Alerts](https://docs.metronome.com/connecting-metronome/alerts/) monitor customer spending, balances, and other billing factors. Use these endpoints to create, retrieve, and archive customer alerts. To view sample alert payloads by alert type, navigate [here.](https://docs.metronome.com/manage-product-access/create-manage-alerts/#webhook-notifications)
+ */
 export class Alerts extends APIResource {
   /**
    * Retrieve the real-time evaluation status for a specific threshold

package/src/resources/v1/customers/billing-config.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * [Customers](https://docs.metronome.com/provisioning/create-customers/) in Metronome represent your users for all billing and reporting. Use these endpoints to create, retrieve, update, and archive customers and their billing configuration.
+ */
 export class BillingConfig extends APIResource {
   /**
    * Set the billing configuration for a given customer. This is a Plans (deprecated)

package/src/resources/v1/customers/commits.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * Credits and commits are used to manage customer balances.
+ */
 export class Commits extends APIResource {
   /**
    * Creates customer-level commits that establish spending commitments for customers

package/src/resources/v1/customers/credits.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * Credits and commits are used to manage customer balances.
+ */
 export class Credits extends APIResource {
   /**
    * Creates customer-level credits that provide spending allowances or free credit

package/src/resources/v1/customers/customers.ts

@@ -217,6 +217,57 @@ export class Customers extends APIResource {
     return this._client.post('/v1/customers/archive', { body, ...options });
   }
 
+  /**
+   * Deprecate an existing billing configuration for a customer to handle churn or
+   * billing and collection preference changes. Archiving a billing configuration
+   * takes effect immediately. If there are active contracts using the configuration,
+   * Metronome will archive the configuration on the contract and immediately stop
+   * metering to downstream systems.
+   *
+   * ### Use this endpoint to:
+   *
+   * - Remove billing provider customer data and configurations when no longer needed
+   * - Clean up test or deprecated billing provider configurations
+   * - Free up uniqueness keys for reuse with new billing provider configurations
+   * - Disable threshold recharge configurations associated with archived billing
+   *   providers
+   *
+   * ### Key response fields:
+   *
+   * A successful response returns:
+   *
+   * - `success`: Boolean indicating the operation completed successfully
+   * - `error`: Null on success, error message on failure
+   *
+   * ### Usage guidelines:
+   *
+   * - Archiving a contract configuration during a grace period will result in the
+   *   invoice not being sent to the customer
+   * - Automatically disables both spend-based and credit-based threshold recharge
+   *   configurations for contracts using the archived billing provider
+   * - You can archive multiple configurations for a single customer in a single
+   *   request, but any validation failures for an individual configuration will
+   *   prevent the entire operation from succeeding
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.customers.archiveBillingConfigurations({
+   *     customer_billing_provider_configuration_ids: [
+   *       '4db51251-61de-4bfe-b9ce-495e244f3491',
+   *       '4db51251-61de-4bfe-b9ce-495e244f3491',
+   *     ],
+   *     customer_id: '20a060d1-aa80-41d4-8bb2-4f3091b93903',
+   *   });
+   * ```
+   */
+  archiveBillingConfigurations(
+    body: CustomerArchiveBillingConfigurationsParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomerArchiveBillingConfigurationsResponse> {
+    return this._client.post('/v1/archiveCustomerBillingProviderConfigurations', { body, ...options });
+  }
+
   /**
    * Get all billable metrics available for a specific customer. Supports pagination
    * and filtering by current plan status or archived metrics. Use this endpoint to
@@ -404,6 +455,12 @@ export class Customers extends APIResource {
    *       configuration: { ... },
    *       delivery_method: 'direct_to_billing_provider',
    *     },
+   *     {
+   *       customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+   *       billing_provider: 'netsuite',
+   *       configuration: { ... },
+   *       delivery_method: 'direct_to_billing_provider',
+   *     },
    *   ],
    * });
    * ```
@@ -602,6 +659,24 @@ export interface CustomerArchiveResponse {
   data: Shared.ID;
 }
 
+export interface CustomerArchiveBillingConfigurationsResponse {
+  data: CustomerArchiveBillingConfigurationsResponse.Data;
+}
+
+export namespace CustomerArchiveBillingConfigurationsResponse {
+  export interface Data {
+    /**
+     * Array of billing provider configuration IDs to archive
+     */
+    customer_billing_provider_configuration_ids: Array<string>;
+
+    /**
+     * The customer ID the billing provider configurations belong to
+     */
+    customer_id: string;
+  }
+}
+
 export interface CustomerListBillableMetricsResponse {
   id: string;
 
@@ -1001,6 +1076,18 @@ export interface CustomerArchiveParams {
   id: string;
 }
 
+export interface CustomerArchiveBillingConfigurationsParams {
+  /**
+   * Array of billing provider configuration IDs to archive
+   */
+  customer_billing_provider_configuration_ids: Array<string>;
+
+  /**
+   * The customer ID the billing provider configurations belong to
+   */
+  customer_id: string;
+}
+
 export interface CustomerListBillableMetricsParams extends CursorPageParams {
   /**
    * Path param
@@ -1202,6 +1289,7 @@ export declare namespace Customers {
     type CustomerCreateResponse as CustomerCreateResponse,
     type CustomerRetrieveResponse as CustomerRetrieveResponse,
     type CustomerArchiveResponse as CustomerArchiveResponse,
+    type CustomerArchiveBillingConfigurationsResponse as CustomerArchiveBillingConfigurationsResponse,
     type CustomerListBillableMetricsResponse as CustomerListBillableMetricsResponse,
     type CustomerListCostsResponse as CustomerListCostsResponse,
     type CustomerPreviewEventsResponse as CustomerPreviewEventsResponse,
@@ -1215,6 +1303,7 @@ export declare namespace Customers {
     type CustomerRetrieveParams as CustomerRetrieveParams,
     type CustomerListParams as CustomerListParams,
     type CustomerArchiveParams as CustomerArchiveParams,
+    type CustomerArchiveBillingConfigurationsParams as CustomerArchiveBillingConfigurationsParams,
     type CustomerListBillableMetricsParams as CustomerListBillableMetricsParams,
     type CustomerListCostsParams as CustomerListCostsParams,
     type CustomerPreviewEventsParams as CustomerPreviewEventsParams,

package/src/resources/v1/customers/index.ts

@@ -39,6 +39,7 @@ export {
   type CustomerCreateResponse,
   type CustomerRetrieveResponse,
   type CustomerArchiveResponse,
+  type CustomerArchiveBillingConfigurationsResponse,
   type CustomerListBillableMetricsResponse,
   type CustomerListCostsResponse,
   type CustomerPreviewEventsResponse,
@@ -49,6 +50,7 @@ export {
   type CustomerRetrieveParams,
   type CustomerListParams,
   type CustomerArchiveParams,
+  type CustomerArchiveBillingConfigurationsParams,
   type CustomerListBillableMetricsParams,
   type CustomerListCostsParams,
   type CustomerPreviewEventsParams,