orb-billing 4.50.0 → 4.51.0

package/resources/subscriptions.d.ts

@@ -6524,7 +6524,7 @@ export declare namespace SubscriptionCreateParams {
     }
     interface AddPrice {
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
          * discounts for this price.
          */
         discounts?: Array<AddPrice.Discount> | null;
@@ -6539,13 +6539,13 @@ export declare namespace SubscriptionCreateParams {
          */
         external_price_id?: string | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * maximum amount for this price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
+         * amount for this price.
          */
         maximum_amount?: string | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * minimum amount for this price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
+         * amount for this price.
          */
         minimum_amount?: string | null;
         /**
@@ -8636,7 +8636,7 @@ export declare namespace SubscriptionCreateParams {
          */
         replaces_price_id: string;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
          * discounts for the replacement price.
          */
         discounts?: Array<ReplacePrice.Discount> | null;
@@ -8649,13 +8649,13 @@ export declare namespace SubscriptionCreateParams {
          */
         fixed_price_quantity?: number | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * maximum amount for the replacement price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
+         * amount for the replacement price.
          */
         maximum_amount?: string | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * minimum amount for the replacement price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
+         * amount for the replacement price.
          */
         minimum_amount?: string | null;
         /**
@@ -10787,7 +10787,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
         /**
          * The definition of a new price to create and add to the subscription.
          */
-        price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | null;
+        price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingMaxGroupTieredPrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -12143,6 +12143,99 @@ export declare namespace SubscriptionPriceIntervalsParams {
                 duration_unit: 'day' | 'month';
             }
         }
+        interface NewFloatingMaxGroupTieredPrice {
+            /**
+             * 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;
+            max_group_tiered_config: Record<string, unknown>;
+            model_type: 'max_group_tiered';
+            /**
+             * 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?: NewFloatingMaxGroupTieredPrice.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?: NewFloatingMaxGroupTieredPrice.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;
+        }
+        namespace NewFloatingMaxGroupTieredPrice {
+            /**
+             * For custom cadence: specifies the duration of the billing period in days or
+             * months.
+             */
+            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.
+             */
+            interface InvoicingCycleConfiguration {
+                /**
+                 * The duration of the billing period.
+                 */
+                duration: number;
+                /**
+                 * The unit of billing period duration.
+                 */
+                duration_unit: 'day' | 'month';
+            }
+        }
         interface NewFloatingTieredWithMinimumPrice {
             /**
              * The cadence to bill for this price on.
@@ -13436,7 +13529,8 @@ export interface SubscriptionSchedulePlanChangeParams {
     billing_cycle_anchor_configuration?: SubscriptionSchedulePlanChangeParams.BillingCycleAnchorConfiguration | null;
     /**
      * The date that the plan change should take effect. This parameter can only be
-     * passed if the `change_option` is `requested_date`.
+     * passed if the `change_option` is `requested_date`. If a date with no time is
+     * passed, the plan change will happen at midnight in the customer's timezone.
      */
     change_date?: string | null;
     /**
@@ -13618,7 +13712,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
     }
     interface AddPrice {
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
          * discounts for this price.
          */
         discounts?: Array<AddPrice.Discount> | null;
@@ -13633,13 +13727,13 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
          */
         external_price_id?: string | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * maximum amount for this price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
+         * amount for this price.
          */
         maximum_amount?: string | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * minimum amount for this price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
+         * amount for this price.
          */
         minimum_amount?: string | null;
         /**
@@ -15730,7 +15824,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
          */
         replaces_price_id: string;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
          * discounts for the replacement price.
          */
         discounts?: Array<ReplacePrice.Discount> | null;
@@ -15743,13 +15837,13 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
          */
         fixed_price_quantity?: number | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * maximum amount for the replacement price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
+         * amount for the replacement price.
          */
         maximum_amount?: string | null;
         /**
-         * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
-         * minimum amount for the replacement price.
+         * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
+         * amount for the replacement price.
          */
         minimum_amount?: string | null;
         /**