orb-billing 4.33.0 → 4.47.1

package/src/resources/plans/plans.ts

@@ -3,9 +3,9 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import * as PlansAPI from './plans';
 import * as Shared from '../shared';
 import * as ExternalPlanIDAPI from './external-plan-id';
+import { ExternalPlanID, ExternalPlanIDUpdateParams } from './external-plan-id';
 import * as PricesAPI from '../prices/prices';
 import { Page, type PageParams } from '../../pagination';
 
@@ -83,6 +83,18 @@ export class PlansPage extends Page<Plan> {}
 export interface Plan {
   id: string;
 
+  /**
+   * Adjustments for this plan. If the plan has phases, this includes adjustments
+   * across all phases of the plan.
+   */
+  adjustments: Array<
+    | Plan.AmountDiscountAdjustment
+    | Plan.PercentageDiscountAdjustment
+    | Plan.UsageDiscountAdjustment
+    | Plan.MinimumAdjustment
+    | Plan.MaximumAdjustment
+  >;
+
   base_plan: Plan.BasePlan | null;
 
   /**
@@ -167,6 +179,176 @@ export interface Plan {
 }
 
 export namespace Plan {
+  export interface AmountDiscountAdjustment {
+    id: string;
+
+    adjustment_type: 'amount_discount';
+
+    /**
+     * The amount by which to discount the prices this adjustment applies to in a given
+     * billing period.
+     */
+    amount_discount: string;
+
+    /**
+     * The price IDs that this adjustment applies to.
+     */
+    applies_to_price_ids: Array<string>;
+
+    /**
+     * True for adjustments that apply to an entire invocice, false for adjustments
+     * that apply to only one price.
+     */
+    is_invoice_level: boolean;
+
+    /**
+     * The plan phase in which this adjustment is active.
+     */
+    plan_phase_order: number | null;
+
+    /**
+     * The reason for the adjustment.
+     */
+    reason: string | null;
+  }
+
+  export interface PercentageDiscountAdjustment {
+    id: string;
+
+    adjustment_type: 'percentage_discount';
+
+    /**
+     * The price IDs that this adjustment applies to.
+     */
+    applies_to_price_ids: Array<string>;
+
+    /**
+     * True for adjustments that apply to an entire invocice, false for adjustments
+     * that apply to only one price.
+     */
+    is_invoice_level: boolean;
+
+    /**
+     * The percentage (as a value between 0 and 1) by which to discount the price
+     * intervals this adjustment applies to in a given billing period.
+     */
+    percentage_discount: number;
+
+    /**
+     * The plan phase in which this adjustment is active.
+     */
+    plan_phase_order: number | null;
+
+    /**
+     * The reason for the adjustment.
+     */
+    reason: string | null;
+  }
+
+  export interface UsageDiscountAdjustment {
+    id: string;
+
+    adjustment_type: 'usage_discount';
+
+    /**
+     * The price IDs that this adjustment applies to.
+     */
+    applies_to_price_ids: Array<string>;
+
+    /**
+     * True for adjustments that apply to an entire invocice, false for adjustments
+     * that apply to only one price.
+     */
+    is_invoice_level: boolean;
+
+    /**
+     * The plan phase in which this adjustment is active.
+     */
+    plan_phase_order: number | null;
+
+    /**
+     * The reason for the adjustment.
+     */
+    reason: string | null;
+
+    /**
+     * The number of usage units by which to discount the price this adjustment applies
+     * to in a given billing period.
+     */
+    usage_discount: number;
+  }
+
+  export interface MinimumAdjustment {
+    id: string;
+
+    adjustment_type: 'minimum';
+
+    /**
+     * The price IDs that this adjustment applies to.
+     */
+    applies_to_price_ids: Array<string>;
+
+    /**
+     * True for adjustments that apply to an entire invocice, false for adjustments
+     * that apply to only one price.
+     */
+    is_invoice_level: boolean;
+
+    /**
+     * The item ID that revenue from this minimum will be attributed to.
+     */
+    item_id: string;
+
+    /**
+     * The minimum amount to charge in a given billing period for the prices this
+     * adjustment applies to.
+     */
+    minimum_amount: string;
+
+    /**
+     * The plan phase in which this adjustment is active.
+     */
+    plan_phase_order: number | null;
+
+    /**
+     * The reason for the adjustment.
+     */
+    reason: string | null;
+  }
+
+  export interface MaximumAdjustment {
+    id: string;
+
+    adjustment_type: 'maximum';
+
+    /**
+     * The price IDs that this adjustment applies to.
+     */
+    applies_to_price_ids: Array<string>;
+
+    /**
+     * True for adjustments that apply to an entire invocice, false for adjustments
+     * that apply to only one price.
+     */
+    is_invoice_level: boolean;
+
+    /**
+     * The maximum amount to charge in a given billing period for the prices this
+     * adjustment applies to.
+     */
+    maximum_amount: string;
+
+    /**
+     * The plan phase in which this adjustment is active.
+     */
+    plan_phase_order: number | null;
+
+    /**
+     * The reason for the adjustment.
+     */
+    reason: string | null;
+  }
+
   export interface BasePlan {
     id: string | null;
 
@@ -312,7 +494,9 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanGroupedAllocationPrice
     | PlanCreateParams.NewPlanGroupedWithProratedMinimumPrice
     | PlanCreateParams.NewPlanGroupedWithMeteredMinimumPrice
+    | PlanCreateParams.NewPlanMatrixWithDisplayNamePrice
     | PlanCreateParams.NewPlanBulkWithProrationPrice
+    | PlanCreateParams.NewPlanGroupedTieredPackagePrice
   >;
 
   /**
@@ -2549,6 +2733,119 @@ export namespace PlanCreateParams {
     }
   }
 
+  export interface NewPlanMatrixWithDisplayNamePrice {
+    /**
+     * 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;
+
+    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?: NewPlanMatrixWithDisplayNamePrice.BillingCycleConfiguration | 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;
+
+    /**
+     * 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?: NewPlanMatrixWithDisplayNamePrice.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;
+  }
+
+  export namespace NewPlanMatrixWithDisplayNamePrice {
+    /**
+     * For custom cadence: specifies the duration of the billing period in days or
+     * months.
+     */
+    export 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.
+     */
+    export interface InvoicingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+  }
+
   export interface NewPlanBulkWithProrationPrice {
     bulk_with_proration_config: Record<string, unknown>;
 
@@ -2661,6 +2958,119 @@ export namespace PlanCreateParams {
       duration_unit: 'day' | 'month';
     }
   }
