orb-billing 6.14.0 → 6.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/package.json +1 -1
- package/resources/beta/beta.d.mts +276 -2
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +276 -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 +276 -2
- package/resources/beta/external-plan-id.d.mts.map +1 -1
- package/resources/beta/external-plan-id.d.ts +276 -2
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/customers/credits/top-ups.d.mts +14 -2
- package/resources/customers/credits/top-ups.d.mts.map +1 -1
- package/resources/customers/credits/top-ups.d.ts +14 -2
- package/resources/customers/credits/top-ups.d.ts.map +1 -1
- package/resources/customers/credits/top-ups.js +14 -2
- package/resources/customers/credits/top-ups.js.map +1 -1
- package/resources/customers/credits/top-ups.mjs +14 -2
- package/resources/customers/credits/top-ups.mjs.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.d.mts +11 -2
- package/resources/dimensional-price-groups/dimensional-price-groups.d.mts.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +11 -2
- package/resources/dimensional-price-groups/dimensional-price-groups.d.ts.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.js +11 -2
- package/resources/dimensional-price-groups/dimensional-price-groups.js.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.mjs +11 -2
- package/resources/dimensional-price-groups/dimensional-price-groups.mjs.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.mts +4 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.mts.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts +4 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.js +4 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.js.map +1 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs +4 -1
- package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs.map +1 -1
- package/resources/items.d.mts +3 -1
- package/resources/items.d.mts.map +1 -1
- package/resources/items.d.ts +3 -1
- package/resources/items.d.ts.map +1 -1
- package/resources/items.js +3 -1
- package/resources/items.js.map +1 -1
- package/resources/items.mjs +3 -1
- package/resources/items.mjs.map +1 -1
- package/resources/plans/migrations.d.mts +3 -1
- package/resources/plans/migrations.d.mts.map +1 -1
- package/resources/plans/migrations.d.ts +3 -1
- package/resources/plans/migrations.d.ts.map +1 -1
- package/resources/plans/migrations.js +3 -1
- package/resources/plans/migrations.js.map +1 -1
- package/resources/plans/migrations.mjs +3 -1
- package/resources/plans/migrations.mjs.map +1 -1
- package/resources/plans/plans.d.mts +138 -1
- package/resources/plans/plans.d.mts.map +1 -1
- package/resources/plans/plans.d.ts +138 -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 +396 -3
- package/resources/prices/prices.d.mts.map +1 -1
- package/resources/prices/prices.d.ts +396 -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 +153 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +153 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/subscriptions.d.mts +702 -23
- package/resources/subscriptions.d.mts.map +1 -1
- package/resources/subscriptions.d.ts +702 -23
- package/resources/subscriptions.d.ts.map +1 -1
- package/src/resources/beta/beta.ts +324 -0
- package/src/resources/beta/external-plan-id.ts +324 -0
- package/src/resources/customers/credits/top-ups.ts +14 -2
- package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +11 -2
- package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts +4 -1
- package/src/resources/items.ts +3 -1
- package/src/resources/plans/migrations.ts +3 -1
- package/src/resources/plans/plans.ts +162 -0
- package/src/resources/prices/prices.ts +465 -0
- package/src/resources/shared.ts +194 -0
- package/src/resources/subscriptions.ts +931 -128
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -4522,7 +4522,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
4522
4522
|
/**
|
|
4523
4523
|
* New subscription price request body params.
|
|
4524
4524
|
*/
|
|
4525
|
-
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;
|
|
4525
|
+
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.NewSubscriptionTieredMatrixWithAllocationPrice | 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;
|
|
4526
4526
|
/**
|
|
4527
4527
|
* The id of the price to add to the subscription.
|
|
4528
4528
|
*/
|
|
@@ -4800,6 +4800,143 @@ export declare namespace SubscriptionCreateParams {
|
|
|
4800
4800
|
}
|
|
4801
4801
|
}
|
|
4802
4802
|
}
|
|
4803
|
+
interface NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
4804
|
+
/**
|
|
4805
|
+
* The cadence to bill for this price on.
|
|
4806
|
+
*/
|
|
4807
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4808
|
+
/**
|
|
4809
|
+
* The id of the item the price will be associated with.
|
|
4810
|
+
*/
|
|
4811
|
+
item_id: string;
|
|
4812
|
+
/**
|
|
4813
|
+
* The pricing model type
|
|
4814
|
+
*/
|
|
4815
|
+
model_type: 'tiered_matrix_with_allocation';
|
|
4816
|
+
/**
|
|
4817
|
+
* The name of the price.
|
|
4818
|
+
*/
|
|
4819
|
+
name: string;
|
|
4820
|
+
/**
|
|
4821
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
4822
|
+
*/
|
|
4823
|
+
tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
|
|
4824
|
+
/**
|
|
4825
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4826
|
+
* usage-based.
|
|
4827
|
+
*/
|
|
4828
|
+
billable_metric_id?: string | null;
|
|
4829
|
+
/**
|
|
4830
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4831
|
+
* this is true, and in-arrears if this is false.
|
|
4832
|
+
*/
|
|
4833
|
+
billed_in_advance?: boolean | null;
|
|
4834
|
+
/**
|
|
4835
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4836
|
+
* months.
|
|
4837
|
+
*/
|
|
4838
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4839
|
+
/**
|
|
4840
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4841
|
+
*/
|
|
4842
|
+
conversion_rate?: number | null;
|
|
4843
|
+
/**
|
|
4844
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4845
|
+
*/
|
|
4846
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
4847
|
+
/**
|
|
4848
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4849
|
+
* price is billed.
|
|
4850
|
+
*/
|
|
4851
|
+
currency?: string | null;
|
|
4852
|
+
/**
|
|
4853
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4854
|
+
*/
|
|
4855
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
4856
|
+
/**
|
|
4857
|
+
* An alias for the price.
|
|
4858
|
+
*/
|
|
4859
|
+
external_price_id?: string | null;
|
|
4860
|
+
/**
|
|
4861
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4862
|
+
* applied.
|
|
4863
|
+
*/
|
|
4864
|
+
fixed_price_quantity?: number | null;
|
|
4865
|
+
/**
|
|
4866
|
+
* The property used to group this price on an invoice
|
|
4867
|
+
*/
|
|
4868
|
+
invoice_grouping_key?: string | null;
|
|
4869
|
+
/**
|
|
4870
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4871
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4872
|
+
*/
|
|
4873
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4874
|
+
/**
|
|
4875
|
+
* The ID of the license type to associate with this price. On a usage price this
|
|
4876
|
+
* also marks the price as eligible to draw down from that license type's
|
|
4877
|
+
* allocation; a usage price created without it is billed normally. Usage prices
|
|
4878
|
+
* with a license type must use the `unit` model, and only draw down when their
|
|
4879
|
+
* currency matches the allocation's.
|
|
4880
|
+
*/
|
|
4881
|
+
license_type_id?: string | null;
|
|
4882
|
+
/**
|
|
4883
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4884
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4885
|
+
* by setting `metadata` to `null`.
|
|
4886
|
+
*/
|
|
4887
|
+
metadata?: {
|
|
4888
|
+
[key: string]: string | null;
|
|
4889
|
+
} | null;
|
|
4890
|
+
/**
|
|
4891
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
4892
|
+
* in the same API call.
|
|
4893
|
+
*/
|
|
4894
|
+
reference_id?: string | null;
|
|
4895
|
+
}
|
|
4896
|
+
namespace NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
4897
|
+
/**
|
|
4898
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
4899
|
+
*/
|
|
4900
|
+
interface TieredMatrixWithAllocationConfig {
|
|
4901
|
+
/**
|
|
4902
|
+
* Usage allocation, pooled across all matrix cells
|
|
4903
|
+
*/
|
|
4904
|
+
allocation: string;
|
|
4905
|
+
/**
|
|
4906
|
+
* Per unit rate for usage whose matrix cell has no configured tiers
|
|
4907
|
+
*/
|
|
4908
|
+
default_unit_amount: string;
|
|
4909
|
+
/**
|
|
4910
|
+
* One or two event property values to evaluate matrix cells by
|
|
4911
|
+
*/
|
|
4912
|
+
dimensions: Array<string>;
|
|
4913
|
+
/**
|
|
4914
|
+
* Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
4915
|
+
* own rows
|
|
4916
|
+
*/
|
|
4917
|
+
tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
|
|
4918
|
+
}
|
|
4919
|
+
namespace TieredMatrixWithAllocationConfig {
|
|
4920
|
+
/**
|
|
4921
|
+
* Configuration for a single tier scoped to one matrix cell
|
|
4922
|
+
*/
|
|
4923
|
+
interface Tier {
|
|
4924
|
+
/**
|
|
4925
|
+
* The matrix cell this tier applies to, as one or two dimension values
|
|
4926
|
+
*/
|
|
4927
|
+
dimension_values: Array<string>;
|
|
4928
|
+
/**
|
|
4929
|
+
* Exclusive tier starting value. The tier runs up to and including the next bound
|
|
4930
|
+
* configured for the same matrix cell.
|
|
4931
|
+
*/
|
|
4932
|
+
tier_lower_bound: string;
|
|
4933
|
+
/**
|
|
4934
|
+
* Per unit amount
|
|
4935
|
+
*/
|
|
4936
|
+
unit_amount: string;
|
|
4937
|
+
}
|
|
4938
|
+
}
|
|
4939
|
+
}
|
|
4803
4940
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
4804
4941
|
/**
|
|
4805
4942
|
* The cadence to bill for this price on.
|
|
@@ -5930,7 +6067,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
5930
6067
|
/**
|
|
5931
6068
|
* New subscription price request body params.
|
|
5932
6069
|
*/
|
|
5933
|
-
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;
|
|
6070
|
+
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.NewSubscriptionTieredMatrixWithAllocationPrice | 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;
|
|
5934
6071
|
/**
|
|
5935
6072
|
* The id of the price to add to the subscription.
|
|
5936
6073
|
*/
|
|
@@ -6202,6 +6339,143 @@ export declare namespace SubscriptionCreateParams {
|
|
|
6202
6339
|
}
|
|
6203
6340
|
}
|
|
6204
6341
|
}
|
|
6342
|
+
interface NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
6343
|
+
/**
|
|
6344
|
+
* The cadence to bill for this price on.
|
|
6345
|
+
*/
|
|
6346
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
6347
|
+
/**
|
|
6348
|
+
* The id of the item the price will be associated with.
|
|
6349
|
+
*/
|
|
6350
|
+
item_id: string;
|
|
6351
|
+
/**
|
|
6352
|
+
* The pricing model type
|
|
6353
|
+
*/
|
|
6354
|
+
model_type: 'tiered_matrix_with_allocation';
|
|
6355
|
+
/**
|
|
6356
|
+
* The name of the price.
|
|
6357
|
+
*/
|
|
6358
|
+
name: string;
|
|
6359
|
+
/**
|
|
6360
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
6361
|
+
*/
|
|
6362
|
+
tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
|
|
6363
|
+
/**
|
|
6364
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
6365
|
+
* usage-based.
|
|
6366
|
+
*/
|
|
6367
|
+
billable_metric_id?: string | null;
|
|
6368
|
+
/**
|
|
6369
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
6370
|
+
* this is true, and in-arrears if this is false.
|
|
6371
|
+
*/
|
|
6372
|
+
billed_in_advance?: boolean | null;
|
|
6373
|
+
/**
|
|
6374
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
6375
|
+
* months.
|
|
6376
|
+
*/
|
|
6377
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
6378
|
+
/**
|
|
6379
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
6380
|
+
*/
|
|
6381
|
+
conversion_rate?: number | null;
|
|
6382
|
+
/**
|
|
6383
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
6384
|
+
*/
|
|
6385
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
6386
|
+
/**
|
|
6387
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
6388
|
+
* price is billed.
|
|
6389
|
+
*/
|
|
6390
|
+
currency?: string | null;
|
|
6391
|
+
/**
|
|
6392
|
+
* For dimensional price: specifies a price group and dimension values
|
|
6393
|
+
*/
|
|
6394
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
6395
|
+
/**
|
|
6396
|
+
* An alias for the price.
|
|
6397
|
+
*/
|
|
6398
|
+
external_price_id?: string | null;
|
|
6399
|
+
/**
|
|
6400
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
6401
|
+
* applied.
|
|
6402
|
+
*/
|
|
6403
|
+
fixed_price_quantity?: number | null;
|
|
6404
|
+
/**
|
|
6405
|
+
* The property used to group this price on an invoice
|
|
6406
|
+
*/
|
|
6407
|
+
invoice_grouping_key?: string | null;
|
|
6408
|
+
/**
|
|
6409
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
6410
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
6411
|
+
*/
|
|
6412
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
6413
|
+
/**
|
|
6414
|
+
* The ID of the license type to associate with this price. On a usage price this
|
|
6415
|
+
* also marks the price as eligible to draw down from that license type's
|
|
6416
|
+
* allocation; a usage price created without it is billed normally. Usage prices
|
|
6417
|
+
* with a license type must use the `unit` model, and only draw down when their
|
|
6418
|
+
* currency matches the allocation's.
|
|
6419
|
+
*/
|
|
6420
|
+
license_type_id?: string | null;
|
|
6421
|
+
/**
|
|
6422
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
6423
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
6424
|
+
* by setting `metadata` to `null`.
|
|
6425
|
+
*/
|
|
6426
|
+
metadata?: {
|
|
6427
|
+
[key: string]: string | null;
|
|
6428
|
+
} | null;
|
|
6429
|
+
/**
|
|
6430
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
6431
|
+
* in the same API call.
|
|
6432
|
+
*/
|
|
6433
|
+
reference_id?: string | null;
|
|
6434
|
+
}
|
|
6435
|
+
namespace NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
6436
|
+
/**
|
|
6437
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
6438
|
+
*/
|
|
6439
|
+
interface TieredMatrixWithAllocationConfig {
|
|
6440
|
+
/**
|
|
6441
|
+
* Usage allocation, pooled across all matrix cells
|
|
6442
|
+
*/
|
|
6443
|
+
allocation: string;
|
|
6444
|
+
/**
|
|
6445
|
+
* Per unit rate for usage whose matrix cell has no configured tiers
|
|
6446
|
+
*/
|
|
6447
|
+
default_unit_amount: string;
|
|
6448
|
+
/**
|
|
6449
|
+
* One or two event property values to evaluate matrix cells by
|
|
6450
|
+
*/
|
|
6451
|
+
dimensions: Array<string>;
|
|
6452
|
+
/**
|
|
6453
|
+
* Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
6454
|
+
* own rows
|
|
6455
|
+
*/
|
|
6456
|
+
tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
|
|
6457
|
+
}
|
|
6458
|
+
namespace TieredMatrixWithAllocationConfig {
|
|
6459
|
+
/**
|
|
6460
|
+
* Configuration for a single tier scoped to one matrix cell
|
|
6461
|
+
*/
|
|
6462
|
+
interface Tier {
|
|
6463
|
+
/**
|
|
6464
|
+
* The matrix cell this tier applies to, as one or two dimension values
|
|
6465
|
+
*/
|
|
6466
|
+
dimension_values: Array<string>;
|
|
6467
|
+
/**
|
|
6468
|
+
* Exclusive tier starting value. The tier runs up to and including the next bound
|
|
6469
|
+
* configured for the same matrix cell.
|
|
6470
|
+
*/
|
|
6471
|
+
tier_lower_bound: string;
|
|
6472
|
+
/**
|
|
6473
|
+
* Per unit amount
|
|
6474
|
+
*/
|
|
6475
|
+
unit_amount: string;
|
|
6476
|
+
}
|
|
6477
|
+
}
|
|
6478
|
+
}
|
|
6205
6479
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
6206
6480
|
/**
|
|
6207
6481
|
* The cadence to bill for this price on.
|
|
@@ -7421,7 +7695,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7421
7695
|
/**
|
|
7422
7696
|
* New floating price request body params.
|
|
7423
7697
|
*/
|
|
7424
|
-
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;
|
|
7698
|
+
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.NewFloatingTieredMatrixWithAllocationPrice | 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;
|
|
7425
7699
|
/**
|
|
7426
7700
|
* The id of the price to add to the subscription.
|
|
7427
7701
|
*/
|
|
@@ -7609,10 +7883,129 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7609
7883
|
* An ISO 4217 currency string for which this price is billed in.
|
|
7610
7884
|
*/
|
|
7611
7885
|
currency: string;
|
|
7612
|
-
/**
|
|
7613
|
-
* Configuration for grouped_tiered_matrix pricing
|
|
7614
|
-
*/
|
|
7615
|
-
grouped_tiered_matrix_config: NewFloatingGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
7886
|
+
/**
|
|
7887
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
7888
|
+
*/
|
|
7889
|
+
grouped_tiered_matrix_config: NewFloatingGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
|
|
7890
|
+
/**
|
|
7891
|
+
* The id of the item the price will be associated with.
|
|
7892
|
+
*/
|
|
7893
|
+
item_id: string;
|
|
7894
|
+
/**
|
|
7895
|
+
* The pricing model type
|
|
7896
|
+
*/
|
|
7897
|
+
model_type: 'grouped_tiered_matrix';
|
|
7898
|
+
/**
|
|
7899
|
+
* The name of the price.
|
|
7900
|
+
*/
|
|
7901
|
+
name: string;
|
|
7902
|
+
/**
|
|
7903
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
7904
|
+
* usage-based.
|
|
7905
|
+
*/
|
|
7906
|
+
billable_metric_id?: string | null;
|
|
7907
|
+
/**
|
|
7908
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
7909
|
+
* this is true, and in-arrears if this is false.
|
|
7910
|
+
*/
|
|
7911
|
+
billed_in_advance?: boolean | null;
|
|
7912
|
+
/**
|
|
7913
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
7914
|
+
* months.
|
|
7915
|
+
*/
|
|
7916
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
7917
|
+
/**
|
|
7918
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
7919
|
+
*/
|
|
7920
|
+
conversion_rate?: number | null;
|
|
7921
|
+
/**
|
|
7922
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
7923
|
+
*/
|
|
7924
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7925
|
+
/**
|
|
7926
|
+
* For dimensional price: specifies a price group and dimension values
|
|
7927
|
+
*/
|
|
7928
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
7929
|
+
/**
|
|
7930
|
+
* An alias for the price.
|
|
7931
|
+
*/
|
|
7932
|
+
external_price_id?: string | null;
|
|
7933
|
+
/**
|
|
7934
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
7935
|
+
* applied.
|
|
7936
|
+
*/
|
|
7937
|
+
fixed_price_quantity?: number | null;
|
|
7938
|
+
/**
|
|
7939
|
+
* The property used to group this price on an invoice
|
|
7940
|
+
*/
|
|
7941
|
+
invoice_grouping_key?: string | null;
|
|
7942
|
+
/**
|
|
7943
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
7944
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
7945
|
+
*/
|
|
7946
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
7947
|
+
/**
|
|
7948
|
+
* The ID of the license type to associate with this price. On a usage price this
|
|
7949
|
+
* also marks the price as eligible to draw down from that license type's
|
|
7950
|
+
* allocation; a usage price created without it is billed normally. Usage prices
|
|
7951
|
+
* with a license type must use the `unit` model, and only draw down when their
|
|
7952
|
+
* currency matches the allocation's.
|
|
7953
|
+
*/
|
|
7954
|
+
license_type_id?: string | null;
|
|
7955
|
+
/**
|
|
7956
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
7957
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
7958
|
+
* by setting `metadata` to `null`.
|
|
7959
|
+
*/
|
|
7960
|
+
metadata?: {
|
|
7961
|
+
[key: string]: string | null;
|
|
7962
|
+
} | null;
|
|
7963
|
+
}
|
|
7964
|
+
namespace NewFloatingGroupedTieredMatrixPrice {
|
|
7965
|
+
/**
|
|
7966
|
+
* Configuration for grouped_tiered_matrix pricing
|
|
7967
|
+
*/
|
|
7968
|
+
interface GroupedTieredMatrixConfig {
|
|
7969
|
+
/**
|
|
7970
|
+
* Per unit rate for usage whose dimension value has no configured tiers
|
|
7971
|
+
*/
|
|
7972
|
+
default_unit_amount: string;
|
|
7973
|
+
/**
|
|
7974
|
+
* The billable metric property used to group usage before tiering
|
|
7975
|
+
*/
|
|
7976
|
+
dimension: string;
|
|
7977
|
+
/**
|
|
7978
|
+
* Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
7979
|
+
* against its own rows
|
|
7980
|
+
*/
|
|
7981
|
+
tiers: Array<GroupedTieredMatrixConfig.Tier>;
|
|
7982
|
+
}
|
|
7983
|
+
namespace GroupedTieredMatrixConfig {
|
|
7984
|
+
/**
|
|
7985
|
+
* Configuration for a single tier scoped to a dimension value
|
|
7986
|
+
*/
|
|
7987
|
+
interface Tier {
|
|
7988
|
+
/**
|
|
7989
|
+
* The dimension value this tier applies to
|
|
7990
|
+
*/
|
|
7991
|
+
dimension_value: string;
|
|
7992
|
+
tier_lower_bound: string;
|
|
7993
|
+
/**
|
|
7994
|
+
* Per unit amount
|
|
7995
|
+
*/
|
|
7996
|
+
unit_amount: string;
|
|
7997
|
+
}
|
|
7998
|
+
}
|
|
7999
|
+
}
|
|
8000
|
+
interface NewFloatingTieredMatrixWithAllocationPrice {
|
|
8001
|
+
/**
|
|
8002
|
+
* The cadence to bill for this price on.
|
|
8003
|
+
*/
|
|
8004
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
8005
|
+
/**
|
|
8006
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
8007
|
+
*/
|
|
8008
|
+
currency: string;
|
|
7616
8009
|
/**
|
|
7617
8010
|
* The id of the item the price will be associated with.
|
|
7618
8011
|
*/
|
|
@@ -7620,11 +8013,15 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7620
8013
|
/**
|
|
7621
8014
|
* The pricing model type
|
|
7622
8015
|
*/
|
|
7623
|
-
model_type: '
|
|
8016
|
+
model_type: 'tiered_matrix_with_allocation';
|
|
7624
8017
|
/**
|
|
7625
8018
|
* The name of the price.
|
|
7626
8019
|
*/
|
|
7627
8020
|
name: string;
|
|
8021
|
+
/**
|
|
8022
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
8023
|
+
*/
|
|
8024
|
+
tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
|
|
7628
8025
|
/**
|
|
7629
8026
|
* The id of the billable metric for the price. Only needed if the price is
|
|
7630
8027
|
* usage-based.
|
|
@@ -7687,34 +8084,42 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
7687
8084
|
[key: string]: string | null;
|
|
7688
8085
|
} | null;
|
|
7689
8086
|
}
|
|
7690
|
-
namespace
|
|
8087
|
+
namespace NewFloatingTieredMatrixWithAllocationPrice {
|
|
7691
8088
|
/**
|
|
7692
|
-
* Configuration for
|
|
8089
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
7693
8090
|
*/
|
|
7694
|
-
interface
|
|
8091
|
+
interface TieredMatrixWithAllocationConfig {
|
|
7695
8092
|
/**
|
|
7696
|
-
*
|
|
8093
|
+
* Usage allocation, pooled across all matrix cells
|
|
8094
|
+
*/
|
|
8095
|
+
allocation: string;
|
|
8096
|
+
/**
|
|
8097
|
+
* Per unit rate for usage whose matrix cell has no configured tiers
|
|
7697
8098
|
*/
|
|
7698
8099
|
default_unit_amount: string;
|
|
7699
8100
|
/**
|
|
7700
|
-
*
|
|
8101
|
+
* One or two event property values to evaluate matrix cells by
|
|
7701
8102
|
*/
|
|
7702
|
-
|
|
8103
|
+
dimensions: Array<string>;
|
|
7703
8104
|
/**
|
|
7704
|
-
* Graduated tiers keyed by
|
|
7705
|
-
*
|
|
8105
|
+
* Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
8106
|
+
* own rows
|
|
7706
8107
|
*/
|
|
7707
|
-
tiers: Array<
|
|
8108
|
+
tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
|
|
7708
8109
|
}
|
|
7709
|
-
namespace
|
|
8110
|
+
namespace TieredMatrixWithAllocationConfig {
|
|
7710
8111
|
/**
|
|
7711
|
-
* Configuration for a single tier scoped to
|
|
8112
|
+
* Configuration for a single tier scoped to one matrix cell
|
|
7712
8113
|
*/
|
|
7713
8114
|
interface Tier {
|
|
7714
8115
|
/**
|
|
7715
|
-
* The
|
|
8116
|
+
* The matrix cell this tier applies to, as one or two dimension values
|
|
8117
|
+
*/
|
|
8118
|
+
dimension_values: Array<string>;
|
|
8119
|
+
/**
|
|
8120
|
+
* Exclusive tier starting value. The tier runs up to and including the next bound
|
|
8121
|
+
* configured for the same matrix cell.
|
|
7716
8122
|
*/
|
|
7717
|
-
dimension_value: string;
|
|
7718
8123
|
tier_lower_bound: string;
|
|
7719
8124
|
/**
|
|
7720
8125
|
* Per unit amount
|
|
@@ -9029,7 +9434,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
9029
9434
|
/**
|
|
9030
9435
|
* New subscription price request body params.
|
|
9031
9436
|
*/
|
|
9032
|
-
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;
|
|
9437
|
+
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.NewSubscriptionTieredMatrixWithAllocationPrice | 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;
|
|
9033
9438
|
/**
|
|
9034
9439
|
* The id of the price to add to the subscription.
|
|
9035
9440
|
*/
|
|
@@ -9307,6 +9712,143 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
9307
9712
|
}
|
|
9308
9713
|
}
|
|
9309
9714
|
}
|
|
9715
|
+
interface NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
9716
|
+
/**
|
|
9717
|
+
* The cadence to bill for this price on.
|
|
9718
|
+
*/
|
|
9719
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
9720
|
+
/**
|
|
9721
|
+
* The id of the item the price will be associated with.
|
|
9722
|
+
*/
|
|
9723
|
+
item_id: string;
|
|
9724
|
+
/**
|
|
9725
|
+
* The pricing model type
|
|
9726
|
+
*/
|
|
9727
|
+
model_type: 'tiered_matrix_with_allocation';
|
|
9728
|
+
/**
|
|
9729
|
+
* The name of the price.
|
|
9730
|
+
*/
|
|
9731
|
+
name: string;
|
|
9732
|
+
/**
|
|
9733
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
9734
|
+
*/
|
|
9735
|
+
tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
|
|
9736
|
+
/**
|
|
9737
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
9738
|
+
* usage-based.
|
|
9739
|
+
*/
|
|
9740
|
+
billable_metric_id?: string | null;
|
|
9741
|
+
/**
|
|
9742
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
9743
|
+
* this is true, and in-arrears if this is false.
|
|
9744
|
+
*/
|
|
9745
|
+
billed_in_advance?: boolean | null;
|
|
9746
|
+
/**
|
|
9747
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
9748
|
+
* months.
|
|
9749
|
+
*/
|
|
9750
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
9751
|
+
/**
|
|
9752
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
9753
|
+
*/
|
|
9754
|
+
conversion_rate?: number | null;
|
|
9755
|
+
/**
|
|
9756
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
9757
|
+
*/
|
|
9758
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9759
|
+
/**
|
|
9760
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
9761
|
+
* price is billed.
|
|
9762
|
+
*/
|
|
9763
|
+
currency?: string | null;
|
|
9764
|
+
/**
|
|
9765
|
+
* For dimensional price: specifies a price group and dimension values
|
|
9766
|
+
*/
|
|
9767
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
9768
|
+
/**
|
|
9769
|
+
* An alias for the price.
|
|
9770
|
+
*/
|
|
9771
|
+
external_price_id?: string | null;
|
|
9772
|
+
/**
|
|
9773
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
9774
|
+
* applied.
|
|
9775
|
+
*/
|
|
9776
|
+
fixed_price_quantity?: number | null;
|
|
9777
|
+
/**
|
|
9778
|
+
* The property used to group this price on an invoice
|
|
9779
|
+
*/
|
|
9780
|
+
invoice_grouping_key?: string | null;
|
|
9781
|
+
/**
|
|
9782
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
9783
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
9784
|
+
*/
|
|
9785
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
9786
|
+
/**
|
|
9787
|
+
* The ID of the license type to associate with this price. On a usage price this
|
|
9788
|
+
* also marks the price as eligible to draw down from that license type's
|
|
9789
|
+
* allocation; a usage price created without it is billed normally. Usage prices
|
|
9790
|
+
* with a license type must use the `unit` model, and only draw down when their
|
|
9791
|
+
* currency matches the allocation's.
|
|
9792
|
+
*/
|
|
9793
|
+
license_type_id?: string | null;
|
|
9794
|
+
/**
|
|
9795
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
9796
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
9797
|
+
* by setting `metadata` to `null`.
|
|
9798
|
+
*/
|
|
9799
|
+
metadata?: {
|
|
9800
|
+
[key: string]: string | null;
|
|
9801
|
+
} | null;
|
|
9802
|
+
/**
|
|
9803
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
9804
|
+
* in the same API call.
|
|
9805
|
+
*/
|
|
9806
|
+
reference_id?: string | null;
|
|
9807
|
+
}
|
|
9808
|
+
namespace NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
9809
|
+
/**
|
|
9810
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
9811
|
+
*/
|
|
9812
|
+
interface TieredMatrixWithAllocationConfig {
|
|
9813
|
+
/**
|
|
9814
|
+
* Usage allocation, pooled across all matrix cells
|
|
9815
|
+
*/
|
|
9816
|
+
allocation: string;
|
|
9817
|
+
/**
|
|
9818
|
+
* Per unit rate for usage whose matrix cell has no configured tiers
|
|
9819
|
+
*/
|
|
9820
|
+
default_unit_amount: string;
|
|
9821
|
+
/**
|
|
9822
|
+
* One or two event property values to evaluate matrix cells by
|
|
9823
|
+
*/
|
|
9824
|
+
dimensions: Array<string>;
|
|
9825
|
+
/**
|
|
9826
|
+
* Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
9827
|
+
* own rows
|
|
9828
|
+
*/
|
|
9829
|
+
tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
|
|
9830
|
+
}
|
|
9831
|
+
namespace TieredMatrixWithAllocationConfig {
|
|
9832
|
+
/**
|
|
9833
|
+
* Configuration for a single tier scoped to one matrix cell
|
|
9834
|
+
*/
|
|
9835
|
+
interface Tier {
|
|
9836
|
+
/**
|
|
9837
|
+
* The matrix cell this tier applies to, as one or two dimension values
|
|
9838
|
+
*/
|
|
9839
|
+
dimension_values: Array<string>;
|
|
9840
|
+
/**
|
|
9841
|
+
* Exclusive tier starting value. The tier runs up to and including the next bound
|
|
9842
|
+
* configured for the same matrix cell.
|
|
9843
|
+
*/
|
|
9844
|
+
tier_lower_bound: string;
|
|
9845
|
+
/**
|
|
9846
|
+
* Per unit amount
|
|
9847
|
+
*/
|
|
9848
|
+
unit_amount: string;
|
|
9849
|
+
}
|
|
9850
|
+
}
|
|
9851
|
+
}
|
|
9310
9852
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
9311
9853
|
/**
|
|
9312
9854
|
* The cadence to bill for this price on.
|
|
@@ -10437,7 +10979,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
10437
10979
|
/**
|
|
10438
10980
|
* New subscription price request body params.
|
|
10439
10981
|
*/
|
|
10440
|
-
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;
|
|
10982
|
+
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.NewSubscriptionTieredMatrixWithAllocationPrice | 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;
|
|
10441
10983
|
/**
|
|
10442
10984
|
* The id of the price to add to the subscription.
|
|
10443
10985
|
*/
|
|
@@ -10709,6 +11251,143 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
10709
11251
|
}
|
|
10710
11252
|
}
|
|
10711
11253
|
}
|
|
11254
|
+
interface NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
11255
|
+
/**
|
|
11256
|
+
* The cadence to bill for this price on.
|
|
11257
|
+
*/
|
|
11258
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
11259
|
+
/**
|
|
11260
|
+
* The id of the item the price will be associated with.
|
|
11261
|
+
*/
|
|
11262
|
+
item_id: string;
|
|
11263
|
+
/**
|
|
11264
|
+
* The pricing model type
|
|
11265
|
+
*/
|
|
11266
|
+
model_type: 'tiered_matrix_with_allocation';
|
|
11267
|
+
/**
|
|
11268
|
+
* The name of the price.
|
|
11269
|
+
*/
|
|
11270
|
+
name: string;
|
|
11271
|
+
/**
|
|
11272
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
11273
|
+
*/
|
|
11274
|
+
tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
|
|
11275
|
+
/**
|
|
11276
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
11277
|
+
* usage-based.
|
|
11278
|
+
*/
|
|
11279
|
+
billable_metric_id?: string | null;
|
|
11280
|
+
/**
|
|
11281
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
11282
|
+
* this is true, and in-arrears if this is false.
|
|
11283
|
+
*/
|
|
11284
|
+
billed_in_advance?: boolean | null;
|
|
11285
|
+
/**
|
|
11286
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
11287
|
+
* months.
|
|
11288
|
+
*/
|
|
11289
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
11290
|
+
/**
|
|
11291
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
11292
|
+
*/
|
|
11293
|
+
conversion_rate?: number | null;
|
|
11294
|
+
/**
|
|
11295
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
11296
|
+
*/
|
|
11297
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
11298
|
+
/**
|
|
11299
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
11300
|
+
* price is billed.
|
|
11301
|
+
*/
|
|
11302
|
+
currency?: string | null;
|
|
11303
|
+
/**
|
|
11304
|
+
* For dimensional price: specifies a price group and dimension values
|
|
11305
|
+
*/
|
|
11306
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
11307
|
+
/**
|
|
11308
|
+
* An alias for the price.
|
|
11309
|
+
*/
|
|
11310
|
+
external_price_id?: string | null;
|
|
11311
|
+
/**
|
|
11312
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
11313
|
+
* applied.
|
|
11314
|
+
*/
|
|
11315
|
+
fixed_price_quantity?: number | null;
|
|
11316
|
+
/**
|
|
11317
|
+
* The property used to group this price on an invoice
|
|
11318
|
+
*/
|
|
11319
|
+
invoice_grouping_key?: string | null;
|
|
11320
|
+
/**
|
|
11321
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
11322
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
11323
|
+
*/
|
|
11324
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
11325
|
+
/**
|
|
11326
|
+
* The ID of the license type to associate with this price. On a usage price this
|
|
11327
|
+
* also marks the price as eligible to draw down from that license type's
|
|
11328
|
+
* allocation; a usage price created without it is billed normally. Usage prices
|
|
11329
|
+
* with a license type must use the `unit` model, and only draw down when their
|
|
11330
|
+
* currency matches the allocation's.
|
|
11331
|
+
*/
|
|
11332
|
+
license_type_id?: string | null;
|
|
11333
|
+
/**
|
|
11334
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
11335
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
11336
|
+
* by setting `metadata` to `null`.
|
|
11337
|
+
*/
|
|
11338
|
+
metadata?: {
|
|
11339
|
+
[key: string]: string | null;
|
|
11340
|
+
} | null;
|
|
11341
|
+
/**
|
|
11342
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
11343
|
+
* in the same API call.
|
|
11344
|
+
*/
|
|
11345
|
+
reference_id?: string | null;
|
|
11346
|
+
}
|
|
11347
|
+
namespace NewSubscriptionTieredMatrixWithAllocationPrice {
|
|
11348
|
+
/**
|
|
11349
|
+
* Configuration for tiered_matrix_with_allocation pricing
|
|
11350
|
+
*/
|
|
11351
|
+
interface TieredMatrixWithAllocationConfig {
|
|
11352
|
+
/**
|
|
11353
|
+
* Usage allocation, pooled across all matrix cells
|
|
11354
|
+
*/
|
|
11355
|
+
allocation: string;
|
|
11356
|
+
/**
|
|
11357
|
+
* Per unit rate for usage whose matrix cell has no configured tiers
|
|
11358
|
+
*/
|
|
11359
|
+
default_unit_amount: string;
|
|
11360
|
+
/**
|
|
11361
|
+
* One or two event property values to evaluate matrix cells by
|
|
11362
|
+
*/
|
|
11363
|
+
dimensions: Array<string>;
|
|
11364
|
+
/**
|
|
11365
|
+
* Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
11366
|
+
* own rows
|
|
11367
|
+
*/
|
|
11368
|
+
tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
|
|
11369
|
+
}
|
|
11370
|
+
namespace TieredMatrixWithAllocationConfig {
|
|
11371
|
+
/**
|
|
11372
|
+
* Configuration for a single tier scoped to one matrix cell
|
|
11373
|
+
*/
|
|
11374
|
+
interface Tier {
|
|
11375
|
+
/**
|
|
11376
|
+
* The matrix cell this tier applies to, as one or two dimension values
|
|
11377
|
+
*/
|
|
11378
|
+
dimension_values: Array<string>;
|
|
11379
|
+
/**
|
|
11380
|
+
* Exclusive tier starting value. The tier runs up to and including the next bound
|
|
11381
|
+
* configured for the same matrix cell.
|
|
11382
|
+
*/
|
|
11383
|
+
tier_lower_bound: string;
|
|
11384
|
+
/**
|
|
11385
|
+
* Per unit amount
|
|
11386
|
+
*/
|
|
11387
|
+
unit_amount: string;
|
|
11388
|
+
}
|
|
11389
|
+
}
|
|
11390
|
+
}
|
|
10712
11391
|
interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
|
|
10713
11392
|
/**
|
|
10714
11393
|
* The cadence to bill for this price on.
|