@metronome/sdk 3.7.0 → 3.9.0

package/resources/shared.d.ts

@@ -80,6 +80,11 @@ export interface Commit {
      */
     balance?: number;
     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" }
      */
@@ -379,9 +384,6 @@ export interface Contract {
     custom_fields?: {
         [key: string]: string;
     };
-    /**
-     * The billing provider configuration associated with a contract.
-     */
     customer_billing_provider_configuration?: Contract.CustomerBillingProviderConfiguration;
     /**
      * ID of the package this contract was created from, if applicable.
@@ -458,21 +460,40 @@ export declare namespace Contract {
             starting_at?: string;
         }
     }
-    /**
-     * The billing provider configuration associated with a contract.
-     */
     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' | 'netsuite' | 'custom' | 'azure_marketplace' | 'quickbooks_online' | 'workday' | 'gcp_marketplace' | 'metronome';
-        delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
-        id?: string;
         /**
          * Configuration for the billing provider. The structure of this object is specific
          * to the billing provider.
          */
-        configuration?: {
+        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;
     }
     interface SpendTracker {
         /**
@@ -510,6 +531,11 @@ export interface ContractV2 {
     usage_filter: Array<ContractV2.UsageFilter>;
     usage_statement_schedule: ContractV2.UsageStatementSchedule;
     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>;
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
@@ -517,9 +543,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;
     /**
      * This field's availability is dependent on your client's configuration.
@@ -565,6 +588,11 @@ export interface ContractV2 {
      * This field's availability is dependent on your client's configuration.
      */
     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.
      */
@@ -626,6 +654,11 @@ export declare namespace ContractV2 {
          */
         balance?: number;
         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" }
          */
@@ -827,6 +860,7 @@ export declare namespace ContractV2 {
     }
     namespace Override {
         interface OverrideSpecifier {
+            any_commit_or_credit_ids?: Array<string>;
             billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
             commit_ids?: Array<string>;
             presentation_group_values?: {
@@ -899,6 +933,55 @@ export declare namespace ContractV2 {
         billing_anchor_date: string;
         frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
     }
+    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;
+    }
+    namespace BillingProviderConfigurationSchedule {
+        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;
+        }
+    }
     interface Credit {
         id: string;
         product: Credit.Product;
@@ -930,6 +1013,11 @@ export declare namespace ContractV2 {
          *   start date
          */
         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" }
          */
@@ -1044,16 +1132,40 @@ export declare namespace ContractV2 {
             credit_id: string;
         }
     }
-    /**
-     * This field's availability is dependent on your client's configuration.
-     */
     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' | '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;
     }
     /**
      * Indicates whether there are more items than the limit for this endpoint. Use the
@@ -1191,6 +1303,10 @@ export declare namespace ContractV2 {
          * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
          */
         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
@@ -1198,7 +1314,7 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
@@ -1247,6 +1363,33 @@ export declare namespace ContractV2 {
             quantity: number;
             unit_price: number;
         }
+        /**
+         * Rounding configuration for prorated recurring commit amounts.
+         */
+        interface ProrationRounding {
+            access?: ProrationRounding.Access;
+            invoice?: ProrationRounding.Invoice;
+        }
+        namespace ProrationRounding {
+            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';
+            }
+            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';
+            }
+        }
     }
     interface RecurringCredit {
         id: string;
@@ -1305,6 +1448,10 @@ export declare namespace ContractV2 {
          * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
          */
         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
@@ -1312,7 +1459,7 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
@@ -1353,6 +1500,23 @@ export declare namespace ContractV2 {
         interface Contract {
             id: string;
         }
+        /**
+         * Rounding configuration for prorated recurring credit amounts.
+         */
+        interface ProrationRounding {
+            access?: ProrationRounding.Access;
+        }
+        namespace ProrationRounding {
+            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';
+            }
+        }
     }
     interface ResellerRoyalty {
         reseller_type: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
@@ -1375,6 +1539,54 @@ export declare namespace ContractV2 {
             reseller_contract_value?: number;
         }
     }
+    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;
+    }
+    namespace RevenueSystemConfigurationSchedule {
+        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;
+            };
+        }
+    }
     interface SpendTracker {
         /**
          * Human-readable identifier, unique per contract.
@@ -1424,6 +1636,7 @@ export declare namespace ContractV2 {
         starting_at: string;
         subscription_rate: Subscription.SubscriptionRate;
         id?: string;
+        billing_cycle_config?: Subscription.BillingCycleConfig;
         /**
          * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
          */
@@ -1462,6 +1675,18 @@ export declare namespace ContractV2 {
         interface Proration {
             invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
             is_prorated: boolean;
+            rounding?: Proration.Rounding;
+        }
+        namespace Proration {
+            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';
+            }
         }
         interface QuantitySchedule {
             quantity: number;
@@ -1478,6 +1703,17 @@ export declare namespace ContractV2 {
                 name: string;
             }
         }
+        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';
+        }
         interface SeatConfig {
             /**
              * The property name, sent on usage events, that identifies the seat ID associated
@@ -1626,6 +1862,10 @@ export declare namespace ContractWithoutAmendments {
          * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
          */
         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
@@ -1633,7 +1873,7 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
@@ -1682,6 +1922,35 @@ export declare namespace ContractWithoutAmendments {
             quantity: number;
             unit_price: number;
         }
+        /**
+         * Rounding configuration for prorated recurring commit amounts.
+         */
+        interface ProrationRounding {
+            access?: ProrationRounding.Access;
+            invoice?: ProrationRounding.Invoice;
+        }
+        namespace ProrationRounding {
+            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';
+            }
+            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';
+            }
+        }
     }
     interface RecurringCredit {
         id: string;
@@ -1740,6 +2009,10 @@ export declare namespace ContractWithoutAmendments {
          * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
          */
         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
@@ -1747,7 +2020,7 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
@@ -1788,6 +2061,24 @@ export declare namespace ContractWithoutAmendments {
         interface Contract {
             id: string;
         }
+        /**
+         * Rounding configuration for prorated recurring credit amounts.
+         */
+        interface ProrationRounding {
+            access?: ProrationRounding.Access;
+        }
+        namespace ProrationRounding {
+            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';
+            }
+        }
     }
     interface ResellerRoyalty {
         fraction: number;
@@ -1862,6 +2153,11 @@ export interface Credit {
      */
     balance?: number;
     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" }
      */
@@ -2161,6 +2457,7 @@ export interface Override {
 }
 export declare namespace Override {
     interface OverrideSpecifier {
+        any_commit_or_credit_ids?: Array<string>;
         billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
         commit_ids?: Array<string>;
         presentation_group_values?: {
@@ -2347,6 +2644,10 @@ export interface PrepaidBalanceThresholdConfiguration {
      */
     custom_credit_type_id?: string;
     discount_configuration?: PrepaidBalanceThresholdConfiguration.DiscountConfiguration;
+    /**
+     * Determines which balances are excluded from remaining balance calculation for
+     * threshold billing.
+     */
     threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfiguration.ThresholdBalanceSpecifier>;
 }
 export declare namespace PrepaidBalanceThresholdConfiguration {
@@ -2401,6 +2702,10 @@ export declare namespace PrepaidBalanceThresholdConfiguration {
         }
     }
     interface ThresholdBalanceSpecifier {
+        /**
+         * If any of the exclude specifier is met, the balance is not considered when
+         * evaluating threshold billing
+         */
         exclude: Array<ThresholdBalanceSpecifier.Exclude>;
     }
     namespace ThresholdBalanceSpecifier {
@@ -2444,6 +2749,10 @@ export interface PrepaidBalanceThresholdConfigurationV2 {
      */
     custom_credit_type_id?: string;
     discount_configuration?: PrepaidBalanceThresholdConfigurationV2.DiscountConfiguration;
+    /**
+     * Determines which balances are excluded from remaining balance calculation for
+     * threshold billing.
+     */
     threshold_balance_specifiers?: Array<PrepaidBalanceThresholdConfigurationV2.ThresholdBalanceSpecifier>;
 }
 export declare namespace PrepaidBalanceThresholdConfigurationV2 {
@@ -2798,6 +3107,7 @@ export interface Subscription {
     starting_at: string;
     subscription_rate: Subscription.SubscriptionRate;
     id?: string;
+    billing_cycle_config?: Subscription.BillingCycleConfig;
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -2836,6 +3146,19 @@ export declare namespace Subscription {
     interface Proration {
         invoice_behavior: 'BILL_IMMEDIATELY' | 'BILL_ON_NEXT_COLLECTION_DATE';
         is_prorated: boolean;
+        rounding?: Proration.Rounding;
+    }
+    namespace Proration {
+        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';
+        }
     }
     interface QuantitySchedule {
         quantity: number;
@@ -2852,6 +3175,17 @@ export declare namespace Subscription {
             name: string;
         }
     }
+    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';
+    }
     interface SeatConfig {
         /**
          * The property name, sent on usage events, that identifies the seat ID associated