@metronome/mcp 2.2.0 → 3.0.0

package/tools/v1/contracts/create-v1-contracts.js

@@ -1,1670 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handler = exports.tool = exports.metadata = void 0;
-const types_1 = require("@metronome/mcp/tools/types");
-const sdk_1 = __importDefault(require("@metronome/sdk"));
-exports.metadata = {
-    resource: 'v1.contracts',
-    operation: 'write',
-    tags: [],
-    httpMethod: 'post',
-    httpPath: '/v1/contracts/create',
-    operationId: 'createContract-v1',
-};
-exports.tool = {
-    name: 'create_v1_contracts',
-    description: "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.\n\n### Use this endpoint to:\n- PLG onboarding: Automatically provision new self-serve customers with contracts when they sign up.\n- Enterprise sales: Push negotiated contracts from Salesforce with custom pricing and commitments\n- Promotional pricing: Implement time-limited discounts and free trials through overrides\n\n### Key components:\n#### Contract Term and Billing Schedule\n- 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.\n\n#### Rate Card\nIf 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.\nRead more about [Rate Cards](https://docs.metronome.com/pricing-packaging/create-manage-rate-cards/).\n\n#### Overrides and discounts\nCustomize pricing on the contract through time-bounded overrides that can target specific products, product families, or complex usage scenarios. Overrides enable two key capabilities:\n- Discounts: Apply percentage discounts, fixed rate reductions, or quantity-based pricing tiers\n- Entitlements: Provide special pricing or access to specific products for negotiated deals\n\nRead more about [Contract Overrides](https://docs.metronome.com/manage-product-access/add-contract-override/).\n\n#### Commits and Credits\nUsing 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.\n\nIn 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`.\n\nThese objects can also also be configured to have a recurrence schedule to easily model customer packaging which includes recurring monthly or quarterly allotments.\n\nCommits support rollover settings (`rollover_fraction`) to transfer unused balances between contract periods, either entirely or as a percentage.\n\nRead more about [Credits and Commits](https://docs.metronome.com/pricing-packaging/apply-credits-commits/).\n\n#### Subscriptions\nYou 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:\n- Define whether the subscription is paid for in-advance or in-arrears (`collection_schedule`)\n- Define the proration behavior (`proration`)\n- Specify an initial quantity (`initial_quantity`)\n- Define which subscription rate on the rate card should be used (`subscription_rate`)\n\nRead more about [Subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/).\n\n#### Scheduled Charges\nSet 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.\n\n#### Threshold Billing\nMetronome 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`.\n\nRead 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/).\n\n### Usage guidelines:\n- 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.\n- 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).\n",
-    inputSchema: {
-        type: 'object',
-        properties: {
-            customer_id: {
-                type: 'string',
-            },
-            starting_at: {
-                type: 'string',
-                description: 'inclusive contract start time',
-                format: 'date-time',
-            },
-            billing_provider_configuration: {
-                type: 'object',
-                description: 'The billing provider configuration associated with a contract. Provide either an ID or the provider and delivery method.',
-                properties: {
-                    billing_provider: {
-                        type: 'string',
-                        description: 'Do not specify if using billing_provider_configuration_id.',
-                        enum: ['aws_marketplace', 'azure_marketplace', 'gcp_marketplace', 'stripe', 'netsuite'],
-                    },
-                    billing_provider_configuration_id: {
-                        type: 'string',
-                        description: '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.',
-                    },
-                    delivery_method: {
-                        type: 'string',
-                        description: 'Do not specify if using billing_provider_configuration_id.',
-                        enum: ['direct_to_billing_provider', 'aws_sqs', 'tackle', 'aws_sns'],
-                    },
-                },
-            },
-            commits: {
-                type: 'array',
-                items: {
-                    type: 'object',
-                    properties: {
-                        product_id: {
-                            type: 'string',
-                        },
-                        type: {
-                            type: 'string',
-                            enum: ['PREPAID', 'POSTPAID'],
-                        },
-                        access_schedule: {
-                            type: 'object',
-                            description: '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.',
-                            properties: {
-                                schedule_items: {
-                                    type: 'array',
-                                    items: {
-                                        type: 'object',
-                                        properties: {
-                                            amount: {
-                                                type: 'number',
-                                            },
-                                            ending_before: {
-                                                type: 'string',
-                                                description: 'RFC 3339 timestamp (exclusive)',
-                                                format: 'date-time',
-                                            },
-                                            starting_at: {
-                                                type: 'string',
-                                                description: 'RFC 3339 timestamp (inclusive)',
-                                                format: 'date-time',
-                                            },
-                                        },
-                                        required: ['amount', 'ending_before', 'starting_at'],
-                                    },
-                                },
-                                credit_type_id: {
-                                    type: 'string',
-                                    description: 'Defaults to USD (cents) if not passed',
-                                },
-                            },
-                            required: ['schedule_items'],
-                        },
-                        amount: {
-                            type: 'number',
-                            description: '(DEPRECATED) Use access_schedule and invoice_schedule instead.',
-                        },
-                        applicable_product_ids: {
-                            type: 'array',
-                            description: 'Which products the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        applicable_product_tags: {
-                            type: 'array',
-                            description: 'Which tags the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        custom_fields: {
-                            type: 'object',
-                            description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
-                            additionalProperties: true,
-                        },
-                        description: {
-                            type: 'string',
-                            description: 'Used only in UI/API. It is not exposed to end customers.',
-                        },
-                        hierarchy_configuration: {
-                            $ref: '#/$defs/commit_hierarchy_configuration',
-                        },
-                        invoice_schedule: {
-                            type: 'object',
-                            description: '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.',
-                            properties: {
-                                credit_type_id: {
-                                    type: 'string',
-                                    description: 'Defaults to USD (cents) if not passed.',
-                                },
-                                do_not_invoice: {
-                                    type: 'boolean',
-                                    description: 'This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.',
-                                },
-                                recurring_schedule: {
-                                    type: 'object',
-                                    description: '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.',
-                                    properties: {
-                                        amount_distribution: {
-                                            type: 'string',
-                                            enum: ['DIVIDED', 'DIVIDED_ROUNDED', 'EACH'],
-                                        },
-                                        ending_before: {
-                                            type: 'string',
-                                            description: 'RFC 3339 timestamp (exclusive).',
-                                            format: 'date-time',
-                                        },
-                                        frequency: {
-                                            type: 'string',
-                                            enum: ['MONTHLY', 'QUARTERLY', 'SEMI_ANNUAL', 'ANNUAL'],
-                                        },
-                                        starting_at: {
-                                            type: 'string',
-                                            description: 'RFC 3339 timestamp (inclusive).',
-                                            format: 'date-time',
-                                        },
-                                        amount: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                        quantity: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                        unit_price: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                    },
-                                    required: ['amount_distribution', 'ending_before', 'frequency', 'starting_at'],
-                                },
-                                schedule_items: {
-                                    type: 'array',
-                                    description: 'Either provide amount or provide both unit_price and quantity.',
-                                    items: {
-                                        type: 'object',
-                                        properties: {
-                                            timestamp: {
-                                                type: 'string',
-                                                description: 'timestamp of the scheduled event',
-                                                format: 'date-time',
-                                            },
-                                            amount: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                            quantity: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                            unit_price: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                        },
-                                        required: ['timestamp'],
-                                    },
-                                },
-                            },
-                        },
-                        name: {
-                            type: 'string',
-                            description: 'displayed on invoices',
-                        },
-                        netsuite_sales_order_id: {
-                            type: 'string',
-                            description: "This field's availability is dependent on your client's configuration.",
-                        },
-                        payment_gate_config: {
-                            type: 'object',
-                            description: 'optionally payment gate this commit',
-                            properties: {
-                                payment_gate_type: {
-                                    type: 'string',
-                                    description: '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.',
-                                    enum: ['NONE', 'STRIPE', 'EXTERNAL'],
-                                },
-                                precalculated_tax_config: {
-                                    type: 'object',
-                                    description: 'Only applicable if using PRECALCULATED as your tax type.',
-                                    properties: {
-                                        tax_amount: {
-                                            type: 'number',
-                                            description: "Amount of tax to be applied. This should be in the same currency and denomination  as the commit's invoice schedule",
-                                        },
-                                        tax_name: {
-                                            type: 'string',
-                                            description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
-                                        },
-                                    },
-                                    required: ['tax_amount'],
-                                },
-                                stripe_config: {
-                                    type: 'object',
-                                    description: 'Only applicable if using STRIPE as your payment gate type.',
-                                    properties: {
-                                        payment_type: {
-                                            type: 'string',
-                                            description: 'If left blank, will default to INVOICE',
-                                            enum: ['INVOICE', 'PAYMENT_INTENT'],
-                                        },
-                                        invoice_metadata: {
-                                            type: 'object',
-                                            description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
-                                            additionalProperties: true,
-                                        },
-                                        on_session_payment: {
-                                            type: 'boolean',
-                                            description: 'If true, the payment will be made assuming the customer is present (i.e. on session). \n\nIf false, the payment will be made assuming the customer is not present (i.e. off session). \nFor cardholders from a country with an e-mandate requirement (e.g. India), the payment may be declined.\n\nIf left blank, will default to false.',
-                                        },
-                                    },
-                                    required: ['payment_type'],
-                                },
-                                tax_type: {
-                                    type: 'string',
-                                    description: '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.',
-                                    enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
-                                },
-                            },
-                            required: ['payment_gate_type'],
-                        },
-                        priority: {
-                            type: 'number',
-                            description: 'If multiple commits are applicable, the one with the lower priority will apply first.',
-                        },
-                        rate_type: {
-                            type: 'string',
-                            enum: ['COMMIT_RATE', 'LIST_RATE'],
-                        },
-                        rollover_fraction: {
-                            type: 'number',
-                            description: 'Fraction of unused segments that will be rolled over. Must be between 0 and 1.',
-                        },
-                        specifiers: {
-                            type: 'array',
-                            description: "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`.",
-                            items: {
-                                $ref: '#/$defs/commit_specifier_input',
-                            },
-                        },
-                        temporary_id: {
-                            type: 'string',
-                            description: 'A temporary ID for the commit that can be used to reference the commit for commit specific overrides.',
-                        },
-                    },
-                    required: ['product_id', 'type'],
-                },
-            },
-            credits: {
-                type: 'array',
-                items: {
-                    type: 'object',
-                    properties: {
-                        access_schedule: {
-                            type: 'object',
-                            description: 'Schedule for distributing the credit to the customer.',
-                            properties: {
-                                schedule_items: {
-                                    type: 'array',
-                                    items: {
-                                        type: 'object',
-                                        properties: {
-                                            amount: {
-                                                type: 'number',
-                                            },
-                                            ending_before: {
-                                                type: 'string',
-                                                description: 'RFC 3339 timestamp (exclusive)',
-                                                format: 'date-time',
-                                            },
-                                            starting_at: {
-                                                type: 'string',
-                                                description: 'RFC 3339 timestamp (inclusive)',
-                                                format: 'date-time',
-                                            },
-                                        },
-                                        required: ['amount', 'ending_before', 'starting_at'],
-                                    },
-                                },
-                                credit_type_id: {
-                                    type: 'string',
-                                    description: 'Defaults to USD (cents) if not passed',
-                                },
-                            },
-                            required: ['schedule_items'],
-                        },
-                        product_id: {
-                            type: 'string',
-                        },
-                        applicable_product_ids: {
-                            type: 'array',
-                            description: 'Which products the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        applicable_product_tags: {
-                            type: 'array',
-                            description: 'Which tags the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        custom_fields: {
-                            type: 'object',
-                            description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
-                            additionalProperties: true,
-                        },
-                        description: {
-                            type: 'string',
-                            description: 'Used only in UI/API. It is not exposed to end customers.',
-                        },
-                        hierarchy_configuration: {
-                            $ref: '#/$defs/commit_hierarchy_configuration',
-                        },
-                        name: {
-                            type: 'string',
-                            description: 'displayed on invoices',
-                        },
-                        netsuite_sales_order_id: {
-                            type: 'string',
-                            description: "This field's availability is dependent on your client's configuration.",
-                        },
-                        priority: {
-                            type: 'number',
-                            description: 'If multiple credits are applicable, the one with the lower priority will apply first.',
-                        },
-                        rate_type: {
-                            type: 'string',
-                            enum: ['COMMIT_RATE', 'LIST_RATE'],
-                        },
-                        specifiers: {
-                            type: 'array',
-                            description: "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`.",
-                            items: {
-                                $ref: '#/$defs/commit_specifier_input',
-                            },
-                        },
-                    },
-                    required: ['access_schedule', 'product_id'],
-                },
-            },
-            custom_fields: {
-                type: 'object',
-                description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
-                additionalProperties: true,
-            },
-            discounts: {
-                type: 'array',
-                description: "This field's availability is dependent on your client's configuration.",
-                items: {
-                    type: 'object',
-                    properties: {
-                        product_id: {
-                            type: 'string',
-                        },
-                        schedule: {
-                            type: 'object',
-                            description: 'Must provide either schedule_items or recurring_schedule.',
-                            properties: {
-                                credit_type_id: {
-                                    type: 'string',
-                                    description: 'Defaults to USD (cents) if not passed.',
-                                },
-                                do_not_invoice: {
-                                    type: 'boolean',
-                                    description: 'This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.',
-                                },
-                                recurring_schedule: {
-                                    type: 'object',
-                                    description: '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.',
-                                    properties: {
-                                        amount_distribution: {
-                                            type: 'string',
-                                            enum: ['DIVIDED', 'DIVIDED_ROUNDED', 'EACH'],
-                                        },
-                                        ending_before: {
-                                            type: 'string',
-                                            description: 'RFC 3339 timestamp (exclusive).',
-                                            format: 'date-time',
-                                        },
-                                        frequency: {
-                                            type: 'string',
-                                            enum: ['MONTHLY', 'QUARTERLY', 'SEMI_ANNUAL', 'ANNUAL'],
-                                        },
-                                        starting_at: {
-                                            type: 'string',
-                                            description: 'RFC 3339 timestamp (inclusive).',
-                                            format: 'date-time',
-                                        },
-                                        amount: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                        quantity: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                        unit_price: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                    },
-                                    required: ['amount_distribution', 'ending_before', 'frequency', 'starting_at'],
-                                },
-                                schedule_items: {
-                                    type: 'array',
-                                    description: 'Either provide amount or provide both unit_price and quantity.',
-                                    items: {
-                                        type: 'object',
-                                        properties: {
-                                            timestamp: {
-                                                type: 'string',
-                                                description: 'timestamp of the scheduled event',
-                                                format: 'date-time',
-                                            },
-                                            amount: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                            quantity: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                            unit_price: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                        },
-                                        required: ['timestamp'],
-                                    },
-                                },
-                            },
-                        },
-                        custom_fields: {
-                            type: 'object',
-                            description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
-                            additionalProperties: true,
-                        },
-                        name: {
-                            type: 'string',
-                            description: 'displayed on invoices',
-                        },
-                        netsuite_sales_order_id: {
-                            type: 'string',
-                            description: "This field's availability is dependent on your client's configuration.",
-                        },
-                    },
-                    required: ['product_id', 'schedule'],
-                },
-            },
-            ending_before: {
-                type: 'string',
-                description: 'exclusive contract end time',
-                format: 'date-time',
-            },
-            hierarchy_configuration: {
-                type: 'object',
-                properties: {
-                    parent: {
-                        type: 'object',
-                        properties: {
-                            contract_id: {
-                                type: 'string',
-                            },
-                            customer_id: {
-                                type: 'string',
-                            },
-                        },
-                        required: ['contract_id', 'customer_id'],
-                    },
-                    parent_behavior: {
-                        type: 'object',
-                        properties: {
-                            invoice_consolidation_type: {
-                                type: 'string',
-                                description: 'Account hierarchy M3 - Indicates the desired behavior of consolidated invoices generated by the parent in a customer hierarchy\n\n**CONCATENATE**: Statements on the invoices of child customers will be appended to the consolidated invoice\n\n**NONE**: Do not generate consolidated invoices',
-                                enum: ['CONCATENATE', 'NONE'],
-                            },
-                        },
-                    },
-                    payer: {
-                        type: 'string',
-                        description: "Account hierarchy M3 - Indicates which customer should pay for the child's invoice charges\n\n**SELF**: The child pays for its own invoice charges\n\n**PARENT**: The parent pays for the child's invoice charges",
-                        enum: ['SELF', 'PARENT'],
-                    },
-                    usage_statement_behavior: {
-                        type: 'string',
-                        description: "Account hierarchy M3 - Indicates the behavior of the child's invoice statements on the parent's invoices.\n\n**CONSOLIDATE**: Child's invoice statements will be added to parent's consolidated invoices\n\n**SEPARATE**: Child's invoice statements will appear not appear on parent's consolidated invoices",
-                        enum: ['CONSOLIDATE', 'SEPARATE'],
-                    },
-                },
-            },
-            multiplier_override_prioritization: {
-                type: 'string',
-                description: '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.',
-                enum: ['LOWEST_MULTIPLIER', 'EXPLICIT'],
-            },
-            name: {
-                type: 'string',
-            },
-            net_payment_terms_days: {
-                type: 'number',
-            },
-            netsuite_sales_order_id: {
-                type: 'string',
-                description: "This field's availability is dependent on your client's configuration.",
-            },
-            overrides: {
-                type: 'array',
-                items: {
-                    type: 'object',
-                    properties: {
-                        starting_at: {
-                            type: 'string',
-                            description: 'RFC 3339 timestamp indicating when the override will start applying (inclusive)',
-                            format: 'date-time',
-                        },
-                        applicable_product_tags: {
-                            type: 'array',
-                            description: 'tags identifying products whose rates are being overridden. Cannot be used in conjunction with override_specifiers.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        ending_before: {
-                            type: 'string',
-                            description: 'RFC 3339 timestamp indicating when the override will stop applying (exclusive)',
-                            format: 'date-time',
-                        },
-                        entitled: {
-                            type: 'boolean',
-                        },
-                        is_commit_specific: {
-                            type: 'boolean',
-                            description: '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.',
-                        },
-                        multiplier: {
-                            type: 'number',
-                            description: 'Required for MULTIPLIER type. Must be >=0.',
-                        },
-                        override_specifiers: {
-                            type: 'array',
-                            description: '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.',
-                            items: {
-                                type: 'object',
-                                properties: {
-                                    billing_frequency: {
-                                        type: 'string',
-                                        enum: ['MONTHLY', 'QUARTERLY', 'ANNUAL', 'WEEKLY'],
-                                    },
-                                    commit_ids: {
-                                        type: 'array',
-                                        description: '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.',
-                                        items: {
-                                            type: 'string',
-                                        },
-                                    },
-                                    presentation_group_values: {
-                                        type: 'object',
-                                        description: 'A map of group names to values. The override will only apply to line items with the specified presentation group values.',
-                                        additionalProperties: true,
-                                    },
-                                    pricing_group_values: {
-                                        type: 'object',
-                                        description: 'A map of pricing group names to values. The override will only apply to products with the specified pricing group values.',
-                                        additionalProperties: true,
-                                    },
-                                    product_id: {
-                                        type: 'string',
-                                        description: 'If provided, the override will only apply to the product with the specified ID.',
-                                    },
-                                    product_tags: {
-                                        type: 'array',
-                                        description: 'If provided, the override will only apply to products with all the specified tags.',
-                                        items: {
-                                            type: 'string',
-                                        },
-                                    },
-                                    recurring_commit_ids: {
-                                        type: 'array',
-                                        description: '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.',
-                                        items: {
-                                            type: 'string',
-                                        },
-                                    },
-                                    recurring_credit_ids: {
-                                        type: 'array',
-                                        description: '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.',
-                                        items: {
-                                            type: 'string',
-                                        },
-                                    },
-                                },
-                            },
-                        },
-                        overwrite_rate: {
-                            type: 'object',
-                            description: 'Required for OVERWRITE type.',
-                            properties: {
-                                rate_type: {
-                                    type: 'string',
-                                    enum: ['FLAT', 'PERCENTAGE', 'SUBSCRIPTION', 'TIERED', 'CUSTOM'],
-                                },
-                                credit_type_id: {
-                                    type: 'string',
-                                },
-                                custom_rate: {
-                                    type: 'object',
-                                    description: 'Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.',
-                                    additionalProperties: true,
-                                },
-                                is_prorated: {
-                                    type: 'boolean',
-                                    description: 'Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.',
-                                },
-                                price: {
-                                    type: 'number',
-                                    description: '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.',
-                                },
-                                quantity: {
-                                    type: 'number',
-                                    description: 'Default quantity. For SUBSCRIPTION rate_type, this must be >=0.',
-                                },
-                                tiers: {
-                                    type: 'array',
-                                    description: 'Only set for TIERED rate_type.',
-                                    items: {
-                                        $ref: '#/$defs/tier',
-                                    },
-                                },
-                            },
-                            required: ['rate_type'],
-                        },
-                        priority: {
-                            type: 'number',
-                            description: '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.',
-                        },
-                        product_id: {
-                            type: 'string',
-                            description: 'ID of the product whose rate is being overridden. Cannot be used in conjunction with override_specifiers.',
-                        },
-                        target: {
-                            type: 'string',
-                            description: '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"`.',
-                            enum: ['COMMIT_RATE', 'LIST_RATE'],
-                        },
-                        tiers: {
-                            type: 'array',
-                            description: 'Required for TIERED type. Must have at least one tier.',
-                            items: {
-                                type: 'object',
-                                properties: {
-                                    multiplier: {
-                                        type: 'number',
-                                    },
-                                    size: {
-                                        type: 'number',
-                                    },
-                                },
-                                required: ['multiplier'],
-                            },
-                        },
-                        type: {
-                            type: 'string',
-                            description: 'Overwrites are prioritized over multipliers and tiered overrides.',
-                            enum: ['OVERWRITE', 'MULTIPLIER', 'TIERED'],
-                        },
-                    },
-                    required: ['starting_at'],
-                },
-            },
-            prepaid_balance_threshold_configuration: {
-                $ref: '#/$defs/prepaid_balance_threshold_configuration',
-            },
-            priority: {
-                type: 'number',
-                description: 'Priority of the contract.',
-            },
-            professional_services: {
-                type: 'array',
-                description: "This field's availability is dependent on your client's configuration.",
-                items: {
-                    type: 'object',
-                    properties: {
-                        max_amount: {
-                            type: 'number',
-                            description: 'Maximum amount for the term.',
-                        },
-                        product_id: {
-                            type: 'string',
-                        },
-                        quantity: {
-                            type: 'number',
-                            description: 'Quantity for the charge. Will be multiplied by unit_price to determine the amount.',
-                        },
-                        unit_price: {
-                            type: 'number',
-                            description: 'Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified.',
-                        },
-                        custom_fields: {
-                            type: 'object',
-                            description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
-                            additionalProperties: true,
-                        },
-                        description: {
-                            type: 'string',
-                        },
-                        netsuite_sales_order_id: {
-                            type: 'string',
-                            description: "This field's availability is dependent on your client's configuration.",
-                        },
-                    },
-                    required: ['max_amount', 'product_id', 'quantity', 'unit_price'],
-                },
-            },
-            rate_card_alias: {
-                type: 'string',
-                description: "Selects the rate card linked to the specified alias as of the contract's start date.",
-            },
-            rate_card_id: {
-                type: 'string',
-            },
-            recurring_commits: {
-                type: 'array',
-                items: {
-                    type: 'object',
-                    properties: {
-                        access_amount: {
-                            type: 'object',
-                            description: 'The amount of commit to grant.',
-                            properties: {
-                                credit_type_id: {
-                                    type: 'string',
-                                },
-                                unit_price: {
-                                    type: 'number',
-                                },
-                                quantity: {
-                                    type: 'number',
-                                    description: 'This field is required unless a subscription is attached via `subscription_config`.',
-                                },
-                            },
-                            required: ['credit_type_id', 'unit_price'],
-                        },
-                        commit_duration: {
-                            type: 'object',
-                            description: '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.',
-                            properties: {
-                                value: {
-                                    type: 'number',
-                                },
-                                unit: {
-                                    type: 'string',
-                                    enum: ['PERIODS'],
-                                },
-                            },
-                            required: ['value'],
-                        },
-                        priority: {
-                            type: 'number',
-                            description: 'Will be passed down to the individual commits',
-                        },
-                        product_id: {
-                            type: 'string',
-                        },
-                        starting_at: {
-                            type: 'string',
-                            description: 'determines the start time for the first commit',
-                            format: 'date-time',
-                        },
-                        applicable_product_ids: {
-                            type: 'array',
-                            description: 'Will be passed down to the individual commits',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        applicable_product_tags: {
-                            type: 'array',
-                            description: 'Will be passed down to the individual commits',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        description: {
-                            type: 'string',
-                            description: 'Will be passed down to the individual commits',
-                        },
-                        ending_before: {
-                            type: 'string',
-                            description: 'Determines when the contract will stop creating recurring commits. optional',
-                            format: 'date-time',
-                        },
-                        hierarchy_configuration: {
-                            $ref: '#/$defs/commit_hierarchy_configuration',
-                        },
-                        invoice_amount: {
-                            type: 'object',
-                            description: 'The amount the customer should be billed for the commit. Not required.',
-                            properties: {
-                                credit_type_id: {
-                                    type: 'string',
-                                },
-                                quantity: {
-                                    type: 'number',
-                                },
-                                unit_price: {
-                                    type: 'number',
-                                },
-                            },
-                            required: ['credit_type_id', 'quantity', 'unit_price'],
-                        },
-                        name: {
-                            type: 'string',
-                            description: 'displayed on invoices. will be passed through to the individual commits',
-                        },
-                        netsuite_sales_order_id: {
-                            type: 'string',
-                            description: 'Will be passed down to the individual commits',
-                        },
-                        proration: {
-                            type: 'string',
-                            description: '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).',
-                            enum: ['NONE', 'FIRST', 'LAST', 'FIRST_AND_LAST'],
-                        },
-                        rate_type: {
-                            type: 'string',
-                            description: 'Whether the created commits will use the commit rate or list rate',
-                            enum: ['COMMIT_RATE', 'LIST_RATE'],
-                        },
-                        recurrence_frequency: {
-                            type: 'string',
-                            description: "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.",
-                            enum: ['MONTHLY', 'QUARTERLY', 'ANNUAL', 'WEEKLY'],
-                        },
-                        rollover_fraction: {
-                            type: 'number',
-                            description: '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.',
-                        },
-                        specifiers: {
-                            type: 'array',
-                            description: "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`.",
-                            items: {
-                                $ref: '#/$defs/commit_specifier_input',
-                            },
-                        },
-                        subscription_config: {
-                            type: 'object',
-                            description: 'Attach a subscription to the recurring commit/credit.',
-                            properties: {
-                                apply_seat_increase_config: {
-                                    type: 'object',
-                                    properties: {
-                                        is_prorated: {
-                                            type: 'boolean',
-                                            description: 'Indicates whether a mid-period seat increase should be prorated.',
-                                        },
-                                    },
-                                    required: ['is_prorated'],
-                                },
-                                subscription_id: {
-                                    type: 'string',
-                                    description: 'ID of the subscription to configure on the recurring commit/credit.',
-                                },
-                                allocation: {
-                                    type: 'string',
-                                    description: 'If set to POOLED, allocation added per seat is pooled across the account. If set to INDIVIDUAL, each seat in the subscription will have its own allocation.',
-                                    enum: ['INDIVIDUAL', 'POOLED'],
-                                },
-                            },
-                            required: ['apply_seat_increase_config', 'subscription_id'],
-                        },
-                        temporary_id: {
-                            type: 'string',
-                            description: 'A temporary ID that can be used to reference the recurring commit for commit specific overrides.',
-                        },
-                    },
-                    required: ['access_amount', 'commit_duration', 'priority', 'product_id', 'starting_at'],
-                },
-            },
-            recurring_credits: {
-                type: 'array',
-                items: {
-                    type: 'object',
-                    properties: {
-                        access_amount: {
-                            type: 'object',
-                            description: 'The amount of commit to grant.',
-                            properties: {
-                                credit_type_id: {
-                                    type: 'string',
-                                },
-                                unit_price: {
-                                    type: 'number',
-                                },
-                                quantity: {
-                                    type: 'number',
-                                    description: 'This field is required unless a subscription is attached via `subscription_config`.',
-                                },
-                            },
-                            required: ['credit_type_id', 'unit_price'],
-                        },
-                        commit_duration: {
-                            type: 'object',
-                            description: '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.',
-                            properties: {
-                                value: {
-                                    type: 'number',
-                                },
-                                unit: {
-                                    type: 'string',
-                                    enum: ['PERIODS'],
-                                },
-                            },
-                            required: ['value'],
-                        },
-                        priority: {
-                            type: 'number',
-                            description: 'Will be passed down to the individual commits',
-                        },
-                        product_id: {
-                            type: 'string',
-                        },
-                        starting_at: {
-                            type: 'string',
-                            description: 'determines the start time for the first commit',
-                            format: 'date-time',
-                        },
-                        applicable_product_ids: {
-                            type: 'array',
-                            description: 'Will be passed down to the individual commits',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        applicable_product_tags: {
-                            type: 'array',
-                            description: 'Will be passed down to the individual commits',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        description: {
-                            type: 'string',
-                            description: 'Will be passed down to the individual commits',
-                        },
-                        ending_before: {
-                            type: 'string',
-                            description: 'Determines when the contract will stop creating recurring commits. optional',
-                            format: 'date-time',
-                        },
-                        hierarchy_configuration: {
-                            $ref: '#/$defs/commit_hierarchy_configuration',
-                        },
-                        name: {
-                            type: 'string',
-                            description: 'displayed on invoices. will be passed through to the individual commits',
-                        },
-                        netsuite_sales_order_id: {
-                            type: 'string',
-                            description: 'Will be passed down to the individual commits',
-                        },
-                        proration: {
-                            type: 'string',
-                            description: '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).',
-                            enum: ['NONE', 'FIRST', 'LAST', 'FIRST_AND_LAST'],
-                        },
-                        rate_type: {
-                            type: 'string',
-                            description: 'Whether the created commits will use the commit rate or list rate',
-                            enum: ['COMMIT_RATE', 'LIST_RATE'],
-                        },
-                        recurrence_frequency: {
-                            type: 'string',
-                            description: "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.",
-                            enum: ['MONTHLY', 'QUARTERLY', 'ANNUAL', 'WEEKLY'],
-                        },
-                        rollover_fraction: {
-                            type: 'number',
-                            description: '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.',
-                        },
-                        specifiers: {
-                            type: 'array',
-                            description: "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`.",
-                            items: {
-                                $ref: '#/$defs/commit_specifier_input',
-                            },
-                        },
-                        subscription_config: {
-                            type: 'object',
-                            description: 'Attach a subscription to the recurring commit/credit.',
-                            properties: {
-                                apply_seat_increase_config: {
-                                    type: 'object',
-                                    properties: {
-                                        is_prorated: {
-                                            type: 'boolean',
-                                            description: 'Indicates whether a mid-period seat increase should be prorated.',
-                                        },
-                                    },
-                                    required: ['is_prorated'],
-                                },
-                                subscription_id: {
-                                    type: 'string',
-                                    description: 'ID of the subscription to configure on the recurring commit/credit.',
-                                },
-                                allocation: {
-                                    type: 'string',
-                                    description: 'If set to POOLED, allocation added per seat is pooled across the account. If set to INDIVIDUAL, each seat in the subscription will have its own allocation.',
-                                    enum: ['INDIVIDUAL', 'POOLED'],
-                                },
-                            },
-                            required: ['apply_seat_increase_config', 'subscription_id'],
-                        },
-                        temporary_id: {
-                            type: 'string',
-                            description: 'A temporary ID that can be used to reference the recurring commit for commit specific overrides.',
-                        },
-                    },
-                    required: ['access_amount', 'commit_duration', 'priority', 'product_id', 'starting_at'],
-                },
-            },
-            reseller_royalties: {
-                type: 'array',
-                description: "This field's availability is dependent on your client's configuration.",
-                items: {
-                    type: 'object',
-                    properties: {
-                        fraction: {
-                            type: 'number',
-                        },
-                        netsuite_reseller_id: {
-                            type: 'string',
-                        },
-                        reseller_type: {
-                            type: 'string',
-                            enum: ['AWS', 'AWS_PRO_SERVICE', 'GCP', 'GCP_PRO_SERVICE'],
-                        },
-                        starting_at: {
-                            type: 'string',
-                            format: 'date-time',
-                        },
-                        applicable_product_ids: {
-                            type: 'array',
-                            description: 'Must provide at least one of applicable_product_ids or applicable_product_tags.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        applicable_product_tags: {
-                            type: 'array',
-                            description: 'Must provide at least one of applicable_product_ids or applicable_product_tags.',
-                            items: {
-                                type: 'string',
-                            },
-                        },
-                        aws_options: {
-                            type: 'object',
-                            properties: {
-                                aws_account_number: {
-                                    type: 'string',
-                                },
-                                aws_offer_id: {
-                                    type: 'string',
-                                },
-                                aws_payer_reference_id: {
-                                    type: 'string',
-                                },
-                            },
-                        },
-                        ending_before: {
-                            type: 'string',
-                            format: 'date-time',
-                        },
-                        gcp_options: {
-                            type: 'object',
-                            properties: {
-                                gcp_account_id: {
-                                    type: 'string',
-                                },
-                                gcp_offer_id: {
-                                    type: 'string',
-                                },
-                            },
-                        },
-                        reseller_contract_value: {
-                            type: 'number',
-                        },
-                    },
-                    required: ['fraction', 'netsuite_reseller_id', 'reseller_type', 'starting_at'],
-                },
-            },
-            revenue_system_configuration: {
-                type: 'object',
-                description: 'The revenue system configuration associated with a contract. Provide either an ID or the provider and delivery method.',
-                properties: {
-                    delivery_method: {
-                        type: 'string',
-                        description: 'How revenue recognition records should be delivered to the revenue system. Do not specify if using revenue_system_configuration_id.',
-                        enum: ['direct_to_billing_provider'],
-                    },
-                    provider: {
-                        type: 'string',
-                        description: 'The system that is providing services for revenue recognition. Do not specify if using revenue_system_configuration_id.',
-                        enum: ['netsuite'],
-                    },
-                    revenue_system_configuration_id: {
-                        type: 'string',
-                        description: 'The Metronome ID of the revenue system configuration. Use when a customer has multiple configurations with the same provider and delivery method. Otherwise, specify the provider and delivery_method.',
-                    },
-                },
-            },
-            salesforce_opportunity_id: {
-                type: 'string',
-                description: "This field's availability is dependent on your client's configuration.",
-            },
-            scheduled_charges: {
-                type: 'array',
-                items: {
-                    type: 'object',
-                    properties: {
-                        product_id: {
-                            type: 'string',
-                        },
-                        schedule: {
-                            type: 'object',
-                            description: 'Must provide either schedule_items or recurring_schedule.',
-                            properties: {
-                                credit_type_id: {
-                                    type: 'string',
-                                    description: 'Defaults to USD (cents) if not passed.',
-                                },
-                                do_not_invoice: {
-                                    type: 'boolean',
-                                    description: 'This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.',
-                                },
-                                recurring_schedule: {
-                                    type: 'object',
-                                    description: '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.',
-                                    properties: {
-                                        amount_distribution: {
-                                            type: 'string',
-                                            enum: ['DIVIDED', 'DIVIDED_ROUNDED', 'EACH'],
-                                        },
-                                        ending_before: {
-                                            type: 'string',
-                                            description: 'RFC 3339 timestamp (exclusive).',
-                                            format: 'date-time',
-                                        },
-                                        frequency: {
-                                            type: 'string',
-                                            enum: ['MONTHLY', 'QUARTERLY', 'SEMI_ANNUAL', 'ANNUAL'],
-                                        },
-                                        starting_at: {
-                                            type: 'string',
-                                            description: 'RFC 3339 timestamp (inclusive).',
-                                            format: 'date-time',
-                                        },
-                                        amount: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                        quantity: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                        unit_price: {
-                                            type: 'number',
-                                            description: '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.',
-                                        },
-                                    },
-                                    required: ['amount_distribution', 'ending_before', 'frequency', 'starting_at'],
-                                },
-                                schedule_items: {
-                                    type: 'array',
-                                    description: 'Either provide amount or provide both unit_price and quantity.',
-                                    items: {
-                                        type: 'object',
-                                        properties: {
-                                            timestamp: {
-                                                type: 'string',
-                                                description: 'timestamp of the scheduled event',
-                                                format: 'date-time',
-                                            },
-                                            amount: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                            quantity: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                            unit_price: {
-                                                type: 'number',
-                                                description: '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.',
-                                            },
-                                        },
-                                        required: ['timestamp'],
-                                    },
-                                },
-                            },
-                        },
-                        custom_fields: {
-                            type: 'object',
-                            description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
-                            additionalProperties: true,
-                        },
-                        name: {
-                            type: 'string',
-                            description: 'displayed on invoices',
-                        },
-                        netsuite_sales_order_id: {
-                            type: 'string',
-                            description: "This field's availability is dependent on your client's configuration.",
-                        },
-                    },
-                    required: ['product_id', 'schedule'],
-                },
-            },
-            scheduled_charges_on_usage_invoices: {
-                type: 'string',
-                description: "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.",
-                enum: ['ALL'],
-            },
-            spend_threshold_configuration: {
-                $ref: '#/$defs/spend_threshold_configuration',
-            },
-            subscriptions: {
-                type: 'array',
-                description: 'Optional list of [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/) to add to the contract.',
-                items: {
-                    type: 'object',
-                    properties: {
-                        collection_schedule: {
-                            type: 'string',
-                            enum: ['ADVANCE', 'ARREARS'],
-                        },
-                        proration: {
-                            type: 'object',
-                            properties: {
-                                invoice_behavior: {
-                                    type: 'string',
-                                    description: 'Indicates how mid-period quantity adjustments are invoiced. \n**BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The quantity increase will be billed immediately on the scheduled date.\n**BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for in-arrears at the end of the period.',
-                                    enum: ['BILL_IMMEDIATELY', 'BILL_ON_NEXT_COLLECTION_DATE'],
-                                },
-                                is_prorated: {
-                                    type: 'boolean',
-                                    description: 'Indicates if the partial period will be prorated or charged a full amount.',
-                                },
-                            },
-                        },
-                        subscription_rate: {
-                            type: 'object',
-                            properties: {
-                                billing_frequency: {
-                                    type: 'string',
-                                    description: 'Frequency to bill subscription with. Together with product_id, must match existing rate on the rate card.',
-                                    enum: ['MONTHLY', 'QUARTERLY', 'ANNUAL', 'WEEKLY'],
-                                },
-                                product_id: {
-                                    type: 'string',
-                                    description: 'Must be subscription type product',
-                                },
-                            },
-                            required: ['billing_frequency', 'product_id'],
-                        },
-                        custom_fields: {
-                            type: 'object',
-                            description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
-                            additionalProperties: true,
-                        },
-                        description: {
-                            type: 'string',
-                        },
-                        ending_before: {
-                            type: 'string',
-                            description: 'Exclusive end time for the subscription. If not provided, subscription inherits contract end date.',
-                            format: 'date-time',
-                        },
-                        initial_quantity: {
-                            type: 'number',
-                            description: 'The initial quantity for the subscription. It must be non-negative value. Required if quantity_management_mode is QUANTITY_ONLY.',
-                        },
-                        name: {
-                            type: 'string',
-                        },
-                        quantity_management_mode: {
-                            type: 'string',
-                            description: "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. **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add user_123) to increment and decrement a subscription quantity, rather than directly providing the quantity. You must use a **SEAT_BASED** subscription to use a linked recurring credit with an allocation per seat. `seat_config` must be provided with this option.",
-                            enum: ['SEAT_BASED', 'QUANTITY_ONLY'],
-                        },
-                        seat_config: {
-                            type: 'object',
-                            properties: {
-                                initial_seat_ids: {
-                                    type: 'array',
-                                    description: 'The initial assigned seats on this subscription.',
-                                    items: {
-                                        type: 'string',
-                                    },
-                                },
-                                seat_group_key: {
-                                    type: 'string',
-                                    description: "The property name, sent on usage events, that identifies the seat ID associated with the usage event.  For example, the property name might be seat_id or user_id. The property must be set as a group key on billable metrics and a presentation/pricing group key on contract products.  This allows linked recurring credits with an allocation per seat to be consumed by only one seat's usage.",
-                                },
-                                initial_unassigned_seats: {
-                                    type: 'number',
-                                    description: 'The initial amount of unassigned seats on this subscription.',
-                                },
-                            },
-                            required: ['initial_seat_ids', 'seat_group_key'],
-                        },
-                        starting_at: {
-                            type: 'string',
-                            description: 'Inclusive start time for the subscription. If not provided, defaults to contract start date',
-                            format: 'date-time',
-                        },
-                        temporary_id: {
-                            type: 'string',
-                            description: 'A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.',
-                        },
-                    },
-                    required: ['collection_schedule', 'proration', 'subscription_rate'],
-                },
-            },
-            total_contract_value: {
-                type: 'number',
-                description: "This field's availability is dependent on your client's configuration.",
-            },
-            transition: {
-                type: 'object',
-                properties: {
-                    from_contract_id: {
-                        type: 'string',
-                    },
-                    type: {
-                        type: 'string',
-                        description: "This field's available values may vary based on your client's configuration.",
-                        enum: ['SUPERSEDE', 'RENEWAL'],
-                    },
-                    future_invoice_behavior: {
-                        type: 'object',
-                        properties: {
-                            trueup: {
-                                type: 'string',
-                                description: 'Controls whether future trueup invoices are billed or removed. Default behavior is AS_IS if not specified.',
-                                enum: ['REMOVE', 'AS_IS'],
-                            },
-                        },
-                    },
-                },
-                required: ['from_contract_id', 'type'],
-            },
-            uniqueness_key: {
-                type: 'string',
-                description: '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.',
-            },
-            usage_filter: {
-                $ref: '#/$defs/base_usage_filter',
-            },
-            usage_statement_schedule: {
-                type: 'object',
-                properties: {
-                    frequency: {
-                        type: 'string',
-                        enum: ['MONTHLY', 'QUARTERLY', 'ANNUAL', 'WEEKLY'],
-                    },
-                    billing_anchor_date: {
-                        type: 'string',
-                        description: '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.',
-                        format: 'date-time',
-                    },
-                    day: {
-                        type: 'string',
-                        description: 'If not provided, defaults to the first day of the month.',
-                        enum: ['FIRST_OF_MONTH', 'CONTRACT_START', 'CUSTOM_DATE'],
-                    },
-                    invoice_generation_starting_at: {
-                        type: 'string',
-                        description: "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.",
-                        format: 'date-time',
-                    },
-                },
-                required: ['frequency'],
-            },
-        },
-        required: ['customer_id', 'starting_at'],
-        $defs: {
-            commit_hierarchy_configuration: {
-                type: 'object',
-                properties: {
-                    child_access: {
-                        anyOf: [
-                            {
-                                type: 'object',
-                                properties: {
-                                    type: {
-                                        type: 'string',
-                                        enum: ['ALL'],
-                                    },
-                                },
-                                required: ['type'],
-                            },
-                            {
-                                type: 'object',
-                                properties: {
-                                    type: {
-                                        type: 'string',
-                                        enum: ['NONE'],
-                                    },
-                                },
-                                required: ['type'],
-                            },
-                            {
-                                type: 'object',
-                                properties: {
-                                    contract_ids: {
-                                        type: 'array',
-                                        items: {
-                                            type: 'string',
-                                        },
-                                    },
-                                    type: {
-                                        type: 'string',
-                                        enum: ['CONTRACT_IDS'],
-                                    },
-                                },
-                                required: ['contract_ids', 'type'],
-                            },
-                        ],
-                    },
-                },
-                required: ['child_access'],
-            },
-            commit_specifier_input: {
-                type: 'object',
-                properties: {
-                    presentation_group_values: {
-                        type: 'object',
-                        additionalProperties: true,
-                    },
-                    pricing_group_values: {
-                        type: 'object',
-                        additionalProperties: true,
-                    },
-                    product_id: {
-                        type: 'string',
-                        description: 'If provided, the specifier will only apply to the product with the specified ID.',
-                    },
-                    product_tags: {
-                        type: 'array',
-                        description: 'If provided, the specifier will only apply to products with all the specified tags.',
-                        items: {
-                            type: 'string',
-                        },
-                    },
-                },
-            },
-            tier: {
-                type: 'object',
-                properties: {
-                    price: {
-                        type: 'number',
-                    },
-                    size: {
-                        type: 'number',
-                    },
-                },
-                required: ['price'],
-            },
-            prepaid_balance_threshold_configuration: {
-                type: 'object',
-                properties: {
-                    commit: {
-                        allOf: [
-                            {
-                                $ref: '#/$defs/base_threshold_commit',
-                            },
-                        ],
-                    },
-                    is_enabled: {
-                        type: 'boolean',
-                        description: 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
-                    },
-                    payment_gate_config: {
-                        $ref: '#/$defs/payment_gate_config',
-                    },
-                    recharge_to_amount: {
-                        type: 'number',
-                        description: 'Specify the amount the balance should be recharged to.',
-                    },
-                    threshold_amount: {
-                        type: 'number',
-                        description: "Specify the threshold amount for the contract. Each time the contract's prepaid balance lowers to this amount, a threshold charge will be initiated.",
-                    },
-                    custom_credit_type_id: {
-                        type: 'string',
-                        description: 'If provided, the threshold, recharge-to amount, and the resulting threshold commit amount will be in terms of this credit type instead of the fiat currency.',
-                    },
-                },
-                required: ['commit', 'is_enabled', 'payment_gate_config', 'recharge_to_amount', 'threshold_amount'],
-            },
-            base_threshold_commit: {
-                type: 'object',
-                properties: {
-                    product_id: {
-                        type: 'string',
-                        description: 'The commit product that will be used to generate the line item for commit payment.',
-                    },
-                    description: {
-                        type: 'string',
-                    },
-                    name: {
-                        type: 'string',
-                        description: 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
-                    },
-                },
-                required: ['product_id'],
-            },
-            payment_gate_config: {
-                type: 'object',
-                properties: {
-                    payment_gate_type: {
-                        type: 'string',
-                        description: '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.',
-                        enum: ['NONE', 'STRIPE', 'EXTERNAL'],
-                    },
-                    precalculated_tax_config: {
-                        type: 'object',
-                        description: 'Only applicable if using PRECALCULATED as your tax type.',
-                        properties: {
-                            tax_amount: {
-                                type: 'number',
-                                description: "Amount of tax to be applied. This should be in the same currency and denomination  as the commit's invoice schedule",
-                            },
-                            tax_name: {
-                                type: 'string',
-                                description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
-                            },
-                        },
-                        required: ['tax_amount'],
-                    },
-                    stripe_config: {
-                        type: 'object',
-                        description: 'Only applicable if using STRIPE as your payment gate type.',
-                        properties: {
-                            payment_type: {
-                                type: 'string',
-                                description: 'If left blank, will default to INVOICE',
-                                enum: ['INVOICE', 'PAYMENT_INTENT'],
-                            },
-                            invoice_metadata: {
-                                type: 'object',
-                                description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
-                                additionalProperties: true,
-                            },
-                        },
-                        required: ['payment_type'],
-                    },
-                    tax_type: {
-                        type: 'string',
-                        description: '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.',
-                        enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
-                    },
-                },
-                required: ['payment_gate_type'],
-            },
-            spend_threshold_configuration: {
-                type: 'object',
-                properties: {
-                    commit: {
-                        $ref: '#/$defs/base_threshold_commit',
-                    },
-                    is_enabled: {
-                        type: 'boolean',
-                        description: 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
-                    },
-                    payment_gate_config: {
-                        $ref: '#/$defs/payment_gate_config',
-                    },
-                    threshold_amount: {
-                        type: 'number',
-                        description: "Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.",
-                    },
-                },
-                required: ['commit', 'is_enabled', 'payment_gate_config', 'threshold_amount'],
-            },
-            base_usage_filter: {
-                type: 'object',
-                properties: {
-                    group_key: {
-                        type: 'string',
-                    },
-                    group_values: {
-                        type: 'array',
-                        items: {
-                            type: 'string',
-                        },
-                    },
-                    starting_at: {
-                        type: 'string',
-                        format: 'date-time',
-                    },
-                },
-                required: ['group_key', 'group_values'],
-            },
-        },
-    },
-    annotations: {},
-};
-const handler = async (client, args) => {
-    const body = args;
-    try {
-        return (0, types_1.asTextContentResult)(await client.v1.contracts.create(body));
-    }
-    catch (error) {
-        if (error instanceof sdk_1.default.APIError) {
-            return (0, types_1.asErrorResult)(error.message);
-        }
-        throw error;
-    }
-};
-exports.handler = handler;
-exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };
-//# sourceMappingURL=create-v1-contracts.js.map