@metronome/sdk 0.1.0-beta.9 → 0.2.0

package/resources/v1/contracts/contracts.d.ts

@@ -7,58 +7,233 @@ import * as ProductsAPI from "./products.js";
 import { ProductArchiveParams, ProductArchiveResponse, ProductCreateParams, ProductCreateResponse, ProductListItemState, ProductListParams, ProductListResponse, ProductListResponsesCursorPage, ProductRetrieveParams, ProductRetrieveResponse, ProductUpdateParams, ProductUpdateResponse, Products, QuantityConversion, QuantityRounding } from "./products.js";
 import * as InvoicesAPI from "../customers/invoices.js";
 import * as RateCardsAPI from "./rate-cards/rate-cards.js";
-import { RateCardCreateParams, RateCardCreateResponse, RateCardListParams, RateCardListResponse, RateCardListResponsesCursorPage, RateCardRetrieveParams, RateCardRetrieveRateScheduleParams, RateCardRetrieveRateScheduleResponse, RateCardRetrieveResponse, RateCardUpdateParams, RateCardUpdateResponse, RateCards } from "./rate-cards/rate-cards.js";
+import { RateCardArchiveParams, RateCardArchiveResponse, RateCardCreateParams, RateCardCreateResponse, RateCardListParams, RateCardListResponse, RateCardListResponsesCursorPage, RateCardRetrieveParams, RateCardRetrieveRateScheduleParams, RateCardRetrieveRateScheduleResponse, RateCardRetrieveResponse, RateCardUpdateParams, RateCardUpdateResponse, RateCards } from "./rate-cards/rate-cards.js";
 export declare class Contracts extends APIResource {
     products: ProductsAPI.Products;
     rateCards: RateCardsAPI.RateCards;
     namedSchedules: NamedSchedulesAPI.NamedSchedules;
     /**
      * 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>;
     /**
-     * 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, options?: Core.RequestOptions): Core.APIPromise<ContractRetrieveResponse>;
     /**
-     * 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>;
     /**
      * 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, options?: Core.RequestOptions): Core.APIPromise<void>;
     /**
-     * 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>;
     /**
      * 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, options?: Core.RequestOptions): Core.APIPromise<ContractArchiveResponse>;
     /**
      * 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, options?: Core.RequestOptions): Core.APIPromise<ContractCreateHistoricalInvoicesResponse>;
     /**
      * 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, options?: Core.RequestOptions): Core.APIPromise<ContractListBalancesResponse>;
     /**
      * 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, options?: Core.RequestOptions): Core.APIPromise<ContractRetrieveRateScheduleResponse>;
+    /**
+     * 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>;
     /**
      * 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, options?: Core.RequestOptions): Core.APIPromise<ContractScheduleProServicesInvoiceResponse>;
     /**
      * 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>;
     /**
      * 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, options?: Core.RequestOptions): Core.APIPromise<ContractUpdateEndDateResponse>;
 }
@@ -80,11 +255,18 @@ export declare namespace ContractRetrieveResponse {
          * the contract is not archived.
          */
         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
@@ -93,6 +275,10 @@ export declare namespace ContractRetrieveResponse {
          * on a separate invoice from usage charges.
          */
         scheduled_charges_on_usage_invoices?: 'ALL';
+        spend_threshold_configuration?: Data.SpendThresholdConfiguration;
+        /**
+         * List of subscriptions on the contract.
+         */
         subscriptions?: Array<Data.Subscription>;
         /**
          * Prevents the creation of duplicates. If a request to create a record is made
@@ -158,16 +344,246 @@ export declare 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;
+            };
+        }
+        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;
+        }
+        namespace PrepaidBalanceThresholdConfiguration {
+            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>;
+            }
+            namespace Commit {
+                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>;
+                }
+            }
+            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';
+            }
+            namespace PaymentGateConfig {
+                /**
+                 * Only applicable if using PRECALCULATED as your tax type.
+                 */
+                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.
+                 */
+                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;
+                    };
+                }
+            }
+        }
+        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;
+        }
+        namespace SpendThresholdConfiguration {
+            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;
+            }
+            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';
+            }
+            namespace PaymentGateConfig {
+                /**
+                 * Only applicable if using PRECALCULATED as your tax type.
+                 */
+                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.
+                 */
+                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;
+                    };
+                }
+            }
         }
         interface Subscription {
             collection_schedule: 'ADVANCE' | 'ARREARS';
             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;
         }
         namespace Subscription {
@@ -181,7 +597,7 @@ export declare namespace ContractRetrieveResponse {
                 ending_before?: string;
             }
             interface SubscriptionRate {
-                billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+                billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
                 product: SubscriptionRate.Product;
             }
             namespace SubscriptionRate {
@@ -208,11 +624,18 @@ export declare namespace ContractListResponse {
          * the contract is not archived.
          */
         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
@@ -221,6 +644,10 @@ export declare namespace ContractListResponse {
          * on a separate invoice from usage charges.
          */
         scheduled_charges_on_usage_invoices?: 'ALL';
+        spend_threshold_configuration?: Data.SpendThresholdConfiguration;
+        /**
+         * List of subscriptions on the contract.
+         */
         subscriptions?: Array<Data.Subscription>;
         /**
          * Prevents the creation of duplicates. If a request to create a record is made
@@ -286,16 +713,246 @@ export declare 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;
+            };
+        }
+        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;
+        }
+        namespace PrepaidBalanceThresholdConfiguration {
+            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>;
+            }
+            namespace Commit {
+                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>;
+                }
+            }
+            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';
+            }
+            namespace PaymentGateConfig {
+                /**
+                 * Only applicable if using PRECALCULATED as your tax type.
+                 */
+                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.
+                 */
+                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;
+                    };
+                }
+            }
+        }
+        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;
+        }
+        namespace SpendThresholdConfiguration {
+            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;
+            }
+            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';
+            }
+            namespace PaymentGateConfig {
+                /**
+                 * Only applicable if using PRECALCULATED as your tax type.
+                 */
+                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.
+                 */
+                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;
+                    };
+                }
+            }
         }
         interface Subscription {
             collection_schedule: 'ADVANCE' | 'ARREARS';
             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;
         }
         namespace Subscription {
@@ -309,7 +966,7 @@ export declare namespace ContractListResponse {
                 ending_before?: string;
             }
             interface SubscriptionRate {
-                billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+                billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
                 product: SubscriptionRate.Product;
             }
             namespace SubscriptionRate {
@@ -342,13 +999,15 @@ export declare namespace ContractRetrieveRateScheduleResponse {
     interface Data {
         entitled: boolean;
         list_rate: Shared.Rate;
-        product_custom_fields: Record<string, string>;
+        product_custom_fields: {
+            [key: string]: string;
+        };
         product_id: string;
         product_name: string;
         product_tags: Array<string>;
         rate_card_id: string;
         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
          * list rate when consuming a credit or commit.
@@ -356,7 +1015,9 @@ export declare namespace ContractRetrieveRateScheduleResponse {
         commit_rate?: Data.CommitRate;
         ending_before?: string;
         override_rate?: Shared.Rate;
-        pricing_group_values?: Record<string, string>;
+        pricing_group_values?: {
+            [key: string]: string;
+        };
     }
     namespace Data {
         /**
@@ -376,6 +1037,29 @@ export declare namespace ContractRetrieveRateScheduleResponse {
         }
     }
 }
+export interface ContractRetrieveSubscriptionQuantityHistoryResponse {
+    data: ContractRetrieveSubscriptionQuantityHistoryResponse.Data;
+}
+export declare namespace ContractRetrieveSubscriptionQuantityHistoryResponse {
+    interface Data {
+        fiat_credit_type_id?: string;
+        history?: Array<Data.History>;
+        subscription_id?: string;
+    }
+    namespace Data {
+        interface History {
+            data: Array<History.Data>;
+            starting_at: string;
+        }
+        namespace History {
+            interface Data {
+                quantity: number;
+                total: number;
+                unit_price: number;
+            }
+        }
+    }
+}
 export interface ContractScheduleProServicesInvoiceResponse {
     data: Array<InvoicesAPI.Invoice>;
 }
@@ -389,12 +1073,15 @@ 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;
     commits?: Array<ContractCreateParams.Commit>;
     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.
      */
@@ -403,6 +1090,7 @@ export interface ContractCreateParams {
      * exclusive contract end time
      */
     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
@@ -417,6 +1105,11 @@ export interface ContractCreateParams {
      */
     netsuite_sales_order_id?: string;
     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.
      */
@@ -446,8 +1139,13 @@ export interface ContractCreateParams {
      * on a separate invoice from usage charges.
      */
     scheduled_charges_on_usage_invoices?: 'ALL';
+    spend_threshold_configuration?: ContractCreateParams.SpendThresholdConfiguration;
+    /**
+     * Optional list of
+     * [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
+     * to add to the contract.
+     */
     subscriptions?: Array<ContractCreateParams.Subscription>;
-    threshold_billing_configuration?: ContractCreateParams.ThresholdBillingConfiguration;
     /**
      * This field's availability is dependent on your client's configuration.
      */
@@ -464,14 +1162,23 @@ export interface ContractCreateParams {
 }
 export declare 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.
      */
     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';
     }
     interface Commit {
@@ -488,20 +1195,28 @@ export declare 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
@@ -517,6 +1232,10 @@ export declare namespace ContractCreateParams {
          * This field's availability is dependent on your client's configuration.
          */
         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.
@@ -527,6 +1246,13 @@ export declare namespace ContractCreateParams {
          * Fraction of unused segments that will be rolled over. Must be between 0 and 1.
          */
         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.
@@ -559,6 +1285,24 @@ export declare namespace ContractCreateParams {
                 starting_at: string;
             }
         }
+        /**
+         * Optional configuration for commit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            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
@@ -642,6 +1386,82 @@ export declare namespace ContractCreateParams {
                 unit_price?: number;
             }
         }
+        /**
+         * optionally payment gate this commit
+         */
+        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';
+        }
+        namespace PaymentGateConfig {
+            /**
+             * Only applicable if using PRECALCULATED as your tax type.
+             */
+            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.
+             */
+            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;
+                };
+            }
+        }
+        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>;
+        }
     }
     interface Credit {
         /**
@@ -659,11 +1479,17 @@ export declare namespace ContractCreateParams {
          * applicable_product_tags are not provided, the credit 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 credit hierarchy access control
+         */
+        hierarchy_configuration?: Credit.HierarchyConfiguration;
         /**
          * displayed on invoices
          */
@@ -678,6 +1504,13 @@ export declare 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>;
     }
     namespace Credit {
         /**
@@ -703,6 +1536,41 @@ export declare namespace ContractCreateParams {
                 starting_at: string;
             }
         }
+        /**
+         * Optional configuration for credit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            interface CommitHierarchyChildAccessContractIDs {
+                contract_ids: Array<string>;
+                type: 'CONTRACT_IDS';
+            }
+        }
+        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>;
+        }
     }
     interface Discount {
         product_id: string;
@@ -710,7 +1578,9 @@ export declare namespace ContractCreateParams {
          * Must provide either schedule_items or recurring_schedule.
          */
         schedule: Discount.Schedule;
-        custom_fields?: Record<string, string>;
+        custom_fields?: {
+            [key: string]: string;
+        };
         /**
          * displayed on invoices
          */
@@ -802,6 +1672,15 @@ export declare namespace ContractCreateParams {
             }
         }
     }
+    interface HierarchyConfiguration {
+        parent: HierarchyConfiguration.Parent;
+    }
+    namespace HierarchyConfiguration {
+        interface Parent {
+            contract_id: string;
+            customer_id: string;
+        }
+    }
     interface Override {
         /**
          * RFC 3339 timestamp indicating when the override will start applying (inclusive)
@@ -866,7 +1745,7 @@ export declare namespace ContractCreateParams {
     }
     namespace Override {
         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
              * one of product_id, product_tags, pricing_group_values, or
@@ -878,12 +1757,16 @@ export declare 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.
              */
@@ -915,32 +1798,167 @@ export declare namespace ContractCreateParams {
             rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
             credit_type_id?: string;
             /**
-             * Only set for CUSTOM rate_type. This field is interpreted by custom rate
-             * processors.
+             * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+             * processors.
+             */
+            custom_rate?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+             * set to true.
+             */
+            is_prorated?: boolean;
+            /**
+             * Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+             * this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+             */
+            price?: number;
+            /**
+             * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+             */
+            quantity?: number;
+            /**
+             * Only set for TIERED rate_type.
+             */
+            tiers?: Array<Shared.Tier>;
+        }
+        interface Tier {
+            multiplier: number;
+            size?: number;
+        }
+    }
+    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;
+    }
+    namespace PrepaidBalanceThresholdConfiguration {
+        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>;
+        }
+        namespace Commit {
+            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>;
+            }
+        }
+        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.
              */
-            custom_rate?: Record<string, unknown>;
+            payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
             /**
-             * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
-             * set to true.
+             * Only applicable if using PRECALCULATED as your tax type.
              */
-            is_prorated?: boolean;
+            precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
             /**
-             * Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
-             * this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+             * Only applicable if using STRIPE as your payment gate type.
              */
-            price?: number;
+            stripe_config?: PaymentGateConfig.StripeConfig;
             /**
-             * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+             * 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.
              */
-            quantity?: number;
+            tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+        }
+        namespace PaymentGateConfig {
             /**
-             * Only set for TIERED rate_type.
+             * Only applicable if using PRECALCULATED as your tax type.
              */
-            tiers?: Array<Shared.Tier>;
-        }
-        interface Tier {
-            multiplier: number;
-            size?: number;
+            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.
+             */
+            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;
+                };
+            }
         }
     }
     interface ProfessionalService {
@@ -959,7 +1977,9 @@ export declare namespace ContractCreateParams {
          * amount and must be specified.
          */
         unit_price: number;
-        custom_fields?: Record<string, string>;
+        custom_fields?: {
+            [key: string]: string;
+        };
         description?: string;
         /**
          * This field's availability is dependent on your client's configuration.
@@ -972,7 +1992,9 @@ export declare 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;
         /**
@@ -1000,6 +2022,10 @@ export declare namespace ContractCreateParams {
          * Determines when the contract will stop creating recurring commits. optional
          */
         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.
          */
@@ -1025,16 +2051,27 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
          * between 0 and 1.
          */
         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.
@@ -1047,15 +2084,39 @@ export declare namespace ContractCreateParams {
          */
         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.
          */
         interface CommitDuration {
-            unit: 'PERIODS';
             value: number;
+            unit?: 'PERIODS';
+        }
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            interface CommitHierarchyChildAccessContractIDs {
+                contract_ids: Array<string>;
+                type: 'CONTRACT_IDS';
+            }
         }
         /**
          * The amount the customer should be billed for the commit. Not required.
@@ -1065,6 +2126,45 @@ export declare namespace ContractCreateParams {
             quantity: number;
             unit_price: number;
         }
+        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.
+         */
+        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';
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
+        }
     }
     interface RecurringCredit {
         /**
@@ -1072,7 +2172,9 @@ export declare 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;
         /**
@@ -1100,6 +2202,10 @@ export declare namespace ContractCreateParams {
          * Determines when the contract will stop creating recurring commits. optional
          */
         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
          */
@@ -1121,16 +2227,27 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
          * between 0 and 1.
          */
         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<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.
@@ -1143,15 +2260,78 @@ export declare namespace ContractCreateParams {
          */
         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.
          */
         interface CommitDuration {
-            unit: 'PERIODS';
             value: number;
+            unit?: 'PERIODS';
+        }
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            interface CommitHierarchyChildAccessContractIDs {
+                contract_ids: Array<string>;
+                type: 'CONTRACT_IDS';
+            }
+        }
+        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.
+         */
+        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';
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
         }
     }
     interface ResellerRoyalty {
@@ -1280,11 +2460,103 @@ export declare namespace ContractCreateParams {
             }
         }
     }
