orb-billing 1.34.2 → 1.35.0

package/src/resources/beta/price.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as PriceAPI from "./price";
+
+export class Price extends APIResource {
+  /**
+   * This endpoint is used to evaluate the output of a price for a given customer and
+   * time range. It enables filtering and grouping the output using
+   * [computed properties](../guides/extensibility/advanced-metrics#computed-properties),
+   * supporting the following workflows:
+   *
+   * 1. Showing detailed usage and costs to the end customer.
+   * 2. Auditing subtotals on invoice line items.
+   *
+   * For these workflows, the expressiveness of computed properties in both the
+   * filters and grouping is critical. For example, if you'd like to show your
+   * customer their usage grouped by hour and another property, you can do so with
+   * the following `grouping_keys`:
+   * `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd
+   * like to examine a customer's usage for a specific property value, you can do so
+   * with the following `filter`:
+   * `my_property = 'foo' AND my_other_property = 'bar'`.
+   *
+   * By default, the start of the time range must be no more than 100 days ago and
+   * the length of the results must be no greater than 1000. Note that this is a POST
+   * endpoint rather than a GET endpoint because it employs a JSON body rather than
+   * query parameters.
+   */
+  evaluate(
+    priceId: string,
+    body: PriceEvaluateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PriceEvaluateResponse> {
+    return this._client.post(`/prices/${priceId}/evaluate`, { body, ...options });
+  }
+}
+
+export interface EvaluatePriceGroup {
+  /**
+   * The price's output for the group
+   */
+  amount: string;
+
+  /**
+   * The values for the group in the order specified by `grouping_keys`
+   */
+  grouping_values: Array<string | number | boolean>;
+
+  /**
+   * The price's usage quantity for the group
+   */
+  quantity: number;
+}
+
+export interface PriceEvaluateResponse {
+  data: Array<EvaluatePriceGroup>;
+}
+
+export interface PriceEvaluateParams {
+  /**
+   * The exclusive upper bound for event timestamps
+   */
+  timeframe_end: string;
+
+  /**
+   * The inclusive lower bound for event timestamps
+   */
+  timeframe_start: string;
+
+  /**
+   * The ID of the customer to which this evaluation is scoped.
+   */
+  customer_id?: string | null;
+
+  /**
+   * The external customer ID of the customer to which this evaluation is scoped.
+   */
+  external_customer_id?: string | null;
+
+  /**
+   * A boolean
+   * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
+   * used to filter the underlying billable metric
+   */
+  filter?: string | null;
+
+  /**
+   * Properties (or
+   * [computed properties](../guides/extensibility/advanced-metrics#computed-properties))
+   * used to group the underlying billable metric
+   */
+  grouping_keys?: Array<string>;
+}
+
+export namespace Price {
+  export import EvaluatePriceGroup = PriceAPI.EvaluatePriceGroup;
+  export import PriceEvaluateResponse = PriceAPI.PriceEvaluateResponse;
+  export import PriceEvaluateParams = PriceAPI.PriceEvaluateParams;
+}

package/src/resources/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless.
 
 export * from './shared';
+export { Beta } from './beta/beta';
 export { Coupon, CouponCreateParams, CouponListParams, CouponsPage, Coupons } from './coupons/coupons';
 export { CreditNote, CreditNoteListParams, CreditNotesPage, CreditNotes } from './credit-notes';
 export {

package/src/resources/prices/prices.ts

@@ -295,8 +295,6 @@ export type Price =
   | Price.BpsPrice
   | Price.BulkBpsPrice
   | Price.BulkPrice
-  | Price.TestRatingFunctionPrice
-  | Price.FivetranExamplePrice
   | Price.ThresholdTotalAmountPrice
   | Price.TieredPackagePrice
   | Price.TieredWithMinimumPrice
@@ -1098,158 +1096,6 @@ export namespace Price {
     }
   }
 
-  export interface TestRatingFunctionPrice {
-    id: string;
-
-    billable_metric: TestRatingFunctionPrice.BillableMetric | null;
-
-    cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
-
-    created_at: string;
-
-    currency: string;
-
-    discount: Shared.Discount | null;
-
-    external_price_id: string | null;
-
-    fixed_price_quantity: number | null;
-
-    item: TestRatingFunctionPrice.Item;
-
-    maximum: TestRatingFunctionPrice.Maximum | null;
-
-    maximum_amount: string | null;
-
-    minimum: TestRatingFunctionPrice.Minimum | null;
-
-    minimum_amount: string | null;
-
-    model_type: 'test_rating_function';
-
-    name: string;
-
-    plan_phase_order: number | null;
-
-    price_type: 'usage_price' | 'fixed_price';
-
-    test_rating_function_config: Record<string, unknown>;
-  }
-
-  export namespace TestRatingFunctionPrice {
-    export interface BillableMetric {
-      id: 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 FivetranExamplePrice {
-    id: string;
-
-    billable_metric: FivetranExamplePrice.BillableMetric | null;
-
-    cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
-
-    created_at: string;
-
-    currency: string;
-
-    discount: Shared.Discount | null;
-
-    external_price_id: string | null;
-
-    fivetran_example_config: Record<string, unknown>;
-
-    fixed_price_quantity: number | null;
-
-    item: FivetranExamplePrice.Item;
-
-    maximum: FivetranExamplePrice.Maximum | null;
-
-    maximum_amount: string | null;
-
-    minimum: FivetranExamplePrice.Minimum | null;
-
-    minimum_amount: string | null;
-
-    model_type: 'fivetran_example';
-
-    name: string;
-
-    plan_phase_order: number | null;
-
-    price_type: 'usage_price' | 'fixed_price';
-  }
-
-  export namespace FivetranExamplePrice {
-    export interface BillableMetric {
-      id: 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 ThresholdTotalAmountPrice {
     id: string;
 

package/src/resources/subscriptions.ts

@@ -2121,8 +2121,6 @@ export interface SubscriptionCreateParams {
     | SubscriptionCreateParams.OverrideBpsPrice
     | SubscriptionCreateParams.OverrideBulkBpsPrice
     | SubscriptionCreateParams.OverrideBulkPrice
-    | SubscriptionCreateParams.OverrideTestRatingFunctionPrice
-    | SubscriptionCreateParams.OverrideFivetranExamplePrice
     | SubscriptionCreateParams.OverrideThresholdTotalAmountPrice
     | SubscriptionCreateParams.OverrideTieredPackagePrice
     | SubscriptionCreateParams.OverrideTieredWithMinimumPrice
@@ -2840,136 +2838,6 @@ export namespace SubscriptionCreateParams {
     }
   }
 
-  export interface OverrideTestRatingFunctionPrice {
-    id: string;
-
-    model_type: 'test_rating_function';
-
-    test_rating_function_config: Record<string, unknown>;
-
-    /**
-     * The subscription's override discount for the plan.
-     */
-    discount?: OverrideTestRatingFunctionPrice.Discount | null;
-
-    /**
-     * The starting quantity of the price, if the price is a fixed price.
-     */
-    fixed_price_quantity?: number | null;
-
-    /**
-     * The subscription's override maximum amount for the plan.
-     */
-    maximum_amount?: string | null;
-
-    /**
-     * The subscription's override minimum amount for the plan.
-     */
-    minimum_amount?: string | null;
-  }
-
-  export namespace OverrideTestRatingFunctionPrice {
-    /**
-     * The subscription's override discount for the plan.
-     */
-    export interface Discount {
-      discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
-
-      /**
-       * Only available if discount_type is `amount`.
-       */
-      amount_discount?: string | null;
-
-      /**
-       * List of price_ids that this discount applies to. For plan/plan phase discounts,
-       * this can be a subset of prices.
-       */
-      applies_to_price_ids?: Array<string> | null;
-
-      /**
-       * Only available if discount_type is `percentage`. This is a number between 0
-       * and 1.
-       */
-      percentage_discount?: number | null;
-
-      /**
-       * Only available if discount_type is `trial`
-       */
-      trial_amount_discount?: string | null;
-
-      /**
-       * Only available if discount_type is `usage`. Number of usage units that this
-       * discount is for
-       */
-      usage_discount?: number | null;
-    }
-  }
-
-  export interface OverrideFivetranExamplePrice {
-    id: string;
-
-    fivetran_example_config: Record<string, unknown>;
-
-    model_type: 'fivetran_example';
-
-    /**
-     * The subscription's override discount for the plan.
-     */
-    discount?: OverrideFivetranExamplePrice.Discount | null;
-
-    /**
-     * The starting quantity of the price, if the price is a fixed price.
-     */
-    fixed_price_quantity?: number | null;
-
-    /**
-     * The subscription's override maximum amount for the plan.
-     */
-    maximum_amount?: string | null;
-
-    /**
-     * The subscription's override minimum amount for the plan.
-     */
-    minimum_amount?: string | null;
-  }
-
-  export namespace OverrideFivetranExamplePrice {
-    /**
-     * The subscription's override discount for the plan.
-     */
-    export interface Discount {
-      discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
-
-      /**
-       * Only available if discount_type is `amount`.
-       */
-      amount_discount?: string | null;
-
-      /**
-       * List of price_ids that this discount applies to. For plan/plan phase discounts,
-       * this can be a subset of prices.
-       */
-      applies_to_price_ids?: Array<string> | null;
-
-      /**
-       * Only available if discount_type is `percentage`. This is a number between 0
-       * and 1.
-       */
-      percentage_discount?: number | null;
-
-      /**
-       * Only available if discount_type is `trial`
-       */
-      trial_amount_discount?: string | null;
-
-      /**
-       * Only available if discount_type is `usage`. Number of usage units that this
-       * discount is for
-       */
-      usage_discount?: number | null;
-    }
-  }
-
   export interface OverrideThresholdTotalAmountPrice {
     id: string;
 
@@ -4444,8 +4312,6 @@ export interface SubscriptionSchedulePlanChangeParams {
     | SubscriptionSchedulePlanChangeParams.OverrideBpsPrice
     | SubscriptionSchedulePlanChangeParams.OverrideBulkBpsPrice
     | SubscriptionSchedulePlanChangeParams.OverrideBulkPrice
-    | SubscriptionSchedulePlanChangeParams.OverrideTestRatingFunctionPrice
-    | SubscriptionSchedulePlanChangeParams.OverrideFivetranExamplePrice
     | SubscriptionSchedulePlanChangeParams.OverrideThresholdTotalAmountPrice
     | SubscriptionSchedulePlanChangeParams.OverrideTieredPackagePrice
     | SubscriptionSchedulePlanChangeParams.OverrideTieredWithMinimumPrice
@@ -5161,136 +5027,6 @@ export namespace SubscriptionSchedulePlanChangeParams {
     }
   }
 
-  export interface OverrideTestRatingFunctionPrice {
-    id: string;
-
-    model_type: 'test_rating_function';
-
-    test_rating_function_config: Record<string, unknown>;
-
-    /**
-     * The subscription's override discount for the plan.
-     */
-    discount?: OverrideTestRatingFunctionPrice.Discount | null;
-
-    /**
-     * The starting quantity of the price, if the price is a fixed price.
-     */
-    fixed_price_quantity?: number | null;
-
-    /**
-     * The subscription's override maximum amount for the plan.
-     */
-    maximum_amount?: string | null;
-
-    /**
-     * The subscription's override minimum amount for the plan.
-     */
-    minimum_amount?: string | null;
-  }
-
-  export namespace OverrideTestRatingFunctionPrice {
-    /**
-     * The subscription's override discount for the plan.
-     */
-    export interface Discount {
-      discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
-
-      /**
-       * Only available if discount_type is `amount`.
-       */
-      amount_discount?: string | null;
-
-      /**
-       * List of price_ids that this discount applies to. For plan/plan phase discounts,
-       * this can be a subset of prices.
-       */
-      applies_to_price_ids?: Array<string> | null;
-
-      /**
-       * Only available if discount_type is `percentage`. This is a number between 0
-       * and 1.
-       */
-      percentage_discount?: number | null;
-
-      /**
-       * Only available if discount_type is `trial`
-       */
-      trial_amount_discount?: string | null;
-
-      /**
-       * Only available if discount_type is `usage`. Number of usage units that this
-       * discount is for
-       */
-      usage_discount?: number | null;
-    }
-  }
-
-  export interface OverrideFivetranExamplePrice {
-    id: string;
-
-    fivetran_example_config: Record<string, unknown>;
-
-    model_type: 'fivetran_example';
-
-    /**
-     * The subscription's override discount for the plan.
-     */
-    discount?: OverrideFivetranExamplePrice.Discount | null;
-
-    /**
-     * The starting quantity of the price, if the price is a fixed price.
-     */
-    fixed_price_quantity?: number | null;
-
-    /**
-     * The subscription's override maximum amount for the plan.
-     */
-    maximum_amount?: string | null;
-
-    /**
-     * The subscription's override minimum amount for the plan.
-     */
-    minimum_amount?: string | null;
-  }
-
-  export namespace OverrideFivetranExamplePrice {
-    /**
-     * The subscription's override discount for the plan.
-     */
-    export interface Discount {
-      discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
-
-      /**
-       * Only available if discount_type is `amount`.
-       */
-      amount_discount?: string | null;
-
-      /**
-       * List of price_ids that this discount applies to. For plan/plan phase discounts,
-       * this can be a subset of prices.
-       */
-      applies_to_price_ids?: Array<string> | null;
-
-      /**
-       * Only available if discount_type is `percentage`. This is a number between 0
-       * and 1.
-       */
-      percentage_discount?: number | null;
-
-      /**
-       * Only available if discount_type is `trial`
-       */
-      trial_amount_discount?: string | null;
-
-      /**
-       * Only available if discount_type is `usage`. Number of usage units that this
-       * discount is for
-       */
-      usage_discount?: number | null;
-    }
-  }
-
   export interface OverrideThresholdTotalAmountPrice {
     id: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.34.2'; // x-release-please-version
+export const VERSION = '1.35.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.34.2";
+export declare const VERSION = "1.35.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 = '1.34.2'; // x-release-please-version
+exports.VERSION = '1.35.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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