orb-billing 5.30.0 → 5.32.0

package/src/resources/plans/plans.ts

@@ -94,14 +94,6 @@ export interface Plan {
     | Shared.PlanPhaseMaximumAdjustment
   >;
 
-  base_plan: Plan.BasePlan | null;
-
-  /**
-   * The parent plan id if the given plan was created by overriding one or more of
-   * the parent's prices
-   */
-  base_plan_id: string | null;
-
   created_at: string;
 
   /**
@@ -190,22 +182,17 @@ export interface Plan {
   trial_config: Plan.TrialConfig;
 
   version: number;
-}
 
-export namespace Plan {
-  export interface BasePlan {
-    id: string | null;
+  base_plan?: Plan.BasePlan | null;
 
-    /**
-     * An optional user-defined ID for this plan resource, used throughout the system
-     * as an alias for this Plan. Use this field to identify a plan by an existing
-     * identifier in your system.
-     */
-    external_plan_id: string | null;
-
-    name: string | null;
-  }
+  /**
+   * The parent plan id if the given plan was created by overriding one or more of
+   * the parent's prices
+   */
+  base_plan_id?: string | null;
+}
 
+export namespace Plan {
   export interface PlanPhase {
     id: string;
 
@@ -250,6 +237,19 @@ export namespace Plan {
 
     trial_period_unit: 'days';
   }
+
+  export interface BasePlan {
+    id: string | null;
+
+    /**
+     * An optional user-defined ID for this plan resource, used throughout the system
+     * as an alias for this Plan. Use this field to identify a plan by an existing
+     * identifier in your system.
+     */
+    external_plan_id: string | null;
+
+    name: string | null;
+  }
 }
 
 export interface PlanCreateParams {
@@ -350,6 +350,7 @@ export namespace PlanCreateParams {
       | Shared.NewPlanScalableMatrixWithUnitPricingPrice
       | Shared.NewPlanScalableMatrixWithTieredPricingPrice
       | Shared.NewPlanCumulativeGroupedBulkPrice
+      | Price.NewPlanCumulativeGroupedAllocationPrice
       | Shared.NewPlanMinimumCompositePrice
       | Price.NewPlanPercentCompositePrice
       | Price.NewPlanEventOutputPrice
@@ -766,6 +767,134 @@ export namespace PlanCreateParams {
       }
     }
 
+    export interface NewPlanCumulativeGroupedAllocationPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      cumulative_grouped_allocation_config: NewPlanCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'cumulative_grouped_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * 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;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | 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;
+
+      /**
+       * 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;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewPlanCumulativeGroupedAllocationPrice {
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      export interface CumulativeGroupedAllocationConfig {
+        /**
+         * The overall allocation across all groups
+         */
+        cumulative_allocation: string;
+
+        /**
+         * The allocation per individual group
+         */
+        group_allocation: string;
+
+        /**
+         * The event property used to group usage before applying allocations
+         */
+        grouping_key: string;
+
+        /**
+         * The amount to charge for each unit outside of the allocation
+         */
+        unit_amount: string;
+      }
+    }
+
     export interface NewPlanPercentCompositePrice {
       /**
        * The cadence to bill for this price on.

package/src/resources/prices/prices.ts

@@ -281,6 +281,7 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice
   | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice
   | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice
+  | PriceCreateParams.NewFloatingCumulativeGroupedAllocationPrice
   | PriceCreateParams.NewFloatingMinimumCompositePrice
   | PriceCreateParams.NewFloatingPercentCompositePrice
   | PriceCreateParams.NewFloatingEventOutputPrice;
@@ -3592,6 +3593,127 @@ export declare namespace PriceCreateParams {
     }
   }
 
+  export interface NewFloatingCumulativeGroupedAllocationPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+    /**
+     * Configuration for cumulative_grouped_allocation pricing
+     */
+    cumulative_grouped_allocation_config: NewFloatingCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+
+    /**
+     * 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: 'cumulative_grouped_allocation';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    /**
+     * 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;
+
+    /**
+     * 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 NewFloatingCumulativeGroupedAllocationPrice {
+    /**
+     * Configuration for cumulative_grouped_allocation pricing
+     */
+    export interface CumulativeGroupedAllocationConfig {
+      /**
+       * The overall allocation across all groups
+       */
+      cumulative_allocation: string;
+
+      /**
+       * The allocation per individual group
+       */
+      group_allocation: string;
+
+      /**
+       * The event property used to group usage before applying allocations
+       */
+      grouping_key: string;
+
+      /**
+       * The amount to charge for each unit outside of the allocation
+       */
+      unit_amount: string;
+    }
+  }
+
   export interface NewFloatingMinimumCompositePrice {
     /**
      * The cadence to bill for this price on.
@@ -4055,6 +4177,7 @@ export namespace PriceEvaluateMultipleParams {
       | Shared.NewFloatingScalableMatrixWithUnitPricingPrice
       | Shared.NewFloatingScalableMatrixWithTieredPricingPrice
       | Shared.NewFloatingCumulativeGroupedBulkPrice
+      | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice
       | Shared.NewFloatingMinimumCompositePrice
       | PriceEvaluation.NewFloatingPercentCompositePrice
       | PriceEvaluation.NewFloatingEventOutputPrice
@@ -4331,6 +4454,127 @@ export namespace PriceEvaluateMultipleParams {
       }
     }
 
+    export interface NewFloatingCumulativeGroupedAllocationPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      cumulative_grouped_allocation_config: NewFloatingCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+
+      /**
+       * 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: 'cumulative_grouped_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * 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;
+
+      /**
+       * 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 NewFloatingCumulativeGroupedAllocationPrice {
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      export interface CumulativeGroupedAllocationConfig {
+        /**
+         * The overall allocation across all groups
+         */
+        cumulative_allocation: string;
+
+        /**
+         * The allocation per individual group
+         */
+        group_allocation: string;
+
+        /**
+         * The event property used to group usage before applying allocations
+         */
+        grouping_key: string;
+
+        /**
+         * The amount to charge for each unit outside of the allocation
+         */
+        unit_amount: string;
+      }
+    }
+
     export interface NewFloatingPercentCompositePrice {
       /**
        * The cadence to bill for this price on.
@@ -4673,6 +4917,7 @@ export namespace PriceEvaluatePreviewEventsParams {
       | Shared.NewFloatingScalableMatrixWithUnitPricingPrice
       | Shared.NewFloatingScalableMatrixWithTieredPricingPrice
       | Shared.NewFloatingCumulativeGroupedBulkPrice
+      | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice
       | Shared.NewFloatingMinimumCompositePrice
       | PriceEvaluation.NewFloatingPercentCompositePrice
       | PriceEvaluation.NewFloatingEventOutputPrice
@@ -4949,6 +5194,127 @@ export namespace PriceEvaluatePreviewEventsParams {
       }
     }
 
+    export interface NewFloatingCumulativeGroupedAllocationPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      cumulative_grouped_allocation_config: NewFloatingCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+
+      /**
+       * 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: 'cumulative_grouped_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * 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;
+
+      /**
+       * 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 NewFloatingCumulativeGroupedAllocationPrice {
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      export interface CumulativeGroupedAllocationConfig {
+        /**
+         * The overall allocation across all groups
+         */
+        cumulative_allocation: string;
+
+        /**
+         * The allocation per individual group
+         */
+        group_allocation: string;
+
+        /**
+         * The event property used to group usage before applying allocations
+         */
+        grouping_key: string;
+
+        /**
+         * The amount to charge for each unit outside of the allocation
+         */
+        unit_amount: string;
+      }
+    }
+
     export interface NewFloatingPercentCompositePrice {
       /**
        * The cadence to bill for this price on.