orb-billing 5.44.0 → 5.45.0

package/src/resources/prices/external-price-id.ts

@@ -4,6 +4,15 @@ import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as Shared from '../shared';
 
+/**
+ * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
+ * the form of an invoice line item. Prices take a quantity and determine an amount to bill.
+ *
+ * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
+ * given Price object. The model_type field determines the key for the configuration object that is present.
+ *
+ * For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price)
+ */
 export class ExternalPriceID extends APIResource {
   /**
    * This endpoint allows you to update the `metadata` property on a price. If you

package/src/resources/prices/prices.ts

@@ -10,6 +10,15 @@ import * as ExternalPriceIDAPI from './external-price-id';
 import { ExternalPriceID, ExternalPriceIDUpdateParams } from './external-price-id';
 import { type PageParams } from '../../pagination';
 
+/**
+ * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
+ * the form of an invoice line item. Prices take a quantity and determine an amount to bill.
+ *
+ * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
+ * given Price object. The model_type field determines the key for the configuration object that is present.
+ *
+ * For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price)
+ */
 export class Prices extends APIResource {
   externalPriceId: ExternalPriceIDAPI.ExternalPriceID = new ExternalPriceIDAPI.ExternalPriceID(this._client);
 
@@ -373,6 +382,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -467,6 +481,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -561,6 +580,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -655,6 +679,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -798,6 +827,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -892,6 +926,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -986,6 +1025,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1112,6 +1156,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1237,6 +1286,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1370,6 +1424,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1496,6 +1555,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1618,6 +1682,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1725,6 +1794,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1836,6 +1910,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -1930,6 +2009,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2054,6 +2138,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2160,6 +2249,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2276,6 +2370,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2399,6 +2498,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2515,6 +2619,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2671,6 +2780,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2792,6 +2906,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -2925,6 +3044,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3053,6 +3177,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3180,6 +3309,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3208,6 +3342,11 @@ export declare namespace PriceCreateParams {
        */
       unit_price: string;
 
+      /**
+       * The property used to group this price
+       */
+      grouping_key?: string | null;
+
       /**
        * If true, the unit price will be prorated to the billing period
        */
@@ -3319,6 +3458,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3459,6 +3603,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3589,6 +3738,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3710,6 +3864,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3821,6 +3980,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -3927,6 +4091,11 @@ export declare namespace PriceCreateParams {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+    /**
+     * The ID of the license type to associate with this price.
+     */
+    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
@@ -4006,6 +4175,12 @@ export interface PriceEvaluateParams {
    * to group the underlying billable metric
    */
   grouping_keys?: Array<string>;
+
+  /**
+   * Optional overrides for parameterized billable metric parameters. If the metric
+   * has parameter definitions and no overrides are provided, defaults will be used.
+   */
+  metric_parameter_overrides?: { [key: string]: unknown } | null;
 }
 
 export interface PriceEvaluateMultipleParams {
@@ -4056,6 +4231,12 @@ export namespace PriceEvaluateMultipleParams {
      */
     grouping_keys?: Array<string>;
 
+    /**
+     * Optional overrides for parameterized billable metric parameters. If the metric
+     * has parameter definitions and no overrides are provided, defaults will be used.
+     */
+    metric_parameter_overrides?: { [key: string]: unknown } | null;
+
     /**
      * New floating price request body params.
      */
@@ -4186,6 +4367,11 @@ export namespace PriceEvaluateMultipleParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -4329,6 +4515,11 @@ export namespace PriceEvaluateMultipleParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -4450,6 +4641,11 @@ export namespace PriceEvaluateMultipleParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -4571,6 +4767,11 @@ export namespace PriceEvaluateMultipleParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -4677,6 +4878,11 @@ export namespace PriceEvaluateMultipleParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -4796,6 +5002,12 @@ export namespace PriceEvaluatePreviewEventsParams {
      */
     grouping_keys?: Array<string>;
 
+    /**
+     * Optional overrides for parameterized billable metric parameters. If the metric
+     * has parameter definitions and no overrides are provided, defaults will be used.
+     */
+    metric_parameter_overrides?: { [key: string]: unknown } | null;
+
     /**
      * New floating price request body params.
      */
@@ -4926,6 +5138,11 @@ export namespace PriceEvaluatePreviewEventsParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -5069,6 +5286,11 @@ export namespace PriceEvaluatePreviewEventsParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -5190,6 +5412,11 @@ export namespace PriceEvaluatePreviewEventsParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -5311,6 +5538,11 @@ export namespace PriceEvaluatePreviewEventsParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
@@ -5417,6 +5649,11 @@ export namespace PriceEvaluatePreviewEventsParams {
        */
       invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
 
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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