orb-billing 6.14.0 → 6.16.0

package/src/resources/prices/prices.ts

@@ -324,6 +324,7 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingPackageWithAllocationPrice
   | PriceCreateParams.NewFloatingUnitWithPercentPrice
   | PriceCreateParams.NewFloatingMatrixWithAllocationPrice
+  | PriceCreateParams.NewFloatingTieredMatrixWithAllocationPrice
   | PriceCreateParams.NewFloatingMatrixWithThresholdDiscountsPrice
   | PriceCreateParams.NewFloatingTieredWithProrationPrice
   | PriceCreateParams.NewFloatingUnitWithProrationPrice
@@ -2174,6 +2175,160 @@ export declare namespace PriceCreateParams {
     metadata?: { [key: string]: string | null } | null;
   }
 
+  export interface NewFloatingTieredMatrixWithAllocationPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+    /**
+     * An ISO 4217 currency string for which this price is billed in.
+     */
+    currency: string;
+
+    /**
+     * The id of the item the price will be associated with.
+     */
+    item_id: string;
+
+    /**
+     * The pricing model type
+     */
+    model_type: 'tiered_matrix_with_allocation';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    /**
+     * Configuration for tiered_matrix_with_allocation pricing
+     */
+    tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+    /**
+     * The id of the billable metric for the price. Only needed if the price is
+     * usage-based.
+     */
+    billable_metric_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, the price will be billed in-advance if
+     * this is true, and in-arrears if this is false.
+     */
+    billed_in_advance?: boolean | null;
+
+    /**
+     * For custom cadence: specifies the duration of the billing period in days or
+     * months.
+     */
+    billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * The configuration for the rate of the price currency to the invoicing currency.
+     */
+    conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+    /**
+     * For dimensional price: specifies a price group and dimension values
+     */
+    dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+    /**
+     * An alias for the price.
+     */
+    external_price_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units
+     * applied.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The property used to group this price on an invoice
+     */
+    invoice_grouping_key?: string | null;
+
+    /**
+     * Within each billing cycle, specifies the cadence at which invoices are produced.
+     * 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. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
+     */
+    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
+     * by setting `metadata` to `null`.
+     */
+    metadata?: { [key: string]: string | null } | null;
+  }
+
+  export namespace NewFloatingTieredMatrixWithAllocationPrice {
+    /**
+     * Configuration for tiered_matrix_with_allocation pricing
+     */
+    export interface TieredMatrixWithAllocationConfig {
+      /**
+       * Usage allocation, pooled across all matrix cells
+       */
+      allocation: string;
+
+      /**
+       * Per unit rate for usage whose matrix cell has no configured tiers
+       */
+      default_unit_amount: string;
+
+      /**
+       * One or two event property values to evaluate matrix cells by
+       */
+      dimensions: Array<string>;
+
+      /**
+       * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+       * own rows
+       */
+      tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+    }
+
+    export namespace TieredMatrixWithAllocationConfig {
+      /**
+       * Configuration for a single tier scoped to one matrix cell
+       */
+      export interface Tier {
+        /**
+         * The matrix cell this tier applies to, as one or two dimension values
+         */
+        dimension_values: Array<string>;
+
+        /**
+         * Exclusive tier starting value. The tier runs up to and including the next bound
+         * configured for the same matrix cell.
+         */
+        tier_lower_bound: string;
+
+        /**
+         * Per unit amount
+         */
+        unit_amount: string;
+      }
+    }
+  }
+
   export interface NewFloatingMatrixWithThresholdDiscountsPrice {
     /**
      * The cadence to bill for this price on.
@@ -5059,6 +5214,7 @@ export namespace PriceEvaluateMultipleParams {
       | Shared.NewFloatingPackageWithAllocationPrice
       | Shared.NewFloatingUnitWithPercentPrice
       | Shared.NewFloatingMatrixWithAllocationPrice
+      | PriceEvaluation.NewFloatingTieredMatrixWithAllocationPrice
       | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice
       | Shared.NewFloatingTieredWithProrationPrice
       | Shared.NewFloatingUnitWithProrationPrice
@@ -5385,6 +5541,160 @@ export namespace PriceEvaluateMultipleParams {
       }
     }
 
+    export interface NewFloatingTieredMatrixWithAllocationPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * An ISO 4217 currency string for which this price is billed in.
+       */
+      currency: string;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'tiered_matrix_with_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * 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. On a usage price this
+       * also marks the price as eligible to draw down from that license type's
+       * allocation; a usage price created without it is billed normally. Usage prices
+       * with a license type must use the `unit` model, and only draw down when their
+       * currency matches the allocation's.
+       */
+      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
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+    }
+
+    export namespace NewFloatingTieredMatrixWithAllocationPrice {
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      export interface TieredMatrixWithAllocationConfig {
+        /**
+         * Usage allocation, pooled across all matrix cells
+         */
+        allocation: string;
+
+        /**
+         * Per unit rate for usage whose matrix cell has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * One or two event property values to evaluate matrix cells by
+         */
+        dimensions: Array<string>;
+
+        /**
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
+         */
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+      }
+
+      export namespace TieredMatrixWithAllocationConfig {
+        /**
+         * Configuration for a single tier scoped to one matrix cell
+         */
+        export interface Tier {
+          /**
+           * The matrix cell this tier applies to, as one or two dimension values
+           */
+          dimension_values: Array<string>;
+
+          /**
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewFloatingMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.
@@ -6483,6 +6793,7 @@ export namespace PriceEvaluatePreviewEventsParams {
       | Shared.NewFloatingPackageWithAllocationPrice
       | Shared.NewFloatingUnitWithPercentPrice
       | Shared.NewFloatingMatrixWithAllocationPrice
+      | PriceEvaluation.NewFloatingTieredMatrixWithAllocationPrice
       | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice
       | Shared.NewFloatingTieredWithProrationPrice
       | Shared.NewFloatingUnitWithProrationPrice
@@ -6809,6 +7120,160 @@ export namespace PriceEvaluatePreviewEventsParams {
       }
     }
 
+    export interface NewFloatingTieredMatrixWithAllocationPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * An ISO 4217 currency string for which this price is billed in.
+       */
+      currency: string;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'tiered_matrix_with_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * 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. On a usage price this
+       * also marks the price as eligible to draw down from that license type's
+       * allocation; a usage price created without it is billed normally. Usage prices
+       * with a license type must use the `unit` model, and only draw down when their
+       * currency matches the allocation's.
+       */
+      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
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+    }
+
+    export namespace NewFloatingTieredMatrixWithAllocationPrice {
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      export interface TieredMatrixWithAllocationConfig {
+        /**
+         * Usage allocation, pooled across all matrix cells
+         */
+        allocation: string;
+
+        /**
+         * Per unit rate for usage whose matrix cell has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * One or two event property values to evaluate matrix cells by
+         */
+        dimensions: Array<string>;
+
+        /**
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
+         */
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+      }
+
+      export namespace TieredMatrixWithAllocationConfig {
+        /**
+         * Configuration for a single tier scoped to one matrix cell
+         */
+        export interface Tier {
+          /**
+           * The matrix cell this tier applies to, as one or two dimension values
+           */
+          dimension_values: Array<string>;
+
+          /**
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewFloatingMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.

package/src/resources/shared.ts

@@ -10759,6 +10759,7 @@ export type Price =
   | Price.PackageWithAllocationPrice
   | Price.UnitWithPercentPrice
   | Price.MatrixWithAllocationPrice
+  | Price.TieredMatrixWithAllocationPrice
   | Price.MatrixWithThresholdDiscountsPrice
   | Price.TieredWithProrationPrice
   | Price.UnitWithProrationPrice
@@ -13206,6 +13207,199 @@ export namespace Price {
     }
   }
 
+  export interface TieredMatrixWithAllocationPrice {
+    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<TieredMatrixWithAllocationPrice.CompositePriceFilter> | 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;
+
+    invoice_grouping_key: string | 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: 'tiered_matrix_with_allocation';
+
+    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;
+
+    /**
+     * Configuration for tiered_matrix_with_allocation pricing
+     */
+    tiered_matrix_with_allocation_config: TieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+    dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
+
+    /**
+     * The LicenseType resource represents a type of license that can be assigned to
+     * users. License types are used during billing by grouping metrics on the
+     * configured grouping key.
+     */
+    license_type?: TieredMatrixWithAllocationPrice.LicenseType | null;
+  }
+
+  export namespace TieredMatrixWithAllocationPrice {
+    export interface CompositePriceFilter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+
+    /**
+     * Configuration for tiered_matrix_with_allocation pricing
+     */
+    export interface TieredMatrixWithAllocationConfig {
+      /**
+       * Usage allocation, pooled across all matrix cells
+       */
+      allocation: string;
+
+      /**
+       * Per unit rate for usage whose matrix cell has no configured tiers
+       */
+      default_unit_amount: string;
+
+      /**
+       * One or two event property values to evaluate matrix cells by
+       */
+      dimensions: Array<string>;
+
+      /**
+       * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+       * own rows
+       */
+      tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+    }
+
+    export namespace TieredMatrixWithAllocationConfig {
+      /**
+       * Configuration for a single tier scoped to one matrix cell
+       */
+      export interface Tier {
+        /**
+         * The matrix cell this tier applies to, as one or two dimension values
+         */
+        dimension_values: Array<string>;
+
+        /**
+         * Exclusive tier starting value. The tier runs up to and including the next bound
+         * configured for the same matrix cell.
+         */
+        tier_lower_bound: string;
+
+        /**
+         * Per unit amount
+         */
+        unit_amount: string;
+      }
+    }
+
+    /**
+     * The LicenseType resource represents a type of license that can be assigned to
+     * users. License types are used during billing by grouping metrics on the
+     * configured grouping key.
+     */
+    export interface LicenseType {
+      /**
+       * The Orb-assigned unique identifier for the license type.
+       */
+      id: string;
+
+      /**
+       * The key used for grouping licenses of this type. This is typically a user
+       * identifier field.
+       */
+      grouping_key: string;
+
+      /**
+       * The name of the license type.
+       */
+      name: string;
+    }
+  }
+
   export interface MatrixWithThresholdDiscountsPrice {
     id: string;