orb-billing 2.11.1 → 3.0.0

package/resources/prices/prices.d.ts

@@ -1,5 +1,5 @@
-import * as Core from "../../core.js";
 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";
@@ -19,6 +19,13 @@ export declare class Prices extends APIResource {
      * price model configurations possible in this endpoint.
      */
     create(body: PriceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Price>;
+    /**
+     * This endpoint allows you to update the `metadata` property on a price. If you
+     * 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>;
     /**
      * This endpoint is used to list all add-on prices created using the
      * [price creation endpoint](../reference/create-price).
@@ -308,7 +315,7 @@ export declare namespace Price {
     interface UnitPrice {
         id: string;
         billable_metric: UnitPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: UnitPrice.CreditAllocation | null;
@@ -319,6 +326,13 @@ export declare namespace Price {
         item: UnitPrice.Item;
         maximum: UnitPrice.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: UnitPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'unit';
@@ -371,7 +385,7 @@ export declare namespace Price {
     interface PackagePrice {
         id: string;
         billable_metric: PackagePrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: PackagePrice.CreditAllocation | null;
@@ -382,6 +396,13 @@ export declare namespace Price {
         item: PackagePrice.Item;
         maximum: PackagePrice.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: PackagePrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'package';
@@ -439,7 +460,7 @@ export declare namespace Price {
     interface MatrixPrice {
         id: string;
         billable_metric: MatrixPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: MatrixPrice.CreditAllocation | null;
@@ -451,6 +472,13 @@ export declare namespace Price {
         matrix_config: MatrixPrice.MatrixConfig;
         maximum: MatrixPrice.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: MatrixPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'matrix';
@@ -524,7 +552,7 @@ export declare namespace Price {
     interface TieredPrice {
         id: string;
         billable_metric: TieredPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: TieredPrice.CreditAllocation | null;
@@ -535,6 +563,13 @@ export declare namespace Price {
         item: TieredPrice.Item;
         maximum: TieredPrice.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: TieredPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'tiered';
@@ -603,7 +638,7 @@ export declare namespace Price {
     interface TieredBpsPrice {
         id: string;
         billable_metric: TieredBpsPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: TieredBpsPrice.CreditAllocation | null;
@@ -614,6 +649,13 @@ export declare namespace Price {
         item: TieredBpsPrice.Item;
         maximum: TieredBpsPrice.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: TieredBpsPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'tiered_bps';
@@ -688,7 +730,7 @@ export declare namespace Price {
         id: string;
         billable_metric: BpsPrice.BillableMetric | null;
         bps_config: BpsPrice.BpsConfig;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: BpsPrice.CreditAllocation | null;
@@ -699,6 +741,13 @@ export declare namespace Price {
         item: BpsPrice.Item;
         maximum: BpsPrice.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: BpsPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'bps';
@@ -755,7 +804,7 @@ export declare namespace Price {
         id: string;
         billable_metric: BulkBpsPrice.BillableMetric | null;
         bulk_bps_config: BulkBpsPrice.BulkBpsConfig;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: BulkBpsPrice.CreditAllocation | null;
@@ -766,6 +815,13 @@ export declare namespace Price {
         item: BulkBpsPrice.Item;
         maximum: BulkBpsPrice.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: BulkBpsPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'bulk_bps';
@@ -835,7 +891,7 @@ export declare namespace Price {
         id: string;
         billable_metric: BulkPrice.BillableMetric | null;
         bulk_config: BulkPrice.BulkConfig;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: BulkPrice.CreditAllocation | null;
@@ -846,6 +902,13 @@ export declare namespace Price {
         item: BulkPrice.Item;
         maximum: BulkPrice.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: BulkPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'bulk';
@@ -909,7 +972,7 @@ export declare namespace Price {
     interface ThresholdTotalAmountPrice {
         id: string;
         billable_metric: ThresholdTotalAmountPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: ThresholdTotalAmountPrice.CreditAllocation | null;
@@ -920,6 +983,13 @@ export declare namespace Price {
         item: ThresholdTotalAmountPrice.Item;
         maximum: ThresholdTotalAmountPrice.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: ThresholdTotalAmountPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'threshold_total_amount';
@@ -966,7 +1036,7 @@ export declare namespace Price {
     interface TieredPackagePrice {
         id: string;
         billable_metric: TieredPackagePrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: TieredPackagePrice.CreditAllocation | null;
@@ -977,6 +1047,13 @@ export declare namespace Price {
         item: TieredPackagePrice.Item;
         maximum: TieredPackagePrice.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: TieredPackagePrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'tiered_package';
@@ -1023,7 +1100,7 @@ export declare namespace Price {
     interface GroupedTieredPrice {
         id: string;
         billable_metric: GroupedTieredPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: GroupedTieredPrice.CreditAllocation | null;
@@ -1035,6 +1112,13 @@ export declare namespace Price {
         item: GroupedTieredPrice.Item;
         maximum: GroupedTieredPrice.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: GroupedTieredPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'grouped_tiered';
@@ -1080,7 +1164,7 @@ export declare namespace Price {
     interface TieredWithMinimumPrice {
         id: string;
         billable_metric: TieredWithMinimumPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: TieredWithMinimumPrice.CreditAllocation | null;
@@ -1091,6 +1175,13 @@ export declare namespace Price {
         item: TieredWithMinimumPrice.Item;
         maximum: TieredWithMinimumPrice.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: TieredWithMinimumPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'tiered_with_minimum';
@@ -1137,7 +1228,7 @@ export declare namespace Price {
     interface TieredPackageWithMinimumPrice {
         id: string;
         billable_metric: TieredPackageWithMinimumPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: TieredPackageWithMinimumPrice.CreditAllocation | null;
@@ -1148,6 +1239,13 @@ export declare namespace Price {
         item: TieredPackageWithMinimumPrice.Item;
         maximum: TieredPackageWithMinimumPrice.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: TieredPackageWithMinimumPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'tiered_package_with_minimum';
@@ -1194,7 +1292,7 @@ export declare namespace Price {
     interface PackageWithAllocationPrice {
         id: string;
         billable_metric: PackageWithAllocationPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: PackageWithAllocationPrice.CreditAllocation | null;
@@ -1205,6 +1303,13 @@ export declare namespace Price {
         item: PackageWithAllocationPrice.Item;
         maximum: PackageWithAllocationPrice.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: PackageWithAllocationPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'package_with_allocation';
@@ -1251,7 +1356,7 @@ export declare namespace Price {
     interface UnitWithPercentPrice {
         id: string;
         billable_metric: UnitWithPercentPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: UnitWithPercentPrice.CreditAllocation | null;
@@ -1262,6 +1367,13 @@ export declare namespace Price {
         item: UnitWithPercentPrice.Item;
         maximum: UnitWithPercentPrice.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: UnitWithPercentPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'unit_with_percent';
@@ -1308,7 +1420,7 @@ export declare namespace Price {
     interface MatrixWithAllocationPrice {
         id: string;
         billable_metric: MatrixWithAllocationPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: MatrixWithAllocationPrice.CreditAllocation | null;
@@ -1320,6 +1432,13 @@ export declare namespace Price {
         matrix_with_allocation_config: MatrixWithAllocationPrice.MatrixWithAllocationConfig;
         maximum: MatrixWithAllocationPrice.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: MatrixWithAllocationPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'matrix_with_allocation';
@@ -1397,7 +1516,7 @@ export declare namespace Price {
     interface TieredWithProrationPrice {
         id: string;
         billable_metric: TieredWithProrationPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: TieredWithProrationPrice.CreditAllocation | null;
@@ -1408,6 +1527,13 @@ export declare namespace Price {
         item: TieredWithProrationPrice.Item;
         maximum: TieredWithProrationPrice.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: TieredWithProrationPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'tiered_with_proration';
@@ -1454,7 +1580,7 @@ export declare namespace Price {
     interface UnitWithProrationPrice {
         id: string;
         billable_metric: UnitWithProrationPrice.BillableMetric | null;
-        cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+        cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
         conversion_rate: number | null;
         created_at: string;
         credit_allocation: UnitWithProrationPrice.CreditAllocation | null;
@@ -1465,6 +1591,13 @@ export declare namespace Price {
         item: UnitWithProrationPrice.Item;
         maximum: UnitWithProrationPrice.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: UnitWithProrationPrice.Minimum | null;
         minimum_amount: string | null;
         model_type: 'unit_with_proration';
@@ -1518,7 +1651,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1560,6 +1693,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingUnitPrice {
         interface UnitConfig {
@@ -1573,7 +1712,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1615,6 +1754,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingPackagePrice {
         interface PackageConfig {
@@ -1633,7 +1778,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1675,6 +1820,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingMatrixPrice {
         interface MatrixConfig {
@@ -1710,7 +1861,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1752,6 +1903,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingMatrixWithAllocationPrice {
         interface MatrixWithAllocationConfig {
@@ -1791,7 +1948,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1833,6 +1990,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingTieredPrice {
         interface TieredConfig {
@@ -1862,7 +2025,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1904,6 +2067,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingTieredBpsPrice {
         interface TieredBpsConfig {
@@ -1939,7 +2108,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1980,6 +2149,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingBpsPrice {
         interface BpsConfig {
@@ -1998,7 +2173,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2039,6 +2214,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingBulkBpsPrice {
         interface BulkBpsConfig {
@@ -2070,7 +2251,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2111,6 +2292,12 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     namespace NewFloatingBulkPrice {
         interface BulkConfig {
@@ -2136,7 +2323,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2178,12 +2365,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingTieredPackagePrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2225,12 +2418,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingGroupedTieredPrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2272,12 +2471,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingTieredWithMinimumPrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2319,12 +2524,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingPackageWithAllocationPrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2366,12 +2577,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingTieredPackageWithMinimumPrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2413,12 +2630,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingUnitWithPercentPrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2460,12 +2683,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingTieredWithProrationPrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2507,12 +2736,18 @@ export declare namespace PriceCreateParams {
          * 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;
     }
     interface NewFloatingUnitWithProrationPrice {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2554,8 +2789,22 @@ export declare namespace PriceCreateParams {
          * 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 {
+    /**
+     * 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 PriceListParams extends PageParams {
 }
 export interface PriceEvaluateParams {
@@ -2594,8 +2843,10 @@ export declare namespace Prices {
     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;
 }
 //# sourceMappingURL=prices.d.ts.map