orb-billing 5.44.0 → 5.45.0

package/resources/prices/prices.d.ts

@@ -6,6 +6,15 @@ import { PricesPage } from "../shared.js";
 import * as ExternalPriceIDAPI from "./external-price-id.js";
 import { ExternalPriceID, ExternalPriceIDUpdateParams } from "./external-price-id.js";
 import { type PageParams } from "../../pagination.js";
+/**
+ * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
+ * the form of an invoice line item. Prices take a quantity and determine an amount to bill.
+ *
+ * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
+ * given Price object. The model_type field determines the key for the configuration object that is present.
+ *
+ * For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price)
+ */
 export declare class Prices extends APIResource {
     externalPriceId: ExternalPriceIDAPI.ExternalPriceID;
     /**
@@ -262,6 +271,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -341,6 +354,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -420,6 +437,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -499,6 +520,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -621,6 +646,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -700,6 +729,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -779,6 +812,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -886,6 +923,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -992,6 +1033,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1104,6 +1149,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1211,6 +1260,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1313,6 +1366,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1402,6 +1459,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1496,6 +1557,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1575,6 +1640,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1681,6 +1750,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1771,6 +1844,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1869,6 +1946,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1974,6 +2055,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2072,6 +2157,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2203,6 +2292,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2305,6 +2398,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2418,6 +2515,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2526,6 +2627,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2633,6 +2738,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2659,6 +2768,10 @@ export declare namespace PriceCreateParams {
              * The final unit price to rate against the output of the matrix
              */
             unit_price: string;
+            /**
+             * The property used to group this price
+             */
+            grouping_key?: string | null;
             /**
              * If true, the unit price will be prorated to the billing period
              */
@@ -2749,6 +2862,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2865,6 +2982,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2975,6 +3096,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3077,6 +3202,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3171,6 +3300,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3261,6 +3394,10 @@ export declare namespace PriceCreateParams {
          * If unspecified, a single invoice is produced per billing cycle.
          */
         invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+        /**
+         * The ID of the license type to associate with this price.
+         */
+        license_type_id?: string | null;
         /**
          * User-specified key/value pairs for the resource. Individual keys can be removed
          * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3334,6 +3471,13 @@ export interface PriceEvaluateParams {
      * to group the underlying billable metric
      */
     grouping_keys?: Array<string>;
+    /**
+     * Optional overrides for parameterized billable metric parameters. If the metric
+     * has parameter definitions and no overrides are provided, defaults will be used.
+     */
+    metric_parameter_overrides?: {
+        [key: string]: unknown;
+    } | null;
 }
 export interface PriceEvaluateMultipleParams {
     /**
@@ -3375,6 +3519,13 @@ export declare namespace PriceEvaluateMultipleParams {
          * to group the underlying billable metric
          */
         grouping_keys?: Array<string>;
+        /**
+         * Optional overrides for parameterized billable metric parameters. If the metric
+         * has parameter definitions and no overrides are provided, defaults will be used.
+         */
+        metric_parameter_overrides?: {
+            [key: string]: unknown;
+        } | null;
         /**
          * New floating price request body params.
          */
@@ -3455,6 +3606,10 @@ export declare namespace PriceEvaluateMultipleParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3577,6 +3732,10 @@ export declare namespace PriceEvaluateMultipleParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3679,6 +3838,10 @@ export declare namespace PriceEvaluateMultipleParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3781,6 +3944,10 @@ export declare namespace PriceEvaluateMultipleParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3871,6 +4038,10 @@ export declare namespace PriceEvaluateMultipleParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3976,6 +4147,13 @@ export declare namespace PriceEvaluatePreviewEventsParams {
          * to group the underlying billable metric
          */
         grouping_keys?: Array<string>;
+        /**
+         * Optional overrides for parameterized billable metric parameters. If the metric
+         * has parameter definitions and no overrides are provided, defaults will be used.
+         */
+        metric_parameter_overrides?: {
+            [key: string]: unknown;
+        } | null;
         /**
          * New floating price request body params.
          */
@@ -4056,6 +4234,10 @@ export declare namespace PriceEvaluatePreviewEventsParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4178,6 +4360,10 @@ export declare namespace PriceEvaluatePreviewEventsParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4280,6 +4466,10 @@ export declare namespace PriceEvaluatePreviewEventsParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4382,6 +4572,10 @@ export declare namespace PriceEvaluatePreviewEventsParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4472,6 +4666,10 @@ export declare namespace PriceEvaluatePreviewEventsParams {
              * If unspecified, a single invoice is produced per billing cycle.
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The ID of the license type to associate with this price.
+             */
+            license_type_id?: string | null;
             /**
              * User-specified key/value pairs for the resource. Individual keys can be removed
              * by setting the value to `null`, and the entire metadata mapping can be cleared