orb-billing 3.2.0 → 4.0.0

package/resources/prices/prices.d.ts

@@ -315,6 +315,7 @@ export declare namespace Price {
     interface UnitPrice {
         id: string;
         billable_metric: UnitPrice.BillableMetric | null;
+        billing_cycle_configuration: UnitPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -345,6 +346,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -385,6 +390,7 @@ export declare namespace Price {
     interface PackagePrice {
         id: string;
         billable_metric: PackagePrice.BillableMetric | null;
+        billing_cycle_configuration: PackagePrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -415,6 +421,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -460,6 +470,7 @@ export declare namespace Price {
     interface MatrixPrice {
         id: string;
         billable_metric: MatrixPrice.BillableMetric | null;
+        billing_cycle_configuration: MatrixPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -490,6 +501,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -552,6 +567,7 @@ export declare namespace Price {
     interface TieredPrice {
         id: string;
         billable_metric: TieredPrice.BillableMetric | null;
+        billing_cycle_configuration: TieredPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -582,6 +598,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -638,6 +658,7 @@ export declare namespace Price {
     interface TieredBpsPrice {
         id: string;
         billable_metric: TieredBpsPrice.BillableMetric | null;
+        billing_cycle_configuration: TieredBpsPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -668,6 +689,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -729,6 +754,7 @@ export declare namespace Price {
     interface BpsPrice {
         id: string;
         billable_metric: BpsPrice.BillableMetric | null;
+        billing_cycle_configuration: BpsPrice.BillingCycleConfiguration | null;
         bps_config: BpsPrice.BpsConfig;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
@@ -759,6 +785,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface BpsConfig {
             /**
              * Basis point take rate per event
@@ -803,6 +833,7 @@ export declare namespace Price {
     interface BulkBpsPrice {
         id: string;
         billable_metric: BulkBpsPrice.BillableMetric | null;
+        billing_cycle_configuration: BulkBpsPrice.BillingCycleConfiguration | null;
         bulk_bps_config: BulkBpsPrice.BulkBpsConfig;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
@@ -833,6 +864,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface BulkBpsConfig {
             /**
              * Tiers for a bulk BPS pricing model where all usage is aggregated to a single
@@ -890,6 +925,7 @@ export declare namespace Price {
     interface BulkPrice {
         id: string;
         billable_metric: BulkPrice.BillableMetric | null;
+        billing_cycle_configuration: BulkPrice.BillingCycleConfiguration | null;
         bulk_config: BulkPrice.BulkConfig;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
@@ -920,6 +956,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface BulkConfig {
             /**
              * Bulk tiers for rating based on total usage volume
@@ -972,6 +1012,7 @@ export declare namespace Price {
     interface ThresholdTotalAmountPrice {
         id: string;
         billable_metric: ThresholdTotalAmountPrice.BillableMetric | null;
+        billing_cycle_configuration: ThresholdTotalAmountPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1002,6 +1043,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1036,6 +1081,7 @@ export declare namespace Price {
     interface TieredPackagePrice {
         id: string;
         billable_metric: TieredPackagePrice.BillableMetric | null;
+        billing_cycle_configuration: TieredPackagePrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1066,6 +1112,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1100,6 +1150,7 @@ export declare namespace Price {
     interface GroupedTieredPrice {
         id: string;
         billable_metric: GroupedTieredPrice.BillableMetric | null;
+        billing_cycle_configuration: GroupedTieredPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1130,6 +1181,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1164,6 +1219,7 @@ export declare namespace Price {
     interface TieredWithMinimumPrice {
         id: string;
         billable_metric: TieredWithMinimumPrice.BillableMetric | null;
+        billing_cycle_configuration: TieredWithMinimumPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1194,6 +1250,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1228,6 +1288,7 @@ export declare namespace Price {
     interface TieredPackageWithMinimumPrice {
         id: string;
         billable_metric: TieredPackageWithMinimumPrice.BillableMetric | null;
+        billing_cycle_configuration: TieredPackageWithMinimumPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1258,6 +1319,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1292,6 +1357,7 @@ export declare namespace Price {
     interface PackageWithAllocationPrice {
         id: string;
         billable_metric: PackageWithAllocationPrice.BillableMetric | null;
+        billing_cycle_configuration: PackageWithAllocationPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1322,6 +1388,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1356,6 +1426,7 @@ export declare namespace Price {
     interface UnitWithPercentPrice {
         id: string;
         billable_metric: UnitWithPercentPrice.BillableMetric | null;
+        billing_cycle_configuration: UnitWithPercentPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1386,6 +1457,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1420,6 +1495,7 @@ export declare namespace Price {
     interface MatrixWithAllocationPrice {
         id: string;
         billable_metric: MatrixWithAllocationPrice.BillableMetric | null;
+        billing_cycle_configuration: MatrixWithAllocationPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1450,6 +1526,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1516,6 +1596,7 @@ export declare namespace Price {
     interface TieredWithProrationPrice {
         id: string;
         billable_metric: TieredWithProrationPrice.BillableMetric | null;
+        billing_cycle_configuration: TieredWithProrationPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1546,6 +1627,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1580,6 +1665,7 @@ export declare namespace Price {
     interface UnitWithProrationPrice {
         id: string;
         billable_metric: UnitWithProrationPrice.BillableMetric | null;
+        billing_cycle_configuration: UnitWithProrationPrice.BillingCycleConfiguration | null;
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         created_at: string;
@@ -1610,6 +1696,10 @@ export declare namespace Price {
         interface BillableMetric {
             id: string;
         }
+        interface BillingCycleConfiguration {
+            duration: number;
+            duration_unit: 'day' | 'month';
+        }
         interface CreditAllocation {
             allows_rollover: boolean;
             currency: string;
@@ -1651,7 +1741,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1712,7 +1802,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1778,7 +1868,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1861,7 +1951,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -1948,7 +2038,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2025,7 +2115,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2108,7 +2198,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2173,7 +2263,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2251,7 +2341,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2323,7 +2413,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2376,7 +2466,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2429,7 +2519,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2482,7 +2572,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2535,7 +2625,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2588,7 +2678,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2641,7 +2731,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2694,7 +2784,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */
@@ -2747,7 +2837,7 @@ export declare namespace PriceCreateParams {
         /**
          * The cadence to bill for this price on.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
          * An ISO 4217 currency string for which this price is billed in.
          */