@metronome/sdk 0.3.0 → 1.0.0

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

@@ -1,16 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
-import * as Shared from "../../shared.js";
-import * as NamedSchedulesAPI from "./named-schedules.js";
+import { APIResource } from '../../../core/resource';
+import * as Shared from '../../shared';
+import * as NamedSchedulesAPI from './named-schedules';
 import {
   NamedScheduleRetrieveParams,
   NamedScheduleRetrieveResponse,
   NamedScheduleUpdateParams,
   NamedSchedules,
-} from "./named-schedules.js";
-import * as ProductsAPI from "./products.js";
+} from './named-schedules';
+import * as ProductsAPI from './products';
 import {
   ProductArchiveParams,
   ProductArchiveResponse,
@@ -27,9 +26,9 @@ import {
   Products,
   QuantityConversion,
   QuantityRounding,
-} from "./products.js";
-import * as InvoicesAPI from "../customers/invoices.js";
-import * as RateCardsAPI from "./rate-cards/rate-cards.js";
+} from './products';
+import * as InvoicesAPI from '../customers/invoices';
+import * as RateCardsAPI from './rate-cards/rate-cards';
 import {
   RateCardArchiveParams,
   RateCardArchiveResponse,
@@ -45,7 +44,11 @@ import {
   RateCardUpdateParams,
   RateCardUpdateResponse,
   RateCards,
-} from "./rate-cards/rate-cards.js";
+} from './rate-cards/rate-cards';
+import { APIPromise } from '../../../core/api-promise';
+import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Contracts extends APIResource {
   products: ProductsAPI.Products = new ProductsAPI.Products(this._client);
@@ -53,7 +56,129 @@ export class Contracts extends APIResource {
   namedSchedules: NamedSchedulesAPI.NamedSchedules = new NamedSchedulesAPI.NamedSchedules(this._client);
 
   /**
-   * 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
@@ -68,7 +193,7 @@ export class Contracts extends APIResource {
    * });
    * ```
    */
-  create(body: ContractCreateParams, options?: Core.RequestOptions): Core.APIPromise<ContractCreateResponse> {
+  create(body: ContractCreateParams, options?: RequestOptions): APIPromise<ContractCreateResponse> {
     return this._client.post('/v1/contracts/create', { body, ...options });
   }
 
@@ -84,16 +209,18 @@ export class Contracts extends APIResource {
    * });
    * ```
    */
-  retrieve(
-    body: ContractRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ContractRetrieveResponse> {
+  retrieve(body: ContractRetrieveParams, options?: RequestOptions): APIPromise<ContractRetrieveResponse> {
     return this._client.post('/v1/contracts/get', { body, ...options });
   }
 
   /**
-   * 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
@@ -102,12 +229,29 @@ export class Contracts extends APIResource {
    * });
    * ```
    */
-  list(body: ContractListParams, options?: Core.RequestOptions): Core.APIPromise<ContractListResponse> {
+  list(body: ContractListParams, options?: RequestOptions): APIPromise<ContractListResponse> {
     return this._client.post('/v1/contracts/list', { body, ...options });
   }
 
   /**
-   * 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
@@ -123,18 +267,18 @@ export class Contracts extends APIResource {
    */
   addManualBalanceEntry(
     body: ContractAddManualBalanceEntryParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<void> {
+    options?: RequestOptions,
+  ): APIPromise<void> {
     return this._client.post('/v1/contracts/addManualBalanceLedgerEntry', {
       body,
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
    * 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.
@@ -148,12 +292,31 @@ export class Contracts extends APIResource {
    * });
    * ```
    */
-  amend(body: ContractAmendParams, options?: Core.RequestOptions): Core.APIPromise<ContractAmendResponse> {
+  amend(body: ContractAmendParams, options?: RequestOptions): APIPromise<ContractAmendResponse> {
     return this._client.post('/v1/contracts/amend', { body, ...options });
   }
 
   /**
-   * 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
@@ -164,15 +327,16 @@ export class Contracts extends APIResource {
    * });
    * ```
    */
-  archive(
-    body: ContractArchiveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ContractArchiveResponse> {
+  archive(body: ContractArchiveParams, options?: RequestOptions): APIPromise<ContractArchiveResponse> {
     return this._client.post('/v1/contracts/archive', { body, ...options });
   }
 
   /**
-   * 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
@@ -205,32 +369,80 @@ export class Contracts extends APIResource {
    */
   createHistoricalInvoices(
     body: ContractCreateHistoricalInvoicesParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ContractCreateHistoricalInvoicesResponse> {
+    options?: RequestOptions,
+  ): APIPromise<ContractCreateHistoricalInvoicesResponse> {
     return this._client.post('/v1/contracts/createHistoricalInvoices', { body, ...options });
   }
 
   /**
-   * 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> {
-    return this._client.post('/v1/contracts/customerBalances/list', { body, ...options });
+    options?: RequestOptions,
+  ): PagePromise<ContractListBalancesResponsesBodyCursorPage, ContractListBalancesResponse> {
+    return this._client.getAPIList(
+      '/v1/contracts/customerBalances/list',
+      BodyCursorPage<ContractListBalancesResponse>,
+      { body, method: 'post', ...options },
+    );
   }
 
   /**
-   * 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
@@ -253,8 +465,8 @@ export class Contracts extends APIResource {
    */
   retrieveRateSchedule(
     params: ContractRetrieveRateScheduleParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ContractRetrieveRateScheduleResponse> {
+    options?: RequestOptions,
+  ): APIPromise<ContractRetrieveRateScheduleResponse> {
     const { limit, next_page, ...body } = params;
     return this._client.post('/v1/contracts/getContractRateSchedule', {
       query: { limit, next_page },
@@ -264,8 +476,16 @@ export class Contracts extends APIResource {
   }
 
   /**
-   * 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
@@ -282,8 +502,8 @@ export class Contracts extends APIResource {
    */
   retrieveSubscriptionQuantityHistory(
     body: ContractRetrieveSubscriptionQuantityHistoryParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ContractRetrieveSubscriptionQuantityHistoryResponse> {
+    options?: RequestOptions,
+  ): APIPromise<ContractRetrieveSubscriptionQuantityHistoryResponse> {
     return this._client.post('/v1/contracts/getSubscriptionQuantityHistory', { body, ...options });
   }
 
@@ -300,994 +520,95 @@ export class Contracts extends APIResource {
    *     issued_at: '2019-12-27T18:11:19.117Z',
    *     line_items: [
    *       {
-   *         professional_service_id:
-   *           '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *       },
-   *     ],
-   *   });
-   * ```
-   */
-  scheduleProServicesInvoice(
-    body: ContractScheduleProServicesInvoiceParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ContractScheduleProServicesInvoiceResponse> {
-    return this._client.post('/v1/contracts/scheduleProServicesInvoice', { body, ...options });
-  }
-
-  /**
-   * Set usage filter for a contract
-   *
-   * @example
-   * ```ts
-   * await client.v1.contracts.setUsageFilter({
-   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
-   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
-   *   group_key: 'business_subscription_id',
-   *   group_values: ['ID-1', 'ID-2'],
-   *   starting_at: '2020-01-01T00:00:00.000Z',
-   * });
-   * ```
-   */
-  setUsageFilter(body: ContractSetUsageFilterParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post('/v1/contracts/setUsageFilter', {
-      body,
-      ...options,
-      headers: { Accept: '*/*', ...options?.headers },
-    });
-  }
-
-  /**
-   * Update the end date of a contract
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.contracts.updateEndDate({
-   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
-   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
-   *   ending_before: '2020-01-01T00:00:00.000Z',
-   * });
-   * ```
-   */
-  updateEndDate(
-    body: ContractUpdateEndDateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ContractUpdateEndDateResponse> {
-    return this._client.post('/v1/contracts/updateEndDate', { body, ...options });
-  }
-}
-
-export interface ContractCreateResponse {
-  data: Shared.ID;
-}
-
-export interface ContractRetrieveResponse {
-  data: ContractRetrieveResponse.Data;
-}
-
-export namespace ContractRetrieveResponse {
-  export 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;
-  }
-
-  export namespace Data {
-    export 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;
-    }
-
-    export namespace Amendment {
-      export 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.
-     */
-    export 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 };
-    }
-
-    export interface PrepaidBalanceThresholdConfiguration {
-      commit: PrepaidBalanceThresholdConfiguration.Commit;
-
-      /**
-       * When set to false, the contract will not be evaluated against the
-       * threshold_amount. Toggling to true will result an immediate evaluation,
-       * regardless of prior state.
-       */
-      is_enabled: boolean;
-
-      payment_gate_config: PrepaidBalanceThresholdConfiguration.PaymentGateConfig;
-
-      /**
-       * Specify the amount the balance should be recharged to.
-       */
-      recharge_to_amount: number;
-
-      /**
-       * Specify the threshold amount for the contract. Each time the contract's prepaid
-       * balance lowers to this amount, a threshold charge will be initiated.
-       */
-      threshold_amount: number;
-
-      /**
-       * If provided, the threshold, recharge-to amount, and the resulting threshold
-       * commit amount will be in terms of this credit type instead of the fiat currency.
-       */
-      custom_credit_type_id?: string;
-    }
-
-    export namespace PrepaidBalanceThresholdConfiguration {
-      export interface Commit {
-        /**
-         * The commit product that will be used to generate the line item for commit
-         * payment.
-         */
-        product_id: string;
-
-        /**
-         * Which products the threshold commit applies to. If applicable_product_ids,
-         * applicable_product_tags or specifiers are not provided, the commit applies to
-         * all products.
-         */
-        applicable_product_ids?: Array<string>;
-
-        /**
-         * Which tags the threshold commit applies to. If applicable_product_ids,
-         * applicable_product_tags or specifiers are not provided, the commit applies to
-         * all products.
-         */
-        applicable_product_tags?: Array<string>;
-
-        description?: string;
-
-        /**
-         * Specify the name of the line item for the threshold charge. If left blank, it
-         * will default to the commit product name.
-         */
-        name?: string;
-
-        /**
-         * List of filters that determine what kind of customer usage draws down a commit
-         * or credit. A customer's usage needs to meet the condition of at least one of the
-         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
-         * be used together with `applicable_product_ids` or `applicable_product_tags`.
-         */
-        specifiers?: Array<Commit.Specifier>;
-      }
-
-      export namespace Commit {
-        export interface Specifier {
-          presentation_group_values?: { [key: string]: string };
-
-          pricing_group_values?: { [key: string]: string };
-
-          /**
-           * If provided, the specifier will only apply to the product with the specified ID.
-           */
-          product_id?: string;
-
-          /**
-           * If provided, the specifier will only apply to products with all the specified
-           * tags.
-           */
-          product_tags?: Array<string>;
-        }
-      }
-
-      export interface PaymentGateConfig {
-        /**
-         * Gate access to the commit balance based on successful collection of payment.
-         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-         * facilitate payment using your own payment integration. Select NONE if you do not
-         * wish to payment gate the commit balance.
-         */
-        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        stripe_config?: PaymentGateConfig.StripeConfig;
-
-        /**
-         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-         * will default to NONE.
-         */
-        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-      }
-
-      export namespace PaymentGateConfig {
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        export interface PrecalculatedTaxConfig {
-          /**
-           * Amount of tax to be applied. This should be in the same currency and
-           * denomination as the commit's invoice schedule
-           */
-          tax_amount: number;
-
-          /**
-           * Name of the tax to be applied. This may be used in an invoice line item
-           * description.
-           */
-          tax_name?: string;
-        }
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        export interface StripeConfig {
-          /**
-           * If left blank, will default to INVOICE
-           */
-          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
-
-          /**
-           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-           * your payment type.
-           */
-          invoice_metadata?: { [key: string]: string };
-        }
-      }
-    }
-
-    export interface SpendThresholdConfiguration {
-      commit: SpendThresholdConfiguration.Commit;
-
-      /**
-       * When set to false, the contract will not be evaluated against the
-       * threshold_amount. Toggling to true will result an immediate evaluation,
-       * regardless of prior state.
-       */
-      is_enabled: boolean;
-
-      payment_gate_config: SpendThresholdConfiguration.PaymentGateConfig;
-
-      /**
-       * Specify the threshold amount for the contract. Each time the contract's usage
-       * hits this amount, a threshold charge will be initiated.
-       */
-      threshold_amount: number;
-    }
-
-    export namespace SpendThresholdConfiguration {
-      export interface Commit {
-        /**
-         * The commit product that will be used to generate the line item for commit
-         * payment.
-         */
-        product_id: string;
-
-        description?: string;
-
-        /**
-         * Specify the name of the line item for the threshold charge. If left blank, it
-         * will default to the commit product name.
-         */
-        name?: string;
-      }
-
-      export interface PaymentGateConfig {
-        /**
-         * Gate access to the commit balance based on successful collection of payment.
-         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-         * facilitate payment using your own payment integration. Select NONE if you do not
-         * wish to payment gate the commit balance.
-         */
-        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        stripe_config?: PaymentGateConfig.StripeConfig;
-
-        /**
-         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-         * will default to NONE.
-         */
-        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-      }
-
-      export namespace PaymentGateConfig {
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        export interface PrecalculatedTaxConfig {
-          /**
-           * Amount of tax to be applied. This should be in the same currency and
-           * denomination as the commit's invoice schedule
-           */
-          tax_amount: number;
-
-          /**
-           * Name of the tax to be applied. This may be used in an invoice line item
-           * description.
-           */
-          tax_name?: string;
-        }
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        export interface StripeConfig {
-          /**
-           * If left blank, will default to INVOICE
-           */
-          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
-
-          /**
-           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-           * your payment type.
-           */
-          invoice_metadata?: { [key: string]: string };
-        }
-      }
-    }
-
-    export interface Subscription {
-      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;
-    }
-
-    export namespace Subscription {
-      export interface Proration {
-        invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
-
-        is_prorated: boolean;
-      }
-
-      export interface QuantitySchedule {
-        quantity: number;
-
-        starting_at: string;
-
-        ending_before?: string;
-      }
-
-      export interface SubscriptionRate {
-        billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
-
-        product: SubscriptionRate.Product;
-      }
-
-      export namespace SubscriptionRate {
-        export interface Product {
-          id: string;
-
-          name: string;
-        }
-      }
-    }
-  }
-}
-
-export interface ContractListResponse {
-  data: Array<ContractListResponse.Data>;
-}
-
-export namespace ContractListResponse {
-  export 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;
-  }
-
-  export namespace Data {
-    export 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;
-    }
-
-    export namespace Amendment {
-      export 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.
-     */
-    export 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 };
-    }
-
-    export interface PrepaidBalanceThresholdConfiguration {
-      commit: PrepaidBalanceThresholdConfiguration.Commit;
-
-      /**
-       * When set to false, the contract will not be evaluated against the
-       * threshold_amount. Toggling to true will result an immediate evaluation,
-       * regardless of prior state.
-       */
-      is_enabled: boolean;
-
-      payment_gate_config: PrepaidBalanceThresholdConfiguration.PaymentGateConfig;
-
-      /**
-       * Specify the amount the balance should be recharged to.
-       */
-      recharge_to_amount: number;
-
-      /**
-       * Specify the threshold amount for the contract. Each time the contract's prepaid
-       * balance lowers to this amount, a threshold charge will be initiated.
-       */
-      threshold_amount: number;
-
-      /**
-       * If provided, the threshold, recharge-to amount, and the resulting threshold
-       * commit amount will be in terms of this credit type instead of the fiat currency.
-       */
-      custom_credit_type_id?: string;
-    }
-
-    export namespace PrepaidBalanceThresholdConfiguration {
-      export interface Commit {
-        /**
-         * The commit product that will be used to generate the line item for commit
-         * payment.
-         */
-        product_id: string;
-
-        /**
-         * Which products the threshold commit applies to. If applicable_product_ids,
-         * applicable_product_tags or specifiers are not provided, the commit applies to
-         * all products.
-         */
-        applicable_product_ids?: Array<string>;
-
-        /**
-         * Which tags the threshold commit applies to. If applicable_product_ids,
-         * applicable_product_tags or specifiers are not provided, the commit applies to
-         * all products.
-         */
-        applicable_product_tags?: Array<string>;
-
-        description?: string;
-
-        /**
-         * Specify the name of the line item for the threshold charge. If left blank, it
-         * will default to the commit product name.
-         */
-        name?: string;
-
-        /**
-         * List of filters that determine what kind of customer usage draws down a commit
-         * or credit. A customer's usage needs to meet the condition of at least one of the
-         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
-         * be used together with `applicable_product_ids` or `applicable_product_tags`.
-         */
-        specifiers?: Array<Commit.Specifier>;
-      }
-
-      export namespace Commit {
-        export interface Specifier {
-          presentation_group_values?: { [key: string]: string };
-
-          pricing_group_values?: { [key: string]: string };
-
-          /**
-           * If provided, the specifier will only apply to the product with the specified ID.
-           */
-          product_id?: string;
-
-          /**
-           * If provided, the specifier will only apply to products with all the specified
-           * tags.
-           */
-          product_tags?: Array<string>;
-        }
-      }
-
-      export interface PaymentGateConfig {
-        /**
-         * Gate access to the commit balance based on successful collection of payment.
-         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-         * facilitate payment using your own payment integration. Select NONE if you do not
-         * wish to payment gate the commit balance.
-         */
-        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        stripe_config?: PaymentGateConfig.StripeConfig;
-
-        /**
-         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-         * will default to NONE.
-         */
-        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-      }
-
-      export namespace PaymentGateConfig {
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        export interface PrecalculatedTaxConfig {
-          /**
-           * Amount of tax to be applied. This should be in the same currency and
-           * denomination as the commit's invoice schedule
-           */
-          tax_amount: number;
-
-          /**
-           * Name of the tax to be applied. This may be used in an invoice line item
-           * description.
-           */
-          tax_name?: string;
-        }
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        export interface StripeConfig {
-          /**
-           * If left blank, will default to INVOICE
-           */
-          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
-
-          /**
-           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-           * your payment type.
-           */
-          invoice_metadata?: { [key: string]: string };
-        }
-      }
-    }
-
-    export interface SpendThresholdConfiguration {
-      commit: SpendThresholdConfiguration.Commit;
-
-      /**
-       * When set to false, the contract will not be evaluated against the
-       * threshold_amount. Toggling to true will result an immediate evaluation,
-       * regardless of prior state.
-       */
-      is_enabled: boolean;
-
-      payment_gate_config: SpendThresholdConfiguration.PaymentGateConfig;
-
-      /**
-       * Specify the threshold amount for the contract. Each time the contract's usage
-       * hits this amount, a threshold charge will be initiated.
-       */
-      threshold_amount: number;
-    }
-
-    export namespace SpendThresholdConfiguration {
-      export interface Commit {
-        /**
-         * The commit product that will be used to generate the line item for commit
-         * payment.
-         */
-        product_id: string;
-
-        description?: string;
-
-        /**
-         * Specify the name of the line item for the threshold charge. If left blank, it
-         * will default to the commit product name.
-         */
-        name?: string;
-      }
-
-      export interface PaymentGateConfig {
-        /**
-         * Gate access to the commit balance based on successful collection of payment.
-         * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-         * facilitate payment using your own payment integration. Select NONE if you do not
-         * wish to payment gate the commit balance.
-         */
-        payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        stripe_config?: PaymentGateConfig.StripeConfig;
-
-        /**
-         * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-         * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-         * will default to NONE.
-         */
-        tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-      }
-
-      export namespace PaymentGateConfig {
-        /**
-         * Only applicable if using PRECALCULATED as your tax type.
-         */
-        export interface PrecalculatedTaxConfig {
-          /**
-           * Amount of tax to be applied. This should be in the same currency and
-           * denomination as the commit's invoice schedule
-           */
-          tax_amount: number;
-
-          /**
-           * Name of the tax to be applied. This may be used in an invoice line item
-           * description.
-           */
-          tax_name?: string;
-        }
-
-        /**
-         * Only applicable if using STRIPE as your payment gate type.
-         */
-        export interface StripeConfig {
-          /**
-           * If left blank, will default to INVOICE
-           */
-          payment_type: 'INVOICE' | 'PAYMENT_INTENT';
-
-          /**
-           * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-           * your payment type.
-           */
-          invoice_metadata?: { [key: string]: string };
-        }
-      }
-    }
-
-    export interface Subscription {
-      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;
-    }
-
-    export namespace Subscription {
-      export interface Proration {
-        invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
-
-        is_prorated: boolean;
-      }
-
-      export interface QuantitySchedule {
-        quantity: number;
+   *         professional_service_id:
+   *           '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  scheduleProServicesInvoice(
+    body: ContractScheduleProServicesInvoiceParams,
+    options?: RequestOptions,
+  ): APIPromise<ContractScheduleProServicesInvoiceResponse> {
+    return this._client.post('/v1/contracts/scheduleProServicesInvoice', { body, ...options });
+  }
 
-        starting_at: string;
+  /**
+   * 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
+   * await client.v1.contracts.setUsageFilter({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   group_key: 'business_subscription_id',
+   *   group_values: ['ID-1', 'ID-2'],
+   *   starting_at: '2020-01-01T00:00:00.000Z',
+   * });
+   * ```
+   */
+  setUsageFilter(body: ContractSetUsageFilterParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/v1/contracts/setUsageFilter', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
 
-        ending_before?: string;
-      }
+  /**
+   * 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
+   * const response = await client.v1.contracts.updateEndDate({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   ending_before: '2020-01-01T00:00:00.000Z',
+   * });
+   * ```
+   */
+  updateEndDate(
+    body: ContractUpdateEndDateParams,
+    options?: RequestOptions,
+  ): APIPromise<ContractUpdateEndDateResponse> {
+    return this._client.post('/v1/contracts/updateEndDate', { body, ...options });
+  }
+}
 
-      export interface SubscriptionRate {
-        billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+export type ContractListBalancesResponsesBodyCursorPage = BodyCursorPage<ContractListBalancesResponse>;
 
-        product: SubscriptionRate.Product;
-      }
+export interface ContractCreateResponse {
+  data: Shared.ID;
+}
 
-      export namespace SubscriptionRate {
-        export interface Product {
-          id: string;
+export interface ContractRetrieveResponse {
+  data: Shared.Contract;
+}
 
-          name: string;
-        }
-      }
-    }
-  }
+export interface ContractListResponse {
+  data: Array<Shared.Contract>;
 }
 
 export interface ContractAmendResponse {
@@ -1302,11 +623,7 @@ 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>;
@@ -1320,6 +637,9 @@ export namespace ContractRetrieveRateScheduleResponse {
 
     list_rate: Shared.Rate;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     product_custom_fields: { [key: string]: string };
 
     product_id: string;
@@ -1338,7 +658,7 @@ export 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;
 
@@ -1346,26 +666,6 @@ export namespace ContractRetrieveRateScheduleResponse {
 
     pricing_group_values?: { [key: string]: string };
   }
-
-  export 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.
-     */
-    export 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 {
@@ -1426,6 +726,9 @@ export interface ContractCreateParams {
 
   credits?: Array<ContractCreateParams.Credit>;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields?: { [key: string]: string };
 
   /**
@@ -1459,7 +762,7 @@ export interface ContractCreateParams {
 
   overrides?: Array<ContractCreateParams.Override>;
 
-  prepaid_balance_threshold_configuration?: ContractCreateParams.PrepaidBalanceThresholdConfiguration;
+  prepaid_balance_threshold_configuration?: Shared.PrepaidBalanceThresholdConfiguration;
 
   /**
    * Priority of the contract.
@@ -1504,7 +807,7 @@ export interface ContractCreateParams {
    */
   scheduled_charges_on_usage_invoices?: 'ALL';
 
-  spend_threshold_configuration?: ContractCreateParams.SpendThresholdConfiguration;
+  spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
 
   /**
    * Optional list of
@@ -1587,6 +890,9 @@ export namespace ContractCreateParams {
      */
     applicable_product_tags?: Array<string>;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -1597,7 +903,7 @@ export 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
@@ -1641,7 +947,7 @@ export 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
@@ -1681,32 +987,6 @@ export namespace ContractCreateParams {
       }
     }
 
-    /**
-     * Optional configuration for commit hierarchy access control
-     */
-    export interface HierarchyConfiguration {
-      child_access:
-        | HierarchyConfiguration.CommitHierarchyChildAccessAll
-        | HierarchyConfiguration.CommitHierarchyChildAccessNone
-        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
-    }
-
-    export namespace HierarchyConfiguration {
-      export interface CommitHierarchyChildAccessAll {
-        type: 'ALL';
-      }
-
-      export interface CommitHierarchyChildAccessNone {
-        type: 'NONE';
-      }
-
-      export interface CommitHierarchyChildAccessContractIDs {
-        contract_ids: Array<string>;
-
-        type: 'CONTRACT_IDS';
-      }
-    }
-
     /**
      * Required for "POSTPAID" commits: the true up invoice will be generated at this
      * time and only one schedule item is allowed; the total must match access_schedule
@@ -1886,23 +1166,6 @@ export namespace ContractCreateParams {
         on_session_payment?: boolean;
       }
     }
-
-    export interface Specifier {
-      presentation_group_values?: { [key: string]: string };
-
-      pricing_group_values?: { [key: string]: string };
-
-      /**
-       * If provided, the specifier will only apply to the product with the specified ID.
-       */
-      product_id?: string;
-
-      /**
-       * If provided, the specifier will only apply to products with all the specified
-       * tags.
-       */
-      product_tags?: Array<string>;
-    }
   }
 
   export interface Credit {
@@ -1925,6 +1188,9 @@ export namespace ContractCreateParams {
      */
     applicable_product_tags?: Array<string>;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -1935,7 +1201,7 @@ export namespace ContractCreateParams {
     /**
      * Optional configuration for credit hierarchy access control
      */
-    hierarchy_configuration?: Credit.HierarchyConfiguration;
+    hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
 
     /**
      * displayed on invoices
@@ -1961,7 +1227,7 @@ export 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>;
   }
 
   export namespace Credit {
@@ -1992,49 +1258,6 @@ export namespace ContractCreateParams {
         starting_at: string;
       }
     }
-
-    /**
-     * Optional configuration for credit hierarchy access control
-     */
-    export interface HierarchyConfiguration {
-      child_access:
-        | HierarchyConfiguration.CommitHierarchyChildAccessAll
-        | HierarchyConfiguration.CommitHierarchyChildAccessNone
-        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
-    }
-
-    export namespace HierarchyConfiguration {
-      export interface CommitHierarchyChildAccessAll {
-        type: 'ALL';
-      }
-
-      export interface CommitHierarchyChildAccessNone {
-        type: 'NONE';
-      }
-
-      export interface CommitHierarchyChildAccessContractIDs {
-        contract_ids: Array<string>;
-
-        type: 'CONTRACT_IDS';
-      }
-    }
-
-    export interface Specifier {
-      presentation_group_values?: { [key: string]: string };
-
-      pricing_group_values?: { [key: string]: string };
-
-      /**
-       * If provided, the specifier will only apply to the product with the specified ID.
-       */
-      product_id?: string;
-
-      /**
-       * If provided, the specifier will only apply to products with all the specified
-       * tags.
-       */
-      product_tags?: Array<string>;
-    }
   }
 
   export interface Discount {
@@ -2045,6 +1268,9 @@ export namespace ContractCreateParams {
      */
     schedule: Discount.Schedule;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -2253,8 +1479,8 @@ export namespace ContractCreateParams {
 
       /**
        * 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>;
@@ -2284,17 +1510,17 @@ export namespace ContractCreateParams {
 
       /**
        * 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>;
     }
@@ -2320,177 +1546,26 @@ export namespace ContractCreateParams {
       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>;
-    }
-
-    export interface Tier {
-      multiplier: number;
-
-      size?: number;
-    }
-  }
-
-  export interface PrepaidBalanceThresholdConfiguration {
-    commit: PrepaidBalanceThresholdConfiguration.Commit;
-
-    /**
-     * When set to false, the contract will not be evaluated against the
-     * threshold_amount. Toggling to true will result an immediate evaluation,
-     * regardless of prior state.
-     */
-    is_enabled: boolean;
-
-    payment_gate_config: PrepaidBalanceThresholdConfiguration.PaymentGateConfig;
-
-    /**
-     * Specify the amount the balance should be recharged to.
-     */
-    recharge_to_amount: number;
-
-    /**
-     * Specify the threshold amount for the contract. Each time the contract's prepaid
-     * balance lowers to this amount, a threshold charge will be initiated.
-     */
-    threshold_amount: number;
-
-    /**
-     * If provided, the threshold, recharge-to amount, and the resulting threshold
-     * commit amount will be in terms of this credit type instead of the fiat currency.
-     */
-    custom_credit_type_id?: string;
-  }
-
-  export namespace PrepaidBalanceThresholdConfiguration {
-    export interface Commit {
-      /**
-       * The commit product that will be used to generate the line item for commit
-       * payment.
-       */
-      product_id: string;
-
-      /**
-       * Which products the threshold commit applies to. If applicable_product_ids,
-       * applicable_product_tags or specifiers are not provided, the commit applies to
-       * all products.
-       */
-      applicable_product_ids?: Array<string>;
-
-      /**
-       * Which tags the threshold commit applies to. If applicable_product_ids,
-       * applicable_product_tags or specifiers are not provided, the commit applies to
-       * all products.
-       */
-      applicable_product_tags?: Array<string>;
-
-      description?: string;
-
-      /**
-       * Specify the name of the line item for the threshold charge. If left blank, it
-       * will default to the commit product name.
-       */
-      name?: string;
-
-      /**
-       * List of filters that determine what kind of customer usage draws down a commit
-       * or credit. A customer's usage needs to meet the condition of at least one of the
-       * specifiers to contribute to a commit's or credit's drawdown. This field cannot
-       * be used together with `applicable_product_ids` or `applicable_product_tags`.
-       */
-      specifiers?: Array<Commit.Specifier>;
-    }
-
-    export namespace Commit {
-      export interface Specifier {
-        presentation_group_values?: { [key: string]: string };
-
-        pricing_group_values?: { [key: string]: string };
-
-        /**
-         * If provided, the specifier will only apply to the product with the specified ID.
-         */
-        product_id?: string;
-
-        /**
-         * If provided, the specifier will only apply to products with all the specified
-         * tags.
-         */
-        product_tags?: Array<string>;
-      }
-    }
-
-    export interface PaymentGateConfig {
-      /**
-       * Gate access to the commit balance based on successful collection of payment.
-       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-       * facilitate payment using your own payment integration. Select NONE if you do not
-       * wish to payment gate the commit balance.
-       */
-      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
-      /**
-       * Only applicable if using PRECALCULATED as your tax type.
-       */
-      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-      /**
-       * Only applicable if using STRIPE as your payment gate type.
-       */
-      stripe_config?: PaymentGateConfig.StripeConfig;
-
-      /**
-       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-       * will default to NONE.
-       */
-      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-    }
-
-    export namespace PaymentGateConfig {
-      /**
-       * Only applicable if using PRECALCULATED as your tax type.
-       */
-      export interface PrecalculatedTaxConfig {
-        /**
-         * Amount of tax to be applied. This should be in the same currency and
-         * denomination as the commit's invoice schedule
-         */
-        tax_amount: number;
-
-        /**
-         * Name of the tax to be applied. This may be used in an invoice line item
-         * description.
-         */
-        tax_name?: string;
-      }
+       * 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;
 
       /**
-       * Only applicable if using STRIPE as your payment gate type.
+       * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
        */
-      export interface StripeConfig {
-        /**
-         * If left blank, will default to INVOICE
-         */
-        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+      quantity?: number;
 
-        /**
-         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-         * your payment type.
-         */
-        invoice_metadata?: { [key: string]: string };
-      }
+      /**
+       * Only set for TIERED rate_type.
+       */
+      tiers?: Array<Shared.Tier>;
+    }
+
+    export interface Tier {
+      multiplier: number;
+
+      size?: number;
     }
   }
 
@@ -2514,6 +1589,9 @@ export namespace ContractCreateParams {
      */
     unit_price: number;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     description?: string;
@@ -2572,7 +1650,7 @@ export 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.
@@ -2622,7 +1700,7 @@ export 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.
@@ -2663,32 +1741,6 @@ export namespace ContractCreateParams {
       unit?: 'PERIODS';
     }
 
-    /**
-     * Optional configuration for recurring commit/credit hierarchy access control
-     */
-    export interface HierarchyConfiguration {
-      child_access:
-        | HierarchyConfiguration.CommitHierarchyChildAccessAll
-        | HierarchyConfiguration.CommitHierarchyChildAccessNone
-        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
-    }
-
-    export namespace HierarchyConfiguration {
-      export interface CommitHierarchyChildAccessAll {
-        type: 'ALL';
-      }
-
-      export interface CommitHierarchyChildAccessNone {
-        type: 'NONE';
-      }
-
-      export interface CommitHierarchyChildAccessContractIDs {
-        contract_ids: Array<string>;
-
-        type: 'CONTRACT_IDS';
-      }
-    }
-
     /**
      * The amount the customer should be billed for the commit. Not required.
      */
@@ -2700,23 +1752,6 @@ export namespace ContractCreateParams {
       unit_price: number;
     }
 
-    export interface Specifier {
-      presentation_group_values?: { [key: string]: string };
-
-      pricing_group_values?: { [key: string]: string };
-
-      /**
-       * If provided, the specifier will only apply to the product with the specified ID.
-       */
-      product_id?: string;
-
-      /**
-       * If provided, the specifier will only apply to products with all the specified
-       * tags.
-       */
-      product_tags?: Array<string>;
-    }
-
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -2731,7 +1766,7 @@ export namespace ContractCreateParams {
       /**
        * If set to POOLED, allocation added per seat is pooled across the account.
        */
-      allocation?: 'POOLED';
+      allocation?: 'INDIVIDUAL' | 'POOLED';
     }
 
     export namespace SubscriptionConfig {
@@ -2792,7 +1827,7 @@ export 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
@@ -2837,7 +1872,7 @@ export 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.
@@ -2878,49 +1913,6 @@ export namespace ContractCreateParams {
       unit?: 'PERIODS';
     }
 
-    /**
-     * Optional configuration for recurring commit/credit hierarchy access control
-     */
-    export interface HierarchyConfiguration {
-      child_access:
-        | HierarchyConfiguration.CommitHierarchyChildAccessAll
-        | HierarchyConfiguration.CommitHierarchyChildAccessNone
-        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
-    }
-
-    export namespace HierarchyConfiguration {
-      export interface CommitHierarchyChildAccessAll {
-        type: 'ALL';
-      }
-
-      export interface CommitHierarchyChildAccessNone {
-        type: 'NONE';
-      }
-
-      export interface CommitHierarchyChildAccessContractIDs {
-        contract_ids: Array<string>;
-
-        type: 'CONTRACT_IDS';
-      }
-    }
-
-    export interface Specifier {
-      presentation_group_values?: { [key: string]: string };
-
-      pricing_group_values?: { [key: string]: string };
-
-      /**
-       * If provided, the specifier will only apply to the product with the specified ID.
-       */
-      product_id?: string;
-
-      /**
-       * If provided, the specifier will only apply to products with all the specified
-       * tags.
-       */
-      product_tags?: Array<string>;
-    }
-
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -2935,7 +1927,7 @@ export namespace ContractCreateParams {
       /**
        * If set to POOLED, allocation added per seat is pooled across the account.
        */
-      allocation?: 'POOLED';
+      allocation?: 'INDIVIDUAL' | 'POOLED';
     }
 
     export namespace SubscriptionConfig {
@@ -3000,6 +1992,9 @@ export namespace ContractCreateParams {
      */
     schedule: ScheduledCharge.Schedule;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -3115,117 +2110,16 @@ export namespace ContractCreateParams {
     }
   }
 
-  export interface SpendThresholdConfiguration {
-    commit: SpendThresholdConfiguration.Commit;
-
-    /**
-     * When set to false, the contract will not be evaluated against the
-     * threshold_amount. Toggling to true will result an immediate evaluation,
-     * regardless of prior state.
-     */
-    is_enabled: boolean;
-
-    payment_gate_config: SpendThresholdConfiguration.PaymentGateConfig;
-
-    /**
-     * Specify the threshold amount for the contract. Each time the contract's usage
-     * hits this amount, a threshold charge will be initiated.
-     */
-    threshold_amount: number;
-  }
-
-  export namespace SpendThresholdConfiguration {
-    export interface Commit {
-      /**
-       * The commit product that will be used to generate the line item for commit
-       * payment.
-       */
-      product_id: string;
-
-      description?: string;
-
-      /**
-       * Specify the name of the line item for the threshold charge. If left blank, it
-       * will default to the commit product name.
-       */
-      name?: string;
-    }
-
-    export interface PaymentGateConfig {
-      /**
-       * Gate access to the commit balance based on successful collection of payment.
-       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-       * facilitate payment using your own payment integration. Select NONE if you do not
-       * wish to payment gate the commit balance.
-       */
-      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
-
-      /**
-       * Only applicable if using PRECALCULATED as your tax type.
-       */
-      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
-
-      /**
-       * Only applicable if using STRIPE as your payment gate type.
-       */
-      stripe_config?: PaymentGateConfig.StripeConfig;
-
-      /**
-       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
-       * will default to NONE.
-       */
-      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
-    }
-
-    export namespace PaymentGateConfig {
-      /**
-       * Only applicable if using PRECALCULATED as your tax type.
-       */
-      export interface PrecalculatedTaxConfig {
-        /**
-         * Amount of tax to be applied. This should be in the same currency and
-         * denomination as the commit's invoice schedule
-         */
-        tax_amount: number;
-
-        /**
-         * Name of the tax to be applied. This may be used in an invoice line item
-         * description.
-         */
-        tax_name?: string;
-      }
-
-      /**
-       * Only applicable if using STRIPE as your payment gate type.
-       */
-      export interface StripeConfig {
-        /**
-         * If left blank, will default to INVOICE
-         */
-        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
-
-        /**
-         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-         * your payment type.
-         */
-        invoice_metadata?: { [key: string]: string };
-      }
-    }
-  }
-
   export interface Subscription {
     collection_schedule: 'ADVANCE' | 'ARREARS';
 
-    /**
-     * The initial quantity for the subscription. It must be non-negative value.
-     */
-    initial_quantity: number;
-
     proration: Subscription.Proration;
 
     subscription_rate: Subscription.SubscriptionRate;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     description?: string;
@@ -3236,8 +2130,22 @@ export namespace ContractCreateParams {
      */
     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
@@ -3441,6 +2349,9 @@ export interface ContractAmendParams {
 
   credits?: Array<ContractAmendParams.Credit>;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields?: { [key: string]: string };
 
   /**
@@ -3510,6 +2421,9 @@ export namespace ContractAmendParams {
      */
     applicable_product_tags?: Array<string>;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -3520,7 +2434,7 @@ export 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
@@ -3564,7 +2478,7 @@ export 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
@@ -3604,32 +2518,6 @@ export namespace ContractAmendParams {
       }
     }
 
-    /**
-     * Optional configuration for commit hierarchy access control
-     */
-    export interface HierarchyConfiguration {
-      child_access:
-        | HierarchyConfiguration.CommitHierarchyChildAccessAll
-        | HierarchyConfiguration.CommitHierarchyChildAccessNone
-        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
-    }
-
-    export namespace HierarchyConfiguration {
-      export interface CommitHierarchyChildAccessAll {
-        type: 'ALL';
-      }
-
-      export interface CommitHierarchyChildAccessNone {
-        type: 'NONE';
-      }
-
-      export interface CommitHierarchyChildAccessContractIDs {
-        contract_ids: Array<string>;
-
-        type: 'CONTRACT_IDS';
-      }
-    }
-
     /**
      * Required for "POSTPAID" commits: the true up invoice will be generated at this
      * time and only one schedule item is allowed; the total must match access_schedule
@@ -3809,23 +2697,6 @@ export namespace ContractAmendParams {
         on_session_payment?: boolean;
       }
     }
-
-    export interface Specifier {
-      presentation_group_values?: { [key: string]: string };
-
-      pricing_group_values?: { [key: string]: string };
-
-      /**
-       * If provided, the specifier will only apply to the product with the specified ID.
-       */
-      product_id?: string;
-
-      /**
-       * If provided, the specifier will only apply to products with all the specified
-       * tags.
-       */
-      product_tags?: Array<string>;
-    }
   }
 
   export interface Credit {
@@ -3848,6 +2719,9 @@ export namespace ContractAmendParams {
      */
     applicable_product_tags?: Array<string>;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -3858,7 +2732,7 @@ export namespace ContractAmendParams {
     /**
      * Optional configuration for credit hierarchy access control
      */
-    hierarchy_configuration?: Credit.HierarchyConfiguration;
+    hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
 
     /**
      * displayed on invoices
@@ -3884,7 +2758,7 @@ export 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>;
   }
 
   export namespace Credit {
@@ -3915,49 +2789,6 @@ export namespace ContractAmendParams {
         starting_at: string;
       }
     }
-
-    /**
-     * Optional configuration for credit hierarchy access control
-     */
-    export interface HierarchyConfiguration {
-      child_access:
-        | HierarchyConfiguration.CommitHierarchyChildAccessAll
-        | HierarchyConfiguration.CommitHierarchyChildAccessNone
-        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
-    }
-
-    export namespace HierarchyConfiguration {
-      export interface CommitHierarchyChildAccessAll {
-        type: 'ALL';
-      }
-
-      export interface CommitHierarchyChildAccessNone {
-        type: 'NONE';
-      }
-
-      export interface CommitHierarchyChildAccessContractIDs {
-        contract_ids: Array<string>;
-
-        type: 'CONTRACT_IDS';
-      }
-    }
-
-    export interface Specifier {
-      presentation_group_values?: { [key: string]: string };
-
-      pricing_group_values?: { [key: string]: string };
-
-      /**
-       * If provided, the specifier will only apply to the product with the specified ID.
-       */
-      product_id?: string;
-
-      /**
-       * If provided, the specifier will only apply to products with all the specified
-       * tags.
-       */
-      product_tags?: Array<string>;
-    }
   }
 
   export interface Discount {
@@ -3968,6 +2799,9 @@ export namespace ContractAmendParams {
      */
     schedule: Discount.Schedule;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -4164,8 +2998,8 @@ export namespace ContractAmendParams {
 
       /**
        * 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>;
@@ -4195,17 +3029,17 @@ export namespace ContractAmendParams {
 
       /**
        * 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>;
     }
@@ -4274,6 +3108,9 @@ export namespace ContractAmendParams {
      */
     unit_price: number;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     description?: string;
@@ -4339,6 +3176,9 @@ export namespace ContractAmendParams {
      */
     schedule: ScheduledCharge.Schedule;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
 
     /**
@@ -4502,6 +3342,9 @@ export namespace ContractCreateHistoricalInvoicesParams {
 
     breakdown_granularity?: 'HOUR' | 'DAY';
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
   }
 
@@ -4534,7 +3377,7 @@ export namespace ContractCreateHistoricalInvoicesParams {
   }
 }
 
-export interface ContractListBalancesParams {
+export interface ContractListBalancesParams extends BodyCursorPageParams {
   customer_id: string;
 
   id?: string;
@@ -4571,16 +3414,6 @@ export interface ContractListBalancesParams {
    */
   include_ledgers?: boolean;
 
-  /**
-   * The maximum number of commits to return. Defaults to 25.
-   */
-  limit?: number;
-
-  /**
-   * The next page token from a previous response.
-   */
-  next_page?: string;
-
   /**
    * Include only balances that have any access on or after the provided date
    */
@@ -4774,9 +3607,7 @@ export interface ContractUpdateEndDateParams {
 }
 
 Contracts.Products = Products;
-Contracts.ProductListResponsesCursorPage = ProductListResponsesCursorPage;
 Contracts.RateCards = RateCards;
-Contracts.RateCardListResponsesCursorPage = RateCardListResponsesCursorPage;
 Contracts.NamedSchedules = NamedSchedules;
 
 export declare namespace Contracts {
@@ -4792,6 +3623,7 @@ export declare namespace Contracts {
     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,
@@ -4817,7 +3649,7 @@ export declare namespace Contracts {
     type ProductUpdateResponse as ProductUpdateResponse,
     type ProductListResponse as ProductListResponse,
     type ProductArchiveResponse as ProductArchiveResponse,
-    ProductListResponsesCursorPage as ProductListResponsesCursorPage,
+    type ProductListResponsesCursorPage as ProductListResponsesCursorPage,
     type ProductCreateParams as ProductCreateParams,
     type ProductRetrieveParams as ProductRetrieveParams,
     type ProductUpdateParams as ProductUpdateParams,
@@ -4833,7 +3665,7 @@ export declare namespace Contracts {
     type RateCardListResponse as RateCardListResponse,
     type RateCardArchiveResponse as RateCardArchiveResponse,
     type RateCardRetrieveRateScheduleResponse as RateCardRetrieveRateScheduleResponse,
-    RateCardListResponsesCursorPage as RateCardListResponsesCursorPage,
+    type RateCardListResponsesCursorPage as RateCardListResponsesCursorPage,
     type RateCardCreateParams as RateCardCreateParams,
     type RateCardRetrieveParams as RateCardRetrieveParams,
     type RateCardUpdateParams as RateCardUpdateParams,