@metronome/sdk 3.5.0 → 3.7.0

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

@@ -58,8 +58,8 @@ export class Contracts extends APIResource {
   /**
    * Contracts define a customer's products, pricing, discounts, access duration, and
    * billing configuration. Contracts serve as the central billing agreement for both
-   * PLG and Enterprise customers, you can automatically customers access to your
-   * products and services directly from your product or CRM.
+   * PLG and Enterprise customers. You can automatically grant customers access to
+   * your products and services directly from your product or CRM.
    *
    * ### Use this endpoint to:
    *
@@ -515,6 +515,55 @@ export class Contracts extends APIResource {
     );
   }
 
+  /**
+   * Retrieve detailed balance for seat-based credits and commits from the contract's
+   * subscriptions, broken down by individual seats.
+   *
+   * ### Use this endpoint to:
+   *
+   * - Display per-seat balance information in customer dashboards
+   * - Filter balance data by subscription or specific seats
+   *
+   * ### Key response fields:
+   *
+   * An array of seat balance objects containing:
+   *
+   * - Seat id
+   * - Balance: current total balance across all commits and credits
+   *
+   * ### Usage guidelines:
+   *
+   * - Date filtering: use `covering_date` OR `starting_at`/`ending_before` to filter
+   *   balance data by time range
+   * - Set `include_credits_and_commits=true` for detailed commits and credits
+   *   breakdown per seat
+   * - Set `include_ledgers=true` for detailed transaction history per commit/credit
+   *   per seat
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.contracts.listSeatBalances(
+   *   {
+   *     contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *     covering_date: '2024-03-01T00:00:00.000Z',
+   *     include_credits_and_commits: true,
+   *     include_ledgers: true,
+   *     limit: 25,
+   *     subscription_ids: [
+   *       '8deed800-1b7a-495d-a207-6c52bac54dc9',
+   *     ],
+   *   },
+   * );
+   * ```
+   */
+  listSeatBalances(
+    body: ContractListSeatBalancesParams,
+    options?: RequestOptions,
+  ): APIPromise<ContractListSeatBalancesResponse> {
+    return this._client.post('/v1/contracts/seatBalances/list', { body, ...options });
+  }
+
   /**
    * For a specific customer and contract, get the rates at a specific point in time.
    * This endpoint takes the contract's rate card into consideration, including
@@ -681,7 +730,472 @@ export class Contracts extends APIResource {
 export type ContractListBalancesResponsesBodyCursorPage = BodyCursorPage<ContractListBalancesResponse>;
 
 export interface ContractCreateResponse {
-  data: Shared.ID;
+  data: ContractCreateResponse.Data;
+}
+
+export namespace ContractCreateResponse {
+  export interface Data {
+    id: string;
+
+    /**
+     * The created contract.
+     */
+    contract?: Data.Contract;
+  }
+
+  export namespace Data {
+    /**
+     * The created contract.
+     */
+    export interface Contract {
+      id: string;
+
+      commits: Array<Shared.Commit>;
+
+      created_at: string;
+
+      created_by: string;
+
+      customer_id: string;
+
+      overrides: Array<Shared.Override>;
+
+      scheduled_charges: Array<Shared.ScheduledCharge>;
+
+      starting_at: string;
+
+      transitions: Array<Contract.Transition>;
+
+      usage_filter: Array<Contract.UsageFilter>;
+
+      usage_statement_schedule: Contract.UsageStatementSchedule;
+
+      credits?: Array<Shared.Credit>;
+
+      /**
+       * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+       */
+      custom_fields?: { [key: string]: string };
+
+      /**
+       * The billing provider configuration associated with the contract.
+       */
+      customer_billing_provider_configuration?: Contract.CustomerBillingProviderConfiguration;
+
+      ending_before?: string;
+
+      /**
+       * Indicates whether there are more items than the limit for this endpoint. Use the
+       * respective list endpoints to get the full lists.
+       */
+      has_more?: Contract.HasMore;
+
+      /**
+       * Either a **parent** configuration with a list of children or a **child**
+       * configuration with a single parent.
+       */
+      hierarchy_configuration?: Shared.HierarchyConfiguration;
+
+      /**
+       * Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
+       * prices automatically. EXPLICIT prioritization requires specifying priorities for
+       * each multiplier; the one with the lowest priority value will be prioritized
+       * first.
+       */
+      multiplier_override_prioritization?: 'LOWEST_MULTIPLIER' | 'EXPLICIT';
+
+      name?: string;
+
+      net_payment_terms_days?: number;
+
+      /**
+       * ID of the package this contract was created from, if applicable.
+       */
+      package_id?: string;
+
+      prepaid_balance_threshold_configuration?: Shared.PrepaidBalanceThresholdConfiguration;
+
+      rate_card_id?: string;
+
+      recurring_commits?: Array<Contract.RecurringCommit>;
+
+      recurring_credits?: Array<Contract.RecurringCredit>;
+
+      /**
+       * Determines which scheduled and commit charges to consolidate onto the Contract's
+       * usage invoice. The charge's `timestamp` must match the usage invoice's
+       * `ending_before` date for consolidation to occur. This field cannot be modified
+       * after a Contract has been created. If this field is omitted, charges will appear
+       * on a separate invoice from usage charges.
+       */
+      scheduled_charges_on_usage_invoices?: 'ALL';
+
+      spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
+
+      /**
+       * List of subscriptions on the contract.
+       */
+      subscriptions?: Array<Shared.Subscription>;
+
+      /**
+       * Optional uniqueness key to prevent duplicate contract creations.
+       */
+      uniqueness_key?: string;
+    }
+
+    export namespace Contract {
+      export interface Transition {
+        from_contract_id: string;
+
+        to_contract_id: string;
+
+        type: 'SUPERSEDE' | 'RENEWAL';
+      }
+
+      export interface UsageFilter {
+        group_key: string;
+
+        group_values: Array<string>;
+
+        starting_at: string;
+
+        ending_before?: string;
+      }
+
+      export interface UsageStatementSchedule {
+        /**
+         * Contract usage statements follow a selected cadence based on this date.
+         */
+        billing_anchor_date: string;
+
+        frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+      }
+
+      /**
+       * The billing provider configuration associated with the contract.
+       */
+      export interface CustomerBillingProviderConfiguration {
+        id?: string;
+
+        billing_provider?:
+          | 'aws_marketplace'
+          | 'stripe'
+          | 'netsuite'
+          | 'custom'
+          | 'azure_marketplace'
+          | 'quickbooks_online'
+          | 'workday'
+          | 'gcp_marketplace'
+          | 'metronome';
+
+        delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+      }
+
+      /**
+       * Indicates whether there are more items than the limit for this endpoint. Use the
+       * respective list endpoints to get the full lists.
+       */
+      export interface HasMore {
+        /**
+         * Whether there are more commits on this contract than the limit for this
+         * endpoint. Use the /contracts/customerCommits/list endpoint to get the full list
+         * of commits.
+         */
+        commits: boolean;
+
+        /**
+         * Whether there are more credits on this contract than the limit for this
+         * endpoint. Use the /contracts/customerCredits/list endpoint to get the full list
+         * of credits.
+         */
+        credits: boolean;
+      }
+
+      export interface RecurringCommit {
+        id: string;
+
+        /**
+         * The amount of commit to grant.
+         */
+        access_amount: RecurringCommit.AccessAmount;
+
+        /**
+         * The amount of time the created commits will be valid for
+         */
+        commit_duration: RecurringCommit.CommitDuration;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        priority: number;
+
+        product: RecurringCommit.Product;
+
+        /**
+         * Whether the created commits will use the commit rate or list rate
+         */
+        rate_type: 'COMMIT_RATE' | 'LIST_RATE';
+
+        /**
+         * Determines the start time for the first commit
+         */
+        starting_at: string;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_ids?: Array<string>;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_tags?: Array<string>;
+
+        contract?: RecurringCommit.Contract;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        description?: string;
+
+        /**
+         * Determines when the contract will stop creating recurring commits. Optional
+         */
+        ending_before?: string;
+
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+
+        /**
+         * The amount the customer should be billed for the commit. Not required.
+         */
+        invoice_amount?: RecurringCommit.InvoiceAmount;
+
+        /**
+         * Displayed on invoices. Will be passed through to the individual commits
+         */
+        name?: string;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        netsuite_sales_order_id?: string;
+
+        /**
+         * Determines whether the first and last commit will be prorated. If not provided,
+         * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
+         */
+        proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
+
+        /**
+         * The frequency at which the recurring commits will be created. If not provided: -
+         * The commits will be created on the usage invoice frequency. If provided: - The
+         * period defined in the duration will correspond to this frequency. - Commits will
+         * be created aligned with the recurring commit's starting_at rather than the usage
+         * invoice dates.
+         */
+        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+
+        /**
+         * Will be passed down to the individual commits. This controls how much of an
+         * individual unexpired commit will roll over upon contract transition. 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
+         * specifiers to contribute to a commit's or credit's drawdown.
+         */
+        specifiers?: Array<Shared.CommitSpecifier>;
+
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        subscription_config?: Shared.RecurringCommitSubscriptionConfig;
+      }
+
+      export namespace RecurringCommit {
+        /**
+         * The amount of commit to grant.
+         */
+        export interface AccessAmount {
+          credit_type_id: string;
+
+          unit_price: number;
+
+          quantity?: number;
+        }
+
+        /**
+         * The amount of time the created commits will be valid for
+         */
+        export interface CommitDuration {
+          value: number;
+
+          unit?: 'PERIODS';
+        }
+
+        export interface Product {
+          id: string;
+
+          name: string;
+        }
+
+        export interface Contract {
+          id: string;
+        }
+
+        /**
+         * The amount the customer should be billed for the commit. Not required.
+         */
+        export interface InvoiceAmount {
+          credit_type_id: string;
+
+          quantity: number;
+
+          unit_price: number;
+        }
+      }
+
+      export interface RecurringCredit {
+        id: string;
+
+        /**
+         * The amount of commit to grant.
+         */
+        access_amount: RecurringCredit.AccessAmount;
+
+        /**
+         * The amount of time the created commits will be valid for
+         */
+        commit_duration: RecurringCredit.CommitDuration;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        priority: number;
+
+        product: RecurringCredit.Product;
+
+        /**
+         * Whether the created commits will use the commit rate or list rate
+         */
+        rate_type: 'COMMIT_RATE' | 'LIST_RATE';
+
+        /**
+         * Determines the start time for the first commit
+         */
+        starting_at: string;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_ids?: Array<string>;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_tags?: Array<string>;
+
+        contract?: RecurringCredit.Contract;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        description?: string;
+
+        /**
+         * Determines when the contract will stop creating recurring commits. Optional
+         */
+        ending_before?: string;
+
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+
+        /**
+         * Displayed on invoices. Will be passed through to the individual commits
+         */
+        name?: string;
+
+        /**
+         * Will be passed down to the individual commits
+         */
+        netsuite_sales_order_id?: string;
+
+        /**
+         * Determines whether the first and last commit will be prorated. If not provided,
+         * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
+         */
+        proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
+
+        /**
+         * The frequency at which the recurring commits will be created. If not provided: -
+         * The commits will be created on the usage invoice frequency. If provided: - The
+         * period defined in the duration will correspond to this frequency. - Commits will
+         * be created aligned with the recurring commit's starting_at rather than the usage
+         * invoice dates.
+         */
+        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+
+        /**
+         * Will be passed down to the individual commits. This controls how much of an
+         * individual unexpired commit will roll over upon contract transition. 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
+         * specifiers to contribute to a commit's or credit's drawdown.
+         */
+        specifiers?: Array<Shared.CommitSpecifier>;
+
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        subscription_config?: Shared.RecurringCommitSubscriptionConfig;
+      }
+
+      export namespace RecurringCredit {
+        /**
+         * The amount of commit to grant.
+         */
+        export interface AccessAmount {
+          credit_type_id: string;
+
+          unit_price: number;
+
+          quantity?: number;
+        }
+
+        /**
+         * The amount of time the created commits will be valid for
+         */
+        export interface CommitDuration {
+          value: number;
+
+          unit?: 'PERIODS';
+        }
+
+        export interface Product {
+          id: string;
+
+          name: string;
+        }
+
+        export interface Contract {
+          id: string;
+        }
+      }
+    }
+  }
 }
 
 export interface ContractRetrieveResponse {
@@ -726,6 +1240,178 @@ export namespace ContractGetNetBalanceResponse {
 
 export type ContractListBalancesResponse = Shared.Commit | Shared.Credit;
 
+export interface ContractListSeatBalancesResponse {
+  data: Array<ContractListSeatBalancesResponse.Data>;
+
+  pagination: ContractListSeatBalancesResponse.Pagination;
+}
+
+export namespace ContractListSeatBalancesResponse {
+  export interface Data {
+    balances: Array<Data.Balance>;
+
+    /**
+     * The unique identifier for the seat
+     */
+    seat_id: string;
+
+    /**
+     * Array of commits applicable to this seat with their balances
+     */
+    commits?: Array<Data.Commit> | null;
+
+    /**
+     * Array of credits applicable to this seat with their balances
+     */
+    credits?: Array<Data.Credit>;
+  }
+
+  export namespace Data {
+    export interface Balance {
+      /**
+       * The total balance across all commits and credits for this seat, of this credit
+       * type.
+       */
+      balance: number;
+
+      credit_type_id: string;
+
+      /**
+       * The total initial balances of all commits and credits for this seat, of this
+       * credit type.
+       */
+      starting_balance: number;
+    }
+
+    export interface Commit {
+      /**
+       * The commit or credit ID
+       */
+      id: string;
+
+      /**
+       * The current balance for this commit for this specific seat
+       */
+      balance: number;
+
+      /**
+       * The datetime when the commit becomes active
+       */
+      start_date: string;
+
+      /**
+       * The datetime when the commit expires
+       */
+      end_date?: string | null;
+
+      /**
+       * Transaction history for this commit for this seat (only included if
+       * include_ledgers=true)
+       */
+      ledger_entries?: Array<Commit.LedgerEntry>;
+    }
+
+    export namespace Commit {
+      export interface LedgerEntry {
+        /**
+         * Amount of the ledger entry
+         */
+        amount: number;
+
+        /**
+         * The datetime when the ledger is created
+         */
+        timestamp: string;
+
+        /**
+         * Commit ledger type
+         */
+        type:
+          | 'PREPAID_COMMIT_SEGMENT_START'
+          | 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION'
+          | 'PREPAID_COMMIT_ROLLOVER'
+          | 'PREPAID_COMMIT_EXPIRATION'
+          | 'PREPAID_COMMIT_CANCELED'
+          | 'PREPAID_COMMIT_CREDITED'
+          | 'PREPAID_COMMIT_MANUAL'
+          | 'PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT';
+      }
+    }
+
+    export interface Credit {
+      /**
+       * The credit ID
+       */
+      id: string;
+
+      /**
+       * The current balance for this credit for this specific seat
+       */
+      balance: number;
+
+      /**
+       * The datetime when the credit becomes active
+       */
+      start_date: string;
+
+      /**
+       * The datetime when the credit expires
+       */
+      end_date?: string | null;
+
+      /**
+       * Transaction history for this credit for this seat (only included if
+       * include_ledgers=true)
+       */
+      ledger_entries?: Array<Credit.LedgerEntry>;
+    }
+
+    export namespace Credit {
+      export interface LedgerEntry {
+        /**
+         * Amount of the ledger entry
+         */
+        amount: number;
+
+        /**
+         * The datetime when the ledger is created
+         */
+        timestamp: string;
+
+        /**
+         * Credit ledger type
+         */
+        type:
+          | 'CREDIT_SEGMENT_START'
+          | 'CREDIT_AUTOMATED_INVOICE_DEDUCTION'
+          | 'CREDIT_EXPIRATION'
+          | 'CREDIT_CANCELED'
+          | 'CREDIT_CREDITED'
+          | 'CREDIT_MANUAL'
+          | 'CREDIT_SEAT_BASED_ADJUSTMENT'
+          | 'CREDIT_ROLLOVER';
+      }
+    }
+  }
+
+  export interface Pagination {
+    /**
+     * Number of seats available to fetch in the next page
+     */
+    seats_available_for_next_page: number;
+
+    /**
+     * Number of seats included in this response
+     */
+    seats_included: number;
+
+    /**
+     * Token to retrieve the next page of results. Null if no more pages available
+     */
+    next_page?: string | null;
+  }
+}
+
 export interface ContractRetrieveRateScheduleResponse {
   data: Array<ContractRetrieveRateScheduleResponse.Data>;
 
@@ -872,7 +1558,7 @@ export interface ContractCreateParams {
   /**
    * 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.
+   * uniqueness_key, transition, and custom_fields are allowed.
    */
   package_id?: string;
 
@@ -924,6 +1610,12 @@ export interface ContractCreateParams {
 
   spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
 
+  /**
+   * Spend trackers to attach to this contract. Aliases must be unique within a
+   * contract.
+   */
+  spend_trackers?: Array<ContractCreateParams.SpendTracker>;
+
   /**
    * Optional list of
    * [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
@@ -1038,11 +1730,6 @@ export namespace ContractCreateParams {
      */
     netsuite_sales_order_id?: string;
 
-    /**
-     * optionally payment gate this commit
-     */
-    payment_gate_config?: Commit.PaymentGateConfig;
-
     /**
      * If multiple commits are applicable, the one with the lower priority will apply
      * first.
@@ -1064,6 +1751,11 @@ export namespace ContractCreateParams {
      */
     specifiers?: Array<Shared.CommitSpecifierInput>;
 
+    /**
+     * Optional attributes for spend tracker integration. Immutable after creation.
+     */
+    spend_tracker_attributes?: Commit.SpendTrackerAttributes;
+
     /**
      * A temporary ID for the commit that can be used to reference the commit for
      * commit specific overrides.
@@ -1206,80 +1898,14 @@ export namespace ContractCreateParams {
     }
 
     /**
-     * optionally payment gate this commit
+     * Optional attributes for spend tracker integration. Immutable after creation.
      */
-    export interface PaymentGateConfig {
-      /**
-       * Gate access to the commit balance based on successful collection of payment.
-       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-       * facilitate payment using your own payment integration. Select NONE if you do not
-       * wish to payment gate the commit balance.
-       */
-      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
+    export interface SpendTrackerAttributes {
       /**
-       * Only applicable if using PRECALCULATED as your tax type.
+       * If true, this commit will be included in spend trackers with discounted set to
+       * DISCOUNTED_ONLY
        */
-      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-      /**
-       * Only applicable if using STRIPE as your payment gate type.
-       */
-      stripe_config?: PaymentGateConfig.StripeConfig;
-
-      /**
-       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-       * will default to NONE.
-       */
-      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-    }
-
-    export namespace PaymentGateConfig {
-      /**
-       * Only applicable if using PRECALCULATED as your tax type.
-       */
-      export interface PrecalculatedTaxConfig {
-        /**
-         * Amount of tax to be applied. This should be in the same currency and
-         * denomination as the commit's invoice schedule
-         */
-        tax_amount: number;
-
-        /**
-         * Name of the tax to be applied. This may be used in an invoice line item
-         * description.
-         */
-        tax_name?: string;
-      }
-
-      /**
-       * Only applicable if using STRIPE as your payment gate type.
-       */
-      export interface StripeConfig {
-        /**
-         * If left blank, will default to INVOICE
-         */
-        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
-
-        /**
-         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-         * your payment type.
-         */
-        invoice_metadata?: { [key: string]: string };
-
-        /**
-         * If true, the payment will be made assuming the customer is present (i.e. on
-         * session).
-         *
-         * If false, the payment will be made assuming the customer is not present (i.e.
-         * off session). For cardholders from a country with an e-mandate requirement (e.g.
-         * India), the payment may be declined.
-         *
-         * If left blank, will default to false.
-         */
-        on_session_payment?: boolean;
-      }
+      counts_as_discounted: boolean;
     }
   }
 
@@ -2285,6 +2911,32 @@ export namespace ContractCreateParams {
     }
   }
 
+  export interface SpendTracker {
+    /**
+     * Human-readable identifier, unique per contract.
+     */
+    alias: string;
+
+    applicable_spend_specifiers: Array<SpendTracker.ApplicableSpendSpecifier>;
+
+    credit_type_id: string;
+
+    reset_frequency: 'BILLING_PERIOD';
+  }
+
+  export namespace SpendTracker {
+    export interface ApplicableSpendSpecifier {
+      sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+
+      spend_type: 'COMMIT_PURCHASE';
+
+      /**
+       * Filter by whether the spend was discounted. Defaults to ANY if omitted.
+       */
+      discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+    }
+  }
+
   export interface Subscription {
     collection_schedule: 'ADVANCE' | 'ARREARS';
 
@@ -2664,11 +3316,6 @@ export namespace ContractAmendParams {
      */
     netsuite_sales_order_id?: string;
 
-    /**
-     * optionally payment gate this commit
-     */
-    payment_gate_config?: Commit.PaymentGateConfig;
-
     /**
      * If multiple commits are applicable, the one with the lower priority will apply
      * first.
@@ -2690,6 +3337,11 @@ export namespace ContractAmendParams {
      */
     specifiers?: Array<Shared.CommitSpecifierInput>;
 
+    /**
+     * Optional attributes for spend tracker integration. Immutable after creation.
+     */
+    spend_tracker_attributes?: Commit.SpendTrackerAttributes;
+
     /**
      * A temporary ID for the commit that can be used to reference the commit for
      * commit specific overrides.
@@ -2832,80 +3484,14 @@ export namespace ContractAmendParams {
     }
 
     /**
-     * optionally payment gate this commit
+     * Optional attributes for spend tracker integration. Immutable after creation.
      */
-    export interface PaymentGateConfig {
-      /**
-       * Gate access to the commit balance based on successful collection of payment.
-       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-       * facilitate payment using your own payment integration. Select NONE if you do not
-       * wish to payment gate the commit balance.
-       */
-      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
-      /**
-       * Only applicable if using PRECALCULATED as your tax type.
-       */
-      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-      /**
-       * Only applicable if using STRIPE as your payment gate type.
-       */
-      stripe_config?: PaymentGateConfig.StripeConfig;
-
-      /**
-       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-       * will default to NONE.
-       */
-      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-    }
-
-    export namespace PaymentGateConfig {
-      /**
-       * Only applicable if using PRECALCULATED as your tax type.
-       */
-      export interface PrecalculatedTaxConfig {
-        /**
-         * Amount of tax to be applied. This should be in the same currency and
-         * denomination as the commit's invoice schedule
-         */
-        tax_amount: number;
-
-        /**
-         * Name of the tax to be applied. This may be used in an invoice line item
-         * description.
-         */
-        tax_name?: string;
-      }
-
+    export interface SpendTrackerAttributes {
       /**
-       * Only applicable if using STRIPE as your payment gate type.
+       * If true, this commit will be included in spend trackers with discounted set to
+       * DISCOUNTED_ONLY
        */
-      export interface StripeConfig {
-        /**
-         * If left blank, will default to INVOICE
-         */
-        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
-
-        /**
-         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-         * your payment type.
-         */
-        invoice_metadata?: { [key: string]: string };
-
-        /**
-         * If true, the payment will be made assuming the customer is present (i.e. on
-         * session).
-         *
-         * If false, the payment will be made assuming the customer is not present (i.e.
-         * off session). For cardholders from a country with an e-mandate requirement (e.g.
-         * India), the payment may be declined.
-         *
-         * If left blank, will default to false.
-         */
-        on_session_payment?: boolean;
-      }
+      counts_as_discounted: boolean;
     }
   }
 
@@ -3658,6 +4244,75 @@ export interface ContractListBalancesParams extends BodyCursorPageParams {
   starting_at?: string;
 }
 
+export interface ContractListSeatBalancesParams {
+  /**
+   * The contract ID to retrieve seat balances for
+   */
+  contract_id: string;
+
+  /**
+   * The customer ID to retrieve seat balances for
+   */
+  customer_id: string;
+
+  /**
+   * Include only commits or credits with access that cover this specific date
+   * (cannot be used with starting_at or ending_before).
+   */
+  covering_date?: string;
+
+  /**
+   * Page token from a previous response to retrieve the next page
+   */
+  cursor?: string;
+
+  /**
+   * Include only commits or credits with access effective on or before this date
+   * (cannot be used with covering_date).
+   */
+  effective_before?: string;
+
+  /**
+   * Include credits and commits in the response
+   */
+  include_credits_and_commits?: boolean;
+
+  /**
+   * Include ledger entries for each commit and commit. `include_credits_and_commits`
+   * must be set to `true` for `include_ledgers=true` to apply.
+   */
+  include_ledgers?: boolean;
+
+  /**
+   * Maximum number of seats to return. Range: 1-100. Default: 25. When
+   * `include_credits_and_commits = true`, if the total commits/credits across all
+   * seats exceeds 100, a limit of 100 applies to the total credits and commits.
+   * Seats are included greedily to maximize the number of seats returned. Example:
+   * if seat 1 has 98 commits and seat 2 has 10 commits, both seats will be returned
+   * (total: 108 commits). Each returned seat includes all of its associated credits
+   * and commits.
+   */
+  limit?: number;
+
+  /**
+   * Optional filter to only include specific seats.
+   */
+  seat_ids?: Array<string>;
+
+  /**
+   * Include only commits or credits with access effective on or after this date
+   * (cannot be used with covering_date).
+   */
+  starting_at?: string;
+
+  /**
+   * Optional filter to only include seats from specific subscriptions. If
+   * subscriptions ids are not mapped to SEAT_BASED subscriptions, error will be
+   * returned.
+   */
+  subscription_ids?: Array<string>;
+}
+
 export interface ContractRetrieveRateScheduleParams {
   /**
    * Body param: ID of the contract to get the rate schedule for.
@@ -3858,6 +4513,7 @@ export declare namespace Contracts {
     type ContractCreateHistoricalInvoicesResponse as ContractCreateHistoricalInvoicesResponse,
     type ContractGetNetBalanceResponse as ContractGetNetBalanceResponse,
     type ContractListBalancesResponse as ContractListBalancesResponse,
+    type ContractListSeatBalancesResponse as ContractListSeatBalancesResponse,
     type ContractRetrieveRateScheduleResponse as ContractRetrieveRateScheduleResponse,
     type ContractRetrieveSubscriptionQuantityHistoryResponse as ContractRetrieveSubscriptionQuantityHistoryResponse,
     type ContractScheduleProServicesInvoiceResponse as ContractScheduleProServicesInvoiceResponse,
@@ -3872,6 +4528,7 @@ export declare namespace Contracts {
     type ContractCreateHistoricalInvoicesParams as ContractCreateHistoricalInvoicesParams,
     type ContractGetNetBalanceParams as ContractGetNetBalanceParams,
     type ContractListBalancesParams as ContractListBalancesParams,
+    type ContractListSeatBalancesParams as ContractListSeatBalancesParams,
     type ContractRetrieveRateScheduleParams as ContractRetrieveRateScheduleParams,
     type ContractRetrieveSubscriptionQuantityHistoryParams as ContractRetrieveSubscriptionQuantityHistoryParams,
     type ContractScheduleProServicesInvoiceParams as ContractScheduleProServicesInvoiceParams,