orb-billing 5.0.0 → 5.2.0

package/src/resources/prices/prices.ts

@@ -203,6 +203,11 @@ export namespace PriceEvaluateMultipleResponse {
      */
     price_groups: Array<PricesAPI.EvaluatePriceGroup>;
 
+    /**
+     * The external ID of the price
+     */
+    external_price_id?: string | null;
+
     /**
      * The index of the inline price
      */
@@ -231,6 +236,11 @@ export namespace PriceEvaluatePreviewEventsResponse {
      */
     price_groups: Array<PricesAPI.EvaluatePriceGroup>;
 
+    /**
+     * The external ID of the price
+     */
+    external_price_id?: string | null;
+
     /**
      * The index of the inline price
      */
@@ -359,7 +369,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingPackagePrice {
@@ -447,7 +457,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingMatrixPrice {
@@ -535,7 +545,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingMatrixWithAllocationPrice {
@@ -623,7 +633,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingTieredPrice {
@@ -711,7 +721,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingTieredBPSPrice {
@@ -799,7 +809,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingBPSPrice {
@@ -887,7 +897,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingBulkBPSPrice {
@@ -975,7 +985,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingBulkPrice {
@@ -1063,7 +1073,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingThresholdTotalAmountPrice {
@@ -1089,7 +1099,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    threshold_total_amount_config: Record<string, unknown>;
+    threshold_total_amount_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1151,7 +1161,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingTieredPackagePrice {
@@ -1177,7 +1187,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    tiered_package_config: Record<string, unknown>;
+    tiered_package_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1239,7 +1249,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingGroupedTieredPrice {
@@ -1253,7 +1263,7 @@ export declare namespace PriceCreateParams {
      */
     currency: string;
 
-    grouped_tiered_config: Record<string, unknown>;
+    grouped_tiered_config: { [key: string]: unknown };
 
     /**
      * The id of the item the price will be associated with.
@@ -1327,7 +1337,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingMaxGroupTieredPackagePrice {
@@ -1346,7 +1356,7 @@ export declare namespace PriceCreateParams {
      */
     item_id: string;
 
-    max_group_tiered_package_config: Record<string, unknown>;
+    max_group_tiered_package_config: { [key: string]: unknown };
 
     model_type: 'max_group_tiered_package';
 
@@ -1415,7 +1425,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingTieredWithMinimumPrice {
@@ -1441,7 +1451,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    tiered_with_minimum_config: Record<string, unknown>;
+    tiered_with_minimum_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1503,7 +1513,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingPackageWithAllocationPrice {
@@ -1529,7 +1539,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    package_with_allocation_config: Record<string, unknown>;
+    package_with_allocation_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1591,7 +1601,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingTieredPackageWithMinimumPrice {
@@ -1617,7 +1627,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    tiered_package_with_minimum_config: Record<string, unknown>;
+    tiered_package_with_minimum_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1679,7 +1689,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingUnitWithPercentPrice {
@@ -1705,7 +1715,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    unit_with_percent_config: Record<string, unknown>;
+    unit_with_percent_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1767,7 +1777,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingTieredWithProrationPrice {
@@ -1793,7 +1803,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    tiered_with_proration_config: Record<string, unknown>;
+    tiered_with_proration_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1855,7 +1865,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingUnitWithProrationPrice {
@@ -1881,7 +1891,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    unit_with_proration_config: Record<string, unknown>;
+    unit_with_proration_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -1943,7 +1953,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingGroupedAllocationPrice {
@@ -1957,7 +1967,7 @@ export declare namespace PriceCreateParams {
      */
     currency: string;
 
-    grouped_allocation_config: Record<string, unknown>;
+    grouped_allocation_config: { [key: string]: unknown };
 
     /**
      * The id of the item the price will be associated with.
@@ -2031,7 +2041,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingGroupedWithProratedMinimumPrice {
@@ -2045,7 +2055,7 @@ export declare namespace PriceCreateParams {
      */
     currency: string;
 
-    grouped_with_prorated_minimum_config: Record<string, unknown>;
+    grouped_with_prorated_minimum_config: { [key: string]: unknown };
 
     /**
      * The id of the item the price will be associated with.
@@ -2119,7 +2129,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingGroupedWithMeteredMinimumPrice {
@@ -2133,7 +2143,7 @@ export declare namespace PriceCreateParams {
      */
     currency: string;
 
-    grouped_with_metered_minimum_config: Record<string, unknown>;
+    grouped_with_metered_minimum_config: { [key: string]: unknown };
 
     /**
      * The id of the item the price will be associated with.
@@ -2207,7 +2217,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingMatrixWithDisplayNamePrice {
@@ -2226,7 +2236,7 @@ export declare namespace PriceCreateParams {
      */
     item_id: string;
 
-    matrix_with_display_name_config: Record<string, unknown>;
+    matrix_with_display_name_config: { [key: string]: unknown };
 
     model_type: 'matrix_with_display_name';
 
@@ -2295,11 +2305,11 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingBulkWithProrationPrice {
-    bulk_with_proration_config: Record<string, unknown>;
+    bulk_with_proration_config: { [key: string]: unknown };
 
     /**
      * The cadence to bill for this price on.
@@ -2383,7 +2393,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingGroupedTieredPackagePrice {
@@ -2397,7 +2407,7 @@ export declare namespace PriceCreateParams {
      */
     currency: string;
 
-    grouped_tiered_package_config: Record<string, unknown>;
+    grouped_tiered_package_config: { [key: string]: unknown };
 
     /**
      * The id of the item the price will be associated with.
@@ -2471,7 +2481,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingScalableMatrixWithUnitPricingPrice {
@@ -2497,7 +2507,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    scalable_matrix_with_unit_pricing_config: Record<string, unknown>;
+    scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -2559,7 +2569,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingScalableMatrixWithTieredPricingPrice {
@@ -2585,7 +2595,7 @@ export declare namespace PriceCreateParams {
      */
     name: string;
 
-    scalable_matrix_with_tiered_pricing_config: Record<string, unknown>;
+    scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
 
     /**
      * The id of the billable metric for the price. Only needed if the price is
@@ -2647,7 +2657,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 
   export interface NewFloatingCumulativeGroupedBulkPrice {
@@ -2656,7 +2666,7 @@ export declare namespace PriceCreateParams {
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
-    cumulative_grouped_bulk_config: Record<string, unknown>;
+    cumulative_grouped_bulk_config: { [key: string]: unknown };
 
     /**
      * An ISO 4217 currency string for which this price is billed in.
@@ -2735,7 +2745,7 @@ export declare namespace PriceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: { [key: string]: string | null } | null;
   }
 }
 
@@ -2745,7 +2755,7 @@ export interface PriceUpdateParams {
    * by setting the value to `null`, and the entire metadata mapping can be cleared
    * by setting `metadata` to `null`.
    */
-  metadata?: Record<string, string | null> | null;
+  metadata?: { [key: string]: string | null } | null;
 }
 
 export interface PriceListParams extends PageParams {}
@@ -2815,6 +2825,11 @@ export interface PriceEvaluateMultipleParams {
 
 export namespace PriceEvaluateMultipleParams {
   export interface PriceEvaluation {
+    /**
+     * The external ID of a price to evaluate that exists in your Orb account.
+     */
+    external_price_id?: string | null;
+
     /**
      * A boolean
      * [computed property](/extensibility/advanced-metrics#computed-properties) used to
@@ -2914,7 +2929,7 @@ export namespace PriceEvaluatePreviewEventsParams {
      * A dictionary of custom properties. Values in this dictionary must be numeric,
      * boolean, or strings. Nested dictionaries are disallowed.
      */
-    properties: Record<string, unknown>;
+    properties: { [key: string]: unknown };
 
     /**
      * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -2936,6 +2951,11 @@ export namespace PriceEvaluatePreviewEventsParams {
   }
 
   export interface PriceEvaluation {
+    /**
+     * The external ID of a price to evaluate that exists in your Orb account.
+     */
+    external_price_id?: string | null;
+
     /**
      * A boolean
      * [computed property](/extensibility/advanced-metrics#computed-properties) used to