@metronome/sdk 0.3.0 → 2.0.0

package/resources/v1/contracts/contracts.d.mts

@@ -0,0 +1,3006 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as Shared from "../../shared.mjs";
+import * as NamedSchedulesAPI from "./named-schedules.mjs";
+import { NamedScheduleRetrieveParams, NamedScheduleRetrieveResponse, NamedScheduleUpdateParams, NamedSchedules } from "./named-schedules.mjs";
+import * as ProductsAPI from "./products.mjs";
+import { ProductArchiveParams, ProductArchiveResponse, ProductCreateParams, ProductCreateResponse, ProductListItemState, ProductListParams, ProductListResponse, ProductListResponsesCursorPage, ProductRetrieveParams, ProductRetrieveResponse, ProductUpdateParams, ProductUpdateResponse, Products, QuantityConversion, QuantityRounding } from "./products.mjs";
+import * as InvoicesAPI from "../customers/invoices.mjs";
+import * as RateCardsAPI from "./rate-cards/rate-cards.mjs";
+import { RateCardArchiveParams, RateCardArchiveResponse, RateCardCreateParams, RateCardCreateResponse, RateCardListParams, RateCardListResponse, RateCardListResponsesCursorPage, RateCardRetrieveParams, RateCardRetrieveRateScheduleParams, RateCardRetrieveRateScheduleResponse, RateCardRetrieveResponse, RateCardUpdateParams, RateCardUpdateResponse, RateCards } from "./rate-cards/rate-cards.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Contracts extends APIResource {
+    products: ProductsAPI.Products;
+    rateCards: RateCardsAPI.RateCards;
+    namedSchedules: NamedSchedulesAPI.NamedSchedules;
+    /**
+     * 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
+     * const contract = await client.v1.contracts.create({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   starting_at: '2020-01-01T00:00:00.000Z',
+     *   billing_provider_configuration: {
+     *     billing_provider: 'stripe',
+     *     delivery_method: 'direct_to_billing_provider',
+     *   },
+     *   rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     * });
+     * ```
+     */
+    create(body: ContractCreateParams, options?: RequestOptions): APIPromise<ContractCreateResponse>;
+    /**
+     * This is the v1 endpoint to get a contract. New clients should implement using
+     * the v2 endpoint.
+     *
+     * @example
+     * ```ts
+     * const contract = await client.v1.contracts.retrieve({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     * });
+     * ```
+     */
+    retrieve(body: ContractRetrieveParams, options?: RequestOptions): APIPromise<ContractRetrieveResponse>;
+    /**
+     * 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
+     * const contracts = await client.v1.contracts.list({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
+     */
+    list(body: ContractListParams, options?: RequestOptions): APIPromise<ContractListResponse>;
+    /**
+     * 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
+     * await client.v1.contracts.addManualBalanceEntry({
+     *   id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   amount: -1000,
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   reason: 'Reason for entry',
+     *   segment_id: '66368e29-3f97-4d15-a6e9-120897f0070a',
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     * });
+     * ```
+     */
+    addManualBalanceEntry(body: ContractAddManualBalanceEntryParams, options?: 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
+     * editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and
+     * reach out to your Metronome representative for more details. Once contract
+     * editing is enabled, access to this endpoint will be removed.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.contracts.amend({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   starting_at: '2020-01-01T00:00:00.000Z',
+     * });
+     * ```
+     */
+    amend(body: ContractAmendParams, options?: RequestOptions): APIPromise<ContractAmendResponse>;
+    /**
+     * 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
+     * const response = await client.v1.contracts.archive({
+     *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   void_invoices: true,
+     * });
+     * ```
+     */
+    archive(body: ContractArchiveParams, options?: RequestOptions): APIPromise<ContractArchiveResponse>;
+    /**
+     * 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
+     * const response =
+     *   await client.v1.contracts.createHistoricalInvoices({
+     *     invoices: [
+     *       {
+     *         customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *         contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *         credit_type_id:
+     *           '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *         inclusive_start_date: '2020-01-01T00:00:00.000Z',
+     *         exclusive_end_date: '2020-02-01T00:00:00.000Z',
+     *         issue_date: '2020-02-01T00:00:00.000Z',
+     *         usage_line_items: [
+     *           {
+     *             product_id:
+     *               'f14d6729-6a44-4b13-9908-9387f1918790',
+     *             inclusive_start_date:
+     *               '2020-01-01T00:00:00.000Z',
+     *             exclusive_end_date: '2020-02-01T00:00:00.000Z',
+     *             quantity: 100,
+     *           },
+     *         ],
+     *       },
+     *     ],
+     *     preview: false,
+     *   });
+     * ```
+     */
+    createHistoricalInvoices(body: ContractCreateHistoricalInvoicesParams, options?: RequestOptions): APIPromise<ContractCreateHistoricalInvoicesResponse>;
+    /**
+     * 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
+     * // 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?: RequestOptions): PagePromise<ContractListBalancesResponsesBodyCursorPage, ContractListBalancesResponse>;
+    /**
+     * 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
+     * const response =
+     *   await client.v1.contracts.retrieveRateSchedule({
+     *     contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     at: '2020-01-01T00:00:00.000Z',
+     *     selectors: [
+     *       {
+     *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+     *         partial_pricing_group_values: {
+     *           region: 'us-west-2',
+     *           cloud: 'aws',
+     *         },
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    retrieveRateSchedule(params: ContractRetrieveRateScheduleParams, options?: RequestOptions): APIPromise<ContractRetrieveRateScheduleResponse>;
+    /**
+     * 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
+     * const response =
+     *   await client.v1.contracts.retrieveSubscriptionQuantityHistory(
+     *     {
+     *       contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *       customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *       subscription_id:
+     *         '1a824d53-bde6-4d82-96d7-6347ff227d5c',
+     *     },
+     *   );
+     * ```
+     */
+    retrieveSubscriptionQuantityHistory(body: ContractRetrieveSubscriptionQuantityHistoryParams, options?: 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.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.scheduleProServicesInvoice({
+     *     contract_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     customer_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     issued_at: '2019-12-27T18:11:19.117Z',
+     *     line_items: [
+     *       {
+     *         professional_service_id:
+     *           '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    scheduleProServicesInvoice(body: ContractScheduleProServicesInvoiceParams, options?: RequestOptions): APIPromise<ContractScheduleProServicesInvoiceResponse>;
+    /**
+     * 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>;
+    /**
+     * Update or add 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. In-advance subscriptions will not
+     * be 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>;
+}
+export type ContractListBalancesResponsesBodyCursorPage = BodyCursorPage<ContractListBalancesResponse>;
+export interface ContractCreateResponse {
+    data: Shared.ID;
+}
+export interface ContractRetrieveResponse {
+    data: Shared.Contract;
+}
+export interface ContractListResponse {
+    data: Array<Shared.Contract>;
+}
+export interface ContractAmendResponse {
+    data: Shared.ID;
+}
+export interface ContractArchiveResponse {
+    data: Shared.ID;
+}
+export interface ContractCreateHistoricalInvoicesResponse {
+    data: Array<InvoicesAPI.Invoice>;
+}
+export type ContractListBalancesResponse = Shared.Commit | Shared.Credit;
+export interface ContractRetrieveRateScheduleResponse {
+    data: Array<ContractRetrieveRateScheduleResponse.Data>;
+    next_page?: string | null;
+}
+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;
+        };
+        product_id: string;
+        product_name: string;
+        product_tags: Array<string>;
+        rate_card_id: string;
+        starting_at: string;
+        billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        /**
+         * A distinct rate on the rate card. You can choose to use this rate rather than
+         * list rate when consuming a credit or commit.
+         */
+        commit_rate?: Shared.CommitRate;
+        ending_before?: string;
+        override_rate?: Shared.Rate;
+        pricing_group_values?: {
+            [key: string]: string;
+        };
+    }
+}
+export interface ContractRetrieveSubscriptionQuantityHistoryResponse {
+    data: ContractRetrieveSubscriptionQuantityHistoryResponse.Data;
+}
+export declare namespace ContractRetrieveSubscriptionQuantityHistoryResponse {
+    interface Data {
+        fiat_credit_type_id?: string;
+        history?: Array<Data.History>;
+        subscription_id?: string;
+    }
+    namespace Data {
+        interface History {
+            data: Array<History.Data>;
+            starting_at: string;
+        }
+        namespace History {
+            interface Data {
+                quantity: number;
+                total: number;
+                unit_price: number;
+            }
+        }
+    }
+}
+export interface ContractScheduleProServicesInvoiceResponse {
+    data: Array<InvoicesAPI.Invoice>;
+}
+export interface ContractUpdateEndDateResponse {
+    data: Shared.ID;
+}
+export interface ContractCreateParams {
+    customer_id: string;
+    /**
+     * inclusive contract start time
+     */
+    starting_at: string;
+    /**
+     * The billing provider configuration associated with a contract. Provide either an
+     * ID or the provider and delivery method.
+     */
+    billing_provider_configuration?: ContractCreateParams.BillingProviderConfiguration;
+    commits?: Array<ContractCreateParams.Commit>;
+    credits?: Array<ContractCreateParams.Credit>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: {
+        [key: string]: string;
+    };
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    discounts?: Array<ContractCreateParams.Discount>;
+    /**
+     * exclusive contract end time
+     */
+    ending_before?: string;
+    hierarchy_configuration?: ContractCreateParams.HierarchyConfiguration;
+    /**
+     * Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
+     * prices automatically. EXPLICIT prioritization requires specifying priorities for
+     * each multiplier; the one with the lowest priority value will be prioritized
+     * first. If tiered overrides are used, prioritization must be explicit.
+     */
+    multiplier_override_prioritization?: 'LOWEST_MULTIPLIER' | 'EXPLICIT';
+    name?: string;
+    net_payment_terms_days?: number;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    netsuite_sales_order_id?: string;
+    overrides?: Array<ContractCreateParams.Override>;
+    prepaid_balance_threshold_configuration?: Shared.PrepaidBalanceThresholdConfiguration;
+    /**
+     * Priority of the contract.
+     */
+    priority?: number;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    professional_services?: Array<ContractCreateParams.ProfessionalService>;
+    /**
+     * Selects the rate card linked to the specified alias as of the contract's start
+     * date.
+     */
+    rate_card_alias?: string;
+    rate_card_id?: string;
+    recurring_commits?: Array<ContractCreateParams.RecurringCommit>;
+    recurring_credits?: Array<ContractCreateParams.RecurringCredit>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    reseller_royalties?: Array<ContractCreateParams.ResellerRoyalty>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    salesforce_opportunity_id?: string;
+    scheduled_charges?: Array<ContractCreateParams.ScheduledCharge>;
+    /**
+     * 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?: Shared.SpendThresholdConfiguration;
+    /**
+     * Optional list of
+     * [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
+     * to add to the contract.
+     */
+    subscriptions?: Array<ContractCreateParams.Subscription>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    total_contract_value?: number;
+    transition?: ContractCreateParams.Transition;
+    /**
+     * 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;
+    usage_filter?: Shared.BaseUsageFilter;
+    usage_statement_schedule?: ContractCreateParams.UsageStatementSchedule;
+}
+export declare namespace ContractCreateParams {
+    /**
+     * The billing provider configuration associated with a contract. Provide either an
+     * ID or the provider and delivery method.
+     */
+    interface BillingProviderConfiguration {
+        /**
+         * Do not specify if using billing_provider_configuration_id.
+         */
+        billing_provider?: 'aws_marketplace' | 'azure_marketplace' | 'gcp_marketplace' | 'stripe' | 'netsuite';
+        /**
+         * The Metronome ID of the billing provider configuration. Use when a customer has
+         * multiple configurations with the same billing provider and delivery method.
+         * Otherwise, specify the billing_provider and delivery_method.
+         */
+        billing_provider_configuration_id?: string;
+        /**
+         * Do not specify if using billing_provider_configuration_id.
+         */
+        delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+    }
+    interface Commit {
+        product_id: string;
+        type: 'PREPAID' | 'POSTPAID';
+        /**
+         * Required: Schedule for distributing the commit to the customer. For "POSTPAID"
+         * commits only one schedule item is allowed and amount must match invoice_schedule
+         * total.
+         */
+        access_schedule?: Commit.AccessSchedule;
+        /**
+         * (DEPRECATED) Use access_schedule and invoice_schedule instead.
+         */
+        amount?: number;
+        /**
+         * Which products the commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Which tags the commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_tags?: Array<string>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
+        /**
+         * Used only in UI/API. It is not exposed to end customers.
+         */
+        description?: string;
+        /**
+         * Optional configuration for commit hierarchy access control
+         */
+        hierarchy_configuration?: 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
+         * amount. Optional for "PREPAID" commits: if not provided, this will be a
+         * "complimentary" commit with no invoice.
+         */
+        invoice_schedule?: Commit.InvoiceSchedule;
+        /**
+         * displayed on invoices
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+        /**
+         * optionally payment gate this commit
+         */
+        payment_gate_config?: Commit.PaymentGateConfig;
+        /**
+         * If multiple commits are applicable, the one with the lower priority will apply
+         * first.
+         */
+        priority?: number;
+        rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * Fraction of unused segments that will be rolled over. Must be between 0 and 1.
+         */
+        rollover_fraction?: number;
+        /**
+         * List of filters that determine what kind of customer usage draws down a commit
+         * or credit. A customer's usage needs to meet the condition of at least one of the
+         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+         * be used together with `applicable_product_ids` or `applicable_product_tags`.
+         */
+        specifiers?: Array<Shared.CommitSpecifierInput>;
+        /**
+         * A temporary ID for the commit that can be used to reference the commit for
+         * commit specific overrides.
+         */
+        temporary_id?: string;
+    }
+    namespace Commit {
+        /**
+         * Required: Schedule for distributing the commit to the customer. For "POSTPAID"
+         * commits only one schedule item is allowed and amount must match invoice_schedule
+         * total.
+         */
+        interface AccessSchedule {
+            schedule_items: Array<AccessSchedule.ScheduleItem>;
+            /**
+             * Defaults to USD (cents) if not passed
+             */
+            credit_type_id?: string;
+        }
+        namespace AccessSchedule {
+            interface ScheduleItem {
+                amount: number;
+                /**
+                 * RFC 3339 timestamp (exclusive)
+                 */
+                ending_before: string;
+                /**
+                 * RFC 3339 timestamp (inclusive)
+                 */
+                starting_at: string;
+            }
+        }
+        /**
+         * 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
+         * amount. Optional for "PREPAID" commits: if not provided, this will be a
+         * "complimentary" commit with no invoice.
+         */
+        interface InvoiceSchedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            recurring_schedule?: InvoiceSchedule.RecurringSchedule;
+            /**
+             * Either provide amount or provide both unit_price and quantity.
+             */
+            schedule_items?: Array<InvoiceSchedule.ScheduleItem>;
+        }
+        namespace InvoiceSchedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            interface RecurringSchedule {
+                amount_distribution: 'DIVIDED' | 'DIVIDED_ROUNDED' | 'EACH';
+                /**
+                 * RFC 3339 timestamp (exclusive).
+                 */
+                ending_before: string;
+                frequency: 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL';
+                /**
+                 * RFC 3339 timestamp (inclusive).
+                 */
+                starting_at: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+            interface ScheduleItem {
+                /**
+                 * timestamp of the scheduled event
+                 */
+                timestamp: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+        }
+        /**
+         * optionally payment gate this commit
+         */
+        interface PaymentGateConfig {
+            /**
+             * Gate access to the commit balance based on successful collection of payment.
+             * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+             * facilitate payment using your own payment integration. Select NONE if you do not
+             * wish to payment gate the commit balance.
+             */
+            payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+            /**
+             * Only applicable if using PRECALCULATED as your tax type.
+             */
+            precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+            /**
+             * Only applicable if using STRIPE as your payment gate type.
+             */
+            stripe_config?: PaymentGateConfig.StripeConfig;
+            /**
+             * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+             * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+             * will default to NONE.
+             */
+            tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'AVALARA' | '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;
+                };
+                /**
+                 * 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 Credit {
+        /**
+         * Schedule for distributing the credit to the customer.
+         */
+        access_schedule: Credit.AccessSchedule;
+        product_id: string;
+        /**
+         * Which products the credit applies to. If both applicable_product_ids and
+         * applicable_product_tags are not provided, the credit applies to all products.
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Which tags the credit applies to. If both applicable_product_ids and
+         * 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;
+        };
+        /**
+         * Used only in UI/API. It is not exposed to end customers.
+         */
+        description?: string;
+        /**
+         * Optional configuration for credit hierarchy access control
+         */
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+        /**
+         * displayed on invoices
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+        /**
+         * If multiple credits are applicable, the one with the lower priority will apply
+         * first.
+         */
+        priority?: number;
+        rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * List of filters that determine what kind of customer usage draws down a commit
+         * or credit. A customer's usage needs to meet the condition of at least one of the
+         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+         * be used together with `applicable_product_ids` or `applicable_product_tags`.
+         */
+        specifiers?: Array<Shared.CommitSpecifierInput>;
+    }
+    namespace Credit {
+        /**
+         * Schedule for distributing the credit to the customer.
+         */
+        interface AccessSchedule {
+            schedule_items: Array<AccessSchedule.ScheduleItem>;
+            /**
+             * Defaults to USD (cents) if not passed
+             */
+            credit_type_id?: string;
+        }
+        namespace AccessSchedule {
+            interface ScheduleItem {
+                amount: number;
+                /**
+                 * RFC 3339 timestamp (exclusive)
+                 */
+                ending_before: string;
+                /**
+                 * RFC 3339 timestamp (inclusive)
+                 */
+                starting_at: string;
+            }
+        }
+    }
+    interface Discount {
+        product_id: string;
+        /**
+         * 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;
+        };
+        /**
+         * displayed on invoices
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+    }
+    namespace Discount {
+        /**
+         * Must provide either schedule_items or recurring_schedule.
+         */
+        interface Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            recurring_schedule?: Schedule.RecurringSchedule;
+            /**
+             * Either provide amount or provide both unit_price and quantity.
+             */
+            schedule_items?: Array<Schedule.ScheduleItem>;
+        }
+        namespace Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            interface RecurringSchedule {
+                amount_distribution: 'DIVIDED' | 'DIVIDED_ROUNDED' | 'EACH';
+                /**
+                 * RFC 3339 timestamp (exclusive).
+                 */
+                ending_before: string;
+                frequency: 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL';
+                /**
+                 * RFC 3339 timestamp (inclusive).
+                 */
+                starting_at: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+            interface ScheduleItem {
+                /**
+                 * timestamp of the scheduled event
+                 */
+                timestamp: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+        }
+    }
+    interface HierarchyConfiguration {
+        parent?: HierarchyConfiguration.Parent;
+        parent_behavior?: HierarchyConfiguration.ParentBehavior;
+        /**
+         * Indicates whether the parent should pay for the child's invoice charges
+         */
+        payer?: 'SELF' | 'PARENT';
+        /**
+         * Indicates the behavior of the child's invoice statements on the parent's
+         * invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
+         * consolidated invoices **SEPARATE**: Child's invoice statements will appear not
+         * appear on parent's consolidated invoices
+         */
+        usage_statement_behavior?: 'CONSOLIDATE' | 'SEPARATE';
+    }
+    namespace HierarchyConfiguration {
+        interface Parent {
+            contract_id: string;
+            customer_id: string;
+        }
+        interface ParentBehavior {
+            /**
+             * Indicates the desired behavior of consolidated invoices generated by the parent
+             * in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
+             * customers will be appended to the consolidated invoice **NONE**: Do not generate
+             * consolidated invoices
+             */
+            invoice_consolidation_type?: 'CONCATENATE' | 'NONE';
+        }
+    }
+    interface Override {
+        /**
+         * RFC 3339 timestamp indicating when the override will start applying (inclusive)
+         */
+        starting_at: string;
+        /**
+         * tags identifying products whose rates are being overridden. Cannot be used in
+         * conjunction with override_specifiers.
+         */
+        applicable_product_tags?: Array<string>;
+        /**
+         * RFC 3339 timestamp indicating when the override will stop applying (exclusive)
+         */
+        ending_before?: string;
+        entitled?: boolean;
+        /**
+         * Indicates whether the override should only apply to commits. Defaults to
+         * `false`. If `true`, you can specify relevant commits in `override_specifiers` by
+         * passing `commit_ids`. if you do not specify `commit_ids`, then the override will
+         * apply when consuming any prepaid or postpaid commit.
+         */
+        is_commit_specific?: boolean;
+        /**
+         * Required for MULTIPLIER type. Must be >=0.
+         */
+        multiplier?: number;
+        /**
+         * Cannot be used in conjunction with product_id or applicable_product_tags. If
+         * provided, the override will apply to all products with the specified specifiers.
+         */
+        override_specifiers?: Array<Override.OverrideSpecifier>;
+        /**
+         * Required for OVERWRITE type.
+         */
+        overwrite_rate?: Override.OverwriteRate;
+        /**
+         * Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
+         * Under EXPLICIT prioritization, overwrites are prioritized first, and then tiered
+         * and multiplier overrides are prioritized by their priority value (lowest first).
+         * Must be > 0.
+         */
+        priority?: number;
+        /**
+         * ID of the product whose rate is being overridden. Cannot be used in conjunction
+         * with override_specifiers.
+         */
+        product_id?: string;
+        /**
+         * Indicates whether the override applies to commit rates or list rates. Can only
+         * be used for overrides that have `is_commit_specific` set to `true`. Defaults to
+         * `"LIST_RATE"`.
+         */
+        target?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * Required for TIERED type. Must have at least one tier.
+         */
+        tiers?: Array<Override.Tier>;
+        /**
+         * Overwrites are prioritized over multipliers and tiered overrides.
+         */
+        type?: 'OVERWRITE' | 'MULTIPLIER' | 'TIERED';
+    }
+    namespace Override {
+        interface OverrideSpecifier {
+            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
+             * specified commits. If not provided, the override will apply to all commits.
+             */
+            commit_ids?: Array<string>;
+            /**
+             * A map of group names to values. The override will only apply to line items with
+             * the specified presentation group values.
+             */
+            presentation_group_values?: {
+                [key: string]: string;
+            };
+            /**
+             * A map of pricing group names to values. The override will only apply to products
+             * with the specified pricing group values.
+             */
+            pricing_group_values?: {
+                [key: string]: string;
+            };
+            /**
+             * If provided, the override will only apply to the product with the specified ID.
+             */
+            product_id?: string;
+            /**
+             * If provided, the override will only apply to products with all the specified
+             * tags.
+             */
+            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.
+             */
+            recurring_commit_ids?: Array<string>;
+            /**
+             * Can only be used for commit specific overrides. Must be used in conjunction with
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to
+             * credits created by the specified recurring credit ids.
+             */
+            recurring_credit_ids?: Array<string>;
+        }
+        /**
+         * Required for OVERWRITE type.
+         */
+        interface OverwriteRate {
+            rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+            credit_type_id?: string;
+            /**
+             * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+             * processors.
+             */
+            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 ProfessionalService {
+        /**
+         * Maximum amount for the term.
+         */
+        max_amount: number;
+        product_id: string;
+        /**
+         * Quantity for the charge. Will be multiplied by unit_price to determine the
+         * amount.
+         */
+        quantity: number;
+        /**
+         * Unit price for the charge. Will be multiplied by quantity to determine the
+         * amount and must be specified.
+         */
+        unit_price: number;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
+        description?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+    }
+    interface RecurringCommit {
+        /**
+         * The amount of commit to grant.
+         */
+        access_amount: RecurringCommit.AccessAmount;
+        /**
+         * Defines the length of the access schedule for each created commit/credit. The
+         * value represents the number of units. Unit defaults to "PERIODS", where the
+         * length of a period is determined by the recurrence_frequency.
+         */
+        commit_duration: RecurringCommit.CommitDuration;
+        /**
+         * Will be passed down to the individual commits
+         */
+        priority: number;
+        product_id: string;
+        /**
+         * determines the start time for the first commit
+         */
+        starting_at: string;
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_tags?: Array<string>;
+        /**
+         * Will be passed down to the individual commits
+         */
+        description?: string;
+        /**
+         * Determines when the contract will stop creating recurring commits. optional
+         */
+        ending_before?: string;
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+        /**
+         * The amount the customer should be billed for the commit. Not required.
+         */
+        invoice_amount?: RecurringCommit.InvoiceAmount;
+        /**
+         * displayed on invoices. will be passed through to the individual commits
+         */
+        name?: string;
+        /**
+         * Will be passed down to the individual commits
+         */
+        netsuite_sales_order_id?: string;
+        /**
+         * Determines whether the first and last commit will be prorated. If not provided,
+         * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
+         */
+        proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
+        /**
+         * Whether the created commits will use the commit rate or list rate
+         */
+        rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * The frequency at which the recurring commits will be created. If not provided: -
+         * The commits will be created on the usage invoice frequency. If provided: - The
+         * period defined in the duration will correspond to this frequency. - Commits will
+         * be created aligned with the recurring commit's starting_at rather than the usage
+         * invoice dates.
+         */
+        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        /**
+         * Will be passed down to the individual commits. This controls how much of an
+         * individual unexpired commit will roll over upon contract transition. Must be
+         * between 0 and 1.
+         */
+        rollover_fraction?: number;
+        /**
+         * List of filters that determine what kind of customer usage draws down a commit
+         * or credit. A customer's usage needs to meet the condition of at least one of the
+         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+         * be used together with `applicable_product_ids` or `applicable_product_tags`.
+         */
+        specifiers?: Array<Shared.CommitSpecifierInput>;
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        subscription_config?: RecurringCommit.SubscriptionConfig;
+        /**
+         * A temporary ID that can be used to reference the recurring commit for commit
+         * specific overrides.
+         */
+        temporary_id?: string;
+    }
+    namespace RecurringCommit {
+        /**
+         * The amount of commit to grant.
+         */
+        interface AccessAmount {
+            credit_type_id: string;
+            unit_price: number;
+            /**
+             * This field is required unless a subscription is attached via
+             * `subscription_config`.
+             */
+            quantity?: number;
+        }
+        /**
+         * Defines the length of the access schedule for each created commit/credit. The
+         * value represents the number of units. Unit defaults to "PERIODS", where the
+         * length of a period is determined by the recurrence_frequency.
+         */
+        interface CommitDuration {
+            value: number;
+            unit?: 'PERIODS';
+        }
+        /**
+         * The amount the customer should be billed for the commit. Not required.
+         */
+        interface InvoiceAmount {
+            credit_type_id: string;
+            quantity: number;
+            unit_price: number;
+        }
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        interface SubscriptionConfig {
+            apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+            /**
+             * ID of the subscription to configure on the recurring commit/credit.
+             */
+            subscription_id: string;
+            /**
+             * If set to POOLED, allocation added per seat is pooled across the account.
+             */
+            allocation?: 'INDIVIDUAL' | 'POOLED';
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
+        }
+    }
+    interface RecurringCredit {
+        /**
+         * The amount of commit to grant.
+         */
+        access_amount: RecurringCredit.AccessAmount;
+        /**
+         * Defines the length of the access schedule for each created commit/credit. The
+         * value represents the number of units. Unit defaults to "PERIODS", where the
+         * length of a period is determined by the recurrence_frequency.
+         */
+        commit_duration: RecurringCredit.CommitDuration;
+        /**
+         * Will be passed down to the individual commits
+         */
+        priority: number;
+        product_id: string;
+        /**
+         * determines the start time for the first commit
+         */
+        starting_at: string;
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Will be passed down to the individual commits
+         */
+        applicable_product_tags?: Array<string>;
+        /**
+         * Will be passed down to the individual commits
+         */
+        description?: string;
+        /**
+         * Determines when the contract will stop creating recurring commits. optional
+         */
+        ending_before?: string;
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+        /**
+         * displayed on invoices. will be passed through to the individual commits
+         */
+        name?: string;
+        /**
+         * Will be passed down to the individual commits
+         */
+        netsuite_sales_order_id?: string;
+        /**
+         * Determines whether the first and last commit will be prorated. If not provided,
+         * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
+         */
+        proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
+        /**
+         * Whether the created commits will use the commit rate or list rate
+         */
+        rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * The frequency at which the recurring commits will be created. If not provided: -
+         * The commits will be created on the usage invoice frequency. If provided: - The
+         * period defined in the duration will correspond to this frequency. - Commits will
+         * be created aligned with the recurring commit's starting_at rather than the usage
+         * invoice dates.
+         */
+        recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        /**
+         * Will be passed down to the individual commits. This controls how much of an
+         * individual unexpired commit will roll over upon contract transition. Must be
+         * between 0 and 1.
+         */
+        rollover_fraction?: number;
+        /**
+         * List of filters that determine what kind of customer usage draws down a commit
+         * or credit. A customer's usage needs to meet the condition of at least one of the
+         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+         * be used together with `applicable_product_ids` or `applicable_product_tags`.
+         */
+        specifiers?: Array<Shared.CommitSpecifierInput>;
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        subscription_config?: RecurringCredit.SubscriptionConfig;
+        /**
+         * A temporary ID that can be used to reference the recurring commit for commit
+         * specific overrides.
+         */
+        temporary_id?: string;
+    }
+    namespace RecurringCredit {
+        /**
+         * The amount of commit to grant.
+         */
+        interface AccessAmount {
+            credit_type_id: string;
+            unit_price: number;
+            /**
+             * This field is required unless a subscription is attached via
+             * `subscription_config`.
+             */
+            quantity?: number;
+        }
+        /**
+         * Defines the length of the access schedule for each created commit/credit. The
+         * value represents the number of units. Unit defaults to "PERIODS", where the
+         * length of a period is determined by the recurrence_frequency.
+         */
+        interface CommitDuration {
+            value: number;
+            unit?: 'PERIODS';
+        }
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        interface SubscriptionConfig {
+            apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+            /**
+             * ID of the subscription to configure on the recurring commit/credit.
+             */
+            subscription_id: string;
+            /**
+             * If set to POOLED, allocation added per seat is pooled across the account.
+             */
+            allocation?: 'INDIVIDUAL' | 'POOLED';
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
+        }
+    }
+    interface ResellerRoyalty {
+        fraction: number;
+        netsuite_reseller_id: string;
+        reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
+        starting_at: string;
+        /**
+         * Must provide at least one of applicable_product_ids or applicable_product_tags.
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Must provide at least one of applicable_product_ids or applicable_product_tags.
+         */
+        applicable_product_tags?: Array<string>;
+        aws_options?: ResellerRoyalty.AwsOptions;
+        ending_before?: string;
+        gcp_options?: ResellerRoyalty.GcpOptions;
+        reseller_contract_value?: number;
+    }
+    namespace ResellerRoyalty {
+        interface AwsOptions {
+            aws_account_number?: string;
+            aws_offer_id?: string;
+            aws_payer_reference_id?: string;
+        }
+        interface GcpOptions {
+            gcp_account_id?: string;
+            gcp_offer_id?: string;
+        }
+    }
+    interface ScheduledCharge {
+        product_id: string;
+        /**
+         * 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
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+    }
+    namespace ScheduledCharge {
+        /**
+         * Must provide either schedule_items or recurring_schedule.
+         */
+        interface Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            recurring_schedule?: Schedule.RecurringSchedule;
+            /**
+             * Either provide amount or provide both unit_price and quantity.
+             */
+            schedule_items?: Array<Schedule.ScheduleItem>;
+        }
+        namespace Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            interface RecurringSchedule {
+                amount_distribution: 'DIVIDED' | 'DIVIDED_ROUNDED' | 'EACH';
+                /**
+                 * RFC 3339 timestamp (exclusive).
+                 */
+                ending_before: string;
+                frequency: 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL';
+                /**
+                 * RFC 3339 timestamp (inclusive).
+                 */
+                starting_at: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+            interface ScheduleItem {
+                /**
+                 * timestamp of the scheduled event
+                 */
+                timestamp: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+        }
+    }
+    interface Subscription {
+        collection_schedule: 'ADVANCE' | 'ARREARS';
+        proration: Subscription.Proration;
+        subscription_rate: Subscription.SubscriptionRate;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
+        description?: string;
+        /**
+         * Exclusive end time for the subscription. If not provided, subscription inherits
+         * 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
+         */
+        starting_at?: string;
+        /**
+         * A temporary ID used to reference the subscription in recurring commit/credit
+         * subscription configs created within the same payload.
+         */
+        temporary_id?: string;
+    }
+    namespace Subscription {
+        interface Proration {
+            /**
+             * Indicates how mid-period quantity adjustments are invoiced.
+             * **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+             * quantity increase will be billed immediately on the scheduled date.
+             * **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+             * in-arrears at the end of the period.
+             */
+            invoice_behavior?: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
+            /**
+             * Indicates if the partial period will be prorated or charged a full amount.
+             */
+            is_prorated?: boolean;
+        }
+        interface SubscriptionRate {
+            /**
+             * Frequency to bill subscription with. Together with product_id, must match
+             * existing rate on the rate card.
+             */
+            billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+            /**
+             * Must be subscription type product
+             */
+            product_id: string;
+        }
+    }
+    interface Transition {
+        from_contract_id: string;
+        /**
+         * This field's available values may vary based on your client's configuration.
+         */
+        type: 'SUPERSEDE' | 'RENEWAL';
+        future_invoice_behavior?: Transition.FutureInvoiceBehavior;
+    }
+    namespace Transition {
+        interface FutureInvoiceBehavior {
+            /**
+             * Controls whether future trueup invoices are billed or removed. Default behavior
+             * is AS_IS if not specified.
+             */
+            trueup?: 'REMOVE' | 'AS_IS' | null;
+        }
+    }
+    interface UsageStatementSchedule {
+        frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        /**
+         * Required when using CUSTOM_DATE. This option lets you set a historical billing
+         * anchor date, aligning future billing cycles with a chosen cadence. For example,
+         * if a contract starts on 2024-09-15 and you set the anchor date to 2024-09-10
+         * with a MONTHLY frequency, the first usage statement will cover 09-15 to 10-10.
+         * Subsequent statements will follow the 10th of each month.
+         */
+        billing_anchor_date?: string;
+        /**
+         * If not provided, defaults to the first day of the month.
+         */
+        day?: 'FIRST_OF_MONTH' | 'CONTRACT_START' | 'CUSTOM_DATE';
+        /**
+         * The date Metronome should start generating usage invoices. If unspecified,
+         * contract start date will be used. This is useful to set if you want to import
+         * historical invoices via our 'Create Historical Invoices' API rather than having
+         * Metronome automatically generate them.
+         */
+        invoice_generation_starting_at?: string;
+    }
+}
+export interface ContractRetrieveParams {
+    contract_id: string;
+    customer_id: string;
+    /**
+     * Include the balance of credits and commits in the response. Setting this flag
+     * may cause the query to be slower.
+     */
+    include_balance?: boolean;
+    /**
+     * Include commit ledgers in the response. Setting this flag may cause the query to
+     * be slower.
+     */
+    include_ledgers?: boolean;
+}
+export interface ContractListParams {
+    customer_id: string;
+    /**
+     * Optional RFC 3339 timestamp. If provided, the response will include only
+     * contracts effective on the provided date. This cannot be provided if the
+     * starting_at filter is provided.
+     */
+    covering_date?: string;
+    /**
+     * Include archived contracts in the response
+     */
+    include_archived?: boolean;
+    /**
+     * Include the balance of credits and commits in the response. Setting this flag
+     * may cause the query to be slower.
+     */
+    include_balance?: boolean;
+    /**
+     * Include commit ledgers in the response. Setting this flag may cause the query to
+     * be slower.
+     */
+    include_ledgers?: boolean;
+    /**
+     * Optional RFC 3339 timestamp. If provided, the response will include only
+     * contracts where effective_at is on or after the provided date. This cannot be
+     * provided if the covering_date filter is provided.
+     */
+    starting_at?: string;
+}
+export interface ContractAddManualBalanceEntryParams {
+    /**
+     * ID of the balance (commit or credit) to update.
+     */
+    id: string;
+    /**
+     * Amount to add to the segment. A negative number will draw down from the balance.
+     */
+    amount: number;
+    /**
+     * ID of the customer whose balance is to be updated.
+     */
+    customer_id: string;
+    /**
+     * Reason for the manual adjustment. This will be displayed in the ledger.
+     */
+    reason: string;
+    /**
+     * ID of the segment to update.
+     */
+    segment_id: string;
+    /**
+     * ID of the contract to update. Leave blank to update a customer level balance.
+     */
+    contract_id?: string;
+    /**
+     * RFC 3339 timestamp indicating when the manual adjustment takes place. If not
+     * provided, it will default to the start of the segment.
+     */
+    timestamp?: string;
+}
+export interface ContractAmendParams {
+    /**
+     * ID of the contract to amend
+     */
+    contract_id: string;
+    /**
+     * ID of the customer whose contract is to be amended
+     */
+    customer_id: string;
+    /**
+     * inclusive start time for the amendment
+     */
+    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;
+    };
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    discounts?: Array<ContractAmendParams.Discount>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    netsuite_sales_order_id?: string;
+    overrides?: Array<ContractAmendParams.Override>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    professional_services?: Array<ContractAmendParams.ProfessionalService>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    reseller_royalties?: Array<ContractAmendParams.ResellerRoyalty>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    salesforce_opportunity_id?: string;
+    scheduled_charges?: Array<ContractAmendParams.ScheduledCharge>;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    total_contract_value?: number;
+}
+export declare namespace ContractAmendParams {
+    interface Commit {
+        product_id: string;
+        type: 'PREPAID' | 'POSTPAID';
+        /**
+         * Required: Schedule for distributing the commit to the customer. For "POSTPAID"
+         * commits only one schedule item is allowed and amount must match invoice_schedule
+         * total.
+         */
+        access_schedule?: Commit.AccessSchedule;
+        /**
+         * (DEPRECATED) Use access_schedule and invoice_schedule instead.
+         */
+        amount?: number;
+        /**
+         * Which products the commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Which tags the commit applies to. If applicable_product_ids,
+         * applicable_product_tags or specifiers are not provided, the commit applies to
+         * all products.
+         */
+        applicable_product_tags?: Array<string>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
+        /**
+         * Used only in UI/API. It is not exposed to end customers.
+         */
+        description?: string;
+        /**
+         * Optional configuration for commit hierarchy access control
+         */
+        hierarchy_configuration?: 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
+         * amount. Optional for "PREPAID" commits: if not provided, this will be a
+         * "complimentary" commit with no invoice.
+         */
+        invoice_schedule?: Commit.InvoiceSchedule;
+        /**
+         * displayed on invoices
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+        /**
+         * optionally payment gate this commit
+         */
+        payment_gate_config?: Commit.PaymentGateConfig;
+        /**
+         * If multiple commits are applicable, the one with the lower priority will apply
+         * first.
+         */
+        priority?: number;
+        rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * Fraction of unused segments that will be rolled over. Must be between 0 and 1.
+         */
+        rollover_fraction?: number;
+        /**
+         * List of filters that determine what kind of customer usage draws down a commit
+         * or credit. A customer's usage needs to meet the condition of at least one of the
+         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+         * be used together with `applicable_product_ids` or `applicable_product_tags`.
+         */
+        specifiers?: Array<Shared.CommitSpecifierInput>;
+        /**
+         * A temporary ID for the commit that can be used to reference the commit for
+         * commit specific overrides.
+         */
+        temporary_id?: string;
+    }
+    namespace Commit {
+        /**
+         * Required: Schedule for distributing the commit to the customer. For "POSTPAID"
+         * commits only one schedule item is allowed and amount must match invoice_schedule
+         * total.
+         */
+        interface AccessSchedule {
+            schedule_items: Array<AccessSchedule.ScheduleItem>;
+            /**
+             * Defaults to USD (cents) if not passed
+             */
+            credit_type_id?: string;
+        }
+        namespace AccessSchedule {
+            interface ScheduleItem {
+                amount: number;
+                /**
+                 * RFC 3339 timestamp (exclusive)
+                 */
+                ending_before: string;
+                /**
+                 * RFC 3339 timestamp (inclusive)
+                 */
+                starting_at: string;
+            }
+        }
+        /**
+         * 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
+         * amount. Optional for "PREPAID" commits: if not provided, this will be a
+         * "complimentary" commit with no invoice.
+         */
+        interface InvoiceSchedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            recurring_schedule?: InvoiceSchedule.RecurringSchedule;
+            /**
+             * Either provide amount or provide both unit_price and quantity.
+             */
+            schedule_items?: Array<InvoiceSchedule.ScheduleItem>;
+        }
+        namespace InvoiceSchedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            interface RecurringSchedule {
+                amount_distribution: 'DIVIDED' | 'DIVIDED_ROUNDED' | 'EACH';
+                /**
+                 * RFC 3339 timestamp (exclusive).
+                 */
+                ending_before: string;
+                frequency: 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL';
+                /**
+                 * RFC 3339 timestamp (inclusive).
+                 */
+                starting_at: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+            interface ScheduleItem {
+                /**
+                 * timestamp of the scheduled event
+                 */
+                timestamp: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+        }
+        /**
+         * optionally payment gate this commit
+         */
+        interface PaymentGateConfig {
+            /**
+             * Gate access to the commit balance based on successful collection of payment.
+             * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+             * facilitate payment using your own payment integration. Select NONE if you do not
+             * wish to payment gate the commit balance.
+             */
+            payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+            /**
+             * Only applicable if using PRECALCULATED as your tax type.
+             */
+            precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+            /**
+             * Only applicable if using STRIPE as your payment gate type.
+             */
+            stripe_config?: PaymentGateConfig.StripeConfig;
+            /**
+             * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+             * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+             * will default to NONE.
+             */
+            tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'AVALARA' | '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;
+                };
+                /**
+                 * 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 Credit {
+        /**
+         * Schedule for distributing the credit to the customer.
+         */
+        access_schedule: Credit.AccessSchedule;
+        product_id: string;
+        /**
+         * Which products the credit applies to. If both applicable_product_ids and
+         * applicable_product_tags are not provided, the credit applies to all products.
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Which tags the credit applies to. If both applicable_product_ids and
+         * 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;
+        };
+        /**
+         * Used only in UI/API. It is not exposed to end customers.
+         */
+        description?: string;
+        /**
+         * Optional configuration for credit hierarchy access control
+         */
+        hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+        /**
+         * displayed on invoices
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+        /**
+         * If multiple credits are applicable, the one with the lower priority will apply
+         * first.
+         */
+        priority?: number;
+        rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * List of filters that determine what kind of customer usage draws down a commit
+         * or credit. A customer's usage needs to meet the condition of at least one of the
+         * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+         * be used together with `applicable_product_ids` or `applicable_product_tags`.
+         */
+        specifiers?: Array<Shared.CommitSpecifierInput>;
+    }
+    namespace Credit {
+        /**
+         * Schedule for distributing the credit to the customer.
+         */
+        interface AccessSchedule {
+            schedule_items: Array<AccessSchedule.ScheduleItem>;
+            /**
+             * Defaults to USD (cents) if not passed
+             */
+            credit_type_id?: string;
+        }
+        namespace AccessSchedule {
+            interface ScheduleItem {
+                amount: number;
+                /**
+                 * RFC 3339 timestamp (exclusive)
+                 */
+                ending_before: string;
+                /**
+                 * RFC 3339 timestamp (inclusive)
+                 */
+                starting_at: string;
+            }
+        }
+    }
+    interface Discount {
+        product_id: string;
+        /**
+         * 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;
+        };
+        /**
+         * displayed on invoices
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+    }
+    namespace Discount {
+        /**
+         * Must provide either schedule_items or recurring_schedule.
+         */
+        interface Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            recurring_schedule?: Schedule.RecurringSchedule;
+            /**
+             * Either provide amount or provide both unit_price and quantity.
+             */
+            schedule_items?: Array<Schedule.ScheduleItem>;
+        }
+        namespace Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            interface RecurringSchedule {
+                amount_distribution: 'DIVIDED' | 'DIVIDED_ROUNDED' | 'EACH';
+                /**
+                 * RFC 3339 timestamp (exclusive).
+                 */
+                ending_before: string;
+                frequency: 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL';
+                /**
+                 * RFC 3339 timestamp (inclusive).
+                 */
+                starting_at: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+            interface ScheduleItem {
+                /**
+                 * timestamp of the scheduled event
+                 */
+                timestamp: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+        }
+    }
+    interface Override {
+        /**
+         * RFC 3339 timestamp indicating when the override will start applying (inclusive)
+         */
+        starting_at: string;
+        /**
+         * tags identifying products whose rates are being overridden. Cannot be used in
+         * conjunction with override_specifiers.
+         */
+        applicable_product_tags?: Array<string>;
+        /**
+         * RFC 3339 timestamp indicating when the override will stop applying (exclusive)
+         */
+        ending_before?: string;
+        entitled?: boolean;
+        /**
+         * Indicates whether the override should only apply to commits. Defaults to
+         * `false`. If `true`, you can specify relevant commits in `override_specifiers` by
+         * passing `commit_ids`. if you do not specify `commit_ids`, then the override will
+         * apply when consuming any prepaid or postpaid commit.
+         */
+        is_commit_specific?: boolean;
+        /**
+         * Required for MULTIPLIER type. Must be >=0.
+         */
+        multiplier?: number;
+        /**
+         * Cannot be used in conjunction with product_id or applicable_product_tags. If
+         * provided, the override will apply to all products with the specified specifiers.
+         */
+        override_specifiers?: Array<Override.OverrideSpecifier>;
+        /**
+         * Required for OVERWRITE type.
+         */
+        overwrite_rate?: Override.OverwriteRate;
+        /**
+         * Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides.
+         * Under EXPLICIT prioritization, overwrites are prioritized first, and then tiered
+         * and multiplier overrides are prioritized by their priority value (lowest first).
+         * Must be > 0.
+         */
+        priority?: number;
+        /**
+         * ID of the product whose rate is being overridden. Cannot be used in conjunction
+         * with override_specifiers.
+         */
+        product_id?: string;
+        /**
+         * Indicates whether the override applies to commit rates or list rates. Can only
+         * be used for overrides that have `is_commit_specific` set to `true`. Defaults to
+         * `"LIST_RATE"`.
+         */
+        target?: 'COMMIT_RATE' | 'LIST_RATE';
+        /**
+         * Required for TIERED type. Must have at least one tier.
+         */
+        tiers?: Array<Override.Tier>;
+        /**
+         * Overwrites are prioritized over multipliers and tiered overrides.
+         */
+        type?: 'OVERWRITE' | 'MULTIPLIER' | 'TIERED';
+    }
+    namespace Override {
+        interface OverrideSpecifier {
+            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
+             * specified commits. If not provided, the override will apply to all commits.
+             */
+            commit_ids?: Array<string>;
+            /**
+             * A map of group names to values. The override will only apply to line items with
+             * the specified presentation group values.
+             */
+            presentation_group_values?: {
+                [key: string]: string;
+            };
+            /**
+             * A map of pricing group names to values. The override will only apply to products
+             * with the specified pricing group values.
+             */
+            pricing_group_values?: {
+                [key: string]: string;
+            };
+            /**
+             * If provided, the override will only apply to the product with the specified ID.
+             */
+            product_id?: string;
+            /**
+             * If provided, the override will only apply to products with all the specified
+             * tags.
+             */
+            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.
+             */
+            recurring_commit_ids?: Array<string>;
+            /**
+             * Can only be used for commit specific overrides. Must be used in conjunction with
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. If provided, the override will only apply to
+             * credits created by the specified recurring credit ids.
+             */
+            recurring_credit_ids?: Array<string>;
+        }
+        /**
+         * Required for OVERWRITE type.
+         */
+        interface OverwriteRate {
+            rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+            credit_type_id?: string;
+            /**
+             * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+             * processors.
+             */
+            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 ProfessionalService {
+        /**
+         * Maximum amount for the term.
+         */
+        max_amount: number;
+        product_id: string;
+        /**
+         * Quantity for the charge. Will be multiplied by unit_price to determine the
+         * amount.
+         */
+        quantity: number;
+        /**
+         * Unit price for the charge. Will be multiplied by quantity to determine the
+         * amount and must be specified.
+         */
+        unit_price: number;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
+        description?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+    }
+    interface ResellerRoyalty {
+        reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
+        /**
+         * Must provide at least one of applicable_product_ids or applicable_product_tags.
+         */
+        applicable_product_ids?: Array<string>;
+        /**
+         * Must provide at least one of applicable_product_ids or applicable_product_tags.
+         */
+        applicable_product_tags?: Array<string>;
+        aws_options?: ResellerRoyalty.AwsOptions;
+        /**
+         * Use null to indicate that the existing end timestamp should be removed.
+         */
+        ending_before?: string | null;
+        fraction?: number;
+        gcp_options?: ResellerRoyalty.GcpOptions;
+        netsuite_reseller_id?: string;
+        reseller_contract_value?: number;
+        starting_at?: string;
+    }
+    namespace ResellerRoyalty {
+        interface AwsOptions {
+            aws_account_number?: string;
+            aws_offer_id?: string;
+            aws_payer_reference_id?: string;
+        }
+        interface GcpOptions {
+            gcp_account_id?: string;
+            gcp_offer_id?: string;
+        }
+    }
+    interface ScheduledCharge {
+        product_id: string;
+        /**
+         * 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
+         */
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_sales_order_id?: string;
+    }
+    namespace ScheduledCharge {
+        /**
+         * Must provide either schedule_items or recurring_schedule.
+         */
+        interface Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            recurring_schedule?: Schedule.RecurringSchedule;
+            /**
+             * Either provide amount or provide both unit_price and quantity.
+             */
+            schedule_items?: Array<Schedule.ScheduleItem>;
+        }
+        namespace Schedule {
+            /**
+             * 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
+             * quantity is inferred to be 1.
+             */
+            interface RecurringSchedule {
+                amount_distribution: 'DIVIDED' | 'DIVIDED_ROUNDED' | 'EACH';
+                /**
+                 * RFC 3339 timestamp (exclusive).
+                 */
+                ending_before: string;
+                frequency: 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL';
+                /**
+                 * RFC 3339 timestamp (inclusive).
+                 */
+                starting_at: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+            interface ScheduleItem {
+                /**
+                 * timestamp of the scheduled event
+                 */
+                timestamp: string;
+                /**
+                 * Amount for the charge. Can be provided instead of unit_price and quantity. If
+                 * amount is sent, the unit_price is assumed to be the amount and quantity is
+                 * inferred to be 1.
+                 */
+                amount?: number;
+                /**
+                 * Quantity for the charge. Will be multiplied by unit_price to determine the
+                 * amount and must be specified with unit_price. If specified amount cannot be
+                 * provided.
+                 */
+                quantity?: number;
+                /**
+                 * Unit price for the charge. Will be multiplied by quantity to determine the
+                 * amount and must be specified with quantity. If specified amount cannot be
+                 * provided.
+                 */
+                unit_price?: number;
+            }
+        }
+    }
+}
+export interface ContractArchiveParams {
+    /**
+     * ID of the contract to archive
+     */
+    contract_id: string;
+    /**
+     * ID of the customer whose contract is to be archived
+     */
+    customer_id: string;
+    /**
+     * If false, the existing finalized invoices will remain after the contract is
+     * archived.
+     */
+    void_invoices: boolean;
+}
+export interface ContractCreateHistoricalInvoicesParams {
+    invoices: Array<ContractCreateHistoricalInvoicesParams.Invoice>;
+    preview: boolean;
+}
+export declare namespace ContractCreateHistoricalInvoicesParams {
+    interface Invoice {
+        contract_id: string;
+        credit_type_id: string;
+        customer_id: string;
+        exclusive_end_date: string;
+        inclusive_start_date: string;
+        issue_date: string;
+        usage_line_items: Array<Invoice.UsageLineItem>;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        billable_status?: 'billable' | 'unbillable';
+        breakdown_granularity?: 'HOUR' | 'DAY';
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
+    }
+    namespace Invoice {
+        interface UsageLineItem {
+            exclusive_end_date: string;
+            inclusive_start_date: string;
+            product_id: string;
+            presentation_group_values?: {
+                [key: string]: string;
+            };
+            pricing_group_values?: {
+                [key: string]: string;
+            };
+            quantity?: number;
+            subtotals_with_quantity?: Array<UsageLineItem.SubtotalsWithQuantity>;
+        }
+        namespace UsageLineItem {
+            interface SubtotalsWithQuantity {
+                exclusive_end_date: string;
+                inclusive_start_date: string;
+                quantity: number;
+            }
+        }
+    }
+}
+export interface ContractListBalancesParams extends BodyCursorPageParams {
+    customer_id: string;
+    id?: string;
+    /**
+     * Return only balances that have access schedules that "cover" the provided date
+     */
+    covering_date?: string;
+    /**
+     * Include only balances that have any access before the provided date (exclusive)
+     */
+    effective_before?: string;
+    /**
+     * Include archived credits and credits from archived contracts.
+     */
+    include_archived?: boolean;
+    /**
+     * Include the balance of credits and commits in the response. Setting this flag
+     * may cause the query to be slower.
+     */
+    include_balance?: boolean;
+    /**
+     * Include balances on the contract level.
+     */
+    include_contract_balances?: boolean;
+    /**
+     * Include ledgers in the response. Setting this flag may cause the query to be
+     * slower.
+     */
+    include_ledgers?: boolean;
+    /**
+     * Include only balances that have any access on or after the provided date
+     */
+    starting_at?: string;
+}
+export interface ContractRetrieveRateScheduleParams {
+    /**
+     * Body param: ID of the contract to get the rate schedule for.
+     */
+    contract_id: string;
+    /**
+     * Body param: ID of the customer for whose contract to get the rate schedule for.
+     */
+    customer_id: string;
+    /**
+     * Query param: Max number of results that should be returned
+     */
+    limit?: number;
+    /**
+     * Query param: Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+    /**
+     * Body param: optional timestamp which overlaps with the returned rate schedule
+     * segments. When not specified, the current timestamp will be used.
+     */
+    at?: string;
+    /**
+     * Body param: List of rate selectors, rates matching ANY of the selectors will be
+     * included in the response. Passing no selectors will result in all rates being
+     * returned.
+     */
+    selectors?: Array<ContractRetrieveRateScheduleParams.Selector>;
+}
+export declare namespace ContractRetrieveRateScheduleParams {
+    interface Selector {
+        /**
+         * Subscription rates matching the billing frequency will be included in the
+         * response.
+         */
+        billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+        /**
+         * List of pricing group key value pairs, rates containing the matching key / value
+         * pairs will be included in the response.
+         */
+        partial_pricing_group_values?: {
+            [key: string]: string;
+        };
+        /**
+         * List of pricing group key value pairs, rates matching all of the key / value
+         * pairs will be included in the response.
+         */
+        pricing_group_values?: {
+            [key: string]: string;
+        };
+        /**
+         * Rates matching the product id will be included in the response.
+         */
+        product_id?: string;
+        /**
+         * List of product tags, rates matching any of the tags will be included in the
+         * response.
+         */
+        product_tags?: Array<string>;
+    }
+}
+export interface ContractRetrieveSubscriptionQuantityHistoryParams {
+    contract_id: string;
+    customer_id: string;
+    subscription_id: string;
+}
+export interface ContractScheduleProServicesInvoiceParams {
+    contract_id: string;
+    customer_id: string;
+    /**
+     * The date the invoice is issued
+     */
+    issued_at: string;
+    /**
+     * Each line requires an amount or both unit_price and quantity.
+     */
+    line_items: Array<ContractScheduleProServicesInvoiceParams.LineItem>;
+    /**
+     * The end date of the invoice header in Netsuite
+     */
+    netsuite_invoice_header_end?: string;
+    /**
+     * The start date of the invoice header in Netsuite
+     */
+    netsuite_invoice_header_start?: string;
+}
+export declare namespace ContractScheduleProServicesInvoiceParams {
+    /**
+     * Describes the line item for a professional service charge on an invoice.
+     */
+    interface LineItem {
+        professional_service_id: string;
+        /**
+         * If the professional_service_id was added on an amendment, this is required.
+         */
+        amendment_id?: string;
+        /**
+         * Amount for the term on the new invoice.
+         */
+        amount?: number;
+        /**
+         * For client use.
+         */
+        metadata?: string;
+        /**
+         * The end date for the billing period on the invoice.
+         */
+        netsuite_invoice_billing_end?: string;
+        /**
+         * The start date for the billing period on the invoice.
+         */
+        netsuite_invoice_billing_start?: string;
+        /**
+         * Quantity for the charge. Will be multiplied by unit_price to determine the
+         * amount.
+         */
+        quantity?: number;
+        /**
+         * If specified, this overrides the unit price on the pro service term. Must also
+         * provide quantity (but not amount) if providing unit_price.
+         */
+        unit_price?: number;
+    }
+}
+export interface ContractSetUsageFilterParams {
+    contract_id: string;
+    customer_id: string;
+    group_key: string;
+    group_values: Array<string>;
+    starting_at: string;
+}
+export interface ContractUpdateEndDateParams {
+    /**
+     * ID of the contract to update
+     */
+    contract_id: string;
+    /**
+     * ID of the customer whose contract is to be updated
+     */
+    customer_id: string;
+    /**
+     * If true, allows setting the contract end date earlier than the end_timestamp of
+     * existing finalized invoices. Finalized invoices will be unchanged; if you want
+     * to incorporate the new end date, you can void and regenerate finalized usage
+     * invoices. Defaults to true.
+     */
+    allow_ending_before_finalized_invoice?: boolean;
+    /**
+     * RFC 3339 timestamp indicating when the contract will end (exclusive). If not
+     * provided, the contract will be updated to be open-ended.
+     */
+    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 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.mts.map