@metronome/sdk 3.4.1 → 3.6.0

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 {
@@ -1856,8 +1866,6 @@ export interface PackageCreateParams {
    */
   aliases?: Array<PackageCreateParams.Alias>;
 
-  billing_anchor_date?: 'contract_start_date' | 'first_billing_period';
-
   billing_provider?: 'aws_marketplace' | 'azure_marketplace' | 'gcp_marketplace' | 'stripe' | 'netsuite';
 
   commits?: Array<PackageCreateParams.Commit>;
@@ -2332,14 +2340,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/v1/v1.ts

@@ -153,6 +153,8 @@ import {
   ContractListBalancesResponsesBodyCursorPage,
   ContractListParams,
   ContractListResponse,
+  ContractListSeatBalancesParams,
+  ContractListSeatBalancesResponse,
   ContractRetrieveParams,
   ContractRetrieveRateScheduleParams,
   ContractRetrieveRateScheduleResponse,
@@ -394,6 +396,7 @@ export declare namespace V1 {
     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,
@@ -408,6 +411,7 @@ export declare namespace V1 {
     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,

package/src/resources/v2/contracts.ts

@@ -289,7 +289,7 @@ export namespace ContractGetEditHistoryResponse {
     /**
      * List of subscriptions on the contract.
      */
-    add_subscriptions?: Array<Shared.Subscription>;
+    add_subscriptions?: Array<Data.AddSubscription>;
 
     add_usage_filters?: Array<Data.AddUsageFilter>;
 
@@ -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 {
@@ -931,6 +935,130 @@ export namespace ContractGetEditHistoryResponse {
       }
     }
 
+    export interface AddSubscription {
+      /**
+       * Previous, current, and next billing periods for the subscription.
+       */
+      billing_periods: AddSubscription.BillingPeriods;
+
+      collection_schedule: 'ADVANCE' | 'ARREARS';
+
+      proration: AddSubscription.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<AddSubscription.QuantitySchedule>;
+
+      starting_at: string;
+
+      subscription_rate: AddSubscription.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?: AddSubscription.SeatConfig;
+    }
+
+    export namespace AddSubscription {
+      /**
+       * 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 AddUsageFilter {
       group_key: string;
 
@@ -1110,6 +1238,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 +1269,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 +1464,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 +1512,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 +1624,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 +1642,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 +2640,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 +3514,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 +3595,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 +3643,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 +3755,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 +3773,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.6.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.6.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.6.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.6.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.6.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map