orb-billing 4.53.0 → 4.55.0

package/src/resources/plans/plans.ts

@@ -88,11 +88,11 @@ export interface Plan {
    * across all phases of the plan.
    */
   adjustments: Array<
-    | Plan.AmountDiscountAdjustment
-    | Plan.PercentageDiscountAdjustment
-    | Plan.UsageDiscountAdjustment
-    | Plan.MinimumAdjustment
-    | Plan.MaximumAdjustment
+    | Plan.PlanPhaseUsageDiscountAdjustment
+    | Plan.PlanPhaseAmountDiscountAdjustment
+    | Plan.PlanPhasePercentageDiscountAdjustment
+    | Plan.PlanPhaseMinimumAdjustment
+    | Plan.PlanPhaseMaximumAdjustment
   >;
 
   base_plan: Plan.BasePlan | null;
@@ -179,16 +179,10 @@ export interface Plan {
 }
 
 export namespace Plan {
-  export interface AmountDiscountAdjustment {
+  export interface PlanPhaseUsageDiscountAdjustment {
     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;
+    adjustment_type: 'usage_discount';
 
     /**
      * The price IDs that this adjustment applies to.
@@ -210,12 +204,24 @@ export namespace Plan {
      * 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 PercentageDiscountAdjustment {
+  export interface PlanPhaseAmountDiscountAdjustment {
     id: string;
 
-    adjustment_type: 'percentage_discount';
+    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.
@@ -228,12 +234,6 @@ export namespace Plan {
      */
     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.
      */
@@ -245,10 +245,10 @@ export namespace Plan {
     reason: string | null;
   }
 
-  export interface UsageDiscountAdjustment {
+  export interface PlanPhasePercentageDiscountAdjustment {
     id: string;
 
-    adjustment_type: 'usage_discount';
+    adjustment_type: 'percentage_discount';
 
     /**
      * The price IDs that this adjustment applies to.
@@ -261,6 +261,12 @@ export namespace Plan {
      */
     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.
      */
@@ -270,15 +276,9 @@ export namespace Plan {
      * 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 {
+  export interface PlanPhaseMinimumAdjustment {
     id: string;
 
     adjustment_type: 'minimum';
@@ -316,7 +316,7 @@ export namespace Plan {
     reason: string | null;
   }
 
-  export interface MaximumAdjustment {
+  export interface PlanPhaseMaximumAdjustment {
     id: string;
 
     adjustment_type: 'maximum';
@@ -498,6 +498,8 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanBulkWithProrationPrice
     | PlanCreateParams.NewPlanGroupedTieredPackagePrice
     | PlanCreateParams.NewPlanMaxGroupTieredPackagePrice
+    | PlanCreateParams.NewPlanScalableMatrixWithUnitPricingPrice
+    | PlanCreateParams.NewPlanScalableMatrixWithTieredPricingPrice
   >;
 
   /**
@@ -3185,6 +3187,232 @@ export namespace PlanCreateParams {
       duration_unit: 'day' | 'month';
     }
   }
+
+  export interface NewPlanScalableMatrixWithUnitPricingPrice {
+    /**
+     * 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: 'scalable_matrix_with_unit_pricing';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    scalable_matrix_with_unit_pricing_config: Record<string, unknown>;
+
+    /**
+     * 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?: NewPlanScalableMatrixWithUnitPricingPrice.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?: NewPlanScalableMatrixWithUnitPricingPrice.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 NewPlanScalableMatrixWithUnitPricingPrice {
+    /**
+     * 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 NewPlanScalableMatrixWithTieredPricingPrice {
+    /**
+     * 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: 'scalable_matrix_with_tiered_pricing';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    scalable_matrix_with_tiered_pricing_config: Record<string, unknown>;
+
+    /**
+     * 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?: NewPlanScalableMatrixWithTieredPricingPrice.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?: NewPlanScalableMatrixWithTieredPricingPrice.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 NewPlanScalableMatrixWithTieredPricingPrice {
+    /**
+     * 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 {