orb-billing 5.5.0 → 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 +22 -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 -5
- 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
package/resources/shared.d.ts
CHANGED
|
@@ -110,55 +110,6 @@ export interface BillingCycleConfiguration {
|
|
|
110
110
|
duration_unit: 'day' | 'month';
|
|
111
111
|
}
|
|
112
112
|
export type BillingCycleRelativeDate = 'start_of_term' | 'end_of_term';
|
|
113
|
-
export interface BPSConfig {
|
|
114
|
-
/**
|
|
115
|
-
* Basis point take rate per event
|
|
116
|
-
*/
|
|
117
|
-
bps: number;
|
|
118
|
-
/**
|
|
119
|
-
* Optional currency amount maximum to cap spend per event
|
|
120
|
-
*/
|
|
121
|
-
per_unit_maximum?: string | null;
|
|
122
|
-
}
|
|
123
|
-
export interface BPSTier {
|
|
124
|
-
/**
|
|
125
|
-
* Per-event basis point rate
|
|
126
|
-
*/
|
|
127
|
-
bps: number;
|
|
128
|
-
/**
|
|
129
|
-
* Exclusive tier starting value
|
|
130
|
-
*/
|
|
131
|
-
minimum_amount: string;
|
|
132
|
-
/**
|
|
133
|
-
* Inclusive tier ending value
|
|
134
|
-
*/
|
|
135
|
-
maximum_amount?: string | null;
|
|
136
|
-
/**
|
|
137
|
-
* Per unit maximum to charge
|
|
138
|
-
*/
|
|
139
|
-
per_unit_maximum?: string | null;
|
|
140
|
-
}
|
|
141
|
-
export interface BulkBPSConfig {
|
|
142
|
-
/**
|
|
143
|
-
* Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
|
144
|
-
* tier based on total volume
|
|
145
|
-
*/
|
|
146
|
-
tiers: Array<BulkBPSTier>;
|
|
147
|
-
}
|
|
148
|
-
export interface BulkBPSTier {
|
|
149
|
-
/**
|
|
150
|
-
* Basis points to rate on
|
|
151
|
-
*/
|
|
152
|
-
bps: number;
|
|
153
|
-
/**
|
|
154
|
-
* Upper bound for tier
|
|
155
|
-
*/
|
|
156
|
-
maximum_amount?: string | null;
|
|
157
|
-
/**
|
|
158
|
-
* The maximum amount to charge for any one event
|
|
159
|
-
*/
|
|
160
|
-
per_unit_maximum?: string | null;
|
|
161
|
-
}
|
|
162
113
|
export interface BulkConfig {
|
|
163
114
|
/**
|
|
164
115
|
* Bulk tiers for rating based on total usage volume
|
|
@@ -896,7 +847,7 @@ export declare namespace Invoice {
|
|
|
896
847
|
* A unique id for this transaction.
|
|
897
848
|
*/
|
|
898
849
|
id: string;
|
|
899
|
-
action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment';
|
|
850
|
+
action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover';
|
|
900
851
|
/**
|
|
901
852
|
* The value of the amount changed in the transaction.
|
|
902
853
|
*/
|
|
@@ -1017,7 +968,7 @@ export declare namespace Invoice {
|
|
|
1017
968
|
*/
|
|
1018
969
|
sub_line_items: Array<Shared.MatrixSubLineItem | Shared.TierSubLineItem | Shared.OtherSubLineItem>;
|
|
1019
970
|
/**
|
|
1020
|
-
* The line amount before
|
|
971
|
+
* The line amount before any adjustments.
|
|
1021
972
|
*/
|
|
1022
973
|
subtotal: string;
|
|
1023
974
|
/**
|
|
@@ -1051,6 +1002,11 @@ export declare namespace Invoice {
|
|
|
1051
1002
|
* The ID of the payment attempt in the payment provider.
|
|
1052
1003
|
*/
|
|
1053
1004
|
payment_provider_id: string | null;
|
|
1005
|
+
/**
|
|
1006
|
+
* URL to the downloadable PDF version of the receipt. This field will be `null`
|
|
1007
|
+
* for payment attempts that did not succeed.
|
|
1008
|
+
*/
|
|
1009
|
+
receipt_pdf: string | null;
|
|
1054
1010
|
/**
|
|
1055
1011
|
* Whether the payment attempt succeeded.
|
|
1056
1012
|
*/
|
|
@@ -1220,8 +1176,8 @@ export interface MonetaryAmountDiscountAdjustment {
|
|
|
1220
1176
|
*/
|
|
1221
1177
|
filters: Array<TransformPriceFilter>;
|
|
1222
1178
|
/**
|
|
1223
|
-
* True for adjustments that apply to an entire
|
|
1224
|
-
*
|
|
1179
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1180
|
+
* apply to only one price.
|
|
1225
1181
|
*/
|
|
1226
1182
|
is_invoice_level: boolean;
|
|
1227
1183
|
/**
|
|
@@ -1250,8 +1206,8 @@ export interface MonetaryMaximumAdjustment {
|
|
|
1250
1206
|
*/
|
|
1251
1207
|
filters: Array<TransformPriceFilter>;
|
|
1252
1208
|
/**
|
|
1253
|
-
* True for adjustments that apply to an entire
|
|
1254
|
-
*
|
|
1209
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1210
|
+
* apply to only one price.
|
|
1255
1211
|
*/
|
|
1256
1212
|
is_invoice_level: boolean;
|
|
1257
1213
|
/**
|
|
@@ -1285,8 +1241,8 @@ export interface MonetaryMinimumAdjustment {
|
|
|
1285
1241
|
*/
|
|
1286
1242
|
filters: Array<TransformPriceFilter>;
|
|
1287
1243
|
/**
|
|
1288
|
-
* True for adjustments that apply to an entire
|
|
1289
|
-
*
|
|
1244
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1245
|
+
* apply to only one price.
|
|
1290
1246
|
*/
|
|
1291
1247
|
is_invoice_level: boolean;
|
|
1292
1248
|
/**
|
|
@@ -1324,8 +1280,8 @@ export interface MonetaryPercentageDiscountAdjustment {
|
|
|
1324
1280
|
*/
|
|
1325
1281
|
filters: Array<TransformPriceFilter>;
|
|
1326
1282
|
/**
|
|
1327
|
-
* True for adjustments that apply to an entire
|
|
1328
|
-
*
|
|
1283
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1284
|
+
* apply to only one price.
|
|
1329
1285
|
*/
|
|
1330
1286
|
is_invoice_level: boolean;
|
|
1331
1287
|
/**
|
|
@@ -1359,8 +1315,8 @@ export interface MonetaryUsageDiscountAdjustment {
|
|
|
1359
1315
|
*/
|
|
1360
1316
|
filters: Array<TransformPriceFilter>;
|
|
1361
1317
|
/**
|
|
1362
|
-
* True for adjustments that apply to an entire
|
|
1363
|
-
*
|
|
1318
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1319
|
+
* apply to only one price.
|
|
1364
1320
|
*/
|
|
1365
1321
|
is_invoice_level: boolean;
|
|
1366
1322
|
/**
|
|
@@ -1460,152 +1416,6 @@ export interface NewDimensionalPriceConfiguration {
|
|
|
1460
1416
|
*/
|
|
1461
1417
|
external_dimensional_price_group_id?: string | null;
|
|
1462
1418
|
}
|
|
1463
|
-
export interface NewFloatingBPSPrice {
|
|
1464
|
-
bps_config: BPSConfig;
|
|
1465
|
-
/**
|
|
1466
|
-
* The cadence to bill for this price on.
|
|
1467
|
-
*/
|
|
1468
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
1469
|
-
/**
|
|
1470
|
-
* An ISO 4217 currency string for which this price is billed in.
|
|
1471
|
-
*/
|
|
1472
|
-
currency: string;
|
|
1473
|
-
/**
|
|
1474
|
-
* The id of the item the price will be associated with.
|
|
1475
|
-
*/
|
|
1476
|
-
item_id: string;
|
|
1477
|
-
model_type: 'bps';
|
|
1478
|
-
/**
|
|
1479
|
-
* The name of the price.
|
|
1480
|
-
*/
|
|
1481
|
-
name: string;
|
|
1482
|
-
/**
|
|
1483
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
1484
|
-
* usage-based.
|
|
1485
|
-
*/
|
|
1486
|
-
billable_metric_id?: string | null;
|
|
1487
|
-
/**
|
|
1488
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
1489
|
-
* this is true, and in-arrears if this is false.
|
|
1490
|
-
*/
|
|
1491
|
-
billed_in_advance?: boolean | null;
|
|
1492
|
-
/**
|
|
1493
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
1494
|
-
* months.
|
|
1495
|
-
*/
|
|
1496
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
1497
|
-
/**
|
|
1498
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1499
|
-
*/
|
|
1500
|
-
conversion_rate?: number | null;
|
|
1501
|
-
/**
|
|
1502
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
1503
|
-
*/
|
|
1504
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
1505
|
-
/**
|
|
1506
|
-
* For dimensional price: specifies a price group and dimension values
|
|
1507
|
-
*/
|
|
1508
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
1509
|
-
/**
|
|
1510
|
-
* An alias for the price.
|
|
1511
|
-
*/
|
|
1512
|
-
external_price_id?: string | null;
|
|
1513
|
-
/**
|
|
1514
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
1515
|
-
* applied.
|
|
1516
|
-
*/
|
|
1517
|
-
fixed_price_quantity?: number | null;
|
|
1518
|
-
/**
|
|
1519
|
-
* The property used to group this price on an invoice
|
|
1520
|
-
*/
|
|
1521
|
-
invoice_grouping_key?: string | null;
|
|
1522
|
-
/**
|
|
1523
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1524
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
1525
|
-
*/
|
|
1526
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
1527
|
-
/**
|
|
1528
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1529
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
1530
|
-
* by setting `metadata` to `null`.
|
|
1531
|
-
*/
|
|
1532
|
-
metadata?: {
|
|
1533
|
-
[key: string]: string | null;
|
|
1534
|
-
} | null;
|
|
1535
|
-
}
|
|
1536
|
-
export interface NewFloatingBulkBPSPrice {
|
|
1537
|
-
bulk_bps_config: BulkBPSConfig;
|
|
1538
|
-
/**
|
|
1539
|
-
* The cadence to bill for this price on.
|
|
1540
|
-
*/
|
|
1541
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
1542
|
-
/**
|
|
1543
|
-
* An ISO 4217 currency string for which this price is billed in.
|
|
1544
|
-
*/
|
|
1545
|
-
currency: string;
|
|
1546
|
-
/**
|
|
1547
|
-
* The id of the item the price will be associated with.
|
|
1548
|
-
*/
|
|
1549
|
-
item_id: string;
|
|
1550
|
-
model_type: 'bulk_bps';
|
|
1551
|
-
/**
|
|
1552
|
-
* The name of the price.
|
|
1553
|
-
*/
|
|
1554
|
-
name: string;
|
|
1555
|
-
/**
|
|
1556
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
1557
|
-
* usage-based.
|
|
1558
|
-
*/
|
|
1559
|
-
billable_metric_id?: string | null;
|
|
1560
|
-
/**
|
|
1561
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
1562
|
-
* this is true, and in-arrears if this is false.
|
|
1563
|
-
*/
|
|
1564
|
-
billed_in_advance?: boolean | null;
|
|
1565
|
-
/**
|
|
1566
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
1567
|
-
* months.
|
|
1568
|
-
*/
|
|
1569
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
1570
|
-
/**
|
|
1571
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1572
|
-
*/
|
|
1573
|
-
conversion_rate?: number | null;
|
|
1574
|
-
/**
|
|
1575
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
1576
|
-
*/
|
|
1577
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
1578
|
-
/**
|
|
1579
|
-
* For dimensional price: specifies a price group and dimension values
|
|
1580
|
-
*/
|
|
1581
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
1582
|
-
/**
|
|
1583
|
-
* An alias for the price.
|
|
1584
|
-
*/
|
|
1585
|
-
external_price_id?: string | null;
|
|
1586
|
-
/**
|
|
1587
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
1588
|
-
* applied.
|
|
1589
|
-
*/
|
|
1590
|
-
fixed_price_quantity?: number | null;
|
|
1591
|
-
/**
|
|
1592
|
-
* The property used to group this price on an invoice
|
|
1593
|
-
*/
|
|
1594
|
-
invoice_grouping_key?: string | null;
|
|
1595
|
-
/**
|
|
1596
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1597
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
1598
|
-
*/
|
|
1599
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
1600
|
-
/**
|
|
1601
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1602
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
1603
|
-
* by setting `metadata` to `null`.
|
|
1604
|
-
*/
|
|
1605
|
-
metadata?: {
|
|
1606
|
-
[key: string]: string | null;
|
|
1607
|
-
} | null;
|
|
1608
|
-
}
|
|
1609
1419
|
export interface NewFloatingBulkPrice {
|
|
1610
1420
|
bulk_config: BulkConfig;
|
|
1611
1421
|
/**
|
|
@@ -2500,7 +2310,7 @@ export interface NewFloatingMaxGroupTieredPackagePrice {
|
|
|
2500
2310
|
[key: string]: string | null;
|
|
2501
2311
|
} | null;
|
|
2502
2312
|
}
|
|
2503
|
-
export interface
|
|
2313
|
+
export interface NewFloatingMinimumCompositePrice {
|
|
2504
2314
|
/**
|
|
2505
2315
|
* The cadence to bill for this price on.
|
|
2506
2316
|
*/
|
|
@@ -2513,12 +2323,12 @@ export interface NewFloatingPackagePrice {
|
|
|
2513
2323
|
* The id of the item the price will be associated with.
|
|
2514
2324
|
*/
|
|
2515
2325
|
item_id: string;
|
|
2516
|
-
|
|
2326
|
+
minimum_config: NewFloatingMinimumCompositePrice.MinimumConfig;
|
|
2327
|
+
model_type: 'minimum';
|
|
2517
2328
|
/**
|
|
2518
2329
|
* The name of the price.
|
|
2519
2330
|
*/
|
|
2520
2331
|
name: string;
|
|
2521
|
-
package_config: PackageConfig;
|
|
2522
2332
|
/**
|
|
2523
2333
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2524
2334
|
* usage-based.
|
|
@@ -2573,7 +2383,20 @@ export interface NewFloatingPackagePrice {
|
|
|
2573
2383
|
[key: string]: string | null;
|
|
2574
2384
|
} | null;
|
|
2575
2385
|
}
|
|
2576
|
-
export
|
|
2386
|
+
export declare namespace NewFloatingMinimumCompositePrice {
|
|
2387
|
+
interface MinimumConfig {
|
|
2388
|
+
/**
|
|
2389
|
+
* The minimum amount to apply
|
|
2390
|
+
*/
|
|
2391
|
+
minimum_amount: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
2394
|
+
* service period. Set to false to disable proration.
|
|
2395
|
+
*/
|
|
2396
|
+
prorated?: boolean | null;
|
|
2397
|
+
}
|
|
2398
|
+
}
|
|
2399
|
+
export interface NewFloatingPackagePrice {
|
|
2577
2400
|
/**
|
|
2578
2401
|
* The cadence to bill for this price on.
|
|
2579
2402
|
*/
|
|
@@ -2586,14 +2409,12 @@ export interface NewFloatingPackageWithAllocationPrice {
|
|
|
2586
2409
|
* The id of the item the price will be associated with.
|
|
2587
2410
|
*/
|
|
2588
2411
|
item_id: string;
|
|
2589
|
-
model_type: '
|
|
2412
|
+
model_type: 'package';
|
|
2590
2413
|
/**
|
|
2591
2414
|
* The name of the price.
|
|
2592
2415
|
*/
|
|
2593
2416
|
name: string;
|
|
2594
|
-
|
|
2595
|
-
[key: string]: unknown;
|
|
2596
|
-
};
|
|
2417
|
+
package_config: PackageConfig;
|
|
2597
2418
|
/**
|
|
2598
2419
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2599
2420
|
* usage-based.
|
|
@@ -2648,7 +2469,7 @@ export interface NewFloatingPackageWithAllocationPrice {
|
|
|
2648
2469
|
[key: string]: string | null;
|
|
2649
2470
|
} | null;
|
|
2650
2471
|
}
|
|
2651
|
-
export interface
|
|
2472
|
+
export interface NewFloatingPackageWithAllocationPrice {
|
|
2652
2473
|
/**
|
|
2653
2474
|
* The cadence to bill for this price on.
|
|
2654
2475
|
*/
|
|
@@ -2661,12 +2482,12 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
|
2661
2482
|
* The id of the item the price will be associated with.
|
|
2662
2483
|
*/
|
|
2663
2484
|
item_id: string;
|
|
2664
|
-
model_type: '
|
|
2485
|
+
model_type: 'package_with_allocation';
|
|
2665
2486
|
/**
|
|
2666
2487
|
* The name of the price.
|
|
2667
2488
|
*/
|
|
2668
2489
|
name: string;
|
|
2669
|
-
|
|
2490
|
+
package_with_allocation_config: {
|
|
2670
2491
|
[key: string]: unknown;
|
|
2671
2492
|
};
|
|
2672
2493
|
/**
|
|
@@ -2723,7 +2544,7 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
|
2723
2544
|
[key: string]: string | null;
|
|
2724
2545
|
} | null;
|
|
2725
2546
|
}
|
|
2726
|
-
export interface
|
|
2547
|
+
export interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
2727
2548
|
/**
|
|
2728
2549
|
* The cadence to bill for this price on.
|
|
2729
2550
|
*/
|
|
@@ -2736,12 +2557,12 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
|
2736
2557
|
* The id of the item the price will be associated with.
|
|
2737
2558
|
*/
|
|
2738
2559
|
item_id: string;
|
|
2739
|
-
model_type: '
|
|
2560
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
2740
2561
|
/**
|
|
2741
2562
|
* The name of the price.
|
|
2742
2563
|
*/
|
|
2743
2564
|
name: string;
|
|
2744
|
-
|
|
2565
|
+
scalable_matrix_with_tiered_pricing_config: {
|
|
2745
2566
|
[key: string]: unknown;
|
|
2746
2567
|
};
|
|
2747
2568
|
/**
|
|
@@ -2798,7 +2619,7 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
|
2798
2619
|
[key: string]: string | null;
|
|
2799
2620
|
} | null;
|
|
2800
2621
|
}
|
|
2801
|
-
export interface
|
|
2622
|
+
export interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
2802
2623
|
/**
|
|
2803
2624
|
* The cadence to bill for this price on.
|
|
2804
2625
|
*/
|
|
@@ -2811,12 +2632,12 @@ export interface NewFloatingThresholdTotalAmountPrice {
|
|
|
2811
2632
|
* The id of the item the price will be associated with.
|
|
2812
2633
|
*/
|
|
2813
2634
|
item_id: string;
|
|
2814
|
-
model_type: '
|
|
2635
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
2815
2636
|
/**
|
|
2816
2637
|
* The name of the price.
|
|
2817
2638
|
*/
|
|
2818
2639
|
name: string;
|
|
2819
|
-
|
|
2640
|
+
scalable_matrix_with_unit_pricing_config: {
|
|
2820
2641
|
[key: string]: unknown;
|
|
2821
2642
|
};
|
|
2822
2643
|
/**
|
|
@@ -2873,7 +2694,7 @@ export interface NewFloatingThresholdTotalAmountPrice {
|
|
|
2873
2694
|
[key: string]: string | null;
|
|
2874
2695
|
} | null;
|
|
2875
2696
|
}
|
|
2876
|
-
export interface
|
|
2697
|
+
export interface NewFloatingThresholdTotalAmountPrice {
|
|
2877
2698
|
/**
|
|
2878
2699
|
* The cadence to bill for this price on.
|
|
2879
2700
|
*/
|
|
@@ -2886,12 +2707,14 @@ export interface NewFloatingTieredBPSPrice {
|
|
|
2886
2707
|
* The id of the item the price will be associated with.
|
|
2887
2708
|
*/
|
|
2888
2709
|
item_id: string;
|
|
2889
|
-
model_type: '
|
|
2710
|
+
model_type: 'threshold_total_amount';
|
|
2890
2711
|
/**
|
|
2891
2712
|
* The name of the price.
|
|
2892
2713
|
*/
|
|
2893
2714
|
name: string;
|
|
2894
|
-
|
|
2715
|
+
threshold_total_amount_config: {
|
|
2716
|
+
[key: string]: unknown;
|
|
2717
|
+
};
|
|
2895
2718
|
/**
|
|
2896
2719
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2897
2720
|
* usage-based.
|
|
@@ -3645,8 +3468,8 @@ export interface NewPercentageDiscount {
|
|
|
3645
3468
|
*/
|
|
3646
3469
|
price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
|
|
3647
3470
|
}
|
|
3648
|
-
export interface
|
|
3649
|
-
|
|
3471
|
+
export interface NewPlanBulkPrice {
|
|
3472
|
+
bulk_config: BulkConfig;
|
|
3650
3473
|
/**
|
|
3651
3474
|
* The cadence to bill for this price on.
|
|
3652
3475
|
*/
|
|
@@ -3655,7 +3478,7 @@ export interface NewPlanBPSPrice {
|
|
|
3655
3478
|
* The id of the item the price will be associated with.
|
|
3656
3479
|
*/
|
|
3657
3480
|
item_id: string;
|
|
3658
|
-
model_type: '
|
|
3481
|
+
model_type: 'bulk';
|
|
3659
3482
|
/**
|
|
3660
3483
|
* The name of the price.
|
|
3661
3484
|
*/
|
|
@@ -3724,8 +3547,10 @@ export interface NewPlanBPSPrice {
|
|
|
3724
3547
|
*/
|
|
3725
3548
|
reference_id?: string | null;
|
|
3726
3549
|
}
|
|
3727
|
-
export interface
|
|
3728
|
-
|
|
3550
|
+
export interface NewPlanBulkWithProrationPrice {
|
|
3551
|
+
bulk_with_proration_config: {
|
|
3552
|
+
[key: string]: unknown;
|
|
3553
|
+
};
|
|
3729
3554
|
/**
|
|
3730
3555
|
* The cadence to bill for this price on.
|
|
3731
3556
|
*/
|
|
@@ -3734,7 +3559,7 @@ export interface NewPlanBulkBPSPrice {
|
|
|
3734
3559
|
* The id of the item the price will be associated with.
|
|
3735
3560
|
*/
|
|
3736
3561
|
item_id: string;
|
|
3737
|
-
model_type: '
|
|
3562
|
+
model_type: 'bulk_with_proration';
|
|
3738
3563
|
/**
|
|
3739
3564
|
* The name of the price.
|
|
3740
3565
|
*/
|
|
@@ -3803,17 +3628,19 @@ export interface NewPlanBulkBPSPrice {
|
|
|
3803
3628
|
*/
|
|
3804
3629
|
reference_id?: string | null;
|
|
3805
3630
|
}
|
|
3806
|
-
export interface
|
|
3807
|
-
bulk_config: BulkConfig;
|
|
3631
|
+
export interface NewPlanCumulativeGroupedBulkPrice {
|
|
3808
3632
|
/**
|
|
3809
3633
|
* The cadence to bill for this price on.
|
|
3810
3634
|
*/
|
|
3811
3635
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3636
|
+
cumulative_grouped_bulk_config: {
|
|
3637
|
+
[key: string]: unknown;
|
|
3638
|
+
};
|
|
3812
3639
|
/**
|
|
3813
3640
|
* The id of the item the price will be associated with.
|
|
3814
3641
|
*/
|
|
3815
3642
|
item_id: string;
|
|
3816
|
-
model_type: '
|
|
3643
|
+
model_type: 'cumulative_grouped_bulk';
|
|
3817
3644
|
/**
|
|
3818
3645
|
* The name of the price.
|
|
3819
3646
|
*/
|
|
@@ -3882,19 +3709,19 @@ export interface NewPlanBulkPrice {
|
|
|
3882
3709
|
*/
|
|
3883
3710
|
reference_id?: string | null;
|
|
3884
3711
|
}
|
|
3885
|
-
export interface
|
|
3886
|
-
bulk_with_proration_config: {
|
|
3887
|
-
[key: string]: unknown;
|
|
3888
|
-
};
|
|
3712
|
+
export interface NewPlanGroupedAllocationPrice {
|
|
3889
3713
|
/**
|
|
3890
3714
|
* The cadence to bill for this price on.
|
|
3891
3715
|
*/
|
|
3892
3716
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3717
|
+
grouped_allocation_config: {
|
|
3718
|
+
[key: string]: unknown;
|
|
3719
|
+
};
|
|
3893
3720
|
/**
|
|
3894
3721
|
* The id of the item the price will be associated with.
|
|
3895
3722
|
*/
|
|
3896
3723
|
item_id: string;
|
|
3897
|
-
model_type: '
|
|
3724
|
+
model_type: 'grouped_allocation';
|
|
3898
3725
|
/**
|
|
3899
3726
|
* The name of the price.
|
|
3900
3727
|
*/
|
|
@@ -3963,19 +3790,19 @@ export interface NewPlanBulkWithProrationPrice {
|
|
|
3963
3790
|
*/
|
|
3964
3791
|
reference_id?: string | null;
|
|
3965
3792
|
}
|
|
3966
|
-
export interface
|
|
3793
|
+
export interface NewPlanGroupedTieredPackagePrice {
|
|
3967
3794
|
/**
|
|
3968
3795
|
* The cadence to bill for this price on.
|
|
3969
3796
|
*/
|
|
3970
3797
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3971
|
-
|
|
3798
|
+
grouped_tiered_package_config: {
|
|
3972
3799
|
[key: string]: unknown;
|
|
3973
3800
|
};
|
|
3974
3801
|
/**
|
|
3975
3802
|
* The id of the item the price will be associated with.
|
|
3976
3803
|
*/
|
|
3977
3804
|
item_id: string;
|
|
3978
|
-
model_type: '
|
|
3805
|
+
model_type: 'grouped_tiered_package';
|
|
3979
3806
|
/**
|
|
3980
3807
|
* The name of the price.
|
|
3981
3808
|
*/
|
|
@@ -4044,19 +3871,19 @@ export interface NewPlanCumulativeGroupedBulkPrice {
|
|
|
4044
3871
|
*/
|
|
4045
3872
|
reference_id?: string | null;
|
|
4046
3873
|
}
|
|
4047
|
-
export interface
|
|
3874
|
+
export interface NewPlanGroupedTieredPrice {
|
|
4048
3875
|
/**
|
|
4049
3876
|
* The cadence to bill for this price on.
|
|
4050
3877
|
*/
|
|
4051
3878
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4052
|
-
|
|
3879
|
+
grouped_tiered_config: {
|
|
4053
3880
|
[key: string]: unknown;
|
|
4054
3881
|
};
|
|
4055
3882
|
/**
|
|
4056
3883
|
* The id of the item the price will be associated with.
|
|
4057
3884
|
*/
|
|
4058
3885
|
item_id: string;
|
|
4059
|
-
model_type: '
|
|
3886
|
+
model_type: 'grouped_tiered';
|
|
4060
3887
|
/**
|
|
4061
3888
|
* The name of the price.
|
|
4062
3889
|
*/
|
|
@@ -4125,19 +3952,19 @@ export interface NewPlanGroupedAllocationPrice {
|
|
|
4125
3952
|
*/
|
|
4126
3953
|
reference_id?: string | null;
|
|
4127
3954
|
}
|
|
4128
|
-
export interface
|
|
3955
|
+
export interface NewPlanGroupedWithMeteredMinimumPrice {
|
|
4129
3956
|
/**
|
|
4130
3957
|
* The cadence to bill for this price on.
|
|
4131
3958
|
*/
|
|
4132
3959
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4133
|
-
|
|
3960
|
+
grouped_with_metered_minimum_config: {
|
|
4134
3961
|
[key: string]: unknown;
|
|
4135
3962
|
};
|
|
4136
3963
|
/**
|
|
4137
3964
|
* The id of the item the price will be associated with.
|
|
4138
3965
|
*/
|
|
4139
3966
|
item_id: string;
|
|
4140
|
-
model_type: '
|
|
3967
|
+
model_type: 'grouped_with_metered_minimum';
|
|
4141
3968
|
/**
|
|
4142
3969
|
* The name of the price.
|
|
4143
3970
|
*/
|
|
@@ -4206,100 +4033,19 @@ export interface NewPlanGroupedTieredPackagePrice {
|
|
|
4206
4033
|
*/
|
|
4207
4034
|
reference_id?: string | null;
|
|
4208
4035
|
}
|
|
4209
|
-
export interface
|
|
4036
|
+
export interface NewPlanGroupedWithProratedMinimumPrice {
|
|
4210
4037
|
/**
|
|
4211
4038
|
* The cadence to bill for this price on.
|
|
4212
4039
|
*/
|
|
4213
4040
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4214
|
-
|
|
4041
|
+
grouped_with_prorated_minimum_config: {
|
|
4215
4042
|
[key: string]: unknown;
|
|
4216
4043
|
};
|
|
4217
4044
|
/**
|
|
4218
4045
|
* The id of the item the price will be associated with.
|
|
4219
4046
|
*/
|
|
4220
4047
|
item_id: string;
|
|
4221
|
-
model_type: '
|
|
4222
|
-
/**
|
|
4223
|
-
* The name of the price.
|
|
4224
|
-
*/
|
|
4225
|
-
name: string;
|
|
4226
|
-
/**
|
|
4227
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
4228
|
-
* usage-based.
|
|
4229
|
-
*/
|
|
4230
|
-
billable_metric_id?: string | null;
|
|
4231
|
-
/**
|
|
4232
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4233
|
-
* this is true, and in-arrears if this is false.
|
|
4234
|
-
*/
|
|
4235
|
-
billed_in_advance?: boolean | null;
|
|
4236
|
-
/**
|
|
4237
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
4238
|
-
* months.
|
|
4239
|
-
*/
|
|
4240
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
4241
|
-
/**
|
|
4242
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4243
|
-
*/
|
|
4244
|
-
conversion_rate?: number | null;
|
|
4245
|
-
/**
|
|
4246
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4247
|
-
*/
|
|
4248
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
4249
|
-
/**
|
|
4250
|
-
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4251
|
-
* price is billed.
|
|
4252
|
-
*/
|
|
4253
|
-
currency?: string | null;
|
|
4254
|
-
/**
|
|
4255
|
-
* For dimensional price: specifies a price group and dimension values
|
|
4256
|
-
*/
|
|
4257
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
4258
|
-
/**
|
|
4259
|
-
* An alias for the price.
|
|
4260
|
-
*/
|
|
4261
|
-
external_price_id?: string | null;
|
|
4262
|
-
/**
|
|
4263
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4264
|
-
* applied.
|
|
4265
|
-
*/
|
|
4266
|
-
fixed_price_quantity?: number | null;
|
|
4267
|
-
/**
|
|
4268
|
-
* The property used to group this price on an invoice
|
|
4269
|
-
*/
|
|
4270
|
-
invoice_grouping_key?: string | null;
|
|
4271
|
-
/**
|
|
4272
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4273
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
4274
|
-
*/
|
|
4275
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
4276
|
-
/**
|
|
4277
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4278
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4279
|
-
* by setting `metadata` to `null`.
|
|
4280
|
-
*/
|
|
4281
|
-
metadata?: {
|
|
4282
|
-
[key: string]: string | null;
|
|
4283
|
-
} | null;
|
|
4284
|
-
/**
|
|
4285
|
-
* A transient ID that can be used to reference this price when adding adjustments
|
|
4286
|
-
* in the same API call.
|
|
4287
|
-
*/
|
|
4288
|
-
reference_id?: string | null;
|
|
4289
|
-
}
|
|
4290
|
-
export interface NewPlanGroupedWithMeteredMinimumPrice {
|
|
4291
|
-
/**
|
|
4292
|
-
* The cadence to bill for this price on.
|
|
4293
|
-
*/
|
|
4294
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4295
|
-
grouped_with_metered_minimum_config: {
|
|
4296
|
-
[key: string]: unknown;
|
|
4297
|
-
};
|
|
4298
|
-
/**
|
|
4299
|
-
* The id of the item the price will be associated with.
|
|
4300
|
-
*/
|
|
4301
|
-
item_id: string;
|
|
4302
|
-
model_type: 'grouped_with_metered_minimum';
|
|
4048
|
+
model_type: 'grouped_with_prorated_minimum';
|
|
4303
4049
|
/**
|
|
4304
4050
|
* The name of the price.
|
|
4305
4051
|
*/
|
|
@@ -4368,19 +4114,17 @@ export interface NewPlanGroupedWithMeteredMinimumPrice {
|
|
|
4368
4114
|
*/
|
|
4369
4115
|
reference_id?: string | null;
|
|
4370
4116
|
}
|
|
4371
|
-
export interface
|
|
4117
|
+
export interface NewPlanMatrixPrice {
|
|
4372
4118
|
/**
|
|
4373
4119
|
* The cadence to bill for this price on.
|
|
4374
4120
|
*/
|
|
4375
4121
|
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4376
|
-
grouped_with_prorated_minimum_config: {
|
|
4377
|
-
[key: string]: unknown;
|
|
4378
|
-
};
|
|
4379
4122
|
/**
|
|
4380
4123
|
* The id of the item the price will be associated with.
|
|
4381
4124
|
*/
|
|
4382
4125
|
item_id: string;
|
|
4383
|
-
|
|
4126
|
+
matrix_config: MatrixConfig;
|
|
4127
|
+
model_type: 'matrix';
|
|
4384
4128
|
/**
|
|
4385
4129
|
* The name of the price.
|
|
4386
4130
|
*/
|
|
@@ -4449,7 +4193,7 @@ export interface NewPlanGroupedWithProratedMinimumPrice {
|
|
|
4449
4193
|
*/
|
|
4450
4194
|
reference_id?: string | null;
|
|
4451
4195
|
}
|
|
4452
|
-
export interface
|
|
4196
|
+
export interface NewPlanMatrixWithAllocationPrice {
|
|
4453
4197
|
/**
|
|
4454
4198
|
* The cadence to bill for this price on.
|
|
4455
4199
|
*/
|
|
@@ -4458,8 +4202,8 @@ export interface NewPlanMatrixPrice {
|
|
|
4458
4202
|
* The id of the item the price will be associated with.
|
|
4459
4203
|
*/
|
|
4460
4204
|
item_id: string;
|
|
4461
|
-
|
|
4462
|
-
model_type: '
|
|
4205
|
+
matrix_with_allocation_config: MatrixWithAllocationConfig;
|
|
4206
|
+
model_type: 'matrix_with_allocation';
|
|
4463
4207
|
/**
|
|
4464
4208
|
* The name of the price.
|
|
4465
4209
|
*/
|
|
@@ -4528,7 +4272,7 @@ export interface NewPlanMatrixPrice {
|
|
|
4528
4272
|
*/
|
|
4529
4273
|
reference_id?: string | null;
|
|
4530
4274
|
}
|
|
4531
|
-
export interface
|
|
4275
|
+
export interface NewPlanMatrixWithDisplayNamePrice {
|
|
4532
4276
|
/**
|
|
4533
4277
|
* The cadence to bill for this price on.
|
|
4534
4278
|
*/
|
|
@@ -4537,8 +4281,10 @@ export interface NewPlanMatrixWithAllocationPrice {
|
|
|
4537
4281
|
* The id of the item the price will be associated with.
|
|
4538
4282
|
*/
|
|
4539
4283
|
item_id: string;
|
|
4540
|
-
|
|
4541
|
-
|
|
4284
|
+
matrix_with_display_name_config: {
|
|
4285
|
+
[key: string]: unknown;
|
|
4286
|
+
};
|
|
4287
|
+
model_type: 'matrix_with_display_name';
|
|
4542
4288
|
/**
|
|
4543
4289
|
* The name of the price.
|
|
4544
4290
|
*/
|
|
@@ -4607,7 +4353,7 @@ export interface NewPlanMatrixWithAllocationPrice {
|
|
|
4607
4353
|
*/
|
|
4608
4354
|
reference_id?: string | null;
|
|
4609
4355
|
}
|
|
4610
|
-
export interface
|
|
4356
|
+
export interface NewPlanMaxGroupTieredPackagePrice {
|
|
4611
4357
|
/**
|
|
4612
4358
|
* The cadence to bill for this price on.
|
|
4613
4359
|
*/
|
|
@@ -4616,10 +4362,10 @@ export interface NewPlanMatrixWithDisplayNamePrice {
|
|
|
4616
4362
|
* The id of the item the price will be associated with.
|
|
4617
4363
|
*/
|
|
4618
4364
|
item_id: string;
|
|
4619
|
-
|
|
4365
|
+
max_group_tiered_package_config: {
|
|
4620
4366
|
[key: string]: unknown;
|
|
4621
4367
|
};
|
|
4622
|
-
model_type: '
|
|
4368
|
+
model_type: 'max_group_tiered_package';
|
|
4623
4369
|
/**
|
|
4624
4370
|
* The name of the price.
|
|
4625
4371
|
*/
|
|
@@ -4688,7 +4434,7 @@ export interface NewPlanMatrixWithDisplayNamePrice {
|
|
|
4688
4434
|
*/
|
|
4689
4435
|
reference_id?: string | null;
|
|
4690
4436
|
}
|
|
4691
|
-
export interface
|
|
4437
|
+
export interface NewPlanMinimumCompositePrice {
|
|
4692
4438
|
/**
|
|
4693
4439
|
* The cadence to bill for this price on.
|
|
4694
4440
|
*/
|
|
@@ -4697,10 +4443,8 @@ export interface NewPlanMaxGroupTieredPackagePrice {
|
|
|
4697
4443
|
* The id of the item the price will be associated with.
|
|
4698
4444
|
*/
|
|
4699
4445
|
item_id: string;
|
|
4700
|
-
|
|
4701
|
-
|
|
4702
|
-
};
|
|
4703
|
-
model_type: 'max_group_tiered_package';
|
|
4446
|
+
minimum_config: NewPlanMinimumCompositePrice.MinimumConfig;
|
|
4447
|
+
model_type: 'minimum';
|
|
4704
4448
|
/**
|
|
4705
4449
|
* The name of the price.
|
|
4706
4450
|
*/
|
|
@@ -4769,6 +4513,19 @@ export interface NewPlanMaxGroupTieredPackagePrice {
|
|
|
4769
4513
|
*/
|
|
4770
4514
|
reference_id?: string | null;
|
|
4771
4515
|
}
|
|
4516
|
+
export declare namespace NewPlanMinimumCompositePrice {
|
|
4517
|
+
interface MinimumConfig {
|
|
4518
|
+
/**
|
|
4519
|
+
* The minimum amount to apply
|
|
4520
|
+
*/
|
|
4521
|
+
minimum_amount: string;
|
|
4522
|
+
/**
|
|
4523
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
4524
|
+
* service period. Set to false to disable proration.
|
|
4525
|
+
*/
|
|
4526
|
+
prorated?: boolean | null;
|
|
4527
|
+
}
|
|
4528
|
+
}
|
|
4772
4529
|
export interface NewPlanPackagePrice {
|
|
4773
4530
|
/**
|
|
4774
4531
|
* The cadence to bill for this price on.
|
|
@@ -5253,85 +5010,6 @@ export interface NewPlanTierWithProrationPrice {
|
|
|
5253
5010
|
*/
|
|
5254
5011
|
reference_id?: string | null;
|
|
5255
5012
|
}
|
|
5256
|
-
export interface NewPlanTieredBPSPrice {
|
|
5257
|
-
/**
|
|
5258
|
-
* The cadence to bill for this price on.
|
|
5259
|
-
*/
|
|
5260
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
5261
|
-
/**
|
|
5262
|
-
* The id of the item the price will be associated with.
|
|
5263
|
-
*/
|
|
5264
|
-
item_id: string;
|
|
5265
|
-
model_type: 'tiered_bps';
|
|
5266
|
-
/**
|
|
5267
|
-
* The name of the price.
|
|
5268
|
-
*/
|
|
5269
|
-
name: string;
|
|
5270
|
-
tiered_bps_config: TieredBPSConfig;
|
|
5271
|
-
/**
|
|
5272
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
5273
|
-
* usage-based.
|
|
5274
|
-
*/
|
|
5275
|
-
billable_metric_id?: string | null;
|
|
5276
|
-
/**
|
|
5277
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
5278
|
-
* this is true, and in-arrears if this is false.
|
|
5279
|
-
*/
|
|
5280
|
-
billed_in_advance?: boolean | null;
|
|
5281
|
-
/**
|
|
5282
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
5283
|
-
* months.
|
|
5284
|
-
*/
|
|
5285
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
5286
|
-
/**
|
|
5287
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
5288
|
-
*/
|
|
5289
|
-
conversion_rate?: number | null;
|
|
5290
|
-
/**
|
|
5291
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
5292
|
-
*/
|
|
5293
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
5294
|
-
/**
|
|
5295
|
-
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
5296
|
-
* price is billed.
|
|
5297
|
-
*/
|
|
5298
|
-
currency?: string | null;
|
|
5299
|
-
/**
|
|
5300
|
-
* For dimensional price: specifies a price group and dimension values
|
|
5301
|
-
*/
|
|
5302
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
5303
|
-
/**
|
|
5304
|
-
* An alias for the price.
|
|
5305
|
-
*/
|
|
5306
|
-
external_price_id?: string | null;
|
|
5307
|
-
/**
|
|
5308
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
5309
|
-
* applied.
|
|
5310
|
-
*/
|
|
5311
|
-
fixed_price_quantity?: number | null;
|
|
5312
|
-
/**
|
|
5313
|
-
* The property used to group this price on an invoice
|
|
5314
|
-
*/
|
|
5315
|
-
invoice_grouping_key?: string | null;
|
|
5316
|
-
/**
|
|
5317
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5318
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
5319
|
-
*/
|
|
5320
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
5321
|
-
/**
|
|
5322
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
5323
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
5324
|
-
* by setting `metadata` to `null`.
|
|
5325
|
-
*/
|
|
5326
|
-
metadata?: {
|
|
5327
|
-
[key: string]: string | null;
|
|
5328
|
-
} | null;
|
|
5329
|
-
/**
|
|
5330
|
-
* A transient ID that can be used to reference this price when adding adjustments
|
|
5331
|
-
* in the same API call.
|
|
5332
|
-
*/
|
|
5333
|
-
reference_id?: string | null;
|
|
5334
|
-
}
|
|
5335
5013
|
export interface NewPlanTieredPackagePrice {
|
|
5336
5014
|
/**
|
|
5337
5015
|
* The cadence to bill for this price on.
|
|
@@ -6034,8 +5712,8 @@ export interface PlanPhaseAmountDiscountAdjustment {
|
|
|
6034
5712
|
*/
|
|
6035
5713
|
filters: Array<TransformPriceFilter>;
|
|
6036
5714
|
/**
|
|
6037
|
-
* True for adjustments that apply to an entire
|
|
6038
|
-
*
|
|
5715
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
5716
|
+
* apply to only one price.
|
|
6039
5717
|
*/
|
|
6040
5718
|
is_invoice_level: boolean;
|
|
6041
5719
|
/**
|
|
@@ -6064,8 +5742,8 @@ export interface PlanPhaseMaximumAdjustment {
|
|
|
6064
5742
|
*/
|
|
6065
5743
|
filters: Array<TransformPriceFilter>;
|
|
6066
5744
|
/**
|
|
6067
|
-
* True for adjustments that apply to an entire
|
|
6068
|
-
*
|
|
5745
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
5746
|
+
* apply to only one price.
|
|
6069
5747
|
*/
|
|
6070
5748
|
is_invoice_level: boolean;
|
|
6071
5749
|
/**
|
|
@@ -6099,8 +5777,8 @@ export interface PlanPhaseMinimumAdjustment {
|
|
|
6099
5777
|
*/
|
|
6100
5778
|
filters: Array<TransformPriceFilter>;
|
|
6101
5779
|
/**
|
|
6102
|
-
* True for adjustments that apply to an entire
|
|
6103
|
-
*
|
|
5780
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
5781
|
+
* apply to only one price.
|
|
6104
5782
|
*/
|
|
6105
5783
|
is_invoice_level: boolean;
|
|
6106
5784
|
/**
|
|
@@ -6138,8 +5816,8 @@ export interface PlanPhasePercentageDiscountAdjustment {
|
|
|
6138
5816
|
*/
|
|
6139
5817
|
filters: Array<TransformPriceFilter>;
|
|
6140
5818
|
/**
|
|
6141
|
-
* True for adjustments that apply to an entire
|
|
6142
|
-
*
|
|
5819
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
5820
|
+
* apply to only one price.
|
|
6143
5821
|
*/
|
|
6144
5822
|
is_invoice_level: boolean;
|
|
6145
5823
|
/**
|
|
@@ -6173,8 +5851,8 @@ export interface PlanPhaseUsageDiscountAdjustment {
|
|
|
6173
5851
|
*/
|
|
6174
5852
|
filters: Array<TransformPriceFilter>;
|
|
6175
5853
|
/**
|
|
6176
|
-
* True for adjustments that apply to an entire
|
|
6177
|
-
*
|
|
5854
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
5855
|
+
* apply to only one price.
|
|
6178
5856
|
*/
|
|
6179
5857
|
is_invoice_level: boolean;
|
|
6180
5858
|
/**
|
|
@@ -6208,13 +5886,14 @@ export interface PlanPhaseUsageDiscountAdjustment {
|
|
|
6208
5886
|
* For more on the types of prices, see
|
|
6209
5887
|
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
6210
5888
|
*/
|
|
6211
|
-
export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.
|
|
5889
|
+
export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.BulkPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.GroupedTieredPrice | Price.TieredWithMinimumPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.MatrixWithDisplayNamePrice | Price.BulkWithProrationPrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice | Price.CumulativeGroupedBulkPrice | Price.GroupedWithMinMaxThresholdsPrice | Price.MinimumCompositePrice;
|
|
6212
5890
|
export declare namespace Price {
|
|
6213
5891
|
interface UnitPrice {
|
|
6214
5892
|
id: string;
|
|
6215
5893
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6216
5894
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6217
5895
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
5896
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6218
5897
|
conversion_rate: number | null;
|
|
6219
5898
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6220
5899
|
created_at: string;
|
|
@@ -6270,6 +5949,7 @@ export declare namespace Price {
|
|
|
6270
5949
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6271
5950
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6272
5951
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
5952
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6273
5953
|
conversion_rate: number | null;
|
|
6274
5954
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6275
5955
|
created_at: string;
|
|
@@ -6325,6 +6005,7 @@ export declare namespace Price {
|
|
|
6325
6005
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6326
6006
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6327
6007
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6008
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6328
6009
|
conversion_rate: number | null;
|
|
6329
6010
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6330
6011
|
created_at: string;
|
|
@@ -6380,6 +6061,7 @@ export declare namespace Price {
|
|
|
6380
6061
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6381
6062
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6382
6063
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6064
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6383
6065
|
conversion_rate: number | null;
|
|
6384
6066
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6385
6067
|
created_at: string;
|
|
@@ -6430,177 +6112,13 @@ export declare namespace Price {
|
|
|
6430
6112
|
tiered_config: Shared.TieredConfig;
|
|
6431
6113
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
6432
6114
|
}
|
|
6433
|
-
interface TieredBPSPrice {
|
|
6434
|
-
id: string;
|
|
6435
|
-
billable_metric: Shared.BillableMetricTiny | null;
|
|
6436
|
-
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6437
|
-
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6438
|
-
conversion_rate: number | null;
|
|
6439
|
-
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6440
|
-
created_at: string;
|
|
6441
|
-
credit_allocation: Shared.Allocation | null;
|
|
6442
|
-
currency: string;
|
|
6443
|
-
/**
|
|
6444
|
-
* @deprecated
|
|
6445
|
-
*/
|
|
6446
|
-
discount: Shared.Discount | null;
|
|
6447
|
-
external_price_id: string | null;
|
|
6448
|
-
fixed_price_quantity: number | null;
|
|
6449
|
-
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
6450
|
-
item: Shared.ItemSlim;
|
|
6451
|
-
/**
|
|
6452
|
-
* @deprecated
|
|
6453
|
-
*/
|
|
6454
|
-
maximum: Shared.Maximum | null;
|
|
6455
|
-
/**
|
|
6456
|
-
* @deprecated
|
|
6457
|
-
*/
|
|
6458
|
-
maximum_amount: string | null;
|
|
6459
|
-
/**
|
|
6460
|
-
* User specified key-value pairs for the resource. If not present, this defaults
|
|
6461
|
-
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
6462
|
-
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
6463
|
-
* `null`.
|
|
6464
|
-
*/
|
|
6465
|
-
metadata: {
|
|
6466
|
-
[key: string]: string;
|
|
6467
|
-
};
|
|
6468
|
-
/**
|
|
6469
|
-
* @deprecated
|
|
6470
|
-
*/
|
|
6471
|
-
minimum: Shared.Minimum | null;
|
|
6472
|
-
/**
|
|
6473
|
-
* @deprecated
|
|
6474
|
-
*/
|
|
6475
|
-
minimum_amount: string | null;
|
|
6476
|
-
model_type: 'tiered_bps';
|
|
6477
|
-
name: string;
|
|
6478
|
-
plan_phase_order: number | null;
|
|
6479
|
-
price_type: 'usage_price' | 'fixed_price';
|
|
6480
|
-
/**
|
|
6481
|
-
* The price id this price replaces. This price will take the place of the replaced
|
|
6482
|
-
* price in plan version migrations.
|
|
6483
|
-
*/
|
|
6484
|
-
replaces_price_id: string | null;
|
|
6485
|
-
tiered_bps_config: Shared.TieredBPSConfig;
|
|
6486
|
-
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
6487
|
-
}
|
|
6488
|
-
interface BPSPrice {
|
|
6489
|
-
id: string;
|
|
6490
|
-
billable_metric: Shared.BillableMetricTiny | null;
|
|
6491
|
-
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6492
|
-
bps_config: Shared.BPSConfig;
|
|
6493
|
-
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6494
|
-
conversion_rate: number | null;
|
|
6495
|
-
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6496
|
-
created_at: string;
|
|
6497
|
-
credit_allocation: Shared.Allocation | null;
|
|
6498
|
-
currency: string;
|
|
6499
|
-
/**
|
|
6500
|
-
* @deprecated
|
|
6501
|
-
*/
|
|
6502
|
-
discount: Shared.Discount | null;
|
|
6503
|
-
external_price_id: string | null;
|
|
6504
|
-
fixed_price_quantity: number | null;
|
|
6505
|
-
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
6506
|
-
item: Shared.ItemSlim;
|
|
6507
|
-
/**
|
|
6508
|
-
* @deprecated
|
|
6509
|
-
*/
|
|
6510
|
-
maximum: Shared.Maximum | null;
|
|
6511
|
-
/**
|
|
6512
|
-
* @deprecated
|
|
6513
|
-
*/
|
|
6514
|
-
maximum_amount: string | null;
|
|
6515
|
-
/**
|
|
6516
|
-
* User specified key-value pairs for the resource. If not present, this defaults
|
|
6517
|
-
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
6518
|
-
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
6519
|
-
* `null`.
|
|
6520
|
-
*/
|
|
6521
|
-
metadata: {
|
|
6522
|
-
[key: string]: string;
|
|
6523
|
-
};
|
|
6524
|
-
/**
|
|
6525
|
-
* @deprecated
|
|
6526
|
-
*/
|
|
6527
|
-
minimum: Shared.Minimum | null;
|
|
6528
|
-
/**
|
|
6529
|
-
* @deprecated
|
|
6530
|
-
*/
|
|
6531
|
-
minimum_amount: string | null;
|
|
6532
|
-
model_type: 'bps';
|
|
6533
|
-
name: string;
|
|
6534
|
-
plan_phase_order: number | null;
|
|
6535
|
-
price_type: 'usage_price' | 'fixed_price';
|
|
6536
|
-
/**
|
|
6537
|
-
* The price id this price replaces. This price will take the place of the replaced
|
|
6538
|
-
* price in plan version migrations.
|
|
6539
|
-
*/
|
|
6540
|
-
replaces_price_id: string | null;
|
|
6541
|
-
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
6542
|
-
}
|
|
6543
|
-
interface BulkBPSPrice {
|
|
6544
|
-
id: string;
|
|
6545
|
-
billable_metric: Shared.BillableMetricTiny | null;
|
|
6546
|
-
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6547
|
-
bulk_bps_config: Shared.BulkBPSConfig;
|
|
6548
|
-
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6549
|
-
conversion_rate: number | null;
|
|
6550
|
-
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6551
|
-
created_at: string;
|
|
6552
|
-
credit_allocation: Shared.Allocation | null;
|
|
6553
|
-
currency: string;
|
|
6554
|
-
/**
|
|
6555
|
-
* @deprecated
|
|
6556
|
-
*/
|
|
6557
|
-
discount: Shared.Discount | null;
|
|
6558
|
-
external_price_id: string | null;
|
|
6559
|
-
fixed_price_quantity: number | null;
|
|
6560
|
-
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
6561
|
-
item: Shared.ItemSlim;
|
|
6562
|
-
/**
|
|
6563
|
-
* @deprecated
|
|
6564
|
-
*/
|
|
6565
|
-
maximum: Shared.Maximum | null;
|
|
6566
|
-
/**
|
|
6567
|
-
* @deprecated
|
|
6568
|
-
*/
|
|
6569
|
-
maximum_amount: string | null;
|
|
6570
|
-
/**
|
|
6571
|
-
* User specified key-value pairs for the resource. If not present, this defaults
|
|
6572
|
-
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
6573
|
-
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
6574
|
-
* `null`.
|
|
6575
|
-
*/
|
|
6576
|
-
metadata: {
|
|
6577
|
-
[key: string]: string;
|
|
6578
|
-
};
|
|
6579
|
-
/**
|
|
6580
|
-
* @deprecated
|
|
6581
|
-
*/
|
|
6582
|
-
minimum: Shared.Minimum | null;
|
|
6583
|
-
/**
|
|
6584
|
-
* @deprecated
|
|
6585
|
-
*/
|
|
6586
|
-
minimum_amount: string | null;
|
|
6587
|
-
model_type: 'bulk_bps';
|
|
6588
|
-
name: string;
|
|
6589
|
-
plan_phase_order: number | null;
|
|
6590
|
-
price_type: 'usage_price' | 'fixed_price';
|
|
6591
|
-
/**
|
|
6592
|
-
* The price id this price replaces. This price will take the place of the replaced
|
|
6593
|
-
* price in plan version migrations.
|
|
6594
|
-
*/
|
|
6595
|
-
replaces_price_id: string | null;
|
|
6596
|
-
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
6597
|
-
}
|
|
6598
6115
|
interface BulkPrice {
|
|
6599
6116
|
id: string;
|
|
6600
6117
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6601
6118
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6602
6119
|
bulk_config: Shared.BulkConfig;
|
|
6603
6120
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6121
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6604
6122
|
conversion_rate: number | null;
|
|
6605
6123
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6606
6124
|
created_at: string;
|
|
@@ -6655,6 +6173,7 @@ export declare namespace Price {
|
|
|
6655
6173
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6656
6174
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6657
6175
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6176
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6658
6177
|
conversion_rate: number | null;
|
|
6659
6178
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6660
6179
|
created_at: string;
|
|
@@ -6712,6 +6231,7 @@ export declare namespace Price {
|
|
|
6712
6231
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6713
6232
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6714
6233
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6234
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6715
6235
|
conversion_rate: number | null;
|
|
6716
6236
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6717
6237
|
created_at: string;
|
|
@@ -6769,6 +6289,7 @@ export declare namespace Price {
|
|
|
6769
6289
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6770
6290
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6771
6291
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6292
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6772
6293
|
conversion_rate: number | null;
|
|
6773
6294
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6774
6295
|
created_at: string;
|
|
@@ -6826,6 +6347,7 @@ export declare namespace Price {
|
|
|
6826
6347
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6827
6348
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6828
6349
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6350
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6829
6351
|
conversion_rate: number | null;
|
|
6830
6352
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6831
6353
|
created_at: string;
|
|
@@ -6883,6 +6405,7 @@ export declare namespace Price {
|
|
|
6883
6405
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6884
6406
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6885
6407
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6408
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6886
6409
|
conversion_rate: number | null;
|
|
6887
6410
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6888
6411
|
created_at: string;
|
|
@@ -6940,6 +6463,7 @@ export declare namespace Price {
|
|
|
6940
6463
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6941
6464
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6942
6465
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6466
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
6943
6467
|
conversion_rate: number | null;
|
|
6944
6468
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6945
6469
|
created_at: string;
|
|
@@ -6997,6 +6521,7 @@ export declare namespace Price {
|
|
|
6997
6521
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
6998
6522
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
6999
6523
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6524
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7000
6525
|
conversion_rate: number | null;
|
|
7001
6526
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7002
6527
|
created_at: string;
|
|
@@ -7054,6 +6579,7 @@ export declare namespace Price {
|
|
|
7054
6579
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7055
6580
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7056
6581
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6582
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7057
6583
|
conversion_rate: number | null;
|
|
7058
6584
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7059
6585
|
created_at: string;
|
|
@@ -7109,6 +6635,7 @@ export declare namespace Price {
|
|
|
7109
6635
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7110
6636
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7111
6637
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6638
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7112
6639
|
conversion_rate: number | null;
|
|
7113
6640
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7114
6641
|
created_at: string;
|
|
@@ -7166,6 +6693,7 @@ export declare namespace Price {
|
|
|
7166
6693
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7167
6694
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7168
6695
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6696
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7169
6697
|
conversion_rate: number | null;
|
|
7170
6698
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7171
6699
|
created_at: string;
|
|
@@ -7223,6 +6751,7 @@ export declare namespace Price {
|
|
|
7223
6751
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7224
6752
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7225
6753
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6754
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7226
6755
|
conversion_rate: number | null;
|
|
7227
6756
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7228
6757
|
created_at: string;
|
|
@@ -7280,6 +6809,7 @@ export declare namespace Price {
|
|
|
7280
6809
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7281
6810
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7282
6811
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6812
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7283
6813
|
conversion_rate: number | null;
|
|
7284
6814
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7285
6815
|
created_at: string;
|
|
@@ -7337,6 +6867,7 @@ export declare namespace Price {
|
|
|
7337
6867
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7338
6868
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7339
6869
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6870
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7340
6871
|
conversion_rate: number | null;
|
|
7341
6872
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7342
6873
|
created_at: string;
|
|
@@ -7394,6 +6925,7 @@ export declare namespace Price {
|
|
|
7394
6925
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7395
6926
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7396
6927
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6928
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7397
6929
|
conversion_rate: number | null;
|
|
7398
6930
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7399
6931
|
created_at: string;
|
|
@@ -7454,6 +6986,7 @@ export declare namespace Price {
|
|
|
7454
6986
|
[key: string]: unknown;
|
|
7455
6987
|
};
|
|
7456
6988
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
6989
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7457
6990
|
conversion_rate: number | null;
|
|
7458
6991
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7459
6992
|
created_at: string;
|
|
@@ -7508,6 +7041,7 @@ export declare namespace Price {
|
|
|
7508
7041
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7509
7042
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7510
7043
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7044
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7511
7045
|
conversion_rate: number | null;
|
|
7512
7046
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7513
7047
|
created_at: string;
|
|
@@ -7565,6 +7099,7 @@ export declare namespace Price {
|
|
|
7565
7099
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7566
7100
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7567
7101
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7102
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7568
7103
|
conversion_rate: number | null;
|
|
7569
7104
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7570
7105
|
created_at: string;
|
|
@@ -7622,6 +7157,7 @@ export declare namespace Price {
|
|
|
7622
7157
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7623
7158
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7624
7159
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7160
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7625
7161
|
conversion_rate: number | null;
|
|
7626
7162
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7627
7163
|
created_at: string;
|
|
@@ -7679,6 +7215,7 @@ export declare namespace Price {
|
|
|
7679
7215
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7680
7216
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7681
7217
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7218
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7682
7219
|
conversion_rate: number | null;
|
|
7683
7220
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7684
7221
|
created_at: string;
|
|
@@ -7736,6 +7273,7 @@ export declare namespace Price {
|
|
|
7736
7273
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7737
7274
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7738
7275
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7276
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7739
7277
|
conversion_rate: number | null;
|
|
7740
7278
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7741
7279
|
created_at: string;
|
|
@@ -7793,6 +7331,7 @@ export declare namespace Price {
|
|
|
7793
7331
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7794
7332
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7795
7333
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7334
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7796
7335
|
conversion_rate: number | null;
|
|
7797
7336
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7798
7337
|
created_at: string;
|
|
@@ -7845,6 +7384,75 @@ export declare namespace Price {
|
|
|
7845
7384
|
replaces_price_id: string | null;
|
|
7846
7385
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
7847
7386
|
}
|
|
7387
|
+
interface MinimumCompositePrice {
|
|
7388
|
+
id: string;
|
|
7389
|
+
billable_metric: Shared.BillableMetricTiny | null;
|
|
7390
|
+
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7391
|
+
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7392
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7393
|
+
conversion_rate: number | null;
|
|
7394
|
+
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7395
|
+
created_at: string;
|
|
7396
|
+
credit_allocation: Shared.Allocation | null;
|
|
7397
|
+
currency: string;
|
|
7398
|
+
/**
|
|
7399
|
+
* @deprecated
|
|
7400
|
+
*/
|
|
7401
|
+
discount: Shared.Discount | null;
|
|
7402
|
+
external_price_id: string | null;
|
|
7403
|
+
fixed_price_quantity: number | null;
|
|
7404
|
+
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
7405
|
+
item: Shared.ItemSlim;
|
|
7406
|
+
/**
|
|
7407
|
+
* @deprecated
|
|
7408
|
+
*/
|
|
7409
|
+
maximum: Shared.Maximum | null;
|
|
7410
|
+
/**
|
|
7411
|
+
* @deprecated
|
|
7412
|
+
*/
|
|
7413
|
+
maximum_amount: string | null;
|
|
7414
|
+
/**
|
|
7415
|
+
* User specified key-value pairs for the resource. If not present, this defaults
|
|
7416
|
+
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
7417
|
+
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
7418
|
+
* `null`.
|
|
7419
|
+
*/
|
|
7420
|
+
metadata: {
|
|
7421
|
+
[key: string]: string;
|
|
7422
|
+
};
|
|
7423
|
+
/**
|
|
7424
|
+
* @deprecated
|
|
7425
|
+
*/
|
|
7426
|
+
minimum: Shared.Minimum | null;
|
|
7427
|
+
/**
|
|
7428
|
+
* @deprecated
|
|
7429
|
+
*/
|
|
7430
|
+
minimum_amount: string | null;
|
|
7431
|
+
minimum_config: MinimumCompositePrice.MinimumConfig;
|
|
7432
|
+
model_type: 'minimum';
|
|
7433
|
+
name: string;
|
|
7434
|
+
plan_phase_order: number | null;
|
|
7435
|
+
price_type: 'usage_price' | 'fixed_price';
|
|
7436
|
+
/**
|
|
7437
|
+
* The price id this price replaces. This price will take the place of the replaced
|
|
7438
|
+
* price in plan version migrations.
|
|
7439
|
+
*/
|
|
7440
|
+
replaces_price_id: string | null;
|
|
7441
|
+
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
7442
|
+
}
|
|
7443
|
+
namespace MinimumCompositePrice {
|
|
7444
|
+
interface MinimumConfig {
|
|
7445
|
+
/**
|
|
7446
|
+
* The minimum amount to apply
|
|
7447
|
+
*/
|
|
7448
|
+
minimum_amount: string;
|
|
7449
|
+
/**
|
|
7450
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
7451
|
+
* service period. Set to false to disable proration.
|
|
7452
|
+
*/
|
|
7453
|
+
prorated?: boolean | null;
|
|
7454
|
+
}
|
|
7455
|
+
}
|
|
7848
7456
|
}
|
|
7849
7457
|
/**
|
|
7850
7458
|
* The Price Interval resource represents a period of time for which a price will
|
|
@@ -7973,13 +7581,6 @@ export interface TierSubLineItem {
|
|
|
7973
7581
|
tier_config: TierConfig;
|
|
7974
7582
|
type: 'tier';
|
|
7975
7583
|
}
|
|
7976
|
-
export interface TieredBPSConfig {
|
|
7977
|
-
/**
|
|
7978
|
-
* Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
|
7979
|
-
* tiers
|
|
7980
|
-
*/
|
|
7981
|
-
tiers: Array<BPSTier>;
|
|
7982
|
-
}
|
|
7983
7584
|
export interface TieredConfig {
|
|
7984
7585
|
/**
|
|
7985
7586
|
* Tiers for rating based on total usage quantities into the specified tier
|