orb-billing 4.2.0 → 4.3.0

package/src/resources/prices/prices.ts

@@ -370,7 +370,8 @@ export type Price =
   | Price.UnitWithPercentPrice
   | Price.MatrixWithAllocationPrice
   | Price.TieredWithProrationPrice
-  | Price.UnitWithProrationPrice;
+  | Price.UnitWithProrationPrice
+  | Price.GroupedAllocationPrice;
 
 export namespace Price {
   export interface UnitPrice {
@@ -2417,6 +2418,108 @@ export namespace Price {
       minimum_amount: string;
     }
   }
+
+  export interface GroupedAllocationPrice {
+    id: string;
+
+    billable_metric: GroupedAllocationPrice.BillableMetric | null;
+
+    billing_cycle_configuration: GroupedAllocationPrice.BillingCycleConfiguration | null;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+    conversion_rate: number | null;
+
+    created_at: string;
+
+    credit_allocation: GroupedAllocationPrice.CreditAllocation | null;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    grouped_allocation_config: Record<string, unknown>;
+
+    item: GroupedAllocationPrice.Item;
+
+    maximum: GroupedAllocationPrice.Maximum | null;
+
+    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: Record<string, string>;
+
+    minimum: GroupedAllocationPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'grouped_allocation';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+  }
+
+  export namespace GroupedAllocationPrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface BillingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    export interface CreditAllocation {
+      allows_rollover: boolean;
+
+      currency: string;
+    }
+
+    export interface Item {
+      id: string;
+
+      name: string;
+    }
+
+    export interface Maximum {
+      /**
+       * List of price_ids that this maximum amount applies to. For plan/plan phase
+       * maximums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Maximum amount applied
+       */
+      maximum_amount: string;
+    }
+
+    export interface Minimum {
+      /**
+       * List of price_ids that this minimum amount applies to. For plan/plan phase
+       * minimums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Minimum amount applied
+       */
+      minimum_amount: string;
+    }
+  }
 }
 
 export interface PriceEvaluateResponse {
@@ -2441,7 +2544,8 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice
   | PriceCreateParams.NewFloatingUnitWithPercentPrice
   | PriceCreateParams.NewFloatingTieredWithProrationPrice
-  | PriceCreateParams.NewFloatingUnitWithProrationPrice;
+  | PriceCreateParams.NewFloatingUnitWithProrationPrice
+  | PriceCreateParams.NewFloatingGroupedAllocationPrice;
 
 export namespace PriceCreateParams {
   export interface NewFloatingUnitPrice {
@@ -3858,6 +3962,72 @@ export namespace PriceCreateParams {
      */
     metadata?: Record<string, string | null> | null;
   }
+
+  export interface NewFloatingGroupedAllocationPrice {
+    /**
+     * 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;
+
+    grouped_allocation_config: Record<string, unknown>;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: '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;
+
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | 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;
+
+    /**
+     * 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?: Record<string, string | null> | null;
+  }
 }
 
 export interface PriceUpdateParams {

package/src/resources/subscriptions.ts

@@ -3671,6 +3671,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Add.NewFloatingUnitWithPercentPrice
       | Add.NewFloatingTieredWithProrationPrice
       | Add.NewFloatingUnitWithProrationPrice
+      | Add.NewFloatingGroupedAllocationPrice
       | null;
 
     /**
@@ -5162,6 +5163,72 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       metadata?: Record<string, string | null> | null;
     }
+
+    export interface NewFloatingGroupedAllocationPrice {
+      /**
+       * 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;
+
+      grouped_allocation_config: Record<string, unknown>;
+
+      /**
+       * The id of the item the plan will be associated with.
+       */
+      item_id: string;
+
+      model_type: '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;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | 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;
+
+      /**
+       * 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?: Record<string, string | null> | null;
+    }
   }
 
   export interface AddAdjustment {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.2.0'; // x-release-please-version
+export const VERSION = '4.3.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.2.0";
+export declare const VERSION = "4.3.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.2.0'; // x-release-please-version
+exports.VERSION = '4.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.2.0'; // x-release-please-version
+export const VERSION = '4.3.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map