orb-billing 5.14.0 → 5.16.0

package/resources/shared.d.ts

@@ -1537,8 +1537,18 @@ export interface InvoiceTiny {
      */
     id: string;
 }
+/**
+ * A minimal representation of an Item containing only the essential identifying
+ * information.
+ */
 export interface ItemSlim {
+    /**
+     * The Orb-assigned unique identifier for the item.
+     */
     id: string;
+    /**
+     * The name of the item.
+     */
     name: string;
 }
 /**
@@ -1568,6 +1578,10 @@ export interface MatrixSubLineItem {
     name: string;
     quantity: number;
     type: 'matrix';
+    /**
+     * The scaled quantity for this line item for specific pricing structures
+     */
+    scaled_quantity?: number | null;
 }
 /**
  * Configuration for a single matrix value
@@ -7766,7 +7780,7 @@ export interface PlanPhaseUsageDiscountAdjustment {
  * For more on the types of prices, see
  * [the core concepts documentation](/core-concepts#plan-and-price)
  */
-export type Price = Price.UnitPrice | Price.TieredPrice | Price.BulkPrice | Price.PackagePrice | Price.MatrixPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.TieredWithMinimumPrice | Price.GroupedTieredPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.BulkWithProrationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.GroupedWithMinMaxThresholdsPrice | Price.MatrixWithDisplayNamePrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice | Price.CumulativeGroupedBulkPrice | Price.MinimumCompositePrice;
+export type Price = Price.UnitPrice | Price.TieredPrice | Price.BulkPrice | Price.PackagePrice | Price.MatrixPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.TieredWithMinimumPrice | Price.GroupedTieredPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.BulkWithProrationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.GroupedWithMinMaxThresholdsPrice | Price.MatrixWithDisplayNamePrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice | Price.CumulativeGroupedBulkPrice | Price.MinimumCompositePrice | Price.PercentCompositePrice | Price.EventOutputPrice;
 export declare namespace Price {
     interface UnitPrice {
         id: string;
@@ -7787,6 +7801,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -7850,6 +7868,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -7917,6 +7939,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -7976,6 +8002,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8039,6 +8069,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * Configuration for matrix pricing
@@ -8102,6 +8136,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8196,6 +8234,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8292,6 +8334,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8398,6 +8444,10 @@ export declare namespace Price {
          */
         grouped_tiered_config: GroupedTieredPrice.GroupedTieredConfig;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8488,6 +8538,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8586,6 +8640,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8668,6 +8726,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8746,6 +8808,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * Configuration for matrix_with_allocation pricing
@@ -8809,6 +8875,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8899,6 +8969,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -8977,6 +9051,10 @@ export declare namespace Price {
          */
         grouped_allocation_config: GroupedAllocationPrice.GroupedAllocationConfig;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9059,6 +9137,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9148,6 +9230,10 @@ export declare namespace Price {
          */
         grouped_with_prorated_minimum_config: GroupedWithProratedMinimumPrice.GroupedWithProratedMinimumConfig;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9230,6 +9316,10 @@ export declare namespace Price {
          */
         grouped_with_metered_minimum_config: GroupedWithMeteredMinimumPrice.GroupedWithMeteredMinimumConfig;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9354,6 +9444,10 @@ export declare namespace Price {
          */
         grouped_with_min_max_thresholds_config: GroupedWithMinMaxThresholdsPrice.GroupedWithMinMaxThresholdsConfig;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9436,6 +9530,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * Configuration for matrix_with_display_name pricing
@@ -9537,6 +9635,10 @@ export declare namespace Price {
          */
         grouped_tiered_package_config: GroupedTieredPackagePrice.GroupedTieredPackageConfig;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9631,6 +9733,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * Configuration for max_group_tiered_package pricing
@@ -9728,6 +9834,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9837,6 +9947,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -9959,6 +10073,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -10052,6 +10170,10 @@ export declare namespace Price {
         external_price_id: string | null;
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
         item: Shared.ItemSlim;
         /**
          * @deprecated
@@ -10111,6 +10233,167 @@ export declare namespace Price {
             prorated?: boolean;
         }
     }
+    interface PercentCompositePrice {
+        id: string;
+        billable_metric: Shared.BillableMetricTiny | null;
+        billing_cycle_configuration: Shared.BillingCycleConfiguration;
+        billing_mode: 'in_advance' | 'in_arrear';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+        composite_price_filters: Array<Shared.TransformPriceFilter> | null;
+        conversion_rate: number | null;
+        conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+        created_at: string;
+        credit_allocation: Shared.Allocation | null;
+        currency: string;
+        /**
+         * @deprecated
+         */
+        discount: Shared.Discount | null;
+        external_price_id: string | null;
+        fixed_price_quantity: number | null;
+        invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
+        item: Shared.ItemSlim;
+        /**
+         * @deprecated
+         */
+        maximum: Shared.Maximum | null;
+        /**
+         * @deprecated
+         */
+        maximum_amount: string | null;
+        /**
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * @deprecated
+         */
+        minimum: Shared.Minimum | null;
+        /**
+         * @deprecated
+         */
+        minimum_amount: string | null;
+        /**
+         * The pricing model type
+         */
+        model_type: 'percent';
+        name: string;
+        /**
+         * Configuration for percent pricing
+         */
+        percent_config: PercentCompositePrice.PercentConfig;
+        plan_phase_order: number | null;
+        price_type: 'usage_price' | 'fixed_price' | 'composite_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
+    }
+    namespace PercentCompositePrice {
+        /**
+         * Configuration for percent pricing
+         */
+        interface PercentConfig {
+            /**
+             * What percent of the component subtotals to charge
+             */
+            percent: number;
+        }
+    }
+    interface EventOutputPrice {
+        id: string;
+        billable_metric: Shared.BillableMetricTiny | null;
+        billing_cycle_configuration: Shared.BillingCycleConfiguration;
+        billing_mode: 'in_advance' | 'in_arrear';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+        composite_price_filters: Array<Shared.TransformPriceFilter> | null;
+        conversion_rate: number | null;
+        conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+        created_at: string;
+        credit_allocation: Shared.Allocation | null;
+        currency: string;
+        /**
+         * @deprecated
+         */
+        discount: Shared.Discount | null;
+        /**
+         * Configuration for event_output pricing
+         */
+        event_output_config: EventOutputPrice.EventOutputConfig;
+        external_price_id: string | null;
+        fixed_price_quantity: number | null;
+        invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+        /**
+         * A minimal representation of an Item containing only the essential identifying
+         * information.
+         */
+        item: Shared.ItemSlim;
+        /**
+         * @deprecated
+         */
+        maximum: Shared.Maximum | null;
+        /**
+         * @deprecated
+         */
+        maximum_amount: string | null;
+        /**
+         * User specified key-value pairs for the resource. If not present, this defaults
+         * to an empty dictionary. Individual keys can be removed by setting the value to
+         * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+         * `null`.
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * @deprecated
+         */
+        minimum: Shared.Minimum | null;
+        /**
+         * @deprecated
+         */
+        minimum_amount: string | null;
+        /**
+         * The pricing model type
+         */
+        model_type: 'event_output';
+        name: string;
+        plan_phase_order: number | null;
+        price_type: 'usage_price' | 'fixed_price' | 'composite_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
+    }
+    namespace EventOutputPrice {
+        /**
+         * Configuration for event_output pricing
+         */
+        interface EventOutputConfig {
+            /**
+             * The key in the event data to extract the unit rate from.
+             */
+            unit_rating_key: string;
+            /**
+             * An optional key in the event data to group by (e.g., event ID). All events will
+             * also be grouped by their unit rate.
+             */
+            grouping_key?: string | null;
+        }
+    }
 }
 /**
  * The Price Interval resource represents a period of time for which a price will