@metronome/sdk 3.6.0 → 3.8.0

package/resources/v1/packages.d.ts

@@ -121,10 +121,9 @@ export declare class Packages extends APIResource {
      *
      * ### **Usage guidelines:**
      *
-     * Use the **`starting_at`**, **`covering_date`**,
-     * and **`include_archived`** parameters to filter the list of returned contracts.
-     * For example, to list only currently active contracts,
-     * pass **`covering_date`** equal to the current time.
+     * Use the **`starting_at`**, **`covering_date`**, and **`include_archived`**
+     * parameters to filter the list of returned contracts. For example, to list only
+     * currently active contracts, pass **`covering_date`** equal to the current time.
      *
      * @example
      * ```ts
@@ -187,6 +186,7 @@ export declare namespace PackageRetrieveResponse {
          */
         scheduled_charges_on_usage_invoices?: 'ALL';
         spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
+        spend_trackers?: Array<Data.SpendTracker>;
         subscriptions?: Array<Data.Subscription>;
         /**
          * Prevents the creation of duplicates. If a request to create a record is made
@@ -308,6 +308,7 @@ export declare namespace PackageRetrieveResponse {
         }
         namespace Override {
             interface OverrideSpecifier {
+                any_commit_or_credit_template_ids?: Array<string>;
                 billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
                 commit_template_ids?: Array<string>;
                 presentation_group_values?: {
@@ -479,6 +480,10 @@ export declare namespace PackageRetrieveResponse {
              * 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
@@ -486,7 +491,7 @@ export declare namespace PackageRetrieveResponse {
              * 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
@@ -548,6 +553,35 @@ export declare namespace PackageRetrieveResponse {
                 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';
+                }
+            }
             /**
              * Attach a subscription to the recurring commit/credit.
              */
@@ -606,6 +640,10 @@ export declare namespace PackageRetrieveResponse {
              * 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
@@ -613,7 +651,7 @@ export declare namespace PackageRetrieveResponse {
              * 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
@@ -667,6 +705,24 @@ export declare namespace PackageRetrieveResponse {
                 unit: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
                 value: number;
             }
+            /**
+             * 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';
+                }
+            }
             /**
              * Attach a subscription to the recurring commit/credit.
              */
@@ -684,11 +740,28 @@ export declare namespace PackageRetrieveResponse {
                 }
             }
         }
+        interface SpendTracker {
+            /**
+             * Human-readable identifier, unique per contract.
+             */
+            alias: string;
+            applicable_spend_specifiers: Array<SpendTracker.ApplicableSpendSpecifier>;
+            credit_type_id: string;
+            reset_frequency: 'BILLING_PERIOD';
+        }
+        namespace SpendTracker {
+            interface ApplicableSpendSpecifier {
+                sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+                spend_type: 'COMMIT_PURCHASE';
+                discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+            }
+        }
         interface Subscription {
             collection_schedule: 'ADVANCE' | 'ARREARS';
             proration: Subscription.Proration;
             subscription_rate: Subscription.SubscriptionRate;
             id?: string;
+            billing_cycle_config?: Subscription.BillingCycleConfig;
             /**
              * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
              */
@@ -719,6 +792,19 @@ export declare namespace PackageRetrieveResponse {
             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 SubscriptionRate {
                 billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
@@ -730,6 +816,9 @@ export declare namespace PackageRetrieveResponse {
                     name: string;
                 }
             }
+            interface BillingCycleConfig {
+                invoice_placement?: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+            }
             interface Duration {
                 unit: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
                 value: number;
@@ -792,6 +881,7 @@ export interface PackageListResponse {
      */
     scheduled_charges_on_usage_invoices?: 'ALL';
     spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
+    spend_trackers?: Array<PackageListResponse.SpendTracker>;
     subscriptions?: Array<PackageListResponse.Subscription>;
     /**
      * Prevents the creation of duplicates. If a request to create a record is made
@@ -913,6 +1003,7 @@ export declare namespace PackageListResponse {
     }
     namespace Override {
         interface OverrideSpecifier {
+            any_commit_or_credit_template_ids?: Array<string>;
             billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
             commit_template_ids?: Array<string>;
             presentation_group_values?: {
@@ -1084,6 +1175,10 @@ export declare namespace PackageListResponse {
          * 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
@@ -1091,7 +1186,7 @@ export declare namespace PackageListResponse {
          * 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
@@ -1153,6 +1248,35 @@ export declare namespace PackageListResponse {
             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';
+            }
+        }
         /**
          * Attach a subscription to the recurring commit/credit.
          */
@@ -1211,6 +1335,10 @@ export declare namespace PackageListResponse {
          * 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
@@ -1218,7 +1346,7 @@ export declare namespace PackageListResponse {
          * 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
@@ -1272,6 +1400,24 @@ export declare namespace PackageListResponse {
             unit: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
             value: number;
         }
+        /**
+         * 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';
+            }
+        }
         /**
          * Attach a subscription to the recurring commit/credit.
          */
@@ -1289,11 +1435,28 @@ export declare namespace PackageListResponse {
             }
         }
     }
+    interface SpendTracker {
+        /**
+         * Human-readable identifier, unique per contract.
+         */
+        alias: string;
+        applicable_spend_specifiers: Array<SpendTracker.ApplicableSpendSpecifier>;
+        credit_type_id: string;
+        reset_frequency: 'BILLING_PERIOD';
+    }
+    namespace SpendTracker {
+        interface ApplicableSpendSpecifier {
+            sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+            spend_type: 'COMMIT_PURCHASE';
+            discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+        }
+    }
     interface Subscription {
         collection_schedule: 'ADVANCE' | 'ARREARS';
         proration: Subscription.Proration;
         subscription_rate: Subscription.SubscriptionRate;
         id?: string;
+        billing_cycle_config?: Subscription.BillingCycleConfig;
         /**
          * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
          */
@@ -1324,6 +1487,19 @@ export declare namespace PackageListResponse {
         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 SubscriptionRate {
             billing_frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
@@ -1335,6 +1511,9 @@ export declare namespace PackageListResponse {
                 name: string;
             }
         }
+        interface BillingCycleConfig {
+            invoice_placement?: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+        }
         interface Duration {
             unit: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
             value: number;
@@ -1408,6 +1587,7 @@ export interface PackageCreateParams {
      */
     scheduled_charges_on_usage_invoices?: 'ALL';
     spend_threshold_configuration?: Shared.SpendThresholdConfiguration;
+    spend_trackers?: Array<PackageCreateParams.SpendTracker>;
     subscriptions?: Array<PackageCreateParams.Subscription>;
     /**
      * Prevents the creation of duplicates. If a request to create a record is made
@@ -1689,9 +1869,10 @@ export declare namespace PackageCreateParams {
         entitled?: boolean;
         /**
          * Indicates whether the override should only apply to commits. Defaults to
-         * `false`. If `true`, you can specify relevant commits in `override_specifiers` by
-         * passing `commit_ids`. if you do not specify `commit_ids`, then the override will
-         * apply when consuming any prepaid or postpaid commit.
+         * `false`. If `true` you can specify relevant commits in `override_specifiers` by
+         * passing `commit_ids`, `recurring_commit_ids`, or `any_commit_or_credit_ids`. If
+         * you do not specify any of these fields, the override will apply when consuming
+         * any prepaid commit, postpaid commit, or credit
          */
         is_commit_specific?: boolean;
         /**
@@ -1726,6 +1907,14 @@ export declare namespace PackageCreateParams {
     }
     namespace Override {
         interface OverrideSpecifier {
+            /**
+             * Can only be used for commit specific overrides. Must be used in conjunction with
+             * one of `product_id`, `product_tags`, `pricing_group_values`, or
+             * `presentation_group_values`. Must be used instead of both `commit_ids` and
+             * `recurring_commit_ids` If provided, the override will apply to any specified
+             * commit, credit, recurring commit or recurring credit IDs.
+             */
+            any_commit_or_credit_ids?: Array<string>;
             billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
             /**
              * Can only be used for commit specific overrides. Must be used in conjunction with
@@ -1869,6 +2058,10 @@ export declare namespace PackageCreateParams {
          * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
          */
         proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
+        /**
+         * Optional rounding configuration for prorated recurring commit amounts.
+         */
+        proration_rounding?: RecurringCommit.ProrationRounding;
         /**
          * Whether the created commits will use the commit rate or list rate
          */
@@ -1880,7 +2073,7 @@ export declare namespace PackageCreateParams {
          * 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
@@ -1950,6 +2143,35 @@ export declare namespace PackageCreateParams {
             quantity: number;
             unit_price: number;
         }
+        /**
+         * Optional 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';
+            }
+        }
         /**
          * Attach a subscription to the recurring commit/credit.
          */
@@ -2021,6 +2243,10 @@ export declare namespace PackageCreateParams {
          * the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
          */
         proration?: 'NONE' | 'FIRST' | 'LAST' | 'FIRST_AND_LAST';
+        /**
+         * Optional rounding configuration for prorated recurring credit amounts.
+         */
+        proration_rounding?: RecurringCredit.ProrationRounding;
         /**
          * Whether the created commits will use the commit rate or list rate
          */
@@ -2032,7 +2258,7 @@ export declare namespace PackageCreateParams {
          * 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
@@ -2094,6 +2320,24 @@ export declare namespace PackageCreateParams {
             unit: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
             value: number;
         }
+        /**
+         * Optional 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';
+            }
+        }
         /**
          * Attach a subscription to the recurring commit/credit.
          */
@@ -2177,10 +2421,30 @@ export declare namespace PackageCreateParams {
             }
         }
     }
+    interface SpendTracker {
+        /**
+         * Human-readable identifier, unique per contract.
+         */
+        alias: string;
+        applicable_spend_specifiers: Array<SpendTracker.ApplicableSpendSpecifier>;
+        credit_type_id: string;
+        reset_frequency: 'BILLING_PERIOD';
+    }
+    namespace SpendTracker {
+        interface ApplicableSpendSpecifier {
+            sources: Array<'THRESHOLD_RECHARGE' | 'MANUAL'>;
+            spend_type: 'COMMIT_PURCHASE';
+            /**
+             * Filter by whether the spend was discounted. Defaults to ANY if omitted.
+             */
+            discounted?: 'ANY' | 'DISCOUNTED_ONLY' | 'UNDISCOUNTED_ONLY';
+        }
+    }
     interface Subscription {
         collection_schedule: 'ADVANCE' | 'ARREARS';
         proration: Subscription.Proration;
         subscription_rate: Subscription.SubscriptionRate;
+        billing_cycle_config?: Subscription.BillingCycleConfig;
         /**
          * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
          */
@@ -2237,6 +2501,19 @@ export declare namespace PackageCreateParams {
              * Indicates if the partial period will be prorated or charged a full amount.
              */
             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 SubscriptionRate {
             /**
@@ -2249,6 +2526,13 @@ export declare namespace PackageCreateParams {
              */
             product_id: string;
         }
+        interface BillingCycleConfig {
+            /**
+             * Controls whether subscriptions consolidate onto usage invoices. Defaults to
+             * ON_USAGE_INVOICE if omitted.
+             */
+            invoice_placement?: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+        }
         /**
          * Lifetime of the subscription from its start. If not provided, subscription
          * inherits contract end date.