orb-billing 5.5.0 → 5.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/index.d.mts +4 -13
- package/index.d.ts +4 -13
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs.map +1 -1
- package/package.json +4 -5
- package/resources/alerts.d.ts +1 -1
- package/resources/beta/beta.d.ts +168 -2
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/external-plan-id.d.ts +168 -2
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/customers/balance-transactions.d.ts +2 -2
- package/resources/customers/balance-transactions.d.ts.map +1 -1
- package/resources/customers/balance-transactions.js.map +1 -1
- package/resources/customers/balance-transactions.mjs.map +1 -1
- package/resources/customers/credits/ledger.d.ts +22 -8
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/customers.d.ts +27 -0
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.js +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.mjs +1 -1
- package/resources/events/backfills.d.ts +2 -2
- package/resources/events/backfills.js +2 -2
- package/resources/events/backfills.mjs +2 -2
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +1 -1
- package/resources/invoices.d.ts +36 -11
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +4 -4
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +4 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/plans/plans.d.ts +84 -1
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/prices.d.ts +262 -166
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/shared.d.ts +216 -615
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.js.map +1 -1
- package/resources/shared.mjs.map +1 -1
- package/resources/subscriptions.d.ts +460 -192
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/index.ts +5 -17
- package/src/resources/alerts.ts +1 -1
- package/src/resources/beta/beta.ts +198 -6
- package/src/resources/beta/external-plan-id.ts +198 -6
- package/src/resources/customers/balance-transactions.ts +4 -2
- package/src/resources/customers/credits/ledger.ts +24 -8
- package/src/resources/customers/customers.ts +31 -0
- package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +1 -1
- package/src/resources/events/backfills.ts +2 -2
- package/src/resources/index.ts +1 -3
- package/src/resources/invoice-line-items.ts +1 -1
- package/src/resources/invoices.ts +41 -11
- package/src/resources/plans/plans.ts +99 -3
- package/src/resources/prices/prices.ts +283 -179
- package/src/resources/shared.ts +260 -747
- package/src/resources/subscriptions.ts +540 -238
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/src/resources/shared.ts
CHANGED
|
@@ -155,65 +155,6 @@ export interface BillingCycleConfiguration {
|
|
|
155
155
|
|
|
156
156
|
export type BillingCycleRelativeDate = 'start_of_term' | 'end_of_term';
|
|
157
157
|
|
|
158
|
-
export interface BPSConfig {
|
|
159
|
-
/**
|
|
160
|
-
* Basis point take rate per event
|
|
161
|
-
*/
|
|
162
|
-
bps: number;
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Optional currency amount maximum to cap spend per event
|
|
166
|
-
*/
|
|
167
|
-
per_unit_maximum?: string | null;
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
export interface BPSTier {
|
|
171
|
-
/**
|
|
172
|
-
* Per-event basis point rate
|
|
173
|
-
*/
|
|
174
|
-
bps: number;
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
* Exclusive tier starting value
|
|
178
|
-
*/
|
|
179
|
-
minimum_amount: string;
|
|
180
|
-
|
|
181
|
-
/**
|
|
182
|
-
* Inclusive tier ending value
|
|
183
|
-
*/
|
|
184
|
-
maximum_amount?: string | null;
|
|
185
|
-
|
|
186
|
-
/**
|
|
187
|
-
* Per unit maximum to charge
|
|
188
|
-
*/
|
|
189
|
-
per_unit_maximum?: string | null;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
export interface BulkBPSConfig {
|
|
193
|
-
/**
|
|
194
|
-
* Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
|
195
|
-
* tier based on total volume
|
|
196
|
-
*/
|
|
197
|
-
tiers: Array<BulkBPSTier>;
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
export interface BulkBPSTier {
|
|
201
|
-
/**
|
|
202
|
-
* Basis points to rate on
|
|
203
|
-
*/
|
|
204
|
-
bps: number;
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* Upper bound for tier
|
|
208
|
-
*/
|
|
209
|
-
maximum_amount?: string | null;
|
|
210
|
-
|
|
211
|
-
/**
|
|
212
|
-
* The maximum amount to charge for any one event
|
|
213
|
-
*/
|
|
214
|
-
per_unit_maximum?: string | null;
|
|
215
|
-
}
|
|
216
|
-
|
|
217
158
|
export interface BulkConfig {
|
|
218
159
|
/**
|
|
219
160
|
* Bulk tiers for rating based on total usage volume
|
|
@@ -1313,7 +1254,8 @@ export namespace Invoice {
|
|
|
1313
1254
|
| 'credit_note_applied'
|
|
1314
1255
|
| 'credit_note_voided'
|
|
1315
1256
|
| 'overpayment_refund'
|
|
1316
|
-
| 'external_payment'
|
|
1257
|
+
| 'external_payment'
|
|
1258
|
+
| 'small_invoice_carryover';
|
|
1317
1259
|
|
|
1318
1260
|
/**
|
|
1319
1261
|
* The value of the amount changed in the transaction.
|
|
@@ -1468,7 +1410,7 @@ export namespace Invoice {
|
|
|
1468
1410
|
sub_line_items: Array<Shared.MatrixSubLineItem | Shared.TierSubLineItem | Shared.OtherSubLineItem>;
|
|
1469
1411
|
|
|
1470
1412
|
/**
|
|
1471
|
-
* The line amount before
|
|
1413
|
+
* The line amount before any adjustments.
|
|
1472
1414
|
*/
|
|
1473
1415
|
subtotal: string;
|
|
1474
1416
|
|
|
@@ -1510,6 +1452,12 @@ export namespace Invoice {
|
|
|
1510
1452
|
*/
|
|
1511
1453
|
payment_provider_id: string | null;
|
|
1512
1454
|
|
|
1455
|
+
/**
|
|
1456
|
+
* URL to the downloadable PDF version of the receipt. This field will be `null`
|
|
1457
|
+
* for payment attempts that did not succeed.
|
|
1458
|
+
*/
|
|
1459
|
+
receipt_pdf: string | null;
|
|
1460
|
+
|
|
1513
1461
|
/**
|
|
1514
1462
|
* Whether the payment attempt succeeded.
|
|
1515
1463
|
*/
|
|
@@ -1721,8 +1669,8 @@ export interface MonetaryAmountDiscountAdjustment {
|
|
|
1721
1669
|
filters: Array<TransformPriceFilter>;
|
|
1722
1670
|
|
|
1723
1671
|
/**
|
|
1724
|
-
* True for adjustments that apply to an entire
|
|
1725
|
-
*
|
|
1672
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1673
|
+
* apply to only one price.
|
|
1726
1674
|
*/
|
|
1727
1675
|
is_invoice_level: boolean;
|
|
1728
1676
|
|
|
@@ -1759,8 +1707,8 @@ export interface MonetaryMaximumAdjustment {
|
|
|
1759
1707
|
filters: Array<TransformPriceFilter>;
|
|
1760
1708
|
|
|
1761
1709
|
/**
|
|
1762
|
-
* True for adjustments that apply to an entire
|
|
1763
|
-
*
|
|
1710
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1711
|
+
* apply to only one price.
|
|
1764
1712
|
*/
|
|
1765
1713
|
is_invoice_level: boolean;
|
|
1766
1714
|
|
|
@@ -1803,8 +1751,8 @@ export interface MonetaryMinimumAdjustment {
|
|
|
1803
1751
|
filters: Array<TransformPriceFilter>;
|
|
1804
1752
|
|
|
1805
1753
|
/**
|
|
1806
|
-
* True for adjustments that apply to an entire
|
|
1807
|
-
*
|
|
1754
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1755
|
+
* apply to only one price.
|
|
1808
1756
|
*/
|
|
1809
1757
|
is_invoice_level: boolean;
|
|
1810
1758
|
|
|
@@ -1852,8 +1800,8 @@ export interface MonetaryPercentageDiscountAdjustment {
|
|
|
1852
1800
|
filters: Array<TransformPriceFilter>;
|
|
1853
1801
|
|
|
1854
1802
|
/**
|
|
1855
|
-
* True for adjustments that apply to an entire
|
|
1856
|
-
*
|
|
1803
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1804
|
+
* apply to only one price.
|
|
1857
1805
|
*/
|
|
1858
1806
|
is_invoice_level: boolean;
|
|
1859
1807
|
|
|
@@ -1896,8 +1844,8 @@ export interface MonetaryUsageDiscountAdjustment {
|
|
|
1896
1844
|
filters: Array<TransformPriceFilter>;
|
|
1897
1845
|
|
|
1898
1846
|
/**
|
|
1899
|
-
* True for adjustments that apply to an entire
|
|
1900
|
-
*
|
|
1847
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1848
|
+
* apply to only one price.
|
|
1901
1849
|
*/
|
|
1902
1850
|
is_invoice_level: boolean;
|
|
1903
1851
|
|
|
@@ -2020,182 +1968,6 @@ export interface NewDimensionalPriceConfiguration {
|
|
|
2020
1968
|
external_dimensional_price_group_id?: string | null;
|
|
2021
1969
|
}
|
|
2022
1970
|
|
|
2023
|
-
export interface NewFloatingBPSPrice {
|
|
2024
|
-
bps_config: BPSConfig;
|
|
2025
|
-
|
|
2026
|
-
/**
|
|
2027
|
-
* The cadence to bill for this price on.
|
|
2028
|
-
*/
|
|
2029
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
2030
|
-
|
|
2031
|
-
/**
|
|
2032
|
-
* An ISO 4217 currency string for which this price is billed in.
|
|
2033
|
-
*/
|
|
2034
|
-
currency: string;
|
|
2035
|
-
|
|
2036
|
-
/**
|
|
2037
|
-
* The id of the item the price will be associated with.
|
|
2038
|
-
*/
|
|
2039
|
-
item_id: string;
|
|
2040
|
-
|
|
2041
|
-
model_type: 'bps';
|
|
2042
|
-
|
|
2043
|
-
/**
|
|
2044
|
-
* The name of the price.
|
|
2045
|
-
*/
|
|
2046
|
-
name: string;
|
|
2047
|
-
|
|
2048
|
-
/**
|
|
2049
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
2050
|
-
* usage-based.
|
|
2051
|
-
*/
|
|
2052
|
-
billable_metric_id?: string | null;
|
|
2053
|
-
|
|
2054
|
-
/**
|
|
2055
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
2056
|
-
* this is true, and in-arrears if this is false.
|
|
2057
|
-
*/
|
|
2058
|
-
billed_in_advance?: boolean | null;
|
|
2059
|
-
|
|
2060
|
-
/**
|
|
2061
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
2062
|
-
* months.
|
|
2063
|
-
*/
|
|
2064
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
2065
|
-
|
|
2066
|
-
/**
|
|
2067
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2068
|
-
*/
|
|
2069
|
-
conversion_rate?: number | null;
|
|
2070
|
-
|
|
2071
|
-
/**
|
|
2072
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
2073
|
-
*/
|
|
2074
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
2075
|
-
|
|
2076
|
-
/**
|
|
2077
|
-
* For dimensional price: specifies a price group and dimension values
|
|
2078
|
-
*/
|
|
2079
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
2080
|
-
|
|
2081
|
-
/**
|
|
2082
|
-
* An alias for the price.
|
|
2083
|
-
*/
|
|
2084
|
-
external_price_id?: string | null;
|
|
2085
|
-
|
|
2086
|
-
/**
|
|
2087
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
2088
|
-
* applied.
|
|
2089
|
-
*/
|
|
2090
|
-
fixed_price_quantity?: number | null;
|
|
2091
|
-
|
|
2092
|
-
/**
|
|
2093
|
-
* The property used to group this price on an invoice
|
|
2094
|
-
*/
|
|
2095
|
-
invoice_grouping_key?: string | null;
|
|
2096
|
-
|
|
2097
|
-
/**
|
|
2098
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2099
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
2100
|
-
*/
|
|
2101
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
2102
|
-
|
|
2103
|
-
/**
|
|
2104
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2105
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
2106
|
-
* by setting `metadata` to `null`.
|
|
2107
|
-
*/
|
|
2108
|
-
metadata?: { [key: string]: string | null } | null;
|
|
2109
|
-
}
|
|
2110
|
-
|
|
2111
|
-
export interface NewFloatingBulkBPSPrice {
|
|
2112
|
-
bulk_bps_config: BulkBPSConfig;
|
|
2113
|
-
|
|
2114
|
-
/**
|
|
2115
|
-
* The cadence to bill for this price on.
|
|
2116
|
-
*/
|
|
2117
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
2118
|
-
|
|
2119
|
-
/**
|
|
2120
|
-
* An ISO 4217 currency string for which this price is billed in.
|
|
2121
|
-
*/
|
|
2122
|
-
currency: string;
|
|
2123
|
-
|
|
2124
|
-
/**
|
|
2125
|
-
* The id of the item the price will be associated with.
|
|
2126
|
-
*/
|
|
2127
|
-
item_id: string;
|
|
2128
|
-
|
|
2129
|
-
model_type: 'bulk_bps';
|
|
2130
|
-
|
|
2131
|
-
/**
|
|
2132
|
-
* The name of the price.
|
|
2133
|
-
*/
|
|
2134
|
-
name: string;
|
|
2135
|
-
|
|
2136
|
-
/**
|
|
2137
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
2138
|
-
* usage-based.
|
|
2139
|
-
*/
|
|
2140
|
-
billable_metric_id?: string | null;
|
|
2141
|
-
|
|
2142
|
-
/**
|
|
2143
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
2144
|
-
* this is true, and in-arrears if this is false.
|
|
2145
|
-
*/
|
|
2146
|
-
billed_in_advance?: boolean | null;
|
|
2147
|
-
|
|
2148
|
-
/**
|
|
2149
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
2150
|
-
* months.
|
|
2151
|
-
*/
|
|
2152
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
2153
|
-
|
|
2154
|
-
/**
|
|
2155
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2156
|
-
*/
|
|
2157
|
-
conversion_rate?: number | null;
|
|
2158
|
-
|
|
2159
|
-
/**
|
|
2160
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
2161
|
-
*/
|
|
2162
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
2163
|
-
|
|
2164
|
-
/**
|
|
2165
|
-
* For dimensional price: specifies a price group and dimension values
|
|
2166
|
-
*/
|
|
2167
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
2168
|
-
|
|
2169
|
-
/**
|
|
2170
|
-
* An alias for the price.
|
|
2171
|
-
*/
|
|
2172
|
-
external_price_id?: string | null;
|
|
2173
|
-
|
|
2174
|
-
/**
|
|
2175
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
2176
|
-
* applied.
|
|
2177
|
-
*/
|
|
2178
|
-
fixed_price_quantity?: number | null;
|
|
2179
|
-
|
|
2180
|
-
/**
|
|
2181
|
-
* The property used to group this price on an invoice
|
|
2182
|
-
*/
|
|
2183
|
-
invoice_grouping_key?: string | null;
|
|
2184
|
-
|
|
2185
|
-
/**
|
|
2186
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2187
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
2188
|
-
*/
|
|
2189
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
2190
|
-
|
|
2191
|
-
/**
|
|
2192
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2193
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
2194
|
-
* by setting `metadata` to `null`.
|
|
2195
|
-
*/
|
|
2196
|
-
metadata?: { [key: string]: string | null } | null;
|
|
2197
|
-
}
|
|
2198
|
-
|
|
2199
1971
|
export interface NewFloatingBulkPrice {
|
|
2200
1972
|
bulk_config: BulkConfig;
|
|
2201
1973
|
|
|
@@ -3252,7 +3024,7 @@ export interface NewFloatingMaxGroupTieredPackagePrice {
|
|
|
3252
3024
|
metadata?: { [key: string]: string | null } | null;
|
|
3253
3025
|
}
|
|
3254
3026
|
|
|
3255
|
-
export interface
|
|
3027
|
+
export interface NewFloatingMinimumCompositePrice {
|
|
3256
3028
|
/**
|
|
3257
3029
|
* The cadence to bill for this price on.
|
|
3258
3030
|
*/
|
|
@@ -3268,15 +3040,15 @@ export interface NewFloatingPackagePrice {
|
|
|
3268
3040
|
*/
|
|
3269
3041
|
item_id: string;
|
|
3270
3042
|
|
|
3271
|
-
|
|
3043
|
+
minimum_config: NewFloatingMinimumCompositePrice.MinimumConfig;
|
|
3044
|
+
|
|
3045
|
+
model_type: 'minimum';
|
|
3272
3046
|
|
|
3273
3047
|
/**
|
|
3274
3048
|
* The name of the price.
|
|
3275
3049
|
*/
|
|
3276
3050
|
name: string;
|
|
3277
3051
|
|
|
3278
|
-
package_config: PackageConfig;
|
|
3279
|
-
|
|
3280
3052
|
/**
|
|
3281
3053
|
* The id of the billable metric for the price. Only needed if the price is
|
|
3282
3054
|
* usage-based.
|
|
@@ -3340,7 +3112,22 @@ export interface NewFloatingPackagePrice {
|
|
|
3340
3112
|
metadata?: { [key: string]: string | null } | null;
|
|
3341
3113
|
}
|
|
3342
3114
|
|
|
3343
|
-
export
|
|
3115
|
+
export namespace NewFloatingMinimumCompositePrice {
|
|
3116
|
+
export interface MinimumConfig {
|
|
3117
|
+
/**
|
|
3118
|
+
* The minimum amount to apply
|
|
3119
|
+
*/
|
|
3120
|
+
minimum_amount: string;
|
|
3121
|
+
|
|
3122
|
+
/**
|
|
3123
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
3124
|
+
* service period. Set to false to disable proration.
|
|
3125
|
+
*/
|
|
3126
|
+
prorated?: boolean | null;
|
|
3127
|
+
}
|
|
3128
|
+
}
|
|
3129
|
+
|
|
3130
|
+
export interface NewFloatingPackagePrice {
|
|
3344
3131
|
/**
|
|
3345
3132
|
* The cadence to bill for this price on.
|
|
3346
3133
|
*/
|
|
@@ -3356,14 +3143,14 @@ export interface NewFloatingPackageWithAllocationPrice {
|
|
|
3356
3143
|
*/
|
|
3357
3144
|
item_id: string;
|
|
3358
3145
|
|
|
3359
|
-
model_type: '
|
|
3146
|
+
model_type: 'package';
|
|
3360
3147
|
|
|
3361
3148
|
/**
|
|
3362
3149
|
* The name of the price.
|
|
3363
3150
|
*/
|
|
3364
3151
|
name: string;
|
|
3365
3152
|
|
|
3366
|
-
|
|
3153
|
+
package_config: PackageConfig;
|
|
3367
3154
|
|
|
3368
3155
|
/**
|
|
3369
3156
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -3428,7 +3215,7 @@ export interface NewFloatingPackageWithAllocationPrice {
|
|
|
3428
3215
|
metadata?: { [key: string]: string | null } | null;
|
|
3429
3216
|
}
|
|
3430
3217
|
|
|
3431
|
-
export interface
|
|
3218
|
+
export interface NewFloatingPackageWithAllocationPrice {
|
|
3432
3219
|
/**
|
|
3433
3220
|
* The cadence to bill for this price on.
|
|
3434
3221
|
*/
|
|
@@ -3444,14 +3231,14 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
|
3444
3231
|
*/
|
|
3445
3232
|
item_id: string;
|
|
3446
3233
|
|
|
3447
|
-
model_type: '
|
|
3234
|
+
model_type: 'package_with_allocation';
|
|
3448
3235
|
|
|
3449
3236
|
/**
|
|
3450
3237
|
* The name of the price.
|
|
3451
3238
|
*/
|
|
3452
3239
|
name: string;
|
|
3453
3240
|
|
|
3454
|
-
|
|
3241
|
+
package_with_allocation_config: { [key: string]: unknown };
|
|
3455
3242
|
|
|
3456
3243
|
/**
|
|
3457
3244
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -3516,7 +3303,7 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
|
3516
3303
|
metadata?: { [key: string]: string | null } | null;
|
|
3517
3304
|
}
|
|
3518
3305
|
|
|
3519
|
-
export interface
|
|
3306
|
+
export interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
3520
3307
|
/**
|
|
3521
3308
|
* The cadence to bill for this price on.
|
|
3522
3309
|
*/
|
|
@@ -3532,14 +3319,14 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
|
3532
3319
|
*/
|
|
3533
3320
|
item_id: string;
|
|
3534
3321
|
|
|
3535
|
-
model_type: '
|
|
3322
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
3536
3323
|
|
|
3537
3324
|
/**
|
|
3538
3325
|
* The name of the price.
|
|
3539
3326
|
*/
|
|
3540
3327
|
name: string;
|
|
3541
3328
|
|
|
3542
|
-
|
|
3329
|
+
scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
|
|
3543
3330
|
|
|
3544
3331
|
/**
|
|
3545
3332
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -3604,7 +3391,7 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
|
3604
3391
|
metadata?: { [key: string]: string | null } | null;
|
|
3605
3392
|
}
|
|
3606
3393
|
|
|
3607
|
-
export interface
|
|
3394
|
+
export interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
3608
3395
|
/**
|
|
3609
3396
|
* The cadence to bill for this price on.
|
|
3610
3397
|
*/
|
|
@@ -3620,14 +3407,14 @@ export interface NewFloatingThresholdTotalAmountPrice {
|
|
|
3620
3407
|
*/
|
|
3621
3408
|
item_id: string;
|
|
3622
3409
|
|
|
3623
|
-
model_type: '
|
|
3410
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
3624
3411
|
|
|
3625
3412
|
/**
|
|
3626
3413
|
* The name of the price.
|
|
3627
3414
|
*/
|
|
3628
3415
|
name: string;
|
|
3629
3416
|
|
|
3630
|
-
|
|
3417
|
+
scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
|
|
3631
3418
|
|
|
3632
3419
|
/**
|
|
3633
3420
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -3692,7 +3479,7 @@ export interface NewFloatingThresholdTotalAmountPrice {
|
|
|
3692
3479
|
metadata?: { [key: string]: string | null } | null;
|
|
3693
3480
|
}
|
|
3694
3481
|
|
|
3695
|
-
export interface
|
|
3482
|
+
export interface NewFloatingThresholdTotalAmountPrice {
|
|
3696
3483
|
/**
|
|
3697
3484
|
* The cadence to bill for this price on.
|
|
3698
3485
|
*/
|
|
@@ -3708,14 +3495,14 @@ export interface NewFloatingTieredBPSPrice {
|
|
|
3708
3495
|
*/
|
|
3709
3496
|
item_id: string;
|
|
3710
3497
|
|
|
3711
|
-
model_type: '
|
|
3498
|
+
model_type: 'threshold_total_amount';
|
|
3712
3499
|
|
|
3713
3500
|
/**
|
|
3714
3501
|
* The name of the price.
|
|
3715
3502
|
*/
|
|
3716
3503
|
name: string;
|
|
3717
3504
|
|
|
3718
|
-
|
|
3505
|
+
threshold_total_amount_config: { [key: string]: unknown };
|
|
3719
3506
|
|
|
3720
3507
|
/**
|
|
3721
3508
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -4615,8 +4402,8 @@ export interface NewPercentageDiscount {
|
|
|
4615
4402
|
price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
|
|
4616
4403
|
}
|
|
4617
4404
|
|
|
4618
|
-
export interface
|
|
4619
|
-
|
|
4405
|
+
export interface NewPlanBulkPrice {
|
|
4406
|
+
bulk_config: BulkConfig;
|
|
4620
4407
|
|
|
4621
4408
|
/**
|
|
4622
4409
|
* The cadence to bill for this price on.
|
|
@@ -4628,7 +4415,7 @@ export interface NewPlanBPSPrice {
|
|
|
4628
4415
|
*/
|
|
4629
4416
|
item_id: string;
|
|
4630
4417
|
|
|
4631
|
-
model_type: '
|
|
4418
|
+
model_type: 'bulk';
|
|
4632
4419
|
|
|
4633
4420
|
/**
|
|
4634
4421
|
* The name of the price.
|
|
@@ -4710,8 +4497,8 @@ export interface NewPlanBPSPrice {
|
|
|
4710
4497
|
reference_id?: string | null;
|
|
4711
4498
|
}
|
|
4712
4499
|
|
|
4713
|
-
export interface
|
|
4714
|
-
|
|
4500
|
+
export interface NewPlanBulkWithProrationPrice {
|
|
4501
|
+
bulk_with_proration_config: { [key: string]: unknown };
|
|
4715
4502
|
|
|
4716
4503
|
/**
|
|
4717
4504
|
* The cadence to bill for this price on.
|
|
@@ -4723,197 +4510,7 @@ export interface NewPlanBulkBPSPrice {
|
|
|
4723
4510
|
*/
|
|
4724
4511
|
item_id: string;
|
|
4725
4512
|
|
|
4726
|
-
model_type: '
|
|
4727
|
-
|
|
4728
|
-
/**
|
|
4729
|
-
* The name of the price.
|
|
4730
|
-
*/
|
|
4731
|
-
name: string;
|
|
4732
|
-
|
|
4733
|
-
/**
|
|
4734
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
4735
|
-
* usage-based.
|
|
4736
|
-
*/
|
|
4737
|
-
billable_metric_id?: string | null;
|
|
4738
|
-
|
|
4739
|
-
/**
|
|
4740
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4741
|
-
* this is true, and in-arrears if this is false.
|
|
4742
|
-
*/
|
|
4743
|
-
billed_in_advance?: boolean | null;
|
|
4744
|
-
|
|
4745
|
-
/**
|
|
4746
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
4747
|
-
* months.
|
|
4748
|
-
*/
|
|
4749
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
4750
|
-
|
|
4751
|
-
/**
|
|
4752
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4753
|
-
*/
|
|
4754
|
-
conversion_rate?: number | null;
|
|
4755
|
-
|
|
4756
|
-
/**
|
|
4757
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4758
|
-
*/
|
|
4759
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
4760
|
-
|
|
4761
|
-
/**
|
|
4762
|
-
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4763
|
-
* price is billed.
|
|
4764
|
-
*/
|
|
4765
|
-
currency?: string | null;
|
|
4766
|
-
|
|
4767
|
-
/**
|
|
4768
|
-
* For dimensional price: specifies a price group and dimension values
|
|
4769
|
-
*/
|
|
4770
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
4771
|
-
|
|
4772
|
-
/**
|
|
4773
|
-
* An alias for the price.
|
|
4774
|
-
*/
|
|
4775
|
-
external_price_id?: string | null;
|
|
4776
|
-
|
|
4777
|
-
/**
|
|
4778
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4779
|
-
* applied.
|
|
4780
|
-
*/
|
|
4781
|
-
fixed_price_quantity?: number | null;
|
|
4782
|
-
|
|
4783
|
-
/**
|
|
4784
|
-
* The property used to group this price on an invoice
|
|
4785
|
-
*/
|
|
4786
|
-
invoice_grouping_key?: string | null;
|
|
4787
|
-
|
|
4788
|
-
/**
|
|
4789
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4790
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
4791
|
-
*/
|
|
4792
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
4793
|
-
|
|
4794
|
-
/**
|
|
4795
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4796
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4797
|
-
* by setting `metadata` to `null`.
|
|
4798
|
-
*/
|
|
4799
|
-
metadata?: { [key: string]: string | null } | null;
|
|
4800
|
-
|
|
4801
|
-
/**
|
|
4802
|
-
* A transient ID that can be used to reference this price when adding adjustments
|
|
4803
|
-
* in the same API call.
|
|
4804
|
-
*/
|
|
4805
|
-
reference_id?: string | null;
|
|
4806
|
-
}
|
|
4807
|
-
|
|
4808
|
-
export interface NewPlanBulkPrice {
|
|
4809
|
-
bulk_config: BulkConfig;
|
|
4810
|
-
|
|
4811
|
-
/**
|
|
4812
|
-
* The cadence to bill for this price on.
|
|
4813
|
-
*/
|
|
4814
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4815
|
-
|
|
4816
|
-
/**
|
|
4817
|
-
* The id of the item the price will be associated with.
|
|
4818
|
-
*/
|
|
4819
|
-
item_id: string;
|
|
4820
|
-
|
|
4821
|
-
model_type: 'bulk';
|
|
4822
|
-
|
|
4823
|
-
/**
|
|
4824
|
-
* The name of the price.
|
|
4825
|
-
*/
|
|
4826
|
-
name: string;
|
|
4827
|
-
|
|
4828
|
-
/**
|
|
4829
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
4830
|
-
* usage-based.
|
|
4831
|
-
*/
|
|
4832
|
-
billable_metric_id?: string | null;
|
|
4833
|
-
|
|
4834
|
-
/**
|
|
4835
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4836
|
-
* this is true, and in-arrears if this is false.
|
|
4837
|
-
*/
|
|
4838
|
-
billed_in_advance?: boolean | null;
|
|
4839
|
-
|
|
4840
|
-
/**
|
|
4841
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
4842
|
-
* months.
|
|
4843
|
-
*/
|
|
4844
|
-
billing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
4845
|
-
|
|
4846
|
-
/**
|
|
4847
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4848
|
-
*/
|
|
4849
|
-
conversion_rate?: number | null;
|
|
4850
|
-
|
|
4851
|
-
/**
|
|
4852
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4853
|
-
*/
|
|
4854
|
-
conversion_rate_config?: UnitConversionRateConfig | TieredConversionRateConfig | null;
|
|
4855
|
-
|
|
4856
|
-
/**
|
|
4857
|
-
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4858
|
-
* price is billed.
|
|
4859
|
-
*/
|
|
4860
|
-
currency?: string | null;
|
|
4861
|
-
|
|
4862
|
-
/**
|
|
4863
|
-
* For dimensional price: specifies a price group and dimension values
|
|
4864
|
-
*/
|
|
4865
|
-
dimensional_price_configuration?: NewDimensionalPriceConfiguration | null;
|
|
4866
|
-
|
|
4867
|
-
/**
|
|
4868
|
-
* An alias for the price.
|
|
4869
|
-
*/
|
|
4870
|
-
external_price_id?: string | null;
|
|
4871
|
-
|
|
4872
|
-
/**
|
|
4873
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4874
|
-
* applied.
|
|
4875
|
-
*/
|
|
4876
|
-
fixed_price_quantity?: number | null;
|
|
4877
|
-
|
|
4878
|
-
/**
|
|
4879
|
-
* The property used to group this price on an invoice
|
|
4880
|
-
*/
|
|
4881
|
-
invoice_grouping_key?: string | null;
|
|
4882
|
-
|
|
4883
|
-
/**
|
|
4884
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4885
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
4886
|
-
*/
|
|
4887
|
-
invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
|
|
4888
|
-
|
|
4889
|
-
/**
|
|
4890
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4891
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4892
|
-
* by setting `metadata` to `null`.
|
|
4893
|
-
*/
|
|
4894
|
-
metadata?: { [key: string]: string | null } | null;
|
|
4895
|
-
|
|
4896
|
-
/**
|
|
4897
|
-
* A transient ID that can be used to reference this price when adding adjustments
|
|
4898
|
-
* in the same API call.
|
|
4899
|
-
*/
|
|
4900
|
-
reference_id?: string | null;
|
|
4901
|
-
}
|
|
4902
|
-
|
|
4903
|
-
export interface NewPlanBulkWithProrationPrice {
|
|
4904
|
-
bulk_with_proration_config: { [key: string]: unknown };
|
|
4905
|
-
|
|
4906
|
-
/**
|
|
4907
|
-
* The cadence to bill for this price on.
|
|
4908
|
-
*/
|
|
4909
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4910
|
-
|
|
4911
|
-
/**
|
|
4912
|
-
* The id of the item the price will be associated with.
|
|
4913
|
-
*/
|
|
4914
|
-
item_id: string;
|
|
4915
|
-
|
|
4916
|
-
model_type: 'bulk_with_proration';
|
|
4513
|
+
model_type: 'bulk_with_proration';
|
|
4917
4514
|
|
|
4918
4515
|
/**
|
|
4919
4516
|
* The name of the price.
|
|
@@ -5945,7 +5542,7 @@ export interface NewPlanMaxGroupTieredPackagePrice {
|
|
|
5945
5542
|
reference_id?: string | null;
|
|
5946
5543
|
}
|
|
5947
5544
|
|
|
5948
|
-
export interface
|
|
5545
|
+
export interface NewPlanMinimumCompositePrice {
|
|
5949
5546
|
/**
|
|
5950
5547
|
* The cadence to bill for this price on.
|
|
5951
5548
|
*/
|
|
@@ -5956,15 +5553,15 @@ export interface NewPlanPackagePrice {
|
|
|
5956
5553
|
*/
|
|
5957
5554
|
item_id: string;
|
|
5958
5555
|
|
|
5959
|
-
|
|
5556
|
+
minimum_config: NewPlanMinimumCompositePrice.MinimumConfig;
|
|
5557
|
+
|
|
5558
|
+
model_type: 'minimum';
|
|
5960
5559
|
|
|
5961
5560
|
/**
|
|
5962
5561
|
* The name of the price.
|
|
5963
5562
|
*/
|
|
5964
5563
|
name: string;
|
|
5965
5564
|
|
|
5966
|
-
package_config: PackageConfig;
|
|
5967
|
-
|
|
5968
5565
|
/**
|
|
5969
5566
|
* The id of the billable metric for the price. Only needed if the price is
|
|
5970
5567
|
* usage-based.
|
|
@@ -6040,7 +5637,22 @@ export interface NewPlanPackagePrice {
|
|
|
6040
5637
|
reference_id?: string | null;
|
|
6041
5638
|
}
|
|
6042
5639
|
|
|
6043
|
-
export
|
|
5640
|
+
export namespace NewPlanMinimumCompositePrice {
|
|
5641
|
+
export interface MinimumConfig {
|
|
5642
|
+
/**
|
|
5643
|
+
* The minimum amount to apply
|
|
5644
|
+
*/
|
|
5645
|
+
minimum_amount: string;
|
|
5646
|
+
|
|
5647
|
+
/**
|
|
5648
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
5649
|
+
* service period. Set to false to disable proration.
|
|
5650
|
+
*/
|
|
5651
|
+
prorated?: boolean | null;
|
|
5652
|
+
}
|
|
5653
|
+
}
|
|
5654
|
+
|
|
5655
|
+
export interface NewPlanPackagePrice {
|
|
6044
5656
|
/**
|
|
6045
5657
|
* The cadence to bill for this price on.
|
|
6046
5658
|
*/
|
|
@@ -6051,14 +5663,14 @@ export interface NewPlanPackageWithAllocationPrice {
|
|
|
6051
5663
|
*/
|
|
6052
5664
|
item_id: string;
|
|
6053
5665
|
|
|
6054
|
-
model_type: '
|
|
5666
|
+
model_type: 'package';
|
|
6055
5667
|
|
|
6056
5668
|
/**
|
|
6057
5669
|
* The name of the price.
|
|
6058
5670
|
*/
|
|
6059
5671
|
name: string;
|
|
6060
5672
|
|
|
6061
|
-
|
|
5673
|
+
package_config: PackageConfig;
|
|
6062
5674
|
|
|
6063
5675
|
/**
|
|
6064
5676
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -6135,7 +5747,7 @@ export interface NewPlanPackageWithAllocationPrice {
|
|
|
6135
5747
|
reference_id?: string | null;
|
|
6136
5748
|
}
|
|
6137
5749
|
|
|
6138
|
-
export interface
|
|
5750
|
+
export interface NewPlanPackageWithAllocationPrice {
|
|
6139
5751
|
/**
|
|
6140
5752
|
* The cadence to bill for this price on.
|
|
6141
5753
|
*/
|
|
@@ -6146,14 +5758,14 @@ export interface NewPlanScalableMatrixWithTieredPricingPrice {
|
|
|
6146
5758
|
*/
|
|
6147
5759
|
item_id: string;
|
|
6148
5760
|
|
|
6149
|
-
model_type: '
|
|
5761
|
+
model_type: 'package_with_allocation';
|
|
6150
5762
|
|
|
6151
5763
|
/**
|
|
6152
5764
|
* The name of the price.
|
|
6153
5765
|
*/
|
|
6154
5766
|
name: string;
|
|
6155
5767
|
|
|
6156
|
-
|
|
5768
|
+
package_with_allocation_config: { [key: string]: unknown };
|
|
6157
5769
|
|
|
6158
5770
|
/**
|
|
6159
5771
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -6230,7 +5842,7 @@ export interface NewPlanScalableMatrixWithTieredPricingPrice {
|
|
|
6230
5842
|
reference_id?: string | null;
|
|
6231
5843
|
}
|
|
6232
5844
|
|
|
6233
|
-
export interface
|
|
5845
|
+
export interface NewPlanScalableMatrixWithTieredPricingPrice {
|
|
6234
5846
|
/**
|
|
6235
5847
|
* The cadence to bill for this price on.
|
|
6236
5848
|
*/
|
|
@@ -6241,14 +5853,14 @@ export interface NewPlanScalableMatrixWithUnitPricingPrice {
|
|
|
6241
5853
|
*/
|
|
6242
5854
|
item_id: string;
|
|
6243
5855
|
|
|
6244
|
-
model_type: '
|
|
5856
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
6245
5857
|
|
|
6246
5858
|
/**
|
|
6247
5859
|
* The name of the price.
|
|
6248
5860
|
*/
|
|
6249
5861
|
name: string;
|
|
6250
5862
|
|
|
6251
|
-
|
|
5863
|
+
scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
|
|
6252
5864
|
|
|
6253
5865
|
/**
|
|
6254
5866
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -6325,7 +5937,7 @@ export interface NewPlanScalableMatrixWithUnitPricingPrice {
|
|
|
6325
5937
|
reference_id?: string | null;
|
|
6326
5938
|
}
|
|
6327
5939
|
|
|
6328
|
-
export interface
|
|
5940
|
+
export interface NewPlanScalableMatrixWithUnitPricingPrice {
|
|
6329
5941
|
/**
|
|
6330
5942
|
* The cadence to bill for this price on.
|
|
6331
5943
|
*/
|
|
@@ -6336,14 +5948,14 @@ export interface NewPlanThresholdTotalAmountPrice {
|
|
|
6336
5948
|
*/
|
|
6337
5949
|
item_id: string;
|
|
6338
5950
|
|
|
6339
|
-
model_type: '
|
|
5951
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
6340
5952
|
|
|
6341
5953
|
/**
|
|
6342
5954
|
* The name of the price.
|
|
6343
5955
|
*/
|
|
6344
5956
|
name: string;
|
|
6345
5957
|
|
|
6346
|
-
|
|
5958
|
+
scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
|
|
6347
5959
|
|
|
6348
5960
|
/**
|
|
6349
5961
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -6420,7 +6032,7 @@ export interface NewPlanThresholdTotalAmountPrice {
|
|
|
6420
6032
|
reference_id?: string | null;
|
|
6421
6033
|
}
|
|
6422
6034
|
|
|
6423
|
-
export interface
|
|
6035
|
+
export interface NewPlanThresholdTotalAmountPrice {
|
|
6424
6036
|
/**
|
|
6425
6037
|
* The cadence to bill for this price on.
|
|
6426
6038
|
*/
|
|
@@ -6431,14 +6043,14 @@ export interface NewPlanTierWithProrationPrice {
|
|
|
6431
6043
|
*/
|
|
6432
6044
|
item_id: string;
|
|
6433
6045
|
|
|
6434
|
-
model_type: '
|
|
6046
|
+
model_type: 'threshold_total_amount';
|
|
6435
6047
|
|
|
6436
6048
|
/**
|
|
6437
6049
|
* The name of the price.
|
|
6438
6050
|
*/
|
|
6439
6051
|
name: string;
|
|
6440
6052
|
|
|
6441
|
-
|
|
6053
|
+
threshold_total_amount_config: { [key: string]: unknown };
|
|
6442
6054
|
|
|
6443
6055
|
/**
|
|
6444
6056
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -6515,7 +6127,7 @@ export interface NewPlanTierWithProrationPrice {
|
|
|
6515
6127
|
reference_id?: string | null;
|
|
6516
6128
|
}
|
|
6517
6129
|
|
|
6518
|
-
export interface
|
|
6130
|
+
export interface NewPlanTierWithProrationPrice {
|
|
6519
6131
|
/**
|
|
6520
6132
|
* The cadence to bill for this price on.
|
|
6521
6133
|
*/
|
|
@@ -6526,14 +6138,14 @@ export interface NewPlanTieredBPSPrice {
|
|
|
6526
6138
|
*/
|
|
6527
6139
|
item_id: string;
|
|
6528
6140
|
|
|
6529
|
-
model_type: '
|
|
6141
|
+
model_type: 'tiered_with_proration';
|
|
6530
6142
|
|
|
6531
6143
|
/**
|
|
6532
6144
|
* The name of the price.
|
|
6533
6145
|
*/
|
|
6534
6146
|
name: string;
|
|
6535
6147
|
|
|
6536
|
-
|
|
6148
|
+
tiered_with_proration_config: { [key: string]: unknown };
|
|
6537
6149
|
|
|
6538
6150
|
/**
|
|
6539
6151
|
* The id of the billable metric for the price. Only needed if the price is
|
|
@@ -7453,8 +7065,8 @@ export interface PlanPhaseAmountDiscountAdjustment {
|
|
|
7453
7065
|
filters: Array<TransformPriceFilter>;
|
|
7454
7066
|
|
|
7455
7067
|
/**
|
|
7456
|
-
* True for adjustments that apply to an entire
|
|
7457
|
-
*
|
|
7068
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7069
|
+
* apply to only one price.
|
|
7458
7070
|
*/
|
|
7459
7071
|
is_invoice_level: boolean;
|
|
7460
7072
|
|
|
@@ -7491,8 +7103,8 @@ export interface PlanPhaseMaximumAdjustment {
|
|
|
7491
7103
|
filters: Array<TransformPriceFilter>;
|
|
7492
7104
|
|
|
7493
7105
|
/**
|
|
7494
|
-
* True for adjustments that apply to an entire
|
|
7495
|
-
*
|
|
7106
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7107
|
+
* apply to only one price.
|
|
7496
7108
|
*/
|
|
7497
7109
|
is_invoice_level: boolean;
|
|
7498
7110
|
|
|
@@ -7535,8 +7147,8 @@ export interface PlanPhaseMinimumAdjustment {
|
|
|
7535
7147
|
filters: Array<TransformPriceFilter>;
|
|
7536
7148
|
|
|
7537
7149
|
/**
|
|
7538
|
-
* True for adjustments that apply to an entire
|
|
7539
|
-
*
|
|
7150
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7151
|
+
* apply to only one price.
|
|
7540
7152
|
*/
|
|
7541
7153
|
is_invoice_level: boolean;
|
|
7542
7154
|
|
|
@@ -7584,8 +7196,8 @@ export interface PlanPhasePercentageDiscountAdjustment {
|
|
|
7584
7196
|
filters: Array<TransformPriceFilter>;
|
|
7585
7197
|
|
|
7586
7198
|
/**
|
|
7587
|
-
* True for adjustments that apply to an entire
|
|
7588
|
-
*
|
|
7199
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7200
|
+
* apply to only one price.
|
|
7589
7201
|
*/
|
|
7590
7202
|
is_invoice_level: boolean;
|
|
7591
7203
|
|
|
@@ -7628,8 +7240,8 @@ export interface PlanPhaseUsageDiscountAdjustment {
|
|
|
7628
7240
|
filters: Array<TransformPriceFilter>;
|
|
7629
7241
|
|
|
7630
7242
|
/**
|
|
7631
|
-
* True for adjustments that apply to an entire
|
|
7632
|
-
*
|
|
7243
|
+
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7244
|
+
* apply to only one price.
|
|
7633
7245
|
*/
|
|
7634
7246
|
is_invoice_level: boolean;
|
|
7635
7247
|
|
|
@@ -7673,9 +7285,6 @@ export type Price =
|
|
|
7673
7285
|
| Price.PackagePrice
|
|
7674
7286
|
| Price.MatrixPrice
|
|
7675
7287
|
| Price.TieredPrice
|
|
7676
|
-
| Price.TieredBPSPrice
|
|
7677
|
-
| Price.BPSPrice
|
|
7678
|
-
| Price.BulkBPSPrice
|
|
7679
7288
|
| Price.BulkPrice
|
|
7680
7289
|
| Price.ThresholdTotalAmountPrice
|
|
7681
7290
|
| Price.TieredPackagePrice
|
|
@@ -7697,7 +7306,8 @@ export type Price =
|
|
|
7697
7306
|
| Price.ScalableMatrixWithUnitPricingPrice
|
|
7698
7307
|
| Price.ScalableMatrixWithTieredPricingPrice
|
|
7699
7308
|
| Price.CumulativeGroupedBulkPrice
|
|
7700
|
-
| Price.GroupedWithMinMaxThresholdsPrice
|
|
7309
|
+
| Price.GroupedWithMinMaxThresholdsPrice
|
|
7310
|
+
| Price.MinimumCompositePrice;
|
|
7701
7311
|
|
|
7702
7312
|
export namespace Price {
|
|
7703
7313
|
export interface UnitPrice {
|
|
@@ -7709,6 +7319,8 @@ export namespace Price {
|
|
|
7709
7319
|
|
|
7710
7320
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7711
7321
|
|
|
7322
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7323
|
+
|
|
7712
7324
|
conversion_rate: number | null;
|
|
7713
7325
|
|
|
7714
7326
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -7788,6 +7400,8 @@ export namespace Price {
|
|
|
7788
7400
|
|
|
7789
7401
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7790
7402
|
|
|
7403
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7404
|
+
|
|
7791
7405
|
conversion_rate: number | null;
|
|
7792
7406
|
|
|
7793
7407
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -7867,6 +7481,8 @@ export namespace Price {
|
|
|
7867
7481
|
|
|
7868
7482
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7869
7483
|
|
|
7484
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7485
|
+
|
|
7870
7486
|
conversion_rate: number | null;
|
|
7871
7487
|
|
|
7872
7488
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -7946,6 +7562,8 @@ export namespace Price {
|
|
|
7946
7562
|
|
|
7947
7563
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7948
7564
|
|
|
7565
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7566
|
+
|
|
7949
7567
|
conversion_rate: number | null;
|
|
7950
7568
|
|
|
7951
7569
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8016,15 +7634,19 @@ export namespace Price {
|
|
|
8016
7634
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8017
7635
|
}
|
|
8018
7636
|
|
|
8019
|
-
export interface
|
|
7637
|
+
export interface BulkPrice {
|
|
8020
7638
|
id: string;
|
|
8021
7639
|
|
|
8022
7640
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
8023
7641
|
|
|
8024
7642
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8025
7643
|
|
|
7644
|
+
bulk_config: Shared.BulkConfig;
|
|
7645
|
+
|
|
8026
7646
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8027
7647
|
|
|
7648
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7649
|
+
|
|
8028
7650
|
conversion_rate: number | null;
|
|
8029
7651
|
|
|
8030
7652
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8076,7 +7698,7 @@ export namespace Price {
|
|
|
8076
7698
|
*/
|
|
8077
7699
|
minimum_amount: string | null;
|
|
8078
7700
|
|
|
8079
|
-
model_type: '
|
|
7701
|
+
model_type: 'bulk';
|
|
8080
7702
|
|
|
8081
7703
|
name: string;
|
|
8082
7704
|
|
|
@@ -8090,22 +7712,20 @@ export namespace Price {
|
|
|
8090
7712
|
*/
|
|
8091
7713
|
replaces_price_id: string | null;
|
|
8092
7714
|
|
|
8093
|
-
tiered_bps_config: Shared.TieredBPSConfig;
|
|
8094
|
-
|
|
8095
7715
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8096
7716
|
}
|
|
8097
7717
|
|
|
8098
|
-
export interface
|
|
7718
|
+
export interface ThresholdTotalAmountPrice {
|
|
8099
7719
|
id: string;
|
|
8100
7720
|
|
|
8101
7721
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
8102
7722
|
|
|
8103
7723
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8104
7724
|
|
|
8105
|
-
bps_config: Shared.BPSConfig;
|
|
8106
|
-
|
|
8107
7725
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8108
7726
|
|
|
7727
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7728
|
+
|
|
8109
7729
|
conversion_rate: number | null;
|
|
8110
7730
|
|
|
8111
7731
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8157,7 +7777,7 @@ export namespace Price {
|
|
|
8157
7777
|
*/
|
|
8158
7778
|
minimum_amount: string | null;
|
|
8159
7779
|
|
|
8160
|
-
model_type: '
|
|
7780
|
+
model_type: 'threshold_total_amount';
|
|
8161
7781
|
|
|
8162
7782
|
name: string;
|
|
8163
7783
|
|
|
@@ -8171,20 +7791,22 @@ export namespace Price {
|
|
|
8171
7791
|
*/
|
|
8172
7792
|
replaces_price_id: string | null;
|
|
8173
7793
|
|
|
7794
|
+
threshold_total_amount_config: { [key: string]: unknown };
|
|
7795
|
+
|
|
8174
7796
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8175
7797
|
}
|
|
8176
7798
|
|
|
8177
|
-
export interface
|
|
7799
|
+
export interface TieredPackagePrice {
|
|
8178
7800
|
id: string;
|
|
8179
7801
|
|
|
8180
7802
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
8181
7803
|
|
|
8182
7804
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8183
7805
|
|
|
8184
|
-
bulk_bps_config: Shared.BulkBPSConfig;
|
|
8185
|
-
|
|
8186
7806
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8187
7807
|
|
|
7808
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7809
|
+
|
|
8188
7810
|
conversion_rate: number | null;
|
|
8189
7811
|
|
|
8190
7812
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8236,7 +7858,7 @@ export namespace Price {
|
|
|
8236
7858
|
*/
|
|
8237
7859
|
minimum_amount: string | null;
|
|
8238
7860
|
|
|
8239
|
-
model_type: '
|
|
7861
|
+
model_type: 'tiered_package';
|
|
8240
7862
|
|
|
8241
7863
|
name: string;
|
|
8242
7864
|
|
|
@@ -8250,89 +7872,12 @@ export namespace Price {
|
|
|
8250
7872
|
*/
|
|
8251
7873
|
replaces_price_id: string | null;
|
|
8252
7874
|
|
|
8253
|
-
|
|
8254
|
-
}
|
|
8255
|
-
|
|
8256
|
-
export interface BulkPrice {
|
|
8257
|
-
id: string;
|
|
8258
|
-
|
|
8259
|
-
billable_metric: Shared.BillableMetricTiny | null;
|
|
8260
|
-
|
|
8261
|
-
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8262
|
-
|
|
8263
|
-
bulk_config: Shared.BulkConfig;
|
|
8264
|
-
|
|
8265
|
-
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8266
|
-
|
|
8267
|
-
conversion_rate: number | null;
|
|
8268
|
-
|
|
8269
|
-
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8270
|
-
|
|
8271
|
-
created_at: string;
|
|
8272
|
-
|
|
8273
|
-
credit_allocation: Shared.Allocation | null;
|
|
8274
|
-
|
|
8275
|
-
currency: string;
|
|
8276
|
-
|
|
8277
|
-
/**
|
|
8278
|
-
* @deprecated
|
|
8279
|
-
*/
|
|
8280
|
-
discount: Shared.Discount | null;
|
|
8281
|
-
|
|
8282
|
-
external_price_id: string | null;
|
|
8283
|
-
|
|
8284
|
-
fixed_price_quantity: number | null;
|
|
8285
|
-
|
|
8286
|
-
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
8287
|
-
|
|
8288
|
-
item: Shared.ItemSlim;
|
|
8289
|
-
|
|
8290
|
-
/**
|
|
8291
|
-
* @deprecated
|
|
8292
|
-
*/
|
|
8293
|
-
maximum: Shared.Maximum | null;
|
|
8294
|
-
|
|
8295
|
-
/**
|
|
8296
|
-
* @deprecated
|
|
8297
|
-
*/
|
|
8298
|
-
maximum_amount: string | null;
|
|
8299
|
-
|
|
8300
|
-
/**
|
|
8301
|
-
* User specified key-value pairs for the resource. If not present, this defaults
|
|
8302
|
-
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
8303
|
-
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
8304
|
-
* `null`.
|
|
8305
|
-
*/
|
|
8306
|
-
metadata: { [key: string]: string };
|
|
8307
|
-
|
|
8308
|
-
/**
|
|
8309
|
-
* @deprecated
|
|
8310
|
-
*/
|
|
8311
|
-
minimum: Shared.Minimum | null;
|
|
8312
|
-
|
|
8313
|
-
/**
|
|
8314
|
-
* @deprecated
|
|
8315
|
-
*/
|
|
8316
|
-
minimum_amount: string | null;
|
|
8317
|
-
|
|
8318
|
-
model_type: 'bulk';
|
|
8319
|
-
|
|
8320
|
-
name: string;
|
|
8321
|
-
|
|
8322
|
-
plan_phase_order: number | null;
|
|
8323
|
-
|
|
8324
|
-
price_type: 'usage_price' | 'fixed_price';
|
|
8325
|
-
|
|
8326
|
-
/**
|
|
8327
|
-
* The price id this price replaces. This price will take the place of the replaced
|
|
8328
|
-
* price in plan version migrations.
|
|
8329
|
-
*/
|
|
8330
|
-
replaces_price_id: string | null;
|
|
7875
|
+
tiered_package_config: { [key: string]: unknown };
|
|
8331
7876
|
|
|
8332
7877
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8333
7878
|
}
|
|
8334
7879
|
|
|
8335
|
-
export interface
|
|
7880
|
+
export interface GroupedTieredPrice {
|
|
8336
7881
|
id: string;
|
|
8337
7882
|
|
|
8338
7883
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8341,6 +7886,8 @@ export namespace Price {
|
|
|
8341
7886
|
|
|
8342
7887
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8343
7888
|
|
|
7889
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7890
|
+
|
|
8344
7891
|
conversion_rate: number | null;
|
|
8345
7892
|
|
|
8346
7893
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8360,6 +7907,8 @@ export namespace Price {
|
|
|
8360
7907
|
|
|
8361
7908
|
fixed_price_quantity: number | null;
|
|
8362
7909
|
|
|
7910
|
+
grouped_tiered_config: { [key: string]: unknown };
|
|
7911
|
+
|
|
8363
7912
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
8364
7913
|
|
|
8365
7914
|
item: Shared.ItemSlim;
|
|
@@ -8392,7 +7941,7 @@ export namespace Price {
|
|
|
8392
7941
|
*/
|
|
8393
7942
|
minimum_amount: string | null;
|
|
8394
7943
|
|
|
8395
|
-
model_type: '
|
|
7944
|
+
model_type: 'grouped_tiered';
|
|
8396
7945
|
|
|
8397
7946
|
name: string;
|
|
8398
7947
|
|
|
@@ -8406,12 +7955,10 @@ export namespace Price {
|
|
|
8406
7955
|
*/
|
|
8407
7956
|
replaces_price_id: string | null;
|
|
8408
7957
|
|
|
8409
|
-
threshold_total_amount_config: { [key: string]: unknown };
|
|
8410
|
-
|
|
8411
7958
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8412
7959
|
}
|
|
8413
7960
|
|
|
8414
|
-
export interface
|
|
7961
|
+
export interface TieredWithMinimumPrice {
|
|
8415
7962
|
id: string;
|
|
8416
7963
|
|
|
8417
7964
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8420,6 +7967,8 @@ export namespace Price {
|
|
|
8420
7967
|
|
|
8421
7968
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8422
7969
|
|
|
7970
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
7971
|
+
|
|
8423
7972
|
conversion_rate: number | null;
|
|
8424
7973
|
|
|
8425
7974
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8471,7 +8020,7 @@ export namespace Price {
|
|
|
8471
8020
|
*/
|
|
8472
8021
|
minimum_amount: string | null;
|
|
8473
8022
|
|
|
8474
|
-
model_type: '
|
|
8023
|
+
model_type: 'tiered_with_minimum';
|
|
8475
8024
|
|
|
8476
8025
|
name: string;
|
|
8477
8026
|
|
|
@@ -8485,12 +8034,12 @@ export namespace Price {
|
|
|
8485
8034
|
*/
|
|
8486
8035
|
replaces_price_id: string | null;
|
|
8487
8036
|
|
|
8488
|
-
|
|
8037
|
+
tiered_with_minimum_config: { [key: string]: unknown };
|
|
8489
8038
|
|
|
8490
8039
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8491
8040
|
}
|
|
8492
8041
|
|
|
8493
|
-
export interface
|
|
8042
|
+
export interface TieredPackageWithMinimumPrice {
|
|
8494
8043
|
id: string;
|
|
8495
8044
|
|
|
8496
8045
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8499,6 +8048,8 @@ export namespace Price {
|
|
|
8499
8048
|
|
|
8500
8049
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8501
8050
|
|
|
8051
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8052
|
+
|
|
8502
8053
|
conversion_rate: number | null;
|
|
8503
8054
|
|
|
8504
8055
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8518,8 +8069,6 @@ export namespace Price {
|
|
|
8518
8069
|
|
|
8519
8070
|
fixed_price_quantity: number | null;
|
|
8520
8071
|
|
|
8521
|
-
grouped_tiered_config: { [key: string]: unknown };
|
|
8522
|
-
|
|
8523
8072
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
8524
8073
|
|
|
8525
8074
|
item: Shared.ItemSlim;
|
|
@@ -8552,7 +8101,7 @@ export namespace Price {
|
|
|
8552
8101
|
*/
|
|
8553
8102
|
minimum_amount: string | null;
|
|
8554
8103
|
|
|
8555
|
-
model_type: '
|
|
8104
|
+
model_type: 'tiered_package_with_minimum';
|
|
8556
8105
|
|
|
8557
8106
|
name: string;
|
|
8558
8107
|
|
|
@@ -8566,10 +8115,12 @@ export namespace Price {
|
|
|
8566
8115
|
*/
|
|
8567
8116
|
replaces_price_id: string | null;
|
|
8568
8117
|
|
|
8118
|
+
tiered_package_with_minimum_config: { [key: string]: unknown };
|
|
8119
|
+
|
|
8569
8120
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8570
8121
|
}
|
|
8571
8122
|
|
|
8572
|
-
export interface
|
|
8123
|
+
export interface PackageWithAllocationPrice {
|
|
8573
8124
|
id: string;
|
|
8574
8125
|
|
|
8575
8126
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8578,6 +8129,8 @@ export namespace Price {
|
|
|
8578
8129
|
|
|
8579
8130
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8580
8131
|
|
|
8132
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8133
|
+
|
|
8581
8134
|
conversion_rate: number | null;
|
|
8582
8135
|
|
|
8583
8136
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8629,10 +8182,12 @@ export namespace Price {
|
|
|
8629
8182
|
*/
|
|
8630
8183
|
minimum_amount: string | null;
|
|
8631
8184
|
|
|
8632
|
-
model_type: '
|
|
8185
|
+
model_type: 'package_with_allocation';
|
|
8633
8186
|
|
|
8634
8187
|
name: string;
|
|
8635
8188
|
|
|
8189
|
+
package_with_allocation_config: { [key: string]: unknown };
|
|
8190
|
+
|
|
8636
8191
|
plan_phase_order: number | null;
|
|
8637
8192
|
|
|
8638
8193
|
price_type: 'usage_price' | 'fixed_price';
|
|
@@ -8643,12 +8198,10 @@ export namespace Price {
|
|
|
8643
8198
|
*/
|
|
8644
8199
|
replaces_price_id: string | null;
|
|
8645
8200
|
|
|
8646
|
-
tiered_with_minimum_config: { [key: string]: unknown };
|
|
8647
|
-
|
|
8648
8201
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8649
8202
|
}
|
|
8650
8203
|
|
|
8651
|
-
export interface
|
|
8204
|
+
export interface UnitWithPercentPrice {
|
|
8652
8205
|
id: string;
|
|
8653
8206
|
|
|
8654
8207
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8657,6 +8210,8 @@ export namespace Price {
|
|
|
8657
8210
|
|
|
8658
8211
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8659
8212
|
|
|
8213
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8214
|
+
|
|
8660
8215
|
conversion_rate: number | null;
|
|
8661
8216
|
|
|
8662
8217
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8708,7 +8263,7 @@ export namespace Price {
|
|
|
8708
8263
|
*/
|
|
8709
8264
|
minimum_amount: string | null;
|
|
8710
8265
|
|
|
8711
|
-
model_type: '
|
|
8266
|
+
model_type: 'unit_with_percent';
|
|
8712
8267
|
|
|
8713
8268
|
name: string;
|
|
8714
8269
|
|
|
@@ -8722,12 +8277,12 @@ export namespace Price {
|
|
|
8722
8277
|
*/
|
|
8723
8278
|
replaces_price_id: string | null;
|
|
8724
8279
|
|
|
8725
|
-
|
|
8280
|
+
unit_with_percent_config: { [key: string]: unknown };
|
|
8726
8281
|
|
|
8727
8282
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8728
8283
|
}
|
|
8729
8284
|
|
|
8730
|
-
export interface
|
|
8285
|
+
export interface MatrixWithAllocationPrice {
|
|
8731
8286
|
id: string;
|
|
8732
8287
|
|
|
8733
8288
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8736,6 +8291,8 @@ export namespace Price {
|
|
|
8736
8291
|
|
|
8737
8292
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8738
8293
|
|
|
8294
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8295
|
+
|
|
8739
8296
|
conversion_rate: number | null;
|
|
8740
8297
|
|
|
8741
8298
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8759,6 +8316,8 @@ export namespace Price {
|
|
|
8759
8316
|
|
|
8760
8317
|
item: Shared.ItemSlim;
|
|
8761
8318
|
|
|
8319
|
+
matrix_with_allocation_config: Shared.MatrixWithAllocationConfig;
|
|
8320
|
+
|
|
8762
8321
|
/**
|
|
8763
8322
|
* @deprecated
|
|
8764
8323
|
*/
|
|
@@ -8787,12 +8346,10 @@ export namespace Price {
|
|
|
8787
8346
|
*/
|
|
8788
8347
|
minimum_amount: string | null;
|
|
8789
8348
|
|
|
8790
|
-
model_type: '
|
|
8349
|
+
model_type: 'matrix_with_allocation';
|
|
8791
8350
|
|
|
8792
8351
|
name: string;
|
|
8793
8352
|
|
|
8794
|
-
package_with_allocation_config: { [key: string]: unknown };
|
|
8795
|
-
|
|
8796
8353
|
plan_phase_order: number | null;
|
|
8797
8354
|
|
|
8798
8355
|
price_type: 'usage_price' | 'fixed_price';
|
|
@@ -8806,7 +8363,7 @@ export namespace Price {
|
|
|
8806
8363
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8807
8364
|
}
|
|
8808
8365
|
|
|
8809
|
-
export interface
|
|
8366
|
+
export interface TieredWithProrationPrice {
|
|
8810
8367
|
id: string;
|
|
8811
8368
|
|
|
8812
8369
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8815,6 +8372,8 @@ export namespace Price {
|
|
|
8815
8372
|
|
|
8816
8373
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8817
8374
|
|
|
8375
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8376
|
+
|
|
8818
8377
|
conversion_rate: number | null;
|
|
8819
8378
|
|
|
8820
8379
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -8866,7 +8425,7 @@ export namespace Price {
|
|
|
8866
8425
|
*/
|
|
8867
8426
|
minimum_amount: string | null;
|
|
8868
8427
|
|
|
8869
|
-
model_type: '
|
|
8428
|
+
model_type: 'tiered_with_proration';
|
|
8870
8429
|
|
|
8871
8430
|
name: string;
|
|
8872
8431
|
|
|
@@ -8880,12 +8439,12 @@ export namespace Price {
|
|
|
8880
8439
|
*/
|
|
8881
8440
|
replaces_price_id: string | null;
|
|
8882
8441
|
|
|
8883
|
-
|
|
8442
|
+
tiered_with_proration_config: { [key: string]: unknown };
|
|
8884
8443
|
|
|
8885
8444
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8886
8445
|
}
|
|
8887
8446
|
|
|
8888
|
-
export interface
|
|
8447
|
+
export interface UnitWithProrationPrice {
|
|
8889
8448
|
id: string;
|
|
8890
8449
|
|
|
8891
8450
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -8894,84 +8453,7 @@ export namespace Price {
|
|
|
8894
8453
|
|
|
8895
8454
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8896
8455
|
|
|
8897
|
-
|
|
8898
|
-
|
|
8899
|
-
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8900
|
-
|
|
8901
|
-
created_at: string;
|
|
8902
|
-
|
|
8903
|
-
credit_allocation: Shared.Allocation | null;
|
|
8904
|
-
|
|
8905
|
-
currency: string;
|
|
8906
|
-
|
|
8907
|
-
/**
|
|
8908
|
-
* @deprecated
|
|
8909
|
-
*/
|
|
8910
|
-
discount: Shared.Discount | null;
|
|
8911
|
-
|
|
8912
|
-
external_price_id: string | null;
|
|
8913
|
-
|
|
8914
|
-
fixed_price_quantity: number | null;
|
|
8915
|
-
|
|
8916
|
-
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
8917
|
-
|
|
8918
|
-
item: Shared.ItemSlim;
|
|
8919
|
-
|
|
8920
|
-
matrix_with_allocation_config: Shared.MatrixWithAllocationConfig;
|
|
8921
|
-
|
|
8922
|
-
/**
|
|
8923
|
-
* @deprecated
|
|
8924
|
-
*/
|
|
8925
|
-
maximum: Shared.Maximum | null;
|
|
8926
|
-
|
|
8927
|
-
/**
|
|
8928
|
-
* @deprecated
|
|
8929
|
-
*/
|
|
8930
|
-
maximum_amount: string | null;
|
|
8931
|
-
|
|
8932
|
-
/**
|
|
8933
|
-
* User specified key-value pairs for the resource. If not present, this defaults
|
|
8934
|
-
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
8935
|
-
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
8936
|
-
* `null`.
|
|
8937
|
-
*/
|
|
8938
|
-
metadata: { [key: string]: string };
|
|
8939
|
-
|
|
8940
|
-
/**
|
|
8941
|
-
* @deprecated
|
|
8942
|
-
*/
|
|
8943
|
-
minimum: Shared.Minimum | null;
|
|
8944
|
-
|
|
8945
|
-
/**
|
|
8946
|
-
* @deprecated
|
|
8947
|
-
*/
|
|
8948
|
-
minimum_amount: string | null;
|
|
8949
|
-
|
|
8950
|
-
model_type: 'matrix_with_allocation';
|
|
8951
|
-
|
|
8952
|
-
name: string;
|
|
8953
|
-
|
|
8954
|
-
plan_phase_order: number | null;
|
|
8955
|
-
|
|
8956
|
-
price_type: 'usage_price' | 'fixed_price';
|
|
8957
|
-
|
|
8958
|
-
/**
|
|
8959
|
-
* The price id this price replaces. This price will take the place of the replaced
|
|
8960
|
-
* price in plan version migrations.
|
|
8961
|
-
*/
|
|
8962
|
-
replaces_price_id: string | null;
|
|
8963
|
-
|
|
8964
|
-
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8965
|
-
}
|
|
8966
|
-
|
|
8967
|
-
export interface TieredWithProrationPrice {
|
|
8968
|
-
id: string;
|
|
8969
|
-
|
|
8970
|
-
billable_metric: Shared.BillableMetricTiny | null;
|
|
8971
|
-
|
|
8972
|
-
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8973
|
-
|
|
8974
|
-
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8456
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8975
8457
|
|
|
8976
8458
|
conversion_rate: number | null;
|
|
8977
8459
|
|
|
@@ -9024,7 +8506,7 @@ export namespace Price {
|
|
|
9024
8506
|
*/
|
|
9025
8507
|
minimum_amount: string | null;
|
|
9026
8508
|
|
|
9027
|
-
model_type: '
|
|
8509
|
+
model_type: 'unit_with_proration';
|
|
9028
8510
|
|
|
9029
8511
|
name: string;
|
|
9030
8512
|
|
|
@@ -9038,12 +8520,12 @@ export namespace Price {
|
|
|
9038
8520
|
*/
|
|
9039
8521
|
replaces_price_id: string | null;
|
|
9040
8522
|
|
|
9041
|
-
|
|
8523
|
+
unit_with_proration_config: { [key: string]: unknown };
|
|
9042
8524
|
|
|
9043
8525
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9044
8526
|
}
|
|
9045
8527
|
|
|
9046
|
-
export interface
|
|
8528
|
+
export interface GroupedAllocationPrice {
|
|
9047
8529
|
id: string;
|
|
9048
8530
|
|
|
9049
8531
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9052,6 +8534,8 @@ export namespace Price {
|
|
|
9052
8534
|
|
|
9053
8535
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9054
8536
|
|
|
8537
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8538
|
+
|
|
9055
8539
|
conversion_rate: number | null;
|
|
9056
8540
|
|
|
9057
8541
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9071,6 +8555,8 @@ export namespace Price {
|
|
|
9071
8555
|
|
|
9072
8556
|
fixed_price_quantity: number | null;
|
|
9073
8557
|
|
|
8558
|
+
grouped_allocation_config: { [key: string]: unknown };
|
|
8559
|
+
|
|
9074
8560
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9075
8561
|
|
|
9076
8562
|
item: Shared.ItemSlim;
|
|
@@ -9103,7 +8589,7 @@ export namespace Price {
|
|
|
9103
8589
|
*/
|
|
9104
8590
|
minimum_amount: string | null;
|
|
9105
8591
|
|
|
9106
|
-
model_type: '
|
|
8592
|
+
model_type: 'grouped_allocation';
|
|
9107
8593
|
|
|
9108
8594
|
name: string;
|
|
9109
8595
|
|
|
@@ -9117,12 +8603,10 @@ export namespace Price {
|
|
|
9117
8603
|
*/
|
|
9118
8604
|
replaces_price_id: string | null;
|
|
9119
8605
|
|
|
9120
|
-
unit_with_proration_config: { [key: string]: unknown };
|
|
9121
|
-
|
|
9122
8606
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9123
8607
|
}
|
|
9124
8608
|
|
|
9125
|
-
export interface
|
|
8609
|
+
export interface GroupedWithProratedMinimumPrice {
|
|
9126
8610
|
id: string;
|
|
9127
8611
|
|
|
9128
8612
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9131,6 +8615,8 @@ export namespace Price {
|
|
|
9131
8615
|
|
|
9132
8616
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9133
8617
|
|
|
8618
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8619
|
+
|
|
9134
8620
|
conversion_rate: number | null;
|
|
9135
8621
|
|
|
9136
8622
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9150,7 +8636,7 @@ export namespace Price {
|
|
|
9150
8636
|
|
|
9151
8637
|
fixed_price_quantity: number | null;
|
|
9152
8638
|
|
|
9153
|
-
|
|
8639
|
+
grouped_with_prorated_minimum_config: { [key: string]: unknown };
|
|
9154
8640
|
|
|
9155
8641
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9156
8642
|
|
|
@@ -9184,7 +8670,7 @@ export namespace Price {
|
|
|
9184
8670
|
*/
|
|
9185
8671
|
minimum_amount: string | null;
|
|
9186
8672
|
|
|
9187
|
-
model_type: '
|
|
8673
|
+
model_type: 'grouped_with_prorated_minimum';
|
|
9188
8674
|
|
|
9189
8675
|
name: string;
|
|
9190
8676
|
|
|
@@ -9201,7 +8687,7 @@ export namespace Price {
|
|
|
9201
8687
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9202
8688
|
}
|
|
9203
8689
|
|
|
9204
|
-
export interface
|
|
8690
|
+
export interface GroupedWithMeteredMinimumPrice {
|
|
9205
8691
|
id: string;
|
|
9206
8692
|
|
|
9207
8693
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9210,6 +8696,8 @@ export namespace Price {
|
|
|
9210
8696
|
|
|
9211
8697
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9212
8698
|
|
|
8699
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8700
|
+
|
|
9213
8701
|
conversion_rate: number | null;
|
|
9214
8702
|
|
|
9215
8703
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9229,7 +8717,7 @@ export namespace Price {
|
|
|
9229
8717
|
|
|
9230
8718
|
fixed_price_quantity: number | null;
|
|
9231
8719
|
|
|
9232
|
-
|
|
8720
|
+
grouped_with_metered_minimum_config: { [key: string]: unknown };
|
|
9233
8721
|
|
|
9234
8722
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9235
8723
|
|
|
@@ -9263,7 +8751,7 @@ export namespace Price {
|
|
|
9263
8751
|
*/
|
|
9264
8752
|
minimum_amount: string | null;
|
|
9265
8753
|
|
|
9266
|
-
model_type: '
|
|
8754
|
+
model_type: 'grouped_with_metered_minimum';
|
|
9267
8755
|
|
|
9268
8756
|
name: string;
|
|
9269
8757
|
|
|
@@ -9280,7 +8768,7 @@ export namespace Price {
|
|
|
9280
8768
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9281
8769
|
}
|
|
9282
8770
|
|
|
9283
|
-
export interface
|
|
8771
|
+
export interface MatrixWithDisplayNamePrice {
|
|
9284
8772
|
id: string;
|
|
9285
8773
|
|
|
9286
8774
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9289,6 +8777,8 @@ export namespace Price {
|
|
|
9289
8777
|
|
|
9290
8778
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9291
8779
|
|
|
8780
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8781
|
+
|
|
9292
8782
|
conversion_rate: number | null;
|
|
9293
8783
|
|
|
9294
8784
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9308,12 +8798,12 @@ export namespace Price {
|
|
|
9308
8798
|
|
|
9309
8799
|
fixed_price_quantity: number | null;
|
|
9310
8800
|
|
|
9311
|
-
grouped_with_metered_minimum_config: { [key: string]: unknown };
|
|
9312
|
-
|
|
9313
8801
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9314
8802
|
|
|
9315
8803
|
item: Shared.ItemSlim;
|
|
9316
8804
|
|
|
8805
|
+
matrix_with_display_name_config: { [key: string]: unknown };
|
|
8806
|
+
|
|
9317
8807
|
/**
|
|
9318
8808
|
* @deprecated
|
|
9319
8809
|
*/
|
|
@@ -9342,7 +8832,7 @@ export namespace Price {
|
|
|
9342
8832
|
*/
|
|
9343
8833
|
minimum_amount: string | null;
|
|
9344
8834
|
|
|
9345
|
-
model_type: '
|
|
8835
|
+
model_type: 'matrix_with_display_name';
|
|
9346
8836
|
|
|
9347
8837
|
name: string;
|
|
9348
8838
|
|
|
@@ -9359,15 +8849,19 @@ export namespace Price {
|
|
|
9359
8849
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9360
8850
|
}
|
|
9361
8851
|
|
|
9362
|
-
export interface
|
|
8852
|
+
export interface BulkWithProrationPrice {
|
|
9363
8853
|
id: string;
|
|
9364
8854
|
|
|
9365
8855
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
9366
8856
|
|
|
9367
8857
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9368
8858
|
|
|
8859
|
+
bulk_with_proration_config: { [key: string]: unknown };
|
|
8860
|
+
|
|
9369
8861
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9370
8862
|
|
|
8863
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8864
|
+
|
|
9371
8865
|
conversion_rate: number | null;
|
|
9372
8866
|
|
|
9373
8867
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9391,8 +8885,6 @@ export namespace Price {
|
|
|
9391
8885
|
|
|
9392
8886
|
item: Shared.ItemSlim;
|
|
9393
8887
|
|
|
9394
|
-
matrix_with_display_name_config: { [key: string]: unknown };
|
|
9395
|
-
|
|
9396
8888
|
/**
|
|
9397
8889
|
* @deprecated
|
|
9398
8890
|
*/
|
|
@@ -9421,7 +8913,7 @@ export namespace Price {
|
|
|
9421
8913
|
*/
|
|
9422
8914
|
minimum_amount: string | null;
|
|
9423
8915
|
|
|
9424
|
-
model_type: '
|
|
8916
|
+
model_type: 'bulk_with_proration';
|
|
9425
8917
|
|
|
9426
8918
|
name: string;
|
|
9427
8919
|
|
|
@@ -9438,17 +8930,17 @@ export namespace Price {
|
|
|
9438
8930
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9439
8931
|
}
|
|
9440
8932
|
|
|
9441
|
-
export interface
|
|
8933
|
+
export interface GroupedTieredPackagePrice {
|
|
9442
8934
|
id: string;
|
|
9443
8935
|
|
|
9444
8936
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
9445
8937
|
|
|
9446
8938
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9447
8939
|
|
|
9448
|
-
bulk_with_proration_config: { [key: string]: unknown };
|
|
9449
|
-
|
|
9450
8940
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9451
8941
|
|
|
8942
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
8943
|
+
|
|
9452
8944
|
conversion_rate: number | null;
|
|
9453
8945
|
|
|
9454
8946
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9468,6 +8960,8 @@ export namespace Price {
|
|
|
9468
8960
|
|
|
9469
8961
|
fixed_price_quantity: number | null;
|
|
9470
8962
|
|
|
8963
|
+
grouped_tiered_package_config: { [key: string]: unknown };
|
|
8964
|
+
|
|
9471
8965
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9472
8966
|
|
|
9473
8967
|
item: Shared.ItemSlim;
|
|
@@ -9500,7 +8994,7 @@ export namespace Price {
|
|
|
9500
8994
|
*/
|
|
9501
8995
|
minimum_amount: string | null;
|
|
9502
8996
|
|
|
9503
|
-
model_type: '
|
|
8997
|
+
model_type: 'grouped_tiered_package';
|
|
9504
8998
|
|
|
9505
8999
|
name: string;
|
|
9506
9000
|
|
|
@@ -9517,7 +9011,7 @@ export namespace Price {
|
|
|
9517
9011
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9518
9012
|
}
|
|
9519
9013
|
|
|
9520
|
-
export interface
|
|
9014
|
+
export interface MaxGroupTieredPackagePrice {
|
|
9521
9015
|
id: string;
|
|
9522
9016
|
|
|
9523
9017
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9526,6 +9020,8 @@ export namespace Price {
|
|
|
9526
9020
|
|
|
9527
9021
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9528
9022
|
|
|
9023
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
9024
|
+
|
|
9529
9025
|
conversion_rate: number | null;
|
|
9530
9026
|
|
|
9531
9027
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9545,12 +9041,12 @@ export namespace Price {
|
|
|
9545
9041
|
|
|
9546
9042
|
fixed_price_quantity: number | null;
|
|
9547
9043
|
|
|
9548
|
-
grouped_tiered_package_config: { [key: string]: unknown };
|
|
9549
|
-
|
|
9550
9044
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9551
9045
|
|
|
9552
9046
|
item: Shared.ItemSlim;
|
|
9553
9047
|
|
|
9048
|
+
max_group_tiered_package_config: { [key: string]: unknown };
|
|
9049
|
+
|
|
9554
9050
|
/**
|
|
9555
9051
|
* @deprecated
|
|
9556
9052
|
*/
|
|
@@ -9579,7 +9075,7 @@ export namespace Price {
|
|
|
9579
9075
|
*/
|
|
9580
9076
|
minimum_amount: string | null;
|
|
9581
9077
|
|
|
9582
|
-
model_type: '
|
|
9078
|
+
model_type: 'max_group_tiered_package';
|
|
9583
9079
|
|
|
9584
9080
|
name: string;
|
|
9585
9081
|
|
|
@@ -9596,7 +9092,7 @@ export namespace Price {
|
|
|
9596
9092
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9597
9093
|
}
|
|
9598
9094
|
|
|
9599
|
-
export interface
|
|
9095
|
+
export interface ScalableMatrixWithUnitPricingPrice {
|
|
9600
9096
|
id: string;
|
|
9601
9097
|
|
|
9602
9098
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9605,6 +9101,8 @@ export namespace Price {
|
|
|
9605
9101
|
|
|
9606
9102
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9607
9103
|
|
|
9104
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
9105
|
+
|
|
9608
9106
|
conversion_rate: number | null;
|
|
9609
9107
|
|
|
9610
9108
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9628,8 +9126,6 @@ export namespace Price {
|
|
|
9628
9126
|
|
|
9629
9127
|
item: Shared.ItemSlim;
|
|
9630
9128
|
|
|
9631
|
-
max_group_tiered_package_config: { [key: string]: unknown };
|
|
9632
|
-
|
|
9633
9129
|
/**
|
|
9634
9130
|
* @deprecated
|
|
9635
9131
|
*/
|
|
@@ -9658,7 +9154,7 @@ export namespace Price {
|
|
|
9658
9154
|
*/
|
|
9659
9155
|
minimum_amount: string | null;
|
|
9660
9156
|
|
|
9661
|
-
model_type: '
|
|
9157
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
9662
9158
|
|
|
9663
9159
|
name: string;
|
|
9664
9160
|
|
|
@@ -9672,10 +9168,12 @@ export namespace Price {
|
|
|
9672
9168
|
*/
|
|
9673
9169
|
replaces_price_id: string | null;
|
|
9674
9170
|
|
|
9171
|
+
scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
|
|
9172
|
+
|
|
9675
9173
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9676
9174
|
}
|
|
9677
9175
|
|
|
9678
|
-
export interface
|
|
9176
|
+
export interface ScalableMatrixWithTieredPricingPrice {
|
|
9679
9177
|
id: string;
|
|
9680
9178
|
|
|
9681
9179
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9684,6 +9182,8 @@ export namespace Price {
|
|
|
9684
9182
|
|
|
9685
9183
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9686
9184
|
|
|
9185
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
9186
|
+
|
|
9687
9187
|
conversion_rate: number | null;
|
|
9688
9188
|
|
|
9689
9189
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9735,7 +9235,7 @@ export namespace Price {
|
|
|
9735
9235
|
*/
|
|
9736
9236
|
minimum_amount: string | null;
|
|
9737
9237
|
|
|
9738
|
-
model_type: '
|
|
9238
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
9739
9239
|
|
|
9740
9240
|
name: string;
|
|
9741
9241
|
|
|
@@ -9749,12 +9249,12 @@ export namespace Price {
|
|
|
9749
9249
|
*/
|
|
9750
9250
|
replaces_price_id: string | null;
|
|
9751
9251
|
|
|
9752
|
-
|
|
9252
|
+
scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
|
|
9753
9253
|
|
|
9754
9254
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9755
9255
|
}
|
|
9756
9256
|
|
|
9757
|
-
export interface
|
|
9257
|
+
export interface CumulativeGroupedBulkPrice {
|
|
9758
9258
|
id: string;
|
|
9759
9259
|
|
|
9760
9260
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9763,6 +9263,8 @@ export namespace Price {
|
|
|
9763
9263
|
|
|
9764
9264
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9765
9265
|
|
|
9266
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
9267
|
+
|
|
9766
9268
|
conversion_rate: number | null;
|
|
9767
9269
|
|
|
9768
9270
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9771,6 +9273,8 @@ export namespace Price {
|
|
|
9771
9273
|
|
|
9772
9274
|
credit_allocation: Shared.Allocation | null;
|
|
9773
9275
|
|
|
9276
|
+
cumulative_grouped_bulk_config: { [key: string]: unknown };
|
|
9277
|
+
|
|
9774
9278
|
currency: string;
|
|
9775
9279
|
|
|
9776
9280
|
/**
|
|
@@ -9814,7 +9318,7 @@ export namespace Price {
|
|
|
9814
9318
|
*/
|
|
9815
9319
|
minimum_amount: string | null;
|
|
9816
9320
|
|
|
9817
|
-
model_type: '
|
|
9321
|
+
model_type: 'cumulative_grouped_bulk';
|
|
9818
9322
|
|
|
9819
9323
|
name: string;
|
|
9820
9324
|
|
|
@@ -9828,12 +9332,10 @@ export namespace Price {
|
|
|
9828
9332
|
*/
|
|
9829
9333
|
replaces_price_id: string | null;
|
|
9830
9334
|
|
|
9831
|
-
scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
|
|
9832
|
-
|
|
9833
9335
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9834
9336
|
}
|
|
9835
9337
|
|
|
9836
|
-
export interface
|
|
9338
|
+
export interface GroupedWithMinMaxThresholdsPrice {
|
|
9837
9339
|
id: string;
|
|
9838
9340
|
|
|
9839
9341
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9842,6 +9344,8 @@ export namespace Price {
|
|
|
9842
9344
|
|
|
9843
9345
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9844
9346
|
|
|
9347
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
9348
|
+
|
|
9845
9349
|
conversion_rate: number | null;
|
|
9846
9350
|
|
|
9847
9351
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9850,8 +9354,6 @@ export namespace Price {
|
|
|
9850
9354
|
|
|
9851
9355
|
credit_allocation: Shared.Allocation | null;
|
|
9852
9356
|
|
|
9853
|
-
cumulative_grouped_bulk_config: { [key: string]: unknown };
|
|
9854
|
-
|
|
9855
9357
|
currency: string;
|
|
9856
9358
|
|
|
9857
9359
|
/**
|
|
@@ -9863,6 +9365,8 @@ export namespace Price {
|
|
|
9863
9365
|
|
|
9864
9366
|
fixed_price_quantity: number | null;
|
|
9865
9367
|
|
|
9368
|
+
grouped_with_min_max_thresholds_config: { [key: string]: unknown };
|
|
9369
|
+
|
|
9866
9370
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9867
9371
|
|
|
9868
9372
|
item: Shared.ItemSlim;
|
|
@@ -9895,7 +9399,7 @@ export namespace Price {
|
|
|
9895
9399
|
*/
|
|
9896
9400
|
minimum_amount: string | null;
|
|
9897
9401
|
|
|
9898
|
-
model_type: '
|
|
9402
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
9899
9403
|
|
|
9900
9404
|
name: string;
|
|
9901
9405
|
|
|
@@ -9912,7 +9416,7 @@ export namespace Price {
|
|
|
9912
9416
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9913
9417
|
}
|
|
9914
9418
|
|
|
9915
|
-
export interface
|
|
9419
|
+
export interface MinimumCompositePrice {
|
|
9916
9420
|
id: string;
|
|
9917
9421
|
|
|
9918
9422
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -9921,6 +9425,8 @@ export namespace Price {
|
|
|
9921
9425
|
|
|
9922
9426
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9923
9427
|
|
|
9428
|
+
composite_price_filters: Array<Shared.TransformPriceFilter> | null;
|
|
9429
|
+
|
|
9924
9430
|
conversion_rate: number | null;
|
|
9925
9431
|
|
|
9926
9432
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
@@ -9940,8 +9446,6 @@ export namespace Price {
|
|
|
9940
9446
|
|
|
9941
9447
|
fixed_price_quantity: number | null;
|
|
9942
9448
|
|
|
9943
|
-
grouped_with_min_max_thresholds_config: { [key: string]: unknown };
|
|
9944
|
-
|
|
9945
9449
|
invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
|
|
9946
9450
|
|
|
9947
9451
|
item: Shared.ItemSlim;
|
|
@@ -9974,7 +9478,9 @@ export namespace Price {
|
|
|
9974
9478
|
*/
|
|
9975
9479
|
minimum_amount: string | null;
|
|
9976
9480
|
|
|
9977
|
-
|
|
9481
|
+
minimum_config: MinimumCompositePrice.MinimumConfig;
|
|
9482
|
+
|
|
9483
|
+
model_type: 'minimum';
|
|
9978
9484
|
|
|
9979
9485
|
name: string;
|
|
9980
9486
|
|
|
@@ -9990,6 +9496,21 @@ export namespace Price {
|
|
|
9990
9496
|
|
|
9991
9497
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9992
9498
|
}
|
|
9499
|
+
|
|
9500
|
+
export namespace MinimumCompositePrice {
|
|
9501
|
+
export interface MinimumConfig {
|
|
9502
|
+
/**
|
|
9503
|
+
* The minimum amount to apply
|
|
9504
|
+
*/
|
|
9505
|
+
minimum_amount: string;
|
|
9506
|
+
|
|
9507
|
+
/**
|
|
9508
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
9509
|
+
* service period. Set to false to disable proration.
|
|
9510
|
+
*/
|
|
9511
|
+
prorated?: boolean | null;
|
|
9512
|
+
}
|
|
9513
|
+
}
|
|
9993
9514
|
}
|
|
9994
9515
|
|
|
9995
9516
|
/**
|
|
@@ -10150,14 +9671,6 @@ export interface TierSubLineItem {
|
|
|
10150
9671
|
type: 'tier';
|
|
10151
9672
|
}
|
|
10152
9673
|
|
|
10153
|
-
export interface TieredBPSConfig {
|
|
10154
|
-
/**
|
|
10155
|
-
* Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
|
10156
|
-
* tiers
|
|
10157
|
-
*/
|
|
10158
|
-
tiers: Array<BPSTier>;
|
|
10159
|
-
}
|
|
10160
|
-
|
|
10161
9674
|
export interface TieredConfig {
|
|
10162
9675
|
/**
|
|
10163
9676
|
* Tiers for rating based on total usage quantities into the specified tier
|