orb-billing 6.8.0 → 6.10.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 +21 -0
- package/package.json +1 -1
- package/resources/beta/beta.d.mts +252 -2
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +252 -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.mts +252 -2
- package/resources/beta/external-plan-id.d.mts.map +1 -1
- package/resources/beta/external-plan-id.d.ts +252 -2
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/customers/costs.d.mts +20 -0
- package/resources/customers/costs.d.mts.map +1 -1
- package/resources/customers/costs.d.ts +20 -0
- package/resources/customers/costs.d.ts.map +1 -1
- package/resources/customers/costs.js +20 -0
- package/resources/customers/costs.js.map +1 -1
- package/resources/customers/costs.mjs +20 -0
- package/resources/customers/costs.mjs.map +1 -1
- package/resources/invoices.d.mts +9 -9
- package/resources/invoices.d.ts +9 -9
- package/resources/licenses/external-licenses.d.mts +7 -0
- package/resources/licenses/external-licenses.d.mts.map +1 -1
- package/resources/licenses/external-licenses.d.ts +7 -0
- package/resources/licenses/external-licenses.d.ts.map +1 -1
- package/resources/licenses/external-licenses.js +7 -0
- package/resources/licenses/external-licenses.js.map +1 -1
- package/resources/licenses/external-licenses.mjs +7 -0
- package/resources/licenses/external-licenses.mjs.map +1 -1
- package/resources/licenses/usage.d.mts +3 -0
- package/resources/licenses/usage.d.mts.map +1 -1
- package/resources/licenses/usage.d.ts +3 -0
- package/resources/licenses/usage.d.ts.map +1 -1
- package/resources/licenses/usage.js +3 -0
- package/resources/licenses/usage.js.map +1 -1
- package/resources/licenses/usage.mjs +3 -0
- package/resources/licenses/usage.mjs.map +1 -1
- package/resources/plans/plans.d.mts +126 -1
- package/resources/plans/plans.d.mts.map +1 -1
- package/resources/plans/plans.d.ts +126 -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.mts +360 -3
- package/resources/prices/prices.d.mts.map +1 -1
- package/resources/prices/prices.d.ts +360 -3
- 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.mts +151 -7
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +151 -7
- package/resources/shared.d.ts.map +1 -1
- package/resources/subscriptions.d.mts +655 -36
- package/resources/subscriptions.d.mts.map +1 -1
- package/resources/subscriptions.d.ts +655 -36
- package/resources/subscriptions.d.ts.map +1 -1
- package/src/resources/beta/beta.ts +298 -0
- package/src/resources/beta/external-plan-id.ts +298 -0
- package/src/resources/customers/costs.ts +20 -0
- package/src/resources/invoices.ts +9 -9
- package/src/resources/licenses/external-licenses.ts +7 -0
- package/src/resources/licenses/usage.ts +3 -0
- package/src/resources/plans/plans.ts +149 -0
- package/src/resources/prices/prices.ts +426 -0
- package/src/resources/shared.ts +191 -6
- package/src/resources/subscriptions.ts +845 -107
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -253,7 +253,7 @@ export declare namespace PriceEvaluatePreviewEventsResponse {
|
|
|
253
253
|
price_id?: string | null;
|
|
254
254
|
}
|
|
255
255
|
}
|
|
256
|
-
export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingBulkWithFiltersPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingMatrixWithThresholdDiscountsPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingCumulativeGroupedAllocationPrice | PriceCreateParams.NewFloatingDailyCreditAllowancePrice | PriceCreateParams.NewFloatingMeteredAllowancePrice | PriceCreateParams.NewFloatingMinimumCompositePrice | PriceCreateParams.NewFloatingPercentCompositePrice | PriceCreateParams.NewFloatingEventOutputPrice;
|
|
256
|
+
export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingBulkWithFiltersPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingGroupedTieredMatrixPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingMatrixWithThresholdDiscountsPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingCumulativeGroupedAllocationPrice | PriceCreateParams.NewFloatingDailyCreditAllowancePrice | PriceCreateParams.NewFloatingMeteredAllowancePrice | PriceCreateParams.NewFloatingMinimumCompositePrice | PriceCreateParams.NewFloatingPercentCompositePrice | PriceCreateParams.NewFloatingEventOutputPrice;
|
|
257
257
|
export declare namespace PriceCreateParams {
|
|
258
258
|
interface NewFloatingUnitPrice {
|
|
259
259
|
/**
|
|
@@ -1244,6 +1244,125 @@ export declare namespace PriceCreateParams {
|
|
|
1244
1244
|
}
|
|
1245
1245
|
}
|
|
1246
1246
|
}
|
|
1247
|
+
interface NewFloatingGroupedTieredMatrixPrice {
|
|
1248
|
+
/**
|
|
1249
|
+
* The cadence to bill for this price on.
|
|
1250
|
+
*/
|
|
1251
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
1252
|
+
/**
|
|
1253
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
1254
|
+
*/
|
|
1255
|
+
currency: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
1258
|
+
*/
|
|
1259
|
+
grouped_tiered_matrix_config: NewFloatingGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
1260
|
+
/**
|
|
1261
|
+
* The id of the item the price will be associated with.
|
|
1262
|
+
*/
|
|
1263
|
+
item_id: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* The pricing model type
|
|
1266
|
+
*/
|
|
1267
|
+
model_type: 'grouped_tiered_matrix';
|
|
1268
|
+
/**
|
|
1269
|
+
* The name of the price.
|
|
1270
|
+
*/
|
|
1271
|
+
name: string;
|
|
1272
|
+
/**
|
|
1273
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
1274
|
+
* usage-based.
|
|
1275
|
+
*/
|
|
1276
|
+
billable_metric_id?: string | null;
|
|
1277
|
+
/**
|
|
1278
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
1279
|
+
* this is true, and in-arrears if this is false.
|
|
1280
|
+
*/
|
|
1281
|
+
billed_in_advance?: boolean | null;
|
|
1282
|
+
/**
|
|
1283
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1284
|
+
* months.
|
|
1285
|
+
*/
|
|
1286
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
1287
|
+
/**
|
|
1288
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1289
|
+
*/
|
|
1290
|
+
conversion_rate?: number | null;
|
|
1291
|
+
/**
|
|
1292
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
1293
|
+
*/
|
|
1294
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
1295
|
+
/**
|
|
1296
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1297
|
+
*/
|
|
1298
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
1299
|
+
/**
|
|
1300
|
+
* An alias for the price.
|
|
1301
|
+
*/
|
|
1302
|
+
external_price_id?: string | null;
|
|
1303
|
+
/**
|
|
1304
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
1305
|
+
* applied.
|
|
1306
|
+
*/
|
|
1307
|
+
fixed_price_quantity?: number | null;
|
|
1308
|
+
/**
|
|
1309
|
+
* The property used to group this price on an invoice
|
|
1310
|
+
*/
|
|
1311
|
+
invoice_grouping_key?: string | null;
|
|
1312
|
+
/**
|
|
1313
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1314
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1315
|
+
*/
|
|
1316
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
1317
|
+
/**
|
|
1318
|
+
* The ID of the license type to associate with this price.
|
|
1319
|
+
*/
|
|
1320
|
+
license_type_id?: string | null;
|
|
1321
|
+
/**
|
|
1322
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1323
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
1324
|
+
* by setting `metadata` to `null`.
|
|
1325
|
+
*/
|
|
1326
|
+
metadata?: {
|
|
1327
|
+
[key: string]: string | null;
|
|
1328
|
+
} | null;
|
|
1329
|
+
}
|
|
1330
|
+
namespace NewFloatingGroupedTieredMatrixPrice {
|
|
1331
|
+
/**
|
|
1332
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
1333
|
+
*/
|
|
1334
|
+
interface GroupedTieredMatrixConfig {
|
|
1335
|
+
/**
|
|
1336
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
1337
|
+
*/
|
|
1338
|
+
default_unit_amount: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* The billable metric property used to group usage before tiering
|
|
1341
|
+
*/
|
|
1342
|
+
dimension: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
1345
|
+
* against its own rows
|
|
1346
|
+
*/
|
|
1347
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
1348
|
+
}
|
|
1349
|
+
namespace GroupedTieredMatrixConfig {
|
|
1350
|
+
/**
|
|
1351
|
+
* Configuration for a single tier scoped to a dimension value
|
|
1352
|
+
*/
|
|
1353
|
+
interface Tier {
|
|
1354
|
+
/**
|
|
1355
|
+
* The dimension value this tier applies to
|
|
1356
|
+
*/
|
|
1357
|
+
dimension_value: string;
|
|
1358
|
+
tier_lower_bound: string;
|
|
1359
|
+
/**
|
|
1360
|
+
* Per unit amount
|
|
1361
|
+
*/
|
|
1362
|
+
unit_amount: string;
|
|
1363
|
+
}
|
|
1364
|
+
}
|
|
1365
|
+
}
|
|
1247
1366
|
interface NewFloatingTieredPackageWithMinimumPrice {
|
|
1248
1367
|
/**
|
|
1249
1368
|
* The cadence to bill for this price on.
|
|
@@ -3978,7 +4097,7 @@ export declare namespace PriceEvaluateMultipleParams {
|
|
|
3978
4097
|
/**
|
|
3979
4098
|
* New floating price request body params.
|
|
3980
4099
|
*/
|
|
3981
|
-
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
|
|
4100
|
+
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | PriceEvaluation.NewFloatingGroupedTieredMatrixPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
|
|
3982
4101
|
/**
|
|
3983
4102
|
* The ID of a price to evaluate that exists in your Orb account.
|
|
3984
4103
|
*/
|
|
@@ -4111,6 +4230,125 @@ export declare namespace PriceEvaluateMultipleParams {
|
|
|
4111
4230
|
}
|
|
4112
4231
|
}
|
|
4113
4232
|
}
|
|
4233
|
+
interface NewFloatingGroupedTieredMatrixPrice {
|
|
4234
|
+
/**
|
|
4235
|
+
* The cadence to bill for this price on.
|
|
4236
|
+
*/
|
|
4237
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4238
|
+
/**
|
|
4239
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
4240
|
+
*/
|
|
4241
|
+
currency: string;
|
|
4242
|
+
/**
|
|
4243
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
4244
|
+
*/
|
|
4245
|
+
grouped_tiered_matrix_config: NewFloatingGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
4246
|
+
/**
|
|
4247
|
+
* The id of the item the price will be associated with.
|
|
4248
|
+
*/
|
|
4249
|
+
item_id: string;
|
|
4250
|
+
/**
|
|
4251
|
+
* The pricing model type
|
|
4252
|
+
*/
|
|
4253
|
+
model_type: 'grouped_tiered_matrix';
|
|
4254
|
+
/**
|
|
4255
|
+
* The name of the price.
|
|
4256
|
+
*/
|
|
4257
|
+
name: string;
|
|
4258
|
+
/**
|
|
4259
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4260
|
+
* usage-based.
|
|
4261
|
+
*/
|
|
4262
|
+
billable_metric_id?: string | null;
|
|
4263
|
+
/**
|
|
4264
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4265
|
+
* this is true, and in-arrears if this is false.
|
|
4266
|
+
*/
|
|
4267
|
+
billed_in_advance?: boolean | null;
|
|
4268
|
+
/**
|
|
4269
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4270
|
+
* months.
|
|
4271
|
+
*/
|
|
4272
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4273
|
+
/**
|
|
4274
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4275
|
+
*/
|
|
4276
|
+
conversion_rate?: number | null;
|
|
4277
|
+
/**
|
|
4278
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4279
|
+
*/
|
|
4280
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
4281
|
+
/**
|
|
4282
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4283
|
+
*/
|
|
4284
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
4285
|
+
/**
|
|
4286
|
+
* An alias for the price.
|
|
4287
|
+
*/
|
|
4288
|
+
external_price_id?: string | null;
|
|
4289
|
+
/**
|
|
4290
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4291
|
+
* applied.
|
|
4292
|
+
*/
|
|
4293
|
+
fixed_price_quantity?: number | null;
|
|
4294
|
+
/**
|
|
4295
|
+
* The property used to group this price on an invoice
|
|
4296
|
+
*/
|
|
4297
|
+
invoice_grouping_key?: string | null;
|
|
4298
|
+
/**
|
|
4299
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4300
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4301
|
+
*/
|
|
4302
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4303
|
+
/**
|
|
4304
|
+
* The ID of the license type to associate with this price.
|
|
4305
|
+
*/
|
|
4306
|
+
license_type_id?: string | null;
|
|
4307
|
+
/**
|
|
4308
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4309
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4310
|
+
* by setting `metadata` to `null`.
|
|
4311
|
+
*/
|
|
4312
|
+
metadata?: {
|
|
4313
|
+
[key: string]: string | null;
|
|
4314
|
+
} | null;
|
|
4315
|
+
}
|
|
4316
|
+
namespace NewFloatingGroupedTieredMatrixPrice {
|
|
4317
|
+
/**
|
|
4318
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
4319
|
+
*/
|
|
4320
|
+
interface GroupedTieredMatrixConfig {
|
|
4321
|
+
/**
|
|
4322
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
4323
|
+
*/
|
|
4324
|
+
default_unit_amount: string;
|
|
4325
|
+
/**
|
|
4326
|
+
* The billable metric property used to group usage before tiering
|
|
4327
|
+
*/
|
|
4328
|
+
dimension: string;
|
|
4329
|
+
/**
|
|
4330
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
4331
|
+
* against its own rows
|
|
4332
|
+
*/
|
|
4333
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
4334
|
+
}
|
|
4335
|
+
namespace GroupedTieredMatrixConfig {
|
|
4336
|
+
/**
|
|
4337
|
+
* Configuration for a single tier scoped to a dimension value
|
|
4338
|
+
*/
|
|
4339
|
+
interface Tier {
|
|
4340
|
+
/**
|
|
4341
|
+
* The dimension value this tier applies to
|
|
4342
|
+
*/
|
|
4343
|
+
dimension_value: string;
|
|
4344
|
+
tier_lower_bound: string;
|
|
4345
|
+
/**
|
|
4346
|
+
* Per unit amount
|
|
4347
|
+
*/
|
|
4348
|
+
unit_amount: string;
|
|
4349
|
+
}
|
|
4350
|
+
}
|
|
4351
|
+
}
|
|
4114
4352
|
interface NewFloatingMatrixWithThresholdDiscountsPrice {
|
|
4115
4353
|
/**
|
|
4116
4354
|
* The cadence to bill for this price on.
|
|
@@ -5001,7 +5239,7 @@ export declare namespace PriceEvaluatePreviewEventsParams {
|
|
|
5001
5239
|
/**
|
|
5002
5240
|
* New floating price request body params.
|
|
5003
5241
|
*/
|
|
5004
|
-
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
|
|
5242
|
+
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | PriceEvaluation.NewFloatingGroupedTieredMatrixPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
|
|
5005
5243
|
/**
|
|
5006
5244
|
* The ID of a price to evaluate that exists in your Orb account.
|
|
5007
5245
|
*/
|
|
@@ -5134,6 +5372,125 @@ export declare namespace PriceEvaluatePreviewEventsParams {
|
|
|
5134
5372
|
}
|
|
5135
5373
|
}
|
|
5136
5374
|
}
|
|
5375
|
+
interface NewFloatingGroupedTieredMatrixPrice {
|
|
5376
|
+
/**
|
|
5377
|
+
* The cadence to bill for this price on.
|
|
5378
|
+
*/
|
|
5379
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
5380
|
+
/**
|
|
5381
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
5382
|
+
*/
|
|
5383
|
+
currency: string;
|
|
5384
|
+
/**
|
|
5385
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
5386
|
+
*/
|
|
5387
|
+
grouped_tiered_matrix_config: NewFloatingGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
5388
|
+
/**
|
|
5389
|
+
* The id of the item the price will be associated with.
|
|
5390
|
+
*/
|
|
5391
|
+
item_id: string;
|
|
5392
|
+
/**
|
|
5393
|
+
* The pricing model type
|
|
5394
|
+
*/
|
|
5395
|
+
model_type: 'grouped_tiered_matrix';
|
|
5396
|
+
/**
|
|
5397
|
+
* The name of the price.
|
|
5398
|
+
*/
|
|
5399
|
+
name: string;
|
|
5400
|
+
/**
|
|
5401
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
5402
|
+
* usage-based.
|
|
5403
|
+
*/
|
|
5404
|
+
billable_metric_id?: string | null;
|
|
5405
|
+
/**
|
|
5406
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
5407
|
+
* this is true, and in-arrears if this is false.
|
|
5408
|
+
*/
|
|
5409
|
+
billed_in_advance?: boolean | null;
|
|
5410
|
+
/**
|
|
5411
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5412
|
+
* months.
|
|
5413
|
+
*/
|
|
5414
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
5415
|
+
/**
|
|
5416
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
5417
|
+
*/
|
|
5418
|
+
conversion_rate?: number | null;
|
|
5419
|
+
/**
|
|
5420
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
5421
|
+
*/
|
|
5422
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
5423
|
+
/**
|
|
5424
|
+
* For dimensional price: specifies a price group and dimension values
|
|
5425
|
+
*/
|
|
5426
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
5427
|
+
/**
|
|
5428
|
+
* An alias for the price.
|
|
5429
|
+
*/
|
|
5430
|
+
external_price_id?: string | null;
|
|
5431
|
+
/**
|
|
5432
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
5433
|
+
* applied.
|
|
5434
|
+
*/
|
|
5435
|
+
fixed_price_quantity?: number | null;
|
|
5436
|
+
/**
|
|
5437
|
+
* The property used to group this price on an invoice
|
|
5438
|
+
*/
|
|
5439
|
+
invoice_grouping_key?: string | null;
|
|
5440
|
+
/**
|
|
5441
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5442
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5443
|
+
*/
|
|
5444
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
5445
|
+
/**
|
|
5446
|
+
* The ID of the license type to associate with this price.
|
|
5447
|
+
*/
|
|
5448
|
+
license_type_id?: string | null;
|
|
5449
|
+
/**
|
|
5450
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
5451
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
5452
|
+
* by setting `metadata` to `null`.
|
|
5453
|
+
*/
|
|
5454
|
+
metadata?: {
|
|
5455
|
+
[key: string]: string | null;
|
|
5456
|
+
} | null;
|
|
5457
|
+
}
|
|
5458
|
+
namespace NewFloatingGroupedTieredMatrixPrice {
|
|
5459
|
+
/**
|
|
5460
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
5461
|
+
*/
|
|
5462
|
+
interface GroupedTieredMatrixConfig {
|
|
5463
|
+
/**
|
|
5464
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
5465
|
+
*/
|
|
5466
|
+
default_unit_amount: string;
|
|
5467
|
+
/**
|
|
5468
|
+
* The billable metric property used to group usage before tiering
|
|
5469
|
+
*/
|
|
5470
|
+
dimension: string;
|
|
5471
|
+
/**
|
|
5472
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
5473
|
+
* against its own rows
|
|
5474
|
+
*/
|
|
5475
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
5476
|
+
}
|
|
5477
|
+
namespace GroupedTieredMatrixConfig {
|
|
5478
|
+
/**
|
|
5479
|
+
* Configuration for a single tier scoped to a dimension value
|
|
5480
|
+
*/
|
|
5481
|
+
interface Tier {
|
|
5482
|
+
/**
|
|
5483
|
+
* The dimension value this tier applies to
|
|
5484
|
+
*/
|
|
5485
|
+
dimension_value: string;
|
|
5486
|
+
tier_lower_bound: string;
|
|
5487
|
+
/**
|
|
5488
|
+
* Per unit amount
|
|
5489
|
+
*/
|
|
5490
|
+
unit_amount: string;
|
|
5491
|
+
}
|
|
5492
|
+
}
|
|
5493
|
+
}
|
|
5137
5494
|
interface NewFloatingMatrixWithThresholdDiscountsPrice {
|
|
5138
5495
|
/**
|
|
5139
5496
|
* The cadence to bill for this price on.
|