@metronome/sdk 3.7.0 → 3.8.0

package/src/resources/shared.ts

@@ -103,6 +103,12 @@ export interface Commit {
 
   contract?: Commit.Contract;
 
+  /**
+   * The actor who created this commit. Omitted for system-generated commits such as
+   * recurring commits, rollover commits, and threshold commits.
+   */
+  created_by?: string;
+
   /**
    * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
    */
@@ -875,6 +881,12 @@ export namespace ContractV2 {
 
     contract?: Commit.Contract;
 
+    /**
+     * The actor who created this commit. Omitted for system-generated commits such as
+     * recurring commits, rollover commits, and threshold commits.
+     */
+    created_by?: string;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -1193,6 +1205,8 @@ export namespace ContractV2 {
 
   export namespace Override {
     export interface OverrideSpecifier {
+      any_commit_or_credit_ids?: Array<string>;
+
       billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       commit_ids?: Array<string>;
@@ -1326,6 +1340,12 @@ export namespace ContractV2 {
      */
     created_at?: string;
 
+    /**
+     * The actor who created this credit. Omitted for system-generated credits such as
+     * recurring credits.
+     */
+    created_by?: string;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -1691,6 +1711,11 @@ export namespace ContractV2 {
      */
     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
@@ -1698,7 +1723,7 @@ export namespace ContractV2 {
      * 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
@@ -1761,6 +1786,39 @@ export namespace ContractV2 {
 
       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).
+         */
+        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).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
   }
 
   export interface RecurringCredit {
@@ -1836,6 +1894,11 @@ export namespace ContractV2 {
      */
     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
@@ -1843,7 +1906,7 @@ export namespace ContractV2 {
      * 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
@@ -1895,6 +1958,26 @@ export namespace ContractV2 {
     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).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
   }
 
   export interface ResellerRoyalty {
@@ -2001,6 +2084,8 @@ export namespace ContractV2 {
 
     id?: string;
 
+    billing_cycle_config?: Subscription.BillingCycleConfig;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -2053,6 +2138,21 @@ export namespace ContractV2 {
       invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
 
       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).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
     }
 
     export interface QuantitySchedule {
@@ -2077,6 +2177,19 @@ export namespace ContractV2 {
       }
     }
 
+    export interface BillingCycleConfig {
+      /**
+       * The date this subscription's billing cycle is anchored to.
+       */
+      anchor_date: string;
+
+      /**
+       * Controls whether this subscription consolidates onto usage invoices or gets its
+       * own scheduled invoice.
+       */
+      invoice_placement: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+    }
+
     export interface SeatConfig {
       /**
        * The property name, sent on usage events, that identifies the seat ID associated
@@ -2275,6 +2388,11 @@ export namespace ContractWithoutAmendments {
      */
     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
@@ -2282,7 +2400,7 @@ export namespace ContractWithoutAmendments {
      * 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
@@ -2345,6 +2463,41 @@ export namespace ContractWithoutAmendments {
 
       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 {
@@ -2420,6 +2573,11 @@ export namespace ContractWithoutAmendments {
      */
     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
@@ -2427,7 +2585,7 @@ export namespace ContractWithoutAmendments {
      * 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
@@ -2479,6 +2637,27 @@ export namespace ContractWithoutAmendments {
     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';
+      }
+    }
   }
 
   export interface ResellerRoyalty {
@@ -2593,6 +2772,12 @@ export interface Credit {
 
   contract?: Credit.Contract;
 
+  /**
+   * The actor who created this credit. Omitted for system-generated credits such as
+   * recurring credits.
+   */
+  created_by?: string;
+
   /**
    * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
    */
@@ -3005,6 +3190,8 @@ export interface Override {
 
 export namespace Override {
   export interface OverrideSpecifier {
+    any_commit_or_credit_ids?: Array<string>;
+
     billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     commit_ids?: Array<string>;
@@ -3222,6 +3409,10 @@ export interface PrepaidBalanceThresholdConfiguration {
 
   discount_configuration?: PrepaidBalanceThresholdConfiguration.DiscountConfiguration;
 
+  /**
+   * Determines which balances are excluded from remaining balance calculation for
+   * threshold billing.
+   */
   threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfiguration.ThresholdBalanceSpecifier>;
 }
 
@@ -3284,6 +3475,10 @@ export namespace PrepaidBalanceThresholdConfiguration {
   }
 
   export interface ThresholdBalanceSpecifier {
+    /**
+     * If any of the exclude specifier is met, the balance is not considered when
+     * evaluating threshold billing
+     */
     exclude: Array<ThresholdBalanceSpecifier.Exclude>;
   }
 
@@ -3339,6 +3534,10 @@ export interface PrepaidBalanceThresholdConfigurationV2 {
 
   discount_configuration?: PrepaidBalanceThresholdConfigurationV2.DiscountConfiguration;
 
+  /**
+   * Determines which balances are excluded from remaining balance calculation for
+   * threshold billing.
+   */
   threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfigurationV2.ThresholdBalanceSpecifier>;
 }
 
@@ -3772,6 +3971,8 @@ export interface Subscription {
 
   id?: string;
 
+  billing_cycle_config?: Subscription.BillingCycleConfig;
+
   /**
    * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
    */
@@ -3824,6 +4025,22 @@ export namespace Subscription {
     invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
 
     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 QuantitySchedule {
@@ -3848,6 +4065,19 @@ export namespace Subscription {
     }
   }
 
+  export interface BillingCycleConfig {
+    /**
+     * The date this subscription's billing cycle is anchored to.
+     */
+    anchor_date: string;
+
+    /**
+     * Controls whether this subscription consolidates onto usage invoices or gets its
+     * own scheduled invoice.
+     */
+    invoice_placement: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+  }
+
   export interface SeatConfig {
     /**
      * The property name, sent on usage events, that identifies the seat ID associated

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';