@metronome/sdk 3.7.0 → 3.8.0

package/src/resources/v1/dashboards.ts

@@ -31,8 +31,13 @@ export class Dashboards extends APIResource {
    *
    * - Dashboard types: Choose from `invoices`, `usage`, or `commits_and_credits`
    * - Customization options:
-   *   - `dashboard_options`: Configure whether you want invoices to show zero usage
-   *     line items
+   *   - `dashboard_options`: Configure dashboard behavior. For the invoices
+   *     dashboard, supported keys include: `show_zero_usage_line_items`
+   *     ("true"/"false"), `hide_voided_invoices` ("true"/"false"), `contract_id`
+   *     (UUID, filters invoices by contract), `invoice_type` ("USAGE" or
+   *     "SCHEDULED", filters by invoice type), `invoice_status_filter` ("VOID",
+   *     "FINALIZED", "DRAFT", "FINALIZED_AND_DRAFT", or "ALL"), and
+   *     `billable_status_filter` ("BILLABLE", "UNBILLABLE", or "ALL")
    *   - `color_overrides`: Match your brand's color palette
    *   - `bm_group_key_overrides`: Customize how dimensions are displayed (for the
    *     usage embeddable dashboard)
@@ -151,7 +156,9 @@ export namespace DashboardGetEmbeddableURLParams {
       | 'Primary_green'
       | 'Primary_red'
       | 'Progress_bar'
-      | 'Progress_bar_background';
+      | 'Progress_bar_background'
+      | 'Action'
+      | 'Action_hover';
 
     /**
      * Hex value representation of the color

package/src/resources/v1/index.ts

@@ -34,6 +34,7 @@ export {
   type ContractArchiveResponse,
   type ContractCreateHistoricalInvoicesResponse,
   type ContractGetNetBalanceResponse,
+  type ContractGetSubscriptionSeatsHistoryResponse,
   type ContractListBalancesResponse,
   type ContractListSeatBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
@@ -48,6 +49,7 @@ export {
   type ContractArchiveParams,
   type ContractCreateHistoricalInvoicesParams,
   type ContractGetNetBalanceParams,
+  type ContractGetSubscriptionSeatsHistoryParams,
   type ContractListBalancesParams,
   type ContractListSeatBalancesParams,
   type ContractRetrieveRateScheduleParams,

package/src/resources/v1/packages.ts

@@ -430,6 +430,8 @@ export namespace PackageRetrieveResponse {
 
     export namespace Override {
       export interface OverrideSpecifier {
+        any_commit_or_credit_template_ids?: Array<string>;
+
         billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
         commit_template_ids?: Array<string>;
@@ -666,6 +668,11 @@ export namespace PackageRetrieveResponse {
        */
       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
@@ -673,7 +680,7 @@ export 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
@@ -753,6 +760,41 @@ export namespace PackageRetrieveResponse {
         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';
+        }
+      }
+
       /**
        * Attach a subscription to the recurring commit/credit.
        */
@@ -828,6 +870,11 @@ export namespace PackageRetrieveResponse {
        */
       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
@@ -835,7 +882,7 @@ export 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
@@ -904,6 +951,27 @@ export namespace PackageRetrieveResponse {
         value: number;
       }
 
+      /**
+       * 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';
+        }
+      }
+
       /**
        * Attach a subscription to the recurring commit/credit.
        */
@@ -957,6 +1025,8 @@ export namespace PackageRetrieveResponse {
 
       id?: string;
 
+      billing_cycle_config?: Subscription.BillingCycleConfig;
+
       /**
        * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
        */
@@ -995,6 +1065,22 @@ export namespace PackageRetrieveResponse {
         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 SubscriptionRate {
@@ -1011,6 +1097,10 @@ export namespace PackageRetrieveResponse {
         }
       }
 
+      export interface BillingCycleConfig {
+        invoice_placement?: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+      }
+
       export interface Duration {
         unit: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
 
@@ -1282,6 +1372,8 @@ export namespace PackageListResponse {
 
   export namespace Override {
     export interface OverrideSpecifier {
+      any_commit_or_credit_template_ids?: Array<string>;
+
       billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
       commit_template_ids?: Array<string>;
@@ -1518,6 +1610,11 @@ export namespace PackageListResponse {
      */
     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
@@ -1525,7 +1622,7 @@ export 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
@@ -1605,6 +1702,41 @@ export namespace PackageListResponse {
       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';
+      }
+    }
+
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -1680,6 +1812,11 @@ export namespace PackageListResponse {
      */
     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
@@ -1687,7 +1824,7 @@ export 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
@@ -1756,6 +1893,27 @@ export namespace PackageListResponse {
       value: number;
     }
 
+    /**
+     * 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';
+      }
+    }
+
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -1809,6 +1967,8 @@ export namespace PackageListResponse {
 
     id?: string;
 
+    billing_cycle_config?: Subscription.BillingCycleConfig;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -1847,6 +2007,22 @@ export namespace PackageListResponse {
       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 SubscriptionRate {
@@ -1863,6 +2039,10 @@ export namespace PackageListResponse {
       }
     }
 
+    export interface BillingCycleConfig {
+      invoice_placement?: 'ON_SCHEDULED_INVOICE' | 'ON_USAGE_INVOICE';
+    }
+
     export interface Duration {
       unit: 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS';
 
@@ -2307,9 +2487,10 @@ export namespace PackageCreateParams {
 
     /**
      * 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;
 
@@ -2351,6 +2532,15 @@ export namespace PackageCreateParams {
 
   export namespace Override {
     export 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';
 
       /**
@@ -2520,6 +2710,11 @@ export namespace PackageCreateParams {
      */
     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
      */
@@ -2532,7 +2727,7 @@ export 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
@@ -2619,6 +2814,41 @@ export namespace PackageCreateParams {
       unit_price: number;
     }
 
+    /**
+     * Optional 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';
+      }
+    }
+
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -2705,6 +2935,11 @@ export namespace PackageCreateParams {
      */
     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
      */
@@ -2717,7 +2952,7 @@ export 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
@@ -2793,6 +3028,27 @@ export namespace PackageCreateParams {
       value: number;
     }
 
+    /**
+     * Optional 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';
+      }
+    }
+
     /**
      * Attach a subscription to the recurring commit/credit.
      */
@@ -2922,6 +3178,8 @@ export namespace PackageCreateParams {
 
     subscription_rate: Subscription.SubscriptionRate;
 
+    billing_cycle_config?: Subscription.BillingCycleConfig;
+
     /**
      * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
      */
@@ -2986,6 +3244,22 @@ export namespace PackageCreateParams {
        * Indicates if the partial period will be prorated or charged a full amount.
        */
       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 SubscriptionRate {
@@ -3001,6 +3275,14 @@ export namespace PackageCreateParams {
       product_id: string;
     }
 
+    export 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.

package/src/resources/v1/v1.ts

@@ -136,6 +136,8 @@ import {
   ContractCreateResponse,
   ContractGetNetBalanceParams,
   ContractGetNetBalanceResponse,
+  ContractGetSubscriptionSeatsHistoryParams,
+  ContractGetSubscriptionSeatsHistoryResponse,
   ContractListBalancesParams,
   ContractListBalancesResponse,
   ContractListBalancesResponsesBodyCursorPage,
@@ -381,6 +383,7 @@ export declare namespace V1 {
     type ContractArchiveResponse as ContractArchiveResponse,
     type ContractCreateHistoricalInvoicesResponse as ContractCreateHistoricalInvoicesResponse,
     type ContractGetNetBalanceResponse as ContractGetNetBalanceResponse,
+    type ContractGetSubscriptionSeatsHistoryResponse as ContractGetSubscriptionSeatsHistoryResponse,
     type ContractListBalancesResponse as ContractListBalancesResponse,
     type ContractListSeatBalancesResponse as ContractListSeatBalancesResponse,
     type ContractRetrieveRateScheduleResponse as ContractRetrieveRateScheduleResponse,
@@ -396,6 +399,7 @@ export declare namespace V1 {
     type ContractArchiveParams as ContractArchiveParams,
     type ContractCreateHistoricalInvoicesParams as ContractCreateHistoricalInvoicesParams,
     type ContractGetNetBalanceParams as ContractGetNetBalanceParams,
+    type ContractGetSubscriptionSeatsHistoryParams as ContractGetSubscriptionSeatsHistoryParams,
     type ContractListBalancesParams as ContractListBalancesParams,
     type ContractListSeatBalancesParams as ContractListSeatBalancesParams,
     type ContractRetrieveRateScheduleParams as ContractRetrieveRateScheduleParams,