@metronome/sdk 3.7.0 → 3.9.0

package/src/resources/v1/alerts.ts

@@ -155,6 +155,13 @@ export interface AlertCreateParams {
    */
   threshold: number;
 
+  /**
+   * Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+   * notifications. Defines the balances that are considered when evaluating the
+   * alert.
+   */
+  alert_specifiers?: Array<AlertCreateParams.AlertSpecifier>;
+
   /**
    * For threshold notifications of type `usage_threshold_reached`, specifies which
    * billable metric to track the usage for.
@@ -228,6 +235,48 @@ export interface AlertCreateParams {
 }
 
 export namespace AlertCreateParams {
+  export interface AlertSpecifier {
+    /**
+     * A list of custom field filters for notification types that support advanced
+     * filtering
+     */
+    custom_field_filters?: Array<AlertSpecifier.CustomFieldFilter>;
+
+    /**
+     * If provided, the specifier will not apply to balances that matches the inclusion
+     * criteria and any of the excluding values.
+     */
+    exclude?: Array<AlertSpecifier.Exclude>;
+  }
+
+  export namespace AlertSpecifier {
+    export interface CustomFieldFilter {
+      entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+      key: string;
+
+      value?: string;
+    }
+
+    export interface Exclude {
+      /**
+       * A list of custom field filters for notification types that support advanced
+       * filtering
+       */
+      custom_field_filters?: Array<Exclude.CustomFieldFilter>;
+    }
+
+    export namespace Exclude {
+      export interface CustomFieldFilter {
+        entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+        key: string;
+
+        value: string;
+      }
+    }
+  }
+
   export interface CustomFieldFilter {
     entity: 'Contract' | 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
 

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

@@ -451,6 +451,53 @@ export class Contracts extends APIResource {
     return this._client.post('/v1/contracts/customerBalances/getNetBalance', { body, ...options });
   }
 
+  /**
+   * Get the history of subscription seats schedule over time for a given
+   * `subscription_id`. This endpoint provides information about seat assignments and
+   * total quantities for different time periods, allowing you to track how seat
+   * assignments have changed over time.
+   *
+   * ### Use this endpoint to:
+   *
+   * - Track changes to seat assignments over time
+   * - Get seat schedule for a specific date using the `covering_date` parameter
+   * - Get seat schedule history with optional date range filtering using
+   *   `starting_at` and `ending_before`
+   *
+   * ### Key response fields:
+   *
+   * - data: array of seat schedule entries with time periods, quantity, and
+   *   assignments
+   * - next_page: cursor for pagination to retrieve additional results
+   *
+   * ### Usage guidelines:
+   *
+   * - Use `covering_date` to get the active seats for a specific point in time.
+   *   `covering_date` cannot be used with `starting_at` or `ending_before`.
+   * - Use `starting_at` and `ending_before` to filter results by time range.
+   *   `starting_at` and `ending_before` cannot be used with `covering_date`.
+   * - Maximum limit is 10 seat schedule entries per request
+   * - Results are ordered by `starting_at` timestamp
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.getSubscriptionSeatsHistory({
+   *     contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *     subscription_id: '1a824d53-bde6-4d82-96d7-6347ff227d5c',
+   *     covering_date: '2024-01-15T00:00:00.000Z',
+   *     limit: 10,
+   *   });
+   * ```
+   */
+  getSubscriptionSeatsHistory(
+    body: ContractGetSubscriptionSeatsHistoryParams,
+    options?: RequestOptions,
+  ): APIPromise<ContractGetSubscriptionSeatsHistoryResponse> {
+    return this._client.post('/v1/contracts/getSubscriptionSeatsHistory', { 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,
@@ -777,9 +824,6 @@ export namespace ContractCreateResponse {
        */
       custom_fields?: { [key: string]: string };
 
-      /**
-       * The billing provider configuration associated with the contract.
-       */
       customer_billing_provider_configuration?: Contract.CustomerBillingProviderConfiguration;
 
       ending_before?: string;
@@ -871,13 +915,19 @@ export namespace ContractCreateResponse {
         frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
       }
 
-      /**
-       * The billing provider configuration associated with the contract.
-       */
       export interface CustomerBillingProviderConfiguration {
-        id?: string;
+        /**
+         * ID of this configuration; can be provided as the
+         * billing_provider_configuration_id when creating a contract.
+         */
+        id: string;
+
+        archived_at: string | null;
 
-        billing_provider?:
+        /**
+         * The billing provider set for this configuration.
+         */
+        billing_provider:
           | 'aws_marketplace'
           | 'stripe'
           | 'netsuite'
@@ -888,7 +938,29 @@ export namespace ContractCreateResponse {
           | 'gcp_marketplace'
           | 'metronome';
 
-        delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+        /**
+         * Configuration for the billing provider. The structure of this object is specific
+         * to the billing provider.
+         */
+        configuration: { [key: string]: unknown };
+
+        customer_id: string;
+
+        /**
+         * The method to use for delivering invoices to this customer.
+         */
+        delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+
+        /**
+         * Configuration for the delivery method. The structure of this object is specific
+         * to the delivery method.
+         */
+        delivery_method_configuration: { [key: string]: unknown };
+
+        /**
+         * ID of the delivery method to use for this customer.
+         */
+        delivery_method_id: string;
       }
 
       /**
@@ -989,6 +1061,11 @@ export namespace ContractCreateResponse {
          */
         proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+        /**
+         * Rounding configuration for prorated recurring commit amounts.
+         */
+        proration_rounding?: RecurringCommit.ProrationRounding | null;
+
         /**
          * 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
@@ -996,7 +1073,7 @@ export namespace ContractCreateResponse {
          * be created aligned with the recurring commit's starting_at rather than the usage
          * invoice dates.
          */
-        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
         /**
          * Will be passed down to the individual commits. This controls how much of an
@@ -1059,6 +1136,41 @@ export namespace ContractCreateResponse {
 
           unit_price: number;
         }
+
+        /**
+         * Rounding configuration for prorated recurring commit amounts.
+         */
+        export interface ProrationRounding {
+          access?: ProrationRounding.Access;
+
+          invoice?: ProrationRounding.Invoice;
+        }
+
+        export namespace ProrationRounding {
+          export interface Access {
+            /**
+             * Number of decimal places to round to. Applied directly to the stored monetary
+             * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+             * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+             * dollar).
+             */
+            decimal_places: number;
+
+            rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+          }
+
+          export interface Invoice {
+            /**
+             * Number of decimal places to round to. Applied directly to the stored monetary
+             * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+             * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+             * dollar).
+             */
+            decimal_places: number;
+
+            rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+          }
+        }
       }
 
       export interface RecurringCredit {
@@ -1134,6 +1246,11 @@ export namespace ContractCreateResponse {
          */
         proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+        /**
+         * Rounding configuration for prorated recurring credit amounts.
+         */
+        proration_rounding?: RecurringCredit.ProrationRounding | null;
+
         /**
          * 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
@@ -1141,7 +1258,7 @@ export namespace ContractCreateResponse {
          * be created aligned with the recurring commit's starting_at rather than the usage
          * invoice dates.
          */
-        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
         /**
          * Will be passed down to the individual commits. This controls how much of an
@@ -1193,6 +1310,27 @@ export namespace ContractCreateResponse {
         export interface Contract {
           id: string;
         }
+
+        /**
+         * Rounding configuration for prorated recurring credit amounts.
+         */
+        export interface ProrationRounding {
+          access?: ProrationRounding.Access;
+        }
+
+        export namespace ProrationRounding {
+          export interface Access {
+            /**
+             * Number of decimal places to round to. Applied directly to the stored monetary
+             * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+             * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+             * dollar).
+             */
+            decimal_places: number;
+
+            rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+          }
+        }
       }
     }
   }
@@ -1238,6 +1376,39 @@ export namespace ContractGetNetBalanceResponse {
   }
 }
 
+export interface ContractGetSubscriptionSeatsHistoryResponse {
+  data: Array<ContractGetSubscriptionSeatsHistoryResponse.Data>;
+
+  /**
+   * Cursor for the next page of results
+   */
+  next_page: string | null;
+}
+
+export namespace ContractGetSubscriptionSeatsHistoryResponse {
+  export interface Data {
+    /**
+     * Array of seat IDs that are assigned in this period
+     */
+    assigned_seat_ids: Array<string>;
+
+    /**
+     * The end time of this seat schedule period (null if ongoing)
+     */
+    ending_before: string | null;
+
+    /**
+     * The start time of this seat schedule period
+     */
+    starting_at: string;
+
+    /**
+     * Total number of assigned and unassigned seats in this period
+     */
+    total_quantity: number;
+  }
+}
+
 export type ContractListBalancesResponse = Shared.Commit | Shared.Credit;
 
 export interface ContractListSeatBalancesResponse {
@@ -2201,9 +2372,10 @@ export namespace ContractCreateParams {
 
     /**
      * Indicates whether the override should only apply to commits. Defaults to
-     * `false`. If `true`, you can specify relevant commits in `override_specifiers` by
-     * passing `commit_ids`. if you do not specify `commit_ids`, then the override will
-     * apply when consuming any prepaid or postpaid commit.
+     * `false`. If `true` you can specify relevant commits in `override_specifiers` by
+     * passing `commit_ids`, `recurring_commit_ids`, or `any_commit_or_credit_ids`. If
+     * you do not specify any of these fields, the override will apply when consuming
+     * any prepaid commit, postpaid commit, or credit
      */
     is_commit_specific?: boolean;
 
@@ -2257,6 +2429,15 @@ export namespace ContractCreateParams {
 
   export namespace Override {
     export interface OverrideSpecifier {
+      /**
+       * 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`. Must be used instead of both `commit_ids` and
+       * `recurring_commit_ids` If provided, the override will apply to any specified
+       * commit, credit, recurring commit or recurring credit IDs.
+       */
+      any_commit_or_credit_ids?: Array<string>;
+
       billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       /**
@@ -2447,6 +2628,11 @@ export namespace ContractCreateParams {
      */
     proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+    /**
+     * Optional rounding configuration for prorated recurring commit amounts.
+     */
+    proration_rounding?: RecurringCommit.ProrationRounding;
+
     /**
      * Whether the created commits will use the commit rate or list rate
      */
@@ -2459,7 +2645,7 @@ export namespace ContractCreateParams {
      * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -2526,6 +2712,41 @@ export namespace ContractCreateParams {
       unit_price: number;
     }
 
+    /**
+     * Optional rounding configuration for prorated recurring commit amounts.
+     */
+    export interface ProrationRounding {
+      access?: ProrationRounding.Access;
+
+      invoice?: ProrationRounding.Invoice;
+    }
+
+    export namespace ProrationRounding {
+      export interface Access {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+         * dollar).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+
+      export interface Invoice {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+         * dollar).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
+
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -2620,6 +2841,11 @@ export namespace ContractCreateParams {
      */
     proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+    /**
+     * Optional rounding configuration for prorated recurring credit amounts.
+     */
+    proration_rounding?: RecurringCredit.ProrationRounding;
+
     /**
      * Whether the created commits will use the commit rate or list rate
      */
@@ -2632,7 +2858,7 @@ export namespace ContractCreateParams {
      * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -2688,6 +2914,27 @@ export namespace ContractCreateParams {
       unit?: 'PERIODS';
     }
 
+    /**
+     * Optional rounding configuration for prorated recurring credit amounts.
+     */
+    export interface ProrationRounding {
+      access?: ProrationRounding.Access;
+    }
+
+    export namespace ProrationRounding {
+      export interface Access {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+         * dollar).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
+
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -2944,6 +3191,8 @@ export namespace ContractCreateParams {
 
     subscription_rate: Subscription.SubscriptionRate;
 
+    billing_cycle_config?: Subscription.BillingCycleConfig;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -3008,6 +3257,22 @@ export namespace ContractCreateParams {
        * Indicates if the partial period will be prorated or charged a full amount.
        */
       is_prorated?: boolean;
+
+      rounding?: Proration.Rounding;
+    }
+
+    export namespace Proration {
+      export interface Rounding {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+         * dollar).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
     }
 
     export interface SubscriptionRate {
@@ -3023,6 +3288,20 @@ export namespace ContractCreateParams {
       product_id: string;
     }
 
+    export interface BillingCycleConfig {
+      /**
+       * The date to anchor the billing cycle to. If omitted, defaults to the contract's
+       * usage invoice billing cycle anchor date.
+       */
+      anchor_date?: string;
+
+      /**
+       * Controls whether this subscription consolidates onto usage invoices or gets its
+       * own scheduled invoice. Defaults to ON_USAGE_INVOICE if omitted.
+       */
+      invoice_placement?: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+    }
+
     export interface SeatConfig {
       /**
        * The initial assigned seats on this subscription.
@@ -3739,9 +4018,10 @@ export namespace ContractAmendParams {
 
     /**
      * Indicates whether the override should only apply to commits. Defaults to
-     * `false`. If `true`, you can specify relevant commits in `override_specifiers` by
-     * passing `commit_ids`. if you do not specify `commit_ids`, then the override will
-     * apply when consuming any prepaid or postpaid commit.
+     * `false`. If `true` you can specify relevant commits in `override_specifiers` by
+     * passing `commit_ids`, `recurring_commit_ids`, or `any_commit_or_credit_ids`. If
+     * you do not specify any of these fields, the override will apply when consuming
+     * any prepaid commit, postpaid commit, or credit
      */
     is_commit_specific?: boolean;
 
@@ -3795,6 +4075,15 @@ export namespace ContractAmendParams {
 
   export namespace Override {
     export interface OverrideSpecifier {
+      /**
+       * 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`. Must be used instead of both `commit_ids` and
+       * `recurring_commit_ids` If provided, the override will apply to any specified
+       * commit, credit, recurring commit or recurring credit IDs.
+       */
+      any_commit_or_credit_ids?: Array<string>;
+
       billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       /**
@@ -4196,6 +4485,46 @@ export interface ContractGetNetBalanceParams {
   invoice_inclusion_mode?: 'FINALIZED' | 'FINALIZED_AND_DRAFT';
 }
 
+export interface ContractGetSubscriptionSeatsHistoryParams {
+  contract_id: string;
+
+  customer_id: string;
+
+  subscription_id: string;
+
+  /**
+   * Get the seats history segment for the covering date. Cannot be used with
+   * `starting_at` or `ending_before`.
+   */
+  covering_date?: string | null;
+
+  /**
+   * Cursor for pagination. Use the value from the `next_page` field of the previous
+   * response to retrieve the next page of results.
+   */
+  cursor?: string | null;
+
+  /**
+   * Include seats history segments that are active at or before this timestamp. Use
+   * with `starting_at` to get a specific time range. If not set, there's no upper
+   * bound.
+   */
+  ending_before?: string | null;
+
+  /**
+   * Maximum number of seat schedule entries to return. Defaults to 10. Required
+   * range: 1 <= x <= 10.
+   */
+  limit?: number | null;
+
+  /**
+   * Include seats history segments that are active at or after this timestamp. Use
+   * with `ending_before` to get a specific time range. If not set, there's no lower
+   * bound.
+   */
+  starting_at?: string | null;
+}
+
 export interface ContractListBalancesParams extends BodyCursorPageParams {
   customer_id: string;
 
@@ -4299,6 +4628,12 @@ export interface ContractListSeatBalancesParams {
    */
   seat_ids?: Array<string>;
 
+  /**
+   * When true, any seat_ids not found in contract subscriptions will be silently
+   * omitted from the response instead of returning a 400 error.
+   */
+  skip_missing_seat_ids?: boolean;
+
   /**
    * Include only commits or credits with access effective on or after this date
    * (cannot be used with covering_date).
@@ -4512,6 +4847,7 @@ export declare namespace Contracts {
     type ContractArchiveResponse as ContractArchiveResponse,
     type ContractCreateHistoricalInvoicesResponse as ContractCreateHistoricalInvoicesResponse,
     type ContractGetNetBalanceResponse as ContractGetNetBalanceResponse,
+    type ContractGetSubscriptionSeatsHistoryResponse as ContractGetSubscriptionSeatsHistoryResponse,
     type ContractListBalancesResponse as ContractListBalancesResponse,
     type ContractListSeatBalancesResponse as ContractListSeatBalancesResponse,
     type ContractRetrieveRateScheduleResponse as ContractRetrieveRateScheduleResponse,
@@ -4527,6 +4863,7 @@ export declare namespace Contracts {
     type ContractArchiveParams as ContractArchiveParams,
     type ContractCreateHistoricalInvoicesParams as ContractCreateHistoricalInvoicesParams,
     type ContractGetNetBalanceParams as ContractGetNetBalanceParams,
+    type ContractGetSubscriptionSeatsHistoryParams as ContractGetSubscriptionSeatsHistoryParams,
     type ContractListBalancesParams as ContractListBalancesParams,
     type ContractListSeatBalancesParams as ContractListSeatBalancesParams,
     type ContractRetrieveRateScheduleParams as ContractRetrieveRateScheduleParams,

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

@@ -9,6 +9,7 @@ export {
   type ContractArchiveResponse,
   type ContractCreateHistoricalInvoicesResponse,
   type ContractGetNetBalanceResponse,
+  type ContractGetSubscriptionSeatsHistoryResponse,
   type ContractListBalancesResponse,
   type ContractListSeatBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
@@ -23,6 +24,7 @@ export {
   type ContractArchiveParams,
   type ContractCreateHistoricalInvoicesParams,
   type ContractGetNetBalanceParams,
+  type ContractGetSubscriptionSeatsHistoryParams,
   type ContractListBalancesParams,
   type ContractListSeatBalancesParams,
   type ContractRetrieveRateScheduleParams,

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

@@ -59,6 +59,10 @@ export class Rates extends APIResource {
   /**
    * Add a new rate
    *
+   * This endpoint is heavily rate limited. For adding multiple rates, using the
+   * [addRates](https://docs.metronome.com/api-reference/rate-cards/add-rates)
+   * endpoint is strongly encouraged.
+   *
    * @example
    * ```ts
    * const response =