@metronome/sdk 3.7.0 → 3.9.0

package/src/resources/shared.ts

@@ -103,6 +103,12 @@ export interface Commit {
 
   contract?: Commit.Contract;
 
+  /**
+   * The actor who created this commit. Omitted for system-generated commits such as
+   * recurring commits, rollover commits, and threshold commits.
+   */
+  created_by?: string;
+
   /**
    * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
    */
@@ -525,9 +531,6 @@ export interface Contract {
    */
   custom_fields?: { [key: string]: string };
 
-  /**
-   * The billing provider configuration associated with a contract.
-   */
   customer_billing_provider_configuration?: Contract.CustomerBillingProviderConfiguration;
 
   /**
@@ -636,12 +639,18 @@ export namespace Contract {
     }
   }
 
-  /**
-   * The billing provider configuration associated with a contract.
-   */
   export interface CustomerBillingProviderConfiguration {
+    /**
+     * ID of this configuration; can be provided as the
+     * billing_provider_configuration_id when creating a contract.
+     */
+    id: string;
+
     archived_at: string | null;
 
+    /**
+     * The billing provider set for this configuration.
+     */
     billing_provider:
       | 'aws_marketplace'
       | 'stripe'
@@ -653,15 +662,29 @@ export namespace Contract {
       | 'gcp_marketplace'
       | 'metronome';
 
+    /**
+     * Configuration for the billing provider. The structure of this object is specific
+     * to the billing provider.
+     */
+    configuration: { [key: string]: unknown };
+
+    customer_id: string;
+
+    /**
+     * The method to use for delivering invoices to this customer.
+     */
     delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
 
-    id?: string;
+    /**
+     * Configuration for the delivery method. The structure of this object is specific
+     * to the delivery method.
+     */
+    delivery_method_configuration: { [key: string]: unknown };
 
     /**
-     * Configuration for the billing provider. The structure of this object is specific
-     * to the billing provider.
+     * ID of the delivery method to use for this customer.
      */
-    configuration?: { [key: string]: unknown };
+    delivery_method_id: string;
   }
 
   export interface SpendTracker {
@@ -723,6 +746,12 @@ export interface ContractV2 {
 
   archived_at?: string;
 
+  /**
+   * The schedule of billing provider configuration changes on the contract, ordered
+   * by effective_at ascending.
+   */
+  billing_provider_configuration_schedule?: Array<ContractV2.BillingProviderConfigurationSchedule>;
+
   credits?: Array<ContractV2.Credit>;
 
   /**
@@ -730,9 +759,6 @@ export interface ContractV2 {
    */
   custom_fields?: { [key: string]: string };
 
-  /**
-   * This field's availability is dependent on your client's configuration.
-   */
   customer_billing_provider_configuration?: ContractV2.CustomerBillingProviderConfiguration;
 
   /**
@@ -796,6 +822,12 @@ export interface ContractV2 {
    */
   reseller_royalties?: Array<ContractV2.ResellerRoyalty>;
 
+  /**
+   * The schedule of revenue system configuration changes on the contract, ordered by
+   * effective_at ascending.
+   */
+  revenue_system_configuration_schedule?: Array<ContractV2.RevenueSystemConfigurationSchedule>;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -875,6 +907,12 @@ export namespace ContractV2 {
 
     contract?: Commit.Contract;
 
+    /**
+     * The actor who created this commit. Omitted for system-generated commits such as
+     * recurring commits, rollover commits, and threshold commits.
+     */
+    created_by?: string;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -1193,6 +1231,8 @@ export namespace ContractV2 {
 
   export namespace Override {
     export interface OverrideSpecifier {
+      any_commit_or_credit_ids?: Array<string>;
+
       billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       commit_ids?: Array<string>;
@@ -1284,6 +1324,71 @@ export namespace ContractV2 {
     frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
   }
 
+  export interface BillingProviderConfigurationSchedule {
+    billing_provider_configuration: BillingProviderConfigurationSchedule.BillingProviderConfiguration;
+
+    /**
+     * The date this billing provider configuration became or becomes active.
+     */
+    effective_at: string;
+
+    /**
+     * The date this billing provider configuration is superseded by the next entry.
+     * Null for the last entry in the schedule.
+     */
+    effective_until?: string;
+  }
+
+  export namespace BillingProviderConfigurationSchedule {
+    export interface BillingProviderConfiguration {
+      /**
+       * ID of this configuration; can be provided as the
+       * billing_provider_configuration_id when creating a contract.
+       */
+      id: string;
+
+      archived_at: string | null;
+
+      /**
+       * The billing provider set for this configuration.
+       */
+      billing_provider:
+        | 'aws_marketplace'
+        | 'stripe'
+        | 'netsuite'
+        | 'custom'
+        | 'azure_marketplace'
+        | 'quickbooks_online'
+        | 'workday'
+        | 'gcp_marketplace'
+        | 'metronome';
+
+      /**
+       * Configuration for the billing provider. The structure of this object is specific
+       * to the billing provider.
+       */
+      configuration: { [key: string]: unknown };
+
+      customer_id: string;
+
+      /**
+       * The method to use for delivering invoices to this customer.
+       */
+      delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+
+      /**
+       * Configuration for the delivery method. The structure of this object is specific
+       * to the delivery method.
+       */
+      delivery_method_configuration: { [key: string]: unknown };
+
+      /**
+       * ID of the delivery method to use for this customer.
+       */
+      delivery_method_id: string;
+    }
+  }
+
   export interface Credit {
     id: string;
 
@@ -1326,6 +1431,12 @@ export namespace ContractV2 {
      */
     created_at?: string;
 
+    /**
+     * The actor who created this credit. Omitted for system-generated credits such as
+     * recurring credits.
+     */
+    created_by?: string;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -1503,15 +1614,18 @@ export namespace ContractV2 {
     }
   }
 
-  /**
-   * This field's availability is dependent on your client's configuration.
-   */
   export interface CustomerBillingProviderConfiguration {
     /**
-     * ID of Customer's billing provider configuration.
+     * ID of this configuration; can be provided as the
+     * billing_provider_configuration_id when creating a contract.
      */
     id: string;
 
+    archived_at: string | null;
+
+    /**
+     * The billing provider set for this configuration.
+     */
     billing_provider:
       | 'aws_marketplace'
       | 'stripe'
@@ -1523,7 +1637,29 @@ export namespace ContractV2 {
       | 'gcp_marketplace'
       | 'metronome';
 
+    /**
+     * Configuration for the billing provider. The structure of this object is specific
+     * to the billing provider.
+     */
+    configuration: { [key: string]: unknown };
+
+    customer_id: string;
+
+    /**
+     * The method to use for delivering invoices to this customer.
+     */
     delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+
+    /**
+     * Configuration for the delivery method. The structure of this object is specific
+     * to the delivery method.
+     */
+    delivery_method_configuration: { [key: string]: unknown };
+
+    /**
+     * ID of the delivery method to use for this customer.
+     */
+    delivery_method_id: string;
   }
 
   /**
@@ -1691,6 +1827,11 @@ export namespace ContractV2 {
      */
     proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+    /**
+     * Rounding configuration for prorated recurring commit amounts.
+     */
+    proration_rounding?: RecurringCommit.ProrationRounding | null;
+
     /**
      * The frequency at which the recurring commits will be created. If not provided: -
      * The commits will be created on the usage invoice frequency. If provided: - The
@@ -1698,7 +1839,7 @@ export namespace ContractV2 {
      * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -1761,6 +1902,39 @@ export namespace ContractV2 {
 
       unit_price: number;
     }
+
+    /**
+     * Rounding configuration for prorated recurring commit amounts.
+     */
+    export interface ProrationRounding {
+      access?: ProrationRounding.Access;
+
+      invoice?: ProrationRounding.Invoice;
+    }
+
+    export namespace ProrationRounding {
+      export interface Access {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+
+      export interface Invoice {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
   }
 
   export interface RecurringCredit {
@@ -1836,6 +2010,11 @@ export namespace ContractV2 {
      */
     proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+    /**
+     * Rounding configuration for prorated recurring credit amounts.
+     */
+    proration_rounding?: RecurringCredit.ProrationRounding | null;
+
     /**
      * The frequency at which the recurring commits will be created. If not provided: -
      * The commits will be created on the usage invoice frequency. If provided: - The
@@ -1843,7 +2022,7 @@ export namespace ContractV2 {
      * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -1895,6 +2074,26 @@ export namespace ContractV2 {
     export interface Contract {
       id: string;
     }
+
+    /**
+     * Rounding configuration for prorated recurring credit amounts.
+     */
+    export interface ProrationRounding {
+      access?: ProrationRounding.Access;
+    }
+
+    export namespace ProrationRounding {
+      export interface Access {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
   }
 
   export interface ResellerRoyalty {
@@ -1933,6 +2132,61 @@ export namespace ContractV2 {
     }
   }
 
+  export interface RevenueSystemConfigurationSchedule {
+    /**
+     * The date this revenue system configuration became or becomes active.
+     */
+    effective_at: string;
+
+    revenue_system_configuration: RevenueSystemConfigurationSchedule.RevenueSystemConfiguration;
+
+    /**
+     * The date this revenue system configuration is superseded by the next entry. Null
+     * for the last entry in the schedule.
+     */
+    effective_until?: string;
+  }
+
+  export namespace RevenueSystemConfigurationSchedule {
+    export interface RevenueSystemConfiguration {
+      /**
+       * ID of the revenue system configuration.
+       */
+      id: string;
+
+      /**
+       * Configuration for the revenue system. The structure of this object is specific
+       * to the provider.
+       */
+      configuration: { [key: string]: unknown };
+
+      customer_id: string;
+
+      /**
+       * ID of the delivery method used for this customer configuration.
+       */
+      delivery_method_id: string;
+
+      /**
+       * The revenue system provider (e.g. netsuite).
+       */
+      provider: 'netsuite';
+
+      archived_at?: string | null;
+
+      /**
+       * The method to use for delivering data to the revenue system.
+       */
+      delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+
+      /**
+       * Configuration for the delivery method. The structure of this object is specific
+       * to the delivery method.
+       */
+      delivery_method_configuration?: { [key: string]: unknown };
+    }
+  }
+
   export interface SpendTracker {
     /**
      * Human-readable identifier, unique per contract.
@@ -2001,6 +2255,8 @@ export namespace ContractV2 {
 
     id?: string;
 
+    billing_cycle_config?: Subscription.BillingCycleConfig;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -2053,6 +2309,21 @@ export namespace ContractV2 {
       invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
 
       is_prorated: boolean;
+
+      rounding?: Proration.Rounding;
+    }
+
+    export namespace Proration {
+      export interface Rounding {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
     }
 
     export interface QuantitySchedule {
@@ -2077,6 +2348,19 @@ export namespace ContractV2 {
       }
     }
 
+    export interface BillingCycleConfig {
+      /**
+       * The date this subscription's billing cycle is anchored to.
+       */
+      anchor_date: string;
+
+      /**
+       * Controls whether this subscription consolidates onto usage invoices or gets its
+       * own scheduled invoice.
+       */
+      invoice_placement: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+    }
+
     export interface SeatConfig {
       /**
        * The property name, sent on usage events, that identifies the seat ID associated
@@ -2275,6 +2559,11 @@ export namespace ContractWithoutAmendments {
      */
     proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+    /**
+     * Rounding configuration for prorated recurring commit amounts.
+     */
+    proration_rounding?: RecurringCommit.ProrationRounding | null;
+
     /**
      * The frequency at which the recurring commits will be created. If not provided: -
      * The commits will be created on the usage invoice frequency. If provided: - The
@@ -2282,7 +2571,7 @@ export namespace ContractWithoutAmendments {
      * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -2345,6 +2634,41 @@ export namespace ContractWithoutAmendments {
 
       unit_price: number;
     }
+
+    /**
+     * Rounding configuration for prorated recurring commit amounts.
+     */
+    export interface ProrationRounding {
+      access?: ProrationRounding.Access;
+
+      invoice?: ProrationRounding.Invoice;
+    }
+
+    export namespace ProrationRounding {
+      export interface Access {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+         * dollar).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+
+      export interface Invoice {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+         * dollar).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
   }
 
   export interface RecurringCredit {
@@ -2420,6 +2744,11 @@ export namespace ContractWithoutAmendments {
      */
     proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
 
+    /**
+     * Rounding configuration for prorated recurring credit amounts.
+     */
+    proration_rounding?: RecurringCredit.ProrationRounding | null;
+
     /**
      * The frequency at which the recurring commits will be created. If not provided: -
      * The commits will be created on the usage invoice frequency. If provided: - The
@@ -2427,7 +2756,7 @@ export namespace ContractWithoutAmendments {
      * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -2479,6 +2808,27 @@ export namespace ContractWithoutAmendments {
     export interface Contract {
       id: string;
     }
+
+    /**
+     * Rounding configuration for prorated recurring credit amounts.
+     */
+    export interface ProrationRounding {
+      access?: ProrationRounding.Access;
+    }
+
+    export namespace ProrationRounding {
+      export interface Access {
+        /**
+         * Number of decimal places to round to. Applied directly to the stored monetary
+         * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+         * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+         * dollar).
+         */
+        decimal_places: number;
+
+        rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+      }
+    }
   }
 
   export interface ResellerRoyalty {
@@ -2593,6 +2943,12 @@ export interface Credit {
 
   contract?: Credit.Contract;
 
+  /**
+   * The actor who created this credit. Omitted for system-generated credits such as
+   * recurring credits.
+   */
+  created_by?: string;
+
   /**
    * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
    */
@@ -3005,6 +3361,8 @@ export interface Override {
 
 export namespace Override {
   export interface OverrideSpecifier {
+    any_commit_or_credit_ids?: Array<string>;
+
     billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     commit_ids?: Array<string>;
@@ -3222,6 +3580,10 @@ export interface PrepaidBalanceThresholdConfiguration {
 
   discount_configuration?: PrepaidBalanceThresholdConfiguration.DiscountConfiguration;
 
+  /**
+   * Determines which balances are excluded from remaining balance calculation for
+   * threshold billing.
+   */
   threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfiguration.ThresholdBalanceSpecifier>;
 }
 
@@ -3284,6 +3646,10 @@ export namespace PrepaidBalanceThresholdConfiguration {
   }
 
   export interface ThresholdBalanceSpecifier {
+    /**
+     * If any of the exclude specifier is met, the balance is not considered when
+     * evaluating threshold billing
+     */
     exclude: Array<ThresholdBalanceSpecifier.Exclude>;
   }
 
@@ -3339,6 +3705,10 @@ export interface PrepaidBalanceThresholdConfigurationV2 {
 
   discount_configuration?: PrepaidBalanceThresholdConfigurationV2.DiscountConfiguration;
 
+  /**
+   * Determines which balances are excluded from remaining balance calculation for
+   * threshold billing.
+   */
   threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfigurationV2.ThresholdBalanceSpecifier>;
 }
 
@@ -3772,6 +4142,8 @@ export interface Subscription {
 
   id?: string;
 
+  billing_cycle_config?: Subscription.BillingCycleConfig;
+
   /**
    * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
    */
@@ -3824,6 +4196,22 @@ export namespace Subscription {
     invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
 
     is_prorated: boolean;
+
+    rounding?: Proration.Rounding;
+  }
+
+  export namespace Proration {
+    export interface Rounding {
+      /**
+       * Number of decimal places to round to. Applied directly to the stored monetary
+       * representation. Negative values round to powers of 10 (e.g., -2 rounds to
+       * nearest 100 in the stored unit. For USD, this means rounding to the nearest
+       * dollar).
+       */
+      decimal_places: number;
+
+      rounding_method: 'HALF_UP' | 'FLOOR' | 'CEILING';
+    }
   }
 
   export interface QuantitySchedule {
@@ -3848,6 +4236,19 @@ export namespace Subscription {
     }
   }
 
+  export interface BillingCycleConfig {
+    /**
+     * The date this subscription's billing cycle is anchored to.
+     */
+    anchor_date: string;
+
+    /**
+     * Controls whether this subscription consolidates onto usage invoices or gets its
+     * own scheduled invoice.
+     */
+    invoice_placement: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+  }
+
   export interface SeatConfig {
     /**
      * The property name, sent on usage events, that identifies the seat ID associated