+    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;
+    }
+    namespace SpendThresholdConfiguration {
+        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;
+        }
+        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';
+        }
+        namespace PaymentGateConfig {
+            /**
+             * Only applicable if using PRECALCULATED as your tax type.
+             */
+            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.
+             */
+            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;
+                };
+            }
+        }
+    }
     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;
         /**
          * Exclusive end time for the subscription. If not provided, subscription inherits
@@ -1297,14 +2569,20 @@ export declare 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;
     }
     namespace Subscription {
         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';
             /**
@@ -1317,49 +2595,13 @@ export declare 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
              */
             product_id: string;
         }
     }
-    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;
-    }
-    namespace ThresholdBillingConfiguration {
-        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;
-        }
-    }
     interface Transition {
         from_contract_id: string;
         /**
@@ -1378,7 +2620,7 @@ export declare namespace ContractCreateParams {
         }
     }
     interface UsageStatementSchedule {
-        frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+        frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
         /**
          * Required when using CUSTOM_DATE. This option lets you set a historical billing
          * anchor date, aligning future billing cycles with a chosen cadence. For example,
@@ -1489,7 +2731,9 @@ export interface ContractAmendParams {
     starting_at: string;
     commits?: Array<ContractAmendParams.Commit>;
     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.
      */
@@ -1532,20 +2776,28 @@ export declare 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
@@ -1561,6 +2813,10 @@ export declare namespace ContractAmendParams {
          * This field's availability is dependent on your client's configuration.
          */
         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.
@@ -1571,6 +2827,13 @@ export declare namespace ContractAmendParams {
          * Fraction of unused segments that will be rolled over. Must be between 0 and 1.
          */
         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.
@@ -1603,6 +2866,24 @@ export declare namespace ContractAmendParams {
                 starting_at: string;
             }
         }
+        /**
+         * Optional configuration for commit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            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
@@ -1686,6 +2967,82 @@ export declare namespace ContractAmendParams {
                 unit_price?: number;
             }
         }
+        /**
+         * optionally payment gate this commit
+         */
+        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';
+        }
+        namespace PaymentGateConfig {
+            /**
+             * Only applicable if using PRECALCULATED as your tax type.
+             */
+            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.
+             */
+            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;
+                };
+            }
+        }
+        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>;
+        }
     }
     interface Credit {
         /**
@@ -1703,11 +3060,17 @@ export declare namespace ContractAmendParams {
          * applicable_product_tags are not provided, the credit 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 credit hierarchy access control
+         */
+        hierarchy_configuration?: Credit.HierarchyConfiguration;
         /**
          * displayed on invoices
          */
@@ -1722,6 +3085,13 @@ export declare 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>;
     }
     namespace Credit {
         /**
@@ -1747,6 +3117,41 @@ export declare namespace ContractAmendParams {
                 starting_at: string;
             }
         }
+        /**
+         * Optional configuration for credit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            interface CommitHierarchyChildAccessContractIDs {
+                contract_ids: Array<string>;
+                type: 'CONTRACT_IDS';
+            }
+        }
+        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>;
+        }
     }
     interface Discount {
         product_id: string;
@@ -1754,7 +3159,9 @@ export declare namespace ContractAmendParams {
          * Must provide either schedule_items or recurring_schedule.
          */
         schedule: Discount.Schedule;
-        custom_fields?: Record<string, string>;
+        custom_fields?: {
+            [key: string]: string;
+        };
         /**
          * displayed on invoices
          */
@@ -1910,7 +3317,7 @@ export declare namespace ContractAmendParams {
     }
     namespace Override {
         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
              * one of product_id, product_tags, pricing_group_values, or
@@ -1922,12 +3329,16 @@ export declare 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.
              */
@@ -1962,7 +3373,9 @@ export declare 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
              * set to true.
@@ -2003,7 +3416,9 @@ export declare namespace ContractAmendParams {
          * amount and must be specified.
          */
         unit_price: number;
-        custom_fields?: Record<string, string>;
+        custom_fields?: {
+            [key: string]: string;
+        };
         description?: string;
         /**
          * This field's availability is dependent on your client's configuration.
@@ -2173,15 +3588,21 @@ export declare namespace ContractCreateHistoricalInvoicesParams {
          */
         billable_status?: 'billable' | 'unbillable';
         breakdown_granularity?: 'HOUR' | 'DAY';
-        custom_fields?: Record<string, string>;
+        custom_fields?: {
+            [key: string]: string;
+        };
     }
     namespace Invoice {
         interface UsageLineItem {
             exclusive_end_date: string;
             inclusive_start_date: string;
             product_id: string;
-            presentation_group_values?: Record<string, string>;
-            pricing_group_values?: Record<string, string>;
+            presentation_group_values?: {
+                [key: string]: string;
+            };
+            pricing_group_values?: {
+                [key: string]: string;
+            };
             quantity?: number;
             subtotals_with_quantity?: Array<UsageLineItem.SubtotalsWithQuantity>;
         }
@@ -2206,7 +3627,7 @@ export interface ContractListBalancesParams {
      */
     effective_before?: string;
     /**
-     * Include credits from archived contracts.
+     * Include archived credits and credits from archived contracts.
      */
     include_archived?: boolean;
     /**
@@ -2223,6 +3644,10 @@ export interface ContractListBalancesParams {
      * slower.
      */
     include_ledgers?: boolean;
+    /**
+     * The maximum number of commits to return. Defaults to 25.
+     */
+    limit?: number;
     /**
      * The next page token from a previous response.
      */
@@ -2267,17 +3692,21 @@ export declare 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.
          */
@@ -2289,6 +3718,11 @@ export declare namespace ContractRetrieveRateScheduleParams {
         product_tags?: Array<string>;
     }
 }
+export interface ContractRetrieveSubscriptionQuantityHistoryParams {
+    contract_id: string;
+    customer_id: string;
+    subscription_id: string;
+}
 export interface ContractScheduleProServicesInvoiceParams {
     contract_id: string;
     customer_id: string;
@@ -2377,9 +3811,9 @@ export interface ContractUpdateEndDateParams {
     ending_before?: string;
 }
 export declare namespace Contracts {
-    export { type ContractCreateResponse as ContractCreateResponse, type ContractRetrieveResponse as ContractRetrieveResponse, type ContractListResponse as ContractListResponse, type ContractAmendResponse as ContractAmendResponse, type ContractArchiveResponse as ContractArchiveResponse, type ContractCreateHistoricalInvoicesResponse as ContractCreateHistoricalInvoicesResponse, type ContractListBalancesResponse as ContractListBalancesResponse, type ContractRetrieveRateScheduleResponse as ContractRetrieveRateScheduleResponse, type ContractScheduleProServicesInvoiceResponse as ContractScheduleProServicesInvoiceResponse, type ContractUpdateEndDateResponse as ContractUpdateEndDateResponse, type ContractCreateParams as ContractCreateParams, type ContractRetrieveParams as ContractRetrieveParams, type ContractListParams as ContractListParams, type ContractAddManualBalanceEntryParams as ContractAddManualBalanceEntryParams, type ContractAmendParams as ContractAmendParams, type ContractArchiveParams as ContractArchiveParams, type ContractCreateHistoricalInvoicesParams as ContractCreateHistoricalInvoicesParams, type ContractListBalancesParams as ContractListBalancesParams, type ContractRetrieveRateScheduleParams as ContractRetrieveRateScheduleParams, type ContractScheduleProServicesInvoiceParams as ContractScheduleProServicesInvoiceParams, type ContractSetUsageFilterParams as ContractSetUsageFilterParams, type ContractUpdateEndDateParams as ContractUpdateEndDateParams, };
+    export { type ContractCreateResponse as ContractCreateResponse, type ContractRetrieveResponse as ContractRetrieveResponse, type ContractListResponse as ContractListResponse, type ContractAmendResponse as ContractAmendResponse, type ContractArchiveResponse as ContractArchiveResponse, 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, type ContractRetrieveParams as ContractRetrieveParams, type ContractListParams as ContractListParams, type ContractAddManualBalanceEntryParams as ContractAddManualBalanceEntryParams, type ContractAmendParams as ContractAmendParams, type ContractArchiveParams as ContractArchiveParams, 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, };
     export { Products as Products, type ProductListItemState as ProductListItemState, type QuantityConversion as QuantityConversion, type QuantityRounding as QuantityRounding, type ProductCreateResponse as ProductCreateResponse, type ProductRetrieveResponse as ProductRetrieveResponse, type ProductUpdateResponse as ProductUpdateResponse, type ProductListResponse as ProductListResponse, type ProductArchiveResponse as ProductArchiveResponse, ProductListResponsesCursorPage as ProductListResponsesCursorPage, type ProductCreateParams as ProductCreateParams, type ProductRetrieveParams as ProductRetrieveParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, type ProductArchiveParams as ProductArchiveParams, };
-    export { RateCards as RateCards, type RateCardCreateResponse as RateCardCreateResponse, type RateCardRetrieveResponse as RateCardRetrieveResponse, type RateCardUpdateResponse as RateCardUpdateResponse, type RateCardListResponse as RateCardListResponse, type RateCardRetrieveRateScheduleResponse as RateCardRetrieveRateScheduleResponse, RateCardListResponsesCursorPage as RateCardListResponsesCursorPage, type RateCardCreateParams as RateCardCreateParams, type RateCardRetrieveParams as RateCardRetrieveParams, type RateCardUpdateParams as RateCardUpdateParams, type RateCardListParams as RateCardListParams, type RateCardRetrieveRateScheduleParams as RateCardRetrieveRateScheduleParams, };
+    export { RateCards as RateCards, type RateCardCreateResponse as RateCardCreateResponse, 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, };
     export { NamedSchedules as NamedSchedules, type NamedScheduleRetrieveResponse as NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams as NamedScheduleRetrieveParams, type NamedScheduleUpdateParams as NamedScheduleUpdateParams, };
 }
 //# sourceMappingURL=contracts.d.ts.map