+
+  export interface NewPlanGroupedTieredPackagePrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+    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?: NewPlanGroupedTieredPackagePrice.BillingCycleConfiguration | 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;
+
+    /**
+     * 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?: NewPlanGroupedTieredPackagePrice.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;
+  }
+
+  export namespace NewPlanGroupedTieredPackagePrice {
+    /**
+     * For custom cadence: specifies the duration of the billing period in days or
+     * months.
+     */
+    export 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.
+     */
+    export interface InvoicingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+  }
 }
 
 export interface PlanUpdateParams {
@@ -2694,12 +3104,17 @@ export interface PlanListParams extends PageParams {
   status?: 'active' | 'archived' | 'draft';
 }
 
-export namespace Plans {
-  export import Plan = PlansAPI.Plan;
-  export import PlansPage = PlansAPI.PlansPage;
-  export import PlanCreateParams = PlansAPI.PlanCreateParams;
-  export import PlanUpdateParams = PlansAPI.PlanUpdateParams;
-  export import PlanListParams = PlansAPI.PlanListParams;
-  export import ExternalPlanID = ExternalPlanIDAPI.ExternalPlanID;
-  export import ExternalPlanIDUpdateParams = ExternalPlanIDAPI.ExternalPlanIDUpdateParams;
+Plans.PlansPage = PlansPage;
+Plans.ExternalPlanID = ExternalPlanID;
+
+export declare namespace Plans {
+  export {
+    type Plan as Plan,
+    PlansPage as PlansPage,
+    type PlanCreateParams as PlanCreateParams,
+    type PlanUpdateParams as PlanUpdateParams,
+    type PlanListParams as PlanListParams,
+  };
+
+  export { ExternalPlanID as ExternalPlanID, type ExternalPlanIDUpdateParams as ExternalPlanIDUpdateParams };
 }

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

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import * as ExternalPriceIDAPI from './external-price-id';
 import * as PricesAPI from './prices';
 
 export class ExternalPriceID extends APIResource {
@@ -38,6 +37,6 @@ export interface ExternalPriceIDUpdateParams {
   metadata?: Record<string, string | null> | null;
 }
 
-export namespace ExternalPriceID {
-  export import ExternalPriceIDUpdateParams = ExternalPriceIDAPI.ExternalPriceIDUpdateParams;
+export declare namespace ExternalPriceID {
+  export { type ExternalPriceIDUpdateParams as ExternalPriceIDUpdateParams };
 }

package/src/resources/prices/index.ts

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { ExternalPriceID, type ExternalPriceIDUpdateParams } from './external-price-id';
 export {
-  EvaluatePriceGroup,
-  Price,
-  PriceEvaluateResponse,
-  PriceCreateParams,
-  PriceUpdateParams,
-  PriceListParams,
-  PriceEvaluateParams,
   PricesPage,
   Prices,
+  type EvaluatePriceGroup,
+  type Price,
+  type PriceEvaluateResponse,
+  type PriceCreateParams,
+  type PriceUpdateParams,
+  type PriceListParams,
+  type PriceEvaluateParams,
 } from './prices';
-export { ExternalPriceIDUpdateParams, ExternalPriceID } from './external-price-id';