orb-billing 5.14.0 → 5.16.0

package/src/resources/shared.ts

@@ -2097,9 +2097,19 @@ 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;
 }
 
@@ -2138,6 +2148,11 @@ export interface MatrixSubLineItem {
   quantity: number;
 
   type: 'matrix';
+
+  /**
+   * The scaled quantity for this line item for specific pricing structures
+   */
+  scaled_quantity?: number | null;
 }
 
 /**
@@ -9528,7 +9543,9 @@ export type Price =
   | Price.ScalableMatrixWithUnitPricingPrice
   | Price.ScalableMatrixWithTieredPricingPrice
   | Price.CumulativeGroupedBulkPrice
-  | Price.MinimumCompositePrice;
+  | Price.MinimumCompositePrice
+  | Price.PercentCompositePrice
+  | Price.EventOutputPrice;
 
 export namespace Price {
   export interface UnitPrice {
@@ -9565,6 +9582,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -9654,6 +9675,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -9748,6 +9773,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -9832,6 +9861,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -9921,6 +9954,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10010,6 +10047,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10134,6 +10175,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10260,6 +10305,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10399,6 +10448,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10518,6 +10571,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10647,6 +10704,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10758,6 +10819,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10864,6 +10929,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -10953,6 +11022,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11072,6 +11145,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11178,6 +11255,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11289,6 +11370,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11407,6 +11492,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11518,6 +11607,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11678,6 +11771,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11789,6 +11886,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -11922,6 +12023,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -12046,6 +12151,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -12174,6 +12283,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -12317,6 +12430,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -12475,6 +12592,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -12598,6 +12719,10 @@ export namespace Price {
 
     invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
 
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
     item: Shared.ItemSlim;
 
     /**
@@ -12669,6 +12794,222 @@ export namespace Price {
       prorated?: boolean;
     }
   }
+
+  export 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;
+  }
+
+  export namespace PercentCompositePrice {
+    /**
+     * Configuration for percent pricing
+     */
+    export interface PercentConfig {
+      /**
+       * What percent of the component subtotals to charge
+       */
+      percent: number;
+    }
+  }
+
+  export 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;
+  }
+
+  export namespace EventOutputPrice {
+    /**
+     * Configuration for event_output pricing
+     */
+    export 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;
+    }
+  }
 }
 
 /**