orb-billing 4.10.0 → 4.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/package.json +1 -1
- package/resources/plans/plans.d.ts +664 -0
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/prices.d.ts +910 -28
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/subscriptions.d.ts +1070 -2
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/resources/plans/plans.ts +766 -0
- package/src/resources/prices/prices.ts +1087 -25
- package/src/resources/subscriptions.ts +1277 -17
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -920,6 +920,7 @@ export interface Subscription {
|
|
|
920
920
|
* the plan's behavior. If null, defaults to the customer's setting.
|
|
921
921
|
*/
|
|
922
922
|
auto_collection: boolean | null;
|
|
923
|
+
billing_cycle_anchor_configuration: Subscription.BillingCycleAnchorConfiguration;
|
|
923
924
|
/**
|
|
924
925
|
* The day of the month on which the billing cycle is anchored. If the maximum
|
|
925
926
|
* number of days in a month is greater than this value, the last day of the month
|
|
@@ -1121,6 +1122,26 @@ export declare namespace Subscription {
|
|
|
1121
1122
|
reason: string | null;
|
|
1122
1123
|
}
|
|
1123
1124
|
}
|
|
1125
|
+
interface BillingCycleAnchorConfiguration {
|
|
1126
|
+
/**
|
|
1127
|
+
* The day of the month on which the billing cycle is anchored. If the maximum
|
|
1128
|
+
* number of days in a month is greater than this value, the last day of the month
|
|
1129
|
+
* is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
|
1130
|
+
* period begins on the 30th.
|
|
1131
|
+
*/
|
|
1132
|
+
day: number;
|
|
1133
|
+
/**
|
|
1134
|
+
* The month on which the billing cycle is anchored (e.g. a quarterly price
|
|
1135
|
+
* anchored in February would have cycles starting February, May, August, and
|
|
1136
|
+
* November).
|
|
1137
|
+
*/
|
|
1138
|
+
month?: number | null;
|
|
1139
|
+
/**
|
|
1140
|
+
* The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
|
1141
|
+
* anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
|
1142
|
+
*/
|
|
1143
|
+
year?: number | null;
|
|
1144
|
+
}
|
|
1124
1145
|
interface AmountDiscountInterval {
|
|
1125
1146
|
/**
|
|
1126
1147
|
* Only available if discount_type is `amount`.
|
|
@@ -1878,6 +1899,7 @@ export interface SubscriptionCreateParams {
|
|
|
1878
1899
|
align_billing_with_subscription_start_date?: boolean;
|
|
1879
1900
|
auto_collection?: boolean | null;
|
|
1880
1901
|
aws_region?: string | null;
|
|
1902
|
+
billing_cycle_anchor_configuration?: SubscriptionCreateParams.BillingCycleAnchorConfiguration | null;
|
|
1881
1903
|
coupon_redemption_code?: string | null;
|
|
1882
1904
|
credits_overage_rate?: number | null;
|
|
1883
1905
|
customer_id?: string | null;
|
|
@@ -1909,10 +1931,30 @@ export interface SubscriptionCreateParams {
|
|
|
1909
1931
|
/**
|
|
1910
1932
|
* Optionally provide a list of overrides for prices on the plan
|
|
1911
1933
|
*/
|
|
1912
|
-
price_overrides?: Array<SubscriptionCreateParams.OverrideUnitPrice | SubscriptionCreateParams.OverridePackagePrice | SubscriptionCreateParams.OverrideMatrixPrice | SubscriptionCreateParams.OverrideTieredPrice | SubscriptionCreateParams.OverrideTieredBpsPrice | SubscriptionCreateParams.OverrideBpsPrice | SubscriptionCreateParams.OverrideBulkBpsPrice | SubscriptionCreateParams.OverrideBulkPrice | SubscriptionCreateParams.OverrideThresholdTotalAmountPrice | SubscriptionCreateParams.OverrideTieredPackagePrice | SubscriptionCreateParams.OverrideTieredWithMinimumPrice | SubscriptionCreateParams.OverridePackageWithAllocationPrice | SubscriptionCreateParams.OverrideUnitWithPercentPrice> | null;
|
|
1934
|
+
price_overrides?: Array<SubscriptionCreateParams.OverrideUnitPrice | SubscriptionCreateParams.OverridePackagePrice | SubscriptionCreateParams.OverrideMatrixPrice | SubscriptionCreateParams.OverrideTieredPrice | SubscriptionCreateParams.OverrideTieredBpsPrice | SubscriptionCreateParams.OverrideBpsPrice | SubscriptionCreateParams.OverrideBulkBpsPrice | SubscriptionCreateParams.OverrideBulkPrice | SubscriptionCreateParams.OverrideThresholdTotalAmountPrice | SubscriptionCreateParams.OverrideTieredPackagePrice | SubscriptionCreateParams.OverrideTieredWithMinimumPrice | SubscriptionCreateParams.OverridePackageWithAllocationPrice | SubscriptionCreateParams.OverrideUnitWithPercentPrice | SubscriptionCreateParams.OverrideGroupedAllocationPrice | SubscriptionCreateParams.OverrideBulkWithProrationPrice> | null;
|
|
1913
1935
|
start_date?: string | null;
|
|
1914
1936
|
}
|
|
1915
1937
|
export declare namespace SubscriptionCreateParams {
|
|
1938
|
+
interface BillingCycleAnchorConfiguration {
|
|
1939
|
+
/**
|
|
1940
|
+
* The day of the month on which the billing cycle is anchored. If the maximum
|
|
1941
|
+
* number of days in a month is greater than this value, the last day of the month
|
|
1942
|
+
* is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
|
1943
|
+
* period begins on the 30th.
|
|
1944
|
+
*/
|
|
1945
|
+
day: number;
|
|
1946
|
+
/**
|
|
1947
|
+
* The month on which the billing cycle is anchored (e.g. a quarterly price
|
|
1948
|
+
* anchored in February would have cycles starting February, May, August, and
|
|
1949
|
+
* November).
|
|
1950
|
+
*/
|
|
1951
|
+
month?: number | null;
|
|
1952
|
+
/**
|
|
1953
|
+
* The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
|
1954
|
+
* anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
|
1955
|
+
*/
|
|
1956
|
+
year?: number | null;
|
|
1957
|
+
}
|
|
1916
1958
|
interface OverrideUnitPrice {
|
|
1917
1959
|
id: string;
|
|
1918
1960
|
model_type: 'unit';
|
|
@@ -2851,6 +2893,128 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2851
2893
|
usage_discount?: number | null;
|
|
2852
2894
|
}
|
|
2853
2895
|
}
|
|
2896
|
+
interface OverrideGroupedAllocationPrice {
|
|
2897
|
+
id: string;
|
|
2898
|
+
grouped_allocation_config: Record<string, unknown>;
|
|
2899
|
+
model_type: 'grouped_allocation';
|
|
2900
|
+
/**
|
|
2901
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2902
|
+
*/
|
|
2903
|
+
conversion_rate?: number | null;
|
|
2904
|
+
/**
|
|
2905
|
+
* The currency of the price. If not provided, the currency of the plan will be
|
|
2906
|
+
* used.
|
|
2907
|
+
*/
|
|
2908
|
+
currency?: string | null;
|
|
2909
|
+
/**
|
|
2910
|
+
* The subscription's override discount for the plan.
|
|
2911
|
+
*/
|
|
2912
|
+
discount?: OverrideGroupedAllocationPrice.Discount | null;
|
|
2913
|
+
/**
|
|
2914
|
+
* The starting quantity of the price, if the price is a fixed price.
|
|
2915
|
+
*/
|
|
2916
|
+
fixed_price_quantity?: number | null;
|
|
2917
|
+
/**
|
|
2918
|
+
* The subscription's override maximum amount for the plan.
|
|
2919
|
+
*/
|
|
2920
|
+
maximum_amount?: string | null;
|
|
2921
|
+
/**
|
|
2922
|
+
* The subscription's override minimum amount for the plan.
|
|
2923
|
+
*/
|
|
2924
|
+
minimum_amount?: string | null;
|
|
2925
|
+
}
|
|
2926
|
+
namespace OverrideGroupedAllocationPrice {
|
|
2927
|
+
/**
|
|
2928
|
+
* The subscription's override discount for the plan.
|
|
2929
|
+
*/
|
|
2930
|
+
interface Discount {
|
|
2931
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2932
|
+
/**
|
|
2933
|
+
* Only available if discount_type is `amount`.
|
|
2934
|
+
*/
|
|
2935
|
+
amount_discount?: string | null;
|
|
2936
|
+
/**
|
|
2937
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2938
|
+
* this can be a subset of prices.
|
|
2939
|
+
*/
|
|
2940
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2941
|
+
/**
|
|
2942
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2943
|
+
* and 1.
|
|
2944
|
+
*/
|
|
2945
|
+
percentage_discount?: number | null;
|
|
2946
|
+
/**
|
|
2947
|
+
* Only available if discount_type is `trial`
|
|
2948
|
+
*/
|
|
2949
|
+
trial_amount_discount?: string | null;
|
|
2950
|
+
/**
|
|
2951
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2952
|
+
* discount is for
|
|
2953
|
+
*/
|
|
2954
|
+
usage_discount?: number | null;
|
|
2955
|
+
}
|
|
2956
|
+
}
|
|
2957
|
+
interface OverrideBulkWithProrationPrice {
|
|
2958
|
+
id: string;
|
|
2959
|
+
bulk_with_proration_config: Record<string, unknown>;
|
|
2960
|
+
model_type: 'bulk_with_proration';
|
|
2961
|
+
/**
|
|
2962
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2963
|
+
*/
|
|
2964
|
+
conversion_rate?: number | null;
|
|
2965
|
+
/**
|
|
2966
|
+
* The currency of the price. If not provided, the currency of the plan will be
|
|
2967
|
+
* used.
|
|
2968
|
+
*/
|
|
2969
|
+
currency?: string | null;
|
|
2970
|
+
/**
|
|
2971
|
+
* The subscription's override discount for the plan.
|
|
2972
|
+
*/
|
|
2973
|
+
discount?: OverrideBulkWithProrationPrice.Discount | null;
|
|
2974
|
+
/**
|
|
2975
|
+
* The starting quantity of the price, if the price is a fixed price.
|
|
2976
|
+
*/
|
|
2977
|
+
fixed_price_quantity?: number | null;
|
|
2978
|
+
/**
|
|
2979
|
+
* The subscription's override maximum amount for the plan.
|
|
2980
|
+
*/
|
|
2981
|
+
maximum_amount?: string | null;
|
|
2982
|
+
/**
|
|
2983
|
+
* The subscription's override minimum amount for the plan.
|
|
2984
|
+
*/
|
|
2985
|
+
minimum_amount?: string | null;
|
|
2986
|
+
}
|
|
2987
|
+
namespace OverrideBulkWithProrationPrice {
|
|
2988
|
+
/**
|
|
2989
|
+
* The subscription's override discount for the plan.
|
|
2990
|
+
*/
|
|
2991
|
+
interface Discount {
|
|
2992
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2993
|
+
/**
|
|
2994
|
+
* Only available if discount_type is `amount`.
|
|
2995
|
+
*/
|
|
2996
|
+
amount_discount?: string | null;
|
|
2997
|
+
/**
|
|
2998
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2999
|
+
* this can be a subset of prices.
|
|
3000
|
+
*/
|
|
3001
|
+
applies_to_price_ids?: Array<string> | null;
|
|
3002
|
+
/**
|
|
3003
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
3004
|
+
* and 1.
|
|
3005
|
+
*/
|
|
3006
|
+
percentage_discount?: number | null;
|
|
3007
|
+
/**
|
|
3008
|
+
* Only available if discount_type is `trial`
|
|
3009
|
+
*/
|
|
3010
|
+
trial_amount_discount?: string | null;
|
|
3011
|
+
/**
|
|
3012
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
3013
|
+
* discount is for
|
|
3014
|
+
*/
|
|
3015
|
+
usage_discount?: number | null;
|
|
3016
|
+
}
|
|
3017
|
+
}
|
|
2854
3018
|
}
|
|
2855
3019
|
export interface SubscriptionUpdateParams {
|
|
2856
3020
|
/**
|
|
@@ -3117,6 +3281,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3117
3281
|
* this is true, and in-arrears if this is false.
|
|
3118
3282
|
*/
|
|
3119
3283
|
billed_in_advance?: boolean | null;
|
|
3284
|
+
/**
|
|
3285
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3286
|
+
* months.
|
|
3287
|
+
*/
|
|
3288
|
+
billing_cycle_configuration?: NewFloatingUnitPrice.BillingCycleConfiguration | null;
|
|
3120
3289
|
/**
|
|
3121
3290
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3122
3291
|
*/
|
|
@@ -3134,6 +3303,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3134
3303
|
* The property used to group this price on an invoice
|
|
3135
3304
|
*/
|
|
3136
3305
|
invoice_grouping_key?: string | null;
|
|
3306
|
+
/**
|
|
3307
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3308
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3309
|
+
*/
|
|
3310
|
+
invoicing_cycle_configuration?: NewFloatingUnitPrice.InvoicingCycleConfiguration | null;
|
|
3137
3311
|
/**
|
|
3138
3312
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3139
3313
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3148,6 +3322,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3148
3322
|
*/
|
|
3149
3323
|
unit_amount: string;
|
|
3150
3324
|
}
|
|
3325
|
+
/**
|
|
3326
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3327
|
+
* months.
|
|
3328
|
+
*/
|
|
3329
|
+
interface BillingCycleConfiguration {
|
|
3330
|
+
/**
|
|
3331
|
+
* The duration of the billing period.
|
|
3332
|
+
*/
|
|
3333
|
+
duration: number;
|
|
3334
|
+
/**
|
|
3335
|
+
* The unit of billing period duration.
|
|
3336
|
+
*/
|
|
3337
|
+
duration_unit: 'day' | 'month';
|
|
3338
|
+
}
|
|
3339
|
+
/**
|
|
3340
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3341
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3342
|
+
*/
|
|
3343
|
+
interface InvoicingCycleConfiguration {
|
|
3344
|
+
/**
|
|
3345
|
+
* The duration of the billing period.
|
|
3346
|
+
*/
|
|
3347
|
+
duration: number;
|
|
3348
|
+
/**
|
|
3349
|
+
* The unit of billing period duration.
|
|
3350
|
+
*/
|
|
3351
|
+
duration_unit: 'day' | 'month';
|
|
3352
|
+
}
|
|
3151
3353
|
}
|
|
3152
3354
|
interface NewFloatingPackagePrice {
|
|
3153
3355
|
/**
|
|
@@ -3178,6 +3380,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3178
3380
|
* this is true, and in-arrears if this is false.
|
|
3179
3381
|
*/
|
|
3180
3382
|
billed_in_advance?: boolean | null;
|
|
3383
|
+
/**
|
|
3384
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3385
|
+
* months.
|
|
3386
|
+
*/
|
|
3387
|
+
billing_cycle_configuration?: NewFloatingPackagePrice.BillingCycleConfiguration | null;
|
|
3181
3388
|
/**
|
|
3182
3389
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3183
3390
|
*/
|
|
@@ -3195,6 +3402,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3195
3402
|
* The property used to group this price on an invoice
|
|
3196
3403
|
*/
|
|
3197
3404
|
invoice_grouping_key?: string | null;
|
|
3405
|
+
/**
|
|
3406
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3407
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3408
|
+
*/
|
|
3409
|
+
invoicing_cycle_configuration?: NewFloatingPackagePrice.InvoicingCycleConfiguration | null;
|
|
3198
3410
|
/**
|
|
3199
3411
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3200
3412
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3214,6 +3426,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3214
3426
|
*/
|
|
3215
3427
|
package_size: number;
|
|
3216
3428
|
}
|
|
3429
|
+
/**
|
|
3430
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3431
|
+
* months.
|
|
3432
|
+
*/
|
|
3433
|
+
interface BillingCycleConfiguration {
|
|
3434
|
+
/**
|
|
3435
|
+
* The duration of the billing period.
|
|
3436
|
+
*/
|
|
3437
|
+
duration: number;
|
|
3438
|
+
/**
|
|
3439
|
+
* The unit of billing period duration.
|
|
3440
|
+
*/
|
|
3441
|
+
duration_unit: 'day' | 'month';
|
|
3442
|
+
}
|
|
3443
|
+
/**
|
|
3444
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3445
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3446
|
+
*/
|
|
3447
|
+
interface InvoicingCycleConfiguration {
|
|
3448
|
+
/**
|
|
3449
|
+
* The duration of the billing period.
|
|
3450
|
+
*/
|
|
3451
|
+
duration: number;
|
|
3452
|
+
/**
|
|
3453
|
+
* The unit of billing period duration.
|
|
3454
|
+
*/
|
|
3455
|
+
duration_unit: 'day' | 'month';
|
|
3456
|
+
}
|
|
3217
3457
|
}
|
|
3218
3458
|
interface NewFloatingMatrixPrice {
|
|
3219
3459
|
/**
|
|
@@ -3244,6 +3484,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3244
3484
|
* this is true, and in-arrears if this is false.
|
|
3245
3485
|
*/
|
|
3246
3486
|
billed_in_advance?: boolean | null;
|
|
3487
|
+
/**
|
|
3488
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3489
|
+
* months.
|
|
3490
|
+
*/
|
|
3491
|
+
billing_cycle_configuration?: NewFloatingMatrixPrice.BillingCycleConfiguration | null;
|
|
3247
3492
|
/**
|
|
3248
3493
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3249
3494
|
*/
|
|
@@ -3261,6 +3506,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3261
3506
|
* The property used to group this price on an invoice
|
|
3262
3507
|
*/
|
|
3263
3508
|
invoice_grouping_key?: string | null;
|
|
3509
|
+
/**
|
|
3510
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3511
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3512
|
+
*/
|
|
3513
|
+
invoicing_cycle_configuration?: NewFloatingMatrixPrice.InvoicingCycleConfiguration | null;
|
|
3264
3514
|
/**
|
|
3265
3515
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3266
3516
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3297,6 +3547,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3297
3547
|
unit_amount: string;
|
|
3298
3548
|
}
|
|
3299
3549
|
}
|
|
3550
|
+
/**
|
|
3551
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3552
|
+
* months.
|
|
3553
|
+
*/
|
|
3554
|
+
interface BillingCycleConfiguration {
|
|
3555
|
+
/**
|
|
3556
|
+
* The duration of the billing period.
|
|
3557
|
+
*/
|
|
3558
|
+
duration: number;
|
|
3559
|
+
/**
|
|
3560
|
+
* The unit of billing period duration.
|
|
3561
|
+
*/
|
|
3562
|
+
duration_unit: 'day' | 'month';
|
|
3563
|
+
}
|
|
3564
|
+
/**
|
|
3565
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3566
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3567
|
+
*/
|
|
3568
|
+
interface InvoicingCycleConfiguration {
|
|
3569
|
+
/**
|
|
3570
|
+
* The duration of the billing period.
|
|
3571
|
+
*/
|
|
3572
|
+
duration: number;
|
|
3573
|
+
/**
|
|
3574
|
+
* The unit of billing period duration.
|
|
3575
|
+
*/
|
|
3576
|
+
duration_unit: 'day' | 'month';
|
|
3577
|
+
}
|
|
3300
3578
|
}
|
|
3301
3579
|
interface NewFloatingMatrixWithAllocationPrice {
|
|
3302
3580
|
/**
|
|
@@ -3327,6 +3605,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3327
3605
|
* this is true, and in-arrears if this is false.
|
|
3328
3606
|
*/
|
|
3329
3607
|
billed_in_advance?: boolean | null;
|
|
3608
|
+
/**
|
|
3609
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3610
|
+
* months.
|
|
3611
|
+
*/
|
|
3612
|
+
billing_cycle_configuration?: NewFloatingMatrixWithAllocationPrice.BillingCycleConfiguration | null;
|
|
3330
3613
|
/**
|
|
3331
3614
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3332
3615
|
*/
|
|
@@ -3344,6 +3627,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3344
3627
|
* The property used to group this price on an invoice
|
|
3345
3628
|
*/
|
|
3346
3629
|
invoice_grouping_key?: string | null;
|
|
3630
|
+
/**
|
|
3631
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3632
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3633
|
+
*/
|
|
3634
|
+
invoicing_cycle_configuration?: NewFloatingMatrixWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
3347
3635
|
/**
|
|
3348
3636
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3349
3637
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3384,6 +3672,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3384
3672
|
unit_amount: string;
|
|
3385
3673
|
}
|
|
3386
3674
|
}
|
|
3675
|
+
/**
|
|
3676
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3677
|
+
* months.
|
|
3678
|
+
*/
|
|
3679
|
+
interface BillingCycleConfiguration {
|
|
3680
|
+
/**
|
|
3681
|
+
* The duration of the billing period.
|
|
3682
|
+
*/
|
|
3683
|
+
duration: number;
|
|
3684
|
+
/**
|
|
3685
|
+
* The unit of billing period duration.
|
|
3686
|
+
*/
|
|
3687
|
+
duration_unit: 'day' | 'month';
|
|
3688
|
+
}
|
|
3689
|
+
/**
|
|
3690
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3691
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3692
|
+
*/
|
|
3693
|
+
interface InvoicingCycleConfiguration {
|
|
3694
|
+
/**
|
|
3695
|
+
* The duration of the billing period.
|
|
3696
|
+
*/
|
|
3697
|
+
duration: number;
|
|
3698
|
+
/**
|
|
3699
|
+
* The unit of billing period duration.
|
|
3700
|
+
*/
|
|
3701
|
+
duration_unit: 'day' | 'month';
|
|
3702
|
+
}
|
|
3387
3703
|
}
|
|
3388
3704
|
interface NewFloatingTieredPrice {
|
|
3389
3705
|
/**
|
|
@@ -3414,6 +3730,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3414
3730
|
* this is true, and in-arrears if this is false.
|
|
3415
3731
|
*/
|
|
3416
3732
|
billed_in_advance?: boolean | null;
|
|
3733
|
+
/**
|
|
3734
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3735
|
+
* months.
|
|
3736
|
+
*/
|
|
3737
|
+
billing_cycle_configuration?: NewFloatingTieredPrice.BillingCycleConfiguration | null;
|
|
3417
3738
|
/**
|
|
3418
3739
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3419
3740
|
*/
|
|
@@ -3431,6 +3752,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3431
3752
|
* The property used to group this price on an invoice
|
|
3432
3753
|
*/
|
|
3433
3754
|
invoice_grouping_key?: string | null;
|
|
3755
|
+
/**
|
|
3756
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3757
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3758
|
+
*/
|
|
3759
|
+
invoicing_cycle_configuration?: NewFloatingTieredPrice.InvoicingCycleConfiguration | null;
|
|
3434
3760
|
/**
|
|
3435
3761
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3436
3762
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3461,6 +3787,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3461
3787
|
last_unit?: number | null;
|
|
3462
3788
|
}
|
|
3463
3789
|
}
|
|
3790
|
+
/**
|
|
3791
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3792
|
+
* months.
|
|
3793
|
+
*/
|
|
3794
|
+
interface BillingCycleConfiguration {
|
|
3795
|
+
/**
|
|
3796
|
+
* The duration of the billing period.
|
|
3797
|
+
*/
|
|
3798
|
+
duration: number;
|
|
3799
|
+
/**
|
|
3800
|
+
* The unit of billing period duration.
|
|
3801
|
+
*/
|
|
3802
|
+
duration_unit: 'day' | 'month';
|
|
3803
|
+
}
|
|
3804
|
+
/**
|
|
3805
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3806
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3807
|
+
*/
|
|
3808
|
+
interface InvoicingCycleConfiguration {
|
|
3809
|
+
/**
|
|
3810
|
+
* The duration of the billing period.
|
|
3811
|
+
*/
|
|
3812
|
+
duration: number;
|
|
3813
|
+
/**
|
|
3814
|
+
* The unit of billing period duration.
|
|
3815
|
+
*/
|
|
3816
|
+
duration_unit: 'day' | 'month';
|
|
3817
|
+
}
|
|
3464
3818
|
}
|
|
3465
3819
|
interface NewFloatingTieredBpsPrice {
|
|
3466
3820
|
/**
|
|
@@ -3491,6 +3845,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3491
3845
|
* this is true, and in-arrears if this is false.
|
|
3492
3846
|
*/
|
|
3493
3847
|
billed_in_advance?: boolean | null;
|
|
3848
|
+
/**
|
|
3849
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3850
|
+
* months.
|
|
3851
|
+
*/
|
|
3852
|
+
billing_cycle_configuration?: NewFloatingTieredBpsPrice.BillingCycleConfiguration | null;
|
|
3494
3853
|
/**
|
|
3495
3854
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3496
3855
|
*/
|
|
@@ -3508,6 +3867,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3508
3867
|
* The property used to group this price on an invoice
|
|
3509
3868
|
*/
|
|
3510
3869
|
invoice_grouping_key?: string | null;
|
|
3870
|
+
/**
|
|
3871
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3872
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3873
|
+
*/
|
|
3874
|
+
invoicing_cycle_configuration?: NewFloatingTieredBpsPrice.InvoicingCycleConfiguration | null;
|
|
3511
3875
|
/**
|
|
3512
3876
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3513
3877
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3543,6 +3907,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3543
3907
|
per_unit_maximum?: string | null;
|
|
3544
3908
|
}
|
|
3545
3909
|
}
|
|
3910
|
+
/**
|
|
3911
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3912
|
+
* months.
|
|
3913
|
+
*/
|
|
3914
|
+
interface BillingCycleConfiguration {
|
|
3915
|
+
/**
|
|
3916
|
+
* The duration of the billing period.
|
|
3917
|
+
*/
|
|
3918
|
+
duration: number;
|
|
3919
|
+
/**
|
|
3920
|
+
* The unit of billing period duration.
|
|
3921
|
+
*/
|
|
3922
|
+
duration_unit: 'day' | 'month';
|
|
3923
|
+
}
|
|
3924
|
+
/**
|
|
3925
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3926
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3927
|
+
*/
|
|
3928
|
+
interface InvoicingCycleConfiguration {
|
|
3929
|
+
/**
|
|
3930
|
+
* The duration of the billing period.
|
|
3931
|
+
*/
|
|
3932
|
+
duration: number;
|
|
3933
|
+
/**
|
|
3934
|
+
* The unit of billing period duration.
|
|
3935
|
+
*/
|
|
3936
|
+
duration_unit: 'day' | 'month';
|
|
3937
|
+
}
|
|
3546
3938
|
}
|
|
3547
3939
|
interface NewFloatingBpsPrice {
|
|
3548
3940
|
bps_config: NewFloatingBpsPrice.BpsConfig;
|
|
@@ -3573,6 +3965,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3573
3965
|
* this is true, and in-arrears if this is false.
|
|
3574
3966
|
*/
|
|
3575
3967
|
billed_in_advance?: boolean | null;
|
|
3968
|
+
/**
|
|
3969
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3970
|
+
* months.
|
|
3971
|
+
*/
|
|
3972
|
+
billing_cycle_configuration?: NewFloatingBpsPrice.BillingCycleConfiguration | null;
|
|
3576
3973
|
/**
|
|
3577
3974
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3578
3975
|
*/
|
|
@@ -3590,6 +3987,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3590
3987
|
* The property used to group this price on an invoice
|
|
3591
3988
|
*/
|
|
3592
3989
|
invoice_grouping_key?: string | null;
|
|
3990
|
+
/**
|
|
3991
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3992
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3993
|
+
*/
|
|
3994
|
+
invoicing_cycle_configuration?: NewFloatingBpsPrice.InvoicingCycleConfiguration | null;
|
|
3593
3995
|
/**
|
|
3594
3996
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3595
3997
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3608,6 +4010,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3608
4010
|
*/
|
|
3609
4011
|
per_unit_maximum?: string | null;
|
|
3610
4012
|
}
|
|
4013
|
+
/**
|
|
4014
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4015
|
+
* months.
|
|
4016
|
+
*/
|
|
4017
|
+
interface BillingCycleConfiguration {
|
|
4018
|
+
/**
|
|
4019
|
+
* The duration of the billing period.
|
|
4020
|
+
*/
|
|
4021
|
+
duration: number;
|
|
4022
|
+
/**
|
|
4023
|
+
* The unit of billing period duration.
|
|
4024
|
+
*/
|
|
4025
|
+
duration_unit: 'day' | 'month';
|
|
4026
|
+
}
|
|
4027
|
+
/**
|
|
4028
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4029
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4030
|
+
*/
|
|
4031
|
+
interface InvoicingCycleConfiguration {
|
|
4032
|
+
/**
|
|
4033
|
+
* The duration of the billing period.
|
|
4034
|
+
*/
|
|
4035
|
+
duration: number;
|
|
4036
|
+
/**
|
|
4037
|
+
* The unit of billing period duration.
|
|
4038
|
+
*/
|
|
4039
|
+
duration_unit: 'day' | 'month';
|
|
4040
|
+
}
|
|
3611
4041
|
}
|
|
3612
4042
|
interface NewFloatingBulkBpsPrice {
|
|
3613
4043
|
bulk_bps_config: NewFloatingBulkBpsPrice.BulkBpsConfig;
|
|
@@ -3638,6 +4068,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3638
4068
|
* this is true, and in-arrears if this is false.
|
|
3639
4069
|
*/
|
|
3640
4070
|
billed_in_advance?: boolean | null;
|
|
4071
|
+
/**
|
|
4072
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4073
|
+
* months.
|
|
4074
|
+
*/
|
|
4075
|
+
billing_cycle_configuration?: NewFloatingBulkBpsPrice.BillingCycleConfiguration | null;
|
|
3641
4076
|
/**
|
|
3642
4077
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3643
4078
|
*/
|
|
@@ -3655,6 +4090,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3655
4090
|
* The property used to group this price on an invoice
|
|
3656
4091
|
*/
|
|
3657
4092
|
invoice_grouping_key?: string | null;
|
|
4093
|
+
/**
|
|
4094
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4095
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4096
|
+
*/
|
|
4097
|
+
invoicing_cycle_configuration?: NewFloatingBulkBpsPrice.InvoicingCycleConfiguration | null;
|
|
3658
4098
|
/**
|
|
3659
4099
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3660
4100
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3686,6 +4126,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3686
4126
|
per_unit_maximum?: string | null;
|
|
3687
4127
|
}
|
|
3688
4128
|
}
|
|
4129
|
+
/**
|
|
4130
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4131
|
+
* months.
|
|
4132
|
+
*/
|
|
4133
|
+
interface BillingCycleConfiguration {
|
|
4134
|
+
/**
|
|
4135
|
+
* The duration of the billing period.
|
|
4136
|
+
*/
|
|
4137
|
+
duration: number;
|
|
4138
|
+
/**
|
|
4139
|
+
* The unit of billing period duration.
|
|
4140
|
+
*/
|
|
4141
|
+
duration_unit: 'day' | 'month';
|
|
4142
|
+
}
|
|
4143
|
+
/**
|
|
4144
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4145
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4146
|
+
*/
|
|
4147
|
+
interface InvoicingCycleConfiguration {
|
|
4148
|
+
/**
|
|
4149
|
+
* The duration of the billing period.
|
|
4150
|
+
*/
|
|
4151
|
+
duration: number;
|
|
4152
|
+
/**
|
|
4153
|
+
* The unit of billing period duration.
|
|
4154
|
+
*/
|
|
4155
|
+
duration_unit: 'day' | 'month';
|
|
4156
|
+
}
|
|
3689
4157
|
}
|
|
3690
4158
|
interface NewFloatingBulkPrice {
|
|
3691
4159
|
bulk_config: NewFloatingBulkPrice.BulkConfig;
|
|
@@ -3716,6 +4184,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3716
4184
|
* this is true, and in-arrears if this is false.
|
|
3717
4185
|
*/
|
|
3718
4186
|
billed_in_advance?: boolean | null;
|
|
4187
|
+
/**
|
|
4188
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4189
|
+
* months.
|
|
4190
|
+
*/
|
|
4191
|
+
billing_cycle_configuration?: NewFloatingBulkPrice.BillingCycleConfiguration | null;
|
|
3719
4192
|
/**
|
|
3720
4193
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3721
4194
|
*/
|
|
@@ -3733,6 +4206,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3733
4206
|
* The property used to group this price on an invoice
|
|
3734
4207
|
*/
|
|
3735
4208
|
invoice_grouping_key?: string | null;
|
|
4209
|
+
/**
|
|
4210
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4211
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4212
|
+
*/
|
|
4213
|
+
invoicing_cycle_configuration?: NewFloatingBulkPrice.InvoicingCycleConfiguration | null;
|
|
3736
4214
|
/**
|
|
3737
4215
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3738
4216
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3759,6 +4237,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3759
4237
|
maximum_units?: number | null;
|
|
3760
4238
|
}
|
|
3761
4239
|
}
|
|
4240
|
+
/**
|
|
4241
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4242
|
+
* months.
|
|
4243
|
+
*/
|
|
4244
|
+
interface BillingCycleConfiguration {
|
|
4245
|
+
/**
|
|
4246
|
+
* The duration of the billing period.
|
|
4247
|
+
*/
|
|
4248
|
+
duration: number;
|
|
4249
|
+
/**
|
|
4250
|
+
* The unit of billing period duration.
|
|
4251
|
+
*/
|
|
4252
|
+
duration_unit: 'day' | 'month';
|
|
4253
|
+
}
|
|
4254
|
+
/**
|
|
4255
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4256
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4257
|
+
*/
|
|
4258
|
+
interface InvoicingCycleConfiguration {
|
|
4259
|
+
/**
|
|
4260
|
+
* The duration of the billing period.
|
|
4261
|
+
*/
|
|
4262
|
+
duration: number;
|
|
4263
|
+
/**
|
|
4264
|
+
* The unit of billing period duration.
|
|
4265
|
+
*/
|
|
4266
|
+
duration_unit: 'day' | 'month';
|
|
4267
|
+
}
|
|
3762
4268
|
}
|
|
3763
4269
|
interface NewFloatingThresholdTotalAmountPrice {
|
|
3764
4270
|
/**
|
|
@@ -3789,6 +4295,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3789
4295
|
* this is true, and in-arrears if this is false.
|
|
3790
4296
|
*/
|
|
3791
4297
|
billed_in_advance?: boolean | null;
|
|
4298
|
+
/**
|
|
4299
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4300
|
+
* months.
|
|
4301
|
+
*/
|
|
4302
|
+
billing_cycle_configuration?: NewFloatingThresholdTotalAmountPrice.BillingCycleConfiguration | null;
|
|
3792
4303
|
/**
|
|
3793
4304
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3794
4305
|
*/
|
|
@@ -3806,6 +4317,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3806
4317
|
* The property used to group this price on an invoice
|
|
3807
4318
|
*/
|
|
3808
4319
|
invoice_grouping_key?: string | null;
|
|
4320
|
+
/**
|
|
4321
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4322
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4323
|
+
*/
|
|
4324
|
+
invoicing_cycle_configuration?: NewFloatingThresholdTotalAmountPrice.InvoicingCycleConfiguration | null;
|
|
3809
4325
|
/**
|
|
3810
4326
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3811
4327
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3813,6 +4329,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3813
4329
|
*/
|
|
3814
4330
|
metadata?: Record<string, string | null> | null;
|
|
3815
4331
|
}
|
|
4332
|
+
namespace NewFloatingThresholdTotalAmountPrice {
|
|
4333
|
+
/**
|
|
4334
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4335
|
+
* months.
|
|
4336
|
+
*/
|
|
4337
|
+
interface BillingCycleConfiguration {
|
|
4338
|
+
/**
|
|
4339
|
+
* The duration of the billing period.
|
|
4340
|
+
*/
|
|
4341
|
+
duration: number;
|
|
4342
|
+
/**
|
|
4343
|
+
* The unit of billing period duration.
|
|
4344
|
+
*/
|
|
4345
|
+
duration_unit: 'day' | 'month';
|
|
4346
|
+
}
|
|
4347
|
+
/**
|
|
4348
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4349
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4350
|
+
*/
|
|
4351
|
+
interface InvoicingCycleConfiguration {
|
|
4352
|
+
/**
|
|
4353
|
+
* The duration of the billing period.
|
|
4354
|
+
*/
|
|
4355
|
+
duration: number;
|
|
4356
|
+
/**
|
|
4357
|
+
* The unit of billing period duration.
|
|
4358
|
+
*/
|
|
4359
|
+
duration_unit: 'day' | 'month';
|
|
4360
|
+
}
|
|
4361
|
+
}
|
|
3816
4362
|
interface NewFloatingTieredPackagePrice {
|
|
3817
4363
|
/**
|
|
3818
4364
|
* The cadence to bill for this price on.
|
|
@@ -3842,6 +4388,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3842
4388
|
* this is true, and in-arrears if this is false.
|
|
3843
4389
|
*/
|
|
3844
4390
|
billed_in_advance?: boolean | null;
|
|
4391
|
+
/**
|
|
4392
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4393
|
+
* months.
|
|
4394
|
+
*/
|
|
4395
|
+
billing_cycle_configuration?: NewFloatingTieredPackagePrice.BillingCycleConfiguration | null;
|
|
3845
4396
|
/**
|
|
3846
4397
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3847
4398
|
*/
|
|
@@ -3859,6 +4410,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3859
4410
|
* The property used to group this price on an invoice
|
|
3860
4411
|
*/
|
|
3861
4412
|
invoice_grouping_key?: string | null;
|
|
4413
|
+
/**
|
|
4414
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4415
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4416
|
+
*/
|
|
4417
|
+
invoicing_cycle_configuration?: NewFloatingTieredPackagePrice.InvoicingCycleConfiguration | null;
|
|
3862
4418
|
/**
|
|
3863
4419
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3864
4420
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3866,6 +4422,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3866
4422
|
*/
|
|
3867
4423
|
metadata?: Record<string, string | null> | null;
|
|
3868
4424
|
}
|
|
4425
|
+
namespace NewFloatingTieredPackagePrice {
|
|
4426
|
+
/**
|
|
4427
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4428
|
+
* months.
|
|
4429
|
+
*/
|
|
4430
|
+
interface BillingCycleConfiguration {
|
|
4431
|
+
/**
|
|
4432
|
+
* The duration of the billing period.
|
|
4433
|
+
*/
|
|
4434
|
+
duration: number;
|
|
4435
|
+
/**
|
|
4436
|
+
* The unit of billing period duration.
|
|
4437
|
+
*/
|
|
4438
|
+
duration_unit: 'day' | 'month';
|
|
4439
|
+
}
|
|
4440
|
+
/**
|
|
4441
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4442
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4443
|
+
*/
|
|
4444
|
+
interface InvoicingCycleConfiguration {
|
|
4445
|
+
/**
|
|
4446
|
+
* The duration of the billing period.
|
|
4447
|
+
*/
|
|
4448
|
+
duration: number;
|
|
4449
|
+
/**
|
|
4450
|
+
* The unit of billing period duration.
|
|
4451
|
+
*/
|
|
4452
|
+
duration_unit: 'day' | 'month';
|
|
4453
|
+
}
|
|
4454
|
+
}
|
|
3869
4455
|
interface NewFloatingGroupedTieredPrice {
|
|
3870
4456
|
/**
|
|
3871
4457
|
* The cadence to bill for this price on.
|
|
@@ -3895,6 +4481,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3895
4481
|
* this is true, and in-arrears if this is false.
|
|
3896
4482
|
*/
|
|
3897
4483
|
billed_in_advance?: boolean | null;
|
|
4484
|
+
/**
|
|
4485
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4486
|
+
* months.
|
|
4487
|
+
*/
|
|
4488
|
+
billing_cycle_configuration?: NewFloatingGroupedTieredPrice.BillingCycleConfiguration | null;
|
|
3898
4489
|
/**
|
|
3899
4490
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3900
4491
|
*/
|
|
@@ -3912,6 +4503,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3912
4503
|
* The property used to group this price on an invoice
|
|
3913
4504
|
*/
|
|
3914
4505
|
invoice_grouping_key?: string | null;
|
|
4506
|
+
/**
|
|
4507
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4508
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4509
|
+
*/
|
|
4510
|
+
invoicing_cycle_configuration?: NewFloatingGroupedTieredPrice.InvoicingCycleConfiguration | null;
|
|
3915
4511
|
/**
|
|
3916
4512
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3917
4513
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3919,6 +4515,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3919
4515
|
*/
|
|
3920
4516
|
metadata?: Record<string, string | null> | null;
|
|
3921
4517
|
}
|
|
4518
|
+
namespace NewFloatingGroupedTieredPrice {
|
|
4519
|
+
/**
|
|
4520
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4521
|
+
* months.
|
|
4522
|
+
*/
|
|
4523
|
+
interface BillingCycleConfiguration {
|
|
4524
|
+
/**
|
|
4525
|
+
* The duration of the billing period.
|
|
4526
|
+
*/
|
|
4527
|
+
duration: number;
|
|
4528
|
+
/**
|
|
4529
|
+
* The unit of billing period duration.
|
|
4530
|
+
*/
|
|
4531
|
+
duration_unit: 'day' | 'month';
|
|
4532
|
+
}
|
|
4533
|
+
/**
|
|
4534
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4535
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4536
|
+
*/
|
|
4537
|
+
interface InvoicingCycleConfiguration {
|
|
4538
|
+
/**
|
|
4539
|
+
* The duration of the billing period.
|
|
4540
|
+
*/
|
|
4541
|
+
duration: number;
|
|
4542
|
+
/**
|
|
4543
|
+
* The unit of billing period duration.
|
|
4544
|
+
*/
|
|
4545
|
+
duration_unit: 'day' | 'month';
|
|
4546
|
+
}
|
|
4547
|
+
}
|
|
3922
4548
|
interface NewFloatingTieredWithMinimumPrice {
|
|
3923
4549
|
/**
|
|
3924
4550
|
* The cadence to bill for this price on.
|
|
@@ -3948,6 +4574,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3948
4574
|
* this is true, and in-arrears if this is false.
|
|
3949
4575
|
*/
|
|
3950
4576
|
billed_in_advance?: boolean | null;
|
|
4577
|
+
/**
|
|
4578
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4579
|
+
* months.
|
|
4580
|
+
*/
|
|
4581
|
+
billing_cycle_configuration?: NewFloatingTieredWithMinimumPrice.BillingCycleConfiguration | null;
|
|
3951
4582
|
/**
|
|
3952
4583
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3953
4584
|
*/
|
|
@@ -3965,6 +4596,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3965
4596
|
* The property used to group this price on an invoice
|
|
3966
4597
|
*/
|
|
3967
4598
|
invoice_grouping_key?: string | null;
|
|
4599
|
+
/**
|
|
4600
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4601
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4602
|
+
*/
|
|
4603
|
+
invoicing_cycle_configuration?: NewFloatingTieredWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
3968
4604
|
/**
|
|
3969
4605
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3970
4606
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3972,6 +4608,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3972
4608
|
*/
|
|
3973
4609
|
metadata?: Record<string, string | null> | null;
|
|
3974
4610
|
}
|
|
4611
|
+
namespace NewFloatingTieredWithMinimumPrice {
|
|
4612
|
+
/**
|
|
4613
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4614
|
+
* months.
|
|
4615
|
+
*/
|
|
4616
|
+
interface BillingCycleConfiguration {
|
|
4617
|
+
/**
|
|
4618
|
+
* The duration of the billing period.
|
|
4619
|
+
*/
|
|
4620
|
+
duration: number;
|
|
4621
|
+
/**
|
|
4622
|
+
* The unit of billing period duration.
|
|
4623
|
+
*/
|
|
4624
|
+
duration_unit: 'day' | 'month';
|
|
4625
|
+
}
|
|
4626
|
+
/**
|
|
4627
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4628
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4629
|
+
*/
|
|
4630
|
+
interface InvoicingCycleConfiguration {
|
|
4631
|
+
/**
|
|
4632
|
+
* The duration of the billing period.
|
|
4633
|
+
*/
|
|
4634
|
+
duration: number;
|
|
4635
|
+
/**
|
|
4636
|
+
* The unit of billing period duration.
|
|
4637
|
+
*/
|
|
4638
|
+
duration_unit: 'day' | 'month';
|
|
4639
|
+
}
|
|
4640
|
+
}
|
|
3975
4641
|
interface NewFloatingPackageWithAllocationPrice {
|
|
3976
4642
|
/**
|
|
3977
4643
|
* The cadence to bill for this price on.
|
|
@@ -4001,6 +4667,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4001
4667
|
* this is true, and in-arrears if this is false.
|
|
4002
4668
|
*/
|
|
4003
4669
|
billed_in_advance?: boolean | null;
|
|
4670
|
+
/**
|
|
4671
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4672
|
+
* months.
|
|
4673
|
+
*/
|
|
4674
|
+
billing_cycle_configuration?: NewFloatingPackageWithAllocationPrice.BillingCycleConfiguration | null;
|
|
4004
4675
|
/**
|
|
4005
4676
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4006
4677
|
*/
|
|
@@ -4018,6 +4689,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4018
4689
|
* The property used to group this price on an invoice
|
|
4019
4690
|
*/
|
|
4020
4691
|
invoice_grouping_key?: string | null;
|
|
4692
|
+
/**
|
|
4693
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4694
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4695
|
+
*/
|
|
4696
|
+
invoicing_cycle_configuration?: NewFloatingPackageWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
4021
4697
|
/**
|
|
4022
4698
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4023
4699
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4025,6 +4701,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4025
4701
|
*/
|
|
4026
4702
|
metadata?: Record<string, string | null> | null;
|
|
4027
4703
|
}
|
|
4704
|
+
namespace NewFloatingPackageWithAllocationPrice {
|
|
4705
|
+
/**
|
|
4706
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4707
|
+
* months.
|
|
4708
|
+
*/
|
|
4709
|
+
interface BillingCycleConfiguration {
|
|
4710
|
+
/**
|
|
4711
|
+
* The duration of the billing period.
|
|
4712
|
+
*/
|
|
4713
|
+
duration: number;
|
|
4714
|
+
/**
|
|
4715
|
+
* The unit of billing period duration.
|
|
4716
|
+
*/
|
|
4717
|
+
duration_unit: 'day' | 'month';
|
|
4718
|
+
}
|
|
4719
|
+
/**
|
|
4720
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4721
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4722
|
+
*/
|
|
4723
|
+
interface InvoicingCycleConfiguration {
|
|
4724
|
+
/**
|
|
4725
|
+
* The duration of the billing period.
|
|
4726
|
+
*/
|
|
4727
|
+
duration: number;
|
|
4728
|
+
/**
|
|
4729
|
+
* The unit of billing period duration.
|
|
4730
|
+
*/
|
|
4731
|
+
duration_unit: 'day' | 'month';
|
|
4732
|
+
}
|
|
4733
|
+
}
|
|
4028
4734
|
interface NewFloatingTieredPackageWithMinimumPrice {
|
|
4029
4735
|
/**
|
|
4030
4736
|
* The cadence to bill for this price on.
|
|
@@ -4054,6 +4760,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4054
4760
|
* this is true, and in-arrears if this is false.
|
|
4055
4761
|
*/
|
|
4056
4762
|
billed_in_advance?: boolean | null;
|
|
4763
|
+
/**
|
|
4764
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4765
|
+
* months.
|
|
4766
|
+
*/
|
|
4767
|
+
billing_cycle_configuration?: NewFloatingTieredPackageWithMinimumPrice.BillingCycleConfiguration | null;
|
|
4057
4768
|
/**
|
|
4058
4769
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4059
4770
|
*/
|
|
@@ -4071,6 +4782,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4071
4782
|
* The property used to group this price on an invoice
|
|
4072
4783
|
*/
|
|
4073
4784
|
invoice_grouping_key?: string | null;
|
|
4785
|
+
/**
|
|
4786
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4787
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4788
|
+
*/
|
|
4789
|
+
invoicing_cycle_configuration?: NewFloatingTieredPackageWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
4074
4790
|
/**
|
|
4075
4791
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4076
4792
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4078,6 +4794,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4078
4794
|
*/
|
|
4079
4795
|
metadata?: Record<string, string | null> | null;
|
|
4080
4796
|
}
|
|
4797
|
+
namespace NewFloatingTieredPackageWithMinimumPrice {
|
|
4798
|
+
/**
|
|
4799
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4800
|
+
* months.
|
|
4801
|
+
*/
|
|
4802
|
+
interface BillingCycleConfiguration {
|
|
4803
|
+
/**
|
|
4804
|
+
* The duration of the billing period.
|
|
4805
|
+
*/
|
|
4806
|
+
duration: number;
|
|
4807
|
+
/**
|
|
4808
|
+
* The unit of billing period duration.
|
|
4809
|
+
*/
|
|
4810
|
+
duration_unit: 'day' | 'month';
|
|
4811
|
+
}
|
|
4812
|
+
/**
|
|
4813
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4814
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4815
|
+
*/
|
|
4816
|
+
interface InvoicingCycleConfiguration {
|
|
4817
|
+
/**
|
|
4818
|
+
* The duration of the billing period.
|
|
4819
|
+
*/
|
|
4820
|
+
duration: number;
|
|
4821
|
+
/**
|
|
4822
|
+
* The unit of billing period duration.
|
|
4823
|
+
*/
|
|
4824
|
+
duration_unit: 'day' | 'month';
|
|
4825
|
+
}
|
|
4826
|
+
}
|
|
4081
4827
|
interface NewFloatingUnitWithPercentPrice {
|
|
4082
4828
|
/**
|
|
4083
4829
|
* The cadence to bill for this price on.
|
|
@@ -4107,6 +4853,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4107
4853
|
* this is true, and in-arrears if this is false.
|
|
4108
4854
|
*/
|
|
4109
4855
|
billed_in_advance?: boolean | null;
|
|
4856
|
+
/**
|
|
4857
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4858
|
+
* months.
|
|
4859
|
+
*/
|
|
4860
|
+
billing_cycle_configuration?: NewFloatingUnitWithPercentPrice.BillingCycleConfiguration | null;
|
|
4110
4861
|
/**
|
|
4111
4862
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4112
4863
|
*/
|
|
@@ -4124,6 +4875,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4124
4875
|
* The property used to group this price on an invoice
|
|
4125
4876
|
*/
|
|
4126
4877
|
invoice_grouping_key?: string | null;
|
|
4878
|
+
/**
|
|
4879
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4880
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4881
|
+
*/
|
|
4882
|
+
invoicing_cycle_configuration?: NewFloatingUnitWithPercentPrice.InvoicingCycleConfiguration | null;
|
|
4127
4883
|
/**
|
|
4128
4884
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4129
4885
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4131,6 +4887,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4131
4887
|
*/
|
|
4132
4888
|
metadata?: Record<string, string | null> | null;
|
|
4133
4889
|
}
|
|
4890
|
+
namespace NewFloatingUnitWithPercentPrice {
|
|
4891
|
+
/**
|
|
4892
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4893
|
+
* months.
|
|
4894
|
+
*/
|
|
4895
|
+
interface BillingCycleConfiguration {
|
|
4896
|
+
/**
|
|
4897
|
+
* The duration of the billing period.
|
|
4898
|
+
*/
|
|
4899
|
+
duration: number;
|
|
4900
|
+
/**
|
|
4901
|
+
* The unit of billing period duration.
|
|
4902
|
+
*/
|
|
4903
|
+
duration_unit: 'day' | 'month';
|
|
4904
|
+
}
|
|
4905
|
+
/**
|
|
4906
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4907
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4908
|
+
*/
|
|
4909
|
+
interface InvoicingCycleConfiguration {
|
|
4910
|
+
/**
|
|
4911
|
+
* The duration of the billing period.
|
|
4912
|
+
*/
|
|
4913
|
+
duration: number;
|
|
4914
|
+
/**
|
|
4915
|
+
* The unit of billing period duration.
|
|
4916
|
+
*/
|
|
4917
|
+
duration_unit: 'day' | 'month';
|
|
4918
|
+
}
|
|
4919
|
+
}
|
|
4134
4920
|
interface NewFloatingTieredWithProrationPrice {
|
|
4135
4921
|
/**
|
|
4136
4922
|
* The cadence to bill for this price on.
|
|
@@ -4160,6 +4946,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4160
4946
|
* this is true, and in-arrears if this is false.
|
|
4161
4947
|
*/
|
|
4162
4948
|
billed_in_advance?: boolean | null;
|
|
4949
|
+
/**
|
|
4950
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4951
|
+
* months.
|
|
4952
|
+
*/
|
|
4953
|
+
billing_cycle_configuration?: NewFloatingTieredWithProrationPrice.BillingCycleConfiguration | null;
|
|
4163
4954
|
/**
|
|
4164
4955
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4165
4956
|
*/
|
|
@@ -4177,6 +4968,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4177
4968
|
* The property used to group this price on an invoice
|
|
4178
4969
|
*/
|
|
4179
4970
|
invoice_grouping_key?: string | null;
|
|
4971
|
+
/**
|
|
4972
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4973
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4974
|
+
*/
|
|
4975
|
+
invoicing_cycle_configuration?: NewFloatingTieredWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
4180
4976
|
/**
|
|
4181
4977
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4182
4978
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4184,6 +4980,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4184
4980
|
*/
|
|
4185
4981
|
metadata?: Record<string, string | null> | null;
|
|
4186
4982
|
}
|
|
4983
|
+
namespace NewFloatingTieredWithProrationPrice {
|
|
4984
|
+
/**
|
|
4985
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4986
|
+
* months.
|
|
4987
|
+
*/
|
|
4988
|
+
interface BillingCycleConfiguration {
|
|
4989
|
+
/**
|
|
4990
|
+
* The duration of the billing period.
|
|
4991
|
+
*/
|
|
4992
|
+
duration: number;
|
|
4993
|
+
/**
|
|
4994
|
+
* The unit of billing period duration.
|
|
4995
|
+
*/
|
|
4996
|
+
duration_unit: 'day' | 'month';
|
|
4997
|
+
}
|
|
4998
|
+
/**
|
|
4999
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5000
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5001
|
+
*/
|
|
5002
|
+
interface InvoicingCycleConfiguration {
|
|
5003
|
+
/**
|
|
5004
|
+
* The duration of the billing period.
|
|
5005
|
+
*/
|
|
5006
|
+
duration: number;
|
|
5007
|
+
/**
|
|
5008
|
+
* The unit of billing period duration.
|
|
5009
|
+
*/
|
|
5010
|
+
duration_unit: 'day' | 'month';
|
|
5011
|
+
}
|
|
5012
|
+
}
|
|
4187
5013
|
interface NewFloatingUnitWithProrationPrice {
|
|
4188
5014
|
/**
|
|
4189
5015
|
* The cadence to bill for this price on.
|
|
@@ -4213,6 +5039,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4213
5039
|
* this is true, and in-arrears if this is false.
|
|
4214
5040
|
*/
|
|
4215
5041
|
billed_in_advance?: boolean | null;
|
|
5042
|
+
/**
|
|
5043
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5044
|
+
* months.
|
|
5045
|
+
*/
|
|
5046
|
+
billing_cycle_configuration?: NewFloatingUnitWithProrationPrice.BillingCycleConfiguration | null;
|
|
4216
5047
|
/**
|
|
4217
5048
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4218
5049
|
*/
|
|
@@ -4230,6 +5061,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4230
5061
|
* The property used to group this price on an invoice
|
|
4231
5062
|
*/
|
|
4232
5063
|
invoice_grouping_key?: string | null;
|
|
5064
|
+
/**
|
|
5065
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5066
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5067
|
+
*/
|
|
5068
|
+
invoicing_cycle_configuration?: NewFloatingUnitWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
4233
5069
|
/**
|
|
4234
5070
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4235
5071
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4237,6 +5073,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4237
5073
|
*/
|
|
4238
5074
|
metadata?: Record<string, string | null> | null;
|
|
4239
5075
|
}
|
|
5076
|
+
namespace NewFloatingUnitWithProrationPrice {
|
|
5077
|
+
/**
|
|
5078
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5079
|
+
* months.
|
|
5080
|
+
*/
|
|
5081
|
+
interface BillingCycleConfiguration {
|
|
5082
|
+
/**
|
|
5083
|
+
* The duration of the billing period.
|
|
5084
|
+
*/
|
|
5085
|
+
duration: number;
|
|
5086
|
+
/**
|
|
5087
|
+
* The unit of billing period duration.
|
|
5088
|
+
*/
|
|
5089
|
+
duration_unit: 'day' | 'month';
|
|
5090
|
+
}
|
|
5091
|
+
/**
|
|
5092
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5093
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5094
|
+
*/
|
|
5095
|
+
interface InvoicingCycleConfiguration {
|
|
5096
|
+
/**
|
|
5097
|
+
* The duration of the billing period.
|
|
5098
|
+
*/
|
|
5099
|
+
duration: number;
|
|
5100
|
+
/**
|
|
5101
|
+
* The unit of billing period duration.
|
|
5102
|
+
*/
|
|
5103
|
+
duration_unit: 'day' | 'month';
|
|
5104
|
+
}
|
|
5105
|
+
}
|
|
4240
5106
|
interface NewFloatingGroupedAllocationPrice {
|
|
4241
5107
|
/**
|
|
4242
5108
|
* The cadence to bill for this price on.
|
|
@@ -4266,6 +5132,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4266
5132
|
* this is true, and in-arrears if this is false.
|
|
4267
5133
|
*/
|
|
4268
5134
|
billed_in_advance?: boolean | null;
|
|
5135
|
+
/**
|
|
5136
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5137
|
+
* months.
|
|
5138
|
+
*/
|
|
5139
|
+
billing_cycle_configuration?: NewFloatingGroupedAllocationPrice.BillingCycleConfiguration | null;
|
|
4269
5140
|
/**
|
|
4270
5141
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4271
5142
|
*/
|
|
@@ -4283,6 +5154,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4283
5154
|
* The property used to group this price on an invoice
|
|
4284
5155
|
*/
|
|
4285
5156
|
invoice_grouping_key?: string | null;
|
|
5157
|
+
/**
|
|
5158
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5159
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5160
|
+
*/
|
|
5161
|
+
invoicing_cycle_configuration?: NewFloatingGroupedAllocationPrice.InvoicingCycleConfiguration | null;
|
|
4286
5162
|
/**
|
|
4287
5163
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4288
5164
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4290,6 +5166,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4290
5166
|
*/
|
|
4291
5167
|
metadata?: Record<string, string | null> | null;
|
|
4292
5168
|
}
|
|
5169
|
+
namespace NewFloatingGroupedAllocationPrice {
|
|
5170
|
+
/**
|
|
5171
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5172
|
+
* months.
|
|
5173
|
+
*/
|
|
5174
|
+
interface BillingCycleConfiguration {
|
|
5175
|
+
/**
|
|
5176
|
+
* The duration of the billing period.
|
|
5177
|
+
*/
|
|
5178
|
+
duration: number;
|
|
5179
|
+
/**
|
|
5180
|
+
* The unit of billing period duration.
|
|
5181
|
+
*/
|
|
5182
|
+
duration_unit: 'day' | 'month';
|
|
5183
|
+
}
|
|
5184
|
+
/**
|
|
5185
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5186
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5187
|
+
*/
|
|
5188
|
+
interface InvoicingCycleConfiguration {
|
|
5189
|
+
/**
|
|
5190
|
+
* The duration of the billing period.
|
|
5191
|
+
*/
|
|
5192
|
+
duration: number;
|
|
5193
|
+
/**
|
|
5194
|
+
* The unit of billing period duration.
|
|
5195
|
+
*/
|
|
5196
|
+
duration_unit: 'day' | 'month';
|
|
5197
|
+
}
|
|
5198
|
+
}
|
|
4293
5199
|
interface NewFloatingBulkWithProrationPrice {
|
|
4294
5200
|
bulk_with_proration_config: Record<string, unknown>;
|
|
4295
5201
|
/**
|
|
@@ -4319,6 +5225,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4319
5225
|
* this is true, and in-arrears if this is false.
|
|
4320
5226
|
*/
|
|
4321
5227
|
billed_in_advance?: boolean | null;
|
|
5228
|
+
/**
|
|
5229
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5230
|
+
* months.
|
|
5231
|
+
*/
|
|
5232
|
+
billing_cycle_configuration?: NewFloatingBulkWithProrationPrice.BillingCycleConfiguration | null;
|
|
4322
5233
|
/**
|
|
4323
5234
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4324
5235
|
*/
|
|
@@ -4336,6 +5247,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4336
5247
|
* The property used to group this price on an invoice
|
|
4337
5248
|
*/
|
|
4338
5249
|
invoice_grouping_key?: string | null;
|
|
5250
|
+
/**
|
|
5251
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5252
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5253
|
+
*/
|
|
5254
|
+
invoicing_cycle_configuration?: NewFloatingBulkWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
4339
5255
|
/**
|
|
4340
5256
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4341
5257
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4343,6 +5259,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
4343
5259
|
*/
|
|
4344
5260
|
metadata?: Record<string, string | null> | null;
|
|
4345
5261
|
}
|
|
5262
|
+
namespace NewFloatingBulkWithProrationPrice {
|
|
5263
|
+
/**
|
|
5264
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5265
|
+
* months.
|
|
5266
|
+
*/
|
|
5267
|
+
interface BillingCycleConfiguration {
|
|
5268
|
+
/**
|
|
5269
|
+
* The duration of the billing period.
|
|
5270
|
+
*/
|
|
5271
|
+
duration: number;
|
|
5272
|
+
/**
|
|
5273
|
+
* The unit of billing period duration.
|
|
5274
|
+
*/
|
|
5275
|
+
duration_unit: 'day' | 'month';
|
|
5276
|
+
}
|
|
5277
|
+
/**
|
|
5278
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5279
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5280
|
+
*/
|
|
5281
|
+
interface InvoicingCycleConfiguration {
|
|
5282
|
+
/**
|
|
5283
|
+
* The duration of the billing period.
|
|
5284
|
+
*/
|
|
5285
|
+
duration: number;
|
|
5286
|
+
/**
|
|
5287
|
+
* The unit of billing period duration.
|
|
5288
|
+
*/
|
|
5289
|
+
duration_unit: 'day' | 'month';
|
|
5290
|
+
}
|
|
5291
|
+
}
|
|
4346
5292
|
}
|
|
4347
5293
|
interface AddAdjustment {
|
|
4348
5294
|
/**
|
|
@@ -4504,7 +5450,7 @@ export interface SubscriptionSchedulePlanChangeParams {
|
|
|
4504
5450
|
/**
|
|
4505
5451
|
* Optionally provide a list of overrides for prices on the plan
|
|
4506
5452
|
*/
|
|
4507
|
-
price_overrides?: Array<SubscriptionSchedulePlanChangeParams.OverrideUnitPrice | SubscriptionSchedulePlanChangeParams.OverridePackagePrice | SubscriptionSchedulePlanChangeParams.OverrideMatrixPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkPrice | SubscriptionSchedulePlanChangeParams.OverrideThresholdTotalAmountPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPackagePrice | SubscriptionSchedulePlanChangeParams.OverrideTieredWithMinimumPrice | SubscriptionSchedulePlanChangeParams.OverridePackageWithAllocationPrice | SubscriptionSchedulePlanChangeParams.OverrideUnitWithPercentPrice> | null;
|
|
5453
|
+
price_overrides?: Array<SubscriptionSchedulePlanChangeParams.OverrideUnitPrice | SubscriptionSchedulePlanChangeParams.OverridePackagePrice | SubscriptionSchedulePlanChangeParams.OverrideMatrixPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkPrice | SubscriptionSchedulePlanChangeParams.OverrideThresholdTotalAmountPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPackagePrice | SubscriptionSchedulePlanChangeParams.OverrideTieredWithMinimumPrice | SubscriptionSchedulePlanChangeParams.OverridePackageWithAllocationPrice | SubscriptionSchedulePlanChangeParams.OverrideUnitWithPercentPrice | SubscriptionSchedulePlanChangeParams.OverrideGroupedAllocationPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkWithProrationPrice> | null;
|
|
4508
5454
|
}
|
|
4509
5455
|
export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
4510
5456
|
interface OverrideUnitPrice {
|
|
@@ -5445,6 +6391,128 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
5445
6391
|
usage_discount?: number | null;
|
|
5446
6392
|
}
|
|
5447
6393
|
}
|
|
6394
|
+
interface OverrideGroupedAllocationPrice {
|
|
6395
|
+
id: string;
|
|
6396
|
+
grouped_allocation_config: Record<string, unknown>;
|
|
6397
|
+
model_type: 'grouped_allocation';
|
|
6398
|
+
/**
|
|
6399
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
6400
|
+
*/
|
|
6401
|
+
conversion_rate?: number | null;
|
|
6402
|
+
/**
|
|
6403
|
+
* The currency of the price. If not provided, the currency of the plan will be
|
|
6404
|
+
* used.
|
|
6405
|
+
*/
|
|
6406
|
+
currency?: string | null;
|
|
6407
|
+
/**
|
|
6408
|
+
* The subscription's override discount for the plan.
|
|
6409
|
+
*/
|
|
6410
|
+
discount?: OverrideGroupedAllocationPrice.Discount | null;
|
|
6411
|
+
/**
|
|
6412
|
+
* The starting quantity of the price, if the price is a fixed price.
|
|
6413
|
+
*/
|
|
6414
|
+
fixed_price_quantity?: number | null;
|
|
6415
|
+
/**
|
|
6416
|
+
* The subscription's override maximum amount for the plan.
|
|
6417
|
+
*/
|
|
6418
|
+
maximum_amount?: string | null;
|
|
6419
|
+
/**
|
|
6420
|
+
* The subscription's override minimum amount for the plan.
|
|
6421
|
+
*/
|
|
6422
|
+
minimum_amount?: string | null;
|
|
6423
|
+
}
|
|
6424
|
+
namespace OverrideGroupedAllocationPrice {
|
|
6425
|
+
/**
|
|
6426
|
+
* The subscription's override discount for the plan.
|
|
6427
|
+
*/
|
|
6428
|
+
interface Discount {
|
|
6429
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
6430
|
+
/**
|
|
6431
|
+
* Only available if discount_type is `amount`.
|
|
6432
|
+
*/
|
|
6433
|
+
amount_discount?: string | null;
|
|
6434
|
+
/**
|
|
6435
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
6436
|
+
* this can be a subset of prices.
|
|
6437
|
+
*/
|
|
6438
|
+
applies_to_price_ids?: Array<string> | null;
|
|
6439
|
+
/**
|
|
6440
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
6441
|
+
* and 1.
|
|
6442
|
+
*/
|
|
6443
|
+
percentage_discount?: number | null;
|
|
6444
|
+
/**
|
|
6445
|
+
* Only available if discount_type is `trial`
|
|
6446
|
+
*/
|
|
6447
|
+
trial_amount_discount?: string | null;
|
|
6448
|
+
/**
|
|
6449
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
6450
|
+
* discount is for
|
|
6451
|
+
*/
|
|
6452
|
+
usage_discount?: number | null;
|
|
6453
|
+
}
|
|
6454
|
+
}
|
|
6455
|
+
interface OverrideBulkWithProrationPrice {
|
|
6456
|
+
id: string;
|
|
6457
|
+
bulk_with_proration_config: Record<string, unknown>;
|
|
6458
|
+
model_type: 'bulk_with_proration';
|
|
6459
|
+
/**
|
|
6460
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
6461
|
+
*/
|
|
6462
|
+
conversion_rate?: number | null;
|
|
6463
|
+
/**
|
|
6464
|
+
* The currency of the price. If not provided, the currency of the plan will be
|
|
6465
|
+
* used.
|
|
6466
|
+
*/
|
|
6467
|
+
currency?: string | null;
|
|
6468
|
+
/**
|
|
6469
|
+
* The subscription's override discount for the plan.
|
|
6470
|
+
*/
|
|
6471
|
+
discount?: OverrideBulkWithProrationPrice.Discount | null;
|
|
6472
|
+
/**
|
|
6473
|
+
* The starting quantity of the price, if the price is a fixed price.
|
|
6474
|
+
*/
|
|
6475
|
+
fixed_price_quantity?: number | null;
|
|
6476
|
+
/**
|
|
6477
|
+
* The subscription's override maximum amount for the plan.
|
|
6478
|
+
*/
|
|
6479
|
+
maximum_amount?: string | null;
|
|
6480
|
+
/**
|
|
6481
|
+
* The subscription's override minimum amount for the plan.
|
|
6482
|
+
*/
|
|
6483
|
+
minimum_amount?: string | null;
|
|
6484
|
+
}
|
|
6485
|
+
namespace OverrideBulkWithProrationPrice {
|
|
6486
|
+
/**
|
|
6487
|
+
* The subscription's override discount for the plan.
|
|
6488
|
+
*/
|
|
6489
|
+
interface Discount {
|
|
6490
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
6491
|
+
/**
|
|
6492
|
+
* Only available if discount_type is `amount`.
|
|
6493
|
+
*/
|
|
6494
|
+
amount_discount?: string | null;
|
|
6495
|
+
/**
|
|
6496
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
6497
|
+
* this can be a subset of prices.
|
|
6498
|
+
*/
|
|
6499
|
+
applies_to_price_ids?: Array<string> | null;
|
|
6500
|
+
/**
|
|
6501
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
6502
|
+
* and 1.
|
|
6503
|
+
*/
|
|
6504
|
+
percentage_discount?: number | null;
|
|
6505
|
+
/**
|
|
6506
|
+
* Only available if discount_type is `trial`
|
|
6507
|
+
*/
|
|
6508
|
+
trial_amount_discount?: string | null;
|
|
6509
|
+
/**
|
|
6510
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
6511
|
+
* discount is for
|
|
6512
|
+
*/
|
|
6513
|
+
usage_discount?: number | null;
|
|
6514
|
+
}
|
|
6515
|
+
}
|
|
5448
6516
|
}
|
|
5449
6517
|
export interface SubscriptionTriggerPhaseParams {
|
|
5450
6518
|
/**
|