orb-billing 4.33.0 → 4.47.2

package/resources/prices/index.d.ts

@@ -1,3 +1,3 @@
-export { EvaluatePriceGroup, Price, PriceEvaluateResponse, PriceCreateParams, PriceUpdateParams, PriceListParams, PriceEvaluateParams, PricesPage, Prices, } from "./prices.js";
-export { ExternalPriceIDUpdateParams, ExternalPriceID } from "./external-price-id.js";
+export { ExternalPriceID, type ExternalPriceIDUpdateParams } from "./external-price-id.js";
+export { PricesPage, Prices, type EvaluatePriceGroup, type Price, type PriceEvaluateResponse, type PriceCreateParams, type PriceUpdateParams, type PriceListParams, type PriceEvaluateParams, } from "./prices.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/prices/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/prices/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,kBAAkB,EAClB,KAAK,EACL,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,UAAU,EACV,MAAM,GACP,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,2BAA2B,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/prices/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,KAAK,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EACL,UAAU,EACV,MAAM,EACN,KAAK,kBAAkB,EACvB,KAAK,KAAK,EACV,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,mBAAmB,GACzB,MAAM,UAAU,CAAC"}

package/resources/prices/index.js

@@ -1,10 +1,10 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExternalPriceID = exports.Prices = exports.PricesPage = void 0;
+exports.Prices = exports.PricesPage = exports.ExternalPriceID = void 0;
+var external_price_id_1 = require("./external-price-id.js");
+Object.defineProperty(exports, "ExternalPriceID", { enumerable: true, get: function () { return external_price_id_1.ExternalPriceID; } });
 var prices_1 = require("./prices.js");
 Object.defineProperty(exports, "PricesPage", { enumerable: true, get: function () { return prices_1.PricesPage; } });
 Object.defineProperty(exports, "Prices", { enumerable: true, get: function () { return prices_1.Prices; } });
-var external_price_id_1 = require("./external-price-id.js");
-Object.defineProperty(exports, "ExternalPriceID", { enumerable: true, get: function () { return external_price_id_1.ExternalPriceID; } });
 //# sourceMappingURL=index.js.map

package/resources/prices/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/prices/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAUkB;AAFhB,oGAAA,UAAU,OAAA;AACV,gGAAA,MAAM,OAAA;AAER,4DAAmF;AAA7C,oHAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/prices/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAAwF;AAA/E,oHAAA,eAAe,OAAA;AACxB,sCAUkB;AAThB,oGAAA,UAAU,OAAA;AACV,gGAAA,MAAM,OAAA"}

package/resources/prices/index.mjs

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export { PricesPage, Prices, } from "./prices.mjs";
 export { ExternalPriceID } from "./external-price-id.mjs";
+export { PricesPage, Prices, } from "./prices.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/prices/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/prices/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAQL,UAAU,EACV,MAAM,GACP;OACM,EAA+B,eAAe,EAAE"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/prices/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,eAAe,EAAoC;OACrD,EACL,UAAU,EACV,MAAM,GAQP"}

package/resources/prices/prices.d.ts

@@ -1,8 +1,8 @@
 import { APIResource } from "../../resource.js";
 import * as Core from "../../core.js";
-import * as PricesAPI from "./prices.js";
 import * as Shared from "../shared.js";
 import * as ExternalPriceIDAPI from "./external-price-id.js";
+import { ExternalPriceID, ExternalPriceIDUpdateParams } from "./external-price-id.js";
 import { Page, type PageParams } from "../../pagination.js";
 export declare class Prices extends APIResource {
     externalPriceId: ExternalPriceIDAPI.ExternalPriceID;
@@ -309,7 +309,7 @@ export interface EvaluatePriceGroup {
  * }
  * ```
  */
-export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.TieredBpsPrice | Price.BpsPrice | Price.BulkBpsPrice | Price.BulkPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.GroupedTieredPrice | Price.TieredWithMinimumPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.BulkWithProrationPrice;
+export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.TieredBpsPrice | Price.BpsPrice | Price.BulkBpsPrice | Price.BulkPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.GroupedTieredPrice | Price.TieredWithMinimumPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.MatrixWithDisplayNamePrice | Price.BulkWithProrationPrice | Price.GroupedTieredPackagePrice;
 export declare namespace Price {
     interface UnitPrice {
         id: string;
@@ -2042,6 +2042,80 @@ export declare namespace Price {
             minimum_amount: string;
         }
     }
+    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';
+    }
+    namespace MatrixWithDisplayNamePrice {
+        interface BillableMetric {
+            id: string;
+        }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
+        interface CreditAllocation {
+            allows_rollover: boolean;
+            currency: string;
+        }
+        interface InvoicingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
+        interface Item {
+            id: string;
+            name: string;
+        }
+        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;
+        }
+        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;
+        }
+    }
     interface BulkWithProrationPrice {
         id: string;
         billable_metric: BulkWithProrationPrice.BillableMetric | null;
@@ -2116,11 +2190,85 @@ export declare namespace Price {
             minimum_amount: string;
         }
     }
+    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';
+    }
+    namespace GroupedTieredPackagePrice {
+        interface BillableMetric {
+            id: string;
+        }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
+        interface CreditAllocation {
+            allows_rollover: boolean;
+            currency: string;
+        }
+        interface InvoicingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
+        interface Item {
+            id: string;
+            name: string;
+        }
+        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;
+        }
+        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 {
     data: Array<EvaluatePriceGroup>;
 }
-export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingTieredBpsPrice | PriceCreateParams.NewFloatingBpsPrice | PriceCreateParams.NewFloatingBulkBpsPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice;
+export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingTieredBpsPrice | PriceCreateParams.NewFloatingBpsPrice | PriceCreateParams.NewFloatingBulkBpsPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice;
 export declare namespace PriceCreateParams {
     interface NewFloatingUnitPrice {
         /**
@@ -4252,6 +4400,99 @@ export declare namespace PriceCreateParams {
             duration_unit: 'day' | 'month';
         }
     }
+    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;
+    }
+    namespace NewFloatingMatrixWithDisplayNamePrice {
+        /**
+         * For custom cadence: specifies the duration of the billing period in days or
+         * months.
+         */
+        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.
+         */
+        interface InvoicingCycleConfiguration {
+            /**
+             * The duration of the billing period.
+             */
+            duration: number;
+            /**
+             * The unit of billing period duration.
+             */
+            duration_unit: 'day' | 'month';
+        }
+    }
     interface NewFloatingBulkWithProrationPrice {
         bulk_with_proration_config: Record<string, unknown>;
         /**
@@ -4345,6 +4586,99 @@ export declare namespace PriceCreateParams {
             duration_unit: 'day' | 'month';
         }
     }
+    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;
+    }
+    namespace NewFloatingGroupedTieredPackagePrice {
+        /**
+         * For custom cadence: specifies the duration of the billing period in days or
+         * months.
+         */
+        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.
+         */
+        interface InvoicingCycleConfiguration {
+            /**
+             * The duration of the billing period.
+             */
+            duration: number;
+            /**
+             * The unit of billing period duration.
+             */
+            duration_unit: 'day' | 'month';
+        }
+    }
 }
 export interface PriceUpdateParams {
     /**
@@ -4387,15 +4721,7 @@ export interface PriceEvaluateParams {
     grouping_keys?: Array<string>;
 }
 export declare 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;
+    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, };
 }
 //# sourceMappingURL=prices.d.ts.map