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
|
@@ -4389,7 +4389,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
4389
4389
|
/**
|
|
4390
4390
|
* New subscription price request body params.
|
|
4391
4391
|
*/
|
|
4392
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | AddPrice.NewSubscriptionCumulativeGroupedAllocationPrice | AddPrice.NewSubscriptionDailyCreditAllowancePrice | AddPrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
|
|
4392
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | AddPrice.NewSubscriptionGroupedTieredMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | AddPrice.NewSubscriptionCumulativeGroupedAllocationPrice | AddPrice.NewSubscriptionDailyCreditAllowancePrice | AddPrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
|
|
4393
4393
|
/**
|
|
4394
4394
|
* The id of the price to add to the subscription.
|
|
4395
4395
|
*/
|
|
@@ -4534,6 +4534,131 @@ export declare namespace SubscriptionCreateParams {
|
|
|
4534
4534
|
}
|
|
4535
4535
|
}
|
|
4536
4536
|
}
|
|
4537
|
+
interface NewSubscriptionGroupedTieredMatrixPrice {
|
|
4538
|
+
/**
|
|
4539
|
+
* The cadence to bill for this price on.
|
|
4540
|
+
*/
|
|
4541
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4542
|
+
/**
|
|
4543
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
4544
|
+
*/
|
|
4545
|
+
grouped_tiered_matrix_config: NewSubscriptionGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
4546
|
+
/**
|
|
4547
|
+
* The id of the item the price will be associated with.
|
|
4548
|
+
*/
|
|
4549
|
+
item_id: string;
|
|
4550
|
+
/**
|
|
4551
|
+
* The pricing model type
|
|
4552
|
+
*/
|
|
4553
|
+
model_type: 'grouped_tiered_matrix';
|
|
4554
|
+
/**
|
|
4555
|
+
* The name of the price.
|
|
4556
|
+
*/
|
|
4557
|
+
name: string;
|
|
4558
|
+
/**
|
|
4559
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4560
|
+
* usage-based.
|
|
4561
|
+
*/
|
|
4562
|
+
billable_metric_id?: string | null;
|
|
4563
|
+
/**
|
|
4564
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4565
|
+
* this is true, and in-arrears if this is false.
|
|
4566
|
+
*/
|
|
4567
|
+
billed_in_advance?: boolean | null;
|
|
4568
|
+
/**
|
|
4569
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4570
|
+
* months.
|
|
4571
|
+
*/
|
|
4572
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4573
|
+
/**
|
|
4574
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4575
|
+
*/
|
|
4576
|
+
conversion_rate?: number | null;
|
|
4577
|
+
/**
|
|
4578
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4579
|
+
*/
|
|
4580
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
4581
|
+
/**
|
|
4582
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4583
|
+
* price is billed.
|
|
4584
|
+
*/
|
|
4585
|
+
currency?: string | null;
|
|
4586
|
+
/**
|
|
4587
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4588
|
+
*/
|
|
4589
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
4590
|
+
/**
|
|
4591
|
+
* An alias for the price.
|
|
4592
|
+
*/
|
|
4593
|
+
external_price_id?: string | null;
|
|
4594
|
+
/**
|
|
4595
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4596
|
+
* applied.
|
|
4597
|
+
*/
|
|
4598
|
+
fixed_price_quantity?: number | null;
|
|
4599
|
+
/**
|
|
4600
|
+
* The property used to group this price on an invoice
|
|
4601
|
+
*/
|
|
4602
|
+
invoice_grouping_key?: string | null;
|
|
4603
|
+
/**
|
|
4604
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4605
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4606
|
+
*/
|
|
4607
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4608
|
+
/**
|
|
4609
|
+
* The ID of the license type to associate with this price.
|
|
4610
|
+
*/
|
|
4611
|
+
license_type_id?: string | null;
|
|
4612
|
+
/**
|
|
4613
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4614
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4615
|
+
* by setting `metadata` to `null`.
|
|
4616
|
+
*/
|
|
4617
|
+
metadata?: {
|
|
4618
|
+
[key: string]: string | null;
|
|
4619
|
+
} | null;
|
|
4620
|
+
/**
|
|
4621
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
4622
|
+
* in the same API call.
|
|
4623
|
+
*/
|
|
4624
|
+
reference_id?: string | null;
|
|
4625
|
+
}
|
|
4626
|
+
namespace NewSubscriptionGroupedTieredMatrixPrice {
|
|
4627
|
+
/**
|
|
4628
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
4629
|
+
*/
|
|
4630
|
+
interface GroupedTieredMatrixConfig {
|
|
4631
|
+
/**
|
|
4632
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
4633
|
+
*/
|
|
4634
|
+
default_unit_amount: string;
|
|
4635
|
+
/**
|
|
4636
|
+
* The billable metric property used to group usage before tiering
|
|
4637
|
+
*/
|
|
4638
|
+
dimension: string;
|
|
4639
|
+
/**
|
|
4640
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
4641
|
+
* against its own rows
|
|
4642
|
+
*/
|
|
4643
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
4644
|
+
}
|
|
4645
|
+
namespace GroupedTieredMatrixConfig {
|
|
4646
|
+
/**
|
|
4647
|
+
* Configuration for a single tier scoped to a dimension value
|
|
4648
|
+
*/
|
|
4649
|
+
interface Tier {
|
|
4650
|
+
/**
|
|
4651
|
+
* The dimension value this tier applies to
|
|
4652
|
+
*/
|
|
4653
|
+
dimension_value: string;
|
|
4654
|
+
tier_lower_bound: string;
|
|
4655
|
+
/**
|
|
4656
|
+
* Per unit amount
|
|
4657
|
+
*/
|
|
4658
|
+
unit_amount: string;
|
|
4659
|
+
}
|
|
4660
|
+
}
|
|
4661
|
+
}
|
|
4537
4662
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
4538
4663
|
/**
|
|
4539
4664
|
* The cadence to bill for this price on.
|
|
@@ -5632,7 +5757,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
5632
5757
|
/**
|
|
5633
5758
|
* New subscription price request body params.
|
|
5634
5759
|
*/
|
|
5635
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | ReplacePrice.NewSubscriptionCumulativeGroupedAllocationPrice | ReplacePrice.NewSubscriptionDailyCreditAllowancePrice | ReplacePrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
|
|
5760
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | ReplacePrice.NewSubscriptionGroupedTieredMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | ReplacePrice.NewSubscriptionCumulativeGroupedAllocationPrice | ReplacePrice.NewSubscriptionDailyCreditAllowancePrice | ReplacePrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
|
|
5636
5761
|
/**
|
|
5637
5762
|
* The id of the price to add to the subscription.
|
|
5638
5763
|
*/
|
|
@@ -5771,6 +5896,131 @@ export declare namespace SubscriptionCreateParams {
|
|
|
5771
5896
|
}
|
|
5772
5897
|
}
|
|
5773
5898
|
}
|
|
5899
|
+
interface NewSubscriptionGroupedTieredMatrixPrice {
|
|
5900
|
+
/**
|
|
5901
|
+
* The cadence to bill for this price on.
|
|
5902
|
+
*/
|
|
5903
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
5904
|
+
/**
|
|
5905
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
5906
|
+
*/
|
|
5907
|
+
grouped_tiered_matrix_config: NewSubscriptionGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
5908
|
+
/**
|
|
5909
|
+
* The id of the item the price will be associated with.
|
|
5910
|
+
*/
|
|
5911
|
+
item_id: string;
|
|
5912
|
+
/**
|
|
5913
|
+
* The pricing model type
|
|
5914
|
+
*/
|
|
5915
|
+
model_type: 'grouped_tiered_matrix';
|
|
5916
|
+
/**
|
|
5917
|
+
* The name of the price.
|
|
5918
|
+
*/
|
|
5919
|
+
name: string;
|
|
5920
|
+
/**
|
|
5921
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
5922
|
+
* usage-based.
|
|
5923
|
+
*/
|
|
5924
|
+
billable_metric_id?: string | null;
|
|
5925
|
+
/**
|
|
5926
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
5927
|
+
* this is true, and in-arrears if this is false.
|
|
5928
|
+
*/
|
|
5929
|
+
billed_in_advance?: boolean | null;
|
|
5930
|
+
/**
|
|
5931
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5932
|
+
* months.
|
|
5933
|
+
*/
|
|
5934
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
5935
|
+
/**
|
|
5936
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
5937
|
+
*/
|
|
5938
|
+
conversion_rate?: number | null;
|
|
5939
|
+
/**
|
|
5940
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
5941
|
+
*/
|
|
5942
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
5943
|
+
/**
|
|
5944
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
5945
|
+
* price is billed.
|
|
5946
|
+
*/
|
|
5947
|
+
currency?: string | null;
|
|
5948
|
+
/**
|
|
5949
|
+
* For dimensional price: specifies a price group and dimension values
|
|
5950
|
+
*/
|
|
5951
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
5952
|
+
/**
|
|
5953
|
+
* An alias for the price.
|
|
5954
|
+
*/
|
|
5955
|
+
external_price_id?: string | null;
|
|
5956
|
+
/**
|
|
5957
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
5958
|
+
* applied.
|
|
5959
|
+
*/
|
|
5960
|
+
fixed_price_quantity?: number | null;
|
|
5961
|
+
/**
|
|
5962
|
+
* The property used to group this price on an invoice
|
|
5963
|
+
*/
|
|
5964
|
+
invoice_grouping_key?: string | null;
|
|
5965
|
+
/**
|
|
5966
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5967
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5968
|
+
*/
|
|
5969
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
5970
|
+
/**
|
|
5971
|
+
* The ID of the license type to associate with this price.
|
|
5972
|
+
*/
|
|
5973
|
+
license_type_id?: string | null;
|
|
5974
|
+
/**
|
|
5975
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
5976
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
5977
|
+
* by setting `metadata` to `null`.
|
|
5978
|
+
*/
|
|
5979
|
+
metadata?: {
|
|
5980
|
+
[key: string]: string | null;
|
|
5981
|
+
} | null;
|
|
5982
|
+
/**
|
|
5983
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
5984
|
+
* in the same API call.
|
|
5985
|
+
*/
|
|
5986
|
+
reference_id?: string | null;
|
|
5987
|
+
}
|
|
5988
|
+
namespace NewSubscriptionGroupedTieredMatrixPrice {
|
|
5989
|
+
/**
|
|
5990
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
5991
|
+
*/
|
|
5992
|
+
interface GroupedTieredMatrixConfig {
|
|
5993
|
+
/**
|
|
5994
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
5995
|
+
*/
|
|
5996
|
+
default_unit_amount: string;
|
|
5997
|
+
/**
|
|
5998
|
+
* The billable metric property used to group usage before tiering
|
|
5999
|
+
*/
|
|
6000
|
+
dimension: string;
|
|
6001
|
+
/**
|
|
6002
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
6003
|
+
* against its own rows
|
|
6004
|
+
*/
|
|
6005
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
6006
|
+
}
|
|
6007
|
+
namespace GroupedTieredMatrixConfig {
|
|
6008
|
+
/**
|
|
6009
|
+
* Configuration for a single tier scoped to a dimension value
|
|
6010
|
+
*/
|
|
6011
|
+
interface Tier {
|
|
6012
|
+
/**
|
|
6013
|
+
* The dimension value this tier applies to
|
|
6014
|
+
*/
|
|
6015
|
+
dimension_value: string;
|
|
6016
|
+
tier_lower_bound: string;
|
|
6017
|
+
/**
|
|
6018
|
+
* Per unit amount
|
|
6019
|
+
*/
|
|
6020
|
+
unit_amount: string;
|
|
6021
|
+
}
|
|
6022
|
+
}
|
|
6023
|
+
}
|
|
5774
6024
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
5775
6025
|
/**
|
|
5776
6026
|
* The cadence to bill for this price on.
|
|
@@ -6958,7 +7208,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
6958
7208
|
/**
|
|
6959
7209
|
* New floating price request body params.
|
|
6960
7210
|
*/
|
|
6961
|
-
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Add.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Add.NewFloatingCumulativeGroupedAllocationPrice | Add.NewFloatingDailyCreditAllowancePrice | Add.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | Add.NewFloatingPercentCompositePrice | Add.NewFloatingEventOutputPrice | null;
|
|
7211
|
+
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Add.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Add.NewFloatingGroupedTieredMatrixPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Add.NewFloatingCumulativeGroupedAllocationPrice | Add.NewFloatingDailyCreditAllowancePrice | Add.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | Add.NewFloatingPercentCompositePrice | Add.NewFloatingEventOutputPrice | null;
|
|
6962
7212
|
/**
|
|
6963
7213
|
* The id of the price to add to the subscription.
|
|
6964
7214
|
*/
|
|
@@ -7007,11 +7257,133 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7007
7257
|
*/
|
|
7008
7258
|
quantity: number;
|
|
7009
7259
|
}
|
|
7010
|
-
interface NewFloatingBulkWithFiltersPrice {
|
|
7011
|
-
/**
|
|
7012
|
-
* Configuration for bulk_with_filters pricing
|
|
7013
|
-
*/
|
|
7014
|
-
bulk_with_filters_config: NewFloatingBulkWithFiltersPrice.BulkWithFiltersConfig;
|
|
7260
|
+
interface NewFloatingBulkWithFiltersPrice {
|
|
7261
|
+
/**
|
|
7262
|
+
* Configuration for bulk_with_filters pricing
|
|
7263
|
+
*/
|
|
7264
|
+
bulk_with_filters_config: NewFloatingBulkWithFiltersPrice.BulkWithFiltersConfig;
|
|
7265
|
+
/**
|
|
7266
|
+
* The cadence to bill for this price on.
|
|
7267
|
+
*/
|
|
7268
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
7269
|
+
/**
|
|
7270
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
7271
|
+
*/
|
|
7272
|
+
currency: string;
|
|
7273
|
+
/**
|
|
7274
|
+
* The id of the item the price will be associated with.
|
|
7275
|
+
*/
|
|
7276
|
+
item_id: string;
|
|
7277
|
+
/**
|
|
7278
|
+
* The pricing model type
|
|
7279
|
+
*/
|
|
7280
|
+
model_type: 'bulk_with_filters';
|
|
7281
|
+
/**
|
|
7282
|
+
* The name of the price.
|
|
7283
|
+
*/
|
|
7284
|
+
name: string;
|
|
7285
|
+
/**
|
|
7286
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
7287
|
+
* usage-based.
|
|
7288
|
+
*/
|
|
7289
|
+
billable_metric_id?: string | null;
|
|
7290
|
+
/**
|
|
7291
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
7292
|
+
* this is true, and in-arrears if this is false.
|
|
7293
|
+
*/
|
|
7294
|
+
billed_in_advance?: boolean | null;
|
|
7295
|
+
/**
|
|
7296
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
7297
|
+
* months.
|
|
7298
|
+
*/
|
|
7299
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
7300
|
+
/**
|
|
7301
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
7302
|
+
*/
|
|
7303
|
+
conversion_rate?: number | null;
|
|
7304
|
+
/**
|
|
7305
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
7306
|
+
*/
|
|
7307
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7308
|
+
/**
|
|
7309
|
+
* For dimensional price: specifies a price group and dimension values
|
|
7310
|
+
*/
|
|
7311
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
7312
|
+
/**
|
|
7313
|
+
* An alias for the price.
|
|
7314
|
+
*/
|
|
7315
|
+
external_price_id?: string | null;
|
|
7316
|
+
/**
|
|
7317
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
7318
|
+
* applied.
|
|
7319
|
+
*/
|
|
7320
|
+
fixed_price_quantity?: number | null;
|
|
7321
|
+
/**
|
|
7322
|
+
* The property used to group this price on an invoice
|
|
7323
|
+
*/
|
|
7324
|
+
invoice_grouping_key?: string | null;
|
|
7325
|
+
/**
|
|
7326
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
7327
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
7328
|
+
*/
|
|
7329
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
7330
|
+
/**
|
|
7331
|
+
* The ID of the license type to associate with this price.
|
|
7332
|
+
*/
|
|
7333
|
+
license_type_id?: string | null;
|
|
7334
|
+
/**
|
|
7335
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
7336
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
7337
|
+
* by setting `metadata` to `null`.
|
|
7338
|
+
*/
|
|
7339
|
+
metadata?: {
|
|
7340
|
+
[key: string]: string | null;
|
|
7341
|
+
} | null;
|
|
7342
|
+
}
|
|
7343
|
+
namespace NewFloatingBulkWithFiltersPrice {
|
|
7344
|
+
/**
|
|
7345
|
+
* Configuration for bulk_with_filters pricing
|
|
7346
|
+
*/
|
|
7347
|
+
interface BulkWithFiltersConfig {
|
|
7348
|
+
/**
|
|
7349
|
+
* Property filters to apply (all must match)
|
|
7350
|
+
*/
|
|
7351
|
+
filters: Array<BulkWithFiltersConfig.Filter>;
|
|
7352
|
+
/**
|
|
7353
|
+
* Bulk tiers for rating based on total usage volume
|
|
7354
|
+
*/
|
|
7355
|
+
tiers: Array<BulkWithFiltersConfig.Tier>;
|
|
7356
|
+
}
|
|
7357
|
+
namespace BulkWithFiltersConfig {
|
|
7358
|
+
/**
|
|
7359
|
+
* Configuration for a single property filter
|
|
7360
|
+
*/
|
|
7361
|
+
interface Filter {
|
|
7362
|
+
/**
|
|
7363
|
+
* Event property key to filter on
|
|
7364
|
+
*/
|
|
7365
|
+
property_key: string;
|
|
7366
|
+
/**
|
|
7367
|
+
* Event property value to match
|
|
7368
|
+
*/
|
|
7369
|
+
property_value: string;
|
|
7370
|
+
}
|
|
7371
|
+
/**
|
|
7372
|
+
* Configuration for a single bulk pricing tier
|
|
7373
|
+
*/
|
|
7374
|
+
interface Tier {
|
|
7375
|
+
/**
|
|
7376
|
+
* Amount per unit
|
|
7377
|
+
*/
|
|
7378
|
+
unit_amount: string;
|
|
7379
|
+
/**
|
|
7380
|
+
* The lower bound for this tier
|
|
7381
|
+
*/
|
|
7382
|
+
tier_lower_bound?: string | null;
|
|
7383
|
+
}
|
|
7384
|
+
}
|
|
7385
|
+
}
|
|
7386
|
+
interface NewFloatingGroupedTieredMatrixPrice {
|
|
7015
7387
|
/**
|
|
7016
7388
|
* The cadence to bill for this price on.
|
|
7017
7389
|
*/
|
|
@@ -7020,6 +7392,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7020
7392
|
* An ISO 4217 currency string for which this price is billed in.
|
|
7021
7393
|
*/
|
|
7022
7394
|
currency: string;
|
|
7395
|
+
/**
|
|
7396
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
7397
|
+
*/
|
|
7398
|
+
grouped_tiered_matrix_config: NewFloatingGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
7023
7399
|
/**
|
|
7024
7400
|
* The id of the item the price will be associated with.
|
|
7025
7401
|
*/
|
|
@@ -7027,7 +7403,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7027
7403
|
/**
|
|
7028
7404
|
* The pricing model type
|
|
7029
7405
|
*/
|
|
7030
|
-
model_type: '
|
|
7406
|
+
model_type: 'grouped_tiered_matrix';
|
|
7031
7407
|
/**
|
|
7032
7408
|
* The name of the price.
|
|
7033
7409
|
*/
|
|
@@ -7090,46 +7466,39 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7090
7466
|
[key: string]: string | null;
|
|
7091
7467
|
} | null;
|
|
7092
7468
|
}
|
|
7093
|
-
namespace
|
|
7469
|
+
namespace NewFloatingGroupedTieredMatrixPrice {
|
|
7094
7470
|
/**
|
|
7095
|
-
* Configuration for
|
|
7471
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
7096
7472
|
*/
|
|
7097
|
-
interface
|
|
7473
|
+
interface GroupedTieredMatrixConfig {
|
|
7098
7474
|
/**
|
|
7099
|
-
*
|
|
7475
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
7100
7476
|
*/
|
|
7101
|
-
|
|
7477
|
+
default_unit_amount: string;
|
|
7102
7478
|
/**
|
|
7103
|
-
*
|
|
7479
|
+
* The billable metric property used to group usage before tiering
|
|
7104
7480
|
*/
|
|
7105
|
-
|
|
7106
|
-
}
|
|
7107
|
-
namespace BulkWithFiltersConfig {
|
|
7481
|
+
dimension: string;
|
|
7108
7482
|
/**
|
|
7109
|
-
*
|
|
7483
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
7484
|
+
* against its own rows
|
|
7110
7485
|
*/
|
|
7111
|
-
|
|
7112
|
-
|
|
7113
|
-
|
|
7114
|
-
*/
|
|
7115
|
-
property_key: string;
|
|
7116
|
-
/**
|
|
7117
|
-
* Event property value to match
|
|
7118
|
-
*/
|
|
7119
|
-
property_value: string;
|
|
7120
|
-
}
|
|
7486
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
7487
|
+
}
|
|
7488
|
+
namespace GroupedTieredMatrixConfig {
|
|
7121
7489
|
/**
|
|
7122
|
-
* Configuration for a single
|
|
7490
|
+
* Configuration for a single tier scoped to a dimension value
|
|
7123
7491
|
*/
|
|
7124
7492
|
interface Tier {
|
|
7125
7493
|
/**
|
|
7126
|
-
*
|
|
7494
|
+
* The dimension value this tier applies to
|
|
7127
7495
|
*/
|
|
7128
|
-
|
|
7496
|
+
dimension_value: string;
|
|
7497
|
+
tier_lower_bound: string;
|
|
7129
7498
|
/**
|
|
7130
|
-
*
|
|
7499
|
+
* Per unit amount
|
|
7131
7500
|
*/
|
|
7132
|
-
|
|
7501
|
+
unit_amount: string;
|
|
7133
7502
|
}
|
|
7134
7503
|
}
|
|
7135
7504
|
}
|
|
@@ -8411,7 +8780,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
8411
8780
|
/**
|
|
8412
8781
|
* New subscription price request body params.
|
|
8413
8782
|
*/
|
|
8414
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | AddPrice.NewSubscriptionCumulativeGroupedAllocationPrice | AddPrice.NewSubscriptionDailyCreditAllowancePrice | AddPrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
|
|
8783
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | AddPrice.NewSubscriptionGroupedTieredMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | AddPrice.NewSubscriptionCumulativeGroupedAllocationPrice | AddPrice.NewSubscriptionDailyCreditAllowancePrice | AddPrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
|
|
8415
8784
|
/**
|
|
8416
8785
|
* The id of the price to add to the subscription.
|
|
8417
8786
|
*/
|
|
@@ -8556,6 +8925,131 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
8556
8925
|
}
|
|
8557
8926
|
}
|
|
8558
8927
|
}
|
|
8928
|
+
interface NewSubscriptionGroupedTieredMatrixPrice {
|
|
8929
|
+
/**
|
|
8930
|
+
* The cadence to bill for this price on.
|
|
8931
|
+
*/
|
|
8932
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
8933
|
+
/**
|
|
8934
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
8935
|
+
*/
|
|
8936
|
+
grouped_tiered_matrix_config: NewSubscriptionGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
8937
|
+
/**
|
|
8938
|
+
* The id of the item the price will be associated with.
|
|
8939
|
+
*/
|
|
8940
|
+
item_id: string;
|
|
8941
|
+
/**
|
|
8942
|
+
* The pricing model type
|
|
8943
|
+
*/
|
|
8944
|
+
model_type: 'grouped_tiered_matrix';
|
|
8945
|
+
/**
|
|
8946
|
+
* The name of the price.
|
|
8947
|
+
*/
|
|
8948
|
+
name: string;
|
|
8949
|
+
/**
|
|
8950
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
8951
|
+
* usage-based.
|
|
8952
|
+
*/
|
|
8953
|
+
billable_metric_id?: string | null;
|
|
8954
|
+
/**
|
|
8955
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
8956
|
+
* this is true, and in-arrears if this is false.
|
|
8957
|
+
*/
|
|
8958
|
+
billed_in_advance?: boolean | null;
|
|
8959
|
+
/**
|
|
8960
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
8961
|
+
* months.
|
|
8962
|
+
*/
|
|
8963
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
8964
|
+
/**
|
|
8965
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
8966
|
+
*/
|
|
8967
|
+
conversion_rate?: number | null;
|
|
8968
|
+
/**
|
|
8969
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
8970
|
+
*/
|
|
8971
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8972
|
+
/**
|
|
8973
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
8974
|
+
* price is billed.
|
|
8975
|
+
*/
|
|
8976
|
+
currency?: string | null;
|
|
8977
|
+
/**
|
|
8978
|
+
* For dimensional price: specifies a price group and dimension values
|
|
8979
|
+
*/
|
|
8980
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
8981
|
+
/**
|
|
8982
|
+
* An alias for the price.
|
|
8983
|
+
*/
|
|
8984
|
+
external_price_id?: string | null;
|
|
8985
|
+
/**
|
|
8986
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
8987
|
+
* applied.
|
|
8988
|
+
*/
|
|
8989
|
+
fixed_price_quantity?: number | null;
|
|
8990
|
+
/**
|
|
8991
|
+
* The property used to group this price on an invoice
|
|
8992
|
+
*/
|
|
8993
|
+
invoice_grouping_key?: string | null;
|
|
8994
|
+
/**
|
|
8995
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
8996
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
8997
|
+
*/
|
|
8998
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
8999
|
+
/**
|
|
9000
|
+
* The ID of the license type to associate with this price.
|
|
9001
|
+
*/
|
|
9002
|
+
license_type_id?: string | null;
|
|
9003
|
+
/**
|
|
9004
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
9005
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
9006
|
+
* by setting `metadata` to `null`.
|
|
9007
|
+
*/
|
|
9008
|
+
metadata?: {
|
|
9009
|
+
[key: string]: string | null;
|
|
9010
|
+
} | null;
|
|
9011
|
+
/**
|
|
9012
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
9013
|
+
* in the same API call.
|
|
9014
|
+
*/
|
|
9015
|
+
reference_id?: string | null;
|
|
9016
|
+
}
|
|
9017
|
+
namespace NewSubscriptionGroupedTieredMatrixPrice {
|
|
9018
|
+
/**
|
|
9019
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
9020
|
+
*/
|
|
9021
|
+
interface GroupedTieredMatrixConfig {
|
|
9022
|
+
/**
|
|
9023
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
9024
|
+
*/
|
|
9025
|
+
default_unit_amount: string;
|
|
9026
|
+
/**
|
|
9027
|
+
* The billable metric property used to group usage before tiering
|
|
9028
|
+
*/
|
|
9029
|
+
dimension: string;
|
|
9030
|
+
/**
|
|
9031
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
9032
|
+
* against its own rows
|
|
9033
|
+
*/
|
|
9034
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
9035
|
+
}
|
|
9036
|
+
namespace GroupedTieredMatrixConfig {
|
|
9037
|
+
/**
|
|
9038
|
+
* Configuration for a single tier scoped to a dimension value
|
|
9039
|
+
*/
|
|
9040
|
+
interface Tier {
|
|
9041
|
+
/**
|
|
9042
|
+
* The dimension value this tier applies to
|
|
9043
|
+
*/
|
|
9044
|
+
dimension_value: string;
|
|
9045
|
+
tier_lower_bound: string;
|
|
9046
|
+
/**
|
|
9047
|
+
* Per unit amount
|
|
9048
|
+
*/
|
|
9049
|
+
unit_amount: string;
|
|
9050
|
+
}
|
|
9051
|
+
}
|
|
9052
|
+
}
|
|
8559
9053
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
8560
9054
|
/**
|
|
8561
9055
|
* The cadence to bill for this price on.
|
|
@@ -9654,7 +10148,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
9654
10148
|
/**
|
|
9655
10149
|
* New subscription price request body params.
|
|
9656
10150
|
*/
|
|
9657
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | ReplacePrice.NewSubscriptionCumulativeGroupedAllocationPrice | ReplacePrice.NewSubscriptionDailyCreditAllowancePrice | ReplacePrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
|
|
10151
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | ReplacePrice.NewSubscriptionGroupedTieredMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionMatrixWithThresholdDiscountsPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | ReplacePrice.NewSubscriptionCumulativeGroupedAllocationPrice | ReplacePrice.NewSubscriptionDailyCreditAllowancePrice | ReplacePrice.NewSubscriptionMeteredAllowancePrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
|
|
9658
10152
|
/**
|
|
9659
10153
|
* The id of the price to add to the subscription.
|
|
9660
10154
|
*/
|
|
@@ -9793,6 +10287,131 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
9793
10287
|
}
|
|
9794
10288
|
}
|
|
9795
10289
|
}
|
|
10290
|
+
interface NewSubscriptionGroupedTieredMatrixPrice {
|
|
10291
|
+
/**
|
|
10292
|
+
* The cadence to bill for this price on.
|
|
10293
|
+
*/
|
|
10294
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
10295
|
+
/**
|
|
10296
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
10297
|
+
*/
|
|
10298
|
+
grouped_tiered_matrix_config: NewSubscriptionGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
10299
|
+
/**
|
|
10300
|
+
* The id of the item the price will be associated with.
|
|
10301
|
+
*/
|
|
10302
|
+
item_id: string;
|
|
10303
|
+
/**
|
|
10304
|
+
* The pricing model type
|
|
10305
|
+
*/
|
|
10306
|
+
model_type: 'grouped_tiered_matrix';
|
|
10307
|
+
/**
|
|
10308
|
+
* The name of the price.
|
|
10309
|
+
*/
|
|
10310
|
+
name: string;
|
|
10311
|
+
/**
|
|
10312
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
10313
|
+
* usage-based.
|
|
10314
|
+
*/
|
|
10315
|
+
billable_metric_id?: string | null;
|
|
10316
|
+
/**
|
|
10317
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
10318
|
+
* this is true, and in-arrears if this is false.
|
|
10319
|
+
*/
|
|
10320
|
+
billed_in_advance?: boolean | null;
|
|
10321
|
+
/**
|
|
10322
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
10323
|
+
* months.
|
|
10324
|
+
*/
|
|
10325
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
10326
|
+
/**
|
|
10327
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
10328
|
+
*/
|
|
10329
|
+
conversion_rate?: number | null;
|
|
10330
|
+
/**
|
|
10331
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
10332
|
+
*/
|
|
10333
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
10334
|
+
/**
|
|
10335
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
10336
|
+
* price is billed.
|
|
10337
|
+
*/
|
|
10338
|
+
currency?: string | null;
|
|
10339
|
+
/**
|
|
10340
|
+
* For dimensional price: specifies a price group and dimension values
|
|
10341
|
+
*/
|
|
10342
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
10343
|
+
/**
|
|
10344
|
+
* An alias for the price.
|
|
10345
|
+
*/
|
|
10346
|
+
external_price_id?: string | null;
|
|
10347
|
+
/**
|
|
10348
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
10349
|
+
* applied.
|
|
10350
|
+
*/
|
|
10351
|
+
fixed_price_quantity?: number | null;
|
|
10352
|
+
/**
|
|
10353
|
+
* The property used to group this price on an invoice
|
|
10354
|
+
*/
|
|
10355
|
+
invoice_grouping_key?: string | null;
|
|
10356
|
+
/**
|
|
10357
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
10358
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
10359
|
+
*/
|
|
10360
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
10361
|
+
/**
|
|
10362
|
+
* The ID of the license type to associate with this price.
|
|
10363
|
+
*/
|
|
10364
|
+
license_type_id?: string | null;
|
|
10365
|
+
/**
|
|
10366
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
10367
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
10368
|
+
* by setting `metadata` to `null`.
|
|
10369
|
+
*/
|
|
10370
|
+
metadata?: {
|
|
10371
|
+
[key: string]: string | null;
|
|
10372
|
+
} | null;
|
|
10373
|
+
/**
|
|
10374
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
10375
|
+
* in the same API call.
|
|
10376
|
+
*/
|
|
10377
|
+
reference_id?: string | null;
|
|
10378
|
+
}
|
|
10379
|
+
namespace NewSubscriptionGroupedTieredMatrixPrice {
|
|
10380
|
+
/**
|
|
10381
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
10382
|
+
*/
|
|
10383
|
+
interface GroupedTieredMatrixConfig {
|
|
10384
|
+
/**
|
|
10385
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
10386
|
+
*/
|
|
10387
|
+
default_unit_amount: string;
|
|
10388
|
+
/**
|
|
10389
|
+
* The billable metric property used to group usage before tiering
|
|
10390
|
+
*/
|
|
10391
|
+
dimension: string;
|
|
10392
|
+
/**
|
|
10393
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
10394
|
+
* against its own rows
|
|
10395
|
+
*/
|
|
10396
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
10397
|
+
}
|
|
10398
|
+
namespace GroupedTieredMatrixConfig {
|
|
10399
|
+
/**
|
|
10400
|
+
* Configuration for a single tier scoped to a dimension value
|
|
10401
|
+
*/
|
|
10402
|
+
interface Tier {
|
|
10403
|
+
/**
|
|
10404
|
+
* The dimension value this tier applies to
|
|
10405
|
+
*/
|
|
10406
|
+
dimension_value: string;
|
|
10407
|
+
tier_lower_bound: string;
|
|
10408
|
+
/**
|
|
10409
|
+
* Per unit amount
|
|
10410
|
+
*/
|
|
10411
|
+
unit_amount: string;
|
|
10412
|
+
}
|
|
10413
|
+
}
|
|
10414
|
+
}
|
|
9796
10415
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
9797
10416
|
/**
|
|
9798
10417
|
* The cadence to bill for this price on.
|