@metronome/sdk 3.4.1 → 3.5.0

package/src/resources/shared.ts

@@ -34,6 +34,12 @@ export interface BaseThresholdCommit {
    * will default to the commit product name.
    */
   name?: string;
+
+  /**
+   * The priority of the commit, used to determine drawdown order. Lower priority
+   * commits are consumed first. Defaults to 100 if not specified.
+   */
+  priority?: number;
 }
 
 export interface BaseUsageFilter {
@@ -1081,6 +1087,8 @@ export namespace ContractV2 {
   export interface Override {
     id: string;
 
+    created_at: string;
+
     starting_at: string;
 
     applicable_product_tags?: Array<string>;
@@ -1123,8 +1131,6 @@ export namespace ContractV2 {
       product_tags?: Array<string>;
 
       recurring_commit_ids?: Array<string>;
-
-      recurring_credit_ids?: Array<string>;
     }
 
     export interface OverwriteRate {
@@ -1267,6 +1273,7 @@ export namespace ContractV2 {
       | Credit.CreditCreditedLedgerEntry
       | Credit.CreditManualLedgerEntry
       | Credit.CreditSeatBasedAdjustmentLedgerEntry
+      | Credit.CreditRolloverLedgerEntry
     >;
 
     name?: string;
@@ -1287,6 +1294,8 @@ export namespace ContractV2 {
      */
     recurring_credit_id?: string;
 
+    rolled_over_from?: Credit.RolledOverFrom;
+
     /**
      * This field's availability is dependent on your client's configuration.
      */
@@ -1397,6 +1406,24 @@ export namespace ContractV2 {
 
       type: 'CREDIT_SEAT_BASED_ADJUSTMENT';
     }
+
+    export interface CreditRolloverLedgerEntry {
+      amount: number;
+
+      new_contract_id: string;
+
+      segment_id: string;
+
+      timestamp: string;
+
+      type: 'CREDIT_ROLLOVER';
+    }
+
+    export interface RolledOverFrom {
+      contract_id: string;
+
+      credit_id: string;
+    }
   }
 
   /**
@@ -2318,6 +2345,7 @@ export interface Credit {
     | Credit.CreditCreditedLedgerEntry
     | Credit.CreditManualLedgerEntry
     | Credit.CreditSeatBasedAdjustmentLedgerEntry
+    | Credit.CreditRolloverLedgerEntry
   >;
 
   name?: string;
@@ -2341,6 +2369,8 @@ export interface Credit {
    */
   recurring_credit_id?: string;
 
+  rolled_over_from?: Credit.RolledOverFrom;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -2461,6 +2491,24 @@ export namespace Credit {
     type: 'CREDIT_SEAT_BASED_ADJUSTMENT';
   }
 
+  export interface CreditRolloverLedgerEntry {
+    amount: number;
+
+    new_contract_id: string;
+
+    segment_id: string;
+
+    timestamp: string;
+
+    type: 'CREDIT_ROLLOVER';
+  }
+
+  export interface RolledOverFrom {
+    contract_id: string;
+
+    credit_id: string;
+  }
+
   /**
    * The subscription configuration for this credit, if it was generated from a
    * recurring credit with a subscription attached.
@@ -2622,6 +2670,8 @@ export interface ID {
 export interface Override {
   id: string;
 
+  created_at: string;
+
   starting_at: string;
 
   applicable_product_tags?: Array<string>;
@@ -2696,8 +2746,6 @@ export namespace Override {
     product_tags?: Array<string>;
 
     recurring_commit_ids?: Array<string>;
-
-    recurring_credit_ids?: Array<string>;
   }
 
   export interface Product {
@@ -2899,6 +2947,8 @@ export interface PrepaidBalanceThresholdConfiguration {
    * commit amount will be in terms of this credit type instead of the fiat currency.
    */
   custom_credit_type_id?: string;
+
+  discount_configuration?: PrepaidBalanceThresholdConfiguration.DiscountConfiguration;
 }
 
 export namespace PrepaidBalanceThresholdConfiguration {
@@ -2925,6 +2975,15 @@ export namespace PrepaidBalanceThresholdConfiguration {
      */
     specifiers?: Array<Shared.CommitSpecifierInput>;
   }
+
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface PrepaidBalanceThresholdConfigurationV2 {
@@ -2955,10 +3014,12 @@ export interface PrepaidBalanceThresholdConfigurationV2 {
    * commit amount will be in terms of this credit type instead of the fiat currency.
    */
   custom_credit_type_id?: string;
+
+  discount_configuration?: PrepaidBalanceThresholdConfigurationV2.DiscountConfiguration;
 }
 
 export namespace PrepaidBalanceThresholdConfigurationV2 {
-  export interface Commit extends Shared.UpdateBaseThresholdCommit {
+  export interface Commit extends Shared.BaseThresholdCommit {
     /**
      * Which products the threshold commit applies to. If applicable_product_ids,
      * applicable_product_tags or specifiers are not provided, the commit applies to
@@ -2983,6 +3044,15 @@ export namespace PrepaidBalanceThresholdConfigurationV2 {
      */
     specifiers?: Array<Shared.CommitSpecifierInput>;
   }
+
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface PropertyFilter {
@@ -3204,10 +3274,23 @@ export interface SpendThresholdConfiguration {
    * hits this amount, a threshold charge will be initiated.
    */
   threshold_amount: number;
+
+  discount_configuration?: SpendThresholdConfiguration.DiscountConfiguration;
+}
+
+export namespace SpendThresholdConfiguration {
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface SpendThresholdConfigurationV2 {
-  commit: UpdateBaseThresholdCommit;
+  commit: BaseThresholdCommit;
 
   /**
    * When set to false, the contract will not be evaluated against the
@@ -3223,6 +3306,19 @@ export interface SpendThresholdConfigurationV2 {
    * hits this amount, a threshold charge will be initiated.
    */
   threshold_amount: number;
+
+  discount_configuration?: SpendThresholdConfigurationV2.DiscountConfiguration;
+}
+
+export namespace SpendThresholdConfigurationV2 {
+  export interface DiscountConfiguration {
+    /**
+     * The fraction of the original amount that the customer pays after applying the
+     * discount. For example, 0.85 means the customer pays 85% of the original amount
+     * (a 15% discount).
+     */
+    payment_fraction: number;
+  }
 }
 
 export interface Subscription {
@@ -3364,6 +3460,13 @@ export interface UpdateBaseThresholdCommit {
    */
   name?: string;
 
+  /**
+   * The priority of the commit, used to determine drawdown order. Lower priority
+   * commits are consumed first. Defaults to 100 if not specified. On updates, set to
+   * null to clear a previously configured priority.
+   */
+  priority?: number | null;
+
   /**
    * The commit product that will be used to generate the line item for commit
    * payment.

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

@@ -411,6 +411,10 @@ export class Contracts extends APIResource {
    *
    * ### Usage guidelines:
    *
+   * - **Balance ledger details**: Use the
+   *   [listBalances](https://docs.metronome.com/api-reference/credits-and-commits/list-balances)
+   *   endpoint instead to understand detailed ledger drawdowns for each individual
+   *   balance
    * - **Draft invoice handling**: Use `invoice_inclusion_mode` to control whether
    *   pending draft invoice deductions are included (`FINALIZED_AND_DRAFT`, the
    *   default) or excluded (`FINALIZED`) from the balance calculation
@@ -473,6 +477,9 @@ export class Contracts extends APIResource {
    *
    * ### Usage guidelines:
    *
+   * - Use the
+   *   [getNetBalance](https://docs.metronome.com/api-reference/credits-and-commits/get-the-net-balance-of-a-customer)
+   *   endpoint to retrieve a single combined current balance
    * - Date filtering: Use `effective_before` to include only balances with access
    *   before a specific date (exclusive)
    * - Set `include_balance=true` for calculated balance amounts on each commit or
@@ -1664,14 +1671,6 @@ export namespace ContractCreateParams {
        * commits created by the specified recurring commit ids.
        */
       recurring_commit_ids?: Array<string>;
-
-      /**
-       * 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`. If provided, the override will only apply to
-       * credits created by the specified recurring credit ids.
-       */
-      recurring_credit_ids?: Array<string>;
     }
 
     /**
@@ -3250,14 +3249,6 @@ export namespace ContractAmendParams {
        * commits created by the specified recurring commit ids.
        */
       recurring_commit_ids?: Array<string>;
-
-      /**
-       * 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`. If provided, the override will only apply to
-       * credits created by the specified recurring credit ids.
-       */
-      recurring_credit_ids?: Array<string>;
     }
 
     /**

package/src/resources/v1/packages.ts

@@ -217,6 +217,11 @@ export namespace PackageRetrieveResponse {
       | 'gcp_marketplace'
       | 'metronome';
 
+    /**
+     * The name to use for contracts created from this package.
+     */
+    contract_name?: string;
+
     credits?: Array<Data.Credit>;
 
     delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
@@ -437,8 +442,6 @@ export namespace PackageRetrieveResponse {
         product_tags?: Array<string>;
 
         recurring_commit_template_ids?: Array<string>;
-
-        recurring_credit_template_ids?: Array<string>;
       }
 
       export interface StartingAtOffset {
@@ -513,6 +516,8 @@ export namespace PackageRetrieveResponse {
 
     export interface UsageStatementSchedule {
       frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+
+      day?: 'FIRST_OF_MONTH' | 'CONTRACT_START';
     }
 
     export interface Alias {
@@ -1039,6 +1044,11 @@ export interface PackageListResponse {
     | 'gcp_marketplace'
     | 'metronome';
 
+  /**
+   * The name to use for contracts created from this package.
+   */
+  contract_name?: string;
+
   credits?: Array<PackageListResponse.Credit>;
 
   delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
@@ -1259,8 +1269,6 @@ export namespace PackageListResponse {
       product_tags?: Array<string>;
 
       recurring_commit_template_ids?: Array<string>;
-
-      recurring_credit_template_ids?: Array<string>;
     }
 
     export interface StartingAtOffset {
@@ -1335,6 +1343,8 @@ export namespace PackageListResponse {
 
   export interface UsageStatementSchedule {
     frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+
+    day?: 'FIRST_OF_MONTH' | 'CONTRACT_START';
   }
 
   export interface Alias {
@@ -2332,14 +2342,6 @@ export namespace PackageCreateParams {
        * commits created by the specified recurring commit ids.
        */
       recurring_commit_ids?: Array<string>;
-
-      /**
-       * 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`. If provided, the override will only apply to
-       * credits created by the specified recurring credit ids.
-       */
-      recurring_credit_ids?: Array<string>;
     }
 
     /**

package/src/resources/v2/contracts.ts

@@ -479,6 +479,10 @@ export namespace ContractGetEditHistoryResponse {
        */
       priority?: number;
 
+      rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+
+      rollover_fraction?: number;
+
       /**
        * This field's availability is dependent on your client's configuration.
        */
@@ -506,6 +510,8 @@ export namespace ContractGetEditHistoryResponse {
     export interface AddOverride {
       id: string;
 
+      created_at: string;
+
       starting_at: string;
 
       applicable_product_tags?: Array<string>;
@@ -548,8 +554,6 @@ export namespace ContractGetEditHistoryResponse {
         product_tags?: Array<string>;
 
         recurring_commit_ids?: Array<string>;
-
-        recurring_credit_ids?: Array<string>;
       }
 
       export interface OverwriteRate {
@@ -1110,6 +1114,20 @@ export namespace ContractGetEditHistoryResponse {
 
       access_schedule?: UpdateCredit.AccessSchedule;
 
+      /**
+       * Which products the credit applies to. If applicable_product_ids,
+       * applicable_product_tags or specifiers are not provided, the credit applies to
+       * all products.
+       */
+      applicable_product_ids?: Array<string> | null;
+
+      /**
+       * Which tags the credit applies to. If applicable_product_ids,
+       * applicable_product_tags or specifiers are not provided, the credit applies to
+       * all products.
+       */
+      applicable_product_tags?: Array<string> | null;
+
       description?: string;
 
       /**
@@ -1127,12 +1145,24 @@ export namespace ContractGetEditHistoryResponse {
        */
       priority?: number | null;
 
+      product_id?: string;
+
       /**
        * If set, the credit's rate type was updated to the specified value.
        */
       rate_type?: 'LIST_RATE' | 'COMMIT_RATE';
 
       rollover_fraction?: number | null;
+
+      /**
+       * 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. This field cannot
+       * be used together with `applicable_product_ids` or `applicable_product_tags`.
+       * Instead, to target usage by product or product tag, pass those values in the
+       * body of `specifiers`.
+       */
+      specifiers?: Array<Shared.CommitSpecifierInput> | null;
     }
 
     export namespace UpdateCredit {
@@ -1310,6 +1340,8 @@ export namespace ContractGetEditHistoryResponse {
        */
       custom_credit_type_id?: string | null;
 
+      discount_configuration?: UpdatePrepaidBalanceThresholdConfiguration.DiscountConfiguration | null;
+
       /**
        * When set to false, the contract will not be evaluated against the
        * threshold_amount. Toggling to true will result an immediate evaluation,
@@ -1356,6 +1388,15 @@ export namespace ContractGetEditHistoryResponse {
          */
         specifiers?: Array<Shared.CommitSpecifierInput> | null;
       }
+
+      export interface DiscountConfiguration {
+        /**
+         * The fraction of the original amount that the customer pays after applying the
+         * discount. Set to null to remove the discount fraction. For example, 0.85 means
+         * the customer pays 85% of the original amount (a 15% discount).
+         */
+        payment_fraction?: number | null;
+      }
     }
 
     export interface UpdateRecurringCommit {
@@ -1459,6 +1500,8 @@ export namespace ContractGetEditHistoryResponse {
     export interface UpdateSpendThresholdConfiguration {
       commit?: Shared.UpdateBaseThresholdCommit;
 
+      discount_configuration?: UpdateSpendThresholdConfiguration.DiscountConfiguration | null;
+
       /**
        * When set to false, the contract will not be evaluated against the
        * threshold_amount. Toggling to true will result an immediate evaluation,
@@ -1475,6 +1518,17 @@ export namespace ContractGetEditHistoryResponse {
       threshold_amount?: number;
     }
 
+    export namespace UpdateSpendThresholdConfiguration {
+      export interface DiscountConfiguration {
+        /**
+         * The fraction of the original amount that the customer pays after applying the
+         * discount. Set to null to remove the discount fraction. For example, 0.85 means
+         * the customer pays 85% of the original amount (a 15% discount).
+         */
+        payment_fraction?: number | null;
+      }
+    }
+
     export interface UpdateSubscription {
       id: string;
 
@@ -2462,14 +2516,6 @@ export namespace ContractEditParams {
        * created by the specified recurring commit ids.
        */
       recurring_commit_ids?: Array<string>;
-
-      /**
-       * 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. If provided, the override will only apply to commits
-       * created by the specified recurring credit ids.
-       */
-      recurring_credit_ids?: Array<string>;
     }
 
     /**
@@ -3344,15 +3390,15 @@ export namespace ContractEditParams {
     access_schedule?: UpdateCredit.AccessSchedule;
 
     /**
-     * Which products the commit applies to. If applicable_product_ids,
-     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * Which products the credit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the credit applies to
      * all products.
      */
     applicable_product_ids?: Array<string> | null;
 
     /**
-     * Which tags the commit applies to. If applicable_product_ids,
-     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * Which tags the credit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the credit applies to
      * all products.
      */
     applicable_product_tags?: Array<string> | null;
@@ -3425,6 +3471,8 @@ export namespace ContractEditParams {
      */
     custom_credit_type_id?: string | null;
 
+    discount_configuration?: UpdatePrepaidBalanceThresholdConfiguration.DiscountConfiguration | null;
+
     /**
      * When set to false, the contract will not be evaluated against the
      * threshold_amount. Toggling to true will result an immediate evaluation,
@@ -3471,6 +3519,15 @@ export namespace ContractEditParams {
        */
       specifiers?: Array<Shared.CommitSpecifierInput> | null;
     }
+
+    export interface DiscountConfiguration {
+      /**
+       * The fraction of the original amount that the customer pays after applying the
+       * discount. Set to null to remove the discount fraction. For example, 0.85 means
+       * the customer pays 85% of the original amount (a 15% discount).
+       */
+      payment_fraction?: number | null;
+    }
   }
 
   export interface UpdateRecurringCommit {
@@ -3574,6 +3631,8 @@ export namespace ContractEditParams {
   export interface UpdateSpendThresholdConfiguration {
     commit?: Shared.UpdateBaseThresholdCommit;
 
+    discount_configuration?: UpdateSpendThresholdConfiguration.DiscountConfiguration | null;
+
     /**
      * When set to false, the contract will not be evaluated against the
      * threshold_amount. Toggling to true will result an immediate evaluation,
@@ -3590,6 +3649,17 @@ export namespace ContractEditParams {
     threshold_amount?: number;
   }
 
+  export namespace UpdateSpendThresholdConfiguration {
+    export interface DiscountConfiguration {
+      /**
+       * The fraction of the original amount that the customer pays after applying the
+       * discount. Set to null to remove the discount fraction. For example, 0.85 means
+       * the customer pays 85% of the original amount (a 15% discount).
+       */
+      payment_fraction?: number | null;
+    }
+  }
+
   export interface UpdateSubscription {
     subscription_id: string;
 

package/src/resources/webhooks.ts

@@ -82,7 +82,7 @@ export class Webhooks extends APIResource {
   ): void {
     this.validateSecret(secret);
 
-    const msgDate = getRequiredHeader(headers, 'Date');
+    const msgDate = getRequiredHeader(headers, 'X-Metronome-Date');
     const msgSignature = getRequiredHeader(headers, 'Metronome-Webhook-Signature');
 
     const now = Date.now();

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.4.1'; // x-release-please-version
+export const VERSION = '3.5.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.4.1";
+export declare const VERSION = "3.5.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.4.1";
+export declare const VERSION = "3.5.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.4.1'; // x-release-please-version
+exports.VERSION = '3.5.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.4.1'; // x-release-please-version
+export const VERSION = '3.5.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map