orb-billing 4.8.0 → 4.11.0

package/resources/subscriptions.d.ts

@@ -414,8 +414,10 @@ export declare class Subscriptions extends APIResource {
      * recently created subscription. For a full discussion of the subscription
      * resource, see [Subscription](../guides/concepts#subscription).
      *
-     * Subscriptions can be filtered to a single customer by passing in the
-     * `customer_id` query parameter or the `external_customer_id` query parameter.
+     * Subscriptions can be filtered for a specific customer by using either the
+     * customer_id or external_customer_id query parameters. To filter subscriptions
+     * for multiple customers, use the customer_id[] or external_customer_id[] query
+     * parameters.
      */
     list(query?: SubscriptionListParams, options?: Core.RequestOptions): Core.PagePromise<SubscriptionsPage, Subscription>;
     list(options?: Core.RequestOptions): Core.PagePromise<SubscriptionsPage, Subscription>;
@@ -918,6 +920,7 @@ export interface Subscription {
      * the plan's behavior. If null, defaults to the customer's setting.
      */
     auto_collection: boolean | null;
+    billing_cycle_anchor_configuration: Subscription.BillingCycleAnchorConfiguration;
     /**
      * The day of the month on which the billing cycle is anchored. If the maximum
      * number of days in a month is greater than this value, the last day of the month
@@ -1119,6 +1122,26 @@ export declare namespace Subscription {
             reason: string | null;
         }
     }
+    interface BillingCycleAnchorConfiguration {
+        /**
+         * The day of the month on which the billing cycle is anchored. If the maximum
+         * number of days in a month is greater than this value, the last day of the month
+         * is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
+         * period begins on the 30th.
+         */
+        day: number;
+        /**
+         * The month on which the billing cycle is anchored (e.g. a quarterly price
+         * anchored in February would have cycles starting February, May, August, and
+         * November).
+         */
+        month?: number | null;
+        /**
+         * The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
+         * anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
+         */
+        year?: number | null;
+    }
     interface AmountDiscountInterval {
         /**
          * Only available if discount_type is `amount`.
@@ -1876,6 +1899,7 @@ export interface SubscriptionCreateParams {
     align_billing_with_subscription_start_date?: boolean;
     auto_collection?: boolean | null;
     aws_region?: string | null;
+    billing_cycle_anchor_configuration?: SubscriptionCreateParams.BillingCycleAnchorConfiguration | null;
     coupon_redemption_code?: string | null;
     credits_overage_rate?: number | null;
     customer_id?: string | null;
@@ -1911,6 +1935,26 @@ export interface SubscriptionCreateParams {
     start_date?: string | null;
 }
 export declare namespace SubscriptionCreateParams {
+    interface BillingCycleAnchorConfiguration {
+        /**
+         * The day of the month on which the billing cycle is anchored. If the maximum
+         * number of days in a month is greater than this value, the last day of the month
+         * is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
+         * period begins on the 30th.
+         */
+        day: number;
+        /**
+         * The month on which the billing cycle is anchored (e.g. a quarterly price
+         * anchored in February would have cycles starting February, May, August, and
+         * November).
+         */
+        month?: number | null;
+        /**
+         * The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
+         * anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
+         */
+        year?: number | null;
+    }
     interface OverrideUnitPrice {
         id: string;
         model_type: 'unit';
@@ -2887,7 +2931,7 @@ export interface SubscriptionListParams extends PageParams {
     'created_at[gte]'?: string | null;
     'created_at[lt]'?: string | null;
     'created_at[lte]'?: string | null;
-    customer_id?: string | null;
+    customer_id?: Array<string> | null;
     external_customer_id?: string | null;
     status?: 'active' | 'ended' | 'upcoming' | null;
 }
@@ -3115,6 +3159,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingUnitPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3132,6 +3181,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingUnitPrice.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
@@ -3146,6 +3200,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                  */
                 unit_amount: string;
             }
+            /**
+             * 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 NewFloatingPackagePrice {
             /**
@@ -3176,6 +3258,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingPackagePrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3193,6 +3280,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingPackagePrice.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
@@ -3212,6 +3304,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                  */
                 package_size: number;
             }
+            /**
+             * 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 NewFloatingMatrixPrice {
             /**
@@ -3242,6 +3362,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingMatrixPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3259,6 +3384,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingMatrixPrice.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
@@ -3295,6 +3425,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                     unit_amount: string;
                 }
             }
+            /**
+             * 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 NewFloatingMatrixWithAllocationPrice {
             /**
@@ -3325,6 +3483,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingMatrixWithAllocationPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3342,6 +3505,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingMatrixWithAllocationPrice.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
@@ -3382,6 +3550,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                     unit_amount: string;
                 }
             }
+            /**
+             * 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 NewFloatingTieredPrice {
             /**
@@ -3412,6 +3608,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3429,6 +3630,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredPrice.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
@@ -3459,6 +3665,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                     last_unit?: number | null;
                 }
             }
+            /**
+             * 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 NewFloatingTieredBpsPrice {
             /**
@@ -3489,6 +3723,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredBpsPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3506,6 +3745,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredBpsPrice.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
@@ -3541,6 +3785,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                     per_unit_maximum?: string | null;
                 }
             }
+            /**
+             * 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 NewFloatingBpsPrice {
             bps_config: NewFloatingBpsPrice.BpsConfig;
@@ -3571,6 +3843,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBpsPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3588,6 +3865,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBpsPrice.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
@@ -3606,6 +3888,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                  */
                 per_unit_maximum?: string | null;
             }
