orb-billing 4.3.0 → 4.5.0

package/src/resources/metrics.ts

@@ -14,10 +14,32 @@ export class Metrics extends APIResource {
    * [SQL support](../guides/extensibility/advanced-metrics#sql-support) for a
    * description of constructing SQL queries with examples.
    */
-  create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetricCreateResponse> {
+  create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetric> {
     return this._client.post('/metrics', { body, ...options });
   }
 
+  /**
+   * This endpoint allows you to update the `metadata` property on a metric. If you
+   * pass `null` for the metadata value, it will clear any existing metadata for that
+   * invoice.
+   */
+  update(
+    metricId: string,
+    body?: MetricUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BillableMetric>;
+  update(metricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
+  update(
+    metricId: string,
+    body: MetricUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BillableMetric> {
+    if (isRequestOptions(body)) {
+      return this.update(metricId, {}, body);
+    }
+    return this._client.put(`/metrics/${metricId}`, { body, ...options });
+  }
+
   /**
    * This endpoint is used to fetch [metric](../guides/concepts#metric) details given
    * a metric identifier. It returns information about the metrics including its
@@ -26,95 +48,35 @@ export class Metrics extends APIResource {
   list(
     query?: MetricListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<MetricListResponsesPage, MetricListResponse>;
-  list(options?: Core.RequestOptions): Core.PagePromise<MetricListResponsesPage, MetricListResponse>;
+  ): Core.PagePromise<BillableMetricsPage, BillableMetric>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BillableMetricsPage, BillableMetric>;
   list(
     query: MetricListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<MetricListResponsesPage, MetricListResponse> {
+  ): Core.PagePromise<BillableMetricsPage, BillableMetric> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this._client.getAPIList('/metrics', MetricListResponsesPage, { query, ...options });
+    return this._client.getAPIList('/metrics', BillableMetricsPage, { query, ...options });
   }
 
   /**
    * This endpoint is used to list [metrics](../guides/concepts##metric). It returns
    * information about the metrics including its name, description, and item.
    */
-  fetch(metricId: string, options?: Core.RequestOptions): Core.APIPromise<MetricFetchResponse> {
+  fetch(metricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetric> {
     return this._client.get(`/metrics/${metricId}`, options);
   }
 }
 
-export class MetricListResponsesPage extends Page<MetricListResponse> {}
+export class BillableMetricsPage extends Page<BillableMetric> {}
 
 /**
  * The Metric resource represents a calculation of a quantity based on events.
  * Metrics are defined by the query that transforms raw usage events into
  * meaningful values for your customers.
  */
-export interface MetricCreateResponse {
-  id: string;
-
-  description: string | null;
-
-  /**
-   * The Item resource represents a sellable product or good. Items are associated
-   * with all line items, billable metrics, and prices and are used for defining
-   * external sync behavior for invoices and tax calculation purposes.
-   */
-  item: ItemsAPI.Item;
-
-  /**
-   * 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>;
-
-  name: string;
-
-  status: 'active' | 'draft' | 'archived';
-}
-
-/**
- * The Metric resource represents a calculation of a quantity based on events.
- * Metrics are defined by the query that transforms raw usage events into
- * meaningful values for your customers.
- */
-export interface MetricListResponse {
-  id: string;
-
-  description: string | null;
-
-  /**
-   * The Item resource represents a sellable product or good. Items are associated
-   * with all line items, billable metrics, and prices and are used for defining
-   * external sync behavior for invoices and tax calculation purposes.
-   */
-  item: ItemsAPI.Item;
-
-  /**
-   * 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>;
-
-  name: string;
-
-  status: 'active' | 'draft' | 'archived';
-}
-
-/**
- * The Metric resource represents a calculation of a quantity based on events.
- * Metrics are defined by the query that transforms raw usage events into
- * meaningful values for your customers.
- */
-export interface MetricFetchResponse {
+export interface BillableMetric {
   id: string;
 
   description: string | null;
@@ -168,6 +130,15 @@ export interface MetricCreateParams {
   metadata?: Record<string, string | null> | null;
 }
 
+export interface MetricUpdateParams {
+  /**
+   * 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 MetricListParams extends PageParams {
   'created_at[gt]'?: string | null;
 
@@ -179,10 +150,9 @@ export interface MetricListParams extends PageParams {
 }
 
 export namespace Metrics {
-  export import MetricCreateResponse = MetricsAPI.MetricCreateResponse;
-  export import MetricListResponse = MetricsAPI.MetricListResponse;
-  export import MetricFetchResponse = MetricsAPI.MetricFetchResponse;
-  export import MetricListResponsesPage = MetricsAPI.MetricListResponsesPage;
+  export import BillableMetric = MetricsAPI.BillableMetric;
+  export import BillableMetricsPage = MetricsAPI.BillableMetricsPage;
   export import MetricCreateParams = MetricsAPI.MetricCreateParams;
+  export import MetricUpdateParams = MetricsAPI.MetricUpdateParams;
   export import MetricListParams = MetricsAPI.MetricListParams;
 }

package/src/resources/plans/plans.ts

@@ -319,6 +319,7 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanTierWithProrationPrice
     | PlanCreateParams.NewPlanUnitWithProrationPrice
     | PlanCreateParams.NewPlanGroupedAllocationPrice
+    | PlanCreateParams.NewPlanBulkWithProrationPrice
   >;
 
   /**
@@ -1608,6 +1609,73 @@ export namespace PlanCreateParams {
      */
     metadata?: Record<string, string | null> | null;
   }
+
+  export interface NewPlanBulkWithProrationPrice {
+    bulk_with_proration_config: Record<string, unknown>;
+
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'bulk_with_proration';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    /**
+     * The id of the billable metric for the price. Only needed if the price is
+     * usage-based.
+     */
+    billable_metric_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, the price will be billed in-advance if
+     * this is true, and in-arrears if this is false.
+     */
+    billed_in_advance?: boolean | null;
+
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | null;
+
+    /**
+     * An alias for the price.
+     */
+    external_price_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units
+     * applied.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The property used to group this price on an invoice
+     */
+    invoice_grouping_key?: string | null;
+
+    /**
+     * User-specified key/value pairs for the resource. Individual keys can be removed
+     * by setting the value to `null`, and the entire metadata mapping can be cleared
+     * by setting `metadata` to `null`.
+     */
+    metadata?: Record<string, string | null> | null;
+  }
 }
 
 export interface PlanUpdateParams {

package/src/resources/prices/prices.ts

@@ -371,7 +371,8 @@ export type Price =
   | Price.MatrixWithAllocationPrice
   | Price.TieredWithProrationPrice
   | Price.UnitWithProrationPrice
-  | Price.GroupedAllocationPrice;
+  | Price.GroupedAllocationPrice
+  | Price.BulkWithProrationPrice;
 
 export namespace Price {
   export interface UnitPrice {
@@ -2520,6 +2521,108 @@ export namespace Price {
       minimum_amount: string;
     }
   }
+
+  export interface BulkWithProrationPrice {
+    id: string;
+
+    billable_metric: BulkWithProrationPrice.BillableMetric | null;
+
+    billing_cycle_configuration: BulkWithProrationPrice.BillingCycleConfiguration | null;
+
+    bulk_with_proration_config: Record<string, unknown>;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+    conversion_rate: number | null;
+
+    created_at: string;
+
+    credit_allocation: BulkWithProrationPrice.CreditAllocation | null;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    item: BulkWithProrationPrice.Item;
+
+    maximum: BulkWithProrationPrice.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: BulkWithProrationPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'bulk_with_proration';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+  }
+
+  export namespace BulkWithProrationPrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface BillingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    export interface CreditAllocation {
+      allows_rollover: boolean;
+
+      currency: string;
+    }
+
+    export interface Item {
+      id: string;
+
+      name: string;
+    }
+
+    export interface Maximum {
+      /**
+       * List of price_ids that this maximum amount applies to. For plan/plan phase
+       * maximums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Maximum amount applied
+       */
+      maximum_amount: string;
+    }
+
+    export interface Minimum {
+      /**
+       * List of price_ids that this minimum amount applies to. For plan/plan phase
+       * minimums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Minimum amount applied
+       */
+      minimum_amount: string;
+    }
+  }
 }
 
 export interface PriceEvaluateResponse {
@@ -2545,7 +2648,8 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingUnitWithPercentPrice
   | PriceCreateParams.NewFloatingTieredWithProrationPrice
   | PriceCreateParams.NewFloatingUnitWithProrationPrice
-  | PriceCreateParams.NewFloatingGroupedAllocationPrice;
+  | PriceCreateParams.NewFloatingGroupedAllocationPrice
+  | PriceCreateParams.NewFloatingBulkWithProrationPrice;
 
 export namespace PriceCreateParams {
   export interface NewFloatingUnitPrice {
@@ -4028,6 +4132,72 @@ export namespace PriceCreateParams {
      */
     metadata?: Record<string, string | null> | null;
   }
+
+  export interface NewFloatingBulkWithProrationPrice {
+    bulk_with_proration_config: Record<string, unknown>;
+
+    /**
+     * 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;
+
+    model_type: 'bulk_with_proration';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    /**
+     * The id of the billable metric for the price. Only needed if the price is
+     * usage-based.
+     */
+    billable_metric_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, the price will be billed in-advance if
+     * this is true, and in-arrears if this is false.
+     */
+    billed_in_advance?: boolean | null;
+
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An alias for the price.
+     */
+    external_price_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units
+     * applied.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The property used to group this price on an invoice
+     */
+    invoice_grouping_key?: string | null;
+
+    /**
+     * User-specified key/value pairs for the resource. Individual keys can be removed
+     * by setting the value to `null`, and the entire metadata mapping can be cleared
+     * by setting `metadata` to `null`.
+     */
+    metadata?: Record<string, string | null> | null;
+  }
 }
 
 export interface PriceUpdateParams {

package/src/resources/subscriptions.ts

@@ -3672,6 +3672,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Add.NewFloatingTieredWithProrationPrice
       | Add.NewFloatingUnitWithProrationPrice
       | Add.NewFloatingGroupedAllocationPrice
+      | Add.NewFloatingBulkWithProrationPrice
       | null;
 
     /**
@@ -5229,6 +5230,72 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       metadata?: Record<string, string | null> | null;
     }
+
+    export interface NewFloatingBulkWithProrationPrice {
+      bulk_with_proration_config: Record<string, unknown>;
+
+      /**
+       * 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;
+
+      model_type: 'bulk_with_proration';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * User-specified key/value pairs for the resource. Individual keys can be removed
+       * by setting the value to `null`, and the entire metadata mapping can be cleared
+       * by setting `metadata` to `null`.
+       */
+      metadata?: Record<string, string | null> | null;
+    }
   }
 
   export interface AddAdjustment {

package/src/version.ts

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

package/version.d.ts

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

package/version.js

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

package/version.mjs

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