orb-billing 4.53.0 → 4.55.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/core.d.ts.map +1 -1
- package/core.js +12 -6
- package/core.js.map +1 -1
- package/core.mjs +12 -6
- package/core.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/customers/credits/ledger.d.ts +2 -2
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/events/backfills.d.ts +30 -0
- package/resources/events/backfills.d.ts.map +1 -1
- package/resources/events/backfills.js.map +1 -1
- package/resources/events/backfills.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +175 -2
- package/resources/invoice-line-items.d.ts.map +1 -1
- package/resources/invoices.d.ts +350 -4
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs.map +1 -1
- package/resources/plans/plans.d.ts +213 -25
- 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 +530 -61
- 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/subscriptions.d.ts +453 -269
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/core.ts +14 -6
- package/src/resources/customers/credits/ledger.ts +2 -2
- package/src/resources/events/backfills.ts +35 -0
- package/src/resources/invoice-line-items.ts +221 -2
- package/src/resources/invoices.ts +442 -4
- package/src/resources/plans/plans.ts +259 -31
- package/src/resources/prices/prices.ts +752 -88
- package/src/resources/subscriptions.ts +569 -345
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1042,7 +1042,7 @@ export interface Subscription {
|
|
|
1042
1042
|
export declare namespace Subscription {
|
|
1043
1043
|
interface AdjustmentInterval {
|
|
1044
1044
|
id: string;
|
|
1045
|
-
adjustment: AdjustmentInterval.
|
|
1045
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
1046
1046
|
/**
|
|
1047
1047
|
* The price interval IDs that this adjustment applies to.
|
|
1048
1048
|
*/
|
|
@@ -1057,14 +1057,9 @@ export declare namespace Subscription {
|
|
|
1057
1057
|
start_date: string;
|
|
1058
1058
|
}
|
|
1059
1059
|
namespace AdjustmentInterval {
|
|
1060
|
-
interface
|
|
1060
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
1061
1061
|
id: string;
|
|
1062
|
-
adjustment_type: '
|
|
1063
|
-
/**
|
|
1064
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
1065
|
-
* billing period.
|
|
1066
|
-
*/
|
|
1067
|
-
amount_discount: string;
|
|
1062
|
+
adjustment_type: 'usage_discount';
|
|
1068
1063
|
/**
|
|
1069
1064
|
* The price IDs that this adjustment applies to.
|
|
1070
1065
|
*/
|
|
@@ -1082,10 +1077,20 @@ export declare namespace Subscription {
|
|
|
1082
1077
|
* The reason for the adjustment.
|
|
1083
1078
|
*/
|
|
1084
1079
|
reason: string | null;
|
|
1080
|
+
/**
|
|
1081
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
1082
|
+
* to in a given billing period.
|
|
1083
|
+
*/
|
|
1084
|
+
usage_discount: number;
|
|
1085
1085
|
}
|
|
1086
|
-
interface
|
|
1086
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
1087
1087
|
id: string;
|
|
1088
|
-
adjustment_type: '
|
|
1088
|
+
adjustment_type: 'amount_discount';
|
|
1089
|
+
/**
|
|
1090
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
1091
|
+
* billing period.
|
|
1092
|
+
*/
|
|
1093
|
+
amount_discount: string;
|
|
1089
1094
|
/**
|
|
1090
1095
|
* The price IDs that this adjustment applies to.
|
|
1091
1096
|
*/
|
|
@@ -1095,11 +1100,6 @@ export declare namespace Subscription {
|
|
|
1095
1100
|
* that apply to only one price.
|
|
1096
1101
|
*/
|
|
1097
1102
|
is_invoice_level: boolean;
|
|
1098
|
-
/**
|
|
1099
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
1100
|
-
* intervals this adjustment applies to in a given billing period.
|
|
1101
|
-
*/
|
|
1102
|
-
percentage_discount: number;
|
|
1103
1103
|
/**
|
|
1104
1104
|
* The plan phase in which this adjustment is active.
|
|
1105
1105
|
*/
|
|
@@ -1109,9 +1109,9 @@ export declare namespace Subscription {
|
|
|
1109
1109
|
*/
|
|
1110
1110
|
reason: string | null;
|
|
1111
1111
|
}
|
|
1112
|
-
interface
|
|
1112
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
1113
1113
|
id: string;
|
|
1114
|
-
adjustment_type: '
|
|
1114
|
+
adjustment_type: 'percentage_discount';
|
|
1115
1115
|
/**
|
|
1116
1116
|
* The price IDs that this adjustment applies to.
|
|
1117
1117
|
*/
|
|
@@ -1121,6 +1121,11 @@ export declare namespace Subscription {
|
|
|
1121
1121
|
* that apply to only one price.
|
|
1122
1122
|
*/
|
|
1123
1123
|
is_invoice_level: boolean;
|
|
1124
|
+
/**
|
|
1125
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
1126
|
+
* intervals this adjustment applies to in a given billing period.
|
|
1127
|
+
*/
|
|
1128
|
+
percentage_discount: number;
|
|
1124
1129
|
/**
|
|
1125
1130
|
* The plan phase in which this adjustment is active.
|
|
1126
1131
|
*/
|
|
@@ -1129,13 +1134,8 @@ export declare namespace Subscription {
|
|
|
1129
1134
|
* The reason for the adjustment.
|
|
1130
1135
|
*/
|
|
1131
1136
|
reason: string | null;
|
|
1132
|
-
/**
|
|
1133
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
1134
|
-
* to in a given billing period.
|
|
1135
|
-
*/
|
|
1136
|
-
usage_discount: number;
|
|
1137
1137
|
}
|
|
1138
|
-
interface
|
|
1138
|
+
interface PlanPhaseMinimumAdjustment {
|
|
1139
1139
|
id: string;
|
|
1140
1140
|
adjustment_type: 'minimum';
|
|
1141
1141
|
/**
|
|
@@ -1165,7 +1165,7 @@ export declare namespace Subscription {
|
|
|
1165
1165
|
*/
|
|
1166
1166
|
reason: string | null;
|
|
1167
1167
|
}
|
|
1168
|
-
interface
|
|
1168
|
+
interface PlanPhaseMaximumAdjustment {
|
|
1169
1169
|
id: string;
|
|
1170
1170
|
adjustment_type: 'maximum';
|
|
1171
1171
|
/**
|
|
@@ -1576,7 +1576,7 @@ export interface SubscriptionCreateResponse {
|
|
|
1576
1576
|
export declare namespace SubscriptionCreateResponse {
|
|
1577
1577
|
interface AdjustmentInterval {
|
|
1578
1578
|
id: string;
|
|
1579
|
-
adjustment: AdjustmentInterval.
|
|
1579
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
1580
1580
|
/**
|
|
1581
1581
|
* The price interval IDs that this adjustment applies to.
|
|
1582
1582
|
*/
|
|
@@ -1591,14 +1591,9 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
1591
1591
|
start_date: string;
|
|
1592
1592
|
}
|
|
1593
1593
|
namespace AdjustmentInterval {
|
|
1594
|
-
interface
|
|
1594
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
1595
1595
|
id: string;
|
|
1596
|
-
adjustment_type: '
|
|
1597
|
-
/**
|
|
1598
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
1599
|
-
* billing period.
|
|
1600
|
-
*/
|
|
1601
|
-
amount_discount: string;
|
|
1596
|
+
adjustment_type: 'usage_discount';
|
|
1602
1597
|
/**
|
|
1603
1598
|
* The price IDs that this adjustment applies to.
|
|
1604
1599
|
*/
|
|
@@ -1616,10 +1611,20 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
1616
1611
|
* The reason for the adjustment.
|
|
1617
1612
|
*/
|
|
1618
1613
|
reason: string | null;
|
|
1614
|
+
/**
|
|
1615
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
1616
|
+
* to in a given billing period.
|
|
1617
|
+
*/
|
|
1618
|
+
usage_discount: number;
|
|
1619
1619
|
}
|
|
1620
|
-
interface
|
|
1620
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
1621
1621
|
id: string;
|
|
1622
|
-
adjustment_type: '
|
|
1622
|
+
adjustment_type: 'amount_discount';
|
|
1623
|
+
/**
|
|
1624
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
1625
|
+
* billing period.
|
|
1626
|
+
*/
|
|
1627
|
+
amount_discount: string;
|
|
1623
1628
|
/**
|
|
1624
1629
|
* The price IDs that this adjustment applies to.
|
|
1625
1630
|
*/
|
|
@@ -1629,11 +1634,6 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
1629
1634
|
* that apply to only one price.
|
|
1630
1635
|
*/
|
|
1631
1636
|
is_invoice_level: boolean;
|
|
1632
|
-
/**
|
|
1633
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
1634
|
-
* intervals this adjustment applies to in a given billing period.
|
|
1635
|
-
*/
|
|
1636
|
-
percentage_discount: number;
|
|
1637
1637
|
/**
|
|
1638
1638
|
* The plan phase in which this adjustment is active.
|
|
1639
1639
|
*/
|
|
@@ -1643,9 +1643,9 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
1643
1643
|
*/
|
|
1644
1644
|
reason: string | null;
|
|
1645
1645
|
}
|
|
1646
|
-
interface
|
|
1646
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
1647
1647
|
id: string;
|
|
1648
|
-
adjustment_type: '
|
|
1648
|
+
adjustment_type: 'percentage_discount';
|
|
1649
1649
|
/**
|
|
1650
1650
|
* The price IDs that this adjustment applies to.
|
|
1651
1651
|
*/
|
|
@@ -1655,6 +1655,11 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
1655
1655
|
* that apply to only one price.
|
|
1656
1656
|
*/
|
|
1657
1657
|
is_invoice_level: boolean;
|
|
1658
|
+
/**
|
|
1659
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
1660
|
+
* intervals this adjustment applies to in a given billing period.
|
|
1661
|
+
*/
|
|
1662
|
+
percentage_discount: number;
|
|
1658
1663
|
/**
|
|
1659
1664
|
* The plan phase in which this adjustment is active.
|
|
1660
1665
|
*/
|
|
@@ -1663,13 +1668,8 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
1663
1668
|
* The reason for the adjustment.
|
|
1664
1669
|
*/
|
|
1665
1670
|
reason: string | null;
|
|
1666
|
-
/**
|
|
1667
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
1668
|
-
* to in a given billing period.
|
|
1669
|
-
*/
|
|
1670
|
-
usage_discount: number;
|
|
1671
1671
|
}
|
|
1672
|
-
interface
|
|
1672
|
+
interface PlanPhaseMinimumAdjustment {
|
|
1673
1673
|
id: string;
|
|
1674
1674
|
adjustment_type: 'minimum';
|
|
1675
1675
|
/**
|
|
@@ -1699,7 +1699,7 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
1699
1699
|
*/
|
|
1700
1700
|
reason: string | null;
|
|
1701
1701
|
}
|
|
1702
|
-
interface
|
|
1702
|
+
interface PlanPhaseMaximumAdjustment {
|
|
1703
1703
|
id: string;
|
|
1704
1704
|
adjustment_type: 'maximum';
|
|
1705
1705
|
/**
|
|
@@ -2055,7 +2055,7 @@ export interface SubscriptionCancelResponse {
|
|
|
2055
2055
|
export declare namespace SubscriptionCancelResponse {
|
|
2056
2056
|
interface AdjustmentInterval {
|
|
2057
2057
|
id: string;
|
|
2058
|
-
adjustment: AdjustmentInterval.
|
|
2058
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
2059
2059
|
/**
|
|
2060
2060
|
* The price interval IDs that this adjustment applies to.
|
|
2061
2061
|
*/
|
|
@@ -2070,14 +2070,9 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2070
2070
|
start_date: string;
|
|
2071
2071
|
}
|
|
2072
2072
|
namespace AdjustmentInterval {
|
|
2073
|
-
interface
|
|
2073
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
2074
2074
|
id: string;
|
|
2075
|
-
adjustment_type: '
|
|
2076
|
-
/**
|
|
2077
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
2078
|
-
* billing period.
|
|
2079
|
-
*/
|
|
2080
|
-
amount_discount: string;
|
|
2075
|
+
adjustment_type: 'usage_discount';
|
|
2081
2076
|
/**
|
|
2082
2077
|
* The price IDs that this adjustment applies to.
|
|
2083
2078
|
*/
|
|
@@ -2095,10 +2090,20 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2095
2090
|
* The reason for the adjustment.
|
|
2096
2091
|
*/
|
|
2097
2092
|
reason: string | null;
|
|
2093
|
+
/**
|
|
2094
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
2095
|
+
* to in a given billing period.
|
|
2096
|
+
*/
|
|
2097
|
+
usage_discount: number;
|
|
2098
2098
|
}
|
|
2099
|
-
interface
|
|
2099
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
2100
2100
|
id: string;
|
|
2101
|
-
adjustment_type: '
|
|
2101
|
+
adjustment_type: 'amount_discount';
|
|
2102
|
+
/**
|
|
2103
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
2104
|
+
* billing period.
|
|
2105
|
+
*/
|
|
2106
|
+
amount_discount: string;
|
|
2102
2107
|
/**
|
|
2103
2108
|
* The price IDs that this adjustment applies to.
|
|
2104
2109
|
*/
|
|
@@ -2108,11 +2113,6 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2108
2113
|
* that apply to only one price.
|
|
2109
2114
|
*/
|
|
2110
2115
|
is_invoice_level: boolean;
|
|
2111
|
-
/**
|
|
2112
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
2113
|
-
* intervals this adjustment applies to in a given billing period.
|
|
2114
|
-
*/
|
|
2115
|
-
percentage_discount: number;
|
|
2116
2116
|
/**
|
|
2117
2117
|
* The plan phase in which this adjustment is active.
|
|
2118
2118
|
*/
|
|
@@ -2122,9 +2122,9 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2122
2122
|
*/
|
|
2123
2123
|
reason: string | null;
|
|
2124
2124
|
}
|
|
2125
|
-
interface
|
|
2125
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
2126
2126
|
id: string;
|
|
2127
|
-
adjustment_type: '
|
|
2127
|
+
adjustment_type: 'percentage_discount';
|
|
2128
2128
|
/**
|
|
2129
2129
|
* The price IDs that this adjustment applies to.
|
|
2130
2130
|
*/
|
|
@@ -2134,6 +2134,11 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2134
2134
|
* that apply to only one price.
|
|
2135
2135
|
*/
|
|
2136
2136
|
is_invoice_level: boolean;
|
|
2137
|
+
/**
|
|
2138
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
2139
|
+
* intervals this adjustment applies to in a given billing period.
|
|
2140
|
+
*/
|
|
2141
|
+
percentage_discount: number;
|
|
2137
2142
|
/**
|
|
2138
2143
|
* The plan phase in which this adjustment is active.
|
|
2139
2144
|
*/
|
|
@@ -2142,13 +2147,8 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2142
2147
|
* The reason for the adjustment.
|
|
2143
2148
|
*/
|
|
2144
2149
|
reason: string | null;
|
|
2145
|
-
/**
|
|
2146
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
2147
|
-
* to in a given billing period.
|
|
2148
|
-
*/
|
|
2149
|
-
usage_discount: number;
|
|
2150
2150
|
}
|
|
2151
|
-
interface
|
|
2151
|
+
interface PlanPhaseMinimumAdjustment {
|
|
2152
2152
|
id: string;
|
|
2153
2153
|
adjustment_type: 'minimum';
|
|
2154
2154
|
/**
|
|
@@ -2178,7 +2178,7 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2178
2178
|
*/
|
|
2179
2179
|
reason: string | null;
|
|
2180
2180
|
}
|
|
2181
|
-
interface
|
|
2181
|
+
interface PlanPhaseMaximumAdjustment {
|
|
2182
2182
|
id: string;
|
|
2183
2183
|
adjustment_type: 'maximum';
|
|
2184
2184
|
/**
|
|
@@ -2599,7 +2599,7 @@ export interface SubscriptionPriceIntervalsResponse {
|
|
|
2599
2599
|
export declare namespace SubscriptionPriceIntervalsResponse {
|
|
2600
2600
|
interface AdjustmentInterval {
|
|
2601
2601
|
id: string;
|
|
2602
|
-
adjustment: AdjustmentInterval.
|
|
2602
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
2603
2603
|
/**
|
|
2604
2604
|
* The price interval IDs that this adjustment applies to.
|
|
2605
2605
|
*/
|
|
@@ -2614,14 +2614,9 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
2614
2614
|
start_date: string;
|
|
2615
2615
|
}
|
|
2616
2616
|
namespace AdjustmentInterval {
|
|
2617
|
-
interface
|
|
2617
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
2618
2618
|
id: string;
|
|
2619
|
-
adjustment_type: '
|
|
2620
|
-
/**
|
|
2621
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
2622
|
-
* billing period.
|
|
2623
|
-
*/
|
|
2624
|
-
amount_discount: string;
|
|
2619
|
+
adjustment_type: 'usage_discount';
|
|
2625
2620
|
/**
|
|
2626
2621
|
* The price IDs that this adjustment applies to.
|
|
2627
2622
|
*/
|
|
@@ -2639,10 +2634,20 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
2639
2634
|
* The reason for the adjustment.
|
|
2640
2635
|
*/
|
|
2641
2636
|
reason: string | null;
|
|
2637
|
+
/**
|
|
2638
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
2639
|
+
* to in a given billing period.
|
|
2640
|
+
*/
|
|
2641
|
+
usage_discount: number;
|
|
2642
2642
|
}
|
|
2643
|
-
interface
|
|
2643
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
2644
2644
|
id: string;
|
|
2645
|
-
adjustment_type: '
|
|
2645
|
+
adjustment_type: 'amount_discount';
|
|
2646
|
+
/**
|
|
2647
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
2648
|
+
* billing period.
|
|
2649
|
+
*/
|
|
2650
|
+
amount_discount: string;
|
|
2646
2651
|
/**
|
|
2647
2652
|
* The price IDs that this adjustment applies to.
|
|
2648
2653
|
*/
|
|
@@ -2652,11 +2657,6 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
2652
2657
|
* that apply to only one price.
|
|
2653
2658
|
*/
|
|
2654
2659
|
is_invoice_level: boolean;
|
|
2655
|
-
/**
|
|
2656
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
2657
|
-
* intervals this adjustment applies to in a given billing period.
|
|
2658
|
-
*/
|
|
2659
|
-
percentage_discount: number;
|
|
2660
2660
|
/**
|
|
2661
2661
|
* The plan phase in which this adjustment is active.
|
|
2662
2662
|
*/
|
|
@@ -2666,9 +2666,9 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
2666
2666
|
*/
|
|
2667
2667
|
reason: string | null;
|
|
2668
2668
|
}
|
|
2669
|
-
interface
|
|
2669
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
2670
2670
|
id: string;
|
|
2671
|
-
adjustment_type: '
|
|
2671
|
+
adjustment_type: 'percentage_discount';
|
|
2672
2672
|
/**
|
|
2673
2673
|
* The price IDs that this adjustment applies to.
|
|
2674
2674
|
*/
|
|
@@ -2678,6 +2678,11 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
2678
2678
|
* that apply to only one price.
|
|
2679
2679
|
*/
|
|
2680
2680
|
is_invoice_level: boolean;
|
|
2681
|
+
/**
|
|
2682
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
2683
|
+
* intervals this adjustment applies to in a given billing period.
|
|
2684
|
+
*/
|
|
2685
|
+
percentage_discount: number;
|
|
2681
2686
|
/**
|
|
2682
2687
|
* The plan phase in which this adjustment is active.
|
|
2683
2688
|
*/
|
|
@@ -2686,13 +2691,8 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
2686
2691
|
* The reason for the adjustment.
|
|
2687
2692
|
*/
|
|
2688
2693
|
reason: string | null;
|
|
2689
|
-
/**
|
|
2690
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
2691
|
-
* to in a given billing period.
|
|
2692
|
-
*/
|
|
2693
|
-
usage_discount: number;
|
|
2694
2694
|
}
|
|
2695
|
-
interface
|
|
2695
|
+
interface PlanPhaseMinimumAdjustment {
|
|
2696
2696
|
id: string;
|
|
2697
2697
|
adjustment_type: 'minimum';
|
|
2698
2698
|
/**
|
|
@@ -2722,7 +2722,7 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
2722
2722
|
*/
|
|
2723
2723
|
reason: string | null;
|
|
2724
2724
|
}
|
|
2725
|
-
interface
|
|
2725
|
+
interface PlanPhaseMaximumAdjustment {
|
|
2726
2726
|
id: string;
|
|
2727
2727
|
adjustment_type: 'maximum';
|
|
2728
2728
|
/**
|
|
@@ -3078,7 +3078,7 @@ export interface SubscriptionSchedulePlanChangeResponse {
|
|
|
3078
3078
|
export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
3079
3079
|
interface AdjustmentInterval {
|
|
3080
3080
|
id: string;
|
|
3081
|
-
adjustment: AdjustmentInterval.
|
|
3081
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
3082
3082
|
/**
|
|
3083
3083
|
* The price interval IDs that this adjustment applies to.
|
|
3084
3084
|
*/
|
|
@@ -3093,14 +3093,9 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
3093
3093
|
start_date: string;
|
|
3094
3094
|
}
|
|
3095
3095
|
namespace AdjustmentInterval {
|
|
3096
|
-
interface
|
|
3096
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
3097
3097
|
id: string;
|
|
3098
|
-
adjustment_type: '
|
|
3099
|
-
/**
|
|
3100
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
3101
|
-
* billing period.
|
|
3102
|
-
*/
|
|
3103
|
-
amount_discount: string;
|
|
3098
|
+
adjustment_type: 'usage_discount';
|
|
3104
3099
|
/**
|
|
3105
3100
|
* The price IDs that this adjustment applies to.
|
|
3106
3101
|
*/
|
|
@@ -3118,10 +3113,20 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
3118
3113
|
* The reason for the adjustment.
|
|
3119
3114
|
*/
|
|
3120
3115
|
reason: string | null;
|
|
3116
|
+
/**
|
|
3117
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
3118
|
+
* to in a given billing period.
|
|
3119
|
+
*/
|
|
3120
|
+
usage_discount: number;
|
|
3121
3121
|
}
|
|
3122
|
-
interface
|
|
3122
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
3123
3123
|
id: string;
|
|
3124
|
-
adjustment_type: '
|
|
3124
|
+
adjustment_type: 'amount_discount';
|
|
3125
|
+
/**
|
|
3126
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
3127
|
+
* billing period.
|
|
3128
|
+
*/
|
|
3129
|
+
amount_discount: string;
|
|
3125
3130
|
/**
|
|
3126
3131
|
* The price IDs that this adjustment applies to.
|
|
3127
3132
|
*/
|
|
@@ -3131,11 +3136,6 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
3131
3136
|
* that apply to only one price.
|
|
3132
3137
|
*/
|
|
3133
3138
|
is_invoice_level: boolean;
|
|
3134
|
-
/**
|
|
3135
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
3136
|
-
* intervals this adjustment applies to in a given billing period.
|
|
3137
|
-
*/
|
|
3138
|
-
percentage_discount: number;
|
|
3139
3139
|
/**
|
|
3140
3140
|
* The plan phase in which this adjustment is active.
|
|
3141
3141
|
*/
|
|
@@ -3145,9 +3145,9 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
3145
3145
|
*/
|
|
3146
3146
|
reason: string | null;
|
|
3147
3147
|
}
|
|
3148
|
-
interface
|
|
3148
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
3149
3149
|
id: string;
|
|
3150
|
-
adjustment_type: '
|
|
3150
|
+
adjustment_type: 'percentage_discount';
|
|
3151
3151
|
/**
|
|
3152
3152
|
* The price IDs that this adjustment applies to.
|
|
3153
3153
|
*/
|
|
@@ -3157,6 +3157,11 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
3157
3157
|
* that apply to only one price.
|
|
3158
3158
|
*/
|
|
3159
3159
|
is_invoice_level: boolean;
|
|
3160
|
+
/**
|
|
3161
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
3162
|
+
* intervals this adjustment applies to in a given billing period.
|
|
3163
|
+
*/
|
|
3164
|
+
percentage_discount: number;
|
|
3160
3165
|
/**
|
|
3161
3166
|
* The plan phase in which this adjustment is active.
|
|
3162
3167
|
*/
|
|
@@ -3165,13 +3170,8 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
3165
3170
|
* The reason for the adjustment.
|
|
3166
3171
|
*/
|
|
3167
3172
|
reason: string | null;
|
|
3168
|
-
/**
|
|
3169
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
3170
|
-
* to in a given billing period.
|
|
3171
|
-
*/
|
|
3172
|
-
usage_discount: number;
|
|
3173
3173
|
}
|
|
3174
|
-
interface
|
|
3174
|
+
interface PlanPhaseMinimumAdjustment {
|
|
3175
3175
|
id: string;
|
|
3176
3176
|
adjustment_type: 'minimum';
|
|
3177
3177
|
/**
|
|
@@ -3201,7 +3201,7 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
3201
3201
|
*/
|
|
3202
3202
|
reason: string | null;
|
|
3203
3203
|
}
|
|
3204
|
-
interface
|
|
3204
|
+
interface PlanPhaseMaximumAdjustment {
|
|
3205
3205
|
id: string;
|
|
3206
3206
|
adjustment_type: 'maximum';
|
|
3207
3207
|
/**
|
|
@@ -3557,7 +3557,7 @@ export interface SubscriptionTriggerPhaseResponse {
|
|
|
3557
3557
|
export declare namespace SubscriptionTriggerPhaseResponse {
|
|
3558
3558
|
interface AdjustmentInterval {
|
|
3559
3559
|
id: string;
|
|
3560
|
-
adjustment: AdjustmentInterval.
|
|
3560
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
3561
3561
|
/**
|
|
3562
3562
|
* The price interval IDs that this adjustment applies to.
|
|
3563
3563
|
*/
|
|
@@ -3572,14 +3572,9 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
3572
3572
|
start_date: string;
|
|
3573
3573
|
}
|
|
3574
3574
|
namespace AdjustmentInterval {
|
|
3575
|
-
interface
|
|
3575
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
3576
3576
|
id: string;
|
|
3577
|
-
adjustment_type: '
|
|
3578
|
-
/**
|
|
3579
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
3580
|
-
* billing period.
|
|
3581
|
-
*/
|
|
3582
|
-
amount_discount: string;
|
|
3577
|
+
adjustment_type: 'usage_discount';
|
|
3583
3578
|
/**
|
|
3584
3579
|
* The price IDs that this adjustment applies to.
|
|
3585
3580
|
*/
|
|
@@ -3597,10 +3592,20 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
3597
3592
|
* The reason for the adjustment.
|
|
3598
3593
|
*/
|
|
3599
3594
|
reason: string | null;
|
|
3595
|
+
/**
|
|
3596
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
3597
|
+
* to in a given billing period.
|
|
3598
|
+
*/
|
|
3599
|
+
usage_discount: number;
|
|
3600
3600
|
}
|
|
3601
|
-
interface
|
|
3601
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
3602
3602
|
id: string;
|
|
3603
|
-
adjustment_type: '
|
|
3603
|
+
adjustment_type: 'amount_discount';
|
|
3604
|
+
/**
|
|
3605
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
3606
|
+
* billing period.
|
|
3607
|
+
*/
|
|
3608
|
+
amount_discount: string;
|
|
3604
3609
|
/**
|
|
3605
3610
|
* The price IDs that this adjustment applies to.
|
|
3606
3611
|
*/
|
|
@@ -3610,11 +3615,6 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
3610
3615
|
* that apply to only one price.
|
|
3611
3616
|
*/
|
|
3612
3617
|
is_invoice_level: boolean;
|
|
3613
|
-
/**
|
|
3614
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
3615
|
-
* intervals this adjustment applies to in a given billing period.
|
|
3616
|
-
*/
|
|
3617
|
-
percentage_discount: number;
|
|
3618
3618
|
/**
|
|
3619
3619
|
* The plan phase in which this adjustment is active.
|
|
3620
3620
|
*/
|
|
@@ -3624,9 +3624,9 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
3624
3624
|
*/
|
|
3625
3625
|
reason: string | null;
|
|
3626
3626
|
}
|
|
3627
|
-
interface
|
|
3627
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
3628
3628
|
id: string;
|
|
3629
|
-
adjustment_type: '
|
|
3629
|
+
adjustment_type: 'percentage_discount';
|
|
3630
3630
|
/**
|
|
3631
3631
|
* The price IDs that this adjustment applies to.
|
|
3632
3632
|
*/
|
|
@@ -3636,6 +3636,11 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
3636
3636
|
* that apply to only one price.
|
|
3637
3637
|
*/
|
|
3638
3638
|
is_invoice_level: boolean;
|
|
3639
|
+
/**
|
|
3640
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
3641
|
+
* intervals this adjustment applies to in a given billing period.
|
|
3642
|
+
*/
|
|
3643
|
+
percentage_discount: number;
|
|
3639
3644
|
/**
|
|
3640
3645
|
* The plan phase in which this adjustment is active.
|
|
3641
3646
|
*/
|
|
@@ -3644,13 +3649,8 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
3644
3649
|
* The reason for the adjustment.
|
|
3645
3650
|
*/
|
|
3646
3651
|
reason: string | null;
|
|
3647
|
-
/**
|
|
3648
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
3649
|
-
* to in a given billing period.
|
|
3650
|
-
*/
|
|
3651
|
-
usage_discount: number;
|
|
3652
3652
|
}
|
|
3653
|
-
interface
|
|
3653
|
+
interface PlanPhaseMinimumAdjustment {
|
|
3654
3654
|
id: string;
|
|
3655
3655
|
adjustment_type: 'minimum';
|
|
3656
3656
|
/**
|
|
@@ -3680,7 +3680,7 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
3680
3680
|
*/
|
|
3681
3681
|
reason: string | null;
|
|
3682
3682
|
}
|
|
3683
|
-
interface
|
|
3683
|
+
interface PlanPhaseMaximumAdjustment {
|
|
3684
3684
|
id: string;
|
|
3685
3685
|
adjustment_type: 'maximum';
|
|
3686
3686
|
/**
|
|
@@ -4036,7 +4036,7 @@ export interface SubscriptionUnscheduleCancellationResponse {
|
|
|
4036
4036
|
export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
4037
4037
|
interface AdjustmentInterval {
|
|
4038
4038
|
id: string;
|
|
4039
|
-
adjustment: AdjustmentInterval.
|
|
4039
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
4040
4040
|
/**
|
|
4041
4041
|
* The price interval IDs that this adjustment applies to.
|
|
4042
4042
|
*/
|
|
@@ -4051,14 +4051,9 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
4051
4051
|
start_date: string;
|
|
4052
4052
|
}
|
|
4053
4053
|
namespace AdjustmentInterval {
|
|
4054
|
-
interface
|
|
4054
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
4055
4055
|
id: string;
|
|
4056
|
-
adjustment_type: '
|
|
4057
|
-
/**
|
|
4058
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
4059
|
-
* billing period.
|
|
4060
|
-
*/
|
|
4061
|
-
amount_discount: string;
|
|
4056
|
+
adjustment_type: 'usage_discount';
|
|
4062
4057
|
/**
|
|
4063
4058
|
* The price IDs that this adjustment applies to.
|
|
4064
4059
|
*/
|
|
@@ -4076,10 +4071,20 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
4076
4071
|
* The reason for the adjustment.
|
|
4077
4072
|
*/
|
|
4078
4073
|
reason: string | null;
|
|
4074
|
+
/**
|
|
4075
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
4076
|
+
* to in a given billing period.
|
|
4077
|
+
*/
|
|
4078
|
+
usage_discount: number;
|
|
4079
4079
|
}
|
|
4080
|
-
interface
|
|
4080
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
4081
4081
|
id: string;
|
|
4082
|
-
adjustment_type: '
|
|
4082
|
+
adjustment_type: 'amount_discount';
|
|
4083
|
+
/**
|
|
4084
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
4085
|
+
* billing period.
|
|
4086
|
+
*/
|
|
4087
|
+
amount_discount: string;
|
|
4083
4088
|
/**
|
|
4084
4089
|
* The price IDs that this adjustment applies to.
|
|
4085
4090
|
*/
|
|
@@ -4089,11 +4094,6 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
4089
4094
|
* that apply to only one price.
|
|
4090
4095
|
*/
|
|
4091
4096
|
is_invoice_level: boolean;
|
|
4092
|
-
/**
|
|
4093
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
4094
|
-
* intervals this adjustment applies to in a given billing period.
|
|
4095
|
-
*/
|
|
4096
|
-
percentage_discount: number;
|
|
4097
4097
|
/**
|
|
4098
4098
|
* The plan phase in which this adjustment is active.
|
|
4099
4099
|
*/
|
|
@@ -4103,9 +4103,9 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
4103
4103
|
*/
|
|
4104
4104
|
reason: string | null;
|
|
4105
4105
|
}
|
|
4106
|
-
interface
|
|
4106
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
4107
4107
|
id: string;
|
|
4108
|
-
adjustment_type: '
|
|
4108
|
+
adjustment_type: 'percentage_discount';
|
|
4109
4109
|
/**
|
|
4110
4110
|
* The price IDs that this adjustment applies to.
|
|
4111
4111
|
*/
|
|
@@ -4115,6 +4115,11 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
4115
4115
|
* that apply to only one price.
|
|
4116
4116
|
*/
|
|
4117
4117
|
is_invoice_level: boolean;
|
|
4118
|
+
/**
|
|
4119
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
4120
|
+
* intervals this adjustment applies to in a given billing period.
|
|
4121
|
+
*/
|
|
4122
|
+
percentage_discount: number;
|
|
4118
4123
|
/**
|
|
4119
4124
|
* The plan phase in which this adjustment is active.
|
|
4120
4125
|
*/
|
|
@@ -4123,13 +4128,8 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
4123
4128
|
* The reason for the adjustment.
|
|
4124
4129
|
*/
|
|
4125
4130
|
reason: string | null;
|
|
4126
|
-
/**
|
|
4127
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
4128
|
-
* to in a given billing period.
|
|
4129
|
-
*/
|
|
4130
|
-
usage_discount: number;
|
|
4131
4131
|
}
|
|
4132
|
-
interface
|
|
4132
|
+
interface PlanPhaseMinimumAdjustment {
|
|
4133
4133
|
id: string;
|
|
4134
4134
|
adjustment_type: 'minimum';
|
|
4135
4135
|
/**
|
|
@@ -4159,7 +4159,7 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
4159
4159
|
*/
|
|
4160
4160
|
reason: string | null;
|
|
4161
4161
|
}
|
|
4162
|
-
interface
|
|
4162
|
+
interface PlanPhaseMaximumAdjustment {
|
|
4163
4163
|
id: string;
|
|
4164
4164
|
adjustment_type: 'maximum';
|
|
4165
4165
|
/**
|
|
@@ -4515,7 +4515,7 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4515
4515
|
export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
4516
4516
|
interface AdjustmentInterval {
|
|
4517
4517
|
id: string;
|
|
4518
|
-
adjustment: AdjustmentInterval.
|
|
4518
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
4519
4519
|
/**
|
|
4520
4520
|
* The price interval IDs that this adjustment applies to.
|
|
4521
4521
|
*/
|
|
@@ -4530,14 +4530,9 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4530
4530
|
start_date: string;
|
|
4531
4531
|
}
|
|
4532
4532
|
namespace AdjustmentInterval {
|
|
4533
|
-
interface
|
|
4533
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
4534
4534
|
id: string;
|
|
4535
|
-
adjustment_type: '
|
|
4536
|
-
/**
|
|
4537
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
4538
|
-
* billing period.
|
|
4539
|
-
*/
|
|
4540
|
-
amount_discount: string;
|
|
4535
|
+
adjustment_type: 'usage_discount';
|
|
4541
4536
|
/**
|
|
4542
4537
|
* The price IDs that this adjustment applies to.
|
|
4543
4538
|
*/
|
|
@@ -4555,10 +4550,20 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4555
4550
|
* The reason for the adjustment.
|
|
4556
4551
|
*/
|
|
4557
4552
|
reason: string | null;
|
|
4553
|
+
/**
|
|
4554
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
4555
|
+
* to in a given billing period.
|
|
4556
|
+
*/
|
|
4557
|
+
usage_discount: number;
|
|
4558
4558
|
}
|
|
4559
|
-
interface
|
|
4559
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
4560
4560
|
id: string;
|
|
4561
|
-
adjustment_type: '
|
|
4561
|
+
adjustment_type: 'amount_discount';
|
|
4562
|
+
/**
|
|
4563
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
4564
|
+
* billing period.
|
|
4565
|
+
*/
|
|
4566
|
+
amount_discount: string;
|
|
4562
4567
|
/**
|
|
4563
4568
|
* The price IDs that this adjustment applies to.
|
|
4564
4569
|
*/
|
|
@@ -4568,11 +4573,6 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4568
4573
|
* that apply to only one price.
|
|
4569
4574
|
*/
|
|
4570
4575
|
is_invoice_level: boolean;
|
|
4571
|
-
/**
|
|
4572
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
4573
|
-
* intervals this adjustment applies to in a given billing period.
|
|
4574
|
-
*/
|
|
4575
|
-
percentage_discount: number;
|
|
4576
4576
|
/**
|
|
4577
4577
|
* The plan phase in which this adjustment is active.
|
|
4578
4578
|
*/
|
|
@@ -4582,9 +4582,9 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4582
4582
|
*/
|
|
4583
4583
|
reason: string | null;
|
|
4584
4584
|
}
|
|
4585
|
-
interface
|
|
4585
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
4586
4586
|
id: string;
|
|
4587
|
-
adjustment_type: '
|
|
4587
|
+
adjustment_type: 'percentage_discount';
|
|
4588
4588
|
/**
|
|
4589
4589
|
* The price IDs that this adjustment applies to.
|
|
4590
4590
|
*/
|
|
@@ -4594,6 +4594,11 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4594
4594
|
* that apply to only one price.
|
|
4595
4595
|
*/
|
|
4596
4596
|
is_invoice_level: boolean;
|
|
4597
|
+
/**
|
|
4598
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
4599
|
+
* intervals this adjustment applies to in a given billing period.
|
|
4600
|
+
*/
|
|
4601
|
+
percentage_discount: number;
|
|
4597
4602
|
/**
|
|
4598
4603
|
* The plan phase in which this adjustment is active.
|
|
4599
4604
|
*/
|
|
@@ -4602,13 +4607,8 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4602
4607
|
* The reason for the adjustment.
|
|
4603
4608
|
*/
|
|
4604
4609
|
reason: string | null;
|
|
4605
|
-
/**
|
|
4606
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
4607
|
-
* to in a given billing period.
|
|
4608
|
-
*/
|
|
4609
|
-
usage_discount: number;
|
|
4610
4610
|
}
|
|
4611
|
-
interface
|
|
4611
|
+
interface PlanPhaseMinimumAdjustment {
|
|
4612
4612
|
id: string;
|
|
4613
4613
|
adjustment_type: 'minimum';
|
|
4614
4614
|
/**
|
|
@@ -4638,7 +4638,7 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
4638
4638
|
*/
|
|
4639
4639
|
reason: string | null;
|
|
4640
4640
|
}
|
|
4641
|
-
interface
|
|
4641
|
+
interface PlanPhaseMaximumAdjustment {
|
|
4642
4642
|
id: string;
|
|
4643
4643
|
adjustment_type: 'maximum';
|
|
4644
4644
|
/**
|
|
@@ -4994,7 +4994,7 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
4994
4994
|
export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
4995
4995
|
interface AdjustmentInterval {
|
|
4996
4996
|
id: string;
|
|
4997
|
-
adjustment: AdjustmentInterval.
|
|
4997
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
4998
4998
|
/**
|
|
4999
4999
|
* The price interval IDs that this adjustment applies to.
|
|
5000
5000
|
*/
|
|
@@ -5009,14 +5009,9 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
5009
5009
|
start_date: string;
|
|
5010
5010
|
}
|
|
5011
5011
|
namespace AdjustmentInterval {
|
|
5012
|
-
interface
|
|
5012
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
5013
5013
|
id: string;
|
|
5014
|
-
adjustment_type: '
|
|
5015
|
-
/**
|
|
5016
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
5017
|
-
* billing period.
|
|
5018
|
-
*/
|
|
5019
|
-
amount_discount: string;
|
|
5014
|
+
adjustment_type: 'usage_discount';
|
|
5020
5015
|
/**
|
|
5021
5016
|
* The price IDs that this adjustment applies to.
|
|
5022
5017
|
*/
|
|
@@ -5034,10 +5029,20 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
5034
5029
|
* The reason for the adjustment.
|
|
5035
5030
|
*/
|
|
5036
5031
|
reason: string | null;
|
|
5032
|
+
/**
|
|
5033
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
5034
|
+
* to in a given billing period.
|
|
5035
|
+
*/
|
|
5036
|
+
usage_discount: number;
|
|
5037
5037
|
}
|
|
5038
|
-
interface
|
|
5038
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
5039
5039
|
id: string;
|
|
5040
|
-
adjustment_type: '
|
|
5040
|
+
adjustment_type: 'amount_discount';
|
|
5041
|
+
/**
|
|
5042
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
5043
|
+
* billing period.
|
|
5044
|
+
*/
|
|
5045
|
+
amount_discount: string;
|
|
5041
5046
|
/**
|
|
5042
5047
|
* The price IDs that this adjustment applies to.
|
|
5043
5048
|
*/
|
|
@@ -5047,11 +5052,6 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
5047
5052
|
* that apply to only one price.
|
|
5048
5053
|
*/
|
|
5049
5054
|
is_invoice_level: boolean;
|
|
5050
|
-
/**
|
|
5051
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
5052
|
-
* intervals this adjustment applies to in a given billing period.
|
|
5053
|
-
*/
|
|
5054
|
-
percentage_discount: number;
|
|
5055
5055
|
/**
|
|
5056
5056
|
* The plan phase in which this adjustment is active.
|
|
5057
5057
|
*/
|
|
@@ -5061,9 +5061,9 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
5061
5061
|
*/
|
|
5062
5062
|
reason: string | null;
|
|
5063
5063
|
}
|
|
5064
|
-
interface
|
|
5064
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
5065
5065
|
id: string;
|
|
5066
|
-
adjustment_type: '
|
|
5066
|
+
adjustment_type: 'percentage_discount';
|
|
5067
5067
|
/**
|
|
5068
5068
|
* The price IDs that this adjustment applies to.
|
|
5069
5069
|
*/
|
|
@@ -5073,6 +5073,11 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
5073
5073
|
* that apply to only one price.
|
|
5074
5074
|
*/
|
|
5075
5075
|
is_invoice_level: boolean;
|
|
5076
|
+
/**
|
|
5077
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
5078
|
+
* intervals this adjustment applies to in a given billing period.
|
|
5079
|
+
*/
|
|
5080
|
+
percentage_discount: number;
|
|
5076
5081
|
/**
|
|
5077
5082
|
* The plan phase in which this adjustment is active.
|
|
5078
5083
|
*/
|
|
@@ -5081,13 +5086,8 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
5081
5086
|
* The reason for the adjustment.
|
|
5082
5087
|
*/
|
|
5083
5088
|
reason: string | null;
|
|
5084
|
-
/**
|
|
5085
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
5086
|
-
* to in a given billing period.
|
|
5087
|
-
*/
|
|
5088
|
-
usage_discount: number;
|
|
5089
5089
|
}
|
|
5090
|
-
interface
|
|
5090
|
+
interface PlanPhaseMinimumAdjustment {
|
|
5091
5091
|
id: string;
|
|
5092
5092
|
adjustment_type: 'minimum';
|
|
5093
5093
|
/**
|
|
@@ -5117,7 +5117,7 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
5117
5117
|
*/
|
|
5118
5118
|
reason: string | null;
|
|
5119
5119
|
}
|
|
5120
|
-
interface
|
|
5120
|
+
interface PlanPhaseMaximumAdjustment {
|
|
5121
5121
|
id: string;
|
|
5122
5122
|
adjustment_type: 'maximum';
|
|
5123
5123
|
/**
|
|
@@ -5473,7 +5473,7 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5473
5473
|
export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
5474
5474
|
interface AdjustmentInterval {
|
|
5475
5475
|
id: string;
|
|
5476
|
-
adjustment: AdjustmentInterval.
|
|
5476
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
5477
5477
|
/**
|
|
5478
5478
|
* The price interval IDs that this adjustment applies to.
|
|
5479
5479
|
*/
|
|
@@ -5488,14 +5488,9 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5488
5488
|
start_date: string;
|
|
5489
5489
|
}
|
|
5490
5490
|
namespace AdjustmentInterval {
|
|
5491
|
-
interface
|
|
5491
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
5492
5492
|
id: string;
|
|
5493
|
-
adjustment_type: '
|
|
5494
|
-
/**
|
|
5495
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
5496
|
-
* billing period.
|
|
5497
|
-
*/
|
|
5498
|
-
amount_discount: string;
|
|
5493
|
+
adjustment_type: 'usage_discount';
|
|
5499
5494
|
/**
|
|
5500
5495
|
* The price IDs that this adjustment applies to.
|
|
5501
5496
|
*/
|
|
@@ -5513,10 +5508,20 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5513
5508
|
* The reason for the adjustment.
|
|
5514
5509
|
*/
|
|
5515
5510
|
reason: string | null;
|
|
5511
|
+
/**
|
|
5512
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
5513
|
+
* to in a given billing period.
|
|
5514
|
+
*/
|
|
5515
|
+
usage_discount: number;
|
|
5516
5516
|
}
|
|
5517
|
-
interface
|
|
5517
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
5518
5518
|
id: string;
|
|
5519
|
-
adjustment_type: '
|
|
5519
|
+
adjustment_type: 'amount_discount';
|
|
5520
|
+
/**
|
|
5521
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
5522
|
+
* billing period.
|
|
5523
|
+
*/
|
|
5524
|
+
amount_discount: string;
|
|
5520
5525
|
/**
|
|
5521
5526
|
* The price IDs that this adjustment applies to.
|
|
5522
5527
|
*/
|
|
@@ -5526,11 +5531,6 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5526
5531
|
* that apply to only one price.
|
|
5527
5532
|
*/
|
|
5528
5533
|
is_invoice_level: boolean;
|
|
5529
|
-
/**
|
|
5530
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
5531
|
-
* intervals this adjustment applies to in a given billing period.
|
|
5532
|
-
*/
|
|
5533
|
-
percentage_discount: number;
|
|
5534
5534
|
/**
|
|
5535
5535
|
* The plan phase in which this adjustment is active.
|
|
5536
5536
|
*/
|
|
@@ -5540,9 +5540,9 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5540
5540
|
*/
|
|
5541
5541
|
reason: string | null;
|
|
5542
5542
|
}
|
|
5543
|
-
interface
|
|
5543
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
5544
5544
|
id: string;
|
|
5545
|
-
adjustment_type: '
|
|
5545
|
+
adjustment_type: 'percentage_discount';
|
|
5546
5546
|
/**
|
|
5547
5547
|
* The price IDs that this adjustment applies to.
|
|
5548
5548
|
*/
|
|
@@ -5552,6 +5552,11 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5552
5552
|
* that apply to only one price.
|
|
5553
5553
|
*/
|
|
5554
5554
|
is_invoice_level: boolean;
|
|
5555
|
+
/**
|
|
5556
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
5557
|
+
* intervals this adjustment applies to in a given billing period.
|
|
5558
|
+
*/
|
|
5559
|
+
percentage_discount: number;
|
|
5555
5560
|
/**
|
|
5556
5561
|
* The plan phase in which this adjustment is active.
|
|
5557
5562
|
*/
|
|
@@ -5560,13 +5565,8 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5560
5565
|
* The reason for the adjustment.
|
|
5561
5566
|
*/
|
|
5562
5567
|
reason: string | null;
|
|
5563
|
-
/**
|
|
5564
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
5565
|
-
* to in a given billing period.
|
|
5566
|
-
*/
|
|
5567
|
-
usage_discount: number;
|
|
5568
5568
|
}
|
|
5569
|
-
interface
|
|
5569
|
+
interface PlanPhaseMinimumAdjustment {
|
|
5570
5570
|
id: string;
|
|
5571
5571
|
adjustment_type: 'minimum';
|
|
5572
5572
|
/**
|
|
@@ -5596,7 +5596,7 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
5596
5596
|
*/
|
|
5597
5597
|
reason: string | null;
|
|
5598
5598
|
}
|
|
5599
|
-
interface
|
|
5599
|
+
interface PlanPhaseMaximumAdjustment {
|
|
5600
5600
|
id: string;
|
|
5601
5601
|
adjustment_type: 'maximum';
|
|
5602
5602
|
/**
|
|
@@ -5952,7 +5952,7 @@ export interface SubscriptionUpdateTrialResponse {
|
|
|
5952
5952
|
export declare namespace SubscriptionUpdateTrialResponse {
|
|
5953
5953
|
interface AdjustmentInterval {
|
|
5954
5954
|
id: string;
|
|
5955
|
-
adjustment: AdjustmentInterval.
|
|
5955
|
+
adjustment: AdjustmentInterval.PlanPhaseUsageDiscountAdjustment | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment | AdjustmentInterval.PlanPhaseMinimumAdjustment | AdjustmentInterval.PlanPhaseMaximumAdjustment;
|
|
5956
5956
|
/**
|
|
5957
5957
|
* The price interval IDs that this adjustment applies to.
|
|
5958
5958
|
*/
|
|
@@ -5967,14 +5967,9 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
5967
5967
|
start_date: string;
|
|
5968
5968
|
}
|
|
5969
5969
|
namespace AdjustmentInterval {
|
|
5970
|
-
interface
|
|
5970
|
+
interface PlanPhaseUsageDiscountAdjustment {
|
|
5971
5971
|
id: string;
|
|
5972
|
-
adjustment_type: '
|
|
5973
|
-
/**
|
|
5974
|
-
* The amount by which to discount the prices this adjustment applies to in a given
|
|
5975
|
-
* billing period.
|
|
5976
|
-
*/
|
|
5977
|
-
amount_discount: string;
|
|
5972
|
+
adjustment_type: 'usage_discount';
|
|
5978
5973
|
/**
|
|
5979
5974
|
* The price IDs that this adjustment applies to.
|
|
5980
5975
|
*/
|
|
@@ -5992,10 +5987,20 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
5992
5987
|
* The reason for the adjustment.
|
|
5993
5988
|
*/
|
|
5994
5989
|
reason: string | null;
|
|
5990
|
+
/**
|
|
5991
|
+
* The number of usage units by which to discount the price this adjustment applies
|
|
5992
|
+
* to in a given billing period.
|
|
5993
|
+
*/
|
|
5994
|
+
usage_discount: number;
|
|
5995
5995
|
}
|
|
5996
|
-
interface
|
|
5996
|
+
interface PlanPhaseAmountDiscountAdjustment {
|
|
5997
5997
|
id: string;
|
|
5998
|
-
adjustment_type: '
|
|
5998
|
+
adjustment_type: 'amount_discount';
|
|
5999
|
+
/**
|
|
6000
|
+
* The amount by which to discount the prices this adjustment applies to in a given
|
|
6001
|
+
* billing period.
|
|
6002
|
+
*/
|
|
6003
|
+
amount_discount: string;
|
|
5999
6004
|
/**
|
|
6000
6005
|
* The price IDs that this adjustment applies to.
|
|
6001
6006
|
*/
|
|
@@ -6005,11 +6010,6 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
6005
6010
|
* that apply to only one price.
|
|
6006
6011
|
*/
|
|
6007
6012
|
is_invoice_level: boolean;
|
|
6008
|
-
/**
|
|
6009
|
-
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
6010
|
-
* intervals this adjustment applies to in a given billing period.
|
|
6011
|
-
*/
|
|
6012
|
-
percentage_discount: number;
|
|
6013
6013
|
/**
|
|
6014
6014
|
* The plan phase in which this adjustment is active.
|
|
6015
6015
|
*/
|
|
@@ -6019,9 +6019,9 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
6019
6019
|
*/
|
|
6020
6020
|
reason: string | null;
|
|
6021
6021
|
}
|
|
6022
|
-
interface
|
|
6022
|
+
interface PlanPhasePercentageDiscountAdjustment {
|
|
6023
6023
|
id: string;
|
|
6024
|
-
adjustment_type: '
|
|
6024
|
+
adjustment_type: 'percentage_discount';
|
|
6025
6025
|
/**
|
|
6026
6026
|
* The price IDs that this adjustment applies to.
|
|
6027
6027
|
*/
|
|
@@ -6031,6 +6031,11 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
6031
6031
|
* that apply to only one price.
|
|
6032
6032
|
*/
|
|
6033
6033
|
is_invoice_level: boolean;
|
|
6034
|
+
/**
|
|
6035
|
+
* The percentage (as a value between 0 and 1) by which to discount the price
|
|
6036
|
+
* intervals this adjustment applies to in a given billing period.
|
|
6037
|
+
*/
|
|
6038
|
+
percentage_discount: number;
|
|
6034
6039
|
/**
|
|
6035
6040
|
* The plan phase in which this adjustment is active.
|
|
6036
6041
|
*/
|
|
@@ -6039,13 +6044,8 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
6039
6044
|
* The reason for the adjustment.
|
|
6040
6045
|
*/
|
|
6041
6046
|
reason: string | null;
|
|
6042
|
-
/**
|
|
6043
|
-
* The number of usage units by which to discount the price this adjustment applies
|
|
6044
|
-
* to in a given billing period.
|
|
6045
|
-
*/
|
|
6046
|
-
usage_discount: number;
|
|
6047
6047
|
}
|
|
6048
|
-
interface
|
|
6048
|
+
interface PlanPhaseMinimumAdjustment {
|
|
6049
6049
|
id: string;
|
|
6050
6050
|
adjustment_type: 'minimum';
|
|
6051
6051
|
/**
|
|
@@ -6075,7 +6075,7 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
6075
6075
|
*/
|
|
6076
6076
|
reason: string | null;
|
|
6077
6077
|
}
|
|
6078
|
-
interface
|
|
6078
|
+
interface PlanPhaseMaximumAdjustment {
|
|
6079
6079
|
id: string;
|
|
6080
6080
|
adjustment_type: 'maximum';
|
|
6081
6081
|
/**
|
|
@@ -6436,8 +6436,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
6436
6436
|
adjustment: AddAdjustment.NewPercentageDiscount | AddAdjustment.NewUsageDiscount | AddAdjustment.NewAmountDiscount | AddAdjustment.NewMinimum | AddAdjustment.NewMaximum;
|
|
6437
6437
|
/**
|
|
6438
6438
|
* The end date of the adjustment interval. This is the date that the adjustment
|
|
6439
|
-
* will stop affecting prices on the subscription.
|
|
6440
|
-
* start when the phase or subscription starts.
|
|
6439
|
+
* will stop affecting prices on the subscription.
|
|
6441
6440
|
*/
|
|
6442
6441
|
end_date?: string | null;
|
|
6443
6442
|
/**
|
|
@@ -10787,7 +10786,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
10787
10786
|
/**
|
|
10788
10787
|
* The definition of a new price to create and add to the subscription.
|
|
10789
10788
|
*/
|
|
10790
|
-
price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingMaxGroupTieredPackagePrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | null;
|
|
10789
|
+
price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingMaxGroupTieredPackagePrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | Add.NewFloatingScalableMatrixWithUnitPricingPrice | Add.NewFloatingScalableMatrixWithTieredPricingPrice | null;
|
|
10791
10790
|
/**
|
|
10792
10791
|
* The id of the price to add to the subscription.
|
|
10793
10792
|
*/
|
|
@@ -13352,6 +13351,192 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
13352
13351
|
duration_unit: 'day' | 'month';
|
|
13353
13352
|
}
|
|
13354
13353
|
}
|
|
13354
|
+
interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
13355
|
+
/**
|
|
13356
|
+
* The cadence to bill for this price on.
|
|
13357
|
+
*/
|
|
13358
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
13359
|
+
/**
|
|
13360
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
13361
|
+
*/
|
|
13362
|
+
currency: string;
|
|
13363
|
+
/**
|
|
13364
|
+
* The id of the item the plan will be associated with.
|
|
13365
|
+
*/
|
|
13366
|
+
item_id: string;
|
|
13367
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
13368
|
+
/**
|
|
13369
|
+
* The name of the price.
|
|
13370
|
+
*/
|
|
13371
|
+
name: string;
|
|
13372
|
+
scalable_matrix_with_unit_pricing_config: Record<string, unknown>;
|
|
13373
|
+
/**
|
|
13374
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
13375
|
+
* usage-based.
|
|
13376
|
+
*/
|
|
13377
|
+
billable_metric_id?: string | null;
|
|
13378
|
+
/**
|
|
13379
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
13380
|
+
* this is true, and in-arrears if this is false.
|
|
13381
|
+
*/
|
|
13382
|
+
billed_in_advance?: boolean | null;
|
|
13383
|
+
/**
|
|
13384
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
13385
|
+
* months.
|
|
13386
|
+
*/
|
|
13387
|
+
billing_cycle_configuration?: NewFloatingScalableMatrixWithUnitPricingPrice.BillingCycleConfiguration | null;
|
|
13388
|
+
/**
|
|
13389
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
13390
|
+
*/
|
|
13391
|
+
conversion_rate?: number | null;
|
|
13392
|
+
/**
|
|
13393
|
+
* An alias for the price.
|
|
13394
|
+
*/
|
|
13395
|
+
external_price_id?: string | null;
|
|
13396
|
+
/**
|
|
13397
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
13398
|
+
* applied.
|
|
13399
|
+
*/
|
|
13400
|
+
fixed_price_quantity?: number | null;
|
|
13401
|
+
/**
|
|
13402
|
+
* The property used to group this price on an invoice
|
|
13403
|
+
*/
|
|
13404
|
+
invoice_grouping_key?: string | null;
|
|
13405
|
+
/**
|
|
13406
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
13407
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
13408
|
+
*/
|
|
13409
|
+
invoicing_cycle_configuration?: NewFloatingScalableMatrixWithUnitPricingPrice.InvoicingCycleConfiguration | null;
|
|
13410
|
+
/**
|
|
13411
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
13412
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
13413
|
+
* by setting `metadata` to `null`.
|
|
13414
|
+
*/
|
|
13415
|
+
metadata?: Record<string, string | null> | null;
|
|
13416
|
+
}
|
|
13417
|
+
namespace NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
13418
|
+
/**
|
|
13419
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
13420
|
+
* months.
|
|
13421
|
+
*/
|
|
13422
|
+
interface BillingCycleConfiguration {
|
|
13423
|
+
/**
|
|
13424
|
+
* The duration of the billing period.
|
|
13425
|
+
*/
|
|
13426
|
+
duration: number;
|
|
13427
|
+
/**
|
|
13428
|
+
* The unit of billing period duration.
|
|
13429
|
+
*/
|
|
13430
|
+
duration_unit: 'day' | 'month';
|
|
13431
|
+
}
|
|
13432
|
+
/**
|
|
13433
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
13434
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
13435
|
+
*/
|
|
13436
|
+
interface InvoicingCycleConfiguration {
|
|
13437
|
+
/**
|
|
13438
|
+
* The duration of the billing period.
|
|
13439
|
+
*/
|
|
13440
|
+
duration: number;
|
|
13441
|
+
/**
|
|
13442
|
+
* The unit of billing period duration.
|
|
13443
|
+
*/
|
|
13444
|
+
duration_unit: 'day' | 'month';
|
|
13445
|
+
}
|
|
13446
|
+
}
|
|
13447
|
+
interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
13448
|
+
/**
|
|
13449
|
+
* The cadence to bill for this price on.
|
|
13450
|
+
*/
|
|
13451
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
13452
|
+
/**
|
|
13453
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
13454
|
+
*/
|
|
13455
|
+
currency: string;
|
|
13456
|
+
/**
|
|
13457
|
+
* The id of the item the plan will be associated with.
|
|
13458
|
+
*/
|
|
13459
|
+
item_id: string;
|
|
13460
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
13461
|
+
/**
|
|
13462
|
+
* The name of the price.
|
|
13463
|
+
*/
|
|
13464
|
+
name: string;
|
|
13465
|
+
scalable_matrix_with_tiered_pricing_config: Record<string, unknown>;
|
|
13466
|
+
/**
|
|
13467
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
13468
|
+
* usage-based.
|
|
13469
|
+
*/
|
|
13470
|
+
billable_metric_id?: string | null;
|
|
13471
|
+
/**
|
|
13472
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
13473
|
+
* this is true, and in-arrears if this is false.
|
|
13474
|
+
*/
|
|
13475
|
+
billed_in_advance?: boolean | null;
|
|
13476
|
+
/**
|
|
13477
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
13478
|
+
* months.
|
|
13479
|
+
*/
|
|
13480
|
+
billing_cycle_configuration?: NewFloatingScalableMatrixWithTieredPricingPrice.BillingCycleConfiguration | null;
|
|
13481
|
+
/**
|
|
13482
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
13483
|
+
*/
|
|
13484
|
+
conversion_rate?: number | null;
|
|
13485
|
+
/**
|
|
13486
|
+
* An alias for the price.
|
|
13487
|
+
*/
|
|
13488
|
+
external_price_id?: string | null;
|
|
13489
|
+
/**
|
|
13490
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
13491
|
+
* applied.
|
|
13492
|
+
*/
|
|
13493
|
+
fixed_price_quantity?: number | null;
|
|
13494
|
+
/**
|
|
13495
|
+
* The property used to group this price on an invoice
|
|
13496
|
+
*/
|
|
13497
|
+
invoice_grouping_key?: string | null;
|
|
13498
|
+
/**
|
|
13499
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
13500
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
13501
|
+
*/
|
|
13502
|
+
invoicing_cycle_configuration?: NewFloatingScalableMatrixWithTieredPricingPrice.InvoicingCycleConfiguration | null;
|
|
13503
|
+
/**
|
|
13504
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
13505
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
13506
|
+
* by setting `metadata` to `null`.
|
|
13507
|
+
*/
|
|
13508
|
+
metadata?: Record<string, string | null> | null;
|
|
13509
|
+
}
|
|
13510
|
+
namespace NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
13511
|
+
/**
|
|
13512
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
13513
|
+
* months.
|
|
13514
|
+
*/
|
|
13515
|
+
interface BillingCycleConfiguration {
|
|
13516
|
+
/**
|
|
13517
|
+
* The duration of the billing period.
|
|
13518
|
+
*/
|
|
13519
|
+
duration: number;
|
|
13520
|
+
/**
|
|
13521
|
+
* The unit of billing period duration.
|
|
13522
|
+
*/
|
|
13523
|
+
duration_unit: 'day' | 'month';
|
|
13524
|
+
}
|
|
13525
|
+
/**
|
|
13526
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
13527
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
13528
|
+
*/
|
|
13529
|
+
interface InvoicingCycleConfiguration {
|
|
13530
|
+
/**
|
|
13531
|
+
* The duration of the billing period.
|
|
13532
|
+
*/
|
|
13533
|
+
duration: number;
|
|
13534
|
+
/**
|
|
13535
|
+
* The unit of billing period duration.
|
|
13536
|
+
*/
|
|
13537
|
+
duration_unit: 'day' | 'month';
|
|
13538
|
+
}
|
|
13539
|
+
}
|
|
13355
13540
|
}
|
|
13356
13541
|
interface AddAdjustment {
|
|
13357
13542
|
/**
|
|
@@ -13624,8 +13809,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
13624
13809
|
adjustment: AddAdjustment.NewPercentageDiscount | AddAdjustment.NewUsageDiscount | AddAdjustment.NewAmountDiscount | AddAdjustment.NewMinimum | AddAdjustment.NewMaximum;
|
|
13625
13810
|
/**
|
|
13626
13811
|
* The end date of the adjustment interval. This is the date that the adjustment
|
|
13627
|
-
* will stop affecting prices on the subscription.
|
|
13628
|
-
* start when the phase or subscription starts.
|
|
13812
|
+
* will stop affecting prices on the subscription.
|
|
13629
13813
|
*/
|
|
13630
13814
|
end_date?: string | null;
|
|
13631
13815
|
/**
|