@metronome/sdk 1.0.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,106 @@
 # Changelog
 
+## 2.1.0 (2025-10-31)
+
+Full Changelog: [v2.0.0...v2.1.0](https://github.com/Metronome-Industries/metronome-node/compare/v2.0.0...v2.1.0)
+
+### Features
+
+* [ORCH-282] plumb `payment_method_id` to the payment gateway object ([15c6c79](https://github.com/Metronome-Industries/metronome-node/commit/15c6c79a1e6bf2eb5d0f7b56f33ca1457dfb3bef))
+* [ORCH-797] add billing_provider_error to invoice.external_invoice ([c0420d3](https://github.com/Metronome-Industries/metronome-node/commit/c0420d37de98fae7d378b9182b09014cf859e245))
+* Add avalara creds + billing provider APIs to SDK. Add avalara creds API to docs. ([039521a](https://github.com/Metronome-Industries/metronome-node/commit/039521addeac2953ff0f30e0c8a08cb972d24c65))
+* add beta tag to stripe auto charge items ([f5e38e8](https://github.com/Metronome-Industries/metronome-node/commit/f5e38e8c777fe60778583c4574345ee631179383))
+* add exclude_zero_balances field behind a FF for anthropic ([c8c7c29](https://github.com/Metronome-Industries/metronome-node/commit/c8c7c299261e60bf7865046357608732ff26c65d))
+* add METRONOME to BillingProvider type ([e242daa](https://github.com/Metronome-Industries/metronome-node/commit/e242daa137de8488bf9e63a3273f2abe9ba9438b))
+* docs(api) Documentation for seat-based subscription linked recurring commits beta release ([667067a](https://github.com/Metronome-Industries/metronome-node/commit/667067a9507777f4d478efdd360da6d1243e92b2))
+* ignore_duplicates ([4ec20ce](https://github.com/Metronome-Industries/metronome-node/commit/4ec20cebb5aa8f1aaa6d7f36dac434eab4cba5e1))
+* internal: moving plans docs to deprecated section of new docs site ([f8c0abf](https://github.com/Metronome-Industries/metronome-node/commit/f8c0abf50cb4f7b2a4ccdbec271c775d769ddb04))
+* not ready for review ([82f5869](https://github.com/Metronome-Industries/metronome-node/commit/82f5869b1f602f9b3b5e9e6bbf29aac79ff576fb))
+* not ready for review ([c2db062](https://github.com/Metronome-Industries/metronome-node/commit/c2db06258d902bc794389c29ec6f751bc63e0a0f))
+* Relax requirement on customer level commits for invoice_contract_id if do_not_invoice is set to true ([fb89c8e](https://github.com/Metronome-Industries/metronome-node/commit/fb89c8ea130da2171c3c5f48944559588788215f))
+* update get customer alerts api to include low seat balance type ([9d9c44c](https://github.com/Metronome-Industries/metronome-node/commit/9d9c44cf27578836e60a4a81f0118b9f24c88f85))
+
+
+### Bug Fixes
+
+* **api:** Make id field required in /v2/notifications/edit ([afd6647](https://github.com/Metronome-Industries/metronome-node/commit/afd6647d668f6031892fa1cbd6323514ce375e94))
+* **mcpb:** pin @anthropic-ai/mcpb version ([4542481](https://github.com/Metronome-Industries/metronome-node/commit/454248130b0cdd15854808634fd0beb9210e3ef0))
+
+
+### Chores
+
+* **api:** Note SQL BM is not supported in previewCustomerEvents description ([ea70362](https://github.com/Metronome-Industries/metronome-node/commit/ea70362ab43c4505d92b382bca361f937d162d3a))
+
+
+### Documentation
+
+* add migrate amendments to edits page ([8553655](https://github.com/Metronome-Industries/metronome-node/commit/85536552c0f2ab2e5f5be34a16ec43c9df705a32))
+
+## 2.0.0 (2025-10-16)
+
+Full Changelog: [v1.0.0...v2.0.0](https://github.com/Metronome-Industries/metronome-node/compare/v1.0.0...v2.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** Remove customer_id from preview events payload
+* **api:** in getEditHistory endpoint, commit invoice schedule amount, unit price, and quantity are now optional values
+* **api:** Added optional archive_filter param to /notifications/offset/list endpoint
+
+### Features
+
+* Add empty handler for cancelPayment ([8a9f2e8](https://github.com/Metronome-Industries/metronome-node/commit/8a9f2e800db4f6d977d8fade405836f91cf0ca9f))
+* Add payment + billing invoice APIs to the API reference docs ([8cd1d7a](https://github.com/Metronome-Industries/metronome-node/commit/8cd1d7a4678a3887a60fe26c6e6bda89fa4b9bec))
+* Add payment APIs to the SDK ([0adfefc](https://github.com/Metronome-Industries/metronome-node/commit/0adfefc9acf0ab3d480041495f2726446efb9cb4))
+* **api:** add billing_periods to Subscription ([9498382](https://github.com/Metronome-Industries/metronome-node/commit/9498382c48d925d2dc52fb5286d302009371751a))
+* **api:** add new payments/attempt v1 api endpoint ([51234ab](https://github.com/Metronome-Industries/metronome-node/commit/51234abdd9de4ed0a2733b3333e936abec7a4301))
+* **api:** Added optional archive_filter param to /notifications/offset/list endpoint ([efb0aa1](https://github.com/Metronome-Industries/metronome-node/commit/efb0aa188a8c2df9ec025e0f666886f3efd381a0))
+* **api:** Remove customer_id from preview events payload ([d80600b](https://github.com/Metronome-Industries/metronome-node/commit/d80600b4f3be4f9cfc3b94f6acbd13184c7e5c31))
+* Bump graphql version and fix type errors ([a6349d5](https://github.com/Metronome-Industries/metronome-node/commit/a6349d555d194b13a8f6fec4092e01dd49a4f7d4))
+* elia/orch 128 add external apis for payments ([637dc77](https://github.com/Metronome-Industries/metronome-node/commit/637dc77cdf4847ab2ab8458fc06f243d878db724))
+* feat(api):Allow clients retrieve archived config via `/notifications/get` ([ab0b0b1](https://github.com/Metronome-Industries/metronome-node/commit/ab0b0b10ab2102da479552ee5fc3155382085dbd))
+* internal: releasing x-mint ([6f0209a](https://github.com/Metronome-Industries/metronome-node/commit/6f0209a8aa776c96b61ca7bc93ad95b0704009b6))
+* internal: Skip retrieve_pdf API SDK tests ([47426e8](https://github.com/Metronome-Industries/metronome-node/commit/47426e8fea7aa2194c3e31d243becbda73295551))
+* internal(docs): adding confluent endpoints ([66682c2](https://github.com/Metronome-Industries/metronome-node/commit/66682c2705aa432cf5b42bf6c02da3aebbbc187b))
+* LAUNCH-516 add getSubscriptionSeatsScheduleHistory api ([87bffd4](https://github.com/Metronome-Industries/metronome-node/commit/87bffd4eef2a8bbe890d1efcdfddfd351236fa22))
+* **mcp:** add docs search tool ([5b2bce7](https://github.com/Metronome-Industries/metronome-node/commit/5b2bce751297111cae257591faa3da4546ff5065))
+* **mcp:** add option for including docs tools ([4e51097](https://github.com/Metronome-Industries/metronome-node/commit/4e51097669b68a0c473659530ff5920272db1559))
+* **mcp:** enable experimental docs search tool ([9f3a19d](https://github.com/Metronome-Industries/metronome-node/commit/9f3a19d6fd24629865c90ec943be13066929724c))
+* rename getSubscriptionSeatsScheduleHistory to getSubscriptionSeatsHistory ([2a45a7e](https://github.com/Metronome-Industries/metronome-node/commit/2a45a7ecf906d1e07d5530385138590f940626f7))
+* Return array of invoices instead of single invoice and handle multipl… ([843ca4c](https://github.com/Metronome-Industries/metronome-node/commit/843ca4c0cbb15c4bcb13a66ce783452adbad9316))
+* Set up contract get and create with new AH info ([2a15df8](https://github.com/Metronome-Industries/metronome-node/commit/2a15df82e9595ba74d5ca3625d8a582bd9838cb6))
+* update api docs ([ddc0510](https://github.com/Metronome-Industries/metronome-node/commit/ddc0510f876f3cdea0456301c0ec6ef4548100b5))
+
+
+### Bug Fixes
+
+* **api:** in getEditHistory endpoint, commit invoice schedule amount, unit price, and quantity are now optional values ([df927b1](https://github.com/Metronome-Industries/metronome-node/commit/df927b13491689eeb4fa6db96d0989c2e14b76d2))
+* **ci:** set permissions for DXT publish action ([b1bcdad](https://github.com/Metronome-Industries/metronome-node/commit/b1bcdadbf37415497c02cd83e38695be81ac7b44))
+* LAUNCH-1130 remove min and max in api spec for better valiation error message ([20b4d2c](https://github.com/Metronome-Industries/metronome-node/commit/20b4d2cba2d177a71bed7f9db62faabab028cc81))
+* **mcp:** fix cli argument parsing logic ([6db4b4a](https://github.com/Metronome-Industries/metronome-node/commit/6db4b4af661841fe68536cc086a270ea9b93d71f))
+
+
+### Performance Improvements
+
+* faster formatting ([08badd1](https://github.com/Metronome-Industries/metronome-node/commit/08badd16ee6d0a3594977c68540a233fabac163a))
+
+
+### Chores
+
+* **codegen:** internal codegen update ([1dc34a9](https://github.com/Metronome-Industries/metronome-node/commit/1dc34a9cc5066a72c19cfd382472d607effcde75))
+* do not install brew dependencies in ./scripts/bootstrap by default ([607b9b0](https://github.com/Metronome-Industries/metronome-node/commit/607b9b0ada5cb004718cd31c074333c6d9870bdf))
+* extract some types in mcp docs ([2f279f4](https://github.com/Metronome-Industries/metronome-node/commit/2f279f4edb3881f5b4b4ab8577497159915c6680))
+* **internal:** codegen related update ([dde1c3b](https://github.com/Metronome-Industries/metronome-node/commit/dde1c3bababf9ce3b224aa0bd8f69e6a395548e3))
+* **internal:** fix incremental formatting in some cases ([e6aa27e](https://github.com/Metronome-Industries/metronome-node/commit/e6aa27e75896fc2b10f8f0c3f890c839c812afc0))
+* **internal:** gitignore .mcpb files ([0e48487](https://github.com/Metronome-Industries/metronome-node/commit/0e48487bcbd06f3230acd0d9ffa44f9d684d2ae5))
+* **internal:** ignore .eslintcache ([63e1f8e](https://github.com/Metronome-Industries/metronome-node/commit/63e1f8e459f108f4f5d10e2e3a93c64ec090b006))
+* **internal:** remove .eslintcache ([68b87db](https://github.com/Metronome-Industries/metronome-node/commit/68b87dbb06b8b2d3ca403a713434b6daf4a6170b))
+* **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([da007e0](https://github.com/Metronome-Industries/metronome-node/commit/da007e0a5e459e623ed8fe8f9b255a70f29532d4))
+* **internal:** use npm pack for build uploads ([610d7b1](https://github.com/Metronome-Industries/metronome-node/commit/610d7b191822a83c6afdd9c4b67859a14b05f653))
+* **jsdoc:** fix [@link](https://github.com/link) annotations to refer only to parts of the package‘s public interface ([2192205](https://github.com/Metronome-Industries/metronome-node/commit/21922059a1991ea558e77aea79993685f873167f))
+* **mcp:** allow pointing `docs_search` tool at other URLs ([996112b](https://github.com/Metronome-Industries/metronome-node/commit/996112b87d1cf2cd7421f49143f40762e4b0b656))
+* **mcp:** rename dxt to mcpb ([f57db37](https://github.com/Metronome-Industries/metronome-node/commit/f57db3729eadc05ce4b806ff8748540abb7b04ff))
+* update lockfile ([1657600](https://github.com/Metronome-Industries/metronome-node/commit/16576000f23fe49205c7d4d9842416627a7ffbad))
+
 ## 1.0.0 (2025-09-15)
 
 Full Changelog: [v0.3.0...v1.0.0](https://github.com/Metronome-Industries/metronome-node/compare/v0.3.0...v1.0.0)

package/bin/cli

@@ -4,26 +4,19 @@ const { spawnSync } = require('child_process');
 
 const commands = {
   migrate: {
-    description:
-      'Run migrations to update your code using @metronome/sdk@0.3.0 to be compatible with @metronome/sdk@1.0.0',
+    description: 'Run migrations to update your code using @metronome/sdk@0.3.0 to be compatible with @metronome/sdk@1.0.0',
     fn: () => {
       const result = spawnSync(
         'npx',
-        [
-          '-y',
-          'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz',
-          '--migrationConfig',
-          require.resolve('./migration-config.json'),
-          ...process.argv.slice(3),
-        ],
+        ['-y', 'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz', '--migrationConfig', require.resolve('./migration-config.json'), ...process.argv.slice(3)],
         { stdio: 'inherit' },
       );
       if (result.status !== 0) {
         process.exit(result.status);
       }
-    },
-  },
-};
+    }
+  }
+}
 
 function exitWithHelp() {
   console.log(`Usage: metronome-sdk <subcommand>`);

package/internal/to-file.d.mts

@@ -33,7 +33,7 @@ export interface ResponseLike {
 export type ToFileInput = FileLike | ResponseLike | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
 /**
  * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
+ * @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
  * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  * @param {Object=} options additional properties
  * @param {string=} options.type the MIME type of the content

package/internal/to-file.d.ts

@@ -33,7 +33,7 @@ export interface ResponseLike {
 export type ToFileInput = FileLike | ResponseLike | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
 /**
  * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
+ * @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
  * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  * @param {Object=} options additional properties
  * @param {string=} options.type the MIME type of the content

package/internal/to-file.js

@@ -27,7 +27,7 @@ const isResponseLike = (value) => value != null &&
     typeof value.blob === 'function';
 /**
  * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
+ * @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
  * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  * @param {Object=} options additional properties
  * @param {string=} options.type the MIME type of the content

package/internal/to-file.mjs

@@ -24,7 +24,7 @@ const isResponseLike = (value) => value != null &&
     typeof value.blob === 'function';
 /**
  * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
+ * @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
  * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  * @param {Object=} options additional properties
  * @param {string=} options.type the MIME type of the content

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metronome/sdk",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "The official TypeScript library for the Metronome API",
   "author": "Metronome <dev-feedback@metronome.com>",
   "types": "./index.d.ts",

package/resources/shared.d.mts

@@ -387,7 +387,7 @@ export declare namespace Contract {
      */
     interface CustomerBillingProviderConfiguration {
         archived_at: string | null;
-        billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
+        billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace' | 'metronome';
         delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
         id?: string;
         /**
@@ -437,7 +437,7 @@ export interface ContractV2 {
      * Either a **parent** configuration with a list of children or a **child**
      * configuration with a single parent.
      */
-    hierarchy_configuration?: HierarchyConfiguration;
+    hierarchy_configuration?: ContractV2.ParentHierarchyConfiguration | ContractV2.ChildHierarchyConfigurationV2;
     /**
      * Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
      * prices automatically. EXPLICIT prioritization requires specifying priorities for
@@ -694,7 +694,7 @@ export declare namespace ContractV2 {
         multiplier?: number;
         override_specifiers?: Array<Override.OverrideSpecifier>;
         override_tiers?: Array<Shared.OverrideTier>;
-        overwrite_rate?: Shared.OverwriteRate;
+        overwrite_rate?: Override.OverwriteRate;
         priority?: number;
         product?: Override.Product;
         target?: 'COMMIT_RATE' | 'LIST_RATE';
@@ -715,6 +715,35 @@ export declare namespace ContractV2 {
             recurring_commit_ids?: Array<string>;
             recurring_credit_ids?: Array<string>;
         }
+        interface OverwriteRate {
+            rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+            credit_type?: Shared.CreditTypeData;
+            /**
+             * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+             * processors.
+             */
+            custom_rate?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+             * set to true.
+             */
+            is_prorated?: boolean;
+            /**
+             * Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+             * this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+             */
+            price?: number;
+            /**
+             * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+             */
+            quantity?: number;
+            /**
+             * Only set for TIERED rate_type.
+             */
+            tiers?: Array<Shared.Tier>;
+        }
         interface Product {
             id: string;
             name: string;
@@ -871,7 +900,7 @@ export declare namespace ContractV2 {
          * ID of Customer's billing provider configuration.
          */
         id: string;
-        billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
+        billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace' | 'metronome';
         delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
     }
     /**
@@ -892,6 +921,63 @@ export declare namespace ContractV2 {
          */
         credits: boolean;
     }
+    interface ParentHierarchyConfiguration {
+        /**
+         * List of contracts that belong to this parent.
+         */
+        children: Array<ParentHierarchyConfiguration.Child>;
+        parent_behavior?: ParentHierarchyConfiguration.ParentBehavior;
+    }
+    namespace ParentHierarchyConfiguration {
+        interface Child {
+            contract_id: string;
+            customer_id: string;
+        }
+        interface ParentBehavior {
+            /**
+             * Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+             * generated by the parent in a customer hierarchy
+             *
+             * **CONCATENATE**: Statements on the invoices of child customers will be appended
+             * to the consolidated invoice
+             *
+             * **NONE**: Do not generate consolidated invoices
+             */
+            invoice_consolidation_type?: 'CONCATENATE' | 'NONE';
+        }
+    }
+    interface ChildHierarchyConfigurationV2 {
+        /**
+         * The single parent contract/customer for this child.
+         */
+        parent: ChildHierarchyConfigurationV2.Parent;
+        /**
+         * Account hierarchy M3 - Indicates which customer should pay for the child's
+         * invoice charges **SELF**: The child pays for its own invoice charges **PARENT**:
+         * The parent pays for the child's invoice charges
+         */
+        payer?: 'SELF' | 'PARENT';
+        /**
+         * Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+         * on the parent's invoices.
+         *
+         * **CONSOLIDATE**: Child's invoice statements will be added to parent's
+         * consolidated invoices
+         *
+         * **SEPARATE**: Child's invoice statements will appear not appear on parent's
+         * consolidated invoices
+         */
+        usage_statement_behavior?: 'CONSOLIDATE' | 'SEPARATE';
+    }
+    namespace ChildHierarchyConfigurationV2 {
+        /**
+         * The single parent contract/customer for this child.
+         */
+        interface Parent {
+            contract_id: string;
+            customer_id: string;
+        }
+    }
     interface RecurringCommit {
         id: string;
         /**
@@ -1149,7 +1235,7 @@ export interface ContractWithoutAmendments {
     usage_statement_schedule: ContractWithoutAmendments.UsageStatementSchedule;
     credits?: Array<Credit>;
     /**
-     * This field's availability is dependent on your client's configuration.
+     * This field's availability is dependent on your client's
      */
     discounts?: Array<Discount>;
     ending_before?: string;
@@ -1639,18 +1725,51 @@ export declare namespace HierarchyConfiguration {
          * List of contracts that belong to this parent.
          */
         children: Array<ParentHierarchyConfiguration.Child>;
+        parent_behavior?: ParentHierarchyConfiguration.ParentBehavior;
     }
     namespace ParentHierarchyConfiguration {
         interface Child {
             contract_id: string;
             customer_id: string;
         }
+        interface ParentBehavior {
+            /**
+             * Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+             * generated by the parent in a customer hierarchy
+             *
+             * **CONCATENATE**: Statements on the invoices of child customers will be appended
+             * to the consolidated invoice
+             *
+             * **NONE**: Do not generate consolidated invoices
+             */
+            invoice_consolidation_type?: 'CONCATENATE' | 'NONE';
+        }
     }
     interface ChildHierarchyConfiguration {
         /**
          * The single parent contract/customer for this child.
          */
         parent: ChildHierarchyConfiguration.Parent;
+        /**
+         * Account hierarchy M3 - Indicates which customer should pay for the child's
+         * invoice charges
+         *
+         * **SELF**: The child pays for its own invoice charges
+         *
+         * **PARENT**: The parent pays for the child's invoice charges
+         */
+        payer?: 'SELF' | 'PARENT';
+        /**
+         * Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+         * on the parent's invoices.
+         *
+         * **CONSOLIDATE**: Child's invoice statements will be added to parent's
+         * consolidated invoices
+         *
+         * **SEPARATE**: Child's invoice statements will appear not appear on parent's
+         * consolidated invoices
+         */
+        usage_statement_behavior?: 'CONSOLIDATE' | 'SEPARATE';
     }
     namespace ChildHierarchyConfiguration {
         /**
@@ -1782,7 +1901,7 @@ export interface PaymentGateConfig {
      * not wish Metronome to calculate tax on your behalf. Leaving this field blank
      * will default to NONE.
      */
-    tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'AVALARA' | 'PRECALCULATED';
 }
 export declare namespace PaymentGateConfig {
     /**
@@ -1838,7 +1957,7 @@ export interface PaymentGateConfigV2 {
      * not wish Metronome to calculate tax on your behalf. Leaving this field blank
      * will default to NONE.
      */
-    tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'AVALARA' | 'PRECALCULATED';
 }
 export declare namespace PaymentGateConfigV2 {
     /**
@@ -2168,6 +2287,10 @@ export interface SpendThresholdConfigurationV2 {
     threshold_amount: number;
 }
 export interface Subscription {
+    /**
+     * Previous, current, and next billing periods for the subscription.
+     */
+    billing_periods: Subscription.BillingPeriods;
     collection_schedule: 'ADVANCE' | 'ARREARS';
     proration: Subscription.Proration;
     /**
@@ -2175,6 +2298,11 @@ export interface Subscription {
      * 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**: (BETA) 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.
      */
     quantity_management_mode: 'SEAT_BASED' | 'QUANTITY_ONLY';
     /**
@@ -2197,6 +2325,28 @@ export interface Subscription {
     name?: string;
 }
 export declare namespace Subscription {
+    /**
+     * Previous, current, and next billing periods for the subscription.
+     */
+    interface BillingPeriods {
+        current?: BillingPeriods.Current;
+        next?: BillingPeriods.Next;
+        previous?: BillingPeriods.Previous;
+    }
+    namespace BillingPeriods {
+        interface Current {
+            ending_before: string;
+            starting_at: string;
+        }
+        interface Next {
+            ending_before: string;
+            starting_at: string;
+        }
+        interface Previous {
+            ending_before: string;
+            starting_at: string;
+        }
+    }
     interface Proration {
         invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
         is_prorated: boolean;