@metronome/sdk 0.2.0 → 1.0.0

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

@@ -1,5 +1,4 @@
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
+import { APIResource } from "../../../core/resource.js";
 import * as Shared from "../../shared.js";
 import * as NamedSchedulesAPI from "./named-schedules.js";
 import { NamedScheduleRetrieveParams, NamedScheduleRetrieveResponse, NamedScheduleUpdateParams, NamedSchedules } from "./named-schedules.js";
@@ -8,12 +7,137 @@ import { ProductArchiveParams, ProductArchiveResponse, ProductCreateParams, Prod
 import * as InvoicesAPI from "../customers/invoices.js";
 import * as RateCardsAPI 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";
+import { APIPromise } from "../../../core/api-promise.js";
+import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Contracts extends APIResource {
     products: ProductsAPI.Products;
     rateCards: RateCardsAPI.RateCards;
     namedSchedules: NamedSchedulesAPI.NamedSchedules;
     /**
-     * Create a new contract
+     * Contracts define a customer's products, pricing, discounts, access duration, and
+     * billing configuration. Contracts serve as the central billing agreement for both
+     * PLG and Enterprise customers, you can automatically customers access to your
+     * products and services directly from your product or CRM.
+     *
+     * ### Use this endpoint to:
+     *
+     * - PLG onboarding: Automatically provision new self-serve customers with
+     *   contracts when they sign up.
+     * - Enterprise sales: Push negotiated contracts from Salesforce with custom
+     *   pricing and commitments
+     * - Promotional pricing: Implement time-limited discounts and free trials through
+     *   overrides
+     *
+     * ### Key components:
+     *
+     * #### Contract Term and Billing Schedule
+     *
+     * - Set contract duration using `starting_at` and `ending_before` fields. PLG
+     *   contracts typically use perpetual agreements (no end date), while Enterprise
+     *   contracts have fixed end dates which can be edited over time in the case of
+     *   co-term upsells.
+     *
+     * #### Rate Card
+     *
+     * If you are offering usage based pricing, you can set a rate card for the
+     * contract to reference through `rate_card_id` or `rate_card_alias`. The rate card
+     * is a store of all of your usage based products and their centralized pricing.
+     * Any new products or price changes on the rate card can be set to automatically
+     * propagate to all associated contracts - this ensures consistent pricing and
+     * product launches flow to contracts without manual updates and migrations. The
+     * `usage_statement_schedule` determines the cadence on which Metronome will
+     * finalize a usage invoice for the customer. This defaults to monthly on the 1st,
+     * with options for custom dates, quarterly, or annual cadences. Note: Most usage
+     * based billing companies align usage statements to be evaluated aligned to the
+     * first of the month. Read more about
+     * [Rate Cards](https://docs.metronome.com/pricing-packaging/create-manage-rate-cards/).
+     *
+     * #### Overrides and discounts
+     *
+     * Customize pricing on the contract through time-bounded overrides that can target
+     * specific products, product families, or complex usage scenarios. Overrides
+     * enable two key capabilities:
+     *
+     * - Discounts: Apply percentage discounts, fixed rate reductions, or
+     *   quantity-based pricing tiers
+     * - Entitlements: Provide special pricing or access to specific products for
+     *   negotiated deals
+     *
+     * Read more about
+     * [Contract Overrides](https://docs.metronome.com/manage-product-access/add-contract-override/).
+     *
+     * #### Commits and Credits
+     *
+     * Using commits, configure prepaid or postpaid spending commitments where
+     * customers promise to spend a certain amount over the contract period paid in
+     * advance or in arrears. Use credits to provide free spending allowances. Under
+     * the hood these are the same mechanisms, however, credits are typically offered
+     * for free (SLA or promotional) or as a part of an allotment associated with a
+     * Subscription.
+     *
+     * In Metronome, you can set commits and credits to only be applicable for a subset
+     * of usage. Use `applicable_product_ids` or `applicable_product_tags` to create
+     * product or product-family specific commits or credits, or you can build complex
+     * boolean logic specifiers to target usage based on pricing and presentation group
+     * values using `override_specifiers`.
+     *
+     * These objects can also also be configured to have a recurrence schedule to
+     * easily model customer packaging which includes recurring monthly or quarterly
+     * allotments.
+     *
+     * Commits support rollover settings (`rollover_fraction`) to transfer unused
+     * balances between contract periods, either entirely or as a percentage.
+     *
+     * Read more about
+     * [Credits and Commits](https://docs.metronome.com/pricing-packaging/apply-credits-commits/).
+     *
+     * #### Subscriptions
+     *
+     * You can add a fixed recurring charge to a contract, like monthly licenses or
+     * seat-based fees, using the subscription charge. Subscription charges are defined
+     * on your rate card and you can select which subscription is applicable to add to
+     * each contract. When you add a subscription to a contract you need to:
+     *
+     * - Define whether the subscription is paid for in-advance or in-arrears
+     *   (`collection_schedule`)
+     * - Define the proration behavior (`proration`)
+     * - Specify an initial quantity (`initial_quantity`)
+     * - Define which subscription rate on the rate card should be used
+     *   (`subscription_rate`)
+     *
+     * Read more about
+     * [Subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/).
+     *
+     * #### Scheduled Charges
+     *
+     * Set up one-time, recurring, or entirely custom charges that occur on specific
+     * dates, separate from usage-based billing or commitments. These can be used to
+     * model non-recurring platform charges or professional services.
+     *
+     * #### Threshold Billing
+     *
+     * Metronome allows you to configure automatic billing triggers when customers
+     * reach spending thresholds to prevent fraud and manage risk. You can use
+     * `spend_threshold_configuration` to trigger an invoice to cover current charges
+     * whenever the threshold is reached or you can ensure the customer maintains a
+     * minimum prepaid balance using the `prepaid_balance_configuration`.
+     *
+     * Read more about
+     * [Spend Threshold](https://docs.metronome.com/manage-product-access/spend-thresholds/)
+     * and
+     * [Prepaid Balance Thresholds](https://docs.metronome.com/manage-product-access/prepaid-balance-thresholds/).
+     *
+     * ### Usage guidelines:
+     *
+     * - You can always
+     *   [Edit Contracts](https://docs.metronome.com/manage-product-access/edit-contract/)
+     *   after it has been created, using the `editContract` endpoint. Metronome keeps
+     *   track of all edits, both in the audit log and over the `getEditHistory`
+     *   endpoint.
+     * - Customers in Metronome can have multiple concurrent contracts at one time. Use
+     *   `usage_filters` to route the correct usage to each contract.
+     *   [Read more about usage filters](https://docs.metronome.com/manage-product-access/provision-customer/#create-a-usage-filter).
      *
      * @example
      * ```ts
@@ -28,7 +152,7 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    create(body: ContractCreateParams, options?: Core.RequestOptions): Core.APIPromise<ContractCreateResponse>;
+    create(body: ContractCreateParams, options?: RequestOptions): APIPromise<ContractCreateResponse>;
     /**
      * This is the v1 endpoint to get a contract. New clients should implement using
      * the v2 endpoint.
@@ -41,10 +165,15 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    retrieve(body: ContractRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<ContractRetrieveResponse>;
+    retrieve(body: ContractRetrieveParams, options?: RequestOptions): APIPromise<ContractRetrieveResponse>;
     /**
-     * This is the v1 endpoint to list all contracts for a customer. New clients should
-     * implement using the v2 endpoint.
+     * Retrieves all contracts for a specific customer, including pricing, terms,
+     * credits, and commitments. Use this to view a customer's contract history and
+     * current agreements for billing management. Returns contract details with
+     * optional ledgers and balance information.
+     *
+     * ⚠️ Note: This is the legacy v1 endpoint - new integrations should use the v2
+     * endpoint for enhanced features.
      *
      * @example
      * ```ts
@@ -53,9 +182,26 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    list(body: ContractListParams, options?: Core.RequestOptions): Core.APIPromise<ContractListResponse>;
+    list(body: ContractListParams, options?: RequestOptions): APIPromise<ContractListResponse>;
     /**
-     * Add a manual balance entry
+     * Manually adjust the available balance on a commit or credit. This entry is
+     * appended to the commit ledger as a new event. Optionally include a description
+     * that provides the reasoning for the entry.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Address incorrect usage burn-down caused by malformed usage or invalid config
+     * - Decrease available balance to account for outages where usage may have not
+     *   been tracked or sent to Metronome
+     * - Issue credits to customers in the form of increased balance on existing commit
+     *   or credit
+     *
+     * ### Usage guidelines:
+     *
+     * Manual ledger entries can be extremely useful for resolving discrepancies in
+     * Metronome. However, most corrections to inaccurate billings can be modified
+     * upstream of the commit, whether that is via contract editing, rate editing, or
+     * other actions that cause an invoice to be recalculated.
      *
      * @example
      * ```ts
@@ -69,10 +215,10 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    addManualBalanceEntry(body: ContractAddManualBalanceEntryParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    addManualBalanceEntry(body: ContractAddManualBalanceEntryParams, options?: RequestOptions): APIPromise<void>;
     /**
      * Amendments will be replaced by Contract editing. New clients should implement
-     * using the editContract endpoint. Read more about the migration to contract
+     * 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.
@@ -86,9 +232,28 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    amend(body: ContractAmendParams, options?: Core.RequestOptions): Core.APIPromise<ContractAmendResponse>;
+    amend(body: ContractAmendParams, options?: RequestOptions): APIPromise<ContractAmendResponse>;
     /**
-     * Archive a contract
+     * Permanently end and archive a contract along with all its terms. Any draft
+     * invoices will be canceled, and all upcoming scheduled invoices will be
+     * voided–also all finalized invoices can optionally be voided. Use this in the
+     * event a contract was incorrectly created and needed to be removed from a
+     * customer.
+     *
+     * #### Impact on commits and credits:
+     *
+     * When archiving a contract, all associated commits and credits are also archived.
+     * For prepaid commits with active segments, Metronome automatically generates
+     * expiration ledger entries to close out any remaining balances, ensuring accurate
+     * accounting of unused prepaid amounts. These ledger entries will appear in the
+     * commit's transaction history with type `PREPAID_COMMIT_EXPIRATION`.
+     *
+     * #### Archived contract visibility:
+     *
+     * Archived contracts remain accessible for historical reporting and audit
+     * purposes. They can be retrieved using the `ListContracts` endpoint by setting
+     * the `include_archived` parameter to `true` or in the Metronome UI when the "Show
+     * archived" option is enabled.
      *
      * @example
      * ```ts
@@ -99,9 +264,13 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    archive(body: ContractArchiveParams, options?: Core.RequestOptions): Core.APIPromise<ContractArchiveResponse>;
+    archive(body: ContractArchiveParams, options?: RequestOptions): APIPromise<ContractArchiveResponse>;
     /**
-     * Creates historical usage invoices for a contract
+     * Create historical usage invoices for past billing periods on specific contracts.
+     * Use this endpoint to generate retroactive invoices with custom usage line items,
+     * quantities, and date ranges. Supports preview mode to validate invoice data
+     * before creation. Ideal for billing migrations or correcting past billing
+     * periods.
      *
      * @example
      * ```ts
@@ -132,22 +301,66 @@ export declare class Contracts extends APIResource {
      *   });
      * ```
      */
-    createHistoricalInvoices(body: ContractCreateHistoricalInvoicesParams, options?: Core.RequestOptions): Core.APIPromise<ContractCreateHistoricalInvoicesResponse>;
+    createHistoricalInvoices(body: ContractCreateHistoricalInvoicesParams, options?: RequestOptions): APIPromise<ContractCreateHistoricalInvoicesResponse>;
     /**
-     * List balances (commits and credits).
+     * Retrieve a comprehensive view of all available balances (commits and credits)
+     * for a customer. This endpoint provides real-time visibility into prepaid funds,
+     * postpaid commitments, promotional credits, and other balance types that can
+     * offset usage charges, helping you build transparent billing experiences.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Display current available balances in customer dashboards
+     * - Verify available funds before approving high-usage operations
+     * - Generate balance reports for finance teams
+     * - Filter balances by contract or date ranges
+     *
+     * ### Key response fields:
+     *
+     * An array of balance objects (all credits and commits) containing:
+     *
+     * - Balance details: Current available amount for each commit or credit
+     * - Metadata: Product associations, priorities, applicable date ranges
+     * - Optional ledger entries: Detailed transaction history (if
+     *   `include_ledgers=true`)
+     * - Balance calculations: Including pending transactions and future-dated entries
+     * - Custom fields: Any additional metadata attached to balances
+     *
+     * ### Usage guidelines:
+     *
+     * - Date filtering: Use `effective_before` to include only balances with access
+     *   before a specific date (exclusive)
+     * - Set `include_balance=true` for calculated balance amounts on each commit or
+     *   credit
+     * - Set `include_ledgers=true` for full transaction history
+     * - Set `include_contract_balances = true` to see contract level balances
+     * - Balance logic: Reflects currently accessible amounts, excluding expired/future
+     *   segments
+     * - Manual adjustments: Includes all manual ledger entries, even future-dated ones
      *
      * @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,
-     * });
+     * // Automatically fetches more pages as needed.
+     * for await (const contractListBalancesResponse of 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>;
+    listBalances(body: ContractListBalancesParams, options?: RequestOptions): PagePromise<ContractListBalancesResponsesBodyCursorPage, ContractListBalancesResponse>;
     /**
-     * Get the rate schedule for the rate card on a given contract.
+     * For a specific customer and contract, get the rates at a specific point in time.
+     * This endpoint takes the contract's rate card into consideration, including
+     * scheduled changes. It also takes into account overrides on the contract.
+     *
+     * For example, if you want to show your customer a summary of the prices they are
+     * paying, inclusive of any negotiated discounts or promotions, use this endpoint.
+     * This endpoint only returns rates that are entitled.
      *
      * @example
      * ```ts
@@ -168,10 +381,18 @@ export declare class Contracts extends APIResource {
      *   });
      * ```
      */
-    retrieveRateSchedule(params: ContractRetrieveRateScheduleParams, options?: Core.RequestOptions): Core.APIPromise<ContractRetrieveRateScheduleResponse>;
+    retrieveRateSchedule(params: ContractRetrieveRateScheduleParams, options?: RequestOptions): APIPromise<ContractRetrieveRateScheduleResponse>;
     /**
-     * Fetch the quantity and price for a subscription over time. End-point does not
-     * return future scheduled changes.
+     * Get the history of subscription quantities and prices over time for a given
+     * `subscription_id`. This endpoint can be used to power an in-product experience
+     * where you show a customer their historical changes to seat count. Future changes
+     * are not included in this endpoint - use the `getContract` endpoint to view the
+     * future scheduled changes to a subscription's quantity.
+     *
+     * Subscriptions are used to model fixed recurring fees as well as seat-based
+     * recurring fees. To model changes to the number of seats in Metronome, you can
+     * increment or decrement the quantity on a subscription at any point in the past
+     * or future.
      *
      * @example
      * ```ts
@@ -186,7 +407,7 @@ export declare class Contracts extends APIResource {
      *   );
      * ```
      */
-    retrieveSubscriptionQuantityHistory(body: ContractRetrieveSubscriptionQuantityHistoryParams, options?: Core.RequestOptions): Core.APIPromise<ContractRetrieveSubscriptionQuantityHistoryResponse>;
+    retrieveSubscriptionQuantityHistory(body: ContractRetrieveSubscriptionQuantityHistoryParams, options?: RequestOptions): 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.
@@ -207,9 +428,26 @@ export declare class Contracts extends APIResource {
      *   });
      * ```
      */
-    scheduleProServicesInvoice(body: ContractScheduleProServicesInvoiceParams, options?: Core.RequestOptions): Core.APIPromise<ContractScheduleProServicesInvoiceResponse>;
+    scheduleProServicesInvoice(body: ContractScheduleProServicesInvoiceParams, options?: RequestOptions): APIPromise<ContractScheduleProServicesInvoiceResponse>;
     /**
-     * Set usage filter for a contract
+     * If a customer has multiple contracts with overlapping rates, the usage filter
+     * routes usage to the appropriate contract based on a predefined group key.
+     *
+     * As an example, imagine you have a customer associated with two projects. Each
+     * project is associated with its own contract. You can create a usage filter with
+     * group key `project_id` on each contract, and route usage for `project_1` to the
+     * first contract and `project_2` to the second contract.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Support enterprise contracting scenarios where multiple contracts are
+     *   associated to the same customer with the same rates.
+     * - Update the usage filter associated with the contract over time.
+     *
+     * ### Usage guidelines:
+     *
+     * To use usage filters, the `group_key` must be defined on the billable metrics
+     * underlying the rate card on the contracts.
      *
      * @example
      * ```ts
@@ -222,9 +460,13 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    setUsageFilter(body: ContractSetUsageFilterParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    setUsageFilter(body: ContractSetUsageFilterParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Update the end date of a contract
+     * Update or and an end date to a contract. Ending a contract early will impact
+     * draft usage statements, truncate any terms, and remove upcoming scheduled
+     * invoices. Moving the date into the future will only extend the contract length.
+     * Terms and scheduled invoices are not extended. Use this if a contract's end date
+     * has changed or if a perpetual contract ends.
      *
      * @example
      * ```ts
@@ -235,748 +477,17 @@ export declare class Contracts extends APIResource {
      * });
      * ```
      */
-    updateEndDate(body: ContractUpdateEndDateParams, options?: Core.RequestOptions): Core.APIPromise<ContractUpdateEndDateResponse>;
+    updateEndDate(body: ContractUpdateEndDateParams, options?: RequestOptions): APIPromise<ContractUpdateEndDateResponse>;
 }
+export type ContractListBalancesResponsesBodyCursorPage = BodyCursorPage<ContractListBalancesResponse>;
 export interface ContractCreateResponse {
     data: Shared.ID;
 }
 export interface ContractRetrieveResponse {
-    data: ContractRetrieveResponse.Data;
-}
-export declare namespace ContractRetrieveResponse {
-    interface Data {
-        id: string;
-        amendments: Array<Data.Amendment>;
-        current: Shared.ContractWithoutAmendments;
-        customer_id: string;
-        initial: Shared.ContractWithoutAmendments;
-        /**
-         * RFC 3339 timestamp indicating when the contract was archived. If not returned,
-         * the contract is not archived.
-         */
-        archived_at?: 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
-         * `ending_before` date for consolidation to occur. This field cannot be modified
-         * after a Contract has been created. If this field is omitted, charges will appear
-         * 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
-         * with a previously used uniqueness key, a new record will not be created and the
-         * request will fail with a 409 error.
-         */
-        uniqueness_key?: string;
-    }
-    namespace Data {
-        interface Amendment {
-            id: string;
-            commits: Array<Shared.Commit>;
-            created_at: string;
-            created_by: string;
-            overrides: Array<Shared.Override>;
-            scheduled_charges: Array<Shared.ScheduledCharge>;
-            starting_at: string;
-            credits?: Array<Shared.Credit>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            discounts?: Array<Shared.Discount>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            netsuite_sales_order_id?: string;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            professional_services?: Array<Shared.ProService>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            reseller_royalties?: Array<Amendment.ResellerRoyalty>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            salesforce_opportunity_id?: string;
-        }
-        namespace Amendment {
-            interface ResellerRoyalty {
-                reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
-                aws_account_number?: string;
-                aws_offer_id?: string;
-                aws_payer_reference_id?: string;
-                ending_before?: string | null;
-                fraction?: number;
-                gcp_account_id?: string;
-                gcp_offer_id?: string;
-                netsuite_reseller_id?: string;
-                reseller_contract_value?: number;
-                starting_at?: string;
-            }
-        }
-        /**
-         * The billing provider configuration associated with a contract.
-         */
-        interface CustomerBillingProviderConfiguration {
-            billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
-            delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
-            id?: string;
-            /**
-             * Configuration for the billing provider. The structure of this object is specific
-             * to the billing provider.
-             */
-            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 {
-            interface Proration {
-                invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
-                is_prorated: boolean;
-            }
-            interface QuantitySchedule {
-                quantity: number;
-                starting_at: string;
-                ending_before?: string;
-            }
-            interface SubscriptionRate {
-                billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
-                product: SubscriptionRate.Product;
-            }
-            namespace SubscriptionRate {
-                interface Product {
-                    id: string;
-                    name: string;
-                }
-            }
-        }
-    }
+    data: Shared.Contract;
 }
 export interface ContractListResponse {
-    data: Array<ContractListResponse.Data>;
-}
-export declare namespace ContractListResponse {
-    interface Data {
-        id: string;
-        amendments: Array<Data.Amendment>;
-        current: Shared.ContractWithoutAmendments;
-        customer_id: string;
-        initial: Shared.ContractWithoutAmendments;
-        /**
-         * RFC 3339 timestamp indicating when the contract was archived. If not returned,
-         * the contract is not archived.
-         */
-        archived_at?: 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
-         * `ending_before` date for consolidation to occur. This field cannot be modified
-         * after a Contract has been created. If this field is omitted, charges will appear
-         * 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
-         * with a previously used uniqueness key, a new record will not be created and the
-         * request will fail with a 409 error.
-         */
-        uniqueness_key?: string;
-    }
-    namespace Data {
-        interface Amendment {
-            id: string;
-            commits: Array<Shared.Commit>;
-            created_at: string;
-            created_by: string;
-            overrides: Array<Shared.Override>;
-            scheduled_charges: Array<Shared.ScheduledCharge>;
-            starting_at: string;
-            credits?: Array<Shared.Credit>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            discounts?: Array<Shared.Discount>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            netsuite_sales_order_id?: string;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            professional_services?: Array<Shared.ProService>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            reseller_royalties?: Array<Amendment.ResellerRoyalty>;
-            /**
-             * This field's availability is dependent on your client's configuration.
-             */
-            salesforce_opportunity_id?: string;
-        }
-        namespace Amendment {
-            interface ResellerRoyalty {
-                reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
-                aws_account_number?: string;
-                aws_offer_id?: string;
-                aws_payer_reference_id?: string;
-                ending_before?: string | null;
-                fraction?: number;
-                gcp_account_id?: string;
-                gcp_offer_id?: string;
-                netsuite_reseller_id?: string;
-                reseller_contract_value?: number;
-                starting_at?: string;
-            }
-        }
-        /**
-         * The billing provider configuration associated with a contract.
-         */
-        interface CustomerBillingProviderConfiguration {
-            billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
-            delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
-            id?: string;
-            /**
-             * Configuration for the billing provider. The structure of this object is specific
-             * to the billing provider.
-             */
-            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 {
-            interface Proration {
-                invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
-                is_prorated: boolean;
-            }
-            interface QuantitySchedule {
-                quantity: number;
-                starting_at: string;
-                ending_before?: string;
-            }
-            interface SubscriptionRate {
-                billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
-                product: SubscriptionRate.Product;
-            }
-            namespace SubscriptionRate {
-                interface Product {
-                    id: string;
-                    name: string;
-                }
-            }
-        }
-    }
+    data: Array<Shared.Contract>;
 }
 export interface ContractAmendResponse {
     data: Shared.ID;
@@ -987,10 +498,7 @@ export interface ContractArchiveResponse {
 export interface ContractCreateHistoricalInvoicesResponse {
     data: Array<InvoicesAPI.Invoice>;
 }
-export interface ContractListBalancesResponse {
-    data: Array<Shared.Commit | Shared.Credit>;
-    next_page: string | null;
-}
+export type ContractListBalancesResponse = Shared.Commit | Shared.Credit;
 export interface ContractRetrieveRateScheduleResponse {
     data: Array<ContractRetrieveRateScheduleResponse.Data>;
     next_page?: string | null;
@@ -999,6 +507,9 @@ export declare namespace ContractRetrieveRateScheduleResponse {
     interface Data {
         entitled: boolean;
         list_rate: Shared.Rate;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         product_custom_fields: {
             [key: string]: string;
         };
@@ -1012,30 +523,13 @@ export declare namespace ContractRetrieveRateScheduleResponse {
          * A distinct rate on the rate card. You can choose to use this rate rather than
          * list rate when consuming a credit or commit.
          */
-        commit_rate?: Data.CommitRate;
+        commit_rate?: Shared.CommitRate;
         ending_before?: string;
         override_rate?: Shared.Rate;
         pricing_group_values?: {
             [key: string]: string;
         };
     }
-    namespace Data {
-        /**
-         * A distinct rate on the rate card. You can choose to use this rate rather than
-         * list rate when consuming a credit or commit.
-         */
-        interface CommitRate {
-            rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
-            /**
-             * Commit rate price. For FLAT rate_type, this must be >=0.
-             */
-            price?: number;
-            /**
-             * Only set for TIERED rate_type.
-             */
-            tiers?: Array<Shared.Tier>;
-        }
-    }
 }
 export interface ContractRetrieveSubscriptionQuantityHistoryResponse {
     data: ContractRetrieveSubscriptionQuantityHistoryResponse.Data;
@@ -1079,6 +573,9 @@ export interface ContractCreateParams {
     billing_provider_configuration?: ContractCreateParams.BillingProviderConfiguration;
     commits?: Array<ContractCreateParams.Commit>;
     credits?: Array<ContractCreateParams.Credit>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: {
         [key: string]: string;
     };
@@ -1105,7 +602,7 @@ export interface ContractCreateParams {
      */
     netsuite_sales_order_id?: string;
     overrides?: Array<ContractCreateParams.Override>;
-    prepaid_balance_threshold_configuration?: ContractCreateParams.PrepaidBalanceThresholdConfiguration;
+    prepaid_balance_threshold_configuration?: Shared.PrepaidBalanceThresholdConfiguration;
     /**
      * Priority of the contract.
      */
@@ -1139,7 +636,7 @@ export interface ContractCreateParams {
      * on a separate invoice from usage charges.
      */
     scheduled_charges_on_usage_invoices?: 'ALL';
-    spend_threshold_configuration?: ContractCreateParams.SpendThresholdConfiguration;
+    spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
     /**
      * Optional list of
      * [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
@@ -1206,6 +703,9 @@ export declare namespace ContractCreateParams {
          * all products.
          */
         applicable_product_tags?: Array<string>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -1216,7 +716,7 @@ export declare namespace ContractCreateParams {
         /**
          * Optional configuration for commit hierarchy access control
          */
-        hierarchy_configuration?: Commit.HierarchyConfiguration;
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
         /**
          * 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
@@ -1252,7 +752,7 @@ export declare namespace ContractCreateParams {
          * 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>;
+        specifiers?: Array<Shared.CommitSpecifierInput>;
         /**
          * A temporary ID for the commit that can be used to reference the commit for
          * commit specific overrides.
@@ -1285,24 +785,6 @@ 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
@@ -1314,6 +796,11 @@ export declare namespace ContractCreateParams {
              * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -1443,25 +930,19 @@ export declare namespace ContractCreateParams {
                 invoice_metadata?: {
                     [key: string]: string;
                 };
+                /**
+                 * If true, the payment will be made assuming the customer is present (i.e. on
+                 * session).
+                 *
+                 * If false, the payment will be made assuming the customer is not present (i.e.
+                 * off session). For cardholders from a country with an e-mandate requirement (e.g.
+                 * India), the payment may be declined.
+                 *
+                 * If left blank, will default to false.
+                 */
+                on_session_payment?: boolean;
             }
         }
-        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 {
         /**
@@ -1479,6 +960,9 @@ export declare namespace ContractCreateParams {
          * applicable_product_tags are not provided, the credit applies to all products.
          */
         applicable_product_tags?: Array<string>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -1489,7 +973,7 @@ export declare namespace ContractCreateParams {
         /**
          * Optional configuration for credit hierarchy access control
          */
-        hierarchy_configuration?: Credit.HierarchyConfiguration;
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
         /**
          * displayed on invoices
          */
@@ -1510,7 +994,7 @@ export declare namespace ContractCreateParams {
          * 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>;
+        specifiers?: Array<Shared.CommitSpecifierInput>;
     }
     namespace Credit {
         /**
@@ -1536,41 +1020,6 @@ 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;
@@ -1578,6 +1027,9 @@ export declare namespace ContractCreateParams {
          * Must provide either schedule_items or recurring_schedule.
          */
         schedule: Discount.Schedule;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -1599,6 +1051,11 @@ export declare namespace ContractCreateParams {
              * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -1748,8 +1205,8 @@ export declare namespace ContractCreateParams {
             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
-             * presentation_group_values. If provided, the override will only apply to the
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to the
              * specified commits. If not provided, the override will apply to all commits.
              */
             commit_ids?: Array<string>;
@@ -1778,16 +1235,16 @@ export declare namespace ContractCreateParams {
             product_tags?: Array<string>;
             /**
              * Can only be used for commit specific overrides. Must be used in conjunction with
-             * one of product_id, product_tags, pricing_group_values, or
-             * presentation_group_values. If provided, the override will only apply to commits
-             * created by the specified recurring commit ids.
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to
+             * commits created by the specified recurring commit ids.
              */
             recurring_commit_ids?: Array<string>;
             /**
              * Can only be used for commit specific overrides. Must be used in conjunction with
-             * one of product_id, product_tags, pricing_group_values, or
-             * presentation_group_values. If provided, the override will only apply to credits
-             * created by the specified recurring credit ids.
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to
+             * credits created by the specified recurring credit ids.
              */
             recurring_credit_ids?: Array<string>;
         }
@@ -1803,162 +1260,29 @@ export declare namespace ContractCreateParams {
              */
             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.
-             */
-            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.
+             * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+             * set to true.
              */
-            stripe_config?: PaymentGateConfig.StripeConfig;
+            is_prorated?: boolean;
             /**
-             * 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.
+             * 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.
              */
-            tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-        }
-        namespace PaymentGateConfig {
+            price?: number;
             /**
-             * Only applicable if using PRECALCULATED as your tax type.
+             * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
              */
-            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;
-            }
+            quantity?: number;
             /**
-             * Only applicable if using STRIPE as your payment gate type.
+             * Only set for TIERED rate_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;
-                };
-            }
+            tiers?: Array<Shared.Tier>;
+        }
+        interface Tier {
+            multiplier: number;
+            size?: number;
         }
     }
     interface ProfessionalService {
@@ -1977,6 +1301,9 @@ export declare namespace ContractCreateParams {
          * amount and must be specified.
          */
         unit_price: number;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -2025,7 +1352,7 @@ export declare namespace ContractCreateParams {
         /**
          * Optional configuration for recurring commit/credit hierarchy access control
          */
-        hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
         /**
          * The amount the customer should be billed for the commit. Not required.
          */
@@ -2067,7 +1394,7 @@ export declare namespace ContractCreateParams {
          * 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>;
+        specifiers?: Array<Shared.CommitSpecifierInput>;
         /**
          * Attach a subscription to the recurring commit/credit.
          */
@@ -2086,8 +1413,8 @@ export declare namespace ContractCreateParams {
             credit_type_id: string;
             unit_price: number;
             /**
-             * This field is currently required. Upcoming recurring commit/credit configuration
-             * options will allow it to be optional.
+             * This field is required unless a subscription is attached via
+             * `subscription_config`.
              */
             quantity?: number;
         }
@@ -2100,24 +1427,6 @@ export declare namespace ContractCreateParams {
             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.
          */
@@ -2126,23 +1435,6 @@ 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.
          */
@@ -2155,7 +1447,7 @@ export declare namespace ContractCreateParams {
             /**
              * If set to POOLED, allocation added per seat is pooled across the account.
              */
-            allocation?: 'POOLED';
+            allocation?: 'INDIVIDUAL' | 'POOLED';
         }
         namespace SubscriptionConfig {
             interface ApplySeatIncreaseConfig {
@@ -2205,7 +1497,7 @@ export declare namespace ContractCreateParams {
         /**
          * Optional configuration for recurring commit/credit hierarchy access control
          */
-        hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
         /**
          * displayed on invoices. will be passed through to the individual commits
          */
@@ -2243,7 +1535,7 @@ export declare namespace ContractCreateParams {
          * 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>;
+        specifiers?: Array<Shared.CommitSpecifierInput>;
         /**
          * Attach a subscription to the recurring commit/credit.
          */
@@ -2262,8 +1554,8 @@ export declare namespace ContractCreateParams {
             credit_type_id: string;
             unit_price: number;
             /**
-             * This field is currently required. Upcoming recurring commit/credit configuration
-             * options will allow it to be optional.
+             * This field is required unless a subscription is attached via
+             * `subscription_config`.
              */
             quantity?: number;
         }
@@ -2276,41 +1568,6 @@ export declare namespace ContractCreateParams {
             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.
          */
@@ -2323,7 +1580,7 @@ export declare namespace ContractCreateParams {
             /**
              * If set to POOLED, allocation added per seat is pooled across the account.
              */
-            allocation?: 'POOLED';
+            allocation?: 'INDIVIDUAL' | 'POOLED';
         }
         namespace SubscriptionConfig {
             interface ApplySeatIncreaseConfig {
@@ -2369,6 +1626,12 @@ export declare namespace ContractCreateParams {
          * Must provide either schedule_items or recurring_schedule.
          */
         schedule: ScheduledCharge.Schedule;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
         /**
          * displayed on invoices
          */
@@ -2387,6 +1650,11 @@ export declare namespace ContractCreateParams {
              * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -2460,100 +1728,13 @@ 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 to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -2563,7 +1744,19 @@ export declare namespace ContractCreateParams {
          * contract end date.
          */
         ending_before?: string;
+        /**
+         * The initial quantity for the subscription. It must be non-negative value.
+         * Required if quantity_management_mode is QUANTITY_ONLY.
+         */
+        initial_quantity?: number;
         name?: string;
+        /**
+         * Determines how the subscription's quantity is controlled. Defaults to
+         * QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
+         * directly on the subscription. `initial_quantity` must be provided with this
+         * option. Compatible with recurring commits/credits that use POOLED allocation.
+         */
+        quantity_management_mode?: 'SEAT_BASED' | 'QUANTITY_ONLY';
         /**
          * Inclusive start time for the subscription. If not provided, defaults to contract
          * start date
@@ -2731,6 +1924,9 @@ export interface ContractAmendParams {
     starting_at: string;
     commits?: Array<ContractAmendParams.Commit>;
     credits?: Array<ContractAmendParams.Credit>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: {
         [key: string]: string;
     };
@@ -2787,6 +1983,9 @@ export declare namespace ContractAmendParams {
          * all products.
          */
         applicable_product_tags?: Array<string>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -2797,7 +1996,7 @@ export declare namespace ContractAmendParams {
         /**
          * Optional configuration for commit hierarchy access control
          */
-        hierarchy_configuration?: Commit.HierarchyConfiguration;
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
         /**
          * 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
@@ -2833,7 +2032,7 @@ export declare namespace ContractAmendParams {
          * 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>;
+        specifiers?: Array<Shared.CommitSpecifierInput>;
         /**
          * A temporary ID for the commit that can be used to reference the commit for
          * commit specific overrides.
@@ -2866,24 +2065,6 @@ 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
@@ -2895,6 +2076,11 @@ export declare namespace ContractAmendParams {
              * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3024,25 +2210,19 @@ export declare namespace ContractAmendParams {
                 invoice_metadata?: {
                     [key: string]: string;
                 };
+                /**
+                 * If true, the payment will be made assuming the customer is present (i.e. on
+                 * session).
+                 *
+                 * If false, the payment will be made assuming the customer is not present (i.e.
+                 * off session). For cardholders from a country with an e-mandate requirement (e.g.
+                 * India), the payment may be declined.
+                 *
+                 * If left blank, will default to false.
+                 */
+                on_session_payment?: boolean;
             }
         }
-        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 {
         /**
@@ -3060,6 +2240,9 @@ export declare namespace ContractAmendParams {
          * applicable_product_tags are not provided, the credit applies to all products.
          */
         applicable_product_tags?: Array<string>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -3070,7 +2253,7 @@ export declare namespace ContractAmendParams {
         /**
          * Optional configuration for credit hierarchy access control
          */
-        hierarchy_configuration?: Credit.HierarchyConfiguration;
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
         /**
          * displayed on invoices
          */
@@ -3091,7 +2274,7 @@ export declare namespace ContractAmendParams {
          * 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>;
+        specifiers?: Array<Shared.CommitSpecifierInput>;
     }
     namespace Credit {
         /**
@@ -3117,41 +2300,6 @@ 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;
@@ -3159,6 +2307,9 @@ export declare namespace ContractAmendParams {
          * Must provide either schedule_items or recurring_schedule.
          */
         schedule: Discount.Schedule;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -3180,6 +2331,11 @@ export declare namespace ContractAmendParams {
              * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3320,8 +2476,8 @@ export declare namespace ContractAmendParams {
             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
-             * presentation_group_values. If provided, the override will only apply to the
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to the
              * specified commits. If not provided, the override will apply to all commits.
              */
             commit_ids?: Array<string>;
@@ -3350,16 +2506,16 @@ export declare namespace ContractAmendParams {
             product_tags?: Array<string>;
             /**
              * Can only be used for commit specific overrides. Must be used in conjunction with
-             * one of product_id, product_tags, pricing_group_values, or
-             * presentation_group_values. If provided, the override will only apply to commits
-             * created by the specified recurring commit ids.
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to
+             * commits created by the specified recurring commit ids.
              */
             recurring_commit_ids?: Array<string>;
             /**
              * Can only be used for commit specific overrides. Must be used in conjunction with
-             * one of product_id, product_tags, pricing_group_values, or
-             * presentation_group_values. If provided, the override will only apply to credits
-             * created by the specified recurring credit ids.
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to
+             * credits created by the specified recurring credit ids.
              */
             recurring_credit_ids?: Array<string>;
         }
@@ -3416,6 +2572,9 @@ export declare namespace ContractAmendParams {
          * amount and must be specified.
          */
         unit_price: number;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -3463,6 +2622,12 @@ export declare namespace ContractAmendParams {
          * Must provide either schedule_items or recurring_schedule.
          */
         schedule: ScheduledCharge.Schedule;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
         /**
          * displayed on invoices
          */
@@ -3481,6 +2646,11 @@ export declare namespace ContractAmendParams {
              * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3588,6 +2758,9 @@ export declare namespace ContractCreateHistoricalInvoicesParams {
          */
         billable_status?: 'billable' | 'unbillable';
         breakdown_granularity?: 'HOUR' | 'DAY';
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -3615,7 +2788,7 @@ export declare namespace ContractCreateHistoricalInvoicesParams {
         }
     }
 }
-export interface ContractListBalancesParams {
+export interface ContractListBalancesParams extends BodyCursorPageParams {
     customer_id: string;
     id?: string;
     /**
@@ -3644,14 +2817,6 @@ 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.
-     */
-    next_page?: string;
     /**
      * Include only balances that have any access on or after the provided date
      */
@@ -3811,9 +2976,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 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 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 { 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 ContractListBalancesResponsesBodyCursorPage as ContractListBalancesResponsesBodyCursorPage, 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, type 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 RateCardArchiveResponse as RateCardArchiveResponse, type RateCardRetrieveRateScheduleResponse as RateCardRetrieveRateScheduleResponse, type 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