@metronome/sdk 3.5.0 → 3.6.0

package/src/internal/utils/log.ts

@@ -107,6 +107,8 @@ export const formatRequestDetails = (details: {
           name,
           (
             name.toLowerCase() === 'authorization' ||
+            name.toLowerCase() === 'api-key' ||
+            name.toLowerCase() === 'x-api-key' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'
           ) ?

package/src/resources/shared.ts

@@ -761,7 +761,7 @@ export interface ContractV2 {
   /**
    * List of subscriptions on the contract.
    */
-  subscriptions?: Array<Subscription>;
+  subscriptions?: Array<ContractV2.Subscription>;
 
   total_contract_value?: number;
 
@@ -1227,6 +1227,8 @@ export namespace ContractV2 {
 
     applicable_product_tags?: Array<string>;
 
+    archived_at?: string;
+
     /**
      * The current balance of the credit or commit. This balance reflects the amount of
      * credit or commit that the customer has access to use at this moment - thus,
@@ -1855,6 +1857,130 @@ export namespace ContractV2 {
       reseller_contract_value?: number;
     }
   }
+
+  export interface Subscription {
+    /**
+     * Previous, current, and next billing periods for the subscription.
+     */
+    billing_periods: Subscription.BillingPeriods;
+
+    collection_schedule: 'ADVANCE' | 'ARREARS';
+
+    proration: Subscription.Proration;
+
+    /**
+     * Determines how the subscription's quantity is controlled. Defaults to
+     * QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
+     * directly on the subscription. `initial_quantity` must be provided with this
+     * option. Compatible with recurring commits/credits that use POOLED allocation.
+     * **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+     * user_123) to increment and decrement a subscription quantity, rather than
+     * directly providing the quantity. You must use a **SEAT_BASED** subscription to
+     * use a linked recurring credit with an allocation per seat. `seat_config` must be
+     * provided with this option.
+     */
+    quantity_management_mode: 'SEAT_BASED' | 'QUANTITY_ONLY';
+
+    /**
+     * List of quantity schedule items for the subscription. Only includes the current
+     * quantity and future quantity changes.
+     */
+    quantity_schedule: Array<Subscription.QuantitySchedule>;
+
+    starting_at: string;
+
+    subscription_rate: Subscription.SubscriptionRate;
+
+    id?: string;
+
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: { [key: string]: string };
+
+    description?: string;
+
+    ending_before?: string;
+
+    fiat_credit_type_id?: string;
+
+    name?: string;
+
+    seat_config?: Subscription.SeatConfig;
+  }
+
+  export namespace Subscription {
+    /**
+     * Previous, current, and next billing periods for the subscription.
+     */
+    export interface BillingPeriods {
+      current?: BillingPeriods.Current;
+
+      next?: BillingPeriods.Next;
+
+      previous?: BillingPeriods.Previous;
+    }
+
+    export namespace BillingPeriods {
+      export interface Current {
+        ending_before: string;
+
+        starting_at: string;
+      }
+
+      export interface Next {
+        ending_before: string;
+
+        starting_at: string;
+      }
+
+      export interface Previous {
+        ending_before: string;
+
+        starting_at: string;
+      }
+    }
+
+    export interface Proration {
+      invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
+
+      is_prorated: boolean;
+    }
+
+    export interface QuantitySchedule {
+      quantity: number;
+
+      starting_at: string;
+
+      ending_before?: string;
+    }
+
+    export interface SubscriptionRate {
+      billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+
+      product: SubscriptionRate.Product;
+    }
+
+    export namespace SubscriptionRate {
+      export interface Product {
+        id: string;
+
+        name: string;
+      }
+    }
+
+    export interface SeatConfig {
+      /**
+       * The property name, sent on usage events, that identifies the seat ID associated
+       * with the usage event. For example, the property name might be seat_id or
+       * user_id. The property must be set as a group key on billable metrics and a
+       * presentation/pricing group key on contract products. This allows linked
+       * recurring credits with an allocation per seat to be consumed by only one seat's
+       * usage.
+       */
+      seat_group_key: string;
+    }
+  }
 }
 
 export interface ContractWithoutAmendments {

package/src/resources/v1/alerts.ts

@@ -229,7 +229,7 @@ export interface AlertCreateParams {
 
 export namespace AlertCreateParams {
   export interface CustomFieldFilter {
-    entity: 'Contract' | 'Commit' | 'ContractCredit';
+    entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
 
     key: string;
 

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
@@ -726,6 +775,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 +1093,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;
 
@@ -1038,11 +1259,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.
@@ -1204,83 +1420,6 @@ export namespace ContractCreateParams {
         unit_price?: number;
       }
     }
-
-    /**
-     * optionally payment gate this commit
-     */
-    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;
-      }
-
-      /**
-       * 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;
-      }
-    }
   }
 
   export interface Credit {
@@ -2664,11 +2803,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.
@@ -2830,83 +2964,6 @@ export namespace ContractAmendParams {
         unit_price?: number;
       }
     }
-
-    /**
-     * optionally payment gate this commit
-     */
-    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;
-      }
-
-      /**
-       * 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;
-      }
-    }
   }
 
   export interface Credit {
@@ -3658,6 +3715,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 +3984,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 +3999,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,