orb-billing 5.5.1 → 5.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/index.d.mts +4 -13
- package/index.d.ts +4 -13
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/index.mjs.map +1 -1
- package/package.json +4 -1
- package/resources/alerts.d.ts +1 -1
- package/resources/beta/beta.d.ts +168 -2
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/external-plan-id.d.ts +168 -2
- package/resources/beta/external-plan-id.d.ts.map +1 -1
- package/resources/customers/balance-transactions.d.ts +2 -2
- package/resources/customers/balance-transactions.d.ts.map +1 -1
- package/resources/customers/balance-transactions.js.map +1 -1
- package/resources/customers/balance-transactions.mjs.map +1 -1
- package/resources/customers/credits/ledger.d.ts +22 -8
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/customers.d.ts +27 -0
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.js +1 -1
- package/resources/dimensional-price-groups/dimensional-price-groups.mjs +1 -1
- package/resources/events/backfills.d.ts +2 -2
- package/resources/events/backfills.js +2 -2
- package/resources/events/backfills.mjs +2 -2
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +1 -1
- package/resources/invoices.d.ts +36 -11
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +4 -4
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +4 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/plans/plans.d.ts +84 -1
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/prices.d.ts +262 -166
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/shared.d.ts +216 -615
- package/resources/shared.d.ts.map +1 -1
- package/resources/shared.js.map +1 -1
- package/resources/shared.mjs.map +1 -1
- package/resources/subscriptions.d.ts +460 -192
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/index.ts +5 -17
- package/src/resources/alerts.ts +1 -1
- package/src/resources/beta/beta.ts +198 -6
- package/src/resources/beta/external-plan-id.ts +198 -6
- package/src/resources/customers/balance-transactions.ts +4 -2
- package/src/resources/customers/credits/ledger.ts +24 -8
- package/src/resources/customers/customers.ts +31 -0
- package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +1 -1
- package/src/resources/events/backfills.ts +2 -2
- package/src/resources/index.ts +1 -3
- package/src/resources/invoice-line-items.ts +1 -1
- package/src/resources/invoices.ts +41 -11
- package/src/resources/plans/plans.ts +99 -3
- package/src/resources/prices/prices.ts +283 -179
- package/src/resources/shared.ts +260 -747
- package/src/resources/subscriptions.ts +540 -238
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -657,7 +657,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
657
657
|
* This endpoint can be used to change an existing subscription's plan. It returns
|
|
658
658
|
* the serialized updated subscription object.
|
|
659
659
|
*
|
|
660
|
-
* The body parameter `change_option` determines when the plan change
|
|
660
|
+
* The body parameter `change_option` determines when the plan change occurs. Orb
|
|
661
661
|
* supports three options:
|
|
662
662
|
*
|
|
663
663
|
* - `end_of_subscription_term`: changes the plan at the end of the existing plan's
|
|
@@ -926,164 +926,6 @@ export interface DiscountOverride {
|
|
|
926
926
|
*/
|
|
927
927
|
usage_discount?: number | null;
|
|
928
928
|
}
|
|
929
|
-
export interface NewSubscriptionBPSPrice {
|
|
930
|
-
bps_config: Shared.BPSConfig;
|
|
931
|
-
/**
|
|
932
|
-
* The cadence to bill for this price on.
|
|
933
|
-
*/
|
|
934
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
935
|
-
/**
|
|
936
|
-
* The id of the item the price will be associated with.
|
|
937
|
-
*/
|
|
938
|
-
item_id: string;
|
|
939
|
-
model_type: 'bps';
|
|
940
|
-
/**
|
|
941
|
-
* The name of the price.
|
|
942
|
-
*/
|
|
943
|
-
name: string;
|
|
944
|
-
/**
|
|
945
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
946
|
-
* usage-based.
|
|
947
|
-
*/
|
|
948
|
-
billable_metric_id?: string | null;
|
|
949
|
-
/**
|
|
950
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
951
|
-
* this is true, and in-arrears if this is false.
|
|
952
|
-
*/
|
|
953
|
-
billed_in_advance?: boolean | null;
|
|
954
|
-
/**
|
|
955
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
956
|
-
* months.
|
|
957
|
-
*/
|
|
958
|
-
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
959
|
-
/**
|
|
960
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
961
|
-
*/
|
|
962
|
-
conversion_rate?: number | null;
|
|
963
|
-
/**
|
|
964
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
965
|
-
*/
|
|
966
|
-
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
967
|
-
/**
|
|
968
|
-
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
969
|
-
* price is billed.
|
|
970
|
-
*/
|
|
971
|
-
currency?: string | null;
|
|
972
|
-
/**
|
|
973
|
-
* For dimensional price: specifies a price group and dimension values
|
|
974
|
-
*/
|
|
975
|
-
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
976
|
-
/**
|
|
977
|
-
* An alias for the price.
|
|
978
|
-
*/
|
|
979
|
-
external_price_id?: string | null;
|
|
980
|
-
/**
|
|
981
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
982
|
-
* applied.
|
|
983
|
-
*/
|
|
984
|
-
fixed_price_quantity?: number | null;
|
|
985
|
-
/**
|
|
986
|
-
* The property used to group this price on an invoice
|
|
987
|
-
*/
|
|
988
|
-
invoice_grouping_key?: string | null;
|
|
989
|
-
/**
|
|
990
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
991
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
992
|
-
*/
|
|
993
|
-
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
994
|
-
/**
|
|
995
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
996
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
997
|
-
* by setting `metadata` to `null`.
|
|
998
|
-
*/
|
|
999
|
-
metadata?: {
|
|
1000
|
-
[key: string]: string | null;
|
|
1001
|
-
} | null;
|
|
1002
|
-
/**
|
|
1003
|
-
* A transient ID that can be used to reference this price when adding adjustments
|
|
1004
|
-
* in the same API call.
|
|
1005
|
-
*/
|
|
1006
|
-
reference_id?: string | null;
|
|
1007
|
-
}
|
|
1008
|
-
export interface NewSubscriptionBulkBPSPrice {
|
|
1009
|
-
bulk_bps_config: Shared.BulkBPSConfig;
|
|
1010
|
-
/**
|
|
1011
|
-
* The cadence to bill for this price on.
|
|
1012
|
-
*/
|
|
1013
|
-
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
1014
|
-
/**
|
|
1015
|
-
* The id of the item the price will be associated with.
|
|
1016
|
-
*/
|
|
1017
|
-
item_id: string;
|
|
1018
|
-
model_type: 'bulk_bps';
|
|
1019
|
-
/**
|
|
1020
|
-
* The name of the price.
|
|
1021
|
-
*/
|
|
1022
|
-
name: string;
|
|
1023
|
-
/**
|
|
1024
|
-
* The id of the billable metric for the price. Only needed if the price is
|
|
1025
|
-
* usage-based.
|
|
1026
|
-
*/
|
|
1027
|
-
billable_metric_id?: string | null;
|
|
1028
|
-
/**
|
|
1029
|
-
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
1030
|
-
* this is true, and in-arrears if this is false.
|
|
1031
|
-
*/
|
|
1032
|
-
billed_in_advance?: boolean | null;
|
|
1033
|
-
/**
|
|
1034
|
-
* For custom cadence: specifies the duration of the billing period in days or
|
|
1035
|
-
* months.
|
|
1036
|
-
*/
|
|
1037
|
-
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
1038
|
-
/**
|
|
1039
|
-
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1040
|
-
*/
|
|
1041
|
-
conversion_rate?: number | null;
|
|
1042
|
-
/**
|
|
1043
|
-
* The configuration for the rate of the price currency to the invoicing currency.
|
|
1044
|
-
*/
|
|
1045
|
-
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
1046
|
-
/**
|
|
1047
|
-
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
1048
|
-
* price is billed.
|
|
1049
|
-
*/
|
|
1050
|
-
currency?: string | null;
|
|
1051
|
-
/**
|
|
1052
|
-
* For dimensional price: specifies a price group and dimension values
|
|
1053
|
-
*/
|
|
1054
|
-
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
1055
|
-
/**
|
|
1056
|
-
* An alias for the price.
|
|
1057
|
-
*/
|
|
1058
|
-
external_price_id?: string | null;
|
|
1059
|
-
/**
|
|
1060
|
-
* If the Price represents a fixed cost, this represents the quantity of units
|
|
1061
|
-
* applied.
|
|
1062
|
-
*/
|
|
1063
|
-
fixed_price_quantity?: number | null;
|
|
1064
|
-
/**
|
|
1065
|
-
* The property used to group this price on an invoice
|
|
1066
|
-
*/
|
|
1067
|
-
invoice_grouping_key?: string | null;
|
|
1068
|
-
/**
|
|
1069
|
-
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1070
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
1071
|
-
*/
|
|
1072
|
-
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
1073
|
-
/**
|
|
1074
|
-
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1075
|
-
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
1076
|
-
* by setting `metadata` to `null`.
|
|
1077
|
-
*/
|
|
1078
|
-
metadata?: {
|
|
1079
|
-
[key: string]: string | null;
|
|
1080
|
-
} | null;
|
|
1081
|
-
/**
|
|
1082
|
-
* A transient ID that can be used to reference this price when adding adjustments
|
|
1083
|
-
* in the same API call.
|
|
1084
|
-
*/
|
|
1085
|
-
reference_id?: string | null;
|
|
1086
|
-
}
|
|
1087
929
|
export interface NewSubscriptionBulkPrice {
|
|
1088
930
|
bulk_config: Shared.BulkConfig;
|
|
1089
931
|
/**
|
|
@@ -2050,7 +1892,7 @@ export interface NewSubscriptionMaxGroupTieredPackagePrice {
|
|
|
2050
1892
|
*/
|
|
2051
1893
|
reference_id?: string | null;
|
|
2052
1894
|
}
|
|
2053
|
-
export interface
|
|
1895
|
+
export interface NewSubscriptionMinimumCompositePrice {
|
|
2054
1896
|
/**
|
|
2055
1897
|
* The cadence to bill for this price on.
|
|
2056
1898
|
*/
|
|
@@ -2059,12 +1901,12 @@ export interface NewSubscriptionPackagePrice {
|
|
|
2059
1901
|
* The id of the item the price will be associated with.
|
|
2060
1902
|
*/
|
|
2061
1903
|
item_id: string;
|
|
2062
|
-
|
|
1904
|
+
minimum_config: NewSubscriptionMinimumCompositePrice.MinimumConfig;
|
|
1905
|
+
model_type: 'minimum';
|
|
2063
1906
|
/**
|
|
2064
1907
|
* The name of the price.
|
|
2065
1908
|
*/
|
|
2066
1909
|
name: string;
|
|
2067
|
-
package_config: Shared.PackageConfig;
|
|
2068
1910
|
/**
|
|
2069
1911
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2070
1912
|
* usage-based.
|
|
@@ -2129,7 +1971,20 @@ export interface NewSubscriptionPackagePrice {
|
|
|
2129
1971
|
*/
|
|
2130
1972
|
reference_id?: string | null;
|
|
2131
1973
|
}
|
|
2132
|
-
export
|
|
1974
|
+
export declare namespace NewSubscriptionMinimumCompositePrice {
|
|
1975
|
+
interface MinimumConfig {
|
|
1976
|
+
/**
|
|
1977
|
+
* The minimum amount to apply
|
|
1978
|
+
*/
|
|
1979
|
+
minimum_amount: string;
|
|
1980
|
+
/**
|
|
1981
|
+
* By default, subtotals from minimum composite prices are prorated based on the
|
|
1982
|
+
* service period. Set to false to disable proration.
|
|
1983
|
+
*/
|
|
1984
|
+
prorated?: boolean | null;
|
|
1985
|
+
}
|
|
1986
|
+
}
|
|
1987
|
+
export interface NewSubscriptionPackagePrice {
|
|
2133
1988
|
/**
|
|
2134
1989
|
* The cadence to bill for this price on.
|
|
2135
1990
|
*/
|
|
@@ -2138,14 +1993,12 @@ export interface NewSubscriptionPackageWithAllocationPrice {
|
|
|
2138
1993
|
* The id of the item the price will be associated with.
|
|
2139
1994
|
*/
|
|
2140
1995
|
item_id: string;
|
|
2141
|
-
model_type: '
|
|
1996
|
+
model_type: 'package';
|
|
2142
1997
|
/**
|
|
2143
1998
|
* The name of the price.
|
|
2144
1999
|
*/
|
|
2145
2000
|
name: string;
|
|
2146
|
-
|
|
2147
|
-
[key: string]: unknown;
|
|
2148
|
-
};
|
|
2001
|
+
package_config: Shared.PackageConfig;
|
|
2149
2002
|
/**
|
|
2150
2003
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2151
2004
|
* usage-based.
|
|
@@ -2210,7 +2063,7 @@ export interface NewSubscriptionPackageWithAllocationPrice {
|
|
|
2210
2063
|
*/
|
|
2211
2064
|
reference_id?: string | null;
|
|
2212
2065
|
}
|
|
2213
|
-
export interface
|
|
2066
|
+
export interface NewSubscriptionPackageWithAllocationPrice {
|
|
2214
2067
|
/**
|
|
2215
2068
|
* The cadence to bill for this price on.
|
|
2216
2069
|
*/
|
|
@@ -2219,12 +2072,12 @@ export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
|
|
|
2219
2072
|
* The id of the item the price will be associated with.
|
|
2220
2073
|
*/
|
|
2221
2074
|
item_id: string;
|
|
2222
|
-
model_type: '
|
|
2075
|
+
model_type: 'package_with_allocation';
|
|
2223
2076
|
/**
|
|
2224
2077
|
* The name of the price.
|
|
2225
2078
|
*/
|
|
2226
2079
|
name: string;
|
|
2227
|
-
|
|
2080
|
+
package_with_allocation_config: {
|
|
2228
2081
|
[key: string]: unknown;
|
|
2229
2082
|
};
|
|
2230
2083
|
/**
|
|
@@ -2291,7 +2144,7 @@ export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
|
|
|
2291
2144
|
*/
|
|
2292
2145
|
reference_id?: string | null;
|
|
2293
2146
|
}
|
|
2294
|
-
export interface
|
|
2147
|
+
export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
|
|
2295
2148
|
/**
|
|
2296
2149
|
* The cadence to bill for this price on.
|
|
2297
2150
|
*/
|
|
@@ -2300,12 +2153,12 @@ export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
|
|
|
2300
2153
|
* The id of the item the price will be associated with.
|
|
2301
2154
|
*/
|
|
2302
2155
|
item_id: string;
|
|
2303
|
-
model_type: '
|
|
2156
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
2304
2157
|
/**
|
|
2305
2158
|
* The name of the price.
|
|
2306
2159
|
*/
|
|
2307
2160
|
name: string;
|
|
2308
|
-
|
|
2161
|
+
scalable_matrix_with_tiered_pricing_config: {
|
|
2309
2162
|
[key: string]: unknown;
|
|
2310
2163
|
};
|
|
2311
2164
|
/**
|
|
@@ -2372,7 +2225,7 @@ export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
|
|
|
2372
2225
|
*/
|
|
2373
2226
|
reference_id?: string | null;
|
|
2374
2227
|
}
|
|
2375
|
-
export interface
|
|
2228
|
+
export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
|
|
2376
2229
|
/**
|
|
2377
2230
|
* The cadence to bill for this price on.
|
|
2378
2231
|
*/
|
|
@@ -2381,12 +2234,12 @@ export interface NewSubscriptionThresholdTotalAmountPrice {
|
|
|
2381
2234
|
* The id of the item the price will be associated with.
|
|
2382
2235
|
*/
|
|
2383
2236
|
item_id: string;
|
|
2384
|
-
model_type: '
|
|
2237
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
2385
2238
|
/**
|
|
2386
2239
|
* The name of the price.
|
|
2387
2240
|
*/
|
|
2388
2241
|
name: string;
|
|
2389
|
-
|
|
2242
|
+
scalable_matrix_with_unit_pricing_config: {
|
|
2390
2243
|
[key: string]: unknown;
|
|
2391
2244
|
};
|
|
2392
2245
|
/**
|
|
@@ -2453,7 +2306,7 @@ export interface NewSubscriptionThresholdTotalAmountPrice {
|
|
|
2453
2306
|
*/
|
|
2454
2307
|
reference_id?: string | null;
|
|
2455
2308
|
}
|
|
2456
|
-
export interface
|
|
2309
|
+
export interface NewSubscriptionThresholdTotalAmountPrice {
|
|
2457
2310
|
/**
|
|
2458
2311
|
* The cadence to bill for this price on.
|
|
2459
2312
|
*/
|
|
@@ -2462,12 +2315,12 @@ export interface NewSubscriptionTierWithProrationPrice {
|
|
|
2462
2315
|
* The id of the item the price will be associated with.
|
|
2463
2316
|
*/
|
|
2464
2317
|
item_id: string;
|
|
2465
|
-
model_type: '
|
|
2318
|
+
model_type: 'threshold_total_amount';
|
|
2466
2319
|
/**
|
|
2467
2320
|
* The name of the price.
|
|
2468
2321
|
*/
|
|
2469
2322
|
name: string;
|
|
2470
|
-
|
|
2323
|
+
threshold_total_amount_config: {
|
|
2471
2324
|
[key: string]: unknown;
|
|
2472
2325
|
};
|
|
2473
2326
|
/**
|
|
@@ -2534,7 +2387,7 @@ export interface NewSubscriptionTierWithProrationPrice {
|
|
|
2534
2387
|
*/
|
|
2535
2388
|
reference_id?: string | null;
|
|
2536
2389
|
}
|
|
2537
|
-
export interface
|
|
2390
|
+
export interface NewSubscriptionTierWithProrationPrice {
|
|
2538
2391
|
/**
|
|
2539
2392
|
* The cadence to bill for this price on.
|
|
2540
2393
|
*/
|
|
@@ -2543,12 +2396,14 @@ export interface NewSubscriptionTieredBPSPrice {
|
|
|
2543
2396
|
* The id of the item the price will be associated with.
|
|
2544
2397
|
*/
|
|
2545
2398
|
item_id: string;
|
|
2546
|
-
model_type: '
|
|
2399
|
+
model_type: 'tiered_with_proration';
|
|
2547
2400
|
/**
|
|
2548
2401
|
* The name of the price.
|
|
2549
2402
|
*/
|
|
2550
2403
|
name: string;
|
|
2551
|
-
|
|
2404
|
+
tiered_with_proration_config: {
|
|
2405
|
+
[key: string]: unknown;
|
|
2406
|
+
};
|
|
2552
2407
|
/**
|
|
2553
2408
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2554
2409
|
* usage-based.
|
|
@@ -3612,7 +3467,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
3612
3467
|
/**
|
|
3613
3468
|
* The definition of a new price to create and add to the subscription.
|
|
3614
3469
|
*/
|
|
3615
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.
|
|
3470
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTierWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | null;
|
|
3616
3471
|
/**
|
|
3617
3472
|
* The id of the price to add to the subscription.
|
|
3618
3473
|
*/
|
|
@@ -3624,6 +3479,89 @@ export declare namespace SubscriptionCreateParams {
|
|
|
3624
3479
|
*/
|
|
3625
3480
|
start_date?: string | null;
|
|
3626
3481
|
}
|
|
3482
|
+
namespace AddPrice {
|
|
3483
|
+
interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
|
|
3484
|
+
/**
|
|
3485
|
+
* The cadence to bill for this price on.
|
|
3486
|
+
*/
|
|
3487
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3488
|
+
grouped_with_min_max_thresholds_config: {
|
|
3489
|
+
[key: string]: unknown;
|
|
3490
|
+
};
|
|
3491
|
+
/**
|
|
3492
|
+
* The id of the item the price will be associated with.
|
|
3493
|
+
*/
|
|
3494
|
+
item_id: string;
|
|
3495
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
3496
|
+
/**
|
|
3497
|
+
* The name of the price.
|
|
3498
|
+
*/
|
|
3499
|
+
name: string;
|
|
3500
|
+
/**
|
|
3501
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3502
|
+
* usage-based.
|
|
3503
|
+
*/
|
|
3504
|
+
billable_metric_id?: string | null;
|
|
3505
|
+
/**
|
|
3506
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3507
|
+
* this is true, and in-arrears if this is false.
|
|
3508
|
+
*/
|
|
3509
|
+
billed_in_advance?: boolean | null;
|
|
3510
|
+
/**
|
|
3511
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3512
|
+
* months.
|
|
3513
|
+
*/
|
|
3514
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3515
|
+
/**
|
|
3516
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3517
|
+
*/
|
|
3518
|
+
conversion_rate?: number | null;
|
|
3519
|
+
/**
|
|
3520
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3521
|
+
*/
|
|
3522
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3523
|
+
/**
|
|
3524
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
3525
|
+
* price is billed.
|
|
3526
|
+
*/
|
|
3527
|
+
currency?: string | null;
|
|
3528
|
+
/**
|
|
3529
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3530
|
+
*/
|
|
3531
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3532
|
+
/**
|
|
3533
|
+
* An alias for the price.
|
|
3534
|
+
*/
|
|
3535
|
+
external_price_id?: string | null;
|
|
3536
|
+
/**
|
|
3537
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3538
|
+
* applied.
|
|
3539
|
+
*/
|
|
3540
|
+
fixed_price_quantity?: number | null;
|
|
3541
|
+
/**
|
|
3542
|
+
* The property used to group this price on an invoice
|
|
3543
|
+
*/
|
|
3544
|
+
invoice_grouping_key?: string | null;
|
|
3545
|
+
/**
|
|
3546
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3547
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3548
|
+
*/
|
|
3549
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3550
|
+
/**
|
|
3551
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3552
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3553
|
+
* by setting `metadata` to `null`.
|
|
3554
|
+
*/
|
|
3555
|
+
metadata?: {
|
|
3556
|
+
[key: string]: string | null;
|
|
3557
|
+
} | null;
|
|
3558
|
+
/**
|
|
3559
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
3560
|
+
* in the same API call.
|
|
3561
|
+
*/
|
|
3562
|
+
reference_id?: string | null;
|
|
3563
|
+
}
|
|
3564
|
+
}
|
|
3627
3565
|
interface RemoveAdjustment {
|
|
3628
3566
|
/**
|
|
3629
3567
|
* The id of the adjustment to remove on the subscription.
|
|
@@ -3685,12 +3623,95 @@ export declare namespace SubscriptionCreateParams {
|
|
|
3685
3623
|
/**
|
|
3686
3624
|
* The definition of a new price to create and add to the subscription.
|
|
3687
3625
|
*/
|
|
3688
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.
|
|
3626
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTierWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | null;
|
|
3689
3627
|
/**
|
|
3690
3628
|
* The id of the price to add to the subscription.
|
|
3691
3629
|
*/
|
|
3692
3630
|
price_id?: string | null;
|
|
3693
3631
|
}
|
|
3632
|
+
namespace ReplacePrice {
|
|
3633
|
+
interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
|
|
3634
|
+
/**
|
|
3635
|
+
* The cadence to bill for this price on.
|
|
3636
|
+
*/
|
|
3637
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3638
|
+
grouped_with_min_max_thresholds_config: {
|
|
3639
|
+
[key: string]: unknown;
|
|
3640
|
+
};
|
|
3641
|
+
/**
|
|
3642
|
+
* The id of the item the price will be associated with.
|
|
3643
|
+
*/
|
|
3644
|
+
item_id: string;
|
|
3645
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
3646
|
+
/**
|
|
3647
|
+
* The name of the price.
|
|
3648
|
+
*/
|
|
3649
|
+
name: string;
|
|
3650
|
+
/**
|
|
3651
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3652
|
+
* usage-based.
|
|
3653
|
+
*/
|
|
3654
|
+
billable_metric_id?: string | null;
|
|
3655
|
+
/**
|
|
3656
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3657
|
+
* this is true, and in-arrears if this is false.
|
|
3658
|
+
*/
|
|
3659
|
+
billed_in_advance?: boolean | null;
|
|
3660
|
+
/**
|
|
3661
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3662
|
+
* months.
|
|
3663
|
+
*/
|
|
3664
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3665
|
+
/**
|
|
3666
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3667
|
+
*/
|
|
3668
|
+
conversion_rate?: number | null;
|
|
3669
|
+
/**
|
|
3670
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
3671
|
+
*/
|
|
3672
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
3673
|
+
/**
|
|
3674
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
3675
|
+
* price is billed.
|
|
3676
|
+
*/
|
|
3677
|
+
currency?: string | null;
|
|
3678
|
+
/**
|
|
3679
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3680
|
+
*/
|
|
3681
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
3682
|
+
/**
|
|
3683
|
+
* An alias for the price.
|
|
3684
|
+
*/
|
|
3685
|
+
external_price_id?: string | null;
|
|
3686
|
+
/**
|
|
3687
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3688
|
+
* applied.
|
|
3689
|
+
*/
|
|
3690
|
+
fixed_price_quantity?: number | null;
|
|
3691
|
+
/**
|
|
3692
|
+
* The property used to group this price on an invoice
|
|
3693
|
+
*/
|
|
3694
|
+
invoice_grouping_key?: string | null;
|
|
3695
|
+
/**
|
|
3696
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3697
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3698
|
+
*/
|
|
3699
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3700
|
+
/**
|
|
3701
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3702
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3703
|
+
* by setting `metadata` to `null`.
|
|
3704
|
+
*/
|
|
3705
|
+
metadata?: {
|
|
3706
|
+
[key: string]: string | null;
|
|
3707
|
+
} | null;
|
|
3708
|
+
/**
|
|
3709
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
3710
|
+
* in the same API call.
|
|
3711
|
+
*/
|
|
3712
|
+
reference_id?: string | null;
|
|
3713
|
+
}
|
|
3714
|
+
}
|
|
3694
3715
|
}
|
|
3695
3716
|
export interface SubscriptionUpdateParams {
|
|
3696
3717
|
/**
|
|
@@ -3886,7 +3907,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3886
3907
|
/**
|
|
3887
3908
|
* The definition of a new price to create and add to the subscription.
|
|
3888
3909
|
*/
|
|
3889
|
-
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredPrice | Shared.
|
|
3910
|
+
price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Add.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMinimumCompositePrice | null;
|
|
3890
3911
|
/**
|
|
3891
3912
|
* The id of the price to add to the subscription.
|
|
3892
3913
|
*/
|
|
@@ -3935,12 +3956,83 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3935
3956
|
*/
|
|
3936
3957
|
quantity: number;
|
|
3937
3958
|
}
|
|
3959
|
+
interface NewFloatingGroupedWithMinMaxThresholdsPrice {
|
|
3960
|
+
/**
|
|
3961
|
+
* The cadence to bill for this price on.
|
|
3962
|
+
*/
|
|
3963
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3964
|
+
/**
|
|
3965
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
3966
|
+
*/
|
|
3967
|
+
currency: string;
|
|
3968
|
+
grouped_with_min_max_thresholds_config: {
|
|
3969
|
+
[key: string]: unknown;
|
|
3970
|
+
};
|
|
3971
|
+
/**
|
|
3972
|
+
* The id of the item the price will be associated with.
|
|
3973
|
+
*/
|
|
3974
|
+
item_id: string;
|
|
3975
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
3976
|
+
/**
|
|
3977
|
+
* The name of the price.
|
|
3978
|
+
*/
|
|
3979
|
+
name: string;
|
|
3980
|
+
/**
|
|
3981
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3982
|
+
* usage-based.
|
|
3983
|
+
*/
|
|
3984
|
+
billable_metric_id?: string | null;
|
|
3985
|
+
/**
|
|
3986
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3987
|
+
* this is true, and in-arrears if this is false.
|
|
3988
|
+
*/
|
|
3989
|
+
billed_in_advance?: boolean | null;
|
|
3990
|
+
/**
|
|
3991
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3992
|
+
* months.
|
|
3993
|
+
*/
|
|
3994
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
3995
|
+
/**
|
|
3996
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3997
|
+
*/
|
|
3998
|
+
conversion_rate?: number | null;
|
|
3999
|
+
/**
|
|
4000
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4001
|
+
*/
|
|
4002
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
4003
|
+
/**
|
|
4004
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4005
|
+
*/
|
|
4006
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
4007
|
+
/**
|
|
4008
|
+
* An alias for the price.
|
|
4009
|
+
*/
|
|
4010
|
+
external_price_id?: string | null;
|
|
4011
|
+
/**
|
|
4012
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4013
|
+
* applied.
|
|
4014
|
+
*/
|
|
4015
|
+
fixed_price_quantity?: number | null;
|
|
4016
|
+
/**
|
|
4017
|
+
* The property used to group this price on an invoice
|
|
4018
|
+
*/
|
|
4019
|
+
invoice_grouping_key?: string | null;
|
|
4020
|
+
/**
|
|
4021
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4022
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4023
|
+
*/
|
|
4024
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4025
|
+
/**
|
|
4026
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4027
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4028
|
+
* by setting `metadata` to `null`.
|
|
4029
|
+
*/
|
|
4030
|
+
metadata?: {
|
|
4031
|
+
[key: string]: string | null;
|
|
4032
|
+
} | null;
|
|
4033
|
+
}
|
|
3938
4034
|
}
|
|
3939
4035
|
interface AddAdjustment {
|
|
3940
|
-
/**
|
|
3941
|
-
* The definition of a new adjustment to create and add to the subscription.
|
|
3942
|
-
*/
|
|
3943
|
-
adjustment: Shared.NewPercentageDiscount | Shared.NewUsageDiscount | Shared.NewAmountDiscount | Shared.NewMinimum | Shared.NewMaximum;
|
|
3944
4036
|
/**
|
|
3945
4037
|
* The start date of the adjustment interval. This is the date that the adjustment
|
|
3946
4038
|
* will start affecting prices on the subscription. The adjustment will apply to
|
|
@@ -3948,6 +4040,16 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3948
4040
|
* as inclusive for in-advance prices, and exclusive for in-arrears prices.
|
|
3949
4041
|
*/
|
|
3950
4042
|
start_date: (string & {}) | Shared.BillingCycleRelativeDate;
|
|
4043
|
+
/**
|
|
4044
|
+
* The definition of a new adjustment to create and add to the subscription.
|
|
4045
|
+
*/
|
|
4046
|
+
adjustment?: Shared.NewPercentageDiscount | Shared.NewUsageDiscount | Shared.NewAmountDiscount | Shared.NewMinimum | Shared.NewMaximum | null;
|
|
4047
|
+
/**
|
|
4048
|
+
* The ID of the adjustment to add to the subscription. Adjustment IDs can be
|
|
4049
|
+
* re-used from existing subscriptions or plans, but adjustments associated with
|
|
4050
|
+
* coupon redemptions cannot be re-used.
|
|
4051
|
+
*/
|
|
4052
|
+
adjustment_id?: string | null;
|
|
3951
4053
|
/**
|
|
3952
4054
|
* The end date of the adjustment interval. This is the date that the adjustment
|
|
3953
4055
|
* will stop affecting prices on the subscription. The adjustment will apply to
|
|
@@ -4244,7 +4346,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
4244
4346
|
/**
|
|
4245
4347
|
* The definition of a new price to create and add to the subscription.
|
|
4246
4348
|
*/
|
|
4247
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.
|
|
4349
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTierWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | null;
|
|
4248
4350
|
/**
|
|
4249
4351
|
* The id of the price to add to the subscription.
|
|
4250
4352
|
*/
|
|
@@ -4256,6 +4358,89 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
4256
4358
|
*/
|
|
4257
4359
|
start_date?: string | null;
|
|
4258
4360
|
}
|
|
4361
|
+
namespace AddPrice {
|
|
4362
|
+
interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
|
|
4363
|
+
/**
|
|
4364
|
+
* The cadence to bill for this price on.
|
|
4365
|
+
*/
|
|
4366
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4367
|
+
grouped_with_min_max_thresholds_config: {
|
|
4368
|
+
[key: string]: unknown;
|
|
4369
|
+
};
|
|
4370
|
+
/**
|
|
4371
|
+
* The id of the item the price will be associated with.
|
|
4372
|
+
*/
|
|
4373
|
+
item_id: string;
|
|
4374
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
4375
|
+
/**
|
|
4376
|
+
* The name of the price.
|
|
4377
|
+
*/
|
|
4378
|
+
name: string;
|
|
4379
|
+
/**
|
|
4380
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4381
|
+
* usage-based.
|
|
4382
|
+
*/
|
|
4383
|
+
billable_metric_id?: string | null;
|
|
4384
|
+
/**
|
|
4385
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4386
|
+
* this is true, and in-arrears if this is false.
|
|
4387
|
+
*/
|
|
4388
|
+
billed_in_advance?: boolean | null;
|
|
4389
|
+
/**
|
|
4390
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4391
|
+
* months.
|
|
4392
|
+
*/
|
|
4393
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4394
|
+
/**
|
|
4395
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4396
|
+
*/
|
|
4397
|
+
conversion_rate?: number | null;
|
|
4398
|
+
/**
|
|
4399
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4400
|
+
*/
|
|
4401
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
4402
|
+
/**
|
|
4403
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4404
|
+
* price is billed.
|
|
4405
|
+
*/
|
|
4406
|
+
currency?: string | null;
|
|
4407
|
+
/**
|
|
4408
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4409
|
+
*/
|
|
4410
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
4411
|
+
/**
|
|
4412
|
+
* An alias for the price.
|
|
4413
|
+
*/
|
|
4414
|
+
external_price_id?: string | null;
|
|
4415
|
+
/**
|
|
4416
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4417
|
+
* applied.
|
|
4418
|
+
*/
|
|
4419
|
+
fixed_price_quantity?: number | null;
|
|
4420
|
+
/**
|
|
4421
|
+
* The property used to group this price on an invoice
|
|
4422
|
+
*/
|
|
4423
|
+
invoice_grouping_key?: string | null;
|
|
4424
|
+
/**
|
|
4425
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4426
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4427
|
+
*/
|
|
4428
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4429
|
+
/**
|
|
4430
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4431
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4432
|
+
* by setting `metadata` to `null`.
|
|
4433
|
+
*/
|
|
4434
|
+
metadata?: {
|
|
4435
|
+
[key: string]: string | null;
|
|
4436
|
+
} | null;
|
|
4437
|
+
/**
|
|
4438
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
4439
|
+
* in the same API call.
|
|
4440
|
+
*/
|
|
4441
|
+
reference_id?: string | null;
|
|
4442
|
+
}
|
|
4443
|
+
}
|
|
4259
4444
|
interface RemoveAdjustment {
|
|
4260
4445
|
/**
|
|
4261
4446
|
* The id of the adjustment to remove on the subscription.
|
|
@@ -4317,12 +4502,95 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
4317
4502
|
/**
|
|
4318
4503
|
* The definition of a new price to create and add to the subscription.
|
|
4319
4504
|
*/
|
|
4320
|
-
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.
|
|
4505
|
+
price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTierWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | null;
|
|
4321
4506
|
/**
|
|
4322
4507
|
* The id of the price to add to the subscription.
|
|
4323
4508
|
*/
|
|
4324
4509
|
price_id?: string | null;
|
|
4325
4510
|
}
|
|
4511
|
+
namespace ReplacePrice {
|
|
4512
|
+
interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
|
|
4513
|
+
/**
|
|
4514
|
+
* The cadence to bill for this price on.
|
|
4515
|
+
*/
|
|
4516
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4517
|
+
grouped_with_min_max_thresholds_config: {
|
|
4518
|
+
[key: string]: unknown;
|
|
4519
|
+
};
|
|
4520
|
+
/**
|
|
4521
|
+
* The id of the item the price will be associated with.
|
|
4522
|
+
*/
|
|
4523
|
+
item_id: string;
|
|
4524
|
+
model_type: 'grouped_with_min_max_thresholds';
|
|
4525
|
+
/**
|
|
4526
|
+
* The name of the price.
|
|
4527
|
+
*/
|
|
4528
|
+
name: string;
|
|
4529
|
+
/**
|
|
4530
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4531
|
+
* usage-based.
|
|
4532
|
+
*/
|
|
4533
|
+
billable_metric_id?: string | null;
|
|
4534
|
+
/**
|
|
4535
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4536
|
+
* this is true, and in-arrears if this is false.
|
|
4537
|
+
*/
|
|
4538
|
+
billed_in_advance?: boolean | null;
|
|
4539
|
+
/**
|
|
4540
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4541
|
+
* months.
|
|
4542
|
+
*/
|
|
4543
|
+
billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4544
|
+
/**
|
|
4545
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4546
|
+
*/
|
|
4547
|
+
conversion_rate?: number | null;
|
|
4548
|
+
/**
|
|
4549
|
+
* The configuration for the rate of the price currency to the invoicing currency.
|
|
4550
|
+
*/
|
|
4551
|
+
conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
|
|
4552
|
+
/**
|
|
4553
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4554
|
+
* price is billed.
|
|
4555
|
+
*/
|
|
4556
|
+
currency?: string | null;
|
|
4557
|
+
/**
|
|
4558
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4559
|
+
*/
|
|
4560
|
+
dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
|
|
4561
|
+
/**
|
|
4562
|
+
* An alias for the price.
|
|
4563
|
+
*/
|
|
4564
|
+
external_price_id?: string | null;
|
|
4565
|
+
/**
|
|
4566
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4567
|
+
* applied.
|
|
4568
|
+
*/
|
|
4569
|
+
fixed_price_quantity?: number | null;
|
|
4570
|
+
/**
|
|
4571
|
+
* The property used to group this price on an invoice
|
|
4572
|
+
*/
|
|
4573
|
+
invoice_grouping_key?: string | null;
|
|
4574
|
+
/**
|
|
4575
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4576
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4577
|
+
*/
|
|
4578
|
+
invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
|
|
4579
|
+
/**
|
|
4580
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4581
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4582
|
+
* by setting `metadata` to `null`.
|
|
4583
|
+
*/
|
|
4584
|
+
metadata?: {
|
|
4585
|
+
[key: string]: string | null;
|
|
4586
|
+
} | null;
|
|
4587
|
+
/**
|
|
4588
|
+
* A transient ID that can be used to reference this price when adding adjustments
|
|
4589
|
+
* in the same API call.
|
|
4590
|
+
*/
|
|
4591
|
+
reference_id?: string | null;
|
|
4592
|
+
}
|
|
4593
|
+
}
|
|
4326
4594
|
}
|
|
4327
4595
|
export interface SubscriptionTriggerPhaseParams {
|
|
4328
4596
|
/**
|
|
@@ -4381,6 +4649,6 @@ export interface SubscriptionUpdateTrialParams {
|
|
|
4381
4649
|
shift?: boolean;
|
|
4382
4650
|
}
|
|
4383
4651
|
export declare namespace Subscriptions {
|
|
4384
|
-
export { type DiscountOverride as DiscountOverride, type
|
|
4652
|
+
export { type DiscountOverride as DiscountOverride, type NewSubscriptionBulkPrice as NewSubscriptionBulkPrice, type NewSubscriptionBulkWithProrationPrice as NewSubscriptionBulkWithProrationPrice, type NewSubscriptionCumulativeGroupedBulkPrice as NewSubscriptionCumulativeGroupedBulkPrice, type NewSubscriptionGroupedAllocationPrice as NewSubscriptionGroupedAllocationPrice, type NewSubscriptionGroupedTieredPackagePrice as NewSubscriptionGroupedTieredPackagePrice, type NewSubscriptionGroupedTieredPrice as NewSubscriptionGroupedTieredPrice, type NewSubscriptionGroupedWithMeteredMinimumPrice as NewSubscriptionGroupedWithMeteredMinimumPrice, type NewSubscriptionGroupedWithProratedMinimumPrice as NewSubscriptionGroupedWithProratedMinimumPrice, type NewSubscriptionMatrixPrice as NewSubscriptionMatrixPrice, type NewSubscriptionMatrixWithAllocationPrice as NewSubscriptionMatrixWithAllocationPrice, type NewSubscriptionMatrixWithDisplayNamePrice as NewSubscriptionMatrixWithDisplayNamePrice, type NewSubscriptionMaxGroupTieredPackagePrice as NewSubscriptionMaxGroupTieredPackagePrice, type NewSubscriptionMinimumCompositePrice as NewSubscriptionMinimumCompositePrice, type NewSubscriptionPackagePrice as NewSubscriptionPackagePrice, type NewSubscriptionPackageWithAllocationPrice as NewSubscriptionPackageWithAllocationPrice, type NewSubscriptionScalableMatrixWithTieredPricingPrice as NewSubscriptionScalableMatrixWithTieredPricingPrice, type NewSubscriptionScalableMatrixWithUnitPricingPrice as NewSubscriptionScalableMatrixWithUnitPricingPrice, type NewSubscriptionThresholdTotalAmountPrice as NewSubscriptionThresholdTotalAmountPrice, type NewSubscriptionTierWithProrationPrice as NewSubscriptionTierWithProrationPrice, type NewSubscriptionTieredPackagePrice as NewSubscriptionTieredPackagePrice, type NewSubscriptionTieredPackageWithMinimumPrice as NewSubscriptionTieredPackageWithMinimumPrice, type NewSubscriptionTieredPrice as NewSubscriptionTieredPrice, type NewSubscriptionTieredWithMinimumPrice as NewSubscriptionTieredWithMinimumPrice, type NewSubscriptionUnitPrice as NewSubscriptionUnitPrice, type NewSubscriptionUnitWithPercentPrice as NewSubscriptionUnitWithPercentPrice, type NewSubscriptionUnitWithProrationPrice as NewSubscriptionUnitWithProrationPrice, type Subscription as Subscription, type SubscriptionUsage as SubscriptionUsage, type Subscriptions as Subscriptions, type SubscriptionFetchCostsResponse as SubscriptionFetchCostsResponse, type SubscriptionFetchScheduleResponse as SubscriptionFetchScheduleResponse, SubscriptionsPage as SubscriptionsPage, SubscriptionFetchScheduleResponsesPage as SubscriptionFetchScheduleResponsesPage, type SubscriptionCreateParams as SubscriptionCreateParams, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionFetchCostsParams as SubscriptionFetchCostsParams, type SubscriptionFetchScheduleParams as SubscriptionFetchScheduleParams, type SubscriptionFetchUsageParams as SubscriptionFetchUsageParams, type SubscriptionPriceIntervalsParams as SubscriptionPriceIntervalsParams, type SubscriptionRedeemCouponParams as SubscriptionRedeemCouponParams, type SubscriptionSchedulePlanChangeParams as SubscriptionSchedulePlanChangeParams, type SubscriptionTriggerPhaseParams as SubscriptionTriggerPhaseParams, type SubscriptionUnscheduleFixedFeeQuantityUpdatesParams as SubscriptionUnscheduleFixedFeeQuantityUpdatesParams, type SubscriptionUpdateFixedFeeQuantityParams as SubscriptionUpdateFixedFeeQuantityParams, type SubscriptionUpdateTrialParams as SubscriptionUpdateTrialParams, };
|
|
4385
4653
|
}
|
|
4386
4654
|
//# sourceMappingURL=subscriptions.d.ts.map
|