@metronome/sdk 0.1.0 → 0.3.0

package/resources/v2/contracts.d.ts

@@ -327,6 +327,7 @@ export declare namespace ContractRetrieveResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+                contract_id?: string;
             }
             interface PrepaidCommitRolloverLedgerEntry {
                 amount: number;
@@ -347,6 +348,7 @@ export declare namespace ContractRetrieveResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'PREPAID_COMMIT_CANCELED';
+                contract_id?: string;
             }
             interface PrepaidCommitCreditedLedgerEntry {
                 amount: number;
@@ -354,6 +356,7 @@ export declare namespace ContractRetrieveResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'PREPAID_COMMIT_CREDITED';
+                contract_id?: string;
             }
             interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
                 amount: number;
@@ -372,6 +375,7 @@ export declare namespace ContractRetrieveResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+                contract_id?: string;
             }
             interface PostpaidCommitRolloverLedgerEntry {
                 amount: number;
@@ -385,6 +389,7 @@ export declare namespace ContractRetrieveResponse {
                 invoice_id: string;
                 timestamp: string;
                 type: 'POSTPAID_COMMIT_TRUEUP';
+                contract_id?: string;
             }
             interface PrepaidCommitManualLedgerEntry {
                 amount: number;
@@ -615,6 +620,7 @@ export declare namespace ContractRetrieveResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
+                contract_id?: string;
             }
             interface CreditExpirationLedgerEntry {
                 amount: number;
@@ -628,6 +634,7 @@ export declare namespace ContractRetrieveResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'CREDIT_CANCELED';
+                contract_id?: string;
             }
             interface CreditCreditedLedgerEntry {
                 amount: number;
@@ -635,6 +642,7 @@ export declare namespace ContractRetrieveResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'CREDIT_CREDITED';
+                contract_id?: string;
             }
             interface CreditManualLedgerEntry {
                 amount: number;
@@ -670,6 +678,10 @@ export declare namespace ContractRetrieveResponse {
          * This field's availability is dependent on your client's configuration.
          */
         interface CustomerBillingProviderConfiguration {
+            /**
+             * ID of Customer's billing provider configuration.
+             */
+            id: string;
             billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
             delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
         }
@@ -772,6 +784,8 @@ export declare namespace ContractRetrieveResponse {
                  * 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`.
+                 * Instead, to target usage by product or product tag, pass those values in the
+                 * body of `specifiers`.
                  */
                 specifiers?: Array<Commit.Specifier>;
             }
@@ -892,7 +906,7 @@ export declare namespace ContractRetrieveResponse {
              */
             ending_before?: string;
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
             /**
@@ -932,6 +946,10 @@ export declare namespace ContractRetrieveResponse {
              * specifiers to contribute to a commit's or credit's drawdown.
              */
             specifiers?: Array<RecurringCommit.Specifier>;
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            subscription_config?: RecurringCommit.SubscriptionConfig;
         }
         namespace RecurringCommit {
             /**
@@ -957,7 +975,7 @@ export declare namespace ContractRetrieveResponse {
                 id: string;
             }
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             interface HierarchyConfiguration {
                 child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -999,6 +1017,22 @@ export declare namespace ContractRetrieveResponse {
                  */
                 product_tags?: Array<string>;
             }
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            interface SubscriptionConfig {
+                allocation: 'INDIVIDUAL' | 'POOLED';
+                apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+                subscription_id: string;
+            }
+            namespace SubscriptionConfig {
+                interface ApplySeatIncreaseConfig {
+                    /**
+                     * Indicates whether a mid-period seat increase should be prorated.
+                     */
+                    is_prorated: boolean;
+                }
+            }
         }
         interface RecurringCredit {
             id: string;
@@ -1041,7 +1075,7 @@ export declare namespace ContractRetrieveResponse {
              */
             ending_before?: string;
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
             /**
@@ -1077,6 +1111,10 @@ export declare namespace ContractRetrieveResponse {
              * specifiers to contribute to a commit's or credit's drawdown.
              */
             specifiers?: Array<RecurringCredit.Specifier>;
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            subscription_config?: RecurringCredit.SubscriptionConfig;
         }
         namespace RecurringCredit {
             /**
@@ -1102,7 +1140,7 @@ export declare namespace ContractRetrieveResponse {
                 id: string;
             }
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             interface HierarchyConfiguration {
                 child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -1136,6 +1174,22 @@ export declare namespace ContractRetrieveResponse {
                  */
                 product_tags?: Array<string>;
             }
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            interface SubscriptionConfig {
+                allocation: 'INDIVIDUAL' | 'POOLED';
+                apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+                subscription_id: string;
+            }
+            namespace SubscriptionConfig {
+                interface ApplySeatIncreaseConfig {
+                    /**
+                     * Indicates whether a mid-period seat increase should be prorated.
+                     */
+                    is_prorated: boolean;
+                }
+            }
         }
         interface ResellerRoyalty {
             reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -1495,6 +1549,7 @@ export declare namespace ContractListResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+                contract_id?: string;
             }
             interface PrepaidCommitRolloverLedgerEntry {
                 amount: number;
@@ -1515,6 +1570,7 @@ export declare namespace ContractListResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'PREPAID_COMMIT_CANCELED';
+                contract_id?: string;
             }
             interface PrepaidCommitCreditedLedgerEntry {
                 amount: number;
@@ -1522,6 +1578,7 @@ export declare namespace ContractListResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'PREPAID_COMMIT_CREDITED';
+                contract_id?: string;
             }
             interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
                 amount: number;
@@ -1540,6 +1597,7 @@ export declare namespace ContractListResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+                contract_id?: string;
             }
             interface PostpaidCommitRolloverLedgerEntry {
                 amount: number;
@@ -1553,6 +1611,7 @@ export declare namespace ContractListResponse {
                 invoice_id: string;
                 timestamp: string;
                 type: 'POSTPAID_COMMIT_TRUEUP';
+                contract_id?: string;
             }
             interface PrepaidCommitManualLedgerEntry {
                 amount: number;
@@ -1783,6 +1842,7 @@ export declare namespace ContractListResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
+                contract_id?: string;
             }
             interface CreditExpirationLedgerEntry {
                 amount: number;
@@ -1796,6 +1856,7 @@ export declare namespace ContractListResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'CREDIT_CANCELED';
+                contract_id?: string;
             }
             interface CreditCreditedLedgerEntry {
                 amount: number;
@@ -1803,6 +1864,7 @@ export declare namespace ContractListResponse {
                 segment_id: string;
                 timestamp: string;
                 type: 'CREDIT_CREDITED';
+                contract_id?: string;
             }
             interface CreditManualLedgerEntry {
                 amount: number;
@@ -1838,6 +1900,10 @@ export declare namespace ContractListResponse {
          * This field's availability is dependent on your client's configuration.
          */
         interface CustomerBillingProviderConfiguration {
+            /**
+             * ID of Customer's billing provider configuration.
+             */
+            id: string;
             billing_provider: 'aws_marketplace' | 'stripe' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace';
             delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
         }
@@ -1940,6 +2006,8 @@ export declare namespace ContractListResponse {
                  * 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`.
+                 * Instead, to target usage by product or product tag, pass those values in the
+                 * body of `specifiers`.
                  */
                 specifiers?: Array<Commit.Specifier>;
             }
@@ -2060,7 +2128,7 @@ export declare namespace ContractListResponse {
              */
             ending_before?: string;
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
             /**
@@ -2100,6 +2168,10 @@ export declare namespace ContractListResponse {
              * specifiers to contribute to a commit's or credit's drawdown.
              */
             specifiers?: Array<RecurringCommit.Specifier>;
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            subscription_config?: RecurringCommit.SubscriptionConfig;
         }
         namespace RecurringCommit {
             /**
@@ -2125,7 +2197,7 @@ export declare namespace ContractListResponse {
                 id: string;
             }
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             interface HierarchyConfiguration {
                 child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -2167,6 +2239,22 @@ export declare namespace ContractListResponse {
                  */
                 product_tags?: Array<string>;
             }
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            interface SubscriptionConfig {
+                allocation: 'INDIVIDUAL' | 'POOLED';
+                apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+                subscription_id: string;
+            }
+            namespace SubscriptionConfig {
+                interface ApplySeatIncreaseConfig {
+                    /**
+                     * Indicates whether a mid-period seat increase should be prorated.
+                     */
+                    is_prorated: boolean;
+                }
+            }
         }
         interface RecurringCredit {
             id: string;
@@ -2209,7 +2297,7 @@ export declare namespace ContractListResponse {
              */
             ending_before?: string;
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
             /**
@@ -2245,6 +2333,10 @@ export declare namespace ContractListResponse {
              * specifiers to contribute to a commit's or credit's drawdown.
              */
             specifiers?: Array<RecurringCredit.Specifier>;
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            subscription_config?: RecurringCredit.SubscriptionConfig;
         }
         namespace RecurringCredit {
             /**
@@ -2270,7 +2362,7 @@ export declare namespace ContractListResponse {
                 id: string;
             }
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             interface HierarchyConfiguration {
                 child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -2304,6 +2396,22 @@ export declare namespace ContractListResponse {
                  */
                 product_tags?: Array<string>;
             }
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            interface SubscriptionConfig {
+                allocation: 'INDIVIDUAL' | 'POOLED';
+                apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+                subscription_id: string;
+            }
+            namespace SubscriptionConfig {
+                interface ApplySeatIncreaseConfig {
+                    /**
+                     * Indicates whether a mid-period seat increase should be prorated.
+                     */
+                    is_prorated: boolean;
+                }
+            }
         }
         interface ResellerRoyalty {
             reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -2523,6 +2631,10 @@ export declare namespace ContractGetEditHistoryResponse {
             applicable_product_ids?: Array<string>;
             applicable_product_tags?: Array<string>;
             description?: string;
+            /**
+             * Optional configuration for commit hierarchy access control
+             */
+            hierarchy_configuration?: AddCommit.HierarchyConfiguration;
             /**
              * The schedule that the customer will be invoiced for this commit.
              */
@@ -2548,6 +2660,8 @@ export declare namespace ContractGetEditHistoryResponse {
              * 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`.
+             * Instead, to target usage by product or product tag, pass those values in the
+             * body of `specifiers`.
              */
             specifiers?: Array<AddCommit.Specifier>;
         }
@@ -2556,6 +2670,24 @@ export declare namespace ContractGetEditHistoryResponse {
                 id: string;
                 name: string;
             }
+            /**
+             * Optional configuration for commit hierarchy access control
+             */
+            interface HierarchyConfiguration {
+                child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+            }
+            namespace HierarchyConfiguration {
+                interface CommitHierarchyChildAccessAll {
+                    type: 'ALL';
+                }
+                interface CommitHierarchyChildAccessNone {
+                    type: 'NONE';
+                }
+                interface CommitHierarchyChildAccessContractIDs {
+                    contract_ids: Array<string>;
+                    type: 'CONTRACT_IDS';
+                }
+            }
             interface Specifier {
                 presentation_group_values?: {
                     [key: string]: string;
@@ -2585,6 +2717,10 @@ export declare namespace ContractGetEditHistoryResponse {
             applicable_product_ids?: Array<string>;
             applicable_product_tags?: Array<string>;
             description?: string;
+            /**
+             * Optional configuration for recurring credit hierarchy access control
+             */
+            hierarchy_configuration?: AddCredit.HierarchyConfiguration;
             name?: string;
             /**
              * This field's availability is dependent on your client's configuration.
@@ -2604,6 +2740,8 @@ export declare namespace ContractGetEditHistoryResponse {
              * 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`.
+             * Instead, to target usage by product or product tag, pass those values in the
+             * body of `specifiers`.
              */
             specifiers?: Array<AddCredit.Specifier>;
         }
@@ -2612,6 +2750,24 @@ export declare namespace ContractGetEditHistoryResponse {
                 id: string;
                 name: string;
             }
+            /**
+             * Optional configuration for recurring credit hierarchy access control
+             */
+            interface HierarchyConfiguration {
+                child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+            }
+            namespace HierarchyConfiguration {
+                interface CommitHierarchyChildAccessAll {
+                    type: 'ALL';
+                }
+                interface CommitHierarchyChildAccessNone {
+                    type: 'NONE';
+                }
+                interface CommitHierarchyChildAccessContractIDs {
+                    contract_ids: Array<string>;
+                    type: 'CONTRACT_IDS';
+                }
+            }
             interface Specifier {
                 presentation_group_values?: {
                     [key: string]: string;
@@ -2753,6 +2909,8 @@ export declare namespace ContractGetEditHistoryResponse {
                  * 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`.
+                 * Instead, to target usage by product or product tag, pass those values in the
+                 * body of `specifiers`.
                  */
                 specifiers?: Array<Commit.Specifier>;
             }
@@ -2873,7 +3031,7 @@ export declare namespace ContractGetEditHistoryResponse {
              */
             ending_before?: string;
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             hierarchy_configuration?: AddRecurringCommit.HierarchyConfiguration;
             /**
@@ -2913,6 +3071,10 @@ export declare namespace ContractGetEditHistoryResponse {
              * specifiers to contribute to a commit's or credit's drawdown.
              */
             specifiers?: Array<AddRecurringCommit.Specifier>;
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            subscription_config?: AddRecurringCommit.SubscriptionConfig;
         }
         namespace AddRecurringCommit {
             /**
@@ -2938,7 +3100,7 @@ export declare namespace ContractGetEditHistoryResponse {
                 id: string;
             }
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             interface HierarchyConfiguration {
                 child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -2980,6 +3142,22 @@ export declare namespace ContractGetEditHistoryResponse {
                  */
                 product_tags?: Array<string>;
             }
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            interface SubscriptionConfig {
+                allocation: 'INDIVIDUAL' | 'POOLED';
+                apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+                subscription_id: string;
+            }
+            namespace SubscriptionConfig {
+                interface ApplySeatIncreaseConfig {
+                    /**
+                     * Indicates whether a mid-period seat increase should be prorated.
+                     */
+                    is_prorated: boolean;
+                }
+            }
         }
         interface AddRecurringCredit {
             id: string;
@@ -3022,7 +3200,7 @@ export declare namespace ContractGetEditHistoryResponse {
              */
             ending_before?: string;
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             hierarchy_configuration?: AddRecurringCredit.HierarchyConfiguration;
             /**
@@ -3058,6 +3236,10 @@ export declare namespace ContractGetEditHistoryResponse {
              * specifiers to contribute to a commit's or credit's drawdown.
              */
             specifiers?: Array<AddRecurringCredit.Specifier>;
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            subscription_config?: AddRecurringCredit.SubscriptionConfig;
         }
         namespace AddRecurringCredit {
             /**
@@ -3083,7 +3265,7 @@ export declare namespace ContractGetEditHistoryResponse {
                 id: string;
             }
             /**
-             * Optional configuration for recurring commit/credit hierarchy access control
+             * Optional configuration for recurring credit hierarchy access control
              */
             interface HierarchyConfiguration {
                 child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -3117,6 +3299,22 @@ export declare namespace ContractGetEditHistoryResponse {
                  */
                 product_tags?: Array<string>;
             }
+            /**
+             * Attach a subscription to the recurring commit/credit.
+             */
+            interface SubscriptionConfig {
+                allocation: 'INDIVIDUAL' | 'POOLED';
+                apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+                subscription_id: string;
+            }
+            namespace SubscriptionConfig {
+                interface ApplySeatIncreaseConfig {
+                    /**
+                     * Indicates whether a mid-period seat increase should be prorated.
+                     */
+                    is_prorated: boolean;
+                }
+            }
         }
         interface AddResellerRoyalty {
             reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -3319,9 +3517,18 @@ export declare namespace ContractGetEditHistoryResponse {
              * all products.
              */
             applicable_product_tags?: Array<string> | null;
+            /**
+             * Optional configuration for commit hierarchy access control
+             */
+            hierarchy_configuration?: UpdateCommit.HierarchyConfiguration;
             invoice_schedule?: UpdateCommit.InvoiceSchedule;
             name?: string;
             netsuite_sales_order_id?: string | null;
+            /**
+             * If multiple commits are applicable, the one with the lower priority will apply
+             * first.
+             */
+            priority?: number | null;
             product_id?: string;
             rollover_fraction?: number | null;
             /**
@@ -3329,6 +3536,8 @@ export declare namespace ContractGetEditHistoryResponse {
              * 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`.
+             * Instead, to target usage by product or product tag, pass those values in the
+             * body of `specifiers`.
              */
             specifiers?: Array<UpdateCommit.Specifier> | null;
         }
@@ -3366,6 +3575,24 @@ export declare namespace ContractGetEditHistoryResponse {
                     starting_at?: string;
                 }
             }
+            /**
+             * Optional configuration for commit hierarchy access control
+             */
+            interface HierarchyConfiguration {
+                child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+            }
+            namespace HierarchyConfiguration {
+                interface CommitHierarchyChildAccessAll {
+                    type: 'ALL';
+                }
+                interface CommitHierarchyChildAccessNone {
+                    type: 'NONE';
+                }
+                interface CommitHierarchyChildAccessContractIDs {
+                    contract_ids: Array<string>;
+                    type: 'CONTRACT_IDS';
+                }
+            }
             interface InvoiceSchedule {
                 add_schedule_items?: Array<InvoiceSchedule.AddScheduleItem>;
                 remove_schedule_items?: Array<InvoiceSchedule.RemoveScheduleItem>;
@@ -3410,8 +3637,17 @@ export declare namespace ContractGetEditHistoryResponse {
         interface UpdateCredit {
             id: string;
             access_schedule?: UpdateCredit.AccessSchedule;
+            /**
+             * Optional configuration for credit hierarchy access control
+             */
+            hierarchy_configuration?: UpdateCredit.HierarchyConfiguration;
             name?: string;
             netsuite_sales_order_id?: string | null;
+            /**
+             * If multiple credits are applicable, the one with the lower priority will apply
+             * first.
+             */
+            priority?: number | null;
             rollover_fraction?: number | null;
         }
         namespace UpdateCredit {
@@ -3448,6 +3684,24 @@ export declare namespace ContractGetEditHistoryResponse {
                     starting_at?: string;
                 }
             }
+            /**
+             * Optional configuration for credit hierarchy access control
+             */
+            interface HierarchyConfiguration {
+                child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+            }
+            namespace HierarchyConfiguration {
+                interface CommitHierarchyChildAccessAll {
+                    type: 'ALL';
+                }
+                interface CommitHierarchyChildAccessNone {
+                    type: 'NONE';
+                }
+                interface CommitHierarchyChildAccessContractIDs {
+                    contract_ids: Array<string>;
+                    type: 'CONTRACT_IDS';
+                }
+            }
         }
         interface UpdateDiscount {
             id: string;
@@ -3467,9 +3721,14 @@ export declare namespace ContractGetEditHistoryResponse {
              */
             interface Schedule {
                 /**
-                 * Defaults to USD if not passed. Only USD is supported at this time.
+                 * Defaults to USD (cents) if not passed.
                  */
                 credit_type_id?: string;
+                /**
+                 * This field is only applicable to commit invoice schedules. If true, this
+                 * schedule will not generate an invoice.
+                 */
+                do_not_invoice?: boolean;
                 /**
                  * Enter the unit price and quantity for the charge or instead only send the
                  * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3596,6 +3855,8 @@ export declare namespace ContractGetEditHistoryResponse {
                  * 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`.
+                 * Instead, to target usage by product or product tag, pass those values in the
+                 * body of `specifiers`.
                  */
                 specifiers?: Array<Commit.Specifier> | null;
             }
@@ -4037,6 +4298,8 @@ export declare namespace ContractEditParams {
          * 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`.
+         * Instead, to target usage by product or product tag, pass those values in the
+         * body of `specifiers`.
          */
         specifiers?: Array<AddCommit.Specifier>;
         /**
@@ -4094,9 +4357,14 @@ export declare namespace ContractEditParams {
          */
         interface InvoiceSchedule {
             /**
-             * Defaults to USD if not passed. Only USD is supported at this time.
+             * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -4226,6 +4494,17 @@ export declare namespace ContractEditParams {
                 invoice_metadata?: {
                     [key: string]: string;
                 };
+                /**
+                 * If true, the payment will be made assuming the customer is present (i.e. on
+                 * session).
+                 *
+                 * If false, the payment will be made assuming the customer is not present (i.e.
+                 * off session). For cardholders from a country with an e-mandate requirement (e.g.
+                 * India), the payment may be declined.
+                 *
+                 * If left blank, will default to false.
+                 */
+                on_session_payment?: boolean;
             }
         }
         interface Specifier {
@@ -4292,6 +4571,8 @@ export declare namespace ContractEditParams {
          * 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`.
+         * Instead, to target usage by product or product tag, pass those values in the
+         * body of `specifiers`.
          */
         specifiers?: Array<AddCredit.Specifier>;
     }
@@ -4376,9 +4657,14 @@ export declare namespace ContractEditParams {
          */
         interface Schedule {
             /**
-             * Defaults to USD if not passed. Only USD is supported at this time.
+             * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -4650,6 +4936,8 @@ export declare namespace ContractEditParams {
              * 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`.
+             * Instead, to target usage by product or product tag, pass those values in the
+             * body of `specifiers`.
              */
             specifiers?: Array<Commit.Specifier>;
         }
@@ -4791,7 +5079,7 @@ export declare namespace ContractEditParams {
          */
         ending_before?: string;
         /**
-         * Optional configuration for recurring commit/credit hierarchy access control
+         * Optional configuration for recurring credit hierarchy access control
          */
         hierarchy_configuration?: AddRecurringCommit.HierarchyConfiguration;
         /**
@@ -4834,8 +5122,14 @@ export declare namespace ContractEditParams {
          * 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`.
+         * Instead, to target usage by product or product tag, pass those values in the
+         * body of `specifiers`.
          */
         specifiers?: Array<AddRecurringCommit.Specifier>;
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        subscription_config?: AddRecurringCommit.SubscriptionConfig;
         /**
          * A temporary ID that can be used to reference the recurring commit for commit
          * specific overrides.
@@ -4850,8 +5144,8 @@ export declare namespace ContractEditParams {
             credit_type_id: string;
             unit_price: number;
             /**
-             * This field is currently required. Upcoming recurring commit/credit configuration
-             * options will allow it to be optional.
+             * This field is required unless a subscription is attached via
+             * `subscription_config`.
              */
             quantity?: number;
         }
@@ -4865,7 +5159,7 @@ export declare namespace ContractEditParams {
             unit?: 'PERIODS';
         }
         /**
-         * Optional configuration for recurring commit/credit hierarchy access control
+         * Optional configuration for recurring credit hierarchy access control
          */
         interface HierarchyConfiguration {
             child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -4907,6 +5201,28 @@ export declare namespace ContractEditParams {
              */
             product_tags?: Array<string>;
         }
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        interface SubscriptionConfig {
+            apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+            /**
+             * ID of the subscription to configure on the recurring commit/credit.
+             */
+            subscription_id: string;
+            /**
+             * If set to POOLED, allocation added per seat is pooled across the account.
+             */
+            allocation?: 'POOLED';
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
+        }
     }
     interface AddRecurringCredit {
         /**
@@ -4945,7 +5261,7 @@ export declare namespace ContractEditParams {
          */
         ending_before?: string;
         /**
-         * Optional configuration for recurring commit/credit hierarchy access control
+         * Optional configuration for recurring credit hierarchy access control
          */
         hierarchy_configuration?: AddRecurringCredit.HierarchyConfiguration;
         /**
@@ -4984,8 +5300,14 @@ export declare namespace ContractEditParams {
          * 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`.
+         * Instead, to target usage by product or product tag, pass those values in the
+         * body of `specifiers`.
          */
         specifiers?: Array<AddRecurringCredit.Specifier>;
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        subscription_config?: AddRecurringCredit.SubscriptionConfig;
         /**
          * A temporary ID that can be used to reference the recurring commit for commit
          * specific overrides.
@@ -5000,8 +5322,8 @@ export declare namespace ContractEditParams {
             credit_type_id: string;
             unit_price: number;
             /**
-             * This field is currently required. Upcoming recurring commit/credit configuration
-             * options will allow it to be optional.
+             * This field is required unless a subscription is attached via
+             * `subscription_config`.
              */
             quantity?: number;
         }
@@ -5015,7 +5337,7 @@ export declare namespace ContractEditParams {
             unit?: 'PERIODS';
         }
         /**
-         * Optional configuration for recurring commit/credit hierarchy access control
+         * Optional configuration for recurring credit hierarchy access control
          */
         interface HierarchyConfiguration {
             child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
@@ -5049,6 +5371,28 @@ export declare namespace ContractEditParams {
              */
             product_tags?: Array<string>;
         }
+        /**
+         * Attach a subscription to the recurring commit/credit.
+         */
+        interface SubscriptionConfig {
+            apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+            /**
+             * ID of the subscription to configure on the recurring commit/credit.
+             */
+            subscription_id: string;
+            /**
+             * If set to POOLED, allocation added per seat is pooled across the account.
+             */
+            allocation?: 'POOLED';
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
+        }
     }
     interface AddResellerRoyalty {
         reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -5088,6 +5432,9 @@ export declare namespace ContractEditParams {
          * Must provide either schedule_items or recurring_schedule.
          */
         schedule: AddScheduledCharge.Schedule;
+        custom_fields?: {
+            [key: string]: string;
+        };
         /**
          * displayed on invoices
          */
@@ -5103,9 +5450,14 @@ export declare namespace ContractEditParams {
          */
         interface Schedule {
             /**
-             * Defaults to USD if not passed. Only USD is supported at this time.
+             * Defaults to USD (cents) if not passed.
              */
             credit_type_id?: string;
+            /**
+             * This field is only applicable to commit invoice schedules. If true, this
+             * schedule will not generate an invoice.
+             */
+            do_not_invoice?: boolean;
             /**
              * Enter the unit price and quantity for the charge or instead only send the
              * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -5285,14 +5637,20 @@ export declare namespace ContractEditParams {
          * start date
          */
         starting_at?: string;
+        /**
+         * A temporary ID used to reference the subscription in recurring commit/credit
+         * subscription configs created within the same payload.
+         */
+        temporary_id?: string;
     }
     namespace AddSubscription {
         interface Proration {
             /**
-             * Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-             * is selected, the quantity increase will be billed on the scheduled date. If
-             * BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-             * for in-arrears at the end of the period.
+             * Indicates how mid-period quantity adjustments are invoiced.
+             * **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+             * quantity increase will be billed immediately on the scheduled date.
+             * **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+             * in-arrears at the end of the period.
              */
             invoice_behavior?: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
             /**
@@ -5345,6 +5703,7 @@ export declare namespace ContractEditParams {
         hierarchy_configuration?: UpdateCommit.HierarchyConfiguration;
         invoice_schedule?: UpdateCommit.InvoiceSchedule;
         netsuite_sales_order_id?: string | null;
+        priority?: number | null;
         product_id?: string;
         rollover_fraction?: number | null;
     }
@@ -5432,6 +5791,7 @@ export declare namespace ContractEditParams {
          */
         hierarchy_configuration?: UpdateCredit.HierarchyConfiguration;
         netsuite_sales_order_id?: string | null;
+        priority?: number | null;
         product_id?: string;
     }
     namespace UpdateCredit {
@@ -5528,6 +5888,8 @@ export declare namespace ContractEditParams {
              * 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`.
+             * Instead, to target usage by product or product tag, pass those values in the
+             * body of `specifiers`.
              */
             specifiers?: Array<Commit.Specifier> | null;
         }
@@ -5804,12 +6166,19 @@ export interface ContractEditCommitParams {
      */
     invoice_contract_id?: string;
     invoice_schedule?: ContractEditCommitParams.InvoiceSchedule;
+    /**
+     * If multiple commits are applicable, the one with the lower priority will apply
+     * first.
+     */
+    priority?: number | null;
     product_id?: string;
     /**
      * List of filters that determine what kind of customer usage draws down a commit
      * or credit. A customer's usage needs to meet the condition of at least one of the
      * specifiers to contribute to a commit's or credit's drawdown. This field cannot
      * be used together with `applicable_product_ids` or `applicable_product_tags`.
+     * Instead, to target usage by product or product tag, pass those values in the
+     * body of `specifiers`.
      */
     specifiers?: Array<ContractEditCommitParams.Specifier> | null;
 }
@@ -5896,12 +6265,19 @@ export interface ContractEditCreditParams {
      * applicable_product_tags are not provided, the credit applies to all products.
      */
     applicable_product_tags?: Array<string> | null;
+    /**
+     * If multiple commits are applicable, the one with the lower priority will apply
+     * first.
+     */
+    priority?: number | null;
     product_id?: string;
     /**
      * List of filters that determine what kind of customer usage draws down a commit
      * or credit. A customer's usage needs to meet the condition of at least one of the
      * specifiers to contribute to a commit's or credit's drawdown. This field cannot
      * be used together with `applicable_product_ids` or `applicable_product_tags`.
+     * Instead, to target usage by product or product tag, pass those values in the
+     * body of `specifiers`.
      */
     specifiers?: Array<ContractEditCreditParams.Specifier> | null;
 }