orb-billing 5.5.1 → 5.6.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 +14 -0
- package/index.d.mts +4 -13
- package/index.d.ts +4 -13
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs.map +1 -1
- package/package.json +4 -1
- package/resources/alerts.d.ts +1 -1
- package/resources/beta/beta.d.ts +168 -2
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/external-plan-id.d.ts +168 -2
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/customers/balance-transactions.d.ts +2 -2
- package/resources/customers/balance-transactions.d.ts.map +1 -1
- package/resources/customers/balance-transactions.js.map +1 -1
- package/resources/customers/balance-transactions.mjs.map +1 -1
- package/resources/customers/credits/ledger.d.ts +22 -8
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/customers.d.ts +27 -0
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.js +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.mjs +1 -1
- package/resources/events/backfills.d.ts +2 -2
- package/resources/events/backfills.js +2 -2
- package/resources/events/backfills.mjs +2 -2
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +1 -1
- package/resources/invoices.d.ts +36 -11
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +4 -4
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +4 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/plans/plans.d.ts +84 -1
- 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 +262 -166
- 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/shared.d.ts +216 -615
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.js.map +1 -1
- package/resources/shared.mjs.map +1 -1
- package/resources/subscriptions.d.ts +460 -192
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/index.ts +5 -17
- package/src/resources/alerts.ts +1 -1
- package/src/resources/beta/beta.ts +198 -6
- package/src/resources/beta/external-plan-id.ts +198 -6
- package/src/resources/customers/balance-transactions.ts +4 -2
- package/src/resources/customers/credits/ledger.ts +24 -8
- package/src/resources/customers/customers.ts +31 -0
- package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +1 -1
- package/src/resources/events/backfills.ts +2 -2
- package/src/resources/index.ts +1 -3
- package/src/resources/invoice-line-items.ts +1 -1
- package/src/resources/invoices.ts +41 -11
- package/src/resources/plans/plans.ts +99 -3
- package/src/resources/prices/prices.ts +283 -179
- package/src/resources/shared.ts +260 -747
- package/src/resources/subscriptions.ts +540 -238
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -259,9 +259,6 @@ export type PriceCreateParams =
|
|
|
259
259
|
| PriceCreateParams.NewFloatingMatrixPrice
|
|
260
260
|
| PriceCreateParams.NewFloatingMatrixWithAllocationPrice
|
|
261
261
|
| PriceCreateParams.NewFloatingTieredPrice
|
|
262
|
-
| PriceCreateParams.NewFloatingTieredBPSPrice
|
|
263
|
-
| PriceCreateParams.NewFloatingBPSPrice
|
|
264
|
-
| PriceCreateParams.NewFloatingBulkBPSPrice
|
|
265
262
|
| PriceCreateParams.NewFloatingBulkPrice
|
|
266
263
|
| PriceCreateParams.NewFloatingThresholdTotalAmountPrice
|
|
267
264
|
| PriceCreateParams.NewFloatingTieredPackagePrice
|
|
@@ -281,7 +278,9 @@ export type PriceCreateParams =
|
|
|
281
278
|
| PriceCreateParams.NewFloatingGroupedTieredPackagePrice
|
|
282
279
|
| PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice
|
|
283
280
|
| PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice
|
|
284
|
-
| PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice
|
|
281
|
+
| PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice
|
|
282
|
+
| PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice
|
|
283
|
+
| PriceCreateParams.NewFloatingMinimumCompositePrice;
|
|
285
284
|
|
|
286
285
|
export declare namespace PriceCreateParams {
|
|
287
286
|
export interface NewFloatingUnitPrice {
|
|
@@ -724,7 +723,9 @@ export declare namespace PriceCreateParams {
|
|
|
724
723
|
metadata?: { [key: string]: string | null } | null;
|
|
725
724
|
}
|
|
726
725
|
|
|
727
|
-
export interface
|
|
726
|
+
export interface NewFloatingBulkPrice {
|
|
727
|
+
bulk_config: Shared.BulkConfig;
|
|
728
|
+
|
|
728
729
|
/**
|
|
729
730
|
* The cadence to bill for this price on.
|
|
730
731
|
*/
|
|
@@ -740,15 +741,13 @@ export declare namespace PriceCreateParams {
|
|
|
740
741
|
*/
|
|
741
742
|
item_id: string;
|
|
742
743
|
|
|
743
|
-
model_type: '
|
|
744
|
+
model_type: 'bulk';
|
|
744
745
|
|
|
745
746
|
/**
|
|
746
747
|
* The name of the price.
|
|
747
748
|
*/
|
|
748
749
|
name: string;
|
|
749
750
|
|
|
750
|
-
tiered_bps_config: Shared.TieredBPSConfig;
|
|
751
|
-
|
|
752
751
|
/**
|
|
753
752
|
* The id of the billable metric for the price. Only needed if the price is
|
|
754
753
|
* usage-based.
|
|
@@ -812,9 +811,7 @@ export declare namespace PriceCreateParams {
|
|
|
812
811
|
metadata?: { [key: string]: string | null } | null;
|
|
813
812
|
}
|
|
814
813
|
|
|
815
|
-
export interface
|
|
816
|
-
bps_config: Shared.BPSConfig;
|
|
817
|
-
|
|
814
|
+
export interface NewFloatingThresholdTotalAmountPrice {
|
|
818
815
|
/**
|
|
819
816
|
* The cadence to bill for this price on.
|
|
820
817
|
*/
|
|
@@ -830,13 +827,15 @@ export declare namespace PriceCreateParams {
|
|
|
830
827
|
*/
|
|
831
828
|
item_id: string;
|
|
832
829
|
|
|
833
|
-
model_type: '
|
|
830
|
+
model_type: 'threshold_total_amount';
|
|
834
831
|
|
|
835
832
|
/**
|
|
836
833
|
* The name of the price.
|
|
837
834
|
*/
|
|
838
835
|
name: string;
|
|
839
836
|
|
|
837
|
+
threshold_total_amount_config: { [key: string]: unknown };
|
|
838
|
+
|
|
840
839
|
/**
|
|
841
840
|
* The id of the billable metric for the price. Only needed if the price is
|
|
842
841
|
* usage-based.
|
|
@@ -900,9 +899,7 @@ export declare namespace PriceCreateParams {
|
|
|
900
899
|
metadata?: { [key: string]: string | null } | null;
|
|
901
900
|
}
|
|
902
901
|
|
|
903
|
-
export interface
|
|
904
|
-
bulk_bps_config: Shared.BulkBPSConfig;
|
|
905
|
-
|
|
902
|
+
export interface NewFloatingTieredPackagePrice {
|
|
906
903
|
/**
|
|
907
904
|
* The cadence to bill for this price on.
|
|
908
905
|
*/
|
|
@@ -918,13 +915,15 @@ export declare namespace PriceCreateParams {
|
|
|
918
915
|
*/
|
|
919
916
|
item_id: string;
|
|
920
917
|
|
|
921
|
-
model_type: '
|
|
918
|
+
model_type: 'tiered_package';
|
|
922
919
|
|
|
923
920
|
/**
|
|
924
921
|
* The name of the price.
|
|
925
922
|
*/
|
|
926
923
|
name: string;
|
|
927
924
|
|
|
925
|
+
tiered_package_config: { [key: string]: unknown };
|
|
926
|
+
|
|
928
927
|
/**
|
|
929
928
|
* The id of the billable metric for the price. Only needed if the price is
|
|
930
929
|
* usage-based.
|
|
@@ -988,9 +987,7 @@ export declare namespace PriceCreateParams {
|
|
|
988
987
|
metadata?: { [key: string]: string | null } | null;
|
|
989
988
|
}
|
|
990
989
|
|
|
991
|
-
export interface
|
|
992
|
-
bulk_config: Shared.BulkConfig;
|
|
993
|
-
|
|
990
|
+
export interface NewFloatingGroupedTieredPrice {
|
|
994
991
|
/**
|
|
995
992
|
* The cadence to bill for this price on.
|
|
996
993
|
*/
|
|
@@ -1001,12 +998,14 @@ export declare namespace PriceCreateParams {
|
|
|
1001
998
|
*/
|
|
1002
999
|
currency: string;
|
|
1003
1000
|
|
|
1001
|
+
grouped_tiered_config: { [key: string]: unknown };
|
|
1002
|
+
|
|
1004
1003
|
/**
|
|
1005
1004
|
* The id of the item the price will be associated with.
|
|
1006
1005
|
*/
|
|
1007
1006
|
item_id: string;
|
|
1008
1007
|
|
|
1009
|
-
model_type: '
|
|
1008
|
+
model_type: 'grouped_tiered';
|
|
1010
1009
|
|
|
1011
1010
|
/**
|
|
1012
1011
|
* The name of the price.
|
|
@@ -1076,7 +1075,7 @@ export declare namespace PriceCreateParams {
|
|
|
1076
1075
|
metadata?: { [key: string]: string | null } | null;
|
|
1077
1076
|
}
|
|
1078
1077
|
|
|
1079
|
-
export interface
|
|
1078
|
+
export interface NewFloatingMaxGroupTieredPackagePrice {
|
|
1080
1079
|
/**
|
|
1081
1080
|
* The cadence to bill for this price on.
|
|
1082
1081
|
*/
|
|
@@ -1092,15 +1091,15 @@ export declare namespace PriceCreateParams {
|
|
|
1092
1091
|
*/
|
|
1093
1092
|
item_id: string;
|
|
1094
1093
|
|
|
1095
|
-
|
|
1094
|
+
max_group_tiered_package_config: { [key: string]: unknown };
|
|
1095
|
+
|
|
1096
|
+
model_type: 'max_group_tiered_package';
|
|
1096
1097
|
|
|
1097
1098
|
/**
|
|
1098
1099
|
* The name of the price.
|
|
1099
1100
|
*/
|
|
1100
1101
|
name: string;
|
|
1101
1102
|
|
|
1102
|
-
threshold_total_amount_config: { [key: string]: unknown };
|
|
1103
|
-
|
|
1104
1103
|
/**
|
|
1105
1104
|
* The id of the billable metric for the price. Only needed if the price is
|
|
1106
1105
|
* usage-based.
|
|
@@ -1164,7 +1163,7 @@ export declare namespace PriceCreateParams {
|
|
|
1164
1163
|
metadata?: { [key: string]: string | null } | null;
|
|
1165
1164
|
}
|
|
1166
1165
|
|
|
1167
|
-
export interface
|
|
1166
|
+
export interface NewFloatingTieredWithMinimumPrice {
|
|
1168
1167
|
/**
|
|
1169
1168
|
* The cadence to bill for this price on.
|
|
1170
1169
|
*/
|
|
@@ -1180,14 +1179,14 @@ export declare namespace PriceCreateParams {
|
|
|
1180
1179
|
*/
|
|
1181
1180
|
item_id: string;
|
|
1182
1181
|
|
|
1183
|
-
model_type: '
|
|
1182
|
+
model_type: 'tiered_with_minimum';
|
|
1184
1183
|
|
|
1185
1184
|
/**
|
|
1186
1185
|
* The name of the price.
|
|
1187
1186
|
*/
|
|
1188
1187
|
name: string;
|
|
1189
1188
|
|
|
1190
|
-
|
|
1189
|
+
tiered_with_minimum_config: { [key: string]: unknown };
|
|
1191
1190
|
|
|
1192
1191
|
/**
|
|
1193
1192
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -1252,7 +1251,7 @@ export declare namespace PriceCreateParams {
|
|
|
1252
1251
|
metadata?: { [key: string]: string | null } | null;
|
|
1253
1252
|
}
|
|
1254
1253
|
|
|
1255
|
-
export interface
|
|
1254
|
+
export interface NewFloatingPackageWithAllocationPrice {
|
|
1256
1255
|
/**
|
|
1257
1256
|
* The cadence to bill for this price on.
|
|
1258
1257
|
*/
|
|
@@ -1263,107 +1262,19 @@ export declare namespace PriceCreateParams {
|
|
|
1263
1262
|
*/
|
|
1264
1263
|
currency: string;
|
|
1265
1264
|
|
|
1266
|
-
grouped_tiered_config: { [key: string]: unknown };
|
|
1267
|
-
|
|
1268
1265
|
/**
|
|
1269
1266
|
* The id of the item the price will be associated with.
|
|
1270
1267
|
*/
|
|
1271
1268
|
item_id: string;
|
|
1272
1269
|
|
|
1273
|
-
model_type: '
|
|
1270
|
+
model_type: 'package_with_allocation';
|
|
1274
1271
|
|
|
1275
1272
|
/**
|
|
1276
1273
|
* The name of the price.
|
|
1277
1274
|
*/
|
|
1278
1275
|
name: string;
|
|
1279
1276
|
|
|
1280
|
-
|
|
1281
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
1282
|
-
* usage-based.
|
|
1283
|
-
*/
|
|
1284
|
-
billable_metric_id?: string | null;
|
|
1285
|
-
|
|
1286
|
-
/**
|
|
1287
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
1288
|
-
* this is true, and in-arrears if this is false.
|
|
1289
|
-
*/
|
|
1290
|
-
billed_in_advance?: boolean | null;
|
|
1291
|
-
|
|
1292
|
-
/**
|
|
1293
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
1294
|
-
* months.
|
|
1295
|
-
*/
|
|
1296
|
-
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
1297
|
-
|
|
1298
|
-
/**
|
|
1299
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1300
|
-
*/
|
|
1301
|
-
conversion_rate?: number | null;
|
|
1302
|
-
|
|
1303
|
-
/**
|
|
1304
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
1305
|
-
*/
|
|
1306
|
-
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
1307
|
-
|
|
1308
|
-
/**
|
|
1309
|
-
* For dimensional price: specifies a price group and dimension values
|
|
1310
|
-
*/
|
|
1311
|
-
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
1312
|
-
|
|
1313
|
-
/**
|
|
1314
|
-
* An alias for the price.
|
|
1315
|
-
*/
|
|
1316
|
-
external_price_id?: string | null;
|
|
1317
|
-
|
|
1318
|
-
/**
|
|
1319
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
1320
|
-
* applied.
|
|
1321
|
-
*/
|
|
1322
|
-
fixed_price_quantity?: number | null;
|
|
1323
|
-
|
|
1324
|
-
/**
|
|
1325
|
-
* The property used to group this price on an invoice
|
|
1326
|
-
*/
|
|
1327
|
-
invoice_grouping_key?: string | null;
|
|
1328
|
-
|
|
1329
|
-
/**
|
|
1330
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1331
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
1332
|
-
*/
|
|
1333
|
-
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
1334
|
-
|
|
1335
|
-
/**
|
|
1336
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1337
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
1338
|
-
* by setting `metadata` to `null`.
|
|
1339
|
-
*/
|
|
1340
|
-
metadata?: { [key: string]: string | null } | null;
|
|
1341
|
-
}
|
|
1342
|
-
|
|
1343
|
-
export interface NewFloatingMaxGroupTieredPackagePrice {
|
|
1344
|
-
/**
|
|
1345
|
-
* The cadence to bill for this price on.
|
|
1346
|
-
*/
|
|
1347
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
1348
|
-
|
|
1349
|
-
/**
|
|
1350
|
-
* An ISO 4217 currency string for which this price is billed in.
|
|
1351
|
-
*/
|
|
1352
|
-
currency: string;
|
|
1353
|
-
|
|
1354
|
-
/**
|
|
1355
|
-
* The id of the item the price will be associated with.
|
|
1356
|
-
*/
|
|
1357
|
-
item_id: string;
|
|
1358
|
-
|
|
1359
|
-
max_group_tiered_package_config: { [key: string]: unknown };
|
|
1360
|
-
|
|
1361
|
-
model_type: 'max_group_tiered_package';
|
|
1362
|
-
|
|
1363
|
-
/**
|
|
1364
|
-
* The name of the price.
|
|
1365
|
-
*/
|
|
1366
|
-
name: string;
|
|
1277
|
+
package_with_allocation_config: { [key: string]: unknown };
|
|
1367
1278
|
|
|
1368
1279
|
/**
|
|
1369
1280
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -1428,7 +1339,7 @@ export declare namespace PriceCreateParams {
|
|
|
1428
1339
|
metadata?: { [key: string]: string | null } | null;
|
|
1429
1340
|
}
|
|
1430
1341
|
|
|
1431
|
-
export interface
|
|
1342
|
+
export interface NewFloatingTieredPackageWithMinimumPrice {
|
|
1432
1343
|
/**
|
|
1433
1344
|
* The cadence to bill for this price on.
|
|
1434
1345
|
*/
|
|
@@ -1444,14 +1355,14 @@ export declare namespace PriceCreateParams {
|
|
|
1444
1355
|
*/
|
|
1445
1356
|
item_id: string;
|
|
1446
1357
|
|
|
1447
|
-
model_type: '
|
|
1358
|
+
model_type: 'tiered_package_with_minimum';
|
|
1448
1359
|
|
|
1449
1360
|
/**
|
|
1450
1361
|
* The name of the price.
|
|
1451
1362
|
*/
|
|
1452
1363
|
name: string;
|
|
1453
1364
|
|
|
1454
|
-
|
|
1365
|
+
tiered_package_with_minimum_config: { [key: string]: unknown };
|
|
1455
1366
|
|
|
1456
1367
|
/**
|
|
1457
1368
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -1516,7 +1427,7 @@ export declare namespace PriceCreateParams {
|
|
|
1516
1427
|
metadata?: { [key: string]: string | null } | null;
|
|
1517
1428
|
}
|
|
1518
1429
|
|
|
1519
|
-
export interface
|
|
1430
|
+
export interface NewFloatingUnitWithPercentPrice {
|
|
1520
1431
|
/**
|
|
1521
1432
|
* The cadence to bill for this price on.
|
|
1522
1433
|
*/
|
|
@@ -1532,14 +1443,14 @@ export declare namespace PriceCreateParams {
|
|
|
1532
1443
|
*/
|
|
1533
1444
|
item_id: string;
|
|
1534
1445
|
|
|
1535
|
-
model_type: '
|
|
1446
|
+
model_type: 'unit_with_percent';
|
|
1536
1447
|
|
|
1537
1448
|
/**
|
|
1538
1449
|
* The name of the price.
|
|
1539
1450
|
*/
|
|
1540
1451
|
name: string;
|
|
1541
1452
|
|
|
1542
|
-
|
|
1453
|
+
unit_with_percent_config: { [key: string]: unknown };
|
|
1543
1454
|
|
|
1544
1455
|
/**
|
|
1545
1456
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -1604,7 +1515,7 @@ export declare namespace PriceCreateParams {
|
|
|
1604
1515
|
metadata?: { [key: string]: string | null } | null;
|
|
1605
1516
|
}
|
|
1606
1517
|
|
|
1607
|
-
export interface
|
|
1518
|
+
export interface NewFloatingTieredWithProrationPrice {
|
|
1608
1519
|
/**
|
|
1609
1520
|
* The cadence to bill for this price on.
|
|
1610
1521
|
*/
|
|
@@ -1620,14 +1531,14 @@ export declare namespace PriceCreateParams {
|
|
|
1620
1531
|
*/
|
|
1621
1532
|
item_id: string;
|
|
1622
1533
|
|
|
1623
|
-
model_type: '
|
|
1534
|
+
model_type: 'tiered_with_proration';
|
|
1624
1535
|
|
|
1625
1536
|
/**
|
|
1626
1537
|
* The name of the price.
|
|
1627
1538
|
*/
|
|
1628
1539
|
name: string;
|
|
1629
1540
|
|
|
1630
|
-
|
|
1541
|
+
tiered_with_proration_config: { [key: string]: unknown };
|
|
1631
1542
|
|
|
1632
1543
|
/**
|
|
1633
1544
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -1692,7 +1603,7 @@ export declare namespace PriceCreateParams {
|
|
|
1692
1603
|
metadata?: { [key: string]: string | null } | null;
|
|
1693
1604
|
}
|
|
1694
1605
|
|
|
1695
|
-
export interface
|
|
1606
|
+
export interface NewFloatingUnitWithProrationPrice {
|
|
1696
1607
|
/**
|
|
1697
1608
|
* The cadence to bill for this price on.
|
|
1698
1609
|
*/
|
|
@@ -1708,14 +1619,14 @@ export declare namespace PriceCreateParams {
|
|
|
1708
1619
|
*/
|
|
1709
1620
|
item_id: string;
|
|
1710
1621
|
|
|
1711
|
-
model_type: '
|
|
1622
|
+
model_type: 'unit_with_proration';
|
|
1712
1623
|
|
|
1713
1624
|
/**
|
|
1714
1625
|
* The name of the price.
|
|
1715
1626
|
*/
|
|
1716
1627
|
name: string;
|
|
1717
1628
|
|
|
1718
|
-
|
|
1629
|
+
unit_with_proration_config: { [key: string]: unknown };
|
|
1719
1630
|
|
|
1720
1631
|
/**
|
|
1721
1632
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -1780,7 +1691,7 @@ export declare namespace PriceCreateParams {
|
|
|
1780
1691
|
metadata?: { [key: string]: string | null } | null;
|
|
1781
1692
|
}
|
|
1782
1693
|
|
|
1783
|
-
export interface
|
|
1694
|
+
export interface NewFloatingGroupedAllocationPrice {
|
|
1784
1695
|
/**
|
|
1785
1696
|
* The cadence to bill for this price on.
|
|
1786
1697
|
*/
|
|
@@ -1791,20 +1702,20 @@ export declare namespace PriceCreateParams {
|
|
|
1791
1702
|
*/
|
|
1792
1703
|
currency: string;
|
|
1793
1704
|
|
|
1705
|
+
grouped_allocation_config: { [key: string]: unknown };
|
|
1706
|
+
|
|
1794
1707
|
/**
|
|
1795
1708
|
* The id of the item the price will be associated with.
|
|
1796
1709
|
*/
|
|
1797
1710
|
item_id: string;
|
|
1798
1711
|
|
|
1799
|
-
model_type: '
|
|
1712
|
+
model_type: 'grouped_allocation';
|
|
1800
1713
|
|
|
1801
1714
|
/**
|
|
1802
1715
|
* The name of the price.
|
|
1803
1716
|
*/
|
|
1804
1717
|
name: string;
|
|
1805
1718
|
|
|
1806
|
-
tiered_with_proration_config: { [key: string]: unknown };
|
|
1807
|
-
|
|
1808
1719
|
/**
|
|
1809
1720
|
* The id of the billable metric for the price. Only needed if the price is
|
|
1810
1721
|
* usage-based.
|
|
@@ -1868,7 +1779,7 @@ export declare namespace PriceCreateParams {
|
|
|
1868
1779
|
metadata?: { [key: string]: string | null } | null;
|
|
1869
1780
|
}
|
|
1870
1781
|
|
|
1871
|
-
export interface
|
|
1782
|
+
export interface NewFloatingGroupedWithProratedMinimumPrice {
|
|
1872
1783
|
/**
|
|
1873
1784
|
* The cadence to bill for this price on.
|
|
1874
1785
|
*/
|
|
@@ -1879,20 +1790,20 @@ export declare namespace PriceCreateParams {
|
|
|
1879
1790
|
*/
|
|
1880
1791
|
currency: string;
|
|
1881
1792
|
|
|
1793
|
+
grouped_with_prorated_minimum_config: { [key: string]: unknown };
|
|
1794
|
+
|
|
1882
1795
|
/**
|
|
1883
1796
|
* The id of the item the price will be associated with.
|
|
1884
1797
|
*/
|
|
1885
1798
|
item_id: string;
|
|
1886
1799
|
|
|
1887
|
-
model_type: '
|
|
1800
|
+
model_type: 'grouped_with_prorated_minimum';
|
|
1888
1801
|
|
|
1889
1802
|
/**
|
|
1890
1803
|
* The name of the price.
|
|
1891
1804
|
*/
|
|
1892
1805
|
name: string;
|
|
1893
1806
|
|
|
1894
|
-
unit_with_proration_config: { [key: string]: unknown };
|
|
1895
|
-
|
|
1896
1807
|
/**
|
|
1897
1808
|
* The id of the billable metric for the price. Only needed if the price is
|
|
1898
1809
|
* usage-based.
|
|
@@ -1956,7 +1867,7 @@ export declare namespace PriceCreateParams {
|
|
|
1956
1867
|
metadata?: { [key: string]: string | null } | null;
|
|
1957
1868
|
}
|
|
1958
1869
|
|
|
1959
|
-
export interface
|
|
1870
|
+
export interface NewFloatingGroupedWithMeteredMinimumPrice {
|
|
1960
1871
|
/**
|
|
1961
1872
|
* The cadence to bill for this price on.
|
|
1962
1873
|
*/
|
|
@@ -1967,14 +1878,14 @@ export declare namespace PriceCreateParams {
|
|
|
1967
1878
|
*/
|
|
1968
1879
|
currency: string;
|
|
1969
1880
|
|
|
1970
|
-
|
|
1881
|
+
grouped_with_metered_minimum_config: { [key: string]: unknown };
|
|
1971
1882
|
|
|
1972
1883
|
/**
|
|
1973
1884
|
* The id of the item the price will be associated with.
|
|
1974
1885
|
*/
|
|
1975
1886
|
item_id: string;
|
|
1976
1887
|
|
|
1977
|
-
model_type: '
|
|
1888
|
+
model_type: 'grouped_with_metered_minimum';
|
|
1978
1889
|
|
|
1979
1890
|
/**
|
|
1980
1891
|
* The name of the price.
|
|
@@ -2044,7 +1955,7 @@ export declare namespace PriceCreateParams {
|
|
|
2044
1955
|
metadata?: { [key: string]: string | null } | null;
|
|
2045
1956
|
}
|
|
2046
1957
|
|
|
2047
|
-
export interface
|
|
1958
|
+
export interface NewFloatingMatrixWithDisplayNamePrice {
|
|
2048
1959
|
/**
|
|
2049
1960
|
* The cadence to bill for this price on.
|
|
2050
1961
|
*/
|
|
@@ -2055,14 +1966,14 @@ export declare namespace PriceCreateParams {
|
|
|
2055
1966
|
*/
|
|
2056
1967
|
currency: string;
|
|
2057
1968
|
|
|
2058
|
-
grouped_with_prorated_minimum_config: { [key: string]: unknown };
|
|
2059
|
-
|
|
2060
1969
|
/**
|
|
2061
1970
|
* The id of the item the price will be associated with.
|
|
2062
1971
|
*/
|
|
2063
1972
|
item_id: string;
|
|
2064
1973
|
|
|
2065
|
-
|
|
1974
|
+
matrix_with_display_name_config: { [key: string]: unknown };
|
|
1975
|
+
|
|
1976
|
+
model_type: 'matrix_with_display_name';
|
|
2066
1977
|
|
|
2067
1978
|
/**
|
|
2068
1979
|
* The name of the price.
|
|
@@ -2132,7 +2043,9 @@ export declare namespace PriceCreateParams {
|
|
|
2132
2043
|
metadata?: { [key: string]: string | null } | null;
|
|
2133
2044
|
}
|
|
2134
2045
|
|
|
2135
|
-
export interface
|
|
2046
|
+
export interface NewFloatingBulkWithProrationPrice {
|
|
2047
|
+
bulk_with_proration_config: { [key: string]: unknown };
|
|
2048
|
+
|
|
2136
2049
|
/**
|
|
2137
2050
|
* The cadence to bill for this price on.
|
|
2138
2051
|
*/
|
|
@@ -2143,14 +2056,12 @@ export declare namespace PriceCreateParams {
|
|
|
2143
2056
|
*/
|
|
2144
2057
|
currency: string;
|
|
2145
2058
|
|
|
2146
|
-
grouped_with_metered_minimum_config: { [key: string]: unknown };
|
|
2147
|
-
|
|
2148
2059
|
/**
|
|
2149
2060
|
* The id of the item the price will be associated with.
|
|
2150
2061
|
*/
|
|
2151
2062
|
item_id: string;
|
|
2152
2063
|
|
|
2153
|
-
model_type: '
|
|
2064
|
+
model_type: 'bulk_with_proration';
|
|
2154
2065
|
|
|
2155
2066
|
/**
|
|
2156
2067
|
* The name of the price.
|
|
@@ -2220,7 +2131,7 @@ export declare namespace PriceCreateParams {
|
|
|
2220
2131
|
metadata?: { [key: string]: string | null } | null;
|
|
2221
2132
|
}
|
|
2222
2133
|
|
|
2223
|
-
export interface
|
|
2134
|
+
export interface NewFloatingGroupedTieredPackagePrice {
|
|
2224
2135
|
/**
|
|
2225
2136
|
* The cadence to bill for this price on.
|
|
2226
2137
|
*/
|
|
@@ -2231,14 +2142,14 @@ export declare namespace PriceCreateParams {
|
|
|
2231
2142
|
*/
|
|
2232
2143
|
currency: string;
|
|
2233
2144
|
|
|
2145
|
+
grouped_tiered_package_config: { [key: string]: unknown };
|
|
2146
|
+
|
|
2234
2147
|
/**
|
|
2235
2148
|
* The id of the item the price will be associated with.
|
|
2236
2149
|
*/
|
|
2237
2150
|
item_id: string;
|
|
2238
2151
|
|
|
2239
|
-
|
|
2240
|
-
|
|
2241
|
-
model_type: 'matrix_with_display_name';
|
|
2152
|
+
model_type: 'grouped_tiered_package';
|
|
2242
2153
|
|
|
2243
2154
|
/**
|
|
2244
2155
|
* The name of the price.
|
|
@@ -2308,9 +2219,7 @@ export declare namespace PriceCreateParams {
|
|
|
2308
2219
|
metadata?: { [key: string]: string | null } | null;
|
|
2309
2220
|
}
|
|
2310
2221
|
|
|
2311
|
-
export interface
|
|
2312
|
-
bulk_with_proration_config: { [key: string]: unknown };
|
|
2313
|
-
|
|
2222
|
+
export interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
2314
2223
|
/**
|
|
2315
2224
|
* The cadence to bill for this price on.
|
|
2316
2225
|
*/
|
|
@@ -2326,13 +2235,15 @@ export declare namespace PriceCreateParams {
|
|
|
2326
2235
|
*/
|
|
2327
2236
|
item_id: string;
|
|
2328
2237
|
|
|
2329
|
-
model_type: '
|
|
2238
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
2330
2239
|
|
|
2331
2240
|
/**
|
|
2332
2241
|
* The name of the price.
|
|
2333
2242
|
*/
|
|
2334
2243
|
name: string;
|
|
2335
2244
|
|
|
2245
|
+
scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
|
|
2246
|
+
|
|
2336
2247
|
/**
|
|
2337
2248
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2338
2249
|
* usage-based.
|
|
@@ -2396,7 +2307,7 @@ export declare namespace PriceCreateParams {
|
|
|
2396
2307
|
metadata?: { [key: string]: string | null } | null;
|
|
2397
2308
|
}
|
|
2398
2309
|
|
|
2399
|
-
export interface
|
|
2310
|
+
export interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
2400
2311
|
/**
|
|
2401
2312
|
* The cadence to bill for this price on.
|
|
2402
2313
|
*/
|
|
@@ -2407,20 +2318,20 @@ export declare namespace PriceCreateParams {
|
|
|
2407
2318
|
*/
|
|
2408
2319
|
currency: string;
|
|
2409
2320
|
|
|
2410
|
-
grouped_tiered_package_config: { [key: string]: unknown };
|
|
2411
|
-
|
|
2412
2321
|
/**
|
|
2413
2322
|
* The id of the item the price will be associated with.
|
|
2414
2323
|
*/
|
|
2415
2324
|
item_id: string;
|
|
2416
2325
|
|
|
2417
|
-
model_type: '
|
|
2326
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
2418
2327
|
|
|
2419
2328
|
/**
|
|
2420
2329
|
* The name of the price.
|
|
2421
2330
|
*/
|
|
2422
2331
|
name: string;
|
|
2423
2332
|
|
|
2333
|
+
scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
|
|
2334
|
+
|
|
2424
2335
|
/**
|
|
2425
2336
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2426
2337
|
* usage-based.
|
|
@@ -2484,12 +2395,14 @@ export declare namespace PriceCreateParams {
|
|
|
2484
2395
|
metadata?: { [key: string]: string | null } | null;
|
|
2485
2396
|
}
|
|
2486
2397
|
|
|
2487
|
-
export interface
|
|
2398
|
+
export interface NewFloatingCumulativeGroupedBulkPrice {
|
|
2488
2399
|
/**
|
|
2489
2400
|
* The cadence to bill for this price on.
|
|
2490
2401
|
*/
|
|
2491
2402
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
2492
2403
|
|
|
2404
|
+
cumulative_grouped_bulk_config: { [key: string]: unknown };
|
|
2405
|
+
|
|
2493
2406
|
/**
|
|
2494
2407
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2495
2408
|
*/
|
|
@@ -2500,15 +2413,13 @@ export declare namespace PriceCreateParams {
|
|
|
2500
2413
|
*/
|
|
2501
2414
|
item_id: string;
|
|
2502
2415
|
|
|
2503
|
-
model_type: '
|
|
2416
|
+
model_type: 'cumulative_grouped_bulk';
|
|
2504
2417
|
|
|
2505
2418
|
/**
|
|
2506
2419
|
* The name of the price.
|
|
2507
2420
|
*/
|
|
2508
2421
|
name: string;
|
|
2509
2422
|
|
|
2510
|
-
scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
|
|
2511
|
-
|
|
2512
2423
|
/**
|
|
2513
2424
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2514
2425
|
* usage-based.
|
|
@@ -2572,7 +2483,7 @@ export declare namespace PriceCreateParams {
|
|
|
2572
2483
|
metadata?: { [key: string]: string | null } | null;
|
|
2573
2484
|
}
|
|
2574
2485
|
|
|
2575
|
-
export interface
|
|
2486
|
+
export interface NewFloatingGroupedWithMinMaxThresholdsPrice {
|
|
2576
2487
|
/**
|
|
2577
2488
|
* The cadence to bill for this price on.
|
|
2578
2489
|
*/
|
|
@@ -2583,20 +2494,20 @@ export declare namespace PriceCreateParams {
|
|
|
2583
2494
|
*/
|
|
2584
2495
|
currency: string;
|
|
2585
2496
|
|
|
2497
|
+
grouped_with_min_max_thresholds_config: { [key: string]: unknown };
|
|
2498
|
+
|
|
2586
2499
|
/**
|
|
2587
2500
|
* The id of the item the price will be associated with.
|
|
2588
2501
|
*/
|
|
2589
2502
|
item_id: string;
|
|
2590
2503
|
|
|
2591
|
-
model_type: '
|
|
2504
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
2592
2505
|
|
|
2593
2506
|
/**
|
|
2594
2507
|
* The name of the price.
|
|
2595
2508
|
*/
|
|
2596
2509
|
name: string;
|
|
2597
2510
|
|
|
2598
|
-
scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
|
|
2599
|
-
|
|
2600
2511
|
/**
|
|
2601
2512
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2602
2513
|
* usage-based.
|
|
@@ -2660,14 +2571,12 @@ export declare namespace PriceCreateParams {
|
|
|
2660
2571
|
metadata?: { [key: string]: string | null } | null;
|
|
2661
2572
|
}
|
|
2662
2573
|
|
|
2663
|
-
export interface
|
|
2574
|
+
export interface NewFloatingMinimumCompositePrice {
|
|
2664
2575
|
/**
|
|
2665
2576
|
* The cadence to bill for this price on.
|
|
2666
2577
|
*/
|
|
2667
2578
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
2668
2579
|
|
|
2669
|
-
cumulative_grouped_bulk_config: { [key: string]: unknown };
|
|
2670
|
-
|
|
2671
2580
|
/**
|
|
2672
2581
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2673
2582
|
*/
|
|
@@ -2678,7 +2587,9 @@ export declare namespace PriceCreateParams {
|
|
|
2678
2587
|
*/
|
|
2679
2588
|
item_id: string;
|
|
2680
2589
|
|
|
2681
|
-
|
|
2590
|
+
minimum_config: NewFloatingMinimumCompositePrice.MinimumConfig;
|
|
2591
|
+
|
|
2592
|
+
model_type: 'minimum';
|
|
2682
2593
|
|
|
2683
2594
|
/**
|
|
2684
2595
|
* The name of the price.
|
|
@@ -2747,6 +2658,21 @@ export declare namespace PriceCreateParams {
|
|
|
2747
2658
|
*/
|
|
2748
2659
|
metadata?: { [key: string]: string | null } | null;
|
|
2749
2660
|
}
|
|
2661
|
+
|
|
2662
|
+
export namespace NewFloatingMinimumCompositePrice {
|
|
2663
|
+
export interface MinimumConfig {
|
|
2664
|
+
/**
|
|
2665
|
+
* The minimum amount to apply
|
|
2666
|
+
*/
|
|
2667
|
+
minimum_amount: string;
|
|
2668
|
+
|
|
2669
|
+
/**
|
|
2670
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
2671
|
+
* service period. Set to false to disable proration.
|
|
2672
|
+
*/
|
|
2673
|
+
prorated?: boolean | null;
|
|
2674
|
+
}
|
|
2675
|
+
}
|
|
2750
2676
|
}
|
|
2751
2677
|
|
|
2752
2678
|
export interface PriceUpdateParams {
|
|
@@ -2854,9 +2780,6 @@ export namespace PriceEvaluateMultipleParams {
|
|
|
2854
2780
|
| Shared.NewFloatingMatrixPrice
|
|
2855
2781
|
| Shared.NewFloatingMatrixWithAllocationPrice
|
|
2856
2782
|
| Shared.NewFloatingTieredPrice
|
|
2857
|
-
| Shared.NewFloatingTieredBPSPrice
|
|
2858
|
-
| Shared.NewFloatingBPSPrice
|
|
2859
|
-
| Shared.NewFloatingBulkBPSPrice
|
|
2860
2783
|
| Shared.NewFloatingBulkPrice
|
|
2861
2784
|
| Shared.NewFloatingThresholdTotalAmountPrice
|
|
2862
2785
|
| Shared.NewFloatingTieredPackagePrice
|
|
@@ -2877,6 +2800,8 @@ export namespace PriceEvaluateMultipleParams {
|
|
|
2877
2800
|
| Shared.NewFloatingScalableMatrixWithUnitPricingPrice
|
|
2878
2801
|
| Shared.NewFloatingScalableMatrixWithTieredPricingPrice
|
|
2879
2802
|
| Shared.NewFloatingCumulativeGroupedBulkPrice
|
|
2803
|
+
| PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice
|
|
2804
|
+
| Shared.NewFloatingMinimumCompositePrice
|
|
2880
2805
|
| null;
|
|
2881
2806
|
|
|
2882
2807
|
/**
|
|
@@ -2884,6 +2809,96 @@ export namespace PriceEvaluateMultipleParams {
|
|
|
2884
2809
|
*/
|
|
2885
2810
|
price_id?: string | null;
|
|
2886
2811
|
}
|
|
2812
|
+
|
|
2813
|
+
export namespace PriceEvaluation {
|
|
2814
|
+
export interface NewFloatingGroupedWithMinMaxThresholdsPrice {
|
|
2815
|
+
/**
|
|
2816
|
+
* The cadence to bill for this price on.
|
|
2817
|
+
*/
|
|
2818
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
2819
|
+
|
|
2820
|
+
/**
|
|
2821
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
2822
|
+
*/
|
|
2823
|
+
currency: string;
|
|
2824
|
+
|
|
2825
|
+
grouped_with_min_max_thresholds_config: { [key: string]: unknown };
|
|
2826
|
+
|
|
2827
|
+
/**
|
|
2828
|
+
* The id of the item the price will be associated with.
|
|
2829
|
+
*/
|
|
2830
|
+
item_id: string;
|
|
2831
|
+
|
|
2832
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
2833
|
+
|
|
2834
|
+
/**
|
|
2835
|
+
* The name of the price.
|
|
2836
|
+
*/
|
|
2837
|
+
name: string;
|
|
2838
|
+
|
|
2839
|
+
/**
|
|
2840
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
2841
|
+
* usage-based.
|
|
2842
|
+
*/
|
|
2843
|
+
billable_metric_id?: string | null;
|
|
2844
|
+
|
|
2845
|
+
/**
|
|
2846
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
2847
|
+
* this is true, and in-arrears if this is false.
|
|
2848
|
+
*/
|
|
2849
|
+
billed_in_advance?: boolean | null;
|
|
2850
|
+
|
|
2851
|
+
/**
|
|
2852
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2853
|
+
* months.
|
|
2854
|
+
*/
|
|
2855
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
2856
|
+
|
|
2857
|
+
/**
|
|
2858
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2859
|
+
*/
|
|
2860
|
+
conversion_rate?: number | null;
|
|
2861
|
+
|
|
2862
|
+
/**
|
|
2863
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
2864
|
+
*/
|
|
2865
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
2866
|
+
|
|
2867
|
+
/**
|
|
2868
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2869
|
+
*/
|
|
2870
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
2871
|
+
|
|
2872
|
+
/**
|
|
2873
|
+
* An alias for the price.
|
|
2874
|
+
*/
|
|
2875
|
+
external_price_id?: string | null;
|
|
2876
|
+
|
|
2877
|
+
/**
|
|
2878
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
2879
|
+
* applied.
|
|
2880
|
+
*/
|
|
2881
|
+
fixed_price_quantity?: number | null;
|
|
2882
|
+
|
|
2883
|
+
/**
|
|
2884
|
+
* The property used to group this price on an invoice
|
|
2885
|
+
*/
|
|
2886
|
+
invoice_grouping_key?: string | null;
|
|
2887
|
+
|
|
2888
|
+
/**
|
|
2889
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2890
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2891
|
+
*/
|
|
2892
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
2893
|
+
|
|
2894
|
+
/**
|
|
2895
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2896
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
2897
|
+
* by setting `metadata` to `null`.
|
|
2898
|
+
*/
|
|
2899
|
+
metadata?: { [key: string]: string | null } | null;
|
|
2900
|
+
}
|
|
2901
|
+
}
|
|
2887
2902
|
}
|
|
2888
2903
|
|
|
2889
2904
|
export interface PriceEvaluatePreviewEventsParams {
|
|
@@ -2980,9 +2995,6 @@ export namespace PriceEvaluatePreviewEventsParams {
|
|
|
2980
2995
|
| Shared.NewFloatingMatrixPrice
|
|
2981
2996
|
| Shared.NewFloatingMatrixWithAllocationPrice
|
|
2982
2997
|
| Shared.NewFloatingTieredPrice
|
|
2983
|
-
| Shared.NewFloatingTieredBPSPrice
|
|
2984
|
-
| Shared.NewFloatingBPSPrice
|
|
2985
|
-
| Shared.NewFloatingBulkBPSPrice
|
|
2986
2998
|
| Shared.NewFloatingBulkPrice
|
|
2987
2999
|
| Shared.NewFloatingThresholdTotalAmountPrice
|
|
2988
3000
|
| Shared.NewFloatingTieredPackagePrice
|
|
@@ -3003,6 +3015,8 @@ export namespace PriceEvaluatePreviewEventsParams {
|
|
|
3003
3015
|
| Shared.NewFloatingScalableMatrixWithUnitPricingPrice
|
|
3004
3016
|
| Shared.NewFloatingScalableMatrixWithTieredPricingPrice
|
|
3005
3017
|
| Shared.NewFloatingCumulativeGroupedBulkPrice
|
|
3018
|
+
| PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice
|
|
3019
|
+
| Shared.NewFloatingMinimumCompositePrice
|
|
3006
3020
|
| null;
|
|
3007
3021
|
|
|
3008
3022
|
/**
|
|
@@ -3010,6 +3024,96 @@ export namespace PriceEvaluatePreviewEventsParams {
|
|
|
3010
3024
|
*/
|
|
3011
3025
|
price_id?: string | null;
|
|
3012
3026
|
}
|
|
3027
|
+
|
|
3028
|
+
export namespace PriceEvaluation {
|
|
3029
|
+
export interface NewFloatingGroupedWithMinMaxThresholdsPrice {
|
|
3030
|
+
/**
|
|
3031
|
+
* The cadence to bill for this price on.
|
|
3032
|
+
*/
|
|
3033
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3034
|
+
|
|
3035
|
+
/**
|
|
3036
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
3037
|
+
*/
|
|
3038
|
+
currency: string;
|
|
3039
|
+
|
|
3040
|
+
grouped_with_min_max_thresholds_config: { [key: string]: unknown };
|
|
3041
|
+
|
|
3042
|
+
/**
|
|
3043
|
+
* The id of the item the price will be associated with.
|
|
3044
|
+
*/
|
|
3045
|
+
item_id: string;
|
|
3046
|
+
|
|
3047
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
3048
|
+
|
|
3049
|
+
/**
|
|
3050
|
+
* The name of the price.
|
|
3051
|
+
*/
|
|
3052
|
+
name: string;
|
|
3053
|
+
|
|
3054
|
+
/**
|
|
3055
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3056
|
+
* usage-based.
|
|
3057
|
+
*/
|
|
3058
|
+
billable_metric_id?: string | null;
|
|
3059
|
+
|
|
3060
|
+
/**
|
|
3061
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3062
|
+
* this is true, and in-arrears if this is false.
|
|
3063
|
+
*/
|
|
3064
|
+
billed_in_advance?: boolean | null;
|
|
3065
|
+
|
|
3066
|
+
/**
|
|
3067
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3068
|
+
* months.
|
|
3069
|
+
*/
|
|
3070
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3071
|
+
|
|
3072
|
+
/**
|
|
3073
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3074
|
+
*/
|
|
3075
|
+
conversion_rate?: number | null;
|
|
3076
|
+
|
|
3077
|
+
/**
|
|
3078
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3079
|
+
*/
|
|
3080
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3081
|
+
|
|
3082
|
+
/**
|
|
3083
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3084
|
+
*/
|
|
3085
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3086
|
+
|
|
3087
|
+
/**
|
|
3088
|
+
* An alias for the price.
|
|
3089
|
+
*/
|
|
3090
|
+
external_price_id?: string | null;
|
|
3091
|
+
|
|
3092
|
+
/**
|
|
3093
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3094
|
+
* applied.
|
|
3095
|
+
*/
|
|
3096
|
+
fixed_price_quantity?: number | null;
|
|
3097
|
+
|
|
3098
|
+
/**
|
|
3099
|
+
* The property used to group this price on an invoice
|
|
3100
|
+
*/
|
|
3101
|
+
invoice_grouping_key?: string | null;
|
|
3102
|
+
|
|
3103
|
+
/**
|
|
3104
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3105
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3106
|
+
*/
|
|
3107
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3108
|
+
|
|
3109
|
+
/**
|
|
3110
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3111
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3112
|
+
* by setting `metadata` to `null`.
|
|
3113
|
+
*/
|
|
3114
|
+
metadata?: { [key: string]: string | null } | null;
|
|
3115
|
+
}
|
|
3116
|
+
}
|
|
3013
3117
|
}
|
|
3014
3118
|
|
|
3015
3119
|
Prices.ExternalPriceID = ExternalPriceID;
|