@metronome/sdk 3.5.0 → 3.7.0

package/src/resources/shared.ts

@@ -183,6 +183,11 @@ export interface Commit {
    */
   specifiers?: Array<CommitSpecifier>;
 
+  /**
+   * Optional attributes controlling how this commit interacts with spend trackers.
+   */
+  spend_tracker_attributes?: Commit.SpendTrackerAttributes;
+
   /**
    * The subscription configuration for this commit, if it was generated from a
    * recurring commit with a subscription attached.
@@ -380,6 +385,17 @@ export namespace Commit {
     contract_id: string;
   }
 
+  /**
+   * Optional attributes controlling how this commit interacts with spend trackers.
+   */
+  export interface SpendTrackerAttributes {
+    /**
+     * If true, this commit is included in spend trackers with discounted set to
+     * DISCOUNTED_ONLY
+     */
+    counts_as_discounted: boolean;
+  }
+
   /**
    * The subscription configuration for this commit, if it was generated from a
    * recurring commit with a subscription attached.
@@ -532,6 +548,11 @@ export interface Contract {
 
   spend_threshold_configuration?: SpendThresholdConfiguration;
 
+  /**
+   * Spend trackers attached to this contract.
+   */
+  spend_trackers?: Array<Contract.SpendTracker>;
+
   /**
    * List of subscriptions on the contract.
    */
@@ -642,6 +663,39 @@ export namespace Contract {
      */
     configuration?: { [key: string]: unknown };
   }
+
+  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';
+
+    accumulated_spend?: SpendTracker.AccumulatedSpend;
+  }
+
+  export namespace SpendTracker {
+    export interface ApplicableSpendSpecifier {
+      sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+
+      spend_type: 'COMMIT_PURCHASE';
+
+      discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+    }
+
+    export interface AccumulatedSpend {
+      amount: number;
+
+      period_ending_before: string;
+
+      period_starting_at: string;
+    }
+  }
 }
 
 export interface ContractV2 {
@@ -758,10 +812,15 @@ export interface ContractV2 {
 
   spend_threshold_configuration?: SpendThresholdConfigurationV2;
 
+  /**
+   * Spend trackers attached to this contract.
+   */
+  spend_trackers?: Array<ContractV2.SpendTracker>;
+
   /**
    * List of subscriptions on the contract.
    */
-  subscriptions?: Array<Subscription>;
+  subscriptions?: Array<ContractV2.Subscription>;
 
   total_contract_value?: number;
 
@@ -895,6 +954,11 @@ export namespace ContractV2 {
      */
     specifiers?: Array<Shared.CommitSpecifier>;
 
+    /**
+     * Optional attributes controlling how this commit interacts with spend trackers.
+     */
+    spend_tracker_attributes?: Commit.SpendTrackerAttributes;
+
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -1082,6 +1146,17 @@ export namespace ContractV2 {
 
       contract_id: string;
     }
+
+    /**
+     * Optional attributes controlling how this commit interacts with spend trackers.
+     */
+    export interface SpendTrackerAttributes {
+      /**
+       * If true, this commit is included in spend trackers with discounted set to
+       * DISCOUNTED_ONLY
+       */
+      counts_as_discounted: boolean;
+    }
   }
 
   export interface Override {
@@ -1227,6 +1302,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 +1932,163 @@ export namespace ContractV2 {
       reseller_contract_value?: number;
     }
   }
+
+  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';
+
+    accumulated_spend?: SpendTracker.AccumulatedSpend;
+  }
+
+  export namespace SpendTracker {
+    export interface ApplicableSpendSpecifier {
+      sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+
+      spend_type: 'COMMIT_PURCHASE';
+
+      discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+    }
+
+    export interface AccumulatedSpend {
+      amount: number;
+
+      period_ending_before: string;
+
+      period_starting_at: string;
+    }
+  }
+
+  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 {
@@ -1932,6 +2166,11 @@ export interface ContractWithoutAmendments {
 
   spend_threshold_configuration?: SpendThresholdConfiguration;
 
+  /**
+   * Spend trackers attached to this contract.
+   */
+  spend_trackers?: Array<ContractWithoutAmendments.SpendTracker>;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -2270,6 +2509,39 @@ export namespace ContractWithoutAmendments {
     reseller_contract_value?: number;
   }
 
+  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';
+
+    accumulated_spend?: SpendTracker.AccumulatedSpend;
+  }
+
+  export namespace SpendTracker {
+    export interface ApplicableSpendSpecifier {
+      sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+
+      spend_type: 'COMMIT_PURCHASE';
+
+      discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+    }
+
+    export interface AccumulatedSpend {
+      amount: number;
+
+      period_ending_before: string;
+
+      period_starting_at: string;
+    }
+  }
+
   export interface UsageFilter {
     current: Shared.BaseUsageFilter | null;
 
@@ -2949,6 +3221,8 @@ export interface PrepaidBalanceThresholdConfiguration {
   custom_credit_type_id?: string;
 
   discount_configuration?: PrepaidBalanceThresholdConfiguration.DiscountConfiguration;
+
+  threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfiguration.ThresholdBalanceSpecifier>;
 }
 
 export namespace PrepaidBalanceThresholdConfiguration {
@@ -2983,6 +3257,54 @@ export namespace PrepaidBalanceThresholdConfiguration {
      * (a 15% discount).
      */
     payment_fraction: number;
+
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    cap?: DiscountConfiguration.Cap;
+  }
+
+  export namespace DiscountConfiguration {
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    export interface Cap {
+      /**
+       * Accumulated spend ceiling above which the discount stops applying.
+       */
+      amount: number;
+
+      /**
+       * Alias of the spend tracker this cap is measured against.
+       */
+      spend_tracker_alias: string;
+    }
+  }
+
+  export interface ThresholdBalanceSpecifier {
+    exclude: Array<ThresholdBalanceSpecifier.Exclude>;
+  }
+
+  export namespace ThresholdBalanceSpecifier {
+    export interface Exclude {
+      /**
+       * If provided, balances with all the custom fields will not be considered when
+       * evaluating threshold billing
+       */
+      custom_field_filters: Array<Exclude.CustomFieldFilter>;
+    }
+
+    export namespace Exclude {
+      export interface CustomFieldFilter {
+        entity: 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+        key: string;
+
+        value: string;
+      }
+    }
   }
 }
 
@@ -3016,6 +3338,8 @@ export interface PrepaidBalanceThresholdConfigurationV2 {
   custom_credit_type_id?: string;
 
   discount_configuration?: PrepaidBalanceThresholdConfigurationV2.DiscountConfiguration;
+
+  threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfigurationV2.ThresholdBalanceSpecifier>;
 }
 
 export namespace PrepaidBalanceThresholdConfigurationV2 {
@@ -3052,6 +3376,50 @@ export namespace PrepaidBalanceThresholdConfigurationV2 {
      * (a 15% discount).
      */
     payment_fraction: number;
+
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    cap?: DiscountConfiguration.Cap;
+  }
+
+  export namespace DiscountConfiguration {
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    export interface Cap {
+      /**
+       * Accumulated spend ceiling above which the discount stops applying.
+       */
+      amount: number;
+
+      /**
+       * Alias of the spend tracker this cap is measured against.
+       */
+      spend_tracker_alias: string;
+    }
+  }
+
+  export interface ThresholdBalanceSpecifier {
+    exclude: Array<ThresholdBalanceSpecifier.Exclude>;
+  }
+
+  export namespace ThresholdBalanceSpecifier {
+    export interface Exclude {
+      custom_field_filters: Array<Exclude.CustomFieldFilter>;
+    }
+
+    export namespace Exclude {
+      export interface CustomFieldFilter {
+        entity: 'Commit' | 'ContractCredit' | 'ContractCreditOrCommit';
+
+        key: string;
+
+        value: string;
+      }
+    }
   }
 }
 
@@ -3286,6 +3654,30 @@ export namespace SpendThresholdConfiguration {
      * (a 15% discount).
      */
     payment_fraction: number;
+
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    cap?: DiscountConfiguration.Cap;
+  }
+
+  export namespace DiscountConfiguration {
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    export interface Cap {
+      /**
+       * Accumulated spend ceiling above which the discount stops applying.
+       */
+      amount: number;
+
+      /**
+       * Alias of the spend tracker this cap is measured against.
+       */
+      spend_tracker_alias: string;
+    }
   }
 }
 
@@ -3318,6 +3710,30 @@ export namespace SpendThresholdConfigurationV2 {
      * (a 15% discount).
      */
     payment_fraction: number;
+
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    cap?: DiscountConfiguration.Cap;
+  }
+
+  export namespace DiscountConfiguration {
+    /**
+     * If provided, the discount stops applying once the spend tracker has accumulated
+     * this much spend in the billing period.
+     */
+    export interface Cap {
+      /**
+       * Accumulated spend ceiling above which the discount stops applying.
+       */
+      amount: number;
+
+      /**
+       * Alias of the spend tracker this cap is measured against.
+       */
+      spend_tracker_alias: string;
+    }
   }
 }
 

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;