orb-billing 4.8.0 → 4.11.0

package/src/resources/subscriptions.ts

@@ -443,8 +443,10 @@ export 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,
@@ -1098,6 +1100,8 @@ export interface Subscription {
    */
   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
@@ -1354,6 +1358,29 @@ export namespace Subscription {
     }
   }
 
+  export 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;
+  }
+
   export interface AmountDiscountInterval {
     /**
      * Only available if discount_type is `amount`.
@@ -2205,6 +2232,8 @@ export interface SubscriptionCreateParams {
 
   aws_region?: string | null;
 
+  billing_cycle_anchor_configuration?: SubscriptionCreateParams.BillingCycleAnchorConfiguration | null;
+
   coupon_redemption_code?: string | null;
 
   credits_overage_rate?: number | null;
@@ -2271,6 +2300,29 @@ export interface SubscriptionCreateParams {
 }
 
 export namespace SubscriptionCreateParams {
+  export 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;
+  }
+
   export interface OverrideUnitPrice {
     id: string;
 
@@ -3477,7 +3529,7 @@ export interface SubscriptionListParams extends PageParams {
 
   'created_at[lte]'?: string | null;
 
-  customer_id?: string | null;
+  customer_id?: Array<string> | null;
 
   external_customer_id?: string | null;
 
@@ -3787,6 +3839,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -3808,6 +3866,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -3823,6 +3887,38 @@ export namespace SubscriptionPriceIntervalsParams {
          */
         unit_amount: string;
       }
+
+      /**
+       * 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 NewFloatingPackagePrice {
@@ -3862,6 +3958,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -3883,6 +3985,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -3904,6 +4012,38 @@ export namespace SubscriptionPriceIntervalsParams {
          */
         package_size: number;
       }
+
+      /**
+       * 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 NewFloatingMatrixPrice {
@@ -3943,6 +4083,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -3964,6 +4110,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4005,6 +4157,38 @@ export namespace SubscriptionPriceIntervalsParams {
           unit_amount: string;
         }
       }
+
+      /**
+       * 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 NewFloatingMatrixWithAllocationPrice {
@@ -4044,6 +4228,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4065,6 +4255,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4111,6 +4307,38 @@ export namespace SubscriptionPriceIntervalsParams {
           unit_amount: string;
         }
       }
+
+      /**
+       * 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 NewFloatingTieredPrice {
@@ -4150,6 +4378,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4171,6 +4405,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4205,6 +4445,38 @@ export namespace SubscriptionPriceIntervalsParams {
           last_unit?: number | null;
         }
       }
+
+      /**
+       * 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 NewFloatingTieredBpsPrice {
@@ -4244,6 +4516,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4265,6 +4543,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4305,6 +4589,38 @@ export namespace SubscriptionPriceIntervalsParams {
           per_unit_maximum?: string | null;
         }
       }
+
+      /**
+       * 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 NewFloatingBpsPrice {
@@ -4344,6 +4660,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4365,6 +4687,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4385,6 +4713,38 @@ export namespace SubscriptionPriceIntervalsParams {
          */
         per_unit_maximum?: string | null;
       }
+
+      /**
+       * 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 NewFloatingBulkBpsPrice {
@@ -4424,6 +4784,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4445,6 +4811,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4480,6 +4852,38 @@ export namespace SubscriptionPriceIntervalsParams {
           per_unit_maximum?: string | null;
         }
       }
+
+      /**
+       * 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 NewFloatingBulkPrice {
@@ -4519,6 +4923,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4540,6 +4950,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4569,6 +4985,38 @@ export namespace SubscriptionPriceIntervalsParams {
           maximum_units?: number | null;
         }
       }
+
+      /**
+       * 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 NewFloatingThresholdTotalAmountPrice {
@@ -4608,6 +5056,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4629,6 +5083,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4637,16 +5097,50 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
-    export interface NewFloatingTieredPackagePrice {
+    export namespace NewFloatingThresholdTotalAmountPrice {
       /**
-       * The cadence to bill for this price on.
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
        */
-      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+      export interface BillingCycleConfiguration {
+        /**
+         * The duration of the billing period.
+         */
+        duration: number;
+
+        /**
+         * The unit of billing period duration.
+         */
+        duration_unit: 'day' | 'month';
+      }
 
       /**
-       * An ISO 4217 currency string for which this price is billed in.
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
        */
-      currency: string;
+      export interface InvoicingCycleConfiguration {
+        /**
+         * The duration of the billing period.
+         */
+        duration: number;
+
+        /**
+         * The unit of billing period duration.
+         */
+        duration_unit: 'day' | 'month';
+      }
+    }
+
+    export interface NewFloatingTieredPackagePrice {
+      /**
+       * 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.
@@ -4674,6 +5168,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4695,6 +5195,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4703,6 +5209,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingTieredPackagePrice {
+      /**
+       * 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 NewFloatingGroupedTieredPrice {
       /**
        * The cadence to bill for this price on.
@@ -4740,6 +5280,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4761,6 +5307,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4769,6 +5321,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingGroupedTieredPrice {
+      /**
+       * 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 NewFloatingTieredWithMinimumPrice {
       /**
        * The cadence to bill for this price on.
@@ -4806,6 +5392,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4827,6 +5419,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4835,6 +5433,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingTieredWithMinimumPrice {
+      /**
+       * 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 NewFloatingPackageWithAllocationPrice {
       /**
        * The cadence to bill for this price on.
@@ -4872,6 +5504,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4893,6 +5531,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4901,6 +5545,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingPackageWithAllocationPrice {
+      /**
+       * 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 NewFloatingTieredPackageWithMinimumPrice {
       /**
        * The cadence to bill for this price on.
@@ -4938,6 +5616,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -4959,6 +5643,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -4967,6 +5657,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingTieredPackageWithMinimumPrice {
+      /**
+       * 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 NewFloatingUnitWithPercentPrice {
       /**
        * The cadence to bill for this price on.
@@ -5004,6 +5728,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -5025,6 +5755,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -5033,6 +5769,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingUnitWithPercentPrice {
+      /**
+       * 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 NewFloatingTieredWithProrationPrice {
       /**
        * The cadence to bill for this price on.
@@ -5070,6 +5840,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -5091,6 +5867,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -5099,6 +5881,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingTieredWithProrationPrice {
+      /**
+       * 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 NewFloatingUnitWithProrationPrice {
       /**
        * The cadence to bill for this price on.
@@ -5136,6 +5952,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -5157,6 +5979,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -5165,6 +5993,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingUnitWithProrationPrice {
+      /**
+       * 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 NewFloatingGroupedAllocationPrice {
       /**
        * The cadence to bill for this price on.
@@ -5202,6 +6064,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -5223,6 +6091,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -5231,6 +6105,40 @@ export namespace SubscriptionPriceIntervalsParams {
       metadata?: Record<string, string | null> | null;
     }
 
+    export namespace NewFloatingGroupedAllocationPrice {
+      /**
+       * 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>;
 
@@ -5268,6 +6176,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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.
        */
@@ -5289,6 +6203,12 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       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
@@ -5296,6 +6216,40 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       metadata?: Record<string, string | null> | null;
     }
+
+    export namespace NewFloatingBulkWithProrationPrice {
+      /**
+       * 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 AddAdjustment {