orb-billing 4.32.0 → 4.47.1

package/src/resources/prices/prices.ts

@@ -3,9 +3,9 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import * as PricesAPI from './prices';
 import * as Shared from '../shared';
 import * as ExternalPriceIDAPI from './external-price-id';
+import { ExternalPriceID, ExternalPriceIDUpdateParams } from './external-price-id';
 import { Page, type PageParams } from '../../pagination';
 
 export class Prices extends APIResource {
@@ -32,16 +32,7 @@ export class Prices extends APIResource {
    * pass null for the metadata value, it will clear any existing metadata for that
    * price.
    */
-  update(priceId: string, body?: PriceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Price>;
-  update(priceId: string, options?: Core.RequestOptions): Core.APIPromise<Price>;
-  update(
-    priceId: string,
-    body: PriceUpdateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Price> {
-    if (isRequestOptions(body)) {
-      return this.update(priceId, {}, body);
-    }
+  update(priceId: string, body: PriceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Price> {
     return this._client.put(`/prices/${priceId}`, { body, ...options });
   }
 
@@ -374,7 +365,9 @@ export type Price =
   | Price.GroupedAllocationPrice
   | Price.GroupedWithProratedMinimumPrice
   | Price.GroupedWithMeteredMinimumPrice
-  | Price.BulkWithProrationPrice;
+  | Price.MatrixWithDisplayNamePrice
+  | Price.BulkWithProrationPrice
+  | Price.GroupedTieredPackagePrice;
 
 export namespace Price {
   export interface UnitPrice {
@@ -2896,6 +2889,116 @@ export namespace Price {
     }
   }
 
+  export interface MatrixWithDisplayNamePrice {
+    id: string;
+
+    billable_metric: MatrixWithDisplayNamePrice.BillableMetric | null;
+
+    billing_cycle_configuration: MatrixWithDisplayNamePrice.BillingCycleConfiguration;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+    conversion_rate: number | null;
+
+    created_at: string;
+
+    credit_allocation: MatrixWithDisplayNamePrice.CreditAllocation | null;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    invoicing_cycle_configuration: MatrixWithDisplayNamePrice.InvoicingCycleConfiguration | null;
+
+    item: MatrixWithDisplayNamePrice.Item;
+
+    matrix_with_display_name_config: Record<string, unknown>;
+
+    maximum: MatrixWithDisplayNamePrice.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: MatrixWithDisplayNamePrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'matrix_with_display_name';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+  }
+
+  export namespace MatrixWithDisplayNamePrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface BillingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    export interface CreditAllocation {
+      allows_rollover: boolean;
+
+      currency: string;
+    }
+
+    export interface InvoicingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    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 BulkWithProrationPrice {
     id: string;
 
@@ -3005,6 +3108,116 @@ export namespace Price {
       minimum_amount: string;
     }
   }
+
+  export interface GroupedTieredPackagePrice {
+    id: string;
+
+    billable_metric: GroupedTieredPackagePrice.BillableMetric | null;
+
+    billing_cycle_configuration: GroupedTieredPackagePrice.BillingCycleConfiguration;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+    conversion_rate: number | null;
+
+    created_at: string;
+
+    credit_allocation: GroupedTieredPackagePrice.CreditAllocation | null;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    grouped_tiered_package_config: Record<string, unknown>;
+
+    invoicing_cycle_configuration: GroupedTieredPackagePrice.InvoicingCycleConfiguration | null;
+
+    item: GroupedTieredPackagePrice.Item;
+
+    maximum: GroupedTieredPackagePrice.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: GroupedTieredPackagePrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'grouped_tiered_package';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+  }
+
+  export namespace GroupedTieredPackagePrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface BillingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    export interface CreditAllocation {
+      allows_rollover: boolean;
+
+      currency: string;
+    }
+
+    export interface InvoicingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    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 {
@@ -3033,7 +3246,9 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingGroupedAllocationPrice
   | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice
   | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice
-  | PriceCreateParams.NewFloatingBulkWithProrationPrice;
+  | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice
+  | PriceCreateParams.NewFloatingBulkWithProrationPrice
+  | PriceCreateParams.NewFloatingGroupedTieredPackagePrice;
 
 export namespace PriceCreateParams {
   export interface NewFloatingUnitPrice {
@@ -5597,6 +5812,118 @@ export namespace PriceCreateParams {
     }
   }
 
+  export interface NewFloatingMatrixWithDisplayNamePrice {
+    /**
+     * 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 plan will be associated with.
+     */
+    item_id: string;
+
+    matrix_with_display_name_config: Record<string, unknown>;
+
+    model_type: 'matrix_with_display_name';
+
+    /**
+     * 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?: PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice.BillingCycleConfiguration | 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;
+
+    /**
+     * 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?: PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice.InvoicingCycleConfiguration | 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 namespace NewFloatingMatrixWithDisplayNamePrice {
+    /**
+     * For custom cadence: specifies the duration of the billing period in days or
+     * months.
+     */
+    export interface BillingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+
+    /**
+     * Within each billing cycle, specifies the cadence at which invoices are produced.
+     * If unspecified, a single invoice is produced per billing cycle.
+     */
+    export interface InvoicingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+  }
+
   export interface NewFloatingBulkWithProrationPrice {
     bulk_with_proration_config: Record<string, unknown>;
 
@@ -5708,6 +6035,118 @@ export namespace PriceCreateParams {
       duration_unit: 'day' | 'month';
     }
   }
+
+  export interface NewFloatingGroupedTieredPackagePrice {
+    /**
+     * 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_tiered_package_config: Record<string, unknown>;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'grouped_tiered_package';
+
+    /**
+     * 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?: PriceCreateParams.NewFloatingGroupedTieredPackagePrice.BillingCycleConfiguration | 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;
+
+    /**
+     * 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?: PriceCreateParams.NewFloatingGroupedTieredPackagePrice.InvoicingCycleConfiguration | 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 namespace NewFloatingGroupedTieredPackagePrice {
+    /**
+     * For custom cadence: specifies the duration of the billing period in days or
+     * months.
+     */
+    export interface BillingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+
+    /**
+     * Within each billing cycle, specifies the cadence at which invoices are produced.
+     * If unspecified, a single invoice is produced per billing cycle.
+     */
+    export interface InvoicingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+  }
 }
 
 export interface PriceUpdateParams {
@@ -5757,15 +6196,23 @@ export interface PriceEvaluateParams {
   grouping_keys?: Array<string>;
 }
 
-export namespace Prices {
-  export import EvaluatePriceGroup = PricesAPI.EvaluatePriceGroup;
-  export import Price = PricesAPI.Price;
-  export import PriceEvaluateResponse = PricesAPI.PriceEvaluateResponse;
-  export import PricesPage = PricesAPI.PricesPage;
-  export import PriceCreateParams = PricesAPI.PriceCreateParams;
-  export import PriceUpdateParams = PricesAPI.PriceUpdateParams;
-  export import PriceListParams = PricesAPI.PriceListParams;
-  export import PriceEvaluateParams = PricesAPI.PriceEvaluateParams;
-  export import ExternalPriceID = ExternalPriceIDAPI.ExternalPriceID;
-  export import ExternalPriceIDUpdateParams = ExternalPriceIDAPI.ExternalPriceIDUpdateParams;
+Prices.PricesPage = PricesPage;
+Prices.ExternalPriceID = ExternalPriceID;
+
+export declare namespace Prices {
+  export {
+    type EvaluatePriceGroup as EvaluatePriceGroup,
+    type Price as Price,
+    type PriceEvaluateResponse as PriceEvaluateResponse,
+    PricesPage as PricesPage,
+    type PriceCreateParams as PriceCreateParams,
+    type PriceUpdateParams as PriceUpdateParams,
+    type PriceListParams as PriceListParams,
+    type PriceEvaluateParams as PriceEvaluateParams,
+  };
+
+  export {
+    ExternalPriceID as ExternalPriceID,
+    type ExternalPriceIDUpdateParams as ExternalPriceIDUpdateParams,
+  };
 }