orb-billing 5.19.0 → 5.20.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 +8 -0
- package/index.d.mts +0 -1
- package/index.d.ts +0 -1
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/beta/beta.d.ts +12 -0
- 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 +12 -0
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/customers/credits/ledger.d.ts +17 -0
- 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/plans/plans.d.ts +6 -0
- 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 +18 -0
- 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 +910 -70
- 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 +30 -0
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/index.ts +0 -1
- package/src/resources/beta/beta.ts +14 -0
- package/src/resources/beta/external-plan-id.ts +14 -0
- package/src/resources/customers/credits/ledger.ts +21 -0
- package/src/resources/plans/plans.ts +7 -0
- package/src/resources/prices/prices.ts +21 -0
- package/src/resources/shared.ts +1082 -76
- package/src/resources/subscriptions.ts +35 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/shared.d.ts
CHANGED
|
@@ -56,9 +56,25 @@ export interface AmountDiscount {
|
|
|
56
56
|
/**
|
|
57
57
|
* The filters that determine which prices to apply this discount to.
|
|
58
58
|
*/
|
|
59
|
-
filters?: Array<
|
|
59
|
+
filters?: Array<AmountDiscount.Filter> | null;
|
|
60
60
|
reason?: string | null;
|
|
61
61
|
}
|
|
62
|
+
export declare namespace AmountDiscount {
|
|
63
|
+
interface Filter {
|
|
64
|
+
/**
|
|
65
|
+
* The property of the price to filter on.
|
|
66
|
+
*/
|
|
67
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
68
|
+
/**
|
|
69
|
+
* Should prices that match the filter be included or excluded.
|
|
70
|
+
*/
|
|
71
|
+
operator: 'includes' | 'excludes';
|
|
72
|
+
/**
|
|
73
|
+
* The IDs or values that match this filter.
|
|
74
|
+
*/
|
|
75
|
+
values: Array<string>;
|
|
76
|
+
}
|
|
77
|
+
}
|
|
62
78
|
export interface AmountDiscountInterval {
|
|
63
79
|
/**
|
|
64
80
|
* Only available if discount_type is `amount`.
|
|
@@ -76,12 +92,28 @@ export interface AmountDiscountInterval {
|
|
|
76
92
|
/**
|
|
77
93
|
* The filters that determine which prices this discount interval applies to.
|
|
78
94
|
*/
|
|
79
|
-
filters: Array<
|
|
95
|
+
filters: Array<AmountDiscountInterval.Filter>;
|
|
80
96
|
/**
|
|
81
97
|
* The start date of the discount interval.
|
|
82
98
|
*/
|
|
83
99
|
start_date: string;
|
|
84
100
|
}
|
|
101
|
+
export declare namespace AmountDiscountInterval {
|
|
102
|
+
interface Filter {
|
|
103
|
+
/**
|
|
104
|
+
* The property of the price to filter on.
|
|
105
|
+
*/
|
|
106
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
107
|
+
/**
|
|
108
|
+
* Should prices that match the filter be included or excluded.
|
|
109
|
+
*/
|
|
110
|
+
operator: 'includes' | 'excludes';
|
|
111
|
+
/**
|
|
112
|
+
* The IDs or values that match this filter.
|
|
113
|
+
*/
|
|
114
|
+
values: Array<string>;
|
|
115
|
+
}
|
|
116
|
+
}
|
|
85
117
|
export interface BillableMetricTiny {
|
|
86
118
|
id: string;
|
|
87
119
|
}
|
|
@@ -1643,12 +1675,28 @@ export interface Maximum {
|
|
|
1643
1675
|
/**
|
|
1644
1676
|
* The filters that determine which prices to apply this maximum to.
|
|
1645
1677
|
*/
|
|
1646
|
-
filters: Array<
|
|
1678
|
+
filters: Array<Maximum.Filter>;
|
|
1647
1679
|
/**
|
|
1648
1680
|
* Maximum amount applied
|
|
1649
1681
|
*/
|
|
1650
1682
|
maximum_amount: string;
|
|
1651
1683
|
}
|
|
1684
|
+
export declare namespace Maximum {
|
|
1685
|
+
interface Filter {
|
|
1686
|
+
/**
|
|
1687
|
+
* The property of the price to filter on.
|
|
1688
|
+
*/
|
|
1689
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
1690
|
+
/**
|
|
1691
|
+
* Should prices that match the filter be included or excluded.
|
|
1692
|
+
*/
|
|
1693
|
+
operator: 'includes' | 'excludes';
|
|
1694
|
+
/**
|
|
1695
|
+
* The IDs or values that match this filter.
|
|
1696
|
+
*/
|
|
1697
|
+
values: Array<string>;
|
|
1698
|
+
}
|
|
1699
|
+
}
|
|
1652
1700
|
export interface MaximumInterval {
|
|
1653
1701
|
/**
|
|
1654
1702
|
* The price interval ids that this maximum interval applies to.
|
|
@@ -1661,7 +1709,7 @@ export interface MaximumInterval {
|
|
|
1661
1709
|
/**
|
|
1662
1710
|
* The filters that determine which prices this maximum interval applies to.
|
|
1663
1711
|
*/
|
|
1664
|
-
filters: Array<
|
|
1712
|
+
filters: Array<MaximumInterval.Filter>;
|
|
1665
1713
|
/**
|
|
1666
1714
|
* The maximum amount to charge in a given billing period for the price intervals
|
|
1667
1715
|
* this transform applies to.
|
|
@@ -1672,6 +1720,22 @@ export interface MaximumInterval {
|
|
|
1672
1720
|
*/
|
|
1673
1721
|
start_date: string;
|
|
1674
1722
|
}
|
|
1723
|
+
export declare namespace MaximumInterval {
|
|
1724
|
+
interface Filter {
|
|
1725
|
+
/**
|
|
1726
|
+
* The property of the price to filter on.
|
|
1727
|
+
*/
|
|
1728
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
1729
|
+
/**
|
|
1730
|
+
* Should prices that match the filter be included or excluded.
|
|
1731
|
+
*/
|
|
1732
|
+
operator: 'includes' | 'excludes';
|
|
1733
|
+
/**
|
|
1734
|
+
* The IDs or values that match this filter.
|
|
1735
|
+
*/
|
|
1736
|
+
values: Array<string>;
|
|
1737
|
+
}
|
|
1738
|
+
}
|
|
1675
1739
|
export interface Minimum {
|
|
1676
1740
|
/**
|
|
1677
1741
|
* @deprecated List of price_ids that this minimum amount applies to. For plan/plan
|
|
@@ -1681,12 +1745,28 @@ export interface Minimum {
|
|
|
1681
1745
|
/**
|
|
1682
1746
|
* The filters that determine which prices to apply this minimum to.
|
|
1683
1747
|
*/
|
|
1684
|
-
filters: Array<
|
|
1748
|
+
filters: Array<Minimum.Filter>;
|
|
1685
1749
|
/**
|
|
1686
1750
|
* Minimum amount applied
|
|
1687
1751
|
*/
|
|
1688
1752
|
minimum_amount: string;
|
|
1689
1753
|
}
|
|
1754
|
+
export declare namespace Minimum {
|
|
1755
|
+
interface Filter {
|
|
1756
|
+
/**
|
|
1757
|
+
* The property of the price to filter on.
|
|
1758
|
+
*/
|
|
1759
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
1760
|
+
/**
|
|
1761
|
+
* Should prices that match the filter be included or excluded.
|
|
1762
|
+
*/
|
|
1763
|
+
operator: 'includes' | 'excludes';
|
|
1764
|
+
/**
|
|
1765
|
+
* The IDs or values that match this filter.
|
|
1766
|
+
*/
|
|
1767
|
+
values: Array<string>;
|
|
1768
|
+
}
|
|
1769
|
+
}
|
|
1690
1770
|
export interface MinimumInterval {
|
|
1691
1771
|
/**
|
|
1692
1772
|
* The price interval ids that this minimum interval applies to.
|
|
@@ -1699,7 +1779,7 @@ export interface MinimumInterval {
|
|
|
1699
1779
|
/**
|
|
1700
1780
|
* The filters that determine which prices this minimum interval applies to.
|
|
1701
1781
|
*/
|
|
1702
|
-
filters: Array<
|
|
1782
|
+
filters: Array<MinimumInterval.Filter>;
|
|
1703
1783
|
/**
|
|
1704
1784
|
* The minimum amount to charge in a given billing period for the price intervals
|
|
1705
1785
|
* this minimum applies to.
|
|
@@ -1710,6 +1790,22 @@ export interface MinimumInterval {
|
|
|
1710
1790
|
*/
|
|
1711
1791
|
start_date: string;
|
|
1712
1792
|
}
|
|
1793
|
+
export declare namespace MinimumInterval {
|
|
1794
|
+
interface Filter {
|
|
1795
|
+
/**
|
|
1796
|
+
* The property of the price to filter on.
|
|
1797
|
+
*/
|
|
1798
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
1799
|
+
/**
|
|
1800
|
+
* Should prices that match the filter be included or excluded.
|
|
1801
|
+
*/
|
|
1802
|
+
operator: 'includes' | 'excludes';
|
|
1803
|
+
/**
|
|
1804
|
+
* The IDs or values that match this filter.
|
|
1805
|
+
*/
|
|
1806
|
+
values: Array<string>;
|
|
1807
|
+
}
|
|
1808
|
+
}
|
|
1713
1809
|
export interface MonetaryAmountDiscountAdjustment {
|
|
1714
1810
|
id: string;
|
|
1715
1811
|
adjustment_type: 'amount_discount';
|
|
@@ -1729,7 +1825,7 @@ export interface MonetaryAmountDiscountAdjustment {
|
|
|
1729
1825
|
/**
|
|
1730
1826
|
* The filters that determine which prices to apply this adjustment to.
|
|
1731
1827
|
*/
|
|
1732
|
-
filters: Array<
|
|
1828
|
+
filters: Array<MonetaryAmountDiscountAdjustment.Filter>;
|
|
1733
1829
|
/**
|
|
1734
1830
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1735
1831
|
* apply to only one price.
|
|
@@ -1745,6 +1841,22 @@ export interface MonetaryAmountDiscountAdjustment {
|
|
|
1745
1841
|
*/
|
|
1746
1842
|
replaces_adjustment_id: string | null;
|
|
1747
1843
|
}
|
|
1844
|
+
export declare namespace MonetaryAmountDiscountAdjustment {
|
|
1845
|
+
interface Filter {
|
|
1846
|
+
/**
|
|
1847
|
+
* The property of the price to filter on.
|
|
1848
|
+
*/
|
|
1849
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
1850
|
+
/**
|
|
1851
|
+
* Should prices that match the filter be included or excluded.
|
|
1852
|
+
*/
|
|
1853
|
+
operator: 'includes' | 'excludes';
|
|
1854
|
+
/**
|
|
1855
|
+
* The IDs or values that match this filter.
|
|
1856
|
+
*/
|
|
1857
|
+
values: Array<string>;
|
|
1858
|
+
}
|
|
1859
|
+
}
|
|
1748
1860
|
export interface MonetaryMaximumAdjustment {
|
|
1749
1861
|
id: string;
|
|
1750
1862
|
adjustment_type: 'maximum';
|
|
@@ -1759,7 +1871,7 @@ export interface MonetaryMaximumAdjustment {
|
|
|
1759
1871
|
/**
|
|
1760
1872
|
* The filters that determine which prices to apply this adjustment to.
|
|
1761
1873
|
*/
|
|
1762
|
-
filters: Array<
|
|
1874
|
+
filters: Array<MonetaryMaximumAdjustment.Filter>;
|
|
1763
1875
|
/**
|
|
1764
1876
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1765
1877
|
* apply to only one price.
|
|
@@ -1780,6 +1892,22 @@ export interface MonetaryMaximumAdjustment {
|
|
|
1780
1892
|
*/
|
|
1781
1893
|
replaces_adjustment_id: string | null;
|
|
1782
1894
|
}
|
|
1895
|
+
export declare namespace MonetaryMaximumAdjustment {
|
|
1896
|
+
interface Filter {
|
|
1897
|
+
/**
|
|
1898
|
+
* The property of the price to filter on.
|
|
1899
|
+
*/
|
|
1900
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
1901
|
+
/**
|
|
1902
|
+
* Should prices that match the filter be included or excluded.
|
|
1903
|
+
*/
|
|
1904
|
+
operator: 'includes' | 'excludes';
|
|
1905
|
+
/**
|
|
1906
|
+
* The IDs or values that match this filter.
|
|
1907
|
+
*/
|
|
1908
|
+
values: Array<string>;
|
|
1909
|
+
}
|
|
1910
|
+
}
|
|
1783
1911
|
export interface MonetaryMinimumAdjustment {
|
|
1784
1912
|
id: string;
|
|
1785
1913
|
adjustment_type: 'minimum';
|
|
@@ -1794,7 +1922,7 @@ export interface MonetaryMinimumAdjustment {
|
|
|
1794
1922
|
/**
|
|
1795
1923
|
* The filters that determine which prices to apply this adjustment to.
|
|
1796
1924
|
*/
|
|
1797
|
-
filters: Array<
|
|
1925
|
+
filters: Array<MonetaryMinimumAdjustment.Filter>;
|
|
1798
1926
|
/**
|
|
1799
1927
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1800
1928
|
* apply to only one price.
|
|
@@ -1819,6 +1947,22 @@ export interface MonetaryMinimumAdjustment {
|
|
|
1819
1947
|
*/
|
|
1820
1948
|
replaces_adjustment_id: string | null;
|
|
1821
1949
|
}
|
|
1950
|
+
export declare namespace MonetaryMinimumAdjustment {
|
|
1951
|
+
interface Filter {
|
|
1952
|
+
/**
|
|
1953
|
+
* The property of the price to filter on.
|
|
1954
|
+
*/
|
|
1955
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
1956
|
+
/**
|
|
1957
|
+
* Should prices that match the filter be included or excluded.
|
|
1958
|
+
*/
|
|
1959
|
+
operator: 'includes' | 'excludes';
|
|
1960
|
+
/**
|
|
1961
|
+
* The IDs or values that match this filter.
|
|
1962
|
+
*/
|
|
1963
|
+
values: Array<string>;
|
|
1964
|
+
}
|
|
1965
|
+
}
|
|
1822
1966
|
export interface MonetaryPercentageDiscountAdjustment {
|
|
1823
1967
|
id: string;
|
|
1824
1968
|
adjustment_type: 'percentage_discount';
|
|
@@ -1833,7 +1977,7 @@ export interface MonetaryPercentageDiscountAdjustment {
|
|
|
1833
1977
|
/**
|
|
1834
1978
|
* The filters that determine which prices to apply this adjustment to.
|
|
1835
1979
|
*/
|
|
1836
|
-
filters: Array<
|
|
1980
|
+
filters: Array<MonetaryPercentageDiscountAdjustment.Filter>;
|
|
1837
1981
|
/**
|
|
1838
1982
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1839
1983
|
* apply to only one price.
|
|
@@ -1854,6 +1998,22 @@ export interface MonetaryPercentageDiscountAdjustment {
|
|
|
1854
1998
|
*/
|
|
1855
1999
|
replaces_adjustment_id: string | null;
|
|
1856
2000
|
}
|
|
2001
|
+
export declare namespace MonetaryPercentageDiscountAdjustment {
|
|
2002
|
+
interface Filter {
|
|
2003
|
+
/**
|
|
2004
|
+
* The property of the price to filter on.
|
|
2005
|
+
*/
|
|
2006
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
2007
|
+
/**
|
|
2008
|
+
* Should prices that match the filter be included or excluded.
|
|
2009
|
+
*/
|
|
2010
|
+
operator: 'includes' | 'excludes';
|
|
2011
|
+
/**
|
|
2012
|
+
* The IDs or values that match this filter.
|
|
2013
|
+
*/
|
|
2014
|
+
values: Array<string>;
|
|
2015
|
+
}
|
|
2016
|
+
}
|
|
1857
2017
|
export interface MonetaryUsageDiscountAdjustment {
|
|
1858
2018
|
id: string;
|
|
1859
2019
|
adjustment_type: 'usage_discount';
|
|
@@ -1868,7 +2028,7 @@ export interface MonetaryUsageDiscountAdjustment {
|
|
|
1868
2028
|
/**
|
|
1869
2029
|
* The filters that determine which prices to apply this adjustment to.
|
|
1870
2030
|
*/
|
|
1871
|
-
filters: Array<
|
|
2031
|
+
filters: Array<MonetaryUsageDiscountAdjustment.Filter>;
|
|
1872
2032
|
/**
|
|
1873
2033
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1874
2034
|
* apply to only one price.
|
|
@@ -1889,6 +2049,22 @@ export interface MonetaryUsageDiscountAdjustment {
|
|
|
1889
2049
|
*/
|
|
1890
2050
|
usage_discount: number;
|
|
1891
2051
|
}
|
|
2052
|
+
export declare namespace MonetaryUsageDiscountAdjustment {
|
|
2053
|
+
interface Filter {
|
|
2054
|
+
/**
|
|
2055
|
+
* The property of the price to filter on.
|
|
2056
|
+
*/
|
|
2057
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
2058
|
+
/**
|
|
2059
|
+
* Should prices that match the filter be included or excluded.
|
|
2060
|
+
*/
|
|
2061
|
+
operator: 'includes' | 'excludes';
|
|
2062
|
+
/**
|
|
2063
|
+
* The IDs or values that match this filter.
|
|
2064
|
+
*/
|
|
2065
|
+
values: Array<string>;
|
|
2066
|
+
}
|
|
2067
|
+
}
|
|
1892
2068
|
export interface NewAllocationPrice {
|
|
1893
2069
|
/**
|
|
1894
2070
|
* An amount of the currency to allocate to the customer at the specified cadence.
|
|
@@ -1935,7 +2111,7 @@ export interface NewAmountDiscount {
|
|
|
1935
2111
|
/**
|
|
1936
2112
|
* A list of filters that determine which prices this adjustment will apply to.
|
|
1937
2113
|
*/
|
|
1938
|
-
filters?: Array<
|
|
2114
|
+
filters?: Array<NewAmountDiscount.Filter> | null;
|
|
1939
2115
|
/**
|
|
1940
2116
|
* When false, this adjustment will be applied to a single price. Otherwise, it
|
|
1941
2117
|
* will be applied at the invoice level, possibly to multiple prices.
|
|
@@ -1946,6 +2122,22 @@ export interface NewAmountDiscount {
|
|
|
1946
2122
|
*/
|
|
1947
2123
|
price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
|
|
1948
2124
|
}
|
|
2125
|
+
export declare namespace NewAmountDiscount {
|
|
2126
|
+
interface Filter {
|
|
2127
|
+
/**
|
|
2128
|
+
* The property of the price to filter on.
|
|
2129
|
+
*/
|
|
2130
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
2131
|
+
/**
|
|
2132
|
+
* Should prices that match the filter be included or excluded.
|
|
2133
|
+
*/
|
|
2134
|
+
operator: 'includes' | 'excludes';
|
|
2135
|
+
/**
|
|
2136
|
+
* The IDs or values that match this filter.
|
|
2137
|
+
*/
|
|
2138
|
+
values: Array<string>;
|
|
2139
|
+
}
|
|
2140
|
+
}
|
|
1949
2141
|
export interface NewBillingCycleConfiguration {
|
|
1950
2142
|
/**
|
|
1951
2143
|
* The duration of the billing period.
|
|
@@ -4666,7 +4858,7 @@ export interface NewMaximum {
|
|
|
4666
4858
|
/**
|
|
4667
4859
|
* A list of filters that determine which prices this adjustment will apply to.
|
|
4668
4860
|
*/
|
|
4669
|
-
filters?: Array<
|
|
4861
|
+
filters?: Array<NewMaximum.Filter> | null;
|
|
4670
4862
|
/**
|
|
4671
4863
|
* When false, this adjustment will be applied to a single price. Otherwise, it
|
|
4672
4864
|
* will be applied at the invoice level, possibly to multiple prices.
|
|
@@ -4677,6 +4869,22 @@ export interface NewMaximum {
|
|
|
4677
4869
|
*/
|
|
4678
4870
|
price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
|
|
4679
4871
|
}
|
|
4872
|
+
export declare namespace NewMaximum {
|
|
4873
|
+
interface Filter {
|
|
4874
|
+
/**
|
|
4875
|
+
* The property of the price to filter on.
|
|
4876
|
+
*/
|
|
4877
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
4878
|
+
/**
|
|
4879
|
+
* Should prices that match the filter be included or excluded.
|
|
4880
|
+
*/
|
|
4881
|
+
operator: 'includes' | 'excludes';
|
|
4882
|
+
/**
|
|
4883
|
+
* The IDs or values that match this filter.
|
|
4884
|
+
*/
|
|
4885
|
+
values: Array<string>;
|
|
4886
|
+
}
|
|
4887
|
+
}
|
|
4680
4888
|
export interface NewMinimum {
|
|
4681
4889
|
adjustment_type: 'minimum';
|
|
4682
4890
|
/**
|
|
@@ -4703,7 +4911,7 @@ export interface NewMinimum {
|
|
|
4703
4911
|
/**
|
|
4704
4912
|
* A list of filters that determine which prices this adjustment will apply to.
|
|
4705
4913
|
*/
|
|
4706
|
-
filters?: Array<
|
|
4914
|
+
filters?: Array<NewMinimum.Filter> | null;
|
|
4707
4915
|
/**
|
|
4708
4916
|
* When false, this adjustment will be applied to a single price. Otherwise, it
|
|
4709
4917
|
* will be applied at the invoice level, possibly to multiple prices.
|
|
@@ -4714,6 +4922,22 @@ export interface NewMinimum {
|
|
|
4714
4922
|
*/
|
|
4715
4923
|
price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
|
|
4716
4924
|
}
|
|
4925
|
+
export declare namespace NewMinimum {
|
|
4926
|
+
interface Filter {
|
|
4927
|
+
/**
|
|
4928
|
+
* The property of the price to filter on.
|
|
4929
|
+
*/
|
|
4930
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
4931
|
+
/**
|
|
4932
|
+
* Should prices that match the filter be included or excluded.
|
|
4933
|
+
*/
|
|
4934
|
+
operator: 'includes' | 'excludes';
|
|
4935
|
+
/**
|
|
4936
|
+
* The IDs or values that match this filter.
|
|
4937
|
+
*/
|
|
4938
|
+
values: Array<string>;
|
|
4939
|
+
}
|
|
4940
|
+
}
|
|
4717
4941
|
export interface NewPercentageDiscount {
|
|
4718
4942
|
adjustment_type: 'percentage_discount';
|
|
4719
4943
|
percentage_discount: number;
|
|
@@ -4736,7 +4960,7 @@ export interface NewPercentageDiscount {
|
|
|
4736
4960
|
/**
|
|
4737
4961
|
* A list of filters that determine which prices this adjustment will apply to.
|
|
4738
4962
|
*/
|
|
4739
|
-
filters?: Array<
|
|
4963
|
+
filters?: Array<NewPercentageDiscount.Filter> | null;
|
|
4740
4964
|
/**
|
|
4741
4965
|
* When false, this adjustment will be applied to a single price. Otherwise, it
|
|
4742
4966
|
* will be applied at the invoice level, possibly to multiple prices.
|
|
@@ -4747,6 +4971,22 @@ export interface NewPercentageDiscount {
|
|
|
4747
4971
|
*/
|
|
4748
4972
|
price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
|
|
4749
4973
|
}
|
|
4974
|
+
export declare namespace NewPercentageDiscount {
|
|
4975
|
+
interface Filter {
|
|
4976
|
+
/**
|
|
4977
|
+
* The property of the price to filter on.
|
|
4978
|
+
*/
|
|
4979
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
4980
|
+
/**
|
|
4981
|
+
* Should prices that match the filter be included or excluded.
|
|
4982
|
+
*/
|
|
4983
|
+
operator: 'includes' | 'excludes';
|
|
4984
|
+
/**
|
|
4985
|
+
* The IDs or values that match this filter.
|
|
4986
|
+
*/
|
|
4987
|
+
values: Array<string>;
|
|
4988
|
+
}
|
|
4989
|
+
}
|
|
4750
4990
|
export interface NewPlanBulkPrice {
|
|
4751
4991
|
/**
|
|
4752
4992
|
* Configuration for bulk pricing
|
|
@@ -7486,7 +7726,7 @@ export interface NewUsageDiscount {
|
|
|
7486
7726
|
/**
|
|
7487
7727
|
* A list of filters that determine which prices this adjustment will apply to.
|
|
7488
7728
|
*/
|
|
7489
|
-
filters?: Array<
|
|
7729
|
+
filters?: Array<NewUsageDiscount.Filter> | null;
|
|
7490
7730
|
/**
|
|
7491
7731
|
* When false, this adjustment will be applied to a single price. Otherwise, it
|
|
7492
7732
|
* will be applied at the invoice level, possibly to multiple prices.
|
|
@@ -7497,6 +7737,22 @@ export interface NewUsageDiscount {
|
|
|
7497
7737
|
*/
|
|
7498
7738
|
price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
|
|
7499
7739
|
}
|
|
7740
|
+
export declare namespace NewUsageDiscount {
|
|
7741
|
+
interface Filter {
|
|
7742
|
+
/**
|
|
7743
|
+
* The property of the price to filter on.
|
|
7744
|
+
*/
|
|
7745
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
7746
|
+
/**
|
|
7747
|
+
* Should prices that match the filter be included or excluded.
|
|
7748
|
+
*/
|
|
7749
|
+
operator: 'includes' | 'excludes';
|
|
7750
|
+
/**
|
|
7751
|
+
* The IDs or values that match this filter.
|
|
7752
|
+
*/
|
|
7753
|
+
values: Array<string>;
|
|
7754
|
+
}
|
|
7755
|
+
}
|
|
7500
7756
|
export interface OtherSubLineItem {
|
|
7501
7757
|
/**
|
|
7502
7758
|
* The total amount for this sub line item.
|
|
@@ -7562,9 +7818,25 @@ export interface PercentageDiscount {
|
|
|
7562
7818
|
/**
|
|
7563
7819
|
* The filters that determine which prices to apply this discount to.
|
|
7564
7820
|
*/
|
|
7565
|
-
filters?: Array<
|
|
7821
|
+
filters?: Array<PercentageDiscount.Filter> | null;
|
|
7566
7822
|
reason?: string | null;
|
|
7567
7823
|
}
|
|
7824
|
+
export declare namespace PercentageDiscount {
|
|
7825
|
+
interface Filter {
|
|
7826
|
+
/**
|
|
7827
|
+
* The property of the price to filter on.
|
|
7828
|
+
*/
|
|
7829
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
7830
|
+
/**
|
|
7831
|
+
* Should prices that match the filter be included or excluded.
|
|
7832
|
+
*/
|
|
7833
|
+
operator: 'includes' | 'excludes';
|
|
7834
|
+
/**
|
|
7835
|
+
* The IDs or values that match this filter.
|
|
7836
|
+
*/
|
|
7837
|
+
values: Array<string>;
|
|
7838
|
+
}
|
|
7839
|
+
}
|
|
7568
7840
|
export interface PercentageDiscountInterval {
|
|
7569
7841
|
/**
|
|
7570
7842
|
* The price interval ids that this discount interval applies to.
|
|
@@ -7578,7 +7850,7 @@ export interface PercentageDiscountInterval {
|
|
|
7578
7850
|
/**
|
|
7579
7851
|
* The filters that determine which prices this discount interval applies to.
|
|
7580
7852
|
*/
|
|
7581
|
-
filters: Array<
|
|
7853
|
+
filters: Array<PercentageDiscountInterval.Filter>;
|
|
7582
7854
|
/**
|
|
7583
7855
|
* Only available if discount_type is `percentage`.This is a number between 0
|
|
7584
7856
|
* and 1.
|
|
@@ -7589,6 +7861,22 @@ export interface PercentageDiscountInterval {
|
|
|
7589
7861
|
*/
|
|
7590
7862
|
start_date: string;
|
|
7591
7863
|
}
|
|
7864
|
+
export declare namespace PercentageDiscountInterval {
|
|
7865
|
+
interface Filter {
|
|
7866
|
+
/**
|
|
7867
|
+
* The property of the price to filter on.
|
|
7868
|
+
*/
|
|
7869
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
7870
|
+
/**
|
|
7871
|
+
* Should prices that match the filter be included or excluded.
|
|
7872
|
+
*/
|
|
7873
|
+
operator: 'includes' | 'excludes';
|
|
7874
|
+
/**
|
|
7875
|
+
* The IDs or values that match this filter.
|
|
7876
|
+
*/
|
|
7877
|
+
values: Array<string>;
|
|
7878
|
+
}
|
|
7879
|
+
}
|
|
7592
7880
|
export interface PlanPhaseAmountDiscountAdjustment {
|
|
7593
7881
|
id: string;
|
|
7594
7882
|
adjustment_type: 'amount_discount';
|
|
@@ -7604,7 +7892,7 @@ export interface PlanPhaseAmountDiscountAdjustment {
|
|
|
7604
7892
|
/**
|
|
7605
7893
|
* The filters that determine which prices to apply this adjustment to.
|
|
7606
7894
|
*/
|
|
7607
|
-
filters: Array<
|
|
7895
|
+
filters: Array<PlanPhaseAmountDiscountAdjustment.Filter>;
|
|
7608
7896
|
/**
|
|
7609
7897
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7610
7898
|
* apply to only one price.
|
|
@@ -7624,6 +7912,22 @@ export interface PlanPhaseAmountDiscountAdjustment {
|
|
|
7624
7912
|
*/
|
|
7625
7913
|
replaces_adjustment_id: string | null;
|
|
7626
7914
|
}
|
|
7915
|
+
export declare namespace PlanPhaseAmountDiscountAdjustment {
|
|
7916
|
+
interface Filter {
|
|
7917
|
+
/**
|
|
7918
|
+
* The property of the price to filter on.
|
|
7919
|
+
*/
|
|
7920
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
7921
|
+
/**
|
|
7922
|
+
* Should prices that match the filter be included or excluded.
|
|
7923
|
+
*/
|
|
7924
|
+
operator: 'includes' | 'excludes';
|
|
7925
|
+
/**
|
|
7926
|
+
* The IDs or values that match this filter.
|
|
7927
|
+
*/
|
|
7928
|
+
values: Array<string>;
|
|
7929
|
+
}
|
|
7930
|
+
}
|
|
7627
7931
|
export interface PlanPhaseMaximumAdjustment {
|
|
7628
7932
|
id: string;
|
|
7629
7933
|
adjustment_type: 'maximum';
|
|
@@ -7634,7 +7938,7 @@ export interface PlanPhaseMaximumAdjustment {
|
|
|
7634
7938
|
/**
|
|
7635
7939
|
* The filters that determine which prices to apply this adjustment to.
|
|
7636
7940
|
*/
|
|
7637
|
-
filters: Array<
|
|
7941
|
+
filters: Array<PlanPhaseMaximumAdjustment.Filter>;
|
|
7638
7942
|
/**
|
|
7639
7943
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7640
7944
|
* apply to only one price.
|
|
@@ -7659,6 +7963,22 @@ export interface PlanPhaseMaximumAdjustment {
|
|
|
7659
7963
|
*/
|
|
7660
7964
|
replaces_adjustment_id: string | null;
|
|
7661
7965
|
}
|
|
7966
|
+
export declare namespace PlanPhaseMaximumAdjustment {
|
|
7967
|
+
interface Filter {
|
|
7968
|
+
/**
|
|
7969
|
+
* The property of the price to filter on.
|
|
7970
|
+
*/
|
|
7971
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
7972
|
+
/**
|
|
7973
|
+
* Should prices that match the filter be included or excluded.
|
|
7974
|
+
*/
|
|
7975
|
+
operator: 'includes' | 'excludes';
|
|
7976
|
+
/**
|
|
7977
|
+
* The IDs or values that match this filter.
|
|
7978
|
+
*/
|
|
7979
|
+
values: Array<string>;
|
|
7980
|
+
}
|
|
7981
|
+
}
|
|
7662
7982
|
export interface PlanPhaseMinimumAdjustment {
|
|
7663
7983
|
id: string;
|
|
7664
7984
|
adjustment_type: 'minimum';
|
|
@@ -7669,7 +7989,7 @@ export interface PlanPhaseMinimumAdjustment {
|
|
|
7669
7989
|
/**
|
|
7670
7990
|
* The filters that determine which prices to apply this adjustment to.
|
|
7671
7991
|
*/
|
|
7672
|
-
filters: Array<
|
|
7992
|
+
filters: Array<PlanPhaseMinimumAdjustment.Filter>;
|
|
7673
7993
|
/**
|
|
7674
7994
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7675
7995
|
* apply to only one price.
|
|
@@ -7698,6 +8018,22 @@ export interface PlanPhaseMinimumAdjustment {
|
|
|
7698
8018
|
*/
|
|
7699
8019
|
replaces_adjustment_id: string | null;
|
|
7700
8020
|
}
|
|
8021
|
+
export declare namespace PlanPhaseMinimumAdjustment {
|
|
8022
|
+
interface Filter {
|
|
8023
|
+
/**
|
|
8024
|
+
* The property of the price to filter on.
|
|
8025
|
+
*/
|
|
8026
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8027
|
+
/**
|
|
8028
|
+
* Should prices that match the filter be included or excluded.
|
|
8029
|
+
*/
|
|
8030
|
+
operator: 'includes' | 'excludes';
|
|
8031
|
+
/**
|
|
8032
|
+
* The IDs or values that match this filter.
|
|
8033
|
+
*/
|
|
8034
|
+
values: Array<string>;
|
|
8035
|
+
}
|
|
8036
|
+
}
|
|
7701
8037
|
export interface PlanPhasePercentageDiscountAdjustment {
|
|
7702
8038
|
id: string;
|
|
7703
8039
|
adjustment_type: 'percentage_discount';
|
|
@@ -7708,7 +8044,7 @@ export interface PlanPhasePercentageDiscountAdjustment {
|
|
|
7708
8044
|
/**
|
|
7709
8045
|
* The filters that determine which prices to apply this adjustment to.
|
|
7710
8046
|
*/
|
|
7711
|
-
filters: Array<
|
|
8047
|
+
filters: Array<PlanPhasePercentageDiscountAdjustment.Filter>;
|
|
7712
8048
|
/**
|
|
7713
8049
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7714
8050
|
* apply to only one price.
|
|
@@ -7733,6 +8069,22 @@ export interface PlanPhasePercentageDiscountAdjustment {
|
|
|
7733
8069
|
*/
|
|
7734
8070
|
replaces_adjustment_id: string | null;
|
|
7735
8071
|
}
|
|
8072
|
+
export declare namespace PlanPhasePercentageDiscountAdjustment {
|
|
8073
|
+
interface Filter {
|
|
8074
|
+
/**
|
|
8075
|
+
* The property of the price to filter on.
|
|
8076
|
+
*/
|
|
8077
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8078
|
+
/**
|
|
8079
|
+
* Should prices that match the filter be included or excluded.
|
|
8080
|
+
*/
|
|
8081
|
+
operator: 'includes' | 'excludes';
|
|
8082
|
+
/**
|
|
8083
|
+
* The IDs or values that match this filter.
|
|
8084
|
+
*/
|
|
8085
|
+
values: Array<string>;
|
|
8086
|
+
}
|
|
8087
|
+
}
|
|
7736
8088
|
export interface PlanPhaseUsageDiscountAdjustment {
|
|
7737
8089
|
id: string;
|
|
7738
8090
|
adjustment_type: 'usage_discount';
|
|
@@ -7743,7 +8095,7 @@ export interface PlanPhaseUsageDiscountAdjustment {
|
|
|
7743
8095
|
/**
|
|
7744
8096
|
* The filters that determine which prices to apply this adjustment to.
|
|
7745
8097
|
*/
|
|
7746
|
-
filters: Array<
|
|
8098
|
+
filters: Array<PlanPhaseUsageDiscountAdjustment.Filter>;
|
|
7747
8099
|
/**
|
|
7748
8100
|
* True for adjustments that apply to an entire invoice, false for adjustments that
|
|
7749
8101
|
* apply to only one price.
|
|
@@ -7768,6 +8120,22 @@ export interface PlanPhaseUsageDiscountAdjustment {
|
|
|
7768
8120
|
*/
|
|
7769
8121
|
usage_discount: number;
|
|
7770
8122
|
}
|
|
8123
|
+
export declare namespace PlanPhaseUsageDiscountAdjustment {
|
|
8124
|
+
interface Filter {
|
|
8125
|
+
/**
|
|
8126
|
+
* The property of the price to filter on.
|
|
8127
|
+
*/
|
|
8128
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8129
|
+
/**
|
|
8130
|
+
* Should prices that match the filter be included or excluded.
|
|
8131
|
+
*/
|
|
8132
|
+
operator: 'includes' | 'excludes';
|
|
8133
|
+
/**
|
|
8134
|
+
* The IDs or values that match this filter.
|
|
8135
|
+
*/
|
|
8136
|
+
values: Array<string>;
|
|
8137
|
+
}
|
|
8138
|
+
}
|
|
7771
8139
|
/**
|
|
7772
8140
|
* The Price resource represents a price that can be billed on a subscription,
|
|
7773
8141
|
* resulting in a charge on an invoice in the form of an invoice line item. Prices
|
|
@@ -7788,7 +8156,7 @@ export declare namespace Price {
|
|
|
7788
8156
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7789
8157
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
7790
8158
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7791
|
-
composite_price_filters: Array<
|
|
8159
|
+
composite_price_filters: Array<UnitPrice.CompositePriceFilter> | null;
|
|
7792
8160
|
conversion_rate: number | null;
|
|
7793
8161
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7794
8162
|
created_at: string;
|
|
@@ -7849,13 +8217,29 @@ export declare namespace Price {
|
|
|
7849
8217
|
unit_config: Shared.UnitConfig;
|
|
7850
8218
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
7851
8219
|
}
|
|
8220
|
+
namespace UnitPrice {
|
|
8221
|
+
interface CompositePriceFilter {
|
|
8222
|
+
/**
|
|
8223
|
+
* The property of the price to filter on.
|
|
8224
|
+
*/
|
|
8225
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8226
|
+
/**
|
|
8227
|
+
* Should prices that match the filter be included or excluded.
|
|
8228
|
+
*/
|
|
8229
|
+
operator: 'includes' | 'excludes';
|
|
8230
|
+
/**
|
|
8231
|
+
* The IDs or values that match this filter.
|
|
8232
|
+
*/
|
|
8233
|
+
values: Array<string>;
|
|
8234
|
+
}
|
|
8235
|
+
}
|
|
7852
8236
|
interface TieredPrice {
|
|
7853
8237
|
id: string;
|
|
7854
8238
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
7855
8239
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
7856
8240
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
7857
8241
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7858
|
-
composite_price_filters: Array<
|
|
8242
|
+
composite_price_filters: Array<TieredPrice.CompositePriceFilter> | null;
|
|
7859
8243
|
conversion_rate: number | null;
|
|
7860
8244
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7861
8245
|
created_at: string;
|
|
@@ -7916,6 +8300,22 @@ export declare namespace Price {
|
|
|
7916
8300
|
tiered_config: Shared.TieredConfig;
|
|
7917
8301
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
7918
8302
|
}
|
|
8303
|
+
namespace TieredPrice {
|
|
8304
|
+
interface CompositePriceFilter {
|
|
8305
|
+
/**
|
|
8306
|
+
* The property of the price to filter on.
|
|
8307
|
+
*/
|
|
8308
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8309
|
+
/**
|
|
8310
|
+
* Should prices that match the filter be included or excluded.
|
|
8311
|
+
*/
|
|
8312
|
+
operator: 'includes' | 'excludes';
|
|
8313
|
+
/**
|
|
8314
|
+
* The IDs or values that match this filter.
|
|
8315
|
+
*/
|
|
8316
|
+
values: Array<string>;
|
|
8317
|
+
}
|
|
8318
|
+
}
|
|
7919
8319
|
interface BulkPrice {
|
|
7920
8320
|
id: string;
|
|
7921
8321
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -7926,7 +8326,7 @@ export declare namespace Price {
|
|
|
7926
8326
|
*/
|
|
7927
8327
|
bulk_config: Shared.BulkConfig;
|
|
7928
8328
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7929
|
-
composite_price_filters: Array<
|
|
8329
|
+
composite_price_filters: Array<BulkPrice.CompositePriceFilter> | null;
|
|
7930
8330
|
conversion_rate: number | null;
|
|
7931
8331
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7932
8332
|
created_at: string;
|
|
@@ -7983,6 +8383,22 @@ export declare namespace Price {
|
|
|
7983
8383
|
replaces_price_id: string | null;
|
|
7984
8384
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
7985
8385
|
}
|
|
8386
|
+
namespace BulkPrice {
|
|
8387
|
+
interface CompositePriceFilter {
|
|
8388
|
+
/**
|
|
8389
|
+
* The property of the price to filter on.
|
|
8390
|
+
*/
|
|
8391
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8392
|
+
/**
|
|
8393
|
+
* Should prices that match the filter be included or excluded.
|
|
8394
|
+
*/
|
|
8395
|
+
operator: 'includes' | 'excludes';
|
|
8396
|
+
/**
|
|
8397
|
+
* The IDs or values that match this filter.
|
|
8398
|
+
*/
|
|
8399
|
+
values: Array<string>;
|
|
8400
|
+
}
|
|
8401
|
+
}
|
|
7986
8402
|
interface BulkWithFiltersPrice {
|
|
7987
8403
|
id: string;
|
|
7988
8404
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
@@ -7993,7 +8409,7 @@ export declare namespace Price {
|
|
|
7993
8409
|
*/
|
|
7994
8410
|
bulk_with_filters_config: BulkWithFiltersPrice.BulkWithFiltersConfig;
|
|
7995
8411
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
7996
|
-
composite_price_filters: Array<
|
|
8412
|
+
composite_price_filters: Array<BulkWithFiltersPrice.CompositePriceFilter> | null;
|
|
7997
8413
|
conversion_rate: number | null;
|
|
7998
8414
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
7999
8415
|
created_at: string;
|
|
@@ -8092,6 +8508,20 @@ export declare namespace Price {
|
|
|
8092
8508
|
tier_lower_bound?: string | null;
|
|
8093
8509
|
}
|
|
8094
8510
|
}
|
|
8511
|
+
interface CompositePriceFilter {
|
|
8512
|
+
/**
|
|
8513
|
+
* The property of the price to filter on.
|
|
8514
|
+
*/
|
|
8515
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8516
|
+
/**
|
|
8517
|
+
* Should prices that match the filter be included or excluded.
|
|
8518
|
+
*/
|
|
8519
|
+
operator: 'includes' | 'excludes';
|
|
8520
|
+
/**
|
|
8521
|
+
* The IDs or values that match this filter.
|
|
8522
|
+
*/
|
|
8523
|
+
values: Array<string>;
|
|
8524
|
+
}
|
|
8095
8525
|
}
|
|
8096
8526
|
interface PackagePrice {
|
|
8097
8527
|
id: string;
|
|
@@ -8099,7 +8529,7 @@ export declare namespace Price {
|
|
|
8099
8529
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8100
8530
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8101
8531
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8102
|
-
composite_price_filters: Array<
|
|
8532
|
+
composite_price_filters: Array<PackagePrice.CompositePriceFilter> | null;
|
|
8103
8533
|
conversion_rate: number | null;
|
|
8104
8534
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8105
8535
|
created_at: string;
|
|
@@ -8160,13 +8590,29 @@ export declare namespace Price {
|
|
|
8160
8590
|
replaces_price_id: string | null;
|
|
8161
8591
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8162
8592
|
}
|
|
8593
|
+
namespace PackagePrice {
|
|
8594
|
+
interface CompositePriceFilter {
|
|
8595
|
+
/**
|
|
8596
|
+
* The property of the price to filter on.
|
|
8597
|
+
*/
|
|
8598
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8599
|
+
/**
|
|
8600
|
+
* Should prices that match the filter be included or excluded.
|
|
8601
|
+
*/
|
|
8602
|
+
operator: 'includes' | 'excludes';
|
|
8603
|
+
/**
|
|
8604
|
+
* The IDs or values that match this filter.
|
|
8605
|
+
*/
|
|
8606
|
+
values: Array<string>;
|
|
8607
|
+
}
|
|
8608
|
+
}
|
|
8163
8609
|
interface MatrixPrice {
|
|
8164
8610
|
id: string;
|
|
8165
8611
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
8166
8612
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8167
8613
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8168
8614
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8169
|
-
composite_price_filters: Array<
|
|
8615
|
+
composite_price_filters: Array<MatrixPrice.CompositePriceFilter> | null;
|
|
8170
8616
|
conversion_rate: number | null;
|
|
8171
8617
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8172
8618
|
created_at: string;
|
|
@@ -8227,13 +8673,29 @@ export declare namespace Price {
|
|
|
8227
8673
|
replaces_price_id: string | null;
|
|
8228
8674
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8229
8675
|
}
|
|
8676
|
+
namespace MatrixPrice {
|
|
8677
|
+
interface CompositePriceFilter {
|
|
8678
|
+
/**
|
|
8679
|
+
* The property of the price to filter on.
|
|
8680
|
+
*/
|
|
8681
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8682
|
+
/**
|
|
8683
|
+
* Should prices that match the filter be included or excluded.
|
|
8684
|
+
*/
|
|
8685
|
+
operator: 'includes' | 'excludes';
|
|
8686
|
+
/**
|
|
8687
|
+
* The IDs or values that match this filter.
|
|
8688
|
+
*/
|
|
8689
|
+
values: Array<string>;
|
|
8690
|
+
}
|
|
8691
|
+
}
|
|
8230
8692
|
interface ThresholdTotalAmountPrice {
|
|
8231
8693
|
id: string;
|
|
8232
8694
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
8233
8695
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8234
8696
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8235
8697
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8236
|
-
composite_price_filters: Array<
|
|
8698
|
+
composite_price_filters: Array<ThresholdTotalAmountPrice.CompositePriceFilter> | null;
|
|
8237
8699
|
conversion_rate: number | null;
|
|
8238
8700
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8239
8701
|
created_at: string;
|
|
@@ -8295,6 +8757,20 @@ export declare namespace Price {
|
|
|
8295
8757
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8296
8758
|
}
|
|
8297
8759
|
namespace ThresholdTotalAmountPrice {
|
|
8760
|
+
interface CompositePriceFilter {
|
|
8761
|
+
/**
|
|
8762
|
+
* The property of the price to filter on.
|
|
8763
|
+
*/
|
|
8764
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8765
|
+
/**
|
|
8766
|
+
* Should prices that match the filter be included or excluded.
|
|
8767
|
+
*/
|
|
8768
|
+
operator: 'includes' | 'excludes';
|
|
8769
|
+
/**
|
|
8770
|
+
* The IDs or values that match this filter.
|
|
8771
|
+
*/
|
|
8772
|
+
values: Array<string>;
|
|
8773
|
+
}
|
|
8298
8774
|
/**
|
|
8299
8775
|
* Configuration for threshold_total_amount pricing
|
|
8300
8776
|
*/
|
|
@@ -8331,7 +8807,7 @@ export declare namespace Price {
|
|
|
8331
8807
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8332
8808
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8333
8809
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8334
|
-
composite_price_filters: Array<
|
|
8810
|
+
composite_price_filters: Array<TieredPackagePrice.CompositePriceFilter> | null;
|
|
8335
8811
|
conversion_rate: number | null;
|
|
8336
8812
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8337
8813
|
created_at: string;
|
|
@@ -8393,6 +8869,20 @@ export declare namespace Price {
|
|
|
8393
8869
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8394
8870
|
}
|
|
8395
8871
|
namespace TieredPackagePrice {
|
|
8872
|
+
interface CompositePriceFilter {
|
|
8873
|
+
/**
|
|
8874
|
+
* The property of the price to filter on.
|
|
8875
|
+
*/
|
|
8876
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8877
|
+
/**
|
|
8878
|
+
* Should prices that match the filter be included or excluded.
|
|
8879
|
+
*/
|
|
8880
|
+
operator: 'includes' | 'excludes';
|
|
8881
|
+
/**
|
|
8882
|
+
* The IDs or values that match this filter.
|
|
8883
|
+
*/
|
|
8884
|
+
values: Array<string>;
|
|
8885
|
+
}
|
|
8396
8886
|
/**
|
|
8397
8887
|
* Configuration for tiered_package pricing
|
|
8398
8888
|
*/
|
|
@@ -8431,7 +8921,7 @@ export declare namespace Price {
|
|
|
8431
8921
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8432
8922
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8433
8923
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8434
|
-
composite_price_filters: Array<
|
|
8924
|
+
composite_price_filters: Array<TieredWithMinimumPrice.CompositePriceFilter> | null;
|
|
8435
8925
|
conversion_rate: number | null;
|
|
8436
8926
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8437
8927
|
created_at: string;
|
|
@@ -8493,6 +8983,20 @@ export declare namespace Price {
|
|
|
8493
8983
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8494
8984
|
}
|
|
8495
8985
|
namespace TieredWithMinimumPrice {
|
|
8986
|
+
interface CompositePriceFilter {
|
|
8987
|
+
/**
|
|
8988
|
+
* The property of the price to filter on.
|
|
8989
|
+
*/
|
|
8990
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
8991
|
+
/**
|
|
8992
|
+
* Should prices that match the filter be included or excluded.
|
|
8993
|
+
*/
|
|
8994
|
+
operator: 'includes' | 'excludes';
|
|
8995
|
+
/**
|
|
8996
|
+
* The IDs or values that match this filter.
|
|
8997
|
+
*/
|
|
8998
|
+
values: Array<string>;
|
|
8999
|
+
}
|
|
8496
9000
|
/**
|
|
8497
9001
|
* Configuration for tiered_with_minimum pricing
|
|
8498
9002
|
*/
|
|
@@ -8537,7 +9041,7 @@ export declare namespace Price {
|
|
|
8537
9041
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8538
9042
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8539
9043
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8540
|
-
composite_price_filters: Array<
|
|
9044
|
+
composite_price_filters: Array<GroupedTieredPrice.CompositePriceFilter> | null;
|
|
8541
9045
|
conversion_rate: number | null;
|
|
8542
9046
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8543
9047
|
created_at: string;
|
|
@@ -8599,6 +9103,20 @@ export declare namespace Price {
|
|
|
8599
9103
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8600
9104
|
}
|
|
8601
9105
|
namespace GroupedTieredPrice {
|
|
9106
|
+
interface CompositePriceFilter {
|
|
9107
|
+
/**
|
|
9108
|
+
* The property of the price to filter on.
|
|
9109
|
+
*/
|
|
9110
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9111
|
+
/**
|
|
9112
|
+
* Should prices that match the filter be included or excluded.
|
|
9113
|
+
*/
|
|
9114
|
+
operator: 'includes' | 'excludes';
|
|
9115
|
+
/**
|
|
9116
|
+
* The IDs or values that match this filter.
|
|
9117
|
+
*/
|
|
9118
|
+
values: Array<string>;
|
|
9119
|
+
}
|
|
8602
9120
|
/**
|
|
8603
9121
|
* Configuration for grouped_tiered pricing
|
|
8604
9122
|
*/
|
|
@@ -8635,7 +9153,7 @@ export declare namespace Price {
|
|
|
8635
9153
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8636
9154
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8637
9155
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8638
|
-
composite_price_filters: Array<
|
|
9156
|
+
composite_price_filters: Array<TieredPackageWithMinimumPrice.CompositePriceFilter> | null;
|
|
8639
9157
|
conversion_rate: number | null;
|
|
8640
9158
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8641
9159
|
created_at: string;
|
|
@@ -8697,6 +9215,20 @@ export declare namespace Price {
|
|
|
8697
9215
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8698
9216
|
}
|
|
8699
9217
|
namespace TieredPackageWithMinimumPrice {
|
|
9218
|
+
interface CompositePriceFilter {
|
|
9219
|
+
/**
|
|
9220
|
+
* The property of the price to filter on.
|
|
9221
|
+
*/
|
|
9222
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9223
|
+
/**
|
|
9224
|
+
* Should prices that match the filter be included or excluded.
|
|
9225
|
+
*/
|
|
9226
|
+
operator: 'includes' | 'excludes';
|
|
9227
|
+
/**
|
|
9228
|
+
* The IDs or values that match this filter.
|
|
9229
|
+
*/
|
|
9230
|
+
values: Array<string>;
|
|
9231
|
+
}
|
|
8700
9232
|
/**
|
|
8701
9233
|
* Configuration for tiered_package_with_minimum pricing
|
|
8702
9234
|
*/
|
|
@@ -8737,7 +9269,7 @@ export declare namespace Price {
|
|
|
8737
9269
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8738
9270
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8739
9271
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8740
|
-
composite_price_filters: Array<
|
|
9272
|
+
composite_price_filters: Array<PackageWithAllocationPrice.CompositePriceFilter> | null;
|
|
8741
9273
|
conversion_rate: number | null;
|
|
8742
9274
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8743
9275
|
created_at: string;
|
|
@@ -8799,6 +9331,20 @@ export declare namespace Price {
|
|
|
8799
9331
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8800
9332
|
}
|
|
8801
9333
|
namespace PackageWithAllocationPrice {
|
|
9334
|
+
interface CompositePriceFilter {
|
|
9335
|
+
/**
|
|
9336
|
+
* The property of the price to filter on.
|
|
9337
|
+
*/
|
|
9338
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9339
|
+
/**
|
|
9340
|
+
* Should prices that match the filter be included or excluded.
|
|
9341
|
+
*/
|
|
9342
|
+
operator: 'includes' | 'excludes';
|
|
9343
|
+
/**
|
|
9344
|
+
* The IDs or values that match this filter.
|
|
9345
|
+
*/
|
|
9346
|
+
values: Array<string>;
|
|
9347
|
+
}
|
|
8802
9348
|
/**
|
|
8803
9349
|
* Configuration for package_with_allocation pricing
|
|
8804
9350
|
*/
|
|
@@ -8823,7 +9369,7 @@ export declare namespace Price {
|
|
|
8823
9369
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8824
9370
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8825
9371
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8826
|
-
composite_price_filters: Array<
|
|
9372
|
+
composite_price_filters: Array<UnitWithPercentPrice.CompositePriceFilter> | null;
|
|
8827
9373
|
conversion_rate: number | null;
|
|
8828
9374
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8829
9375
|
created_at: string;
|
|
@@ -8885,6 +9431,20 @@ export declare namespace Price {
|
|
|
8885
9431
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8886
9432
|
}
|
|
8887
9433
|
namespace UnitWithPercentPrice {
|
|
9434
|
+
interface CompositePriceFilter {
|
|
9435
|
+
/**
|
|
9436
|
+
* The property of the price to filter on.
|
|
9437
|
+
*/
|
|
9438
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9439
|
+
/**
|
|
9440
|
+
* Should prices that match the filter be included or excluded.
|
|
9441
|
+
*/
|
|
9442
|
+
operator: 'includes' | 'excludes';
|
|
9443
|
+
/**
|
|
9444
|
+
* The IDs or values that match this filter.
|
|
9445
|
+
*/
|
|
9446
|
+
values: Array<string>;
|
|
9447
|
+
}
|
|
8888
9448
|
/**
|
|
8889
9449
|
* Configuration for unit_with_percent pricing
|
|
8890
9450
|
*/
|
|
@@ -8905,7 +9465,7 @@ export declare namespace Price {
|
|
|
8905
9465
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8906
9466
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8907
9467
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8908
|
-
composite_price_filters: Array<
|
|
9468
|
+
composite_price_filters: Array<MatrixWithAllocationPrice.CompositePriceFilter> | null;
|
|
8909
9469
|
conversion_rate: number | null;
|
|
8910
9470
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8911
9471
|
created_at: string;
|
|
@@ -8966,13 +9526,29 @@ export declare namespace Price {
|
|
|
8966
9526
|
replaces_price_id: string | null;
|
|
8967
9527
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
8968
9528
|
}
|
|
9529
|
+
namespace MatrixWithAllocationPrice {
|
|
9530
|
+
interface CompositePriceFilter {
|
|
9531
|
+
/**
|
|
9532
|
+
* The property of the price to filter on.
|
|
9533
|
+
*/
|
|
9534
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9535
|
+
/**
|
|
9536
|
+
* Should prices that match the filter be included or excluded.
|
|
9537
|
+
*/
|
|
9538
|
+
operator: 'includes' | 'excludes';
|
|
9539
|
+
/**
|
|
9540
|
+
* The IDs or values that match this filter.
|
|
9541
|
+
*/
|
|
9542
|
+
values: Array<string>;
|
|
9543
|
+
}
|
|
9544
|
+
}
|
|
8969
9545
|
interface TieredWithProrationPrice {
|
|
8970
9546
|
id: string;
|
|
8971
9547
|
billable_metric: Shared.BillableMetricTiny | null;
|
|
8972
9548
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
8973
9549
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
8974
9550
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
8975
|
-
composite_price_filters: Array<
|
|
9551
|
+
composite_price_filters: Array<TieredWithProrationPrice.CompositePriceFilter> | null;
|
|
8976
9552
|
conversion_rate: number | null;
|
|
8977
9553
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
8978
9554
|
created_at: string;
|
|
@@ -9034,6 +9610,20 @@ export declare namespace Price {
|
|
|
9034
9610
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9035
9611
|
}
|
|
9036
9612
|
namespace TieredWithProrationPrice {
|
|
9613
|
+
interface CompositePriceFilter {
|
|
9614
|
+
/**
|
|
9615
|
+
* The property of the price to filter on.
|
|
9616
|
+
*/
|
|
9617
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9618
|
+
/**
|
|
9619
|
+
* Should prices that match the filter be included or excluded.
|
|
9620
|
+
*/
|
|
9621
|
+
operator: 'includes' | 'excludes';
|
|
9622
|
+
/**
|
|
9623
|
+
* The IDs or values that match this filter.
|
|
9624
|
+
*/
|
|
9625
|
+
values: Array<string>;
|
|
9626
|
+
}
|
|
9037
9627
|
/**
|
|
9038
9628
|
* Configuration for tiered_with_proration pricing
|
|
9039
9629
|
*/
|
|
@@ -9066,7 +9656,7 @@ export declare namespace Price {
|
|
|
9066
9656
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9067
9657
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9068
9658
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9069
|
-
composite_price_filters: Array<
|
|
9659
|
+
composite_price_filters: Array<UnitWithProrationPrice.CompositePriceFilter> | null;
|
|
9070
9660
|
conversion_rate: number | null;
|
|
9071
9661
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9072
9662
|
created_at: string;
|
|
@@ -9128,6 +9718,20 @@ export declare namespace Price {
|
|
|
9128
9718
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9129
9719
|
}
|
|
9130
9720
|
namespace UnitWithProrationPrice {
|
|
9721
|
+
interface CompositePriceFilter {
|
|
9722
|
+
/**
|
|
9723
|
+
* The property of the price to filter on.
|
|
9724
|
+
*/
|
|
9725
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9726
|
+
/**
|
|
9727
|
+
* Should prices that match the filter be included or excluded.
|
|
9728
|
+
*/
|
|
9729
|
+
operator: 'includes' | 'excludes';
|
|
9730
|
+
/**
|
|
9731
|
+
* The IDs or values that match this filter.
|
|
9732
|
+
*/
|
|
9733
|
+
values: Array<string>;
|
|
9734
|
+
}
|
|
9131
9735
|
/**
|
|
9132
9736
|
* Configuration for unit_with_proration pricing
|
|
9133
9737
|
*/
|
|
@@ -9144,7 +9748,7 @@ export declare namespace Price {
|
|
|
9144
9748
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9145
9749
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9146
9750
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9147
|
-
composite_price_filters: Array<
|
|
9751
|
+
composite_price_filters: Array<GroupedAllocationPrice.CompositePriceFilter> | null;
|
|
9148
9752
|
conversion_rate: number | null;
|
|
9149
9753
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9150
9754
|
created_at: string;
|
|
@@ -9206,6 +9810,20 @@ export declare namespace Price {
|
|
|
9206
9810
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9207
9811
|
}
|
|
9208
9812
|
namespace GroupedAllocationPrice {
|
|
9813
|
+
interface CompositePriceFilter {
|
|
9814
|
+
/**
|
|
9815
|
+
* The property of the price to filter on.
|
|
9816
|
+
*/
|
|
9817
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9818
|
+
/**
|
|
9819
|
+
* Should prices that match the filter be included or excluded.
|
|
9820
|
+
*/
|
|
9821
|
+
operator: 'includes' | 'excludes';
|
|
9822
|
+
/**
|
|
9823
|
+
* The IDs or values that match this filter.
|
|
9824
|
+
*/
|
|
9825
|
+
values: Array<string>;
|
|
9826
|
+
}
|
|
9209
9827
|
/**
|
|
9210
9828
|
* Configuration for grouped_allocation pricing
|
|
9211
9829
|
*/
|
|
@@ -9234,7 +9852,7 @@ export declare namespace Price {
|
|
|
9234
9852
|
*/
|
|
9235
9853
|
bulk_with_proration_config: BulkWithProrationPrice.BulkWithProrationConfig;
|
|
9236
9854
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9237
|
-
composite_price_filters: Array<
|
|
9855
|
+
composite_price_filters: Array<BulkWithProrationPrice.CompositePriceFilter> | null;
|
|
9238
9856
|
conversion_rate: number | null;
|
|
9239
9857
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9240
9858
|
created_at: string;
|
|
@@ -9316,6 +9934,20 @@ export declare namespace Price {
|
|
|
9316
9934
|
tier_lower_bound?: string | null;
|
|
9317
9935
|
}
|
|
9318
9936
|
}
|
|
9937
|
+
interface CompositePriceFilter {
|
|
9938
|
+
/**
|
|
9939
|
+
* The property of the price to filter on.
|
|
9940
|
+
*/
|
|
9941
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
9942
|
+
/**
|
|
9943
|
+
* Should prices that match the filter be included or excluded.
|
|
9944
|
+
*/
|
|
9945
|
+
operator: 'includes' | 'excludes';
|
|
9946
|
+
/**
|
|
9947
|
+
* The IDs or values that match this filter.
|
|
9948
|
+
*/
|
|
9949
|
+
values: Array<string>;
|
|
9950
|
+
}
|
|
9319
9951
|
}
|
|
9320
9952
|
interface GroupedWithProratedMinimumPrice {
|
|
9321
9953
|
id: string;
|
|
@@ -9323,7 +9955,7 @@ export declare namespace Price {
|
|
|
9323
9955
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9324
9956
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9325
9957
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9326
|
-
composite_price_filters: Array<
|
|
9958
|
+
composite_price_filters: Array<GroupedWithProratedMinimumPrice.CompositePriceFilter> | null;
|
|
9327
9959
|
conversion_rate: number | null;
|
|
9328
9960
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9329
9961
|
created_at: string;
|
|
@@ -9385,6 +10017,20 @@ export declare namespace Price {
|
|
|
9385
10017
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9386
10018
|
}
|
|
9387
10019
|
namespace GroupedWithProratedMinimumPrice {
|
|
10020
|
+
interface CompositePriceFilter {
|
|
10021
|
+
/**
|
|
10022
|
+
* The property of the price to filter on.
|
|
10023
|
+
*/
|
|
10024
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10025
|
+
/**
|
|
10026
|
+
* Should prices that match the filter be included or excluded.
|
|
10027
|
+
*/
|
|
10028
|
+
operator: 'includes' | 'excludes';
|
|
10029
|
+
/**
|
|
10030
|
+
* The IDs or values that match this filter.
|
|
10031
|
+
*/
|
|
10032
|
+
values: Array<string>;
|
|
10033
|
+
}
|
|
9388
10034
|
/**
|
|
9389
10035
|
* Configuration for grouped_with_prorated_minimum pricing
|
|
9390
10036
|
*/
|
|
@@ -9409,7 +10055,7 @@ export declare namespace Price {
|
|
|
9409
10055
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9410
10056
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9411
10057
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9412
|
-
composite_price_filters: Array<
|
|
10058
|
+
composite_price_filters: Array<GroupedWithMeteredMinimumPrice.CompositePriceFilter> | null;
|
|
9413
10059
|
conversion_rate: number | null;
|
|
9414
10060
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9415
10061
|
created_at: string;
|
|
@@ -9471,6 +10117,20 @@ export declare namespace Price {
|
|
|
9471
10117
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9472
10118
|
}
|
|
9473
10119
|
namespace GroupedWithMeteredMinimumPrice {
|
|
10120
|
+
interface CompositePriceFilter {
|
|
10121
|
+
/**
|
|
10122
|
+
* The property of the price to filter on.
|
|
10123
|
+
*/
|
|
10124
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10125
|
+
/**
|
|
10126
|
+
* Should prices that match the filter be included or excluded.
|
|
10127
|
+
*/
|
|
10128
|
+
operator: 'includes' | 'excludes';
|
|
10129
|
+
/**
|
|
10130
|
+
* The IDs or values that match this filter.
|
|
10131
|
+
*/
|
|
10132
|
+
values: Array<string>;
|
|
10133
|
+
}
|
|
9474
10134
|
/**
|
|
9475
10135
|
* Configuration for grouped_with_metered_minimum pricing
|
|
9476
10136
|
*/
|
|
@@ -9537,7 +10197,7 @@ export declare namespace Price {
|
|
|
9537
10197
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9538
10198
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9539
10199
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9540
|
-
composite_price_filters: Array<
|
|
10200
|
+
composite_price_filters: Array<GroupedWithMinMaxThresholdsPrice.CompositePriceFilter> | null;
|
|
9541
10201
|
conversion_rate: number | null;
|
|
9542
10202
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9543
10203
|
created_at: string;
|
|
@@ -9599,6 +10259,20 @@ export declare namespace Price {
|
|
|
9599
10259
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9600
10260
|
}
|
|
9601
10261
|
namespace GroupedWithMinMaxThresholdsPrice {
|
|
10262
|
+
interface CompositePriceFilter {
|
|
10263
|
+
/**
|
|
10264
|
+
* The property of the price to filter on.
|
|
10265
|
+
*/
|
|
10266
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10267
|
+
/**
|
|
10268
|
+
* Should prices that match the filter be included or excluded.
|
|
10269
|
+
*/
|
|
10270
|
+
operator: 'includes' | 'excludes';
|
|
10271
|
+
/**
|
|
10272
|
+
* The IDs or values that match this filter.
|
|
10273
|
+
*/
|
|
10274
|
+
values: Array<string>;
|
|
10275
|
+
}
|
|
9602
10276
|
/**
|
|
9603
10277
|
* Configuration for grouped_with_min_max_thresholds pricing
|
|
9604
10278
|
*/
|
|
@@ -9627,7 +10301,7 @@ export declare namespace Price {
|
|
|
9627
10301
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9628
10302
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9629
10303
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9630
|
-
composite_price_filters: Array<
|
|
10304
|
+
composite_price_filters: Array<MatrixWithDisplayNamePrice.CompositePriceFilter> | null;
|
|
9631
10305
|
conversion_rate: number | null;
|
|
9632
10306
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9633
10307
|
created_at: string;
|
|
@@ -9689,6 +10363,20 @@ export declare namespace Price {
|
|
|
9689
10363
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9690
10364
|
}
|
|
9691
10365
|
namespace MatrixWithDisplayNamePrice {
|
|
10366
|
+
interface CompositePriceFilter {
|
|
10367
|
+
/**
|
|
10368
|
+
* The property of the price to filter on.
|
|
10369
|
+
*/
|
|
10370
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10371
|
+
/**
|
|
10372
|
+
* Should prices that match the filter be included or excluded.
|
|
10373
|
+
*/
|
|
10374
|
+
operator: 'includes' | 'excludes';
|
|
10375
|
+
/**
|
|
10376
|
+
* The IDs or values that match this filter.
|
|
10377
|
+
*/
|
|
10378
|
+
values: Array<string>;
|
|
10379
|
+
}
|
|
9692
10380
|
/**
|
|
9693
10381
|
* Configuration for matrix_with_display_name pricing
|
|
9694
10382
|
*/
|
|
@@ -9728,7 +10416,7 @@ export declare namespace Price {
|
|
|
9728
10416
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9729
10417
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9730
10418
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9731
|
-
composite_price_filters: Array<
|
|
10419
|
+
composite_price_filters: Array<GroupedTieredPackagePrice.CompositePriceFilter> | null;
|
|
9732
10420
|
conversion_rate: number | null;
|
|
9733
10421
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9734
10422
|
created_at: string;
|
|
@@ -9790,6 +10478,20 @@ export declare namespace Price {
|
|
|
9790
10478
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9791
10479
|
}
|
|
9792
10480
|
namespace GroupedTieredPackagePrice {
|
|
10481
|
+
interface CompositePriceFilter {
|
|
10482
|
+
/**
|
|
10483
|
+
* The property of the price to filter on.
|
|
10484
|
+
*/
|
|
10485
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10486
|
+
/**
|
|
10487
|
+
* Should prices that match the filter be included or excluded.
|
|
10488
|
+
*/
|
|
10489
|
+
operator: 'includes' | 'excludes';
|
|
10490
|
+
/**
|
|
10491
|
+
* The IDs or values that match this filter.
|
|
10492
|
+
*/
|
|
10493
|
+
values: Array<string>;
|
|
10494
|
+
}
|
|
9793
10495
|
/**
|
|
9794
10496
|
* Configuration for grouped_tiered_package pricing
|
|
9795
10497
|
*/
|
|
@@ -9830,7 +10532,7 @@ export declare namespace Price {
|
|
|
9830
10532
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9831
10533
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9832
10534
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9833
|
-
composite_price_filters: Array<
|
|
10535
|
+
composite_price_filters: Array<MaxGroupTieredPackagePrice.CompositePriceFilter> | null;
|
|
9834
10536
|
conversion_rate: number | null;
|
|
9835
10537
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9836
10538
|
created_at: string;
|
|
@@ -9892,6 +10594,20 @@ export declare namespace Price {
|
|
|
9892
10594
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9893
10595
|
}
|
|
9894
10596
|
namespace MaxGroupTieredPackagePrice {
|
|
10597
|
+
interface CompositePriceFilter {
|
|
10598
|
+
/**
|
|
10599
|
+
* The property of the price to filter on.
|
|
10600
|
+
*/
|
|
10601
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10602
|
+
/**
|
|
10603
|
+
* Should prices that match the filter be included or excluded.
|
|
10604
|
+
*/
|
|
10605
|
+
operator: 'includes' | 'excludes';
|
|
10606
|
+
/**
|
|
10607
|
+
* The IDs or values that match this filter.
|
|
10608
|
+
*/
|
|
10609
|
+
values: Array<string>;
|
|
10610
|
+
}
|
|
9895
10611
|
/**
|
|
9896
10612
|
* Configuration for max_group_tiered_package pricing
|
|
9897
10613
|
*/
|
|
@@ -9931,7 +10647,7 @@ export declare namespace Price {
|
|
|
9931
10647
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
9932
10648
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
9933
10649
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
9934
|
-
composite_price_filters: Array<
|
|
10650
|
+
composite_price_filters: Array<ScalableMatrixWithUnitPricingPrice.CompositePriceFilter> | null;
|
|
9935
10651
|
conversion_rate: number | null;
|
|
9936
10652
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
9937
10653
|
created_at: string;
|
|
@@ -9993,6 +10709,20 @@ export declare namespace Price {
|
|
|
9993
10709
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
9994
10710
|
}
|
|
9995
10711
|
namespace ScalableMatrixWithUnitPricingPrice {
|
|
10712
|
+
interface CompositePriceFilter {
|
|
10713
|
+
/**
|
|
10714
|
+
* The property of the price to filter on.
|
|
10715
|
+
*/
|
|
10716
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10717
|
+
/**
|
|
10718
|
+
* Should prices that match the filter be included or excluded.
|
|
10719
|
+
*/
|
|
10720
|
+
operator: 'includes' | 'excludes';
|
|
10721
|
+
/**
|
|
10722
|
+
* The IDs or values that match this filter.
|
|
10723
|
+
*/
|
|
10724
|
+
values: Array<string>;
|
|
10725
|
+
}
|
|
9996
10726
|
/**
|
|
9997
10727
|
* Configuration for scalable_matrix_with_unit_pricing pricing
|
|
9998
10728
|
*/
|
|
@@ -10044,7 +10774,7 @@ export declare namespace Price {
|
|
|
10044
10774
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
10045
10775
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
10046
10776
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
10047
|
-
composite_price_filters: Array<
|
|
10777
|
+
composite_price_filters: Array<ScalableMatrixWithTieredPricingPrice.CompositePriceFilter> | null;
|
|
10048
10778
|
conversion_rate: number | null;
|
|
10049
10779
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
10050
10780
|
created_at: string;
|
|
@@ -10106,6 +10836,20 @@ export declare namespace Price {
|
|
|
10106
10836
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
10107
10837
|
}
|
|
10108
10838
|
namespace ScalableMatrixWithTieredPricingPrice {
|
|
10839
|
+
interface CompositePriceFilter {
|
|
10840
|
+
/**
|
|
10841
|
+
* The property of the price to filter on.
|
|
10842
|
+
*/
|
|
10843
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10844
|
+
/**
|
|
10845
|
+
* Should prices that match the filter be included or excluded.
|
|
10846
|
+
*/
|
|
10847
|
+
operator: 'includes' | 'excludes';
|
|
10848
|
+
/**
|
|
10849
|
+
* The IDs or values that match this filter.
|
|
10850
|
+
*/
|
|
10851
|
+
values: Array<string>;
|
|
10852
|
+
}
|
|
10109
10853
|
/**
|
|
10110
10854
|
* Configuration for scalable_matrix_with_tiered_pricing pricing
|
|
10111
10855
|
*/
|
|
@@ -10166,7 +10910,7 @@ export declare namespace Price {
|
|
|
10166
10910
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
10167
10911
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
10168
10912
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
10169
|
-
composite_price_filters: Array<
|
|
10913
|
+
composite_price_filters: Array<CumulativeGroupedBulkPrice.CompositePriceFilter> | null;
|
|
10170
10914
|
conversion_rate: number | null;
|
|
10171
10915
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
10172
10916
|
created_at: string;
|
|
@@ -10228,6 +10972,20 @@ export declare namespace Price {
|
|
|
10228
10972
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
10229
10973
|
}
|
|
10230
10974
|
namespace CumulativeGroupedBulkPrice {
|
|
10975
|
+
interface CompositePriceFilter {
|
|
10976
|
+
/**
|
|
10977
|
+
* The property of the price to filter on.
|
|
10978
|
+
*/
|
|
10979
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10980
|
+
/**
|
|
10981
|
+
* Should prices that match the filter be included or excluded.
|
|
10982
|
+
*/
|
|
10983
|
+
operator: 'includes' | 'excludes';
|
|
10984
|
+
/**
|
|
10985
|
+
* The IDs or values that match this filter.
|
|
10986
|
+
*/
|
|
10987
|
+
values: Array<string>;
|
|
10988
|
+
}
|
|
10231
10989
|
/**
|
|
10232
10990
|
* Configuration for cumulative_grouped_bulk pricing
|
|
10233
10991
|
*/
|
|
@@ -10267,7 +11025,7 @@ export declare namespace Price {
|
|
|
10267
11025
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
10268
11026
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
10269
11027
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
10270
|
-
composite_price_filters: Array<
|
|
11028
|
+
composite_price_filters: Array<MinimumCompositePrice.CompositePriceFilter> | null;
|
|
10271
11029
|
conversion_rate: number | null;
|
|
10272
11030
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
10273
11031
|
created_at: string;
|
|
@@ -10329,6 +11087,20 @@ export declare namespace Price {
|
|
|
10329
11087
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
10330
11088
|
}
|
|
10331
11089
|
namespace MinimumCompositePrice {
|
|
11090
|
+
interface CompositePriceFilter {
|
|
11091
|
+
/**
|
|
11092
|
+
* The property of the price to filter on.
|
|
11093
|
+
*/
|
|
11094
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
11095
|
+
/**
|
|
11096
|
+
* Should prices that match the filter be included or excluded.
|
|
11097
|
+
*/
|
|
11098
|
+
operator: 'includes' | 'excludes';
|
|
11099
|
+
/**
|
|
11100
|
+
* The IDs or values that match this filter.
|
|
11101
|
+
*/
|
|
11102
|
+
values: Array<string>;
|
|
11103
|
+
}
|
|
10332
11104
|
/**
|
|
10333
11105
|
* Configuration for minimum pricing
|
|
10334
11106
|
*/
|
|
@@ -10349,7 +11121,7 @@ export declare namespace Price {
|
|
|
10349
11121
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
10350
11122
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
10351
11123
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
10352
|
-
composite_price_filters: Array<
|
|
11124
|
+
composite_price_filters: Array<PercentCompositePrice.CompositePriceFilter> | null;
|
|
10353
11125
|
conversion_rate: number | null;
|
|
10354
11126
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
10355
11127
|
created_at: string;
|
|
@@ -10411,6 +11183,20 @@ export declare namespace Price {
|
|
|
10411
11183
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
10412
11184
|
}
|
|
10413
11185
|
namespace PercentCompositePrice {
|
|
11186
|
+
interface CompositePriceFilter {
|
|
11187
|
+
/**
|
|
11188
|
+
* The property of the price to filter on.
|
|
11189
|
+
*/
|
|
11190
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
11191
|
+
/**
|
|
11192
|
+
* Should prices that match the filter be included or excluded.
|
|
11193
|
+
*/
|
|
11194
|
+
operator: 'includes' | 'excludes';
|
|
11195
|
+
/**
|
|
11196
|
+
* The IDs or values that match this filter.
|
|
11197
|
+
*/
|
|
11198
|
+
values: Array<string>;
|
|
11199
|
+
}
|
|
10414
11200
|
/**
|
|
10415
11201
|
* Configuration for percent pricing
|
|
10416
11202
|
*/
|
|
@@ -10427,7 +11213,7 @@ export declare namespace Price {
|
|
|
10427
11213
|
billing_cycle_configuration: Shared.BillingCycleConfiguration;
|
|
10428
11214
|
billing_mode: 'in_advance' | 'in_arrear';
|
|
10429
11215
|
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
10430
|
-
composite_price_filters: Array<
|
|
11216
|
+
composite_price_filters: Array<EventOutputPrice.CompositePriceFilter> | null;
|
|
10431
11217
|
conversion_rate: number | null;
|
|
10432
11218
|
conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
10433
11219
|
created_at: string;
|
|
@@ -10489,6 +11275,20 @@ export declare namespace Price {
|
|
|
10489
11275
|
dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
|
|
10490
11276
|
}
|
|
10491
11277
|
namespace EventOutputPrice {
|
|
11278
|
+
interface CompositePriceFilter {
|
|
11279
|
+
/**
|
|
11280
|
+
* The property of the price to filter on.
|
|
11281
|
+
*/
|
|
11282
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
11283
|
+
/**
|
|
11284
|
+
* Should prices that match the filter be included or excluded.
|
|
11285
|
+
*/
|
|
11286
|
+
operator: 'includes' | 'excludes';
|
|
11287
|
+
/**
|
|
11288
|
+
* The IDs or values that match this filter.
|
|
11289
|
+
*/
|
|
11290
|
+
values: Array<string>;
|
|
11291
|
+
}
|
|
10492
11292
|
/**
|
|
10493
11293
|
* Configuration for event_output pricing
|
|
10494
11294
|
*/
|
|
@@ -10497,6 +11297,12 @@ export declare namespace Price {
|
|
|
10497
11297
|
* The key in the event data to extract the unit rate from.
|
|
10498
11298
|
*/
|
|
10499
11299
|
unit_rating_key: string;
|
|
11300
|
+
/**
|
|
11301
|
+
* If provided, this amount will be used as the unit rate when an event does not
|
|
11302
|
+
* have a value for the `unit_rating_key`. If not provided, events missing a unit
|
|
11303
|
+
* rate will be ignored.
|
|
11304
|
+
*/
|
|
11305
|
+
default_unit_rate?: string | null;
|
|
10500
11306
|
/**
|
|
10501
11307
|
* An optional key in the event data to group by (e.g., event ID). All events will
|
|
10502
11308
|
* also be grouped by their unit rate.
|
|
@@ -10651,20 +11457,6 @@ export interface TieredConversionRateConfig {
|
|
|
10651
11457
|
conversion_rate_type: 'tiered';
|
|
10652
11458
|
tiered_config: ConversionRateTieredConfig;
|
|
10653
11459
|
}
|
|
10654
|
-
export interface TransformPriceFilter {
|
|
10655
|
-
/**
|
|
10656
|
-
* The property of the price to filter on.
|
|
10657
|
-
*/
|
|
10658
|
-
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
10659
|
-
/**
|
|
10660
|
-
* Should prices that match the filter be included or excluded.
|
|
10661
|
-
*/
|
|
10662
|
-
operator: 'includes' | 'excludes';
|
|
10663
|
-
/**
|
|
10664
|
-
* The IDs or values that match this filter.
|
|
10665
|
-
*/
|
|
10666
|
-
values: Array<string>;
|
|
10667
|
-
}
|
|
10668
11460
|
export interface TrialDiscount {
|
|
10669
11461
|
discount_type: 'trial';
|
|
10670
11462
|
/**
|
|
@@ -10675,7 +11467,7 @@ export interface TrialDiscount {
|
|
|
10675
11467
|
/**
|
|
10676
11468
|
* The filters that determine which prices to apply this discount to.
|
|
10677
11469
|
*/
|
|
10678
|
-
filters?: Array<
|
|
11470
|
+
filters?: Array<TrialDiscount.Filter> | null;
|
|
10679
11471
|
reason?: string | null;
|
|
10680
11472
|
/**
|
|
10681
11473
|
* Only available if discount_type is `trial`
|
|
@@ -10686,6 +11478,22 @@ export interface TrialDiscount {
|
|
|
10686
11478
|
*/
|
|
10687
11479
|
trial_percentage_discount?: number | null;
|
|
10688
11480
|
}
|
|
11481
|
+
export declare namespace TrialDiscount {
|
|
11482
|
+
interface Filter {
|
|
11483
|
+
/**
|
|
11484
|
+
* The property of the price to filter on.
|
|
11485
|
+
*/
|
|
11486
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
11487
|
+
/**
|
|
11488
|
+
* Should prices that match the filter be included or excluded.
|
|
11489
|
+
*/
|
|
11490
|
+
operator: 'includes' | 'excludes';
|
|
11491
|
+
/**
|
|
11492
|
+
* The IDs or values that match this filter.
|
|
11493
|
+
*/
|
|
11494
|
+
values: Array<string>;
|
|
11495
|
+
}
|
|
11496
|
+
}
|
|
10689
11497
|
/**
|
|
10690
11498
|
* Configuration for unit pricing
|
|
10691
11499
|
*/
|
|
@@ -10714,9 +11522,25 @@ export interface UsageDiscount {
|
|
|
10714
11522
|
/**
|
|
10715
11523
|
* The filters that determine which prices to apply this discount to.
|
|
10716
11524
|
*/
|
|
10717
|
-
filters?: Array<
|
|
11525
|
+
filters?: Array<UsageDiscount.Filter> | null;
|
|
10718
11526
|
reason?: string | null;
|
|
10719
11527
|
}
|
|
11528
|
+
export declare namespace UsageDiscount {
|
|
11529
|
+
interface Filter {
|
|
11530
|
+
/**
|
|
11531
|
+
* The property of the price to filter on.
|
|
11532
|
+
*/
|
|
11533
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
11534
|
+
/**
|
|
11535
|
+
* Should prices that match the filter be included or excluded.
|
|
11536
|
+
*/
|
|
11537
|
+
operator: 'includes' | 'excludes';
|
|
11538
|
+
/**
|
|
11539
|
+
* The IDs or values that match this filter.
|
|
11540
|
+
*/
|
|
11541
|
+
values: Array<string>;
|
|
11542
|
+
}
|
|
11543
|
+
}
|
|
10720
11544
|
export interface UsageDiscountInterval {
|
|
10721
11545
|
/**
|
|
10722
11546
|
* The price interval ids that this discount interval applies to.
|
|
@@ -10730,7 +11554,7 @@ export interface UsageDiscountInterval {
|
|
|
10730
11554
|
/**
|
|
10731
11555
|
* The filters that determine which prices this discount interval applies to.
|
|
10732
11556
|
*/
|
|
10733
|
-
filters: Array<
|
|
11557
|
+
filters: Array<UsageDiscountInterval.Filter>;
|
|
10734
11558
|
/**
|
|
10735
11559
|
* The start date of the discount interval.
|
|
10736
11560
|
*/
|
|
@@ -10741,6 +11565,22 @@ export interface UsageDiscountInterval {
|
|
|
10741
11565
|
*/
|
|
10742
11566
|
usage_discount: number;
|
|
10743
11567
|
}
|
|
11568
|
+
export declare namespace UsageDiscountInterval {
|
|
11569
|
+
interface Filter {
|
|
11570
|
+
/**
|
|
11571
|
+
* The property of the price to filter on.
|
|
11572
|
+
*/
|
|
11573
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
11574
|
+
/**
|
|
11575
|
+
* Should prices that match the filter be included or excluded.
|
|
11576
|
+
*/
|
|
11577
|
+
operator: 'includes' | 'excludes';
|
|
11578
|
+
/**
|
|
11579
|
+
* The IDs or values that match this filter.
|
|
11580
|
+
*/
|
|
11581
|
+
values: Array<string>;
|
|
11582
|
+
}
|
|
11583
|
+
}
|
|
10744
11584
|
export declare class CreditNotesPage extends Page<CreditNote> {
|
|
10745
11585
|
}
|
|
10746
11586
|
export declare class InvoicesPage extends Page<Invoice> {
|