@metronome/sdk 0.1.0 → 0.3.0

package/src/resources/v2/contracts.ts

@@ -452,6 +452,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitRolloverLedgerEntry {
@@ -486,6 +488,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'PREPAID_COMMIT_CANCELED';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitCreditedLedgerEntry {
@@ -498,6 +502,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'PREPAID_COMMIT_CREDITED';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
@@ -528,6 +534,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+
+        contract_id?: string;
       }
 
       export interface PostpaidCommitRolloverLedgerEntry {
@@ -550,6 +558,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'POSTPAID_COMMIT_TRUEUP';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitManualLedgerEntry {
@@ -873,6 +883,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
+
+        contract_id?: string;
       }
 
       export interface CreditExpirationLedgerEntry {
@@ -895,6 +907,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'CREDIT_CANCELED';
+
+        contract_id?: string;
       }
 
       export interface CreditCreditedLedgerEntry {
@@ -907,6 +921,8 @@ export namespace ContractRetrieveResponse {
         timestamp: string;
 
         type: 'CREDIT_CREDITED';
+
+        contract_id?: string;
       }
 
       export interface CreditManualLedgerEntry {
@@ -951,6 +967,11 @@ export namespace ContractRetrieveResponse {
      * This field's availability is dependent on your client's configuration.
      */
     export interface CustomerBillingProviderConfiguration {
+      /**
+       * ID of Customer's billing provider configuration.
+       */
+      id: string;
+
       billing_provider:
         | 'aws_marketplace'
         | 'stripe'
@@ -1082,6 +1103,8 @@ export 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>;
       }
@@ -1221,7 +1244,7 @@ export 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;
 
@@ -1268,6 +1291,11 @@ export 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;
     }
 
     export namespace RecurringCommit {
@@ -1302,7 +1330,7 @@ export namespace ContractRetrieveResponse {
       }
 
       /**
-       * Optional configuration for recurring commit/credit hierarchy access control
+       * Optional configuration for recurring credit hierarchy access control
        */
       export interface HierarchyConfiguration {
         child_access:
@@ -1354,6 +1382,26 @@ export namespace ContractRetrieveResponse {
          */
         product_tags?: Array<string>;
       }
+
+      /**
+       * Attach a subscription to the recurring commit/credit.
+       */
+      export interface SubscriptionConfig {
+        allocation: 'INDIVIDUAL' | 'POOLED';
+
+        apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+        subscription_id: string;
+      }
+
+      export namespace SubscriptionConfig {
+        export interface ApplySeatIncreaseConfig {
+          /**
+           * Indicates whether a mid-period seat increase should be prorated.
+           */
+          is_prorated: boolean;
+        }
+      }
     }
 
     export interface RecurringCredit {
@@ -1409,7 +1457,7 @@ export 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;
 
@@ -1451,6 +1499,11 @@ export 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;
     }
 
     export namespace RecurringCredit {
@@ -1485,7 +1538,7 @@ export namespace ContractRetrieveResponse {
       }
 
       /**
-       * Optional configuration for recurring commit/credit hierarchy access control
+       * Optional configuration for recurring credit hierarchy access control
        */
       export interface HierarchyConfiguration {
         child_access:
@@ -1526,6 +1579,26 @@ export namespace ContractRetrieveResponse {
          */
         product_tags?: Array<string>;
       }
+
+      /**
+       * Attach a subscription to the recurring commit/credit.
+       */
+      export interface SubscriptionConfig {
+        allocation: 'INDIVIDUAL' | 'POOLED';
+
+        apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+        subscription_id: string;
+      }
+
+      export namespace SubscriptionConfig {
+        export interface ApplySeatIncreaseConfig {
+          /**
+           * Indicates whether a mid-period seat increase should be prorated.
+           */
+          is_prorated: boolean;
+        }
+      }
     }
 
     export interface ResellerRoyalty {
@@ -2024,6 +2097,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitRolloverLedgerEntry {
@@ -2058,6 +2133,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'PREPAID_COMMIT_CANCELED';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitCreditedLedgerEntry {
@@ -2070,6 +2147,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'PREPAID_COMMIT_CREDITED';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
@@ -2100,6 +2179,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+
+        contract_id?: string;
       }
 
       export interface PostpaidCommitRolloverLedgerEntry {
@@ -2122,6 +2203,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'POSTPAID_COMMIT_TRUEUP';
+
+        contract_id?: string;
       }
 
       export interface PrepaidCommitManualLedgerEntry {
@@ -2445,6 +2528,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
+
+        contract_id?: string;
       }
 
       export interface CreditExpirationLedgerEntry {
@@ -2467,6 +2552,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'CREDIT_CANCELED';
+
+        contract_id?: string;
       }
 
       export interface CreditCreditedLedgerEntry {
@@ -2479,6 +2566,8 @@ export namespace ContractListResponse {
         timestamp: string;
 
         type: 'CREDIT_CREDITED';
+
+        contract_id?: string;
       }
 
       export interface CreditManualLedgerEntry {
@@ -2523,6 +2612,11 @@ export namespace ContractListResponse {
      * This field's availability is dependent on your client's configuration.
      */
     export interface CustomerBillingProviderConfiguration {
+      /**
+       * ID of Customer's billing provider configuration.
+       */
+      id: string;
+
       billing_provider:
         | 'aws_marketplace'
         | 'stripe'
@@ -2654,6 +2748,8 @@ export 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>;
       }
@@ -2793,7 +2889,7 @@ export 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;
 
@@ -2840,6 +2936,11 @@ export 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;
     }
 
     export namespace RecurringCommit {
@@ -2874,7 +2975,7 @@ export namespace ContractListResponse {
       }
 
       /**
-       * Optional configuration for recurring commit/credit hierarchy access control
+       * Optional configuration for recurring credit hierarchy access control
        */
       export interface HierarchyConfiguration {
         child_access:
@@ -2926,6 +3027,26 @@ export namespace ContractListResponse {
          */
         product_tags?: Array<string>;
       }
+
+      /**
+       * Attach a subscription to the recurring commit/credit.
+       */
+      export interface SubscriptionConfig {
+        allocation: 'INDIVIDUAL' | 'POOLED';
+
+        apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+        subscription_id: string;
+      }
+
+      export namespace SubscriptionConfig {
+        export interface ApplySeatIncreaseConfig {
+          /**
+           * Indicates whether a mid-period seat increase should be prorated.
+           */
+          is_prorated: boolean;
+        }
+      }
     }
 
     export interface RecurringCredit {
@@ -2981,7 +3102,7 @@ export 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;
 
@@ -3023,6 +3144,11 @@ export 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;
     }
 
     export namespace RecurringCredit {
@@ -3057,7 +3183,7 @@ export namespace ContractListResponse {
       }
 
       /**
-       * Optional configuration for recurring commit/credit hierarchy access control
+       * Optional configuration for recurring credit hierarchy access control
        */
       export interface HierarchyConfiguration {
         child_access:
@@ -3098,6 +3224,26 @@ export namespace ContractListResponse {
          */
         product_tags?: Array<string>;
       }
+
+      /**
+       * Attach a subscription to the recurring commit/credit.
+       */
+      export interface SubscriptionConfig {
+        allocation: 'INDIVIDUAL' | 'POOLED';
+
+        apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+        subscription_id: string;
+      }
+
+      export namespace SubscriptionConfig {
+        export interface ApplySeatIncreaseConfig {
+          /**
+           * Indicates whether a mid-period seat increase should be prorated.
+           */
+          is_prorated: boolean;
+        }
+      }
     }
 
     export interface ResellerRoyalty {
@@ -3406,6 +3552,11 @@ export namespace ContractGetEditHistoryResponse {
 
       description?: string;
 
+      /**
+       * Optional configuration for commit hierarchy access control
+       */
+      hierarchy_configuration?: AddCommit.HierarchyConfiguration;
+
       /**
        * The schedule that the customer will be invoiced for this commit.
        */
@@ -3438,6 +3589,8 @@ export 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>;
     }
@@ -3449,6 +3602,32 @@ export namespace ContractGetEditHistoryResponse {
         name: string;
       }
 
+      /**
+       * Optional configuration for commit hierarchy access control
+       */
+      export interface HierarchyConfiguration {
+        child_access:
+          | HierarchyConfiguration.CommitHierarchyChildAccessAll
+          | HierarchyConfiguration.CommitHierarchyChildAccessNone
+          | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+      }
+
+      export namespace HierarchyConfiguration {
+        export interface CommitHierarchyChildAccessAll {
+          type: 'ALL';
+        }
+
+        export interface CommitHierarchyChildAccessNone {
+          type: 'NONE';
+        }
+
+        export interface CommitHierarchyChildAccessContractIDs {
+          contract_ids: Array<string>;
+
+          type: 'CONTRACT_IDS';
+        }
+      }
+
       export interface Specifier {
         presentation_group_values?: { [key: string]: string };
 
@@ -3485,6 +3664,11 @@ export namespace ContractGetEditHistoryResponse {
 
       description?: string;
 
+      /**
+       * Optional configuration for recurring credit hierarchy access control
+       */
+      hierarchy_configuration?: AddCredit.HierarchyConfiguration;
+
       name?: string;
 
       /**
@@ -3508,6 +3692,8 @@ export 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>;
     }
@@ -3519,6 +3705,32 @@ export namespace ContractGetEditHistoryResponse {
         name: string;
       }
 
+      /**
+       * Optional configuration for recurring credit hierarchy access control
+       */
+      export interface HierarchyConfiguration {
+        child_access:
+          | HierarchyConfiguration.CommitHierarchyChildAccessAll
+          | HierarchyConfiguration.CommitHierarchyChildAccessNone
+          | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+      }
+
+      export namespace HierarchyConfiguration {
+        export interface CommitHierarchyChildAccessAll {
+          type: 'ALL';
+        }
+
+        export interface CommitHierarchyChildAccessNone {
+          type: 'NONE';
+        }
+
+        export interface CommitHierarchyChildAccessContractIDs {
+          contract_ids: Array<string>;
+
+          type: 'CONTRACT_IDS';
+        }
+      }
+
       export interface Specifier {
         presentation_group_values?: { [key: string]: string };
 
@@ -3698,6 +3910,8 @@ export 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>;
       }
@@ -3837,7 +4051,7 @@ export 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;
 
@@ -3884,6 +4098,11 @@ export 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;
     }
 
     export namespace AddRecurringCommit {
@@ -3918,7 +4137,7 @@ export namespace ContractGetEditHistoryResponse {
       }
 
       /**
-       * Optional configuration for recurring commit/credit hierarchy access control
+       * Optional configuration for recurring credit hierarchy access control
        */
       export interface HierarchyConfiguration {
         child_access:
@@ -3970,6 +4189,26 @@ export namespace ContractGetEditHistoryResponse {
          */
         product_tags?: Array<string>;
       }
+
+      /**
+       * Attach a subscription to the recurring commit/credit.
+       */
+      export interface SubscriptionConfig {
+        allocation: 'INDIVIDUAL' | 'POOLED';
+
+        apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+        subscription_id: string;
+      }
+
+      export namespace SubscriptionConfig {
+        export interface ApplySeatIncreaseConfig {
+          /**
+           * Indicates whether a mid-period seat increase should be prorated.
+           */
+          is_prorated: boolean;
+        }
+      }
     }
 
     export interface AddRecurringCredit {
@@ -4025,7 +4264,7 @@ export 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;
 
@@ -4067,6 +4306,11 @@ export 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;
     }
 
     export namespace AddRecurringCredit {
@@ -4101,7 +4345,7 @@ export namespace ContractGetEditHistoryResponse {
       }
 
       /**
-       * Optional configuration for recurring commit/credit hierarchy access control
+       * Optional configuration for recurring credit hierarchy access control
        */
       export interface HierarchyConfiguration {
         child_access:
@@ -4142,6 +4386,26 @@ export namespace ContractGetEditHistoryResponse {
          */
         product_tags?: Array<string>;
       }
+
+      /**
+       * Attach a subscription to the recurring commit/credit.
+       */
+      export interface SubscriptionConfig {
+        allocation: 'INDIVIDUAL' | 'POOLED';
+
+        apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+        subscription_id: string;
+      }
+
+      export namespace SubscriptionConfig {
+        export interface ApplySeatIncreaseConfig {
+          /**
+           * Indicates whether a mid-period seat increase should be prorated.
+           */
+          is_prorated: boolean;
+        }
+      }
     }
 
     export interface AddResellerRoyalty {
@@ -4408,12 +4672,23 @@ export namespace ContractGetEditHistoryResponse {
        */
       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;
@@ -4423,6 +4698,8 @@ export 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;
     }
@@ -4472,6 +4749,32 @@ export namespace ContractGetEditHistoryResponse {
         }
       }
 
+      /**
+       * Optional configuration for commit hierarchy access control
+       */
+      export interface HierarchyConfiguration {
+        child_access:
+          | HierarchyConfiguration.CommitHierarchyChildAccessAll
+          | HierarchyConfiguration.CommitHierarchyChildAccessNone
+          | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+      }
+
+      export namespace HierarchyConfiguration {
+        export interface CommitHierarchyChildAccessAll {
+          type: 'ALL';
+        }
+
+        export interface CommitHierarchyChildAccessNone {
+          type: 'NONE';
+        }
+
+        export interface CommitHierarchyChildAccessContractIDs {
+          contract_ids: Array<string>;
+
+          type: 'CONTRACT_IDS';
+        }
+      }
+
       export interface InvoiceSchedule {
         add_schedule_items?: Array<InvoiceSchedule.AddScheduleItem>;
 
@@ -4531,10 +4834,21 @@ export namespace ContractGetEditHistoryResponse {
 
       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;
     }
 
@@ -4582,6 +4896,32 @@ export namespace ContractGetEditHistoryResponse {
           starting_at?: string;
         }
       }
+
+      /**
+       * Optional configuration for credit hierarchy access control
+       */
+      export interface HierarchyConfiguration {
+        child_access:
+          | HierarchyConfiguration.CommitHierarchyChildAccessAll
+          | HierarchyConfiguration.CommitHierarchyChildAccessNone
+          | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+      }
+
+      export namespace HierarchyConfiguration {
+        export interface CommitHierarchyChildAccessAll {
+          type: 'ALL';
+        }
+
+        export interface CommitHierarchyChildAccessNone {
+          type: 'NONE';
+        }
+
+        export interface CommitHierarchyChildAccessContractIDs {
+          contract_ids: Array<string>;
+
+          type: 'CONTRACT_IDS';
+        }
+      }
     }
 
     export interface UpdateDiscount {
@@ -4605,10 +4945,16 @@ export namespace ContractGetEditHistoryResponse {
        */
       export 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
@@ -4759,6 +5105,8 @@ export 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;
       }
@@ -5312,6 +5660,8 @@ export 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>;
 
@@ -5384,10 +5734,16 @@ export namespace ContractEditParams {
      */
     export 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
@@ -5535,6 +5891,18 @@ export namespace ContractEditParams {
          * your payment type.
          */
         invoice_metadata?: { [key: string]: string };
+
+        /**
+         * If true, the payment will be made assuming the customer is present (i.e. on
+         * session).
+         *
+         * If false, the payment will be made assuming the customer is not present (i.e.
+         * off session). For cardholders from a country with an e-mandate requirement (e.g.
+         * India), the payment may be declined.
+         *
+         * If left blank, will default to false.
+         */
+        on_session_payment?: boolean;
       }
     }
 
@@ -5611,6 +5979,8 @@ export 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>;
   }
@@ -5712,10 +6082,16 @@ export namespace ContractEditParams {
      */
     export 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
@@ -6035,6 +6411,8 @@ export 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>;
     }
@@ -6197,7 +6575,7 @@ export 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;
 
@@ -6248,9 +6626,16 @@ export 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.
@@ -6268,8 +6653,8 @@ export namespace ContractEditParams {
       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;
     }
@@ -6286,7 +6671,7 @@ export namespace ContractEditParams {
     }
 
     /**
-     * Optional configuration for recurring commit/credit hierarchy access control
+     * Optional configuration for recurring credit hierarchy access control
      */
     export interface HierarchyConfiguration {
       child_access:
@@ -6338,6 +6723,32 @@ export namespace ContractEditParams {
        */
       product_tags?: Array<string>;
     }
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    export 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';
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
+    }
   }
 
   export interface AddRecurringCredit {
@@ -6386,7 +6797,7 @@ export 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;
 
@@ -6432,9 +6843,16 @@ export 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.
@@ -6452,8 +6870,8 @@ export namespace ContractEditParams {
       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;
     }
@@ -6470,7 +6888,7 @@ export namespace ContractEditParams {
     }
 
     /**
-     * Optional configuration for recurring commit/credit hierarchy access control
+     * Optional configuration for recurring credit hierarchy access control
      */
     export interface HierarchyConfiguration {
       child_access:
@@ -6511,6 +6929,32 @@ export namespace ContractEditParams {
        */
       product_tags?: Array<string>;
     }
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    export 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';
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
+    }
   }
 
   export interface AddResellerRoyalty {
@@ -6568,6 +7012,8 @@ export namespace ContractEditParams {
      */
     schedule: AddScheduledCharge.Schedule;
 
+    custom_fields?: { [key: string]: string };
+
     /**
      * displayed on invoices
      */
@@ -6585,10 +7031,16 @@ export namespace ContractEditParams {
      */
     export 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
@@ -6800,15 +7252,22 @@ export 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;
   }
 
   export namespace AddSubscription {
     export 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';
 
@@ -6876,6 +7335,8 @@ export namespace ContractEditParams {
 
     netsuite_sales_order_id?: string | null;
 
+    priority?: number | null;
+
     product_id?: string;
 
     rollover_fraction?: number | null;
@@ -7003,6 +7464,8 @@ export namespace ContractEditParams {
 
     netsuite_sales_order_id?: string | null;
 
+    priority?: number | null;
+
     product_id?: string;
   }
 
@@ -7130,6 +7593,8 @@ export 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;
     }
@@ -7468,6 +7933,12 @@ export interface ContractEditCommitParams {
 
   invoice_schedule?: ContractEditCommitParams.InvoiceSchedule;
 
+  /**
+   * If multiple commits are applicable, the one with the lower priority will apply
+   * first.
+   */
+  priority?: number | null;
+
   product_id?: string;
 
   /**
@@ -7475,6 +7946,8 @@ export interface ContractEditCommitParams {
    * 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;
 }
@@ -7591,6 +8064,12 @@ export interface ContractEditCreditParams {
    */
   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;
 
   /**
@@ -7598,6 +8077,8 @@ export interface ContractEditCreditParams {
    * 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;
 }