+            /**
+             * 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 NewFloatingBulkBpsPrice {
             bulk_bps_config: NewFloatingBulkBpsPrice.BulkBpsConfig;
@@ -3636,6 +3946,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBulkBpsPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3653,6 +3968,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBulkBpsPrice.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
@@ -3684,6 +4004,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                     per_unit_maximum?: string | null;
                 }
             }
+            /**
+             * 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 NewFloatingBulkPrice {
             bulk_config: NewFloatingBulkPrice.BulkConfig;
@@ -3714,6 +4062,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBulkPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3731,6 +4084,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBulkPrice.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
@@ -3757,6 +4115,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
                     maximum_units?: number | null;
                 }
             }
+            /**
+             * 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 NewFloatingThresholdTotalAmountPrice {
             /**
@@ -3787,6 +4173,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingThresholdTotalAmountPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3804,6 +4195,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingThresholdTotalAmountPrice.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
@@ -3811,6 +4207,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingThresholdTotalAmountPrice {
+            /**
+             * 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 NewFloatingTieredPackagePrice {
             /**
              * The cadence to bill for this price on.
@@ -3840,6 +4266,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredPackagePrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3857,6 +4288,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredPackagePrice.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
@@ -3864,6 +4300,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingTieredPackagePrice {
+            /**
+             * 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 NewFloatingGroupedTieredPrice {
             /**
              * The cadence to bill for this price on.
@@ -3893,6 +4359,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingGroupedTieredPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3910,6 +4381,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingGroupedTieredPrice.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
@@ -3917,6 +4393,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingGroupedTieredPrice {
+            /**
+             * 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.
@@ -3946,6 +4452,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredWithMinimumPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -3963,6 +4474,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredWithMinimumPrice.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
@@ -3970,6 +4486,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingTieredWithMinimumPrice {
+            /**
+             * 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 NewFloatingPackageWithAllocationPrice {
             /**
              * The cadence to bill for this price on.
@@ -3999,6 +4545,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingPackageWithAllocationPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -4016,6 +4567,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingPackageWithAllocationPrice.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
@@ -4023,6 +4579,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingPackageWithAllocationPrice {
+            /**
+             * 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 NewFloatingTieredPackageWithMinimumPrice {
             /**
              * The cadence to bill for this price on.
@@ -4052,6 +4638,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredPackageWithMinimumPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -4069,6 +4660,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredPackageWithMinimumPrice.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
@@ -4076,6 +4672,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingTieredPackageWithMinimumPrice {
+            /**
+             * 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 NewFloatingUnitWithPercentPrice {
             /**
              * The cadence to bill for this price on.
@@ -4105,6 +4731,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingUnitWithPercentPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -4122,6 +4753,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingUnitWithPercentPrice.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
@@ -4129,6 +4765,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingUnitWithPercentPrice {
+            /**
+             * 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 NewFloatingTieredWithProrationPrice {
             /**
              * The cadence to bill for this price on.
@@ -4158,6 +4824,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredWithProrationPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -4175,6 +4846,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingTieredWithProrationPrice.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
@@ -4182,6 +4858,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingTieredWithProrationPrice {
+            /**
+             * 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 NewFloatingUnitWithProrationPrice {
             /**
              * The cadence to bill for this price on.
@@ -4211,6 +4917,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingUnitWithProrationPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -4228,6 +4939,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingUnitWithProrationPrice.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
@@ -4235,6 +4951,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingUnitWithProrationPrice {
+            /**
+             * 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 NewFloatingGroupedAllocationPrice {
             /**
              * The cadence to bill for this price on.
@@ -4264,6 +5010,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingGroupedAllocationPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -4281,6 +5032,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingGroupedAllocationPrice.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
@@ -4288,6 +5044,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingGroupedAllocationPrice {
+            /**
+             * 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 NewFloatingBulkWithProrationPrice {
             bulk_with_proration_config: Record<string, unknown>;
             /**
@@ -4317,6 +5103,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBulkWithProrationPrice.BillingCycleConfiguration | null;
             /**
              * The per unit conversion rate of the price currency to the invoicing currency.
              */
@@ -4334,6 +5125,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * 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?: NewFloatingBulkWithProrationPrice.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
@@ -4341,6 +5137,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             metadata?: Record<string, string | null> | null;
         }
+        namespace NewFloatingBulkWithProrationPrice {
+            /**
+             * 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 AddAdjustment {
         /**