@metronome/sdk 0.1.0-beta.9 → 0.2.0

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

@@ -1,16 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
-import * as NamedSchedulesAPI from './named-schedules';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
+import * as NamedSchedulesAPI from "./named-schedules.js";
 import {
   NamedScheduleRetrieveParams,
   NamedScheduleRetrieveResponse,
   NamedScheduleUpdateParams,
   NamedSchedules,
-} from './named-schedules';
-import * as ProductsAPI from './products';
+} from "./named-schedules.js";
+import * as ProductsAPI from "./products.js";
 import {
   ProductArchiveParams,
   ProductArchiveResponse,
@@ -27,10 +27,12 @@ import {
   Products,
   QuantityConversion,
   QuantityRounding,
-} from './products';
-import * as InvoicesAPI from '../customers/invoices';
-import * as RateCardsAPI from './rate-cards/rate-cards';
+} from "./products.js";
+import * as InvoicesAPI from "../customers/invoices.js";
+import * as RateCardsAPI from "./rate-cards/rate-cards.js";
 import {
+  RateCardArchiveParams,
+  RateCardArchiveResponse,
   RateCardCreateParams,
   RateCardCreateResponse,
   RateCardListParams,
@@ -43,7 +45,7 @@ import {
   RateCardUpdateParams,
   RateCardUpdateResponse,
   RateCards,
-} from './rate-cards/rate-cards';
+} from "./rate-cards/rate-cards.js";
 
 export class Contracts extends APIResource {
   products: ProductsAPI.Products = new ProductsAPI.Products(this._client);
@@ -52,13 +54,35 @@ export class Contracts extends APIResource {
 
   /**
    * Create a new contract
+   *
+   * @example
+   * ```ts
+   * const contract = await client.v1.contracts.create({
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   starting_at: '2020-01-01T00:00:00.000Z',
+   *   billing_provider_configuration: {
+   *     billing_provider: 'stripe',
+   *     delivery_method: 'direct_to_billing_provider',
+   *   },
+   *   rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   * });
+   * ```
    */
   create(body: ContractCreateParams, options?: Core.RequestOptions): Core.APIPromise<ContractCreateResponse> {
     return this._client.post('/v1/contracts/create', { body, ...options });
   }
 
   /**
-   * Get a specific contract
+   * This is the v1 endpoint to get a contract. New clients should implement using
+   * the v2 endpoint.
+   *
+   * @example
+   * ```ts
+   * const contract = await client.v1.contracts.retrieve({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   * });
+   * ```
    */
   retrieve(
     body: ContractRetrieveParams,
@@ -68,7 +92,15 @@ export class Contracts extends APIResource {
   }
 
   /**
-   * List all contracts for a customer
+   * This is the v1 endpoint to list all contracts for a customer. New clients should
+   * implement using the v2 endpoint.
+   *
+   * @example
+   * ```ts
+   * const contracts = await client.v1.contracts.list({
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   * });
+   * ```
    */
   list(body: ContractListParams, options?: Core.RequestOptions): Core.APIPromise<ContractListResponse> {
     return this._client.post('/v1/contracts/list', { body, ...options });
@@ -76,6 +108,18 @@ export class Contracts extends APIResource {
 
   /**
    * Add a manual balance entry
+   *
+   * @example
+   * ```ts
+   * await client.v1.contracts.addManualBalanceEntry({
+   *   id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+   *   amount: -1000,
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   reason: 'Reason for entry',
+   *   segment_id: '66368e29-3f97-4d15-a6e9-120897f0070a',
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   * });
+   * ```
    */
   addManualBalanceEntry(
     body: ContractAddManualBalanceEntryParams,
@@ -89,7 +133,20 @@ export class Contracts extends APIResource {
   }
 
   /**
-   * Amend a contract
+   * Amendments will be replaced by Contract editing. New clients should implement
+   * using the editContract endpoint. Read more about the migration to contract
+   * editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and
+   * reach out to your Metronome representative for more details. Once contract
+   * editing is enabled, access to this endpoint will be removed.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.contracts.amend({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   starting_at: '2020-01-01T00:00:00.000Z',
+   * });
+   * ```
    */
   amend(body: ContractAmendParams, options?: Core.RequestOptions): Core.APIPromise<ContractAmendResponse> {
     return this._client.post('/v1/contracts/amend', { body, ...options });
@@ -97,6 +154,15 @@ export class Contracts extends APIResource {
 
   /**
    * Archive a contract
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.contracts.archive({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   void_invoices: true,
+   * });
+   * ```
    */
   archive(
     body: ContractArchiveParams,
@@ -107,6 +173,35 @@ export class Contracts extends APIResource {
 
   /**
    * Creates historical usage invoices for a contract
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.createHistoricalInvoices({
+   *     invoices: [
+   *       {
+   *         customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *         contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *         credit_type_id:
+   *           '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *         inclusive_start_date: '2020-01-01T00:00:00.000Z',
+   *         exclusive_end_date: '2020-02-01T00:00:00.000Z',
+   *         issue_date: '2020-02-01T00:00:00.000Z',
+   *         usage_line_items: [
+   *           {
+   *             product_id:
+   *               'f14d6729-6a44-4b13-9908-9387f1918790',
+   *             inclusive_start_date:
+   *               '2020-01-01T00:00:00.000Z',
+   *             exclusive_end_date: '2020-02-01T00:00:00.000Z',
+   *             quantity: 100,
+   *           },
+   *         ],
+   *       },
+   *     ],
+   *     preview: false,
+   *   });
+   * ```
    */
   createHistoricalInvoices(
     body: ContractCreateHistoricalInvoicesParams,
@@ -117,6 +212,15 @@ export class Contracts extends APIResource {
 
   /**
    * List balances (commits and credits).
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.contracts.listBalances({
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+   *   include_ledgers: true,
+   * });
+   * ```
    */
   listBalances(
     body: ContractListBalancesParams,
@@ -127,6 +231,25 @@ export class Contracts extends APIResource {
 
   /**
    * Get the rate schedule for the rate card on a given contract.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.retrieveRateSchedule({
+   *     contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *     at: '2020-01-01T00:00:00.000Z',
+   *     selectors: [
+   *       {
+   *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+   *         partial_pricing_group_values: {
+   *           region: 'us-west-2',
+   *           cloud: 'aws',
+   *         },
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   retrieveRateSchedule(
     params: ContractRetrieveRateScheduleParams,
@@ -140,9 +263,49 @@ export class Contracts extends APIResource {
     });
   }
 
+  /**
+   * Fetch the quantity and price for a subscription over time. End-point does not
+   * return future scheduled changes.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.retrieveSubscriptionQuantityHistory(
+   *     {
+   *       contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *       customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *       subscription_id:
+   *         '1a824d53-bde6-4d82-96d7-6347ff227d5c',
+   *     },
+   *   );
+   * ```
+   */
+  retrieveSubscriptionQuantityHistory(
+    body: ContractRetrieveSubscriptionQuantityHistoryParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ContractRetrieveSubscriptionQuantityHistoryResponse> {
+    return this._client.post('/v1/contracts/getSubscriptionQuantityHistory', { body, ...options });
+  }
+
   /**
    * Create a new scheduled invoice for Professional Services terms on a contract.
    * This endpoint's availability is dependent on your client's configuration.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.scheduleProServicesInvoice({
+   *     contract_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     customer_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     issued_at: '2019-12-27T18:11:19.117Z',
+   *     line_items: [
+   *       {
+   *         professional_service_id:
+   *           '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   scheduleProServicesInvoice(
     body: ContractScheduleProServicesInvoiceParams,
@@ -153,6 +316,17 @@ export class Contracts extends APIResource {
 
   /**
    * Set usage filter for a contract
+   *
+   * @example
+   * ```ts
+   * await client.v1.contracts.setUsageFilter({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   group_key: 'business_subscription_id',
+   *   group_values: ['ID-1', 'ID-2'],
+   *   starting_at: '2020-01-01T00:00:00.000Z',
+   * });
+   * ```
    */
   setUsageFilter(body: ContractSetUsageFilterParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/contracts/setUsageFilter', {
@@ -164,6 +338,15 @@ export class Contracts extends APIResource {
 
   /**
    * Update the end date of a contract
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.contracts.updateEndDate({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   ending_before: '2020-01-01T00:00:00.000Z',
+   * });
+   * ```
    */
   updateEndDate(
     body: ContractUpdateEndDateParams,
@@ -199,13 +382,20 @@ export namespace ContractRetrieveResponse {
      */
     archived_at?: string;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * The billing provider configuration associated with a contract.
      */
     customer_billing_provider_configuration?: Data.CustomerBillingProviderConfiguration;
 
+    prepaid_balance_threshold_configuration?: Data.PrepaidBalanceThresholdConfiguration;
+
+    /**
+     * Priority of the contract.
+     */
+    priority?: number;
+
     /**
      * Determines which scheduled and commit charges to consolidate onto the Contract's
      * usage invoice. The charge's `timestamp` must match the usage invoice's
@@ -215,6 +405,11 @@ export namespace ContractRetrieveResponse {
      */
     scheduled_charges_on_usage_invoices?: 'ALL';
 
+    spend_threshold_configuration?: Data.SpendThresholdConfiguration;
+
+    /**
+     * List of subscriptions on the contract.
+     */
     subscriptions?: Array<Data.Subscription>;
 
     /**
@@ -317,7 +512,257 @@ export namespace ContractRetrieveResponse {
        * Configuration for the billing provider. The structure of this object is specific
        * to the billing provider.
        */
-      configuration?: Record<string, unknown>;
+      configuration?: { [key: string]: unknown };
+    }
+
+    export interface PrepaidBalanceThresholdConfiguration {
+      commit: PrepaidBalanceThresholdConfiguration.Commit;
+
+      /**
+       * When set to false, the contract will not be evaluated against the
+       * threshold_amount. Toggling to true will result an immediate evaluation,
+       * regardless of prior state.
+       */
+      is_enabled: boolean;
+
+      payment_gate_config: PrepaidBalanceThresholdConfiguration.PaymentGateConfig;
+
+      /**
+       * Specify the amount the balance should be recharged to.
+       */
+      recharge_to_amount: number;
+
+      /**
+       * Specify the threshold amount for the contract. Each time the contract's prepaid
+       * balance lowers to this amount, a threshold charge will be initiated.
+       */
+      threshold_amount: number;
+
+      /**
+       * If provided, the threshold, recharge-to amount, and the resulting threshold
+       * commit amount will be in terms of this credit type instead of the fiat currency.
+       */
+      custom_credit_type_id?: string;
+    }
+
+    export namespace PrepaidBalanceThresholdConfiguration {
+      export interface Commit {
+        /**
+         * The commit product that will be used to generate the line item for commit
+         * payment.
+         */
+        product_id: string;
+
+        /**
+         * Which products the threshold commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_ids?: Array<string>;
+
+        /**
+         * Which tags the threshold commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_tags?: Array<string>;
+
+        description?: string;
+
+        /**
+         * Specify the name of the line item for the threshold charge. If left blank, it
+         * will default to the commit product name.
+         */
+        name?: string;
+
+        /**
+         * 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`.
+         */
+        specifiers?: Array<Commit.Specifier>;
+      }
+
+      export namespace Commit {
+        export interface Specifier {
+          presentation_group_values?: { [key: string]: string };
+
+          pricing_group_values?: { [key: string]: string };
+
+          /**
+           * If provided, the specifier will only apply to the product with the specified ID.
+           */
+          product_id?: string;
+
+          /**
+           * If provided, the specifier will only apply to products with all the specified
+           * tags.
+           */
+          product_tags?: Array<string>;
+        }
+      }
+
+      export interface PaymentGateConfig {
+        /**
+         * Gate access to the commit balance based on successful collection of payment.
+         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+         * facilitate payment using your own payment integration. Select NONE if you do not
+         * wish to payment gate the commit balance.
+         */
+        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        stripe_config?: PaymentGateConfig.StripeConfig;
+
+        /**
+         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+         * will default to NONE.
+         */
+        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+      }
+
+      export namespace PaymentGateConfig {
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        export interface PrecalculatedTaxConfig {
+          /**
+           * Amount of tax to be applied. This should be in the same currency and
+           * denomination as the commit's invoice schedule
+           */
+          tax_amount: number;
+
+          /**
+           * Name of the tax to be applied. This may be used in an invoice line item
+           * description.
+           */
+          tax_name?: string;
+        }
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        export interface StripeConfig {
+          /**
+           * If left blank, will default to INVOICE
+           */
+          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+          /**
+           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+           * your payment type.
+           */
+          invoice_metadata?: { [key: string]: string };
+        }
+      }
+    }
+
+    export interface SpendThresholdConfiguration {
+      commit: SpendThresholdConfiguration.Commit;
+
+      /**
+       * When set to false, the contract will not be evaluated against the
+       * threshold_amount. Toggling to true will result an immediate evaluation,
+       * regardless of prior state.
+       */
+      is_enabled: boolean;
+
+      payment_gate_config: SpendThresholdConfiguration.PaymentGateConfig;
+
+      /**
+       * Specify the threshold amount for the contract. Each time the contract's usage
+       * hits this amount, a threshold charge will be initiated.
+       */
+      threshold_amount: number;
+    }
+
+    export namespace SpendThresholdConfiguration {
+      export interface Commit {
+        /**
+         * The commit product that will be used to generate the line item for commit
+         * payment.
+         */
+        product_id: string;
+
+        description?: string;
+
+        /**
+         * Specify the name of the line item for the threshold charge. If left blank, it
+         * will default to the commit product name.
+         */
+        name?: string;
+      }
+
+      export interface PaymentGateConfig {
+        /**
+         * Gate access to the commit balance based on successful collection of payment.
+         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+         * facilitate payment using your own payment integration. Select NONE if you do not
+         * wish to payment gate the commit balance.
+         */
+        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        stripe_config?: PaymentGateConfig.StripeConfig;
+
+        /**
+         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+         * will default to NONE.
+         */
+        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+      }
+
+      export namespace PaymentGateConfig {
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        export interface PrecalculatedTaxConfig {
+          /**
+           * Amount of tax to be applied. This should be in the same currency and
+           * denomination as the commit's invoice schedule
+           */
+          tax_amount: number;
+
+          /**
+           * Name of the tax to be applied. This may be used in an invoice line item
+           * description.
+           */
+          tax_name?: string;
+        }
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        export interface StripeConfig {
+          /**
+           * If left blank, will default to INVOICE
+           */
+          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+          /**
+           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+           * your payment type.
+           */
+          invoice_metadata?: { [key: string]: string };
+        }
+      }
     }
 
     export interface Subscription {
@@ -325,16 +770,26 @@ export namespace ContractRetrieveResponse {
 
       proration: Subscription.Proration;
 
+      /**
+       * 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?: { [key: string]: string };
+
       description?: string;
 
       ending_before?: string;
 
+      fiat_credit_type_id?: string;
+
       name?: string;
     }
 
@@ -354,7 +809,7 @@ export namespace ContractRetrieveResponse {
       }
 
       export interface SubscriptionRate {
-        billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+        billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
         product: SubscriptionRate.Product;
       }
@@ -392,13 +847,20 @@ export namespace ContractListResponse {
      */
     archived_at?: string;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * The billing provider configuration associated with a contract.
      */
     customer_billing_provider_configuration?: Data.CustomerBillingProviderConfiguration;
 
+    prepaid_balance_threshold_configuration?: Data.PrepaidBalanceThresholdConfiguration;
+
+    /**
+     * Priority of the contract.
+     */
+    priority?: number;
+
     /**
      * Determines which scheduled and commit charges to consolidate onto the Contract's
      * usage invoice. The charge's `timestamp` must match the usage invoice's
@@ -408,6 +870,11 @@ export namespace ContractListResponse {
      */
     scheduled_charges_on_usage_invoices?: 'ALL';
 
+    spend_threshold_configuration?: Data.SpendThresholdConfiguration;
+
+    /**
+     * List of subscriptions on the contract.
+     */
     subscriptions?: Array<Data.Subscription>;
 
     /**
@@ -510,7 +977,257 @@ export namespace ContractListResponse {
        * Configuration for the billing provider. The structure of this object is specific
        * to the billing provider.
        */
-      configuration?: Record<string, unknown>;
+      configuration?: { [key: string]: unknown };
+    }
+
+    export interface PrepaidBalanceThresholdConfiguration {
+      commit: PrepaidBalanceThresholdConfiguration.Commit;
+
+      /**
+       * When set to false, the contract will not be evaluated against the
+       * threshold_amount. Toggling to true will result an immediate evaluation,
+       * regardless of prior state.
+       */
+      is_enabled: boolean;
+
+      payment_gate_config: PrepaidBalanceThresholdConfiguration.PaymentGateConfig;
+
+      /**
+       * Specify the amount the balance should be recharged to.
+       */
+      recharge_to_amount: number;
+
+      /**
+       * Specify the threshold amount for the contract. Each time the contract's prepaid
+       * balance lowers to this amount, a threshold charge will be initiated.
+       */
+      threshold_amount: number;
+
+      /**
+       * If provided, the threshold, recharge-to amount, and the resulting threshold
+       * commit amount will be in terms of this credit type instead of the fiat currency.
+       */
+      custom_credit_type_id?: string;
+    }
+
+    export namespace PrepaidBalanceThresholdConfiguration {
+      export interface Commit {
+        /**
+         * The commit product that will be used to generate the line item for commit
+         * payment.
+         */
+        product_id: string;
+
+        /**
+         * Which products the threshold commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_ids?: Array<string>;
+
+        /**
+         * Which tags the threshold commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_tags?: Array<string>;
+
+        description?: string;
+
+        /**
+         * Specify the name of the line item for the threshold charge. If left blank, it
+         * will default to the commit product name.
+         */
+        name?: string;
+
+        /**
+         * 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`.
+         */
+        specifiers?: Array<Commit.Specifier>;
+      }
+
+      export namespace Commit {
+        export interface Specifier {
+          presentation_group_values?: { [key: string]: string };
+
+          pricing_group_values?: { [key: string]: string };
+
+          /**
+           * If provided, the specifier will only apply to the product with the specified ID.
+           */
+          product_id?: string;
+
+          /**
+           * If provided, the specifier will only apply to products with all the specified
+           * tags.
+           */
+          product_tags?: Array<string>;
+        }
+      }
+
+      export interface PaymentGateConfig {
+        /**
+         * Gate access to the commit balance based on successful collection of payment.
+         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+         * facilitate payment using your own payment integration. Select NONE if you do not
+         * wish to payment gate the commit balance.
+         */
+        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        stripe_config?: PaymentGateConfig.StripeConfig;
+
+        /**
+         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+         * will default to NONE.
+         */
+        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+      }
+
+      export namespace PaymentGateConfig {
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        export interface PrecalculatedTaxConfig {
+          /**
+           * Amount of tax to be applied. This should be in the same currency and
+           * denomination as the commit's invoice schedule
+           */
+          tax_amount: number;
+
+          /**
+           * Name of the tax to be applied. This may be used in an invoice line item
+           * description.
+           */
+          tax_name?: string;
+        }
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        export interface StripeConfig {
+          /**
+           * If left blank, will default to INVOICE
+           */
+          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+          /**
+           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+           * your payment type.
+           */
+          invoice_metadata?: { [key: string]: string };
+        }
+      }
+    }
+
+    export interface SpendThresholdConfiguration {
+      commit: SpendThresholdConfiguration.Commit;
+
+      /**
+       * When set to false, the contract will not be evaluated against the
+       * threshold_amount. Toggling to true will result an immediate evaluation,
+       * regardless of prior state.
+       */
+      is_enabled: boolean;
+
+      payment_gate_config: SpendThresholdConfiguration.PaymentGateConfig;
+
+      /**
+       * Specify the threshold amount for the contract. Each time the contract's usage
+       * hits this amount, a threshold charge will be initiated.
+       */
+      threshold_amount: number;
+    }
+
+    export namespace SpendThresholdConfiguration {
+      export interface Commit {
+        /**
+         * The commit product that will be used to generate the line item for commit
+         * payment.
+         */
+        product_id: string;
+
+        description?: string;
+
+        /**
+         * Specify the name of the line item for the threshold charge. If left blank, it
+         * will default to the commit product name.
+         */
+        name?: string;
+      }
+
+      export interface PaymentGateConfig {
+        /**
+         * Gate access to the commit balance based on successful collection of payment.
+         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+         * facilitate payment using your own payment integration. Select NONE if you do not
+         * wish to payment gate the commit balance.
+         */
+        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        stripe_config?: PaymentGateConfig.StripeConfig;
+
+        /**
+         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+         * will default to NONE.
+         */
+        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+      }
+
+      export namespace PaymentGateConfig {
+        /**
+         * Only applicable if using PRECALCULATED as your tax type.
+         */
+        export interface PrecalculatedTaxConfig {
+          /**
+           * Amount of tax to be applied. This should be in the same currency and
+           * denomination as the commit's invoice schedule
+           */
+          tax_amount: number;
+
+          /**
+           * Name of the tax to be applied. This may be used in an invoice line item
+           * description.
+           */
+          tax_name?: string;
+        }
+
+        /**
+         * Only applicable if using STRIPE as your payment gate type.
+         */
+        export interface StripeConfig {
+          /**
+           * If left blank, will default to INVOICE
+           */
+          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+          /**
+           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+           * your payment type.
+           */
+          invoice_metadata?: { [key: string]: string };
+        }
+      }
     }
 
     export interface Subscription {
@@ -518,16 +1235,26 @@ export namespace ContractListResponse {
 
       proration: Subscription.Proration;
 
+      /**
+       * 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?: { [key: string]: string };
+
       description?: string;
 
       ending_before?: string;
 
+      fiat_credit_type_id?: string;
+
       name?: string;
     }
 
@@ -547,7 +1274,7 @@ export namespace ContractListResponse {
       }
 
       export interface SubscriptionRate {
-        billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+        billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
         product: SubscriptionRate.Product;
       }
@@ -593,7 +1320,7 @@ export namespace ContractRetrieveRateScheduleResponse {
 
     list_rate: Shared.Rate;
 
-    product_custom_fields: Record<string, string>;
+    product_custom_fields: { [key: string]: string };
 
     product_id: string;
 
@@ -605,7 +1332,7 @@ export namespace ContractRetrieveRateScheduleResponse {
 
     starting_at: string;
 
-    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * A distinct rate on the rate card. You can choose to use this rate rather than
@@ -617,7 +1344,7 @@ export namespace ContractRetrieveRateScheduleResponse {
 
     override_rate?: Shared.Rate;
 
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
   }
 
   export namespace Data {
@@ -641,6 +1368,38 @@ export namespace ContractRetrieveRateScheduleResponse {
   }
 }
 
+export interface ContractRetrieveSubscriptionQuantityHistoryResponse {
+  data: ContractRetrieveSubscriptionQuantityHistoryResponse.Data;
+}
+
+export namespace ContractRetrieveSubscriptionQuantityHistoryResponse {
+  export interface Data {
+    fiat_credit_type_id?: string;
+
+    history?: Array<Data.History>;
+
+    subscription_id?: string;
+  }
+
+  export namespace Data {
+    export interface History {
+      data: Array<History.Data>;
+
+      starting_at: string;
+    }
+
+    export namespace History {
+      export interface Data {
+        quantity: number;
+
+        total: number;
+
+        unit_price: number;
+      }
+    }
+  }
+}
+
 export interface ContractScheduleProServicesInvoiceResponse {
   data: Array<InvoicesAPI.Invoice>;
 }
@@ -658,7 +1417,8 @@ export interface ContractCreateParams {
   starting_at: string;
 
   /**
-   * The billing provider configuration associated with a contract.
+   * The billing provider configuration associated with a contract. Provide either an
+   * ID or the provider and delivery method.
    */
   billing_provider_configuration?: ContractCreateParams.BillingProviderConfiguration;
 
@@ -666,7 +1426,7 @@ export interface ContractCreateParams {
 
   credits?: Array<ContractCreateParams.Credit>;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   /**
    * This field's availability is dependent on your client's configuration.
@@ -678,6 +1438,8 @@ export interface ContractCreateParams {
    */
   ending_before?: string;
 
+  hierarchy_configuration?: ContractCreateParams.HierarchyConfiguration;
+
   /**
    * Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
    * prices automatically. EXPLICIT prioritization requires specifying priorities for
@@ -697,6 +1459,13 @@ export interface ContractCreateParams {
 
   overrides?: Array<ContractCreateParams.Override>;
 
+  prepaid_balance_threshold_configuration?: ContractCreateParams.PrepaidBalanceThresholdConfiguration;
+
+  /**
+   * Priority of the contract.
+   */
+  priority?: number;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -735,9 +1504,14 @@ export interface ContractCreateParams {
    */
   scheduled_charges_on_usage_invoices?: 'ALL';
 
-  subscriptions?: Array<ContractCreateParams.Subscription>;
+  spend_threshold_configuration?: ContractCreateParams.SpendThresholdConfiguration;
 
-  threshold_billing_configuration?: ContractCreateParams.ThresholdBillingConfiguration;
+  /**
+   * Optional list of
+   * [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
+   * to add to the contract.
+   */
+  subscriptions?: Array<ContractCreateParams.Subscription>;
 
   /**
    * This field's availability is dependent on your client's configuration.
@@ -760,16 +1534,25 @@ export interface ContractCreateParams {
 
 export namespace ContractCreateParams {
   /**
-   * The billing provider configuration associated with a contract.
+   * The billing provider configuration associated with a contract. Provide either an
+   * ID or the provider and delivery method.
    */
   export interface BillingProviderConfiguration {
+    /**
+     * Do not specify if using billing_provider_configuration_id.
+     */
     billing_provider?: 'aws_marketplace' | 'azure_marketplace' | 'gcp_marketplace' | 'stripe' | 'netsuite';
 
     /**
-     * The Metronome ID of the billing provider configuration
+     * The Metronome ID of the billing provider configuration. Use when a customer has
+     * multiple configurations with the same billing provider and delivery method.
+     * Otherwise, specify the billing_provider and delivery_method.
      */
     billing_provider_configuration_id?: string;
 
+    /**
+     * Do not specify if using billing_provider_configuration_id.
+     */
     delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
   }
 
@@ -791,24 +1574,31 @@ export namespace ContractCreateParams {
     amount?: number;
 
     /**
-     * Which products the commit applies to. If both applicable_product_ids and
-     * applicable_product_tags are not provided, the commit applies to all products.
+     * Which products the commit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * all products.
      */
     applicable_product_ids?: Array<string>;
 
     /**
-     * Which tags the commit applies to. If both applicable_product_ids and
-     * applicable_product_tags are not provided, the commit applies to all products.
+     * Which tags the commit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * all products.
      */
     applicable_product_tags?: Array<string>;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * Used only in UI/API. It is not exposed to end customers.
      */
     description?: string;
 
+    /**
+     * Optional configuration for commit hierarchy access control
+     */
+    hierarchy_configuration?: Commit.HierarchyConfiguration;
+
     /**
      * Required for "POSTPAID" commits: the true up invoice will be generated at this
      * time and only one schedule item is allowed; the total must match access_schedule
@@ -827,6 +1617,11 @@ export namespace ContractCreateParams {
      */
     netsuite_sales_order_id?: string;
 
+    /**
+     * optionally payment gate this commit
+     */
+    payment_gate_config?: Commit.PaymentGateConfig;
+
     /**
      * If multiple commits are applicable, the one with the lower priority will apply
      * first.
@@ -840,6 +1635,14 @@ export namespace ContractCreateParams {
      */
     rollover_fraction?: number;
 
+    /**
+     * 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`.
+     */
+    specifiers?: Array<Commit.Specifier>;
+
     /**
      * A temporary ID for the commit that can be used to reference the commit for
      * commit specific overrides.
@@ -878,6 +1681,32 @@ export namespace ContractCreateParams {
       }
     }
 
+    /**
+     * Optional configuration for commit hierarchy access control
+     */
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
+
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
+    }
+
     /**
      * Required for "POSTPAID" commits: the true up invoice will be generated at this
      * time and only one schedule item is allowed; the total must match access_schedule
@@ -974,6 +1803,88 @@ export namespace ContractCreateParams {
         unit_price?: number;
       }
     }
+
+    /**
+     * optionally payment gate this commit
+     */
+    export interface PaymentGateConfig {
+      /**
+       * Gate access to the commit balance based on successful collection of payment.
+       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+       * facilitate payment using your own payment integration. Select NONE if you do not
+       * wish to payment gate the commit balance.
+       */
+      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      stripe_config?: PaymentGateConfig.StripeConfig;
+
+      /**
+       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+       * will default to NONE.
+       */
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    }
+
+    export namespace PaymentGateConfig {
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      export interface PrecalculatedTaxConfig {
+        /**
+         * Amount of tax to be applied. This should be in the same currency and
+         * denomination as the commit's invoice schedule
+         */
+        tax_amount: number;
+
+        /**
+         * Name of the tax to be applied. This may be used in an invoice line item
+         * description.
+         */
+        tax_name?: string;
+      }
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      export interface StripeConfig {
+        /**
+         * If left blank, will default to INVOICE
+         */
+        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+        /**
+         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+         * your payment type.
+         */
+        invoice_metadata?: { [key: string]: string };
+      }
+    }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
+    }
   }
 
   export interface Credit {
@@ -996,13 +1907,18 @@ export namespace ContractCreateParams {
      */
     applicable_product_tags?: Array<string>;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * Used only in UI/API. It is not exposed to end customers.
      */
     description?: string;
 
+    /**
+     * Optional configuration for credit hierarchy access control
+     */
+    hierarchy_configuration?: Credit.HierarchyConfiguration;
+
     /**
      * displayed on invoices
      */
@@ -1020,6 +1936,14 @@ export namespace ContractCreateParams {
     priority?: number;
 
     rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+
+    /**
+     * 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`.
+     */
+    specifiers?: Array<Credit.Specifier>;
   }
 
   export namespace Credit {
@@ -1050,6 +1974,49 @@ export namespace ContractCreateParams {
         starting_at: string;
       }
     }
+
+    /**
+     * Optional configuration for credit hierarchy access control
+     */
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
+
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
+    }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
+    }
   }
 
   export interface Discount {
@@ -1060,7 +2027,7 @@ export namespace ContractCreateParams {
      */
     schedule: Discount.Schedule;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * displayed on invoices
@@ -1169,6 +2136,18 @@ export namespace ContractCreateParams {
     }
   }
 
+  export interface HierarchyConfiguration {
+    parent: HierarchyConfiguration.Parent;
+  }
+
+  export namespace HierarchyConfiguration {
+    export interface Parent {
+      contract_id: string;
+
+      customer_id: string;
+    }
+  }
+
   export interface Override {
     /**
      * RFC 3339 timestamp indicating when the override will start applying (inclusive)
@@ -1246,7 +2225,7 @@ export namespace ContractCreateParams {
 
   export namespace Override {
     export interface OverrideSpecifier {
-      billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+      billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       /**
        * Can only be used for commit specific overrides. Must be used in conjunction with
@@ -1260,13 +2239,13 @@ export namespace ContractCreateParams {
        * A map of group names to values. The override will only apply to line items with
        * the specified presentation group values.
        */
-      presentation_group_values?: Record<string, string>;
+      presentation_group_values?: { [key: string]: string };
 
       /**
        * A map of pricing group names to values. The override will only apply to products
        * with the specified pricing group values.
        */
-      pricing_group_values?: Record<string, string>;
+      pricing_group_values?: { [key: string]: string };
 
       /**
        * If provided, the override will only apply to the product with the specified ID.
@@ -1308,7 +2287,7 @@ export namespace ContractCreateParams {
        * Only set for CUSTOM rate_type. This field is interpreted by custom rate
        * processors.
        */
-      custom_rate?: Record<string, unknown>;
+      custom_rate?: { [key: string]: unknown };
 
       /**
        * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
@@ -1340,6 +2319,157 @@ export namespace ContractCreateParams {
     }
   }
 
+  export interface PrepaidBalanceThresholdConfiguration {
+    commit: PrepaidBalanceThresholdConfiguration.Commit;
+
+    /**
+     * When set to false, the contract will not be evaluated against the
+     * threshold_amount. Toggling to true will result an immediate evaluation,
+     * regardless of prior state.
+     */
+    is_enabled: boolean;
+
+    payment_gate_config: PrepaidBalanceThresholdConfiguration.PaymentGateConfig;
+
+    /**
+     * Specify the amount the balance should be recharged to.
+     */
+    recharge_to_amount: number;
+
+    /**
+     * Specify the threshold amount for the contract. Each time the contract's prepaid
+     * balance lowers to this amount, a threshold charge will be initiated.
+     */
+    threshold_amount: number;
+
+    /**
+     * If provided, the threshold, recharge-to amount, and the resulting threshold
+     * commit amount will be in terms of this credit type instead of the fiat currency.
+     */
+    custom_credit_type_id?: string;
+  }
+
+  export namespace PrepaidBalanceThresholdConfiguration {
+    export interface Commit {
+      /**
+       * The commit product that will be used to generate the line item for commit
+       * payment.
+       */
+      product_id: string;
+
+      /**
+       * Which products the threshold commit applies to. If applicable_product_ids,
+       * applicable_product_tags or specifiers are not provided, the commit applies to
+       * all products.
+       */
+      applicable_product_ids?: Array<string>;
+
+      /**
+       * Which tags the threshold commit applies to. If applicable_product_ids,
+       * applicable_product_tags or specifiers are not provided, the commit applies to
+       * all products.
+       */
+      applicable_product_tags?: Array<string>;
+
+      description?: string;
+
+      /**
+       * Specify the name of the line item for the threshold charge. If left blank, it
+       * will default to the commit product name.
+       */
+      name?: string;
+
+      /**
+       * 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`.
+       */
+      specifiers?: Array<Commit.Specifier>;
+    }
+
+    export namespace Commit {
+      export interface Specifier {
+        presentation_group_values?: { [key: string]: string };
+
+        pricing_group_values?: { [key: string]: string };
+
+        /**
+         * If provided, the specifier will only apply to the product with the specified ID.
+         */
+        product_id?: string;
+
+        /**
+         * If provided, the specifier will only apply to products with all the specified
+         * tags.
+         */
+        product_tags?: Array<string>;
+      }
+    }
+
+    export interface PaymentGateConfig {
+      /**
+       * Gate access to the commit balance based on successful collection of payment.
+       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+       * facilitate payment using your own payment integration. Select NONE if you do not
+       * wish to payment gate the commit balance.
+       */
+      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      stripe_config?: PaymentGateConfig.StripeConfig;
+
+      /**
+       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+       * will default to NONE.
+       */
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    }
+
+    export namespace PaymentGateConfig {
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      export interface PrecalculatedTaxConfig {
+        /**
+         * Amount of tax to be applied. This should be in the same currency and
+         * denomination as the commit's invoice schedule
+         */
+        tax_amount: number;
+
+        /**
+         * Name of the tax to be applied. This may be used in an invoice line item
+         * description.
+         */
+        tax_name?: string;
+      }
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      export interface StripeConfig {
+        /**
+         * If left blank, will default to INVOICE
+         */
+        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+        /**
+         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+         * your payment type.
+         */
+        invoice_metadata?: { [key: string]: string };
+      }
+    }
+  }
+
   export interface ProfessionalService {
     /**
      * Maximum amount for the term.
@@ -1360,7 +2490,7 @@ export namespace ContractCreateParams {
      */
     unit_price: number;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     description?: string;
 
@@ -1377,7 +2507,9 @@ export namespace ContractCreateParams {
     access_amount: RecurringCommit.AccessAmount;
 
     /**
-     * The amount of time the created commits will be valid for.
+     * Defines the length of the access schedule for each created commit/credit. The
+     * value represents the number of units. Unit defaults to "PERIODS", where the
+     * length of a period is determined by the recurrence_frequency.
      */
     commit_duration: RecurringCommit.CommitDuration;
 
@@ -1413,6 +2545,11 @@ export namespace ContractCreateParams {
      */
     ending_before?: string;
 
+    /**
+     * Optional configuration for recurring commit/credit hierarchy access control
+     */
+    hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
+
     /**
      * The amount the customer should be billed for the commit. Not required.
      */
@@ -1443,10 +2580,10 @@ export namespace ContractCreateParams {
      * 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
      * period defined in the duration will correspond to this frequency. - Commits will
-     * be created aligned with the recurring commit's start_date rather than the usage
+     * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -1455,6 +2592,19 @@ export namespace ContractCreateParams {
      */
     rollover_fraction?: number;
 
+    /**
+     * 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`.
+     */
+    specifiers?: Array<RecurringCommit.Specifier>;
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    subscription_config?: RecurringCommit.SubscriptionConfig;
+
     /**
      * A temporary ID that can be used to reference the recurring commit for commit
      * specific overrides.
@@ -1469,18 +2619,50 @@ export namespace ContractCreateParams {
     export interface AccessAmount {
       credit_type_id: string;
 
-      quantity: number;
-
       unit_price: number;
+
+      /**
+       * This field is currently required. Upcoming recurring commit/credit configuration
+       * options will allow it to be optional.
+       */
+      quantity?: number;
     }
 
     /**
-     * The amount of time the created commits will be valid for.
+     * Defines the length of the access schedule for each created commit/credit. The
+     * value represents the number of units. Unit defaults to "PERIODS", where the
+     * length of a period is determined by the recurrence_frequency.
      */
     export interface CommitDuration {
-      unit: 'PERIODS';
-
       value: number;
+
+      unit?: 'PERIODS';
+    }
+
+    /**
+     * Optional configuration for recurring commit/credit hierarchy access control
+     */
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
+
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
     }
 
     /**
@@ -1493,6 +2675,49 @@ export namespace ContractCreateParams {
 
       unit_price: number;
     }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
+    }
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    export interface SubscriptionConfig {
+      apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+      /**
+       * ID of the subscription to configure on the recurring commit/credit.
+       */
+      subscription_id: string;
+
+      /**
+       * If set to POOLED, allocation added per seat is pooled across the account.
+       */
+      allocation?: 'POOLED';
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
+    }
   }
 
   export interface RecurringCredit {
@@ -1502,7 +2727,9 @@ export namespace ContractCreateParams {
     access_amount: RecurringCredit.AccessAmount;
 
     /**
-     * The amount of time the created commits will be valid for.
+     * Defines the length of the access schedule for each created commit/credit. The
+     * value represents the number of units. Unit defaults to "PERIODS", where the
+     * length of a period is determined by the recurrence_frequency.
      */
     commit_duration: RecurringCredit.CommitDuration;
 
@@ -1538,6 +2765,11 @@ export namespace ContractCreateParams {
      */
     ending_before?: string;
 
+    /**
+     * Optional configuration for recurring commit/credit hierarchy access control
+     */
+    hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
+
     /**
      * displayed on invoices. will be passed through to the individual commits
      */
@@ -1563,10 +2795,10 @@ export namespace ContractCreateParams {
      * 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
      * period defined in the duration will correspond to this frequency. - Commits will
-     * be created aligned with the recurring commit's start_date rather than the usage
+     * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -1576,31 +2808,119 @@ export namespace ContractCreateParams {
     rollover_fraction?: number;
 
     /**
-     * A temporary ID that can be used to reference the recurring commit for commit
-     * specific overrides.
+     * 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`.
+     */
+    specifiers?: Array<RecurringCredit.Specifier>;
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    subscription_config?: RecurringCredit.SubscriptionConfig;
+
+    /**
+     * A temporary ID that can be used to reference the recurring commit for commit
+     * specific overrides.
+     */
+    temporary_id?: string;
+  }
+
+  export namespace RecurringCredit {
+    /**
+     * The amount of commit to grant.
+     */
+    export interface AccessAmount {
+      credit_type_id: string;
+
+      unit_price: number;
+
+      /**
+       * This field is currently required. Upcoming recurring commit/credit configuration
+       * options will allow it to be optional.
+       */
+      quantity?: number;
+    }
+
+    /**
+     * Defines the length of the access schedule for each created commit/credit. The
+     * value represents the number of units. Unit defaults to "PERIODS", where the
+     * length of a period is determined by the recurrence_frequency.
      */
-    temporary_id?: string;
-  }
+    export interface CommitDuration {
+      value: number;
+
+      unit?: 'PERIODS';
+    }
 
-  export namespace RecurringCredit {
     /**
-     * The amount of commit to grant.
+     * Optional configuration for recurring commit/credit hierarchy access control
      */
-    export interface AccessAmount {
-      credit_type_id: string;
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
 
-      quantity: number;
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
 
-      unit_price: number;
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
+    }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
     }
 
     /**
-     * The amount of time the created commits will be valid for.
+     * Attach a subscription to the recurring commit/credit.
      */
-    export interface CommitDuration {
-      unit: 'PERIODS';
+    export interface SubscriptionConfig {
+      apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
 
-      value: number;
+      /**
+       * ID of the subscription to configure on the recurring commit/credit.
+       */
+      subscription_id: string;
+
+      /**
+       * If set to POOLED, allocation added per seat is pooled across the account.
+       */
+      allocation?: 'POOLED';
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
     }
   }
 
@@ -1763,15 +3083,119 @@ export namespace ContractCreateParams {
     }
   }
 
+  export interface SpendThresholdConfiguration {
+    commit: SpendThresholdConfiguration.Commit;
+
+    /**
+     * When set to false, the contract will not be evaluated against the
+     * threshold_amount. Toggling to true will result an immediate evaluation,
+     * regardless of prior state.
+     */
+    is_enabled: boolean;
+
+    payment_gate_config: SpendThresholdConfiguration.PaymentGateConfig;
+
+    /**
+     * Specify the threshold amount for the contract. Each time the contract's usage
+     * hits this amount, a threshold charge will be initiated.
+     */
+    threshold_amount: number;
+  }
+
+  export namespace SpendThresholdConfiguration {
+    export interface Commit {
+      /**
+       * The commit product that will be used to generate the line item for commit
+       * payment.
+       */
+      product_id: string;
+
+      description?: string;
+
+      /**
+       * Specify the name of the line item for the threshold charge. If left blank, it
+       * will default to the commit product name.
+       */
+      name?: string;
+    }
+
+    export interface PaymentGateConfig {
+      /**
+       * Gate access to the commit balance based on successful collection of payment.
+       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+       * facilitate payment using your own payment integration. Select NONE if you do not
+       * wish to payment gate the commit balance.
+       */
+      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      stripe_config?: PaymentGateConfig.StripeConfig;
+
+      /**
+       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+       * will default to NONE.
+       */
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    }
+
+    export namespace PaymentGateConfig {
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      export interface PrecalculatedTaxConfig {
+        /**
+         * Amount of tax to be applied. This should be in the same currency and
+         * denomination as the commit's invoice schedule
+         */
+        tax_amount: number;
+
+        /**
+         * Name of the tax to be applied. This may be used in an invoice line item
+         * description.
+         */
+        tax_name?: string;
+      }
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      export interface StripeConfig {
+        /**
+         * If left blank, will default to INVOICE
+         */
+        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+        /**
+         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+         * your payment type.
+         */
+        invoice_metadata?: { [key: string]: string };
+      }
+    }
+  }
+
   export interface Subscription {
     collection_schedule: 'ADVANCE' | 'ARREARS';
 
+    /**
+     * The initial quantity for the subscription. It must be non-negative value.
+     */
     initial_quantity: number;
 
     proration: Subscription.Proration;
 
     subscription_rate: Subscription.SubscriptionRate;
 
+    custom_fields?: { [key: string]: string };
+
     description?: string;
 
     /**
@@ -1787,15 +3211,22 @@ export namespace ContractCreateParams {
      * start date
      */
     starting_at?: string;
+
+    /**
+     * A temporary ID used to reference the subscription in recurring commit/credit
+     * subscription configs created within the same payload.
+     */
+    temporary_id?: string;
   }
 
   export namespace Subscription {
     export interface Proration {
       /**
-       * Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-       * is selected, the quantity increase will be billed on the scheduled date. If
-       * BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-       * for in-arrears at the end of the period.
+       * Indicates how mid-period quantity adjustments are invoiced.
+       * **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+       * quantity increase will be billed immediately on the scheduled date.
+       * **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+       * in-arrears at the end of the period.
        */
       invoice_behavior?: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
 
@@ -1810,7 +3241,7 @@ export namespace ContractCreateParams {
        * Frequency to bill subscription with. Together with product_id, must match
        * existing rate on the rate card.
        */
-      billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+      billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       /**
        * Must be subscription type product
@@ -1819,50 +3250,6 @@ export namespace ContractCreateParams {
     }
   }
 
-  export interface ThresholdBillingConfiguration {
-    commit: ThresholdBillingConfiguration.Commit;
-
-    /**
-     * When set to false, the contract will not be evaluated against the
-     * threshold_amount. Toggling to true will result an immediate evaluation,
-     * regardless of prior state
-     */
-    is_enabled: boolean;
-
-    /**
-     * Specify the threshold amount for the contract. Each time the contract's usage
-     * hits this amount, a threshold charge will be initiated.
-     */
-    threshold_amount: number;
-  }
-
-  export namespace ThresholdBillingConfiguration {
-    export interface Commit {
-      product_id: string;
-
-      /**
-       * Which products the threshold commit applies to. If both applicable_product_ids
-       * and applicable_product_tags are not provided, the commit applies to all
-       * products.
-       */
-      applicable_product_ids?: Array<string>;
-
-      /**
-       * Which tags the threshold commit applies to. If both applicable_product_ids and
-       * applicable_product_tags are not provided, the commit applies to all products.
-       */
-      applicable_product_tags?: Array<string>;
-
-      description?: string;
-
-      /**
-       * Specify the name of the line item for the threshold charge. If left blank, it
-       * will default to the commit product name.
-       */
-      name?: string;
-    }
-  }
-
   export interface Transition {
     from_contract_id: string;
 
@@ -1885,7 +3272,7 @@ export namespace ContractCreateParams {
   }
 
   export interface UsageStatementSchedule {
-    frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * Required when using CUSTOM_DATE. This option lets you set a historical billing
@@ -2022,7 +3409,7 @@ export interface ContractAmendParams {
 
   credits?: Array<ContractAmendParams.Credit>;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   /**
    * This field's availability is dependent on your client's configuration.
@@ -2078,24 +3465,31 @@ export namespace ContractAmendParams {
     amount?: number;
 
     /**
-     * Which products the commit applies to. If both applicable_product_ids and
-     * applicable_product_tags are not provided, the commit applies to all products.
+     * Which products the commit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * all products.
      */
     applicable_product_ids?: Array<string>;
 
     /**
-     * Which tags the commit applies to. If both applicable_product_ids and
-     * applicable_product_tags are not provided, the commit applies to all products.
+     * Which tags the commit applies to. If applicable_product_ids,
+     * applicable_product_tags or specifiers are not provided, the commit applies to
+     * all products.
      */
     applicable_product_tags?: Array<string>;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * Used only in UI/API. It is not exposed to end customers.
      */
     description?: string;
 
+    /**
+     * Optional configuration for commit hierarchy access control
+     */
+    hierarchy_configuration?: Commit.HierarchyConfiguration;
+
     /**
      * Required for "POSTPAID" commits: the true up invoice will be generated at this
      * time and only one schedule item is allowed; the total must match access_schedule
@@ -2114,6 +3508,11 @@ export namespace ContractAmendParams {
      */
     netsuite_sales_order_id?: string;
 
+    /**
+     * optionally payment gate this commit
+     */
+    payment_gate_config?: Commit.PaymentGateConfig;
+
     /**
      * If multiple commits are applicable, the one with the lower priority will apply
      * first.
@@ -2127,6 +3526,14 @@ export namespace ContractAmendParams {
      */
     rollover_fraction?: number;
 
+    /**
+     * 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`.
+     */
+    specifiers?: Array<Commit.Specifier>;
+
     /**
      * A temporary ID for the commit that can be used to reference the commit for
      * commit specific overrides.
@@ -2165,6 +3572,32 @@ export namespace ContractAmendParams {
       }
     }
 
+    /**
+     * Optional configuration for commit hierarchy access control
+     */
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
+
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
+    }
+
     /**
      * Required for "POSTPAID" commits: the true up invoice will be generated at this
      * time and only one schedule item is allowed; the total must match access_schedule
@@ -2261,6 +3694,88 @@ export namespace ContractAmendParams {
         unit_price?: number;
       }
     }
+
+    /**
+     * optionally payment gate this commit
+     */
+    export interface PaymentGateConfig {
+      /**
+       * Gate access to the commit balance based on successful collection of payment.
+       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+       * facilitate payment using your own payment integration. Select NONE if you do not
+       * wish to payment gate the commit balance.
+       */
+      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      stripe_config?: PaymentGateConfig.StripeConfig;
+
+      /**
+       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+       * will default to NONE.
+       */
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    }
+
+    export namespace PaymentGateConfig {
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      export interface PrecalculatedTaxConfig {
+        /**
+         * Amount of tax to be applied. This should be in the same currency and
+         * denomination as the commit's invoice schedule
+         */
+        tax_amount: number;
+
+        /**
+         * Name of the tax to be applied. This may be used in an invoice line item
+         * description.
+         */
+        tax_name?: string;
+      }
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      export interface StripeConfig {
+        /**
+         * If left blank, will default to INVOICE
+         */
+        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+        /**
+         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+         * your payment type.
+         */
+        invoice_metadata?: { [key: string]: string };
+      }
+    }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
+    }
   }
 
   export interface Credit {
@@ -2283,13 +3798,18 @@ export namespace ContractAmendParams {
      */
     applicable_product_tags?: Array<string>;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * Used only in UI/API. It is not exposed to end customers.
      */
     description?: string;
 
+    /**
+     * Optional configuration for credit hierarchy access control
+     */
+    hierarchy_configuration?: Credit.HierarchyConfiguration;
+
     /**
      * displayed on invoices
      */
@@ -2307,6 +3827,14 @@ export namespace ContractAmendParams {
     priority?: number;
 
     rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+
+    /**
+     * 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`.
+     */
+    specifiers?: Array<Credit.Specifier>;
   }
 
   export namespace Credit {
@@ -2337,6 +3865,49 @@ export namespace ContractAmendParams {
         starting_at: string;
       }
     }
+
+    /**
+     * Optional configuration for credit hierarchy access control
+     */
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
+
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
+    }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
+    }
   }
 
   export interface Discount {
@@ -2347,7 +3918,7 @@ export namespace ContractAmendParams {
      */
     schedule: Discount.Schedule;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * displayed on invoices
@@ -2533,7 +4104,7 @@ export namespace ContractAmendParams {
 
   export namespace Override {
     export interface OverrideSpecifier {
-      billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+      billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       /**
        * Can only be used for commit specific overrides. Must be used in conjunction with
@@ -2547,13 +4118,13 @@ export namespace ContractAmendParams {
        * A map of group names to values. The override will only apply to line items with
        * the specified presentation group values.
        */
-      presentation_group_values?: Record<string, string>;
+      presentation_group_values?: { [key: string]: string };
 
       /**
        * A map of pricing group names to values. The override will only apply to products
        * with the specified pricing group values.
        */
-      pricing_group_values?: Record<string, string>;
+      pricing_group_values?: { [key: string]: string };
 
       /**
        * If provided, the override will only apply to the product with the specified ID.
@@ -2595,7 +4166,7 @@ export namespace ContractAmendParams {
        * Only set for CUSTOM rate_type. This field is interpreted by custom rate
        * processors.
        */
-      custom_rate?: Record<string, unknown>;
+      custom_rate?: { [key: string]: unknown };
 
       /**
        * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
@@ -2647,7 +4218,7 @@ export namespace ContractAmendParams {
      */
     unit_price: number;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     description?: string;
 
@@ -2867,7 +4438,7 @@ export namespace ContractCreateHistoricalInvoicesParams {
 
     breakdown_granularity?: 'HOUR' | 'DAY';
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
   }
 
   export namespace Invoice {
@@ -2878,9 +4449,9 @@ export namespace ContractCreateHistoricalInvoicesParams {
 
       product_id: string;
 
-      presentation_group_values?: Record<string, string>;
+      presentation_group_values?: { [key: string]: string };
 
-      pricing_group_values?: Record<string, string>;
+      pricing_group_values?: { [key: string]: string };
 
       quantity?: number;
 
@@ -2915,7 +4486,7 @@ export interface ContractListBalancesParams {
   effective_before?: string;
 
   /**
-   * Include credits from archived contracts.
+   * Include archived credits and credits from archived contracts.
    */
   include_archived?: boolean;
 
@@ -2936,6 +4507,11 @@ export interface ContractListBalancesParams {
    */
   include_ledgers?: boolean;
 
+  /**
+   * The maximum number of commits to return. Defaults to 25.
+   */
+  limit?: number;
+
   /**
    * The next page token from a previous response.
    */
@@ -2988,19 +4564,19 @@ export namespace ContractRetrieveRateScheduleParams {
      * Subscription rates matching the billing frequency will be included in the
      * response.
      */
-    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * List of pricing group key value pairs, rates containing the matching key / value
      * pairs will be included in the response.
      */
-    partial_pricing_group_values?: Record<string, string>;
+    partial_pricing_group_values?: { [key: string]: string };
 
     /**
      * List of pricing group key value pairs, rates matching all of the key / value
      * pairs will be included in the response.
      */
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
 
     /**
      * Rates matching the product id will be included in the response.
@@ -3015,6 +4591,14 @@ export namespace ContractRetrieveRateScheduleParams {
   }
 }
 
+export interface ContractRetrieveSubscriptionQuantityHistoryParams {
+  contract_id: string;
+
+  customer_id: string;
+
+  subscription_id: string;
+}
+
 export interface ContractScheduleProServicesInvoiceParams {
   contract_id: string;
 
@@ -3141,6 +4725,7 @@ export declare namespace Contracts {
     type ContractCreateHistoricalInvoicesResponse as ContractCreateHistoricalInvoicesResponse,
     type ContractListBalancesResponse as ContractListBalancesResponse,
     type ContractRetrieveRateScheduleResponse as ContractRetrieveRateScheduleResponse,
+    type ContractRetrieveSubscriptionQuantityHistoryResponse as ContractRetrieveSubscriptionQuantityHistoryResponse,
     type ContractScheduleProServicesInvoiceResponse as ContractScheduleProServicesInvoiceResponse,
     type ContractUpdateEndDateResponse as ContractUpdateEndDateResponse,
     type ContractCreateParams as ContractCreateParams,
@@ -3152,6 +4737,7 @@ export declare namespace Contracts {
     type ContractCreateHistoricalInvoicesParams as ContractCreateHistoricalInvoicesParams,
     type ContractListBalancesParams as ContractListBalancesParams,
     type ContractRetrieveRateScheduleParams as ContractRetrieveRateScheduleParams,
+    type ContractRetrieveSubscriptionQuantityHistoryParams as ContractRetrieveSubscriptionQuantityHistoryParams,
     type ContractScheduleProServicesInvoiceParams as ContractScheduleProServicesInvoiceParams,
     type ContractSetUsageFilterParams as ContractSetUsageFilterParams,
     type ContractUpdateEndDateParams as ContractUpdateEndDateParams,
@@ -3181,12 +4767,14 @@ export declare namespace Contracts {
     type RateCardRetrieveResponse as RateCardRetrieveResponse,
     type RateCardUpdateResponse as RateCardUpdateResponse,
     type RateCardListResponse as RateCardListResponse,
+    type RateCardArchiveResponse as RateCardArchiveResponse,
     type RateCardRetrieveRateScheduleResponse as RateCardRetrieveRateScheduleResponse,
     RateCardListResponsesCursorPage as RateCardListResponsesCursorPage,
     type RateCardCreateParams as RateCardCreateParams,
     type RateCardRetrieveParams as RateCardRetrieveParams,
     type RateCardUpdateParams as RateCardUpdateParams,
     type RateCardListParams as RateCardListParams,
+    type RateCardArchiveParams as RateCardArchiveParams,
     type RateCardRetrieveRateScheduleParams as RateCardRetrieveRateScheduleParams,
   };