orb-billing 5.0.0 → 5.1.0

package/resources/prices/prices.d.ts

@@ -149,6 +149,10 @@ export declare namespace PriceEvaluateMultipleResponse {
          * The computed price groups associated with input price.
          */
         price_groups: Array<PricesAPI.EvaluatePriceGroup>;
+        /**
+         * The external ID of the price
+         */
+        external_price_id?: string | null;
         /**
          * The index of the inline price
          */
@@ -172,6 +176,10 @@ export declare namespace PriceEvaluatePreviewEventsResponse {
          * The computed price groups associated with input price.
          */
         price_groups: Array<PricesAPI.EvaluatePriceGroup>;
+        /**
+         * The external ID of the price
+         */
+        external_price_id?: string | null;
         /**
          * The index of the inline price
          */
@@ -253,7 +261,9 @@ 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;
     }
     interface NewFloatingPackagePrice {
         /**
@@ -324,7 +334,9 @@ 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;
     }
     interface NewFloatingMatrixPrice {
         /**
@@ -395,7 +407,9 @@ 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;
     }
     interface NewFloatingMatrixWithAllocationPrice {
         /**
@@ -466,7 +480,9 @@ 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;
     }
     interface NewFloatingTieredPrice {
         /**
@@ -537,7 +553,9 @@ 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;
     }
     interface NewFloatingTieredBPSPrice {
         /**
@@ -608,7 +626,9 @@ 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;
     }
     interface NewFloatingBPSPrice {
         bps_config: Shared.BPSConfig;
@@ -679,7 +699,9 @@ 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;
     }
     interface NewFloatingBulkBPSPrice {
         bulk_bps_config: Shared.BulkBPSConfig;
@@ -750,7 +772,9 @@ 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;
     }
     interface NewFloatingBulkPrice {
         bulk_config: Shared.BulkConfig;
@@ -821,7 +845,9 @@ 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;
     }
     interface NewFloatingThresholdTotalAmountPrice {
         /**
@@ -841,7 +867,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -892,7 +920,9 @@ 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;
     }
     interface NewFloatingTieredPackagePrice {
         /**
@@ -912,7 +942,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -963,7 +995,9 @@ 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;
     }
     interface NewFloatingGroupedTieredPrice {
         /**
@@ -974,7 +1008,9 @@ export declare namespace PriceCreateParams {
          * An ISO 4217 currency string for which this price is billed in.
          */
         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.
          */
@@ -1034,7 +1070,9 @@ 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;
     }
     interface NewFloatingMaxGroupTieredPackagePrice {
         /**
@@ -1049,7 +1087,9 @@ export declare namespace PriceCreateParams {
          * The id of the item the price will be associated with.
          */
         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';
         /**
          * The name of the price.
@@ -1105,7 +1145,9 @@ 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;
     }
     interface NewFloatingTieredWithMinimumPrice {
         /**
@@ -1125,7 +1167,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -1176,7 +1220,9 @@ 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;
     }
     interface NewFloatingPackageWithAllocationPrice {
         /**
@@ -1196,7 +1242,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -1247,7 +1295,9 @@ 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;
     }
     interface NewFloatingTieredPackageWithMinimumPrice {
         /**
@@ -1267,7 +1317,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -1318,7 +1370,9 @@ 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;
     }
     interface NewFloatingUnitWithPercentPrice {
         /**
@@ -1338,7 +1392,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -1389,7 +1445,9 @@ 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;
     }
     interface NewFloatingTieredWithProrationPrice {
         /**
@@ -1409,7 +1467,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -1460,7 +1520,9 @@ 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;
     }
     interface NewFloatingUnitWithProrationPrice {
         /**
@@ -1480,7 +1542,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -1531,7 +1595,9 @@ 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;
     }
     interface NewFloatingGroupedAllocationPrice {
         /**
@@ -1542,7 +1608,9 @@ export declare namespace PriceCreateParams {
          * An ISO 4217 currency string for which this price is billed in.
          */
         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.
          */
@@ -1602,7 +1670,9 @@ 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;
     }
     interface NewFloatingGroupedWithProratedMinimumPrice {
         /**
@@ -1613,7 +1683,9 @@ export declare namespace PriceCreateParams {
          * An ISO 4217 currency string for which this price is billed in.
          */
         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.
          */
@@ -1673,7 +1745,9 @@ 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;
     }
     interface NewFloatingGroupedWithMeteredMinimumPrice {
         /**
@@ -1684,7 +1758,9 @@ export declare namespace PriceCreateParams {
          * An ISO 4217 currency string for which this price is billed in.
          */
         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.
          */
@@ -1744,7 +1820,9 @@ 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;
     }
     interface NewFloatingMatrixWithDisplayNamePrice {
         /**
@@ -1759,7 +1837,9 @@ export declare namespace PriceCreateParams {
          * The id of the item the price will be associated with.
          */
         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';
         /**
          * The name of the price.
@@ -1815,10 +1895,14 @@ 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;
     }
     interface NewFloatingBulkWithProrationPrice {
-        bulk_with_proration_config: Record<string, unknown>;
+        bulk_with_proration_config: {
+            [key: string]: unknown;
+        };
         /**
          * The cadence to bill for this price on.
          */
@@ -1886,7 +1970,9 @@ 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;
     }
     interface NewFloatingGroupedTieredPackagePrice {
         /**
@@ -1897,7 +1983,9 @@ export declare namespace PriceCreateParams {
          * An ISO 4217 currency string for which this price is billed in.
          */
         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.
          */
@@ -1957,7 +2045,9 @@ 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;
     }
     interface NewFloatingScalableMatrixWithUnitPricingPrice {
         /**
@@ -1977,7 +2067,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -2028,7 +2120,9 @@ 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;
     }
     interface NewFloatingScalableMatrixWithTieredPricingPrice {
         /**
@@ -2048,7 +2142,9 @@ export declare namespace PriceCreateParams {
          * The name of the price.
          */
         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
          * usage-based.
@@ -2099,14 +2195,18 @@ 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;
     }
     interface NewFloatingCumulativeGroupedBulkPrice {
         /**
          * The cadence to bill for this price on.
          */
         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.
          */
@@ -2170,7 +2270,9 @@ 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 PriceUpdateParams {
@@ -2179,7 +2281,9 @@ 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 {
 }
@@ -2237,6 +2341,10 @@ export interface PriceEvaluateMultipleParams {
 }
 export declare namespace PriceEvaluateMultipleParams {
     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
@@ -2296,7 +2404,9 @@ export declare 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
          * represent the time that usage was recorded, and is particularly important to
@@ -2314,6 +2424,10 @@ export declare namespace PriceEvaluatePreviewEventsParams {
         external_customer_id?: string | null;
     }
     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