orb-billing 4.21.0 → 4.24.0

package/src/resources/plans/plans.ts

@@ -320,6 +320,7 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanUnitWithProrationPrice
     | PlanCreateParams.NewPlanGroupedAllocationPrice
     | PlanCreateParams.NewPlanGroupedWithProratedMinimumPrice
+    | PlanCreateParams.NewPlanGroupedWithMeteredMinimumPrice
     | PlanCreateParams.NewPlanBulkWithProrationPrice
   >;
 
@@ -2444,6 +2445,119 @@ export namespace PlanCreateParams {
     }
   }
 
+  export interface NewPlanGroupedWithMeteredMinimumPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+    grouped_with_metered_minimum_config: Record<string, unknown>;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'grouped_with_metered_minimum';
+
+    /**
+     * 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?: NewPlanGroupedWithMeteredMinimumPrice.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?: NewPlanGroupedWithMeteredMinimumPrice.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 NewPlanGroupedWithMeteredMinimumPrice {
+    /**
+     * 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>;
 

package/src/resources/prices/prices.ts

@@ -373,6 +373,7 @@ export type Price =
   | Price.UnitWithProrationPrice
   | Price.GroupedAllocationPrice
   | Price.GroupedWithProratedMinimumPrice
+  | Price.GroupedWithMeteredMinimumPrice
   | Price.BulkWithProrationPrice;
 
 export namespace Price {
@@ -2785,6 +2786,116 @@ export namespace Price {
     }
   }
 
+  export interface GroupedWithMeteredMinimumPrice {
+    id: string;
+
+    billable_metric: GroupedWithMeteredMinimumPrice.BillableMetric | null;
+
+    billing_cycle_configuration: GroupedWithMeteredMinimumPrice.BillingCycleConfiguration;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+    conversion_rate: number | null;
+
+    created_at: string;
+
+    credit_allocation: GroupedWithMeteredMinimumPrice.CreditAllocation | null;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    grouped_with_metered_minimum_config: Record<string, unknown>;
+
+    invoicing_cycle_configuration: GroupedWithMeteredMinimumPrice.InvoicingCycleConfiguration | null;
+
+    item: GroupedWithMeteredMinimumPrice.Item;
+
+    maximum: GroupedWithMeteredMinimumPrice.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: GroupedWithMeteredMinimumPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'grouped_with_metered_minimum';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+  }
+
+  export namespace GroupedWithMeteredMinimumPrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface BillingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    export interface CreditAllocation {
+      allows_rollover: boolean;
+
+      currency: string;
+    }
+
+    export interface InvoicingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    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 BulkWithProrationPrice {
     id: string;
 
@@ -2921,6 +3032,7 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingUnitWithProrationPrice
   | PriceCreateParams.NewFloatingGroupedAllocationPrice
   | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice
+  | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice
   | PriceCreateParams.NewFloatingBulkWithProrationPrice;
 
 export namespace PriceCreateParams {
@@ -5373,6 +5485,118 @@ export namespace PriceCreateParams {
     }
   }
 
+  export interface NewFloatingGroupedWithMeteredMinimumPrice {
+    /**
+     * 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;
+
+    grouped_with_metered_minimum_config: Record<string, unknown>;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'grouped_with_metered_minimum';
+
+    /**
+     * 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?: PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice.BillingCycleConfiguration | 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;
+
+    /**
+     * 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?: PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice.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 NewFloatingGroupedWithMeteredMinimumPrice {
+    /**
+     * 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 NewFloatingBulkWithProrationPrice {
     bulk_with_proration_config: Record<string, unknown>;
 

package/src/resources/shared.ts

@@ -1,54 +1,27 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export type BillingCycleRelativeDate = 'start_of_term' | 'end_of_term';
-
-export type Discount =
-  | Discount.PercentageDiscount
-  | Discount.TrialDiscount
-  | Discount.UsageDiscount
-  | Discount.AmountDiscount;
-
-export namespace Discount {
-  export interface PercentageDiscount {
-    /**
-     * 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>;
+export interface AmountDiscount {
+  /**
+   * Only available if discount_type is `amount`.
+   */
+  amount_discount: string;
 
-    discount_type: 'percentage';
+  /**
+   * 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>;
 
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
-    percentage_discount: number;
-
-    reason?: string | null;
-  }
+  discount_type: 'amount';
 
-  export interface TrialDiscount {
-    /**
-     * 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>;
-
-    discount_type: 'trial';
+  reason?: string | null;
+}
 
-    reason?: string | null;
+export type BillingCycleRelativeDate = 'start_of_term' | 'end_of_term';
 
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_amount_discount?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_percentage_discount?: number | null;
-  }
+export type Discount = PercentageDiscount | TrialDiscount | Discount.UsageDiscount | AmountDiscount;
 
+export namespace Discount {
   export interface UsageDiscount {
     /**
      * List of price_ids that this discount applies to. For plan/plan phase discounts,
@@ -66,27 +39,52 @@ export namespace Discount {
 
     reason?: string | null;
   }
+}
 
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
-    amount_discount: string;
+export type InvoiceLevelDiscount = PercentageDiscount | AmountDiscount | TrialDiscount;
 
-    /**
-     * 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>;
+export interface PaginationMetadata {
+  has_more: boolean;
 
-    discount_type: 'amount';
+  next_cursor: string | null;
+}
 
-    reason?: string | null;
-  }
+export interface PercentageDiscount {
+  /**
+   * 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>;
+
+  discount_type: 'percentage';
+
+  /**
+   * Only available if discount_type is `percentage`. This is a number between 0
+   * and 1.
+   */
+  percentage_discount: number;
+
+  reason?: string | null;
 }
 
-export interface PaginationMetadata {
-  has_more: boolean;
+export interface TrialDiscount {
+  /**
+   * 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>;
 
-  next_cursor: string | null;
+  discount_type: 'trial';
+
+  reason?: string | null;
+
+  /**
+   * Only available if discount_type is `trial`
+   */
+  trial_amount_discount?: string | null;
+
+  /**
+   * Only available if discount_type is `trial`
+   */
+  trial_percentage_discount?: number | null;
 }