orb-billing 5.0.0 → 5.1.0

package/resources/subscriptions.d.ts

@@ -263,7 +263,7 @@ export declare class Subscriptions extends APIResource {
      * is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is
      * specified in the subscription's invoicing currency, when creating a
      * subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit
-     * $10.00 for a subscription that invoices in USD.
+     * \$10.00 for a subscription that invoices in USD.
      */
     create(body: SubscriptionCreateParams, options?: Core.RequestOptions): Core.APIPromise<SubscriptionChangesAPI.MutatedSubscription>;
     /**
@@ -996,7 +996,9 @@ export interface NewSubscriptionBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1073,7 +1075,9 @@ export interface NewSubscriptionBulkBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1150,7 +1154,9 @@ export interface NewSubscriptionBulkPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1158,7 +1164,9 @@ export interface NewSubscriptionBulkPrice {
     reference_id?: string | null;
 }
 export interface NewSubscriptionBulkWithProrationPrice {
-    bulk_with_proration_config: Record<string, unknown>;
+    bulk_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The cadence to bill for this price on.
      */
@@ -1227,7 +1235,9 @@ export interface NewSubscriptionBulkWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1239,7 +1249,9 @@ export interface NewSubscriptionCumulativeGroupedBulkPrice {
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    cumulative_grouped_bulk_config: Record<string, unknown>;
+    cumulative_grouped_bulk_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1304,7 +1316,9 @@ export interface NewSubscriptionCumulativeGroupedBulkPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1316,7 +1330,9 @@ export interface NewSubscriptionGroupedAllocationPrice {
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_allocation_config: Record<string, unknown>;
+    grouped_allocation_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1381,7 +1397,9 @@ export interface NewSubscriptionGroupedAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1393,7 +1411,9 @@ export interface NewSubscriptionGroupedTieredPackagePrice {
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_tiered_package_config: Record<string, unknown>;
+    grouped_tiered_package_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1458,7 +1478,9 @@ export interface NewSubscriptionGroupedTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1470,7 +1492,9 @@ export interface NewSubscriptionGroupedTieredPrice {
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_tiered_config: Record<string, unknown>;
+    grouped_tiered_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1535,7 +1559,9 @@ export interface NewSubscriptionGroupedTieredPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1547,7 +1573,9 @@ export interface NewSubscriptionGroupedWithMeteredMinimumPrice {
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_with_metered_minimum_config: Record<string, unknown>;
+    grouped_with_metered_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1612,7 +1640,9 @@ export interface NewSubscriptionGroupedWithMeteredMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1624,7 +1654,9 @@ export interface NewSubscriptionGroupedWithProratedMinimumPrice {
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_with_prorated_minimum_config: Record<string, unknown>;
+    grouped_with_prorated_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1689,7 +1721,9 @@ export interface NewSubscriptionGroupedWithProratedMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1766,7 +1800,9 @@ export interface NewSubscriptionMatrixPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1843,7 +1879,9 @@ export interface NewSubscriptionMatrixWithAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1859,7 +1897,9 @@ export interface NewSubscriptionMatrixWithDisplayNamePrice {
      * The id of the item the price will be associated with.
      */
     item_id: string;
-    matrix_with_display_name_config: Record<string, unknown>;
+    matrix_with_display_name_config: {
+        [key: string]: unknown;
+    };
     model_type: 'matrix_with_display_name';
     /**
      * The name of the price.
@@ -1920,7 +1960,9 @@ export interface NewSubscriptionMatrixWithDisplayNamePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -1936,7 +1978,9 @@ export interface NewSubscriptionMaxGroupTieredPackagePrice {
      * The id of the item the price will be associated with.
      */
     item_id: string;
-    max_group_tiered_package_config: Record<string, unknown>;
+    max_group_tiered_package_config: {
+        [key: string]: unknown;
+    };
     model_type: 'max_group_tiered_package';
     /**
      * The name of the price.
@@ -1997,7 +2041,9 @@ export interface NewSubscriptionMaxGroupTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2074,7 +2120,9 @@ export interface NewSubscriptionPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2095,7 +2143,9 @@ export interface NewSubscriptionPackageWithAllocationPrice {
      * The name of the price.
      */
     name: string;
-    package_with_allocation_config: Record<string, unknown>;
+    package_with_allocation_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2151,7 +2201,9 @@ export interface NewSubscriptionPackageWithAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2172,7 +2224,9 @@ export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
      * The name of the price.
      */
     name: string;
-    scalable_matrix_with_tiered_pricing_config: Record<string, unknown>;
+    scalable_matrix_with_tiered_pricing_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2228,7 +2282,9 @@ export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2249,7 +2305,9 @@ export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
      * The name of the price.
      */
     name: string;
-    scalable_matrix_with_unit_pricing_config: Record<string, unknown>;
+    scalable_matrix_with_unit_pricing_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2305,7 +2363,9 @@ export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2326,7 +2386,9 @@ export interface NewSubscriptionThresholdTotalAmountPrice {
      * The name of the price.
      */
     name: string;
-    threshold_total_amount_config: Record<string, unknown>;
+    threshold_total_amount_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2382,7 +2444,9 @@ export interface NewSubscriptionThresholdTotalAmountPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2403,7 +2467,9 @@ export interface NewSubscriptionTierWithProrationPrice {
      * The name of the price.
      */
     name: string;
-    tiered_with_proration_config: Record<string, unknown>;
+    tiered_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2459,7 +2525,9 @@ export interface NewSubscriptionTierWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2536,7 +2604,9 @@ export interface NewSubscriptionTieredBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2557,7 +2627,9 @@ export interface NewSubscriptionTieredPackagePrice {
      * The name of the price.
      */
     name: string;
-    tiered_package_config: Record<string, unknown>;
+    tiered_package_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2613,7 +2685,9 @@ export interface NewSubscriptionTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2634,7 +2708,9 @@ export interface NewSubscriptionTieredPackageWithMinimumPrice {
      * The name of the price.
      */
     name: string;
-    tiered_package_with_minimum_config: Record<string, unknown>;
+    tiered_package_with_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2690,7 +2766,9 @@ export interface NewSubscriptionTieredPackageWithMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2767,7 +2845,9 @@ export interface NewSubscriptionTieredPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2788,7 +2868,9 @@ export interface NewSubscriptionTieredWithMinimumPrice {
      * The name of the price.
      */
     name: string;
-    tiered_with_minimum_config: Record<string, unknown>;
+    tiered_with_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2844,7 +2926,9 @@ export interface NewSubscriptionTieredWithMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2921,7 +3005,9 @@ export interface NewSubscriptionUnitPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -2942,7 +3028,9 @@ export interface NewSubscriptionUnitWithPercentPrice {
      * The name of the price.
      */
     name: string;
-    unit_with_percent_config: Record<string, unknown>;
+    unit_with_percent_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2998,7 +3086,9 @@ export interface NewSubscriptionUnitWithPercentPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -3019,7 +3109,9 @@ export interface NewSubscriptionUnitWithProrationPrice {
      * The name of the price.
      */
     name: string;
-    unit_with_proration_config: Record<string, unknown>;
+    unit_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -3075,7 +3167,9 @@ export interface NewSubscriptionUnitWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * A transient ID that can be used to reference this price when adding adjustments
      * in the same API call.
@@ -3170,7 +3264,7 @@ export interface Subscription {
     default_invoice_memo: string | null;
     /**
      * @deprecated The discount intervals for this subscription sorted by the
-     * start_date.
+     * start_date. This field is deprecated in favor of `adjustment_intervals`.
      */
     discount_intervals: Array<Shared.AmountDiscountInterval | Shared.PercentageDiscountInterval | Shared.UsageDiscountInterval>;
     /**
@@ -3181,7 +3275,7 @@ export interface Subscription {
     invoicing_threshold: string | null;
     /**
      * @deprecated The maximum intervals for this subscription sorted by the
-     * start_date.
+     * start_date. This field is deprecated in favor of `adjustment_intervals`.
      */
     maximum_intervals: Array<Shared.MaximumInterval>;
     /**
@@ -3190,10 +3284,12 @@ export interface Subscription {
      * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
      * `null`.
      */
-    metadata: Record<string, string>;
+    metadata: {
+        [key: string]: string;
+    };
     /**
      * @deprecated The minimum intervals for this subscription sorted by the
-     * start_date.
+     * start_date. This field is deprecated in favor of `adjustment_intervals`.
      */
     minimum_intervals: Array<Shared.MinimumInterval>;
     /**
@@ -3387,7 +3483,9 @@ export interface SubscriptionCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * The name to use for the subscription. If not specified, the plan name will be
      * used.
@@ -3617,7 +3715,9 @@ export interface SubscriptionUpdateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
     /**
      * Determines the difference between the invoice issue date for subscription
      * invoices as the date that they are due. A value of `0` here represents that the
@@ -3868,8 +3968,8 @@ export declare namespace SubscriptionPriceIntervalsParams {
          */
         billing_cycle_day?: number | null;
         /**
-         * The updated end date of this price interval. If not specified, the start date
-         * will not be updated.
+         * The updated end date of this price interval. If not specified, the end date will
+         * not be updated.
          */
         end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
         /**
@@ -3918,8 +4018,8 @@ export declare namespace SubscriptionPriceIntervalsParams {
          */
         adjustment_interval_id: string;
         /**
-         * The updated end date of this adjustment interval. If not specified, the start
-         * date will not be updated.
+         * The updated end date of this adjustment interval. If not specified, the end date
+         * will not be updated.
          */
         end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
         /**