orb-billing 1.23.0 → 1.24.1
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 +16 -0
- package/error.d.ts +1 -1
- package/error.d.ts.map +1 -1
- package/error.js +4 -4
- package/error.js.map +1 -1
- package/error.mjs +2 -2
- package/error.mjs.map +1 -1
- package/index.d.mts +4 -4
- package/index.d.ts +4 -4
- package/index.d.ts.map +1 -1
- package/index.js +7 -3
- package/index.js.map +1 -1
- package/index.mjs +6 -2
- package/index.mjs.map +1 -1
- package/package.json +3 -1
- package/resources/coupons/coupons.d.ts +60 -2
- package/resources/coupons/coupons.d.ts.map +1 -1
- package/resources/coupons/coupons.js.map +1 -1
- package/resources/coupons/coupons.mjs.map +1 -1
- package/resources/credit-notes.d.ts +57 -5
- package/resources/credit-notes.d.ts.map +1 -1
- package/resources/credit-notes.js.map +1 -1
- package/resources/credit-notes.mjs.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/credits.d.ts +2 -2
- package/resources/customers/credits/credits.d.ts.map +1 -1
- package/resources/customers/credits/index.d.ts +1 -1
- package/resources/customers/credits/index.d.ts.map +1 -1
- package/resources/customers/credits/ledger.d.ts +8 -8
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js +1 -1
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs +1 -1
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/customers.d.ts +696 -8
- 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/customers/usage.d.ts +74 -58
- package/resources/customers/usage.d.ts.map +1 -1
- package/resources/customers/usage.js +14 -14
- package/resources/customers/usage.js.map +1 -1
- package/resources/customers/usage.mjs +14 -14
- package/resources/customers/usage.mjs.map +1 -1
- package/resources/events/events.d.ts +40 -40
- package/resources/events/events.js +40 -40
- package/resources/events/events.mjs +40 -40
- package/resources/index.d.ts +4 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +19 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +2 -2
- package/resources/invoice-line-items.d.ts.map +1 -1
- package/resources/invoices.d.ts +358 -71
- 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 +648 -4
- 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/index.d.ts +1 -1
- package/resources/prices/index.d.ts.map +1 -1
- package/resources/prices/index.js +3 -3
- package/resources/prices/index.js.map +1 -1
- package/resources/prices/index.mjs +1 -1
- package/resources/prices/index.mjs.map +1 -1
- package/resources/prices/prices.d.ts +56 -83
- 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 +62 -0
- package/resources/shared.d.ts.map +1 -0
- package/resources/shared.js +4 -0
- package/resources/shared.js.map +1 -0
- package/resources/shared.mjs +3 -0
- package/resources/shared.mjs.map +1 -0
- package/resources/subscriptions.d.ts +1084 -241
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/error.ts +2 -2
- package/src/index.ts +9 -4
- package/src/resources/coupons/coupons.ts +76 -2
- package/src/resources/credit-notes.ts +81 -5
- package/src/resources/customers/balance-transactions.ts +18 -2
- package/src/resources/customers/credits/credits.ts +2 -2
- package/src/resources/customers/credits/index.ts +2 -2
- package/src/resources/customers/credits/ledger.ts +23 -23
- package/src/resources/customers/customers.ts +1144 -12
- package/src/resources/customers/usage.ts +80 -62
- package/src/resources/events/events.ts +40 -40
- package/src/resources/index.ts +3 -3
- package/src/resources/invoice-line-items.ts +2 -2
- package/src/resources/invoices.ts +598 -91
- package/src/resources/plans/plans.ts +810 -4
- package/src/resources/prices/index.ts +1 -1
- package/src/resources/prices/prices.ts +67 -100
- package/src/resources/shared.ts +84 -0
- package/src/resources/subscriptions.ts +1291 -279
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -61,13 +61,13 @@ export declare class Subscriptions extends APIResource {
|
|
|
61
61
|
*
|
|
62
62
|
* ```json
|
|
63
63
|
* {
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
64
|
+
* ...
|
|
65
|
+
* "id": "price_id",
|
|
66
|
+
* "model_type": "unit",
|
|
67
|
+
* "unit_config": {
|
|
68
|
+
* "unit_amount": "0.50"
|
|
69
|
+
* }
|
|
70
|
+
* ...
|
|
71
71
|
* }
|
|
72
72
|
* ```
|
|
73
73
|
*
|
|
@@ -81,24 +81,24 @@ export declare class Subscriptions extends APIResource {
|
|
|
81
81
|
*
|
|
82
82
|
* ```json
|
|
83
83
|
* {
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
84
|
+
* ...
|
|
85
|
+
* "id": "price_id",
|
|
86
|
+
* "model_type": "tiered",
|
|
87
|
+
* "tiered_config": {
|
|
88
|
+
* "tiers": [
|
|
89
|
+
* {
|
|
90
|
+
* "first_unit":"1",
|
|
91
|
+
* "last_unit": "10",
|
|
92
|
+
* "unit_amount": "0.50"
|
|
93
|
+
* },
|
|
94
|
+
* {
|
|
95
|
+
* "first_unit": "10",
|
|
96
|
+
* "last_unit": null,
|
|
97
|
+
* "unit_amount": "0.10"
|
|
98
|
+
* }
|
|
99
|
+
* ]
|
|
100
|
+
* }
|
|
101
|
+
* ...
|
|
102
102
|
* }
|
|
103
103
|
* ```
|
|
104
104
|
*
|
|
@@ -113,22 +113,22 @@ export declare class Subscriptions extends APIResource {
|
|
|
113
113
|
*
|
|
114
114
|
* ```json
|
|
115
115
|
* {
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
116
|
+
* ...
|
|
117
|
+
* "id": "price_id",
|
|
118
|
+
* "model_type": "bulk",
|
|
119
|
+
* "bulk_config": {
|
|
120
|
+
* "tiers": [
|
|
121
|
+
* {
|
|
122
|
+
* "maximum_units": "10",
|
|
123
|
+
* "unit_amount": "0.50"
|
|
124
|
+
* },
|
|
125
|
+
* {
|
|
126
|
+
* "maximum_units": "1000",
|
|
127
|
+
* "unit_amount": "0.40"
|
|
128
|
+
* }
|
|
129
|
+
* ]
|
|
130
|
+
* }
|
|
131
|
+
* ...
|
|
132
132
|
* }
|
|
133
133
|
* ```
|
|
134
134
|
*
|
|
@@ -140,14 +140,14 @@ export declare class Subscriptions extends APIResource {
|
|
|
140
140
|
*
|
|
141
141
|
* ```json
|
|
142
142
|
* {
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
143
|
+
* ...
|
|
144
|
+
* "id": "price_id",
|
|
145
|
+
* "model_type": "package",
|
|
146
|
+
* "package_config": {
|
|
147
|
+
* "package_amount": "0.80",
|
|
148
|
+
* "package_size": 10
|
|
149
|
+
* }
|
|
150
|
+
* ...
|
|
151
151
|
* }
|
|
152
152
|
* ```
|
|
153
153
|
*
|
|
@@ -160,14 +160,14 @@ export declare class Subscriptions extends APIResource {
|
|
|
160
160
|
*
|
|
161
161
|
* ```json
|
|
162
162
|
* {
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
163
|
+
* ...
|
|
164
|
+
* "id": "price_id"
|
|
165
|
+
* "model_type": "bps",
|
|
166
|
+
* "bps_config": {
|
|
167
|
+
* "bps": 125,
|
|
168
|
+
* "per_event_cap": "11.00"
|
|
169
|
+
* }
|
|
170
|
+
* ...
|
|
171
171
|
* }
|
|
172
172
|
* ```
|
|
173
173
|
*
|
|
@@ -182,25 +182,25 @@ export declare class Subscriptions extends APIResource {
|
|
|
182
182
|
*
|
|
183
183
|
* ```json
|
|
184
184
|
* {
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
185
|
+
* ...
|
|
186
|
+
* "id": "price_id"
|
|
187
|
+
* "model_type": "bulk_bps",
|
|
188
|
+
* "bulk_bps_config": {
|
|
189
|
+
* "tiers": [
|
|
190
|
+
* {
|
|
191
|
+
* "minimum_amount": "0.00",
|
|
192
|
+
* "maximum_amount": "1000000.00",
|
|
193
|
+
* "bps": 125,
|
|
194
|
+
* "per_event_cap": "19.00"
|
|
195
|
+
* },
|
|
196
|
+
* {
|
|
197
|
+
* "minimum_amount":"1000000.00",
|
|
198
|
+
* "maximum_amount": null,
|
|
199
|
+
* "bps": 115,
|
|
200
|
+
* "per_event_cap": "4.00"
|
|
201
|
+
* }
|
|
202
|
+
* ]
|
|
203
|
+
* }
|
|
204
204
|
* ...
|
|
205
205
|
* }
|
|
206
206
|
* ```
|
|
@@ -217,26 +217,26 @@ export declare class Subscriptions extends APIResource {
|
|
|
217
217
|
*
|
|
218
218
|
* ```json
|
|
219
219
|
* {
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
*
|
|
220
|
+
* ...
|
|
221
|
+
* "id": "price_id"
|
|
222
|
+
* "model_type": "tiered_bps",
|
|
223
|
+
* "tiered_bps_config": {
|
|
224
|
+
* "tiers": [
|
|
225
|
+
* {
|
|
226
|
+
* "minimum_amount": "0.00",
|
|
227
|
+
* "maximum_amount": "1000000.00",
|
|
228
|
+
* "bps": 125,
|
|
229
|
+
* "per_event_cap": "19.00"
|
|
230
|
+
* },
|
|
231
|
+
* {
|
|
232
|
+
* "minimum_amount":"1000000",
|
|
233
|
+
* "maximum_amount": null,
|
|
234
|
+
* "bps": 115,
|
|
235
|
+
* "per_event_cap": "4.00"
|
|
236
|
+
* }
|
|
237
|
+
* ]
|
|
238
|
+
* }
|
|
239
|
+
* ...
|
|
240
240
|
* }
|
|
241
241
|
* ```
|
|
242
242
|
*
|
|
@@ -252,26 +252,27 @@ export declare class Subscriptions extends APIResource {
|
|
|
252
252
|
* `default_unit_amount`.
|
|
253
253
|
*
|
|
254
254
|
* ```json
|
|
255
|
-
* ...
|
|
256
|
-
* "model_type": "matrix"
|
|
257
|
-
* "matrix_config": {
|
|
258
|
-
* "default_unit_amount": "3.00",
|
|
259
|
-
* "dimensions": [
|
|
260
|
-
* "cluster_name",
|
|
261
|
-
* "region"
|
|
262
|
-
* ],
|
|
263
|
-
* "matrix_values": [
|
|
264
255
|
* {
|
|
265
|
-
*
|
|
266
|
-
* "
|
|
267
|
-
*
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
*
|
|
256
|
+
* ...
|
|
257
|
+
* "model_type": "matrix",
|
|
258
|
+
* "matrix_config": {
|
|
259
|
+
* "default_unit_amount": "3.00",
|
|
260
|
+
* "dimensions": [
|
|
261
|
+
* "cluster_name",
|
|
262
|
+
* "region"
|
|
263
|
+
* ],
|
|
264
|
+
* "matrix_values": [
|
|
265
|
+
* {
|
|
266
|
+
* "dimension_values": [
|
|
267
|
+
* "alpha",
|
|
268
|
+
* "west"
|
|
269
|
+
* ],
|
|
270
|
+
* "unit_amount": "2.00"
|
|
271
|
+
* },
|
|
272
|
+
* ...
|
|
273
|
+
* ]
|
|
274
|
+
* }
|
|
273
275
|
* }
|
|
274
|
-
* ...
|
|
275
276
|
* ```
|
|
276
277
|
*
|
|
277
278
|
* ### Fixed fees
|
|
@@ -282,14 +283,14 @@ export declare class Subscriptions extends APIResource {
|
|
|
282
283
|
*
|
|
283
284
|
* ```json
|
|
284
285
|
* {
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
*
|
|
286
|
+
* ...
|
|
287
|
+
* "id": "price_id",
|
|
288
|
+
* "model_type": "unit",
|
|
289
|
+
* "unit_config": {
|
|
290
|
+
* "unit_amount": "2.00"
|
|
291
|
+
* },
|
|
292
|
+
* "fixed_price_quantity": 3.0
|
|
293
|
+
* ...
|
|
293
294
|
* }
|
|
294
295
|
* ```
|
|
295
296
|
*
|
|
@@ -314,14 +315,14 @@ export declare class Subscriptions extends APIResource {
|
|
|
314
315
|
*
|
|
315
316
|
* ```json
|
|
316
317
|
* {
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
*
|
|
318
|
+
* ...
|
|
319
|
+
* "id": "price_id",
|
|
320
|
+
* "model_type": "unit",
|
|
321
|
+
* "unit_config": {
|
|
322
|
+
* "unit_amount": "0.50"
|
|
323
|
+
* },
|
|
324
|
+
* "minimum_amount": "100.00"
|
|
325
|
+
* ...
|
|
325
326
|
* }
|
|
326
327
|
* ```
|
|
327
328
|
*
|
|
@@ -329,14 +330,14 @@ export declare class Subscriptions extends APIResource {
|
|
|
329
330
|
*
|
|
330
331
|
* ```json
|
|
331
332
|
* {
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
333
|
+
* ...
|
|
334
|
+
* "id": "price_id",
|
|
335
|
+
* "model_type": "unit",
|
|
336
|
+
* "unit_config": {
|
|
337
|
+
* "unit_amount": "0.50"
|
|
338
|
+
* },
|
|
339
|
+
* "minimum_amount": null
|
|
340
|
+
* ...
|
|
340
341
|
* }
|
|
341
342
|
* ```
|
|
342
343
|
*
|
|
@@ -351,12 +352,12 @@ export declare class Subscriptions extends APIResource {
|
|
|
351
352
|
* To add a discount for a specific price, add `discount` to the price in the
|
|
352
353
|
* `price_overrides` object. Discount should be a dictionary of the format:
|
|
353
354
|
*
|
|
354
|
-
* ```
|
|
355
|
+
* ```ts
|
|
355
356
|
* {
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
357
|
+
* "discount_type": "amount" | "percentage" | "usage",
|
|
358
|
+
* "amount_discount": string,
|
|
359
|
+
* "percentage_discount": string,
|
|
360
|
+
* "usage_discount": string
|
|
360
361
|
* }
|
|
361
362
|
* ```
|
|
362
363
|
*
|
|
@@ -367,13 +368,13 @@ export declare class Subscriptions extends APIResource {
|
|
|
367
368
|
*
|
|
368
369
|
* ```json
|
|
369
370
|
* {
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
371
|
+
* ...
|
|
372
|
+
* "id": "price_id",
|
|
373
|
+
* "model_type": "unit",
|
|
374
|
+
* "unit_config": {
|
|
375
|
+
* "unit_amount": "0.50"
|
|
376
|
+
* },
|
|
377
|
+
* "discount": {"discount_type": "amount", "amount_discount": "175"},
|
|
377
378
|
* }
|
|
378
379
|
* ```
|
|
379
380
|
*
|
|
@@ -381,11 +382,11 @@ export declare class Subscriptions extends APIResource {
|
|
|
381
382
|
*
|
|
382
383
|
* ```json
|
|
383
384
|
* {
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
*
|
|
387
|
-
*
|
|
388
|
-
*
|
|
385
|
+
* "customer_id": "customer_id",
|
|
386
|
+
* "plan_id": "plan_id",
|
|
387
|
+
* "discount": null,
|
|
388
|
+
* "price_overrides": [ ... ]
|
|
389
|
+
* ...
|
|
389
390
|
* }
|
|
390
391
|
* ```
|
|
391
392
|
*
|
|
@@ -1394,16 +1395,6 @@ export declare namespace Subscription {
|
|
|
1394
1395
|
end_date: string | null;
|
|
1395
1396
|
}
|
|
1396
1397
|
}
|
|
1397
|
-
export interface Subscriptions {
|
|
1398
|
-
data: Array<Subscription>;
|
|
1399
|
-
pagination_metadata: Subscriptions.PaginationMetadata;
|
|
1400
|
-
}
|
|
1401
|
-
export declare namespace Subscriptions {
|
|
1402
|
-
interface PaginationMetadata {
|
|
1403
|
-
has_more: boolean;
|
|
1404
|
-
next_cursor: string | null;
|
|
1405
|
-
}
|
|
1406
|
-
}
|
|
1407
1398
|
export type SubscriptionUsage = SubscriptionUsage.UngroupedSubscriptionUsage | SubscriptionUsage.GroupedSubscriptionUsage;
|
|
1408
1399
|
export declare namespace SubscriptionUsage {
|
|
1409
1400
|
interface UngroupedSubscriptionUsage {
|
|
@@ -1459,6 +1450,16 @@ export declare namespace SubscriptionUsage {
|
|
|
1459
1450
|
}
|
|
1460
1451
|
}
|
|
1461
1452
|
}
|
|
1453
|
+
export interface Subscriptions {
|
|
1454
|
+
data: Array<Subscription>;
|
|
1455
|
+
pagination_metadata: Subscriptions.PaginationMetadata;
|
|
1456
|
+
}
|
|
1457
|
+
export declare namespace Subscriptions {
|
|
1458
|
+
interface PaginationMetadata {
|
|
1459
|
+
has_more: boolean;
|
|
1460
|
+
next_cursor: string | null;
|
|
1461
|
+
}
|
|
1462
|
+
}
|
|
1462
1463
|
export interface SubscriptionFetchCostsResponse {
|
|
1463
1464
|
data: Array<SubscriptionFetchCostsResponse.Data>;
|
|
1464
1465
|
}
|
|
@@ -1809,7 +1810,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1809
1810
|
/**
|
|
1810
1811
|
* The subscription's override discount for the plan.
|
|
1811
1812
|
*/
|
|
1812
|
-
discount?:
|
|
1813
|
+
discount?: OverrideUnitPrice.Discount | null;
|
|
1813
1814
|
/**
|
|
1814
1815
|
* The starting quantity of the price, if the price is a fixed price.
|
|
1815
1816
|
*/
|
|
@@ -1834,6 +1835,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1834
1835
|
*/
|
|
1835
1836
|
scaling_factor?: number | null;
|
|
1836
1837
|
}
|
|
1838
|
+
/**
|
|
1839
|
+
* The subscription's override discount for the plan.
|
|
1840
|
+
*/
|
|
1841
|
+
interface Discount {
|
|
1842
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
1843
|
+
/**
|
|
1844
|
+
* Only available if discount_type is `amount`.
|
|
1845
|
+
*/
|
|
1846
|
+
amount_discount?: string | null;
|
|
1847
|
+
/**
|
|
1848
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
1849
|
+
* this can be a subset of prices.
|
|
1850
|
+
*/
|
|
1851
|
+
applies_to_price_ids?: Array<string> | null;
|
|
1852
|
+
/**
|
|
1853
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
1854
|
+
* and 1.
|
|
1855
|
+
*/
|
|
1856
|
+
percentage_discount?: number | null;
|
|
1857
|
+
/**
|
|
1858
|
+
* Only available if discount_type is `trial`
|
|
1859
|
+
*/
|
|
1860
|
+
trial_amount_discount?: string | null;
|
|
1861
|
+
/**
|
|
1862
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
1863
|
+
* discount is for
|
|
1864
|
+
*/
|
|
1865
|
+
usage_discount?: number | null;
|
|
1866
|
+
}
|
|
1837
1867
|
}
|
|
1838
1868
|
interface OverridePackagePrice {
|
|
1839
1869
|
id: string;
|
|
@@ -1842,7 +1872,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1842
1872
|
/**
|
|
1843
1873
|
* The subscription's override discount for the plan.
|
|
1844
1874
|
*/
|
|
1845
|
-
discount?:
|
|
1875
|
+
discount?: OverridePackagePrice.Discount | null;
|
|
1846
1876
|
/**
|
|
1847
1877
|
* The starting quantity of the price, if the price is a fixed price.
|
|
1848
1878
|
*/
|
|
@@ -1868,6 +1898,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1868
1898
|
*/
|
|
1869
1899
|
package_size?: number | null;
|
|
1870
1900
|
}
|
|
1901
|
+
/**
|
|
1902
|
+
* The subscription's override discount for the plan.
|
|
1903
|
+
*/
|
|
1904
|
+
interface Discount {
|
|
1905
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
1906
|
+
/**
|
|
1907
|
+
* Only available if discount_type is `amount`.
|
|
1908
|
+
*/
|
|
1909
|
+
amount_discount?: string | null;
|
|
1910
|
+
/**
|
|
1911
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
1912
|
+
* this can be a subset of prices.
|
|
1913
|
+
*/
|
|
1914
|
+
applies_to_price_ids?: Array<string> | null;
|
|
1915
|
+
/**
|
|
1916
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
1917
|
+
* and 1.
|
|
1918
|
+
*/
|
|
1919
|
+
percentage_discount?: number | null;
|
|
1920
|
+
/**
|
|
1921
|
+
* Only available if discount_type is `trial`
|
|
1922
|
+
*/
|
|
1923
|
+
trial_amount_discount?: string | null;
|
|
1924
|
+
/**
|
|
1925
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
1926
|
+
* discount is for
|
|
1927
|
+
*/
|
|
1928
|
+
usage_discount?: number | null;
|
|
1929
|
+
}
|
|
1871
1930
|
}
|
|
1872
1931
|
interface OverrideMatrixPrice {
|
|
1873
1932
|
id: string;
|
|
@@ -1876,7 +1935,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1876
1935
|
/**
|
|
1877
1936
|
* The subscription's override discount for the plan.
|
|
1878
1937
|
*/
|
|
1879
|
-
discount?:
|
|
1938
|
+
discount?: OverrideMatrixPrice.Discount | null;
|
|
1880
1939
|
/**
|
|
1881
1940
|
* The starting quantity of the price, if the price is a fixed price.
|
|
1882
1941
|
*/
|
|
@@ -1928,6 +1987,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1928
1987
|
scaling_factor?: number | null;
|
|
1929
1988
|
}
|
|
1930
1989
|
}
|
|
1990
|
+
/**
|
|
1991
|
+
* The subscription's override discount for the plan.
|
|
1992
|
+
*/
|
|
1993
|
+
interface Discount {
|
|
1994
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
1995
|
+
/**
|
|
1996
|
+
* Only available if discount_type is `amount`.
|
|
1997
|
+
*/
|
|
1998
|
+
amount_discount?: string | null;
|
|
1999
|
+
/**
|
|
2000
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2001
|
+
* this can be a subset of prices.
|
|
2002
|
+
*/
|
|
2003
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2004
|
+
/**
|
|
2005
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2006
|
+
* and 1.
|
|
2007
|
+
*/
|
|
2008
|
+
percentage_discount?: number | null;
|
|
2009
|
+
/**
|
|
2010
|
+
* Only available if discount_type is `trial`
|
|
2011
|
+
*/
|
|
2012
|
+
trial_amount_discount?: string | null;
|
|
2013
|
+
/**
|
|
2014
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2015
|
+
* discount is for
|
|
2016
|
+
*/
|
|
2017
|
+
usage_discount?: number | null;
|
|
2018
|
+
}
|
|
1931
2019
|
}
|
|
1932
2020
|
interface OverrideTieredPrice {
|
|
1933
2021
|
id: string;
|
|
@@ -1936,7 +2024,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1936
2024
|
/**
|
|
1937
2025
|
* The subscription's override discount for the plan.
|
|
1938
2026
|
*/
|
|
1939
|
-
discount?:
|
|
2027
|
+
discount?: OverrideTieredPrice.Discount | null;
|
|
1940
2028
|
/**
|
|
1941
2029
|
* The starting quantity of the price, if the price is a fixed price.
|
|
1942
2030
|
*/
|
|
@@ -1973,6 +2061,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1973
2061
|
last_unit?: number | null;
|
|
1974
2062
|
}
|
|
1975
2063
|
}
|
|
2064
|
+
/**
|
|
2065
|
+
* The subscription's override discount for the plan.
|
|
2066
|
+
*/
|
|
2067
|
+
interface Discount {
|
|
2068
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2069
|
+
/**
|
|
2070
|
+
* Only available if discount_type is `amount`.
|
|
2071
|
+
*/
|
|
2072
|
+
amount_discount?: string | null;
|
|
2073
|
+
/**
|
|
2074
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2075
|
+
* this can be a subset of prices.
|
|
2076
|
+
*/
|
|
2077
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2078
|
+
/**
|
|
2079
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2080
|
+
* and 1.
|
|
2081
|
+
*/
|
|
2082
|
+
percentage_discount?: number | null;
|
|
2083
|
+
/**
|
|
2084
|
+
* Only available if discount_type is `trial`
|
|
2085
|
+
*/
|
|
2086
|
+
trial_amount_discount?: string | null;
|
|
2087
|
+
/**
|
|
2088
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2089
|
+
* discount is for
|
|
2090
|
+
*/
|
|
2091
|
+
usage_discount?: number | null;
|
|
2092
|
+
}
|
|
1976
2093
|
}
|
|
1977
2094
|
interface OverrideTieredBpsPrice {
|
|
1978
2095
|
id: string;
|
|
@@ -1981,7 +2098,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
1981
2098
|
/**
|
|
1982
2099
|
* The subscription's override discount for the plan.
|
|
1983
2100
|
*/
|
|
1984
|
-
discount?:
|
|
2101
|
+
discount?: OverrideTieredBpsPrice.Discount | null;
|
|
1985
2102
|
/**
|
|
1986
2103
|
* The starting quantity of the price, if the price is a fixed price.
|
|
1987
2104
|
*/
|
|
@@ -2023,6 +2140,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2023
2140
|
per_unit_maximum?: string | null;
|
|
2024
2141
|
}
|
|
2025
2142
|
}
|
|
2143
|
+
/**
|
|
2144
|
+
* The subscription's override discount for the plan.
|
|
2145
|
+
*/
|
|
2146
|
+
interface Discount {
|
|
2147
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2148
|
+
/**
|
|
2149
|
+
* Only available if discount_type is `amount`.
|
|
2150
|
+
*/
|
|
2151
|
+
amount_discount?: string | null;
|
|
2152
|
+
/**
|
|
2153
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2154
|
+
* this can be a subset of prices.
|
|
2155
|
+
*/
|
|
2156
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2157
|
+
/**
|
|
2158
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2159
|
+
* and 1.
|
|
2160
|
+
*/
|
|
2161
|
+
percentage_discount?: number | null;
|
|
2162
|
+
/**
|
|
2163
|
+
* Only available if discount_type is `trial`
|
|
2164
|
+
*/
|
|
2165
|
+
trial_amount_discount?: string | null;
|
|
2166
|
+
/**
|
|
2167
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2168
|
+
* discount is for
|
|
2169
|
+
*/
|
|
2170
|
+
usage_discount?: number | null;
|
|
2171
|
+
}
|
|
2026
2172
|
}
|
|
2027
2173
|
interface OverrideBpsPrice {
|
|
2028
2174
|
id: string;
|
|
@@ -2031,7 +2177,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2031
2177
|
/**
|
|
2032
2178
|
* The subscription's override discount for the plan.
|
|
2033
2179
|
*/
|
|
2034
|
-
discount?:
|
|
2180
|
+
discount?: OverrideBpsPrice.Discount | null;
|
|
2035
2181
|
/**
|
|
2036
2182
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2037
2183
|
*/
|
|
@@ -2056,6 +2202,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2056
2202
|
*/
|
|
2057
2203
|
per_unit_maximum?: string | null;
|
|
2058
2204
|
}
|
|
2205
|
+
/**
|
|
2206
|
+
* The subscription's override discount for the plan.
|
|
2207
|
+
*/
|
|
2208
|
+
interface Discount {
|
|
2209
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2210
|
+
/**
|
|
2211
|
+
* Only available if discount_type is `amount`.
|
|
2212
|
+
*/
|
|
2213
|
+
amount_discount?: string | null;
|
|
2214
|
+
/**
|
|
2215
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2216
|
+
* this can be a subset of prices.
|
|
2217
|
+
*/
|
|
2218
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2219
|
+
/**
|
|
2220
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2221
|
+
* and 1.
|
|
2222
|
+
*/
|
|
2223
|
+
percentage_discount?: number | null;
|
|
2224
|
+
/**
|
|
2225
|
+
* Only available if discount_type is `trial`
|
|
2226
|
+
*/
|
|
2227
|
+
trial_amount_discount?: string | null;
|
|
2228
|
+
/**
|
|
2229
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2230
|
+
* discount is for
|
|
2231
|
+
*/
|
|
2232
|
+
usage_discount?: number | null;
|
|
2233
|
+
}
|
|
2059
2234
|
}
|
|
2060
2235
|
interface OverrideBulkBpsPrice {
|
|
2061
2236
|
id: string;
|
|
@@ -2064,7 +2239,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2064
2239
|
/**
|
|
2065
2240
|
* The subscription's override discount for the plan.
|
|
2066
2241
|
*/
|
|
2067
|
-
discount?:
|
|
2242
|
+
discount?: OverrideBulkBpsPrice.Discount | null;
|
|
2068
2243
|
/**
|
|
2069
2244
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2070
2245
|
*/
|
|
@@ -2102,6 +2277,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2102
2277
|
per_unit_maximum?: string | null;
|
|
2103
2278
|
}
|
|
2104
2279
|
}
|
|
2280
|
+
/**
|
|
2281
|
+
* The subscription's override discount for the plan.
|
|
2282
|
+
*/
|
|
2283
|
+
interface Discount {
|
|
2284
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2285
|
+
/**
|
|
2286
|
+
* Only available if discount_type is `amount`.
|
|
2287
|
+
*/
|
|
2288
|
+
amount_discount?: string | null;
|
|
2289
|
+
/**
|
|
2290
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2291
|
+
* this can be a subset of prices.
|
|
2292
|
+
*/
|
|
2293
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2294
|
+
/**
|
|
2295
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2296
|
+
* and 1.
|
|
2297
|
+
*/
|
|
2298
|
+
percentage_discount?: number | null;
|
|
2299
|
+
/**
|
|
2300
|
+
* Only available if discount_type is `trial`
|
|
2301
|
+
*/
|
|
2302
|
+
trial_amount_discount?: string | null;
|
|
2303
|
+
/**
|
|
2304
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2305
|
+
* discount is for
|
|
2306
|
+
*/
|
|
2307
|
+
usage_discount?: number | null;
|
|
2308
|
+
}
|
|
2105
2309
|
}
|
|
2106
2310
|
interface OverrideBulkPrice {
|
|
2107
2311
|
id: string;
|
|
@@ -2110,7 +2314,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2110
2314
|
/**
|
|
2111
2315
|
* The subscription's override discount for the plan.
|
|
2112
2316
|
*/
|
|
2113
|
-
discount?:
|
|
2317
|
+
discount?: OverrideBulkPrice.Discount | null;
|
|
2114
2318
|
/**
|
|
2115
2319
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2116
2320
|
*/
|
|
@@ -2143,6 +2347,35 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2143
2347
|
maximum_units?: number | null;
|
|
2144
2348
|
}
|
|
2145
2349
|
}
|
|
2350
|
+
/**
|
|
2351
|
+
* The subscription's override discount for the plan.
|
|
2352
|
+
*/
|
|
2353
|
+
interface Discount {
|
|
2354
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2355
|
+
/**
|
|
2356
|
+
* Only available if discount_type is `amount`.
|
|
2357
|
+
*/
|
|
2358
|
+
amount_discount?: string | null;
|
|
2359
|
+
/**
|
|
2360
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2361
|
+
* this can be a subset of prices.
|
|
2362
|
+
*/
|
|
2363
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2364
|
+
/**
|
|
2365
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2366
|
+
* and 1.
|
|
2367
|
+
*/
|
|
2368
|
+
percentage_discount?: number | null;
|
|
2369
|
+
/**
|
|
2370
|
+
* Only available if discount_type is `trial`
|
|
2371
|
+
*/
|
|
2372
|
+
trial_amount_discount?: string | null;
|
|
2373
|
+
/**
|
|
2374
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2375
|
+
* discount is for
|
|
2376
|
+
*/
|
|
2377
|
+
usage_discount?: number | null;
|
|
2378
|
+
}
|
|
2146
2379
|
}
|
|
2147
2380
|
interface OverrideTestRatingFunctionPrice {
|
|
2148
2381
|
id: string;
|
|
@@ -2151,7 +2384,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2151
2384
|
/**
|
|
2152
2385
|
* The subscription's override discount for the plan.
|
|
2153
2386
|
*/
|
|
2154
|
-
discount?:
|
|
2387
|
+
discount?: OverrideTestRatingFunctionPrice.Discount | null;
|
|
2155
2388
|
/**
|
|
2156
2389
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2157
2390
|
*/
|
|
@@ -2165,6 +2398,37 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2165
2398
|
*/
|
|
2166
2399
|
minimum_amount?: string | null;
|
|
2167
2400
|
}
|
|
2401
|
+
namespace OverrideTestRatingFunctionPrice {
|
|
2402
|
+
/**
|
|
2403
|
+
* The subscription's override discount for the plan.
|
|
2404
|
+
*/
|
|
2405
|
+
interface Discount {
|
|
2406
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2407
|
+
/**
|
|
2408
|
+
* Only available if discount_type is `amount`.
|
|
2409
|
+
*/
|
|
2410
|
+
amount_discount?: string | null;
|
|
2411
|
+
/**
|
|
2412
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2413
|
+
* this can be a subset of prices.
|
|
2414
|
+
*/
|
|
2415
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2416
|
+
/**
|
|
2417
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2418
|
+
* and 1.
|
|
2419
|
+
*/
|
|
2420
|
+
percentage_discount?: number | null;
|
|
2421
|
+
/**
|
|
2422
|
+
* Only available if discount_type is `trial`
|
|
2423
|
+
*/
|
|
2424
|
+
trial_amount_discount?: string | null;
|
|
2425
|
+
/**
|
|
2426
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2427
|
+
* discount is for
|
|
2428
|
+
*/
|
|
2429
|
+
usage_discount?: number | null;
|
|
2430
|
+
}
|
|
2431
|
+
}
|
|
2168
2432
|
interface OverrideFivetranExamplePrice {
|
|
2169
2433
|
id: string;
|
|
2170
2434
|
fivetran_example_config: Record<string, unknown>;
|
|
@@ -2172,7 +2436,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2172
2436
|
/**
|
|
2173
2437
|
* The subscription's override discount for the plan.
|
|
2174
2438
|
*/
|
|
2175
|
-
discount?:
|
|
2439
|
+
discount?: OverrideFivetranExamplePrice.Discount | null;
|
|
2176
2440
|
/**
|
|
2177
2441
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2178
2442
|
*/
|
|
@@ -2186,6 +2450,37 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2186
2450
|
*/
|
|
2187
2451
|
minimum_amount?: string | null;
|
|
2188
2452
|
}
|
|
2453
|
+
namespace OverrideFivetranExamplePrice {
|
|
2454
|
+
/**
|
|
2455
|
+
* The subscription's override discount for the plan.
|
|
2456
|
+
*/
|
|
2457
|
+
interface Discount {
|
|
2458
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2459
|
+
/**
|
|
2460
|
+
* Only available if discount_type is `amount`.
|
|
2461
|
+
*/
|
|
2462
|
+
amount_discount?: string | null;
|
|
2463
|
+
/**
|
|
2464
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2465
|
+
* this can be a subset of prices.
|
|
2466
|
+
*/
|
|
2467
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2468
|
+
/**
|
|
2469
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2470
|
+
* and 1.
|
|
2471
|
+
*/
|
|
2472
|
+
percentage_discount?: number | null;
|
|
2473
|
+
/**
|
|
2474
|
+
* Only available if discount_type is `trial`
|
|
2475
|
+
*/
|
|
2476
|
+
trial_amount_discount?: string | null;
|
|
2477
|
+
/**
|
|
2478
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2479
|
+
* discount is for
|
|
2480
|
+
*/
|
|
2481
|
+
usage_discount?: number | null;
|
|
2482
|
+
}
|
|
2483
|
+
}
|
|
2189
2484
|
interface OverrideThresholdTotalAmountPrice {
|
|
2190
2485
|
id: string;
|
|
2191
2486
|
model_type: 'threshold_total_amount';
|
|
@@ -2193,7 +2488,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2193
2488
|
/**
|
|
2194
2489
|
* The subscription's override discount for the plan.
|
|
2195
2490
|
*/
|
|
2196
|
-
discount?:
|
|
2491
|
+
discount?: OverrideThresholdTotalAmountPrice.Discount | null;
|
|
2197
2492
|
/**
|
|
2198
2493
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2199
2494
|
*/
|
|
@@ -2207,15 +2502,46 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2207
2502
|
*/
|
|
2208
2503
|
minimum_amount?: string | null;
|
|
2209
2504
|
}
|
|
2210
|
-
|
|
2211
|
-
id: string;
|
|
2212
|
-
model_type: 'tiered_package';
|
|
2213
|
-
tiered_package_config: Record<string, unknown>;
|
|
2505
|
+
namespace OverrideThresholdTotalAmountPrice {
|
|
2214
2506
|
/**
|
|
2215
2507
|
* The subscription's override discount for the plan.
|
|
2216
2508
|
*/
|
|
2217
|
-
|
|
2218
|
-
|
|
2509
|
+
interface Discount {
|
|
2510
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2511
|
+
/**
|
|
2512
|
+
* Only available if discount_type is `amount`.
|
|
2513
|
+
*/
|
|
2514
|
+
amount_discount?: string | null;
|
|
2515
|
+
/**
|
|
2516
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2517
|
+
* this can be a subset of prices.
|
|
2518
|
+
*/
|
|
2519
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2520
|
+
/**
|
|
2521
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2522
|
+
* and 1.
|
|
2523
|
+
*/
|
|
2524
|
+
percentage_discount?: number | null;
|
|
2525
|
+
/**
|
|
2526
|
+
* Only available if discount_type is `trial`
|
|
2527
|
+
*/
|
|
2528
|
+
trial_amount_discount?: string | null;
|
|
2529
|
+
/**
|
|
2530
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2531
|
+
* discount is for
|
|
2532
|
+
*/
|
|
2533
|
+
usage_discount?: number | null;
|
|
2534
|
+
}
|
|
2535
|
+
}
|
|
2536
|
+
interface OverrideTieredPackagePrice {
|
|
2537
|
+
id: string;
|
|
2538
|
+
model_type: 'tiered_package';
|
|
2539
|
+
tiered_package_config: Record<string, unknown>;
|
|
2540
|
+
/**
|
|
2541
|
+
* The subscription's override discount for the plan.
|
|
2542
|
+
*/
|
|
2543
|
+
discount?: OverrideTieredPackagePrice.Discount | null;
|
|
2544
|
+
/**
|
|
2219
2545
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2220
2546
|
*/
|
|
2221
2547
|
fixed_price_quantity?: number | null;
|
|
@@ -2228,6 +2554,37 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2228
2554
|
*/
|
|
2229
2555
|
minimum_amount?: string | null;
|
|
2230
2556
|
}
|
|
2557
|
+
namespace OverrideTieredPackagePrice {
|
|
2558
|
+
/**
|
|
2559
|
+
* The subscription's override discount for the plan.
|
|
2560
|
+
*/
|
|
2561
|
+
interface Discount {
|
|
2562
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2563
|
+
/**
|
|
2564
|
+
* Only available if discount_type is `amount`.
|
|
2565
|
+
*/
|
|
2566
|
+
amount_discount?: string | null;
|
|
2567
|
+
/**
|
|
2568
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2569
|
+
* this can be a subset of prices.
|
|
2570
|
+
*/
|
|
2571
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2572
|
+
/**
|
|
2573
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2574
|
+
* and 1.
|
|
2575
|
+
*/
|
|
2576
|
+
percentage_discount?: number | null;
|
|
2577
|
+
/**
|
|
2578
|
+
* Only available if discount_type is `trial`
|
|
2579
|
+
*/
|
|
2580
|
+
trial_amount_discount?: string | null;
|
|
2581
|
+
/**
|
|
2582
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2583
|
+
* discount is for
|
|
2584
|
+
*/
|
|
2585
|
+
usage_discount?: number | null;
|
|
2586
|
+
}
|
|
2587
|
+
}
|
|
2231
2588
|
interface OverrideTieredWithMinimumPrice {
|
|
2232
2589
|
id: string;
|
|
2233
2590
|
model_type: 'tiered_with_minimum';
|
|
@@ -2235,7 +2592,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2235
2592
|
/**
|
|
2236
2593
|
* The subscription's override discount for the plan.
|
|
2237
2594
|
*/
|
|
2238
|
-
discount?:
|
|
2595
|
+
discount?: OverrideTieredWithMinimumPrice.Discount | null;
|
|
2239
2596
|
/**
|
|
2240
2597
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2241
2598
|
*/
|
|
@@ -2249,6 +2606,37 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2249
2606
|
*/
|
|
2250
2607
|
minimum_amount?: string | null;
|
|
2251
2608
|
}
|
|
2609
|
+
namespace OverrideTieredWithMinimumPrice {
|
|
2610
|
+
/**
|
|
2611
|
+
* The subscription's override discount for the plan.
|
|
2612
|
+
*/
|
|
2613
|
+
interface Discount {
|
|
2614
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2615
|
+
/**
|
|
2616
|
+
* Only available if discount_type is `amount`.
|
|
2617
|
+
*/
|
|
2618
|
+
amount_discount?: string | null;
|
|
2619
|
+
/**
|
|
2620
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2621
|
+
* this can be a subset of prices.
|
|
2622
|
+
*/
|
|
2623
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2624
|
+
/**
|
|
2625
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2626
|
+
* and 1.
|
|
2627
|
+
*/
|
|
2628
|
+
percentage_discount?: number | null;
|
|
2629
|
+
/**
|
|
2630
|
+
* Only available if discount_type is `trial`
|
|
2631
|
+
*/
|
|
2632
|
+
trial_amount_discount?: string | null;
|
|
2633
|
+
/**
|
|
2634
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2635
|
+
* discount is for
|
|
2636
|
+
*/
|
|
2637
|
+
usage_discount?: number | null;
|
|
2638
|
+
}
|
|
2639
|
+
}
|
|
2252
2640
|
interface OverridePackageWithAllocationPrice {
|
|
2253
2641
|
id: string;
|
|
2254
2642
|
model_type: 'package_with_allocation';
|
|
@@ -2256,7 +2644,7 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2256
2644
|
/**
|
|
2257
2645
|
* The subscription's override discount for the plan.
|
|
2258
2646
|
*/
|
|
2259
|
-
discount?:
|
|
2647
|
+
discount?: OverridePackageWithAllocationPrice.Discount | null;
|
|
2260
2648
|
/**
|
|
2261
2649
|
* The starting quantity of the price, if the price is a fixed price.
|
|
2262
2650
|
*/
|
|
@@ -2270,6 +2658,37 @@ export declare namespace SubscriptionCreateParams {
|
|
|
2270
2658
|
*/
|
|
2271
2659
|
minimum_amount?: string | null;
|
|
2272
2660
|
}
|
|
2661
|
+
namespace OverridePackageWithAllocationPrice {
|
|
2662
|
+
/**
|
|
2663
|
+
* The subscription's override discount for the plan.
|
|
2664
|
+
*/
|
|
2665
|
+
interface Discount {
|
|
2666
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
2667
|
+
/**
|
|
2668
|
+
* Only available if discount_type is `amount`.
|
|
2669
|
+
*/
|
|
2670
|
+
amount_discount?: string | null;
|
|
2671
|
+
/**
|
|
2672
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
2673
|
+
* this can be a subset of prices.
|
|
2674
|
+
*/
|
|
2675
|
+
applies_to_price_ids?: Array<string> | null;
|
|
2676
|
+
/**
|
|
2677
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
2678
|
+
* and 1.
|
|
2679
|
+
*/
|
|
2680
|
+
percentage_discount?: number | null;
|
|
2681
|
+
/**
|
|
2682
|
+
* Only available if discount_type is `trial`
|
|
2683
|
+
*/
|
|
2684
|
+
trial_amount_discount?: string | null;
|
|
2685
|
+
/**
|
|
2686
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
2687
|
+
* discount is for
|
|
2688
|
+
*/
|
|
2689
|
+
usage_discount?: number | null;
|
|
2690
|
+
}
|
|
2691
|
+
}
|
|
2273
2692
|
}
|
|
2274
2693
|
export interface SubscriptionListParams extends PageParams {
|
|
2275
2694
|
'created_at[gt]'?: string | null;
|
|
@@ -2410,7 +2829,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2410
2829
|
/**
|
|
2411
2830
|
* The definition of a new price to create and add to the subscription.
|
|
2412
2831
|
*/
|
|
2413
|
-
price?: Add.
|
|
2832
|
+
price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | null;
|
|
2414
2833
|
/**
|
|
2415
2834
|
* The id of the price to add to the subscription.
|
|
2416
2835
|
*/
|
|
@@ -2450,11 +2869,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2450
2869
|
*/
|
|
2451
2870
|
quantity: number;
|
|
2452
2871
|
}
|
|
2453
|
-
interface
|
|
2872
|
+
interface NewFloatingUnitPrice {
|
|
2454
2873
|
/**
|
|
2455
2874
|
* The cadence to bill for this price on.
|
|
2456
2875
|
*/
|
|
2457
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
2876
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2458
2877
|
/**
|
|
2459
2878
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2460
2879
|
*/
|
|
@@ -2468,7 +2887,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2468
2887
|
* The name of the price.
|
|
2469
2888
|
*/
|
|
2470
2889
|
name: string;
|
|
2471
|
-
unit_config:
|
|
2890
|
+
unit_config: NewFloatingUnitPrice.UnitConfig;
|
|
2472
2891
|
/**
|
|
2473
2892
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2474
2893
|
* usage-based.
|
|
@@ -2493,7 +2912,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2493
2912
|
*/
|
|
2494
2913
|
invoice_grouping_key?: string | null;
|
|
2495
2914
|
}
|
|
2496
|
-
namespace
|
|
2915
|
+
namespace NewFloatingUnitPrice {
|
|
2497
2916
|
interface UnitConfig {
|
|
2498
2917
|
/**
|
|
2499
2918
|
* Rate per unit of usage
|
|
@@ -2505,11 +2924,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2505
2924
|
scaling_factor?: number | null;
|
|
2506
2925
|
}
|
|
2507
2926
|
}
|
|
2508
|
-
interface
|
|
2927
|
+
interface NewFloatingPackagePrice {
|
|
2509
2928
|
/**
|
|
2510
2929
|
* The cadence to bill for this price on.
|
|
2511
2930
|
*/
|
|
2512
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
2931
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2513
2932
|
/**
|
|
2514
2933
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2515
2934
|
*/
|
|
@@ -2523,7 +2942,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2523
2942
|
* The name of the price.
|
|
2524
2943
|
*/
|
|
2525
2944
|
name: string;
|
|
2526
|
-
package_config:
|
|
2945
|
+
package_config: NewFloatingPackagePrice.PackageConfig;
|
|
2527
2946
|
/**
|
|
2528
2947
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2529
2948
|
* usage-based.
|
|
@@ -2548,7 +2967,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2548
2967
|
*/
|
|
2549
2968
|
invoice_grouping_key?: string | null;
|
|
2550
2969
|
}
|
|
2551
|
-
namespace
|
|
2970
|
+
namespace NewFloatingPackagePrice {
|
|
2552
2971
|
interface PackageConfig {
|
|
2553
2972
|
/**
|
|
2554
2973
|
* A currency amount to rate usage by
|
|
@@ -2561,11 +2980,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2561
2980
|
package_size?: number | null;
|
|
2562
2981
|
}
|
|
2563
2982
|
}
|
|
2564
|
-
interface
|
|
2983
|
+
interface NewFloatingMatrixPrice {
|
|
2565
2984
|
/**
|
|
2566
2985
|
* The cadence to bill for this price on.
|
|
2567
2986
|
*/
|
|
2568
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
2987
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2569
2988
|
/**
|
|
2570
2989
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2571
2990
|
*/
|
|
@@ -2574,7 +2993,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2574
2993
|
* The id of the item the plan will be associated with.
|
|
2575
2994
|
*/
|
|
2576
2995
|
item_id: string;
|
|
2577
|
-
matrix_config:
|
|
2996
|
+
matrix_config: NewFloatingMatrixPrice.MatrixConfig;
|
|
2578
2997
|
model_type: 'matrix';
|
|
2579
2998
|
/**
|
|
2580
2999
|
* The name of the price.
|
|
@@ -2604,7 +3023,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2604
3023
|
*/
|
|
2605
3024
|
invoice_grouping_key?: string | null;
|
|
2606
3025
|
}
|
|
2607
|
-
namespace
|
|
3026
|
+
namespace NewFloatingMatrixPrice {
|
|
2608
3027
|
interface MatrixConfig {
|
|
2609
3028
|
/**
|
|
2610
3029
|
* Default per unit rate for any usage not bucketed into a specified matrix_value
|
|
@@ -2643,11 +3062,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2643
3062
|
}
|
|
2644
3063
|
}
|
|
2645
3064
|
}
|
|
2646
|
-
interface
|
|
3065
|
+
interface NewFloatingTieredPrice {
|
|
2647
3066
|
/**
|
|
2648
3067
|
* The cadence to bill for this price on.
|
|
2649
3068
|
*/
|
|
2650
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3069
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2651
3070
|
/**
|
|
2652
3071
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2653
3072
|
*/
|
|
@@ -2661,7 +3080,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2661
3080
|
* The name of the price.
|
|
2662
3081
|
*/
|
|
2663
3082
|
name: string;
|
|
2664
|
-
tiered_config:
|
|
3083
|
+
tiered_config: NewFloatingTieredPrice.TieredConfig;
|
|
2665
3084
|
/**
|
|
2666
3085
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2667
3086
|
* usage-based.
|
|
@@ -2686,7 +3105,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2686
3105
|
*/
|
|
2687
3106
|
invoice_grouping_key?: string | null;
|
|
2688
3107
|
}
|
|
2689
|
-
namespace
|
|
3108
|
+
namespace NewFloatingTieredPrice {
|
|
2690
3109
|
interface TieredConfig {
|
|
2691
3110
|
/**
|
|
2692
3111
|
* Tiers for rating based on total usage quantities into the specified tier
|
|
@@ -2710,11 +3129,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2710
3129
|
}
|
|
2711
3130
|
}
|
|
2712
3131
|
}
|
|
2713
|
-
interface
|
|
3132
|
+
interface NewFloatingTieredBpsPrice {
|
|
2714
3133
|
/**
|
|
2715
3134
|
* The cadence to bill for this price on.
|
|
2716
3135
|
*/
|
|
2717
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3136
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2718
3137
|
/**
|
|
2719
3138
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2720
3139
|
*/
|
|
@@ -2728,7 +3147,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2728
3147
|
* The name of the price.
|
|
2729
3148
|
*/
|
|
2730
3149
|
name: string;
|
|
2731
|
-
tiered_bps_config:
|
|
3150
|
+
tiered_bps_config: NewFloatingTieredBpsPrice.TieredBpsConfig;
|
|
2732
3151
|
/**
|
|
2733
3152
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2734
3153
|
* usage-based.
|
|
@@ -2753,7 +3172,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2753
3172
|
*/
|
|
2754
3173
|
invoice_grouping_key?: string | null;
|
|
2755
3174
|
}
|
|
2756
|
-
namespace
|
|
3175
|
+
namespace NewFloatingTieredBpsPrice {
|
|
2757
3176
|
interface TieredBpsConfig {
|
|
2758
3177
|
/**
|
|
2759
3178
|
* Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
|
@@ -2782,12 +3201,12 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2782
3201
|
}
|
|
2783
3202
|
}
|
|
2784
3203
|
}
|
|
2785
|
-
interface
|
|
2786
|
-
bps_config:
|
|
3204
|
+
interface NewFloatingBpsPrice {
|
|
3205
|
+
bps_config: NewFloatingBpsPrice.BpsConfig;
|
|
2787
3206
|
/**
|
|
2788
3207
|
* The cadence to bill for this price on.
|
|
2789
3208
|
*/
|
|
2790
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3209
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2791
3210
|
/**
|
|
2792
3211
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2793
3212
|
*/
|
|
@@ -2825,7 +3244,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2825
3244
|
*/
|
|
2826
3245
|
invoice_grouping_key?: string | null;
|
|
2827
3246
|
}
|
|
2828
|
-
namespace
|
|
3247
|
+
namespace NewFloatingBpsPrice {
|
|
2829
3248
|
interface BpsConfig {
|
|
2830
3249
|
/**
|
|
2831
3250
|
* Basis point take rate per event
|
|
@@ -2837,12 +3256,12 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2837
3256
|
per_unit_maximum?: string | null;
|
|
2838
3257
|
}
|
|
2839
3258
|
}
|
|
2840
|
-
interface
|
|
2841
|
-
bulk_bps_config:
|
|
3259
|
+
interface NewFloatingBulkBpsPrice {
|
|
3260
|
+
bulk_bps_config: NewFloatingBulkBpsPrice.BulkBpsConfig;
|
|
2842
3261
|
/**
|
|
2843
3262
|
* The cadence to bill for this price on.
|
|
2844
3263
|
*/
|
|
2845
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3264
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2846
3265
|
/**
|
|
2847
3266
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2848
3267
|
*/
|
|
@@ -2880,7 +3299,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2880
3299
|
*/
|
|
2881
3300
|
invoice_grouping_key?: string | null;
|
|
2882
3301
|
}
|
|
2883
|
-
namespace
|
|
3302
|
+
namespace NewFloatingBulkBpsPrice {
|
|
2884
3303
|
interface BulkBpsConfig {
|
|
2885
3304
|
/**
|
|
2886
3305
|
* Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
|
@@ -2905,12 +3324,12 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2905
3324
|
}
|
|
2906
3325
|
}
|
|
2907
3326
|
}
|
|
2908
|
-
interface
|
|
2909
|
-
bulk_config:
|
|
3327
|
+
interface NewFloatingBulkPrice {
|
|
3328
|
+
bulk_config: NewFloatingBulkPrice.BulkConfig;
|
|
2910
3329
|
/**
|
|
2911
3330
|
* The cadence to bill for this price on.
|
|
2912
3331
|
*/
|
|
2913
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3332
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2914
3333
|
/**
|
|
2915
3334
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2916
3335
|
*/
|
|
@@ -2948,7 +3367,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2948
3367
|
*/
|
|
2949
3368
|
invoice_grouping_key?: string | null;
|
|
2950
3369
|
}
|
|
2951
|
-
namespace
|
|
3370
|
+
namespace NewFloatingBulkPrice {
|
|
2952
3371
|
interface BulkConfig {
|
|
2953
3372
|
/**
|
|
2954
3373
|
* Bulk tiers for rating based on total usage volume
|
|
@@ -2968,11 +3387,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
2968
3387
|
}
|
|
2969
3388
|
}
|
|
2970
3389
|
}
|
|
2971
|
-
interface
|
|
3390
|
+
interface NewFloatingThresholdTotalAmountPrice {
|
|
2972
3391
|
/**
|
|
2973
3392
|
* The cadence to bill for this price on.
|
|
2974
3393
|
*/
|
|
2975
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3394
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
2976
3395
|
/**
|
|
2977
3396
|
* An ISO 4217 currency string for which this price is billed in.
|
|
2978
3397
|
*/
|
|
@@ -3011,11 +3430,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3011
3430
|
*/
|
|
3012
3431
|
invoice_grouping_key?: string | null;
|
|
3013
3432
|
}
|
|
3014
|
-
interface
|
|
3433
|
+
interface NewFloatingTieredPackagePrice {
|
|
3015
3434
|
/**
|
|
3016
3435
|
* The cadence to bill for this price on.
|
|
3017
3436
|
*/
|
|
3018
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3437
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
3019
3438
|
/**
|
|
3020
3439
|
* An ISO 4217 currency string for which this price is billed in.
|
|
3021
3440
|
*/
|
|
@@ -3054,11 +3473,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3054
3473
|
*/
|
|
3055
3474
|
invoice_grouping_key?: string | null;
|
|
3056
3475
|
}
|
|
3057
|
-
interface
|
|
3476
|
+
interface NewFloatingTieredWithMinimumPrice {
|
|
3058
3477
|
/**
|
|
3059
3478
|
* The cadence to bill for this price on.
|
|
3060
3479
|
*/
|
|
3061
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3480
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
3062
3481
|
/**
|
|
3063
3482
|
* An ISO 4217 currency string for which this price is billed in.
|
|
3064
3483
|
*/
|
|
@@ -3097,11 +3516,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3097
3516
|
*/
|
|
3098
3517
|
invoice_grouping_key?: string | null;
|
|
3099
3518
|
}
|
|
3100
|
-
interface
|
|
3519
|
+
interface NewFloatingPackageWithAllocationPrice {
|
|
3101
3520
|
/**
|
|
3102
3521
|
* The cadence to bill for this price on.
|
|
3103
3522
|
*/
|
|
3104
|
-
cadence: 'annual' | 'monthly' | 'quarterly';
|
|
3523
|
+
cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
|
|
3105
3524
|
/**
|
|
3106
3525
|
* An ISO 4217 currency string for which this price is billed in.
|
|
3107
3526
|
*/
|
|
@@ -3146,6 +3565,12 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3146
3565
|
* The id of the price interval to edit.
|
|
3147
3566
|
*/
|
|
3148
3567
|
price_interval_id: string;
|
|
3568
|
+
/**
|
|
3569
|
+
* The updated billing cycle day for this price interval. If not specified, the
|
|
3570
|
+
* billing cycle day will not be updated. Note that overlapping price intervals
|
|
3571
|
+
* must have the same billing cycle day.
|
|
3572
|
+
*/
|
|
3573
|
+
billing_cycle_day?: number | null;
|
|
3149
3574
|
/**
|
|
3150
3575
|
* The updated end date of this price interval. If not specified, the start date
|
|
3151
3576
|
* will not be updated.
|
|
@@ -3161,7 +3586,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
|
|
|
3161
3586
|
* The updated start date of this price interval. If not specified, the start date
|
|
3162
3587
|
* will not be updated.
|
|
3163
3588
|
*/
|
|
3164
|
-
start_date?: (string & {}) | 'start_of_term' | 'end_of_term'
|
|
3589
|
+
start_date?: (string & {}) | 'start_of_term' | 'end_of_term';
|
|
3165
3590
|
}
|
|
3166
3591
|
namespace Edit {
|
|
3167
3592
|
interface FixedFeeQuantityTransition {
|
|
@@ -3235,7 +3660,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3235
3660
|
/**
|
|
3236
3661
|
* The subscription's override discount for the plan.
|
|
3237
3662
|
*/
|
|
3238
|
-
discount?:
|
|
3663
|
+
discount?: OverrideUnitPrice.Discount | null;
|
|
3239
3664
|
/**
|
|
3240
3665
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3241
3666
|
*/
|
|
@@ -3260,6 +3685,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3260
3685
|
*/
|
|
3261
3686
|
scaling_factor?: number | null;
|
|
3262
3687
|
}
|
|
3688
|
+
/**
|
|
3689
|
+
* The subscription's override discount for the plan.
|
|
3690
|
+
*/
|
|
3691
|
+
interface Discount {
|
|
3692
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
3693
|
+
/**
|
|
3694
|
+
* Only available if discount_type is `amount`.
|
|
3695
|
+
*/
|
|
3696
|
+
amount_discount?: string | null;
|
|
3697
|
+
/**
|
|
3698
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
3699
|
+
* this can be a subset of prices.
|
|
3700
|
+
*/
|
|
3701
|
+
applies_to_price_ids?: Array<string> | null;
|
|
3702
|
+
/**
|
|
3703
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
3704
|
+
* and 1.
|
|
3705
|
+
*/
|
|
3706
|
+
percentage_discount?: number | null;
|
|
3707
|
+
/**
|
|
3708
|
+
* Only available if discount_type is `trial`
|
|
3709
|
+
*/
|
|
3710
|
+
trial_amount_discount?: string | null;
|
|
3711
|
+
/**
|
|
3712
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
3713
|
+
* discount is for
|
|
3714
|
+
*/
|
|
3715
|
+
usage_discount?: number | null;
|
|
3716
|
+
}
|
|
3263
3717
|
}
|
|
3264
3718
|
interface OverridePackagePrice {
|
|
3265
3719
|
id: string;
|
|
@@ -3268,7 +3722,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3268
3722
|
/**
|
|
3269
3723
|
* The subscription's override discount for the plan.
|
|
3270
3724
|
*/
|
|
3271
|
-
discount?:
|
|
3725
|
+
discount?: OverridePackagePrice.Discount | null;
|
|
3272
3726
|
/**
|
|
3273
3727
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3274
3728
|
*/
|
|
@@ -3294,6 +3748,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3294
3748
|
*/
|
|
3295
3749
|
package_size?: number | null;
|
|
3296
3750
|
}
|
|
3751
|
+
/**
|
|
3752
|
+
* The subscription's override discount for the plan.
|
|
3753
|
+
*/
|
|
3754
|
+
interface Discount {
|
|
3755
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
3756
|
+
/**
|
|
3757
|
+
* Only available if discount_type is `amount`.
|
|
3758
|
+
*/
|
|
3759
|
+
amount_discount?: string | null;
|
|
3760
|
+
/**
|
|
3761
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
3762
|
+
* this can be a subset of prices.
|
|
3763
|
+
*/
|
|
3764
|
+
applies_to_price_ids?: Array<string> | null;
|
|
3765
|
+
/**
|
|
3766
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
3767
|
+
* and 1.
|
|
3768
|
+
*/
|
|
3769
|
+
percentage_discount?: number | null;
|
|
3770
|
+
/**
|
|
3771
|
+
* Only available if discount_type is `trial`
|
|
3772
|
+
*/
|
|
3773
|
+
trial_amount_discount?: string | null;
|
|
3774
|
+
/**
|
|
3775
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
3776
|
+
* discount is for
|
|
3777
|
+
*/
|
|
3778
|
+
usage_discount?: number | null;
|
|
3779
|
+
}
|
|
3297
3780
|
}
|
|
3298
3781
|
interface OverrideMatrixPrice {
|
|
3299
3782
|
id: string;
|
|
@@ -3302,7 +3785,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3302
3785
|
/**
|
|
3303
3786
|
* The subscription's override discount for the plan.
|
|
3304
3787
|
*/
|
|
3305
|
-
discount?:
|
|
3788
|
+
discount?: OverrideMatrixPrice.Discount | null;
|
|
3306
3789
|
/**
|
|
3307
3790
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3308
3791
|
*/
|
|
@@ -3354,6 +3837,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3354
3837
|
scaling_factor?: number | null;
|
|
3355
3838
|
}
|
|
3356
3839
|
}
|
|
3840
|
+
/**
|
|
3841
|
+
* The subscription's override discount for the plan.
|
|
3842
|
+
*/
|
|
3843
|
+
interface Discount {
|
|
3844
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
3845
|
+
/**
|
|
3846
|
+
* Only available if discount_type is `amount`.
|
|
3847
|
+
*/
|
|
3848
|
+
amount_discount?: string | null;
|
|
3849
|
+
/**
|
|
3850
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
3851
|
+
* this can be a subset of prices.
|
|
3852
|
+
*/
|
|
3853
|
+
applies_to_price_ids?: Array<string> | null;
|
|
3854
|
+
/**
|
|
3855
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
3856
|
+
* and 1.
|
|
3857
|
+
*/
|
|
3858
|
+
percentage_discount?: number | null;
|
|
3859
|
+
/**
|
|
3860
|
+
* Only available if discount_type is `trial`
|
|
3861
|
+
*/
|
|
3862
|
+
trial_amount_discount?: string | null;
|
|
3863
|
+
/**
|
|
3864
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
3865
|
+
* discount is for
|
|
3866
|
+
*/
|
|
3867
|
+
usage_discount?: number | null;
|
|
3868
|
+
}
|
|
3357
3869
|
}
|
|
3358
3870
|
interface OverrideTieredPrice {
|
|
3359
3871
|
id: string;
|
|
@@ -3362,7 +3874,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3362
3874
|
/**
|
|
3363
3875
|
* The subscription's override discount for the plan.
|
|
3364
3876
|
*/
|
|
3365
|
-
discount?:
|
|
3877
|
+
discount?: OverrideTieredPrice.Discount | null;
|
|
3366
3878
|
/**
|
|
3367
3879
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3368
3880
|
*/
|
|
@@ -3399,6 +3911,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3399
3911
|
last_unit?: number | null;
|
|
3400
3912
|
}
|
|
3401
3913
|
}
|
|
3914
|
+
/**
|
|
3915
|
+
* The subscription's override discount for the plan.
|
|
3916
|
+
*/
|
|
3917
|
+
interface Discount {
|
|
3918
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
3919
|
+
/**
|
|
3920
|
+
* Only available if discount_type is `amount`.
|
|
3921
|
+
*/
|
|
3922
|
+
amount_discount?: string | null;
|
|
3923
|
+
/**
|
|
3924
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
3925
|
+
* this can be a subset of prices.
|
|
3926
|
+
*/
|
|
3927
|
+
applies_to_price_ids?: Array<string> | null;
|
|
3928
|
+
/**
|
|
3929
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
3930
|
+
* and 1.
|
|
3931
|
+
*/
|
|
3932
|
+
percentage_discount?: number | null;
|
|
3933
|
+
/**
|
|
3934
|
+
* Only available if discount_type is `trial`
|
|
3935
|
+
*/
|
|
3936
|
+
trial_amount_discount?: string | null;
|
|
3937
|
+
/**
|
|
3938
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
3939
|
+
* discount is for
|
|
3940
|
+
*/
|
|
3941
|
+
usage_discount?: number | null;
|
|
3942
|
+
}
|
|
3402
3943
|
}
|
|
3403
3944
|
interface OverrideTieredBpsPrice {
|
|
3404
3945
|
id: string;
|
|
@@ -3407,7 +3948,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3407
3948
|
/**
|
|
3408
3949
|
* The subscription's override discount for the plan.
|
|
3409
3950
|
*/
|
|
3410
|
-
discount?:
|
|
3951
|
+
discount?: OverrideTieredBpsPrice.Discount | null;
|
|
3411
3952
|
/**
|
|
3412
3953
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3413
3954
|
*/
|
|
@@ -3449,6 +3990,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3449
3990
|
per_unit_maximum?: string | null;
|
|
3450
3991
|
}
|
|
3451
3992
|
}
|
|
3993
|
+
/**
|
|
3994
|
+
* The subscription's override discount for the plan.
|
|
3995
|
+
*/
|
|
3996
|
+
interface Discount {
|
|
3997
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
3998
|
+
/**
|
|
3999
|
+
* Only available if discount_type is `amount`.
|
|
4000
|
+
*/
|
|
4001
|
+
amount_discount?: string | null;
|
|
4002
|
+
/**
|
|
4003
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4004
|
+
* this can be a subset of prices.
|
|
4005
|
+
*/
|
|
4006
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4007
|
+
/**
|
|
4008
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4009
|
+
* and 1.
|
|
4010
|
+
*/
|
|
4011
|
+
percentage_discount?: number | null;
|
|
4012
|
+
/**
|
|
4013
|
+
* Only available if discount_type is `trial`
|
|
4014
|
+
*/
|
|
4015
|
+
trial_amount_discount?: string | null;
|
|
4016
|
+
/**
|
|
4017
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4018
|
+
* discount is for
|
|
4019
|
+
*/
|
|
4020
|
+
usage_discount?: number | null;
|
|
4021
|
+
}
|
|
3452
4022
|
}
|
|
3453
4023
|
interface OverrideBpsPrice {
|
|
3454
4024
|
id: string;
|
|
@@ -3457,7 +4027,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3457
4027
|
/**
|
|
3458
4028
|
* The subscription's override discount for the plan.
|
|
3459
4029
|
*/
|
|
3460
|
-
discount?:
|
|
4030
|
+
discount?: OverrideBpsPrice.Discount | null;
|
|
3461
4031
|
/**
|
|
3462
4032
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3463
4033
|
*/
|
|
@@ -3482,6 +4052,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3482
4052
|
*/
|
|
3483
4053
|
per_unit_maximum?: string | null;
|
|
3484
4054
|
}
|
|
4055
|
+
/**
|
|
4056
|
+
* The subscription's override discount for the plan.
|
|
4057
|
+
*/
|
|
4058
|
+
interface Discount {
|
|
4059
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4060
|
+
/**
|
|
4061
|
+
* Only available if discount_type is `amount`.
|
|
4062
|
+
*/
|
|
4063
|
+
amount_discount?: string | null;
|
|
4064
|
+
/**
|
|
4065
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4066
|
+
* this can be a subset of prices.
|
|
4067
|
+
*/
|
|
4068
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4069
|
+
/**
|
|
4070
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4071
|
+
* and 1.
|
|
4072
|
+
*/
|
|
4073
|
+
percentage_discount?: number | null;
|
|
4074
|
+
/**
|
|
4075
|
+
* Only available if discount_type is `trial`
|
|
4076
|
+
*/
|
|
4077
|
+
trial_amount_discount?: string | null;
|
|
4078
|
+
/**
|
|
4079
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4080
|
+
* discount is for
|
|
4081
|
+
*/
|
|
4082
|
+
usage_discount?: number | null;
|
|
4083
|
+
}
|
|
3485
4084
|
}
|
|
3486
4085
|
interface OverrideBulkBpsPrice {
|
|
3487
4086
|
id: string;
|
|
@@ -3490,7 +4089,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3490
4089
|
/**
|
|
3491
4090
|
* The subscription's override discount for the plan.
|
|
3492
4091
|
*/
|
|
3493
|
-
discount?:
|
|
4092
|
+
discount?: OverrideBulkBpsPrice.Discount | null;
|
|
3494
4093
|
/**
|
|
3495
4094
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3496
4095
|
*/
|
|
@@ -3528,6 +4127,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3528
4127
|
per_unit_maximum?: string | null;
|
|
3529
4128
|
}
|
|
3530
4129
|
}
|
|
4130
|
+
/**
|
|
4131
|
+
* The subscription's override discount for the plan.
|
|
4132
|
+
*/
|
|
4133
|
+
interface Discount {
|
|
4134
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4135
|
+
/**
|
|
4136
|
+
* Only available if discount_type is `amount`.
|
|
4137
|
+
*/
|
|
4138
|
+
amount_discount?: string | null;
|
|
4139
|
+
/**
|
|
4140
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4141
|
+
* this can be a subset of prices.
|
|
4142
|
+
*/
|
|
4143
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4144
|
+
/**
|
|
4145
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4146
|
+
* and 1.
|
|
4147
|
+
*/
|
|
4148
|
+
percentage_discount?: number | null;
|
|
4149
|
+
/**
|
|
4150
|
+
* Only available if discount_type is `trial`
|
|
4151
|
+
*/
|
|
4152
|
+
trial_amount_discount?: string | null;
|
|
4153
|
+
/**
|
|
4154
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4155
|
+
* discount is for
|
|
4156
|
+
*/
|
|
4157
|
+
usage_discount?: number | null;
|
|
4158
|
+
}
|
|
3531
4159
|
}
|
|
3532
4160
|
interface OverrideBulkPrice {
|
|
3533
4161
|
id: string;
|
|
@@ -3536,7 +4164,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3536
4164
|
/**
|
|
3537
4165
|
* The subscription's override discount for the plan.
|
|
3538
4166
|
*/
|
|
3539
|
-
discount?:
|
|
4167
|
+
discount?: OverrideBulkPrice.Discount | null;
|
|
3540
4168
|
/**
|
|
3541
4169
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3542
4170
|
*/
|
|
@@ -3569,6 +4197,35 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3569
4197
|
maximum_units?: number | null;
|
|
3570
4198
|
}
|
|
3571
4199
|
}
|
|
4200
|
+
/**
|
|
4201
|
+
* The subscription's override discount for the plan.
|
|
4202
|
+
*/
|
|
4203
|
+
interface Discount {
|
|
4204
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4205
|
+
/**
|
|
4206
|
+
* Only available if discount_type is `amount`.
|
|
4207
|
+
*/
|
|
4208
|
+
amount_discount?: string | null;
|
|
4209
|
+
/**
|
|
4210
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4211
|
+
* this can be a subset of prices.
|
|
4212
|
+
*/
|
|
4213
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4214
|
+
/**
|
|
4215
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4216
|
+
* and 1.
|
|
4217
|
+
*/
|
|
4218
|
+
percentage_discount?: number | null;
|
|
4219
|
+
/**
|
|
4220
|
+
* Only available if discount_type is `trial`
|
|
4221
|
+
*/
|
|
4222
|
+
trial_amount_discount?: string | null;
|
|
4223
|
+
/**
|
|
4224
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4225
|
+
* discount is for
|
|
4226
|
+
*/
|
|
4227
|
+
usage_discount?: number | null;
|
|
4228
|
+
}
|
|
3572
4229
|
}
|
|
3573
4230
|
interface OverrideTestRatingFunctionPrice {
|
|
3574
4231
|
id: string;
|
|
@@ -3577,7 +4234,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3577
4234
|
/**
|
|
3578
4235
|
* The subscription's override discount for the plan.
|
|
3579
4236
|
*/
|
|
3580
|
-
discount?:
|
|
4237
|
+
discount?: OverrideTestRatingFunctionPrice.Discount | null;
|
|
3581
4238
|
/**
|
|
3582
4239
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3583
4240
|
*/
|
|
@@ -3591,6 +4248,37 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3591
4248
|
*/
|
|
3592
4249
|
minimum_amount?: string | null;
|
|
3593
4250
|
}
|
|
4251
|
+
namespace OverrideTestRatingFunctionPrice {
|
|
4252
|
+
/**
|
|
4253
|
+
* The subscription's override discount for the plan.
|
|
4254
|
+
*/
|
|
4255
|
+
interface Discount {
|
|
4256
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4257
|
+
/**
|
|
4258
|
+
* Only available if discount_type is `amount`.
|
|
4259
|
+
*/
|
|
4260
|
+
amount_discount?: string | null;
|
|
4261
|
+
/**
|
|
4262
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4263
|
+
* this can be a subset of prices.
|
|
4264
|
+
*/
|
|
4265
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4266
|
+
/**
|
|
4267
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4268
|
+
* and 1.
|
|
4269
|
+
*/
|
|
4270
|
+
percentage_discount?: number | null;
|
|
4271
|
+
/**
|
|
4272
|
+
* Only available if discount_type is `trial`
|
|
4273
|
+
*/
|
|
4274
|
+
trial_amount_discount?: string | null;
|
|
4275
|
+
/**
|
|
4276
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4277
|
+
* discount is for
|
|
4278
|
+
*/
|
|
4279
|
+
usage_discount?: number | null;
|
|
4280
|
+
}
|
|
4281
|
+
}
|
|
3594
4282
|
interface OverrideFivetranExamplePrice {
|
|
3595
4283
|
id: string;
|
|
3596
4284
|
fivetran_example_config: Record<string, unknown>;
|
|
@@ -3598,7 +4286,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3598
4286
|
/**
|
|
3599
4287
|
* The subscription's override discount for the plan.
|
|
3600
4288
|
*/
|
|
3601
|
-
discount?:
|
|
4289
|
+
discount?: OverrideFivetranExamplePrice.Discount | null;
|
|
3602
4290
|
/**
|
|
3603
4291
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3604
4292
|
*/
|
|
@@ -3612,6 +4300,37 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3612
4300
|
*/
|
|
3613
4301
|
minimum_amount?: string | null;
|
|
3614
4302
|
}
|
|
4303
|
+
namespace OverrideFivetranExamplePrice {
|
|
4304
|
+
/**
|
|
4305
|
+
* The subscription's override discount for the plan.
|
|
4306
|
+
*/
|
|
4307
|
+
interface Discount {
|
|
4308
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4309
|
+
/**
|
|
4310
|
+
* Only available if discount_type is `amount`.
|
|
4311
|
+
*/
|
|
4312
|
+
amount_discount?: string | null;
|
|
4313
|
+
/**
|
|
4314
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4315
|
+
* this can be a subset of prices.
|
|
4316
|
+
*/
|
|
4317
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4318
|
+
/**
|
|
4319
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4320
|
+
* and 1.
|
|
4321
|
+
*/
|
|
4322
|
+
percentage_discount?: number | null;
|
|
4323
|
+
/**
|
|
4324
|
+
* Only available if discount_type is `trial`
|
|
4325
|
+
*/
|
|
4326
|
+
trial_amount_discount?: string | null;
|
|
4327
|
+
/**
|
|
4328
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4329
|
+
* discount is for
|
|
4330
|
+
*/
|
|
4331
|
+
usage_discount?: number | null;
|
|
4332
|
+
}
|
|
4333
|
+
}
|
|
3615
4334
|
interface OverrideThresholdTotalAmountPrice {
|
|
3616
4335
|
id: string;
|
|
3617
4336
|
model_type: 'threshold_total_amount';
|
|
@@ -3619,7 +4338,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3619
4338
|
/**
|
|
3620
4339
|
* The subscription's override discount for the plan.
|
|
3621
4340
|
*/
|
|
3622
|
-
discount?:
|
|
4341
|
+
discount?: OverrideThresholdTotalAmountPrice.Discount | null;
|
|
3623
4342
|
/**
|
|
3624
4343
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3625
4344
|
*/
|
|
@@ -3633,6 +4352,37 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3633
4352
|
*/
|
|
3634
4353
|
minimum_amount?: string | null;
|
|
3635
4354
|
}
|
|
4355
|
+
namespace OverrideThresholdTotalAmountPrice {
|
|
4356
|
+
/**
|
|
4357
|
+
* The subscription's override discount for the plan.
|
|
4358
|
+
*/
|
|
4359
|
+
interface Discount {
|
|
4360
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4361
|
+
/**
|
|
4362
|
+
* Only available if discount_type is `amount`.
|
|
4363
|
+
*/
|
|
4364
|
+
amount_discount?: string | null;
|
|
4365
|
+
/**
|
|
4366
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4367
|
+
* this can be a subset of prices.
|
|
4368
|
+
*/
|
|
4369
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4370
|
+
/**
|
|
4371
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4372
|
+
* and 1.
|
|
4373
|
+
*/
|
|
4374
|
+
percentage_discount?: number | null;
|
|
4375
|
+
/**
|
|
4376
|
+
* Only available if discount_type is `trial`
|
|
4377
|
+
*/
|
|
4378
|
+
trial_amount_discount?: string | null;
|
|
4379
|
+
/**
|
|
4380
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4381
|
+
* discount is for
|
|
4382
|
+
*/
|
|
4383
|
+
usage_discount?: number | null;
|
|
4384
|
+
}
|
|
4385
|
+
}
|
|
3636
4386
|
interface OverrideTieredPackagePrice {
|
|
3637
4387
|
id: string;
|
|
3638
4388
|
model_type: 'tiered_package';
|
|
@@ -3640,7 +4390,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3640
4390
|
/**
|
|
3641
4391
|
* The subscription's override discount for the plan.
|
|
3642
4392
|
*/
|
|
3643
|
-
discount?:
|
|
4393
|
+
discount?: OverrideTieredPackagePrice.Discount | null;
|
|
3644
4394
|
/**
|
|
3645
4395
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3646
4396
|
*/
|
|
@@ -3654,6 +4404,37 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3654
4404
|
*/
|
|
3655
4405
|
minimum_amount?: string | null;
|
|
3656
4406
|
}
|
|
4407
|
+
namespace OverrideTieredPackagePrice {
|
|
4408
|
+
/**
|
|
4409
|
+
* The subscription's override discount for the plan.
|
|
4410
|
+
*/
|
|
4411
|
+
interface Discount {
|
|
4412
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4413
|
+
/**
|
|
4414
|
+
* Only available if discount_type is `amount`.
|
|
4415
|
+
*/
|
|
4416
|
+
amount_discount?: string | null;
|
|
4417
|
+
/**
|
|
4418
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4419
|
+
* this can be a subset of prices.
|
|
4420
|
+
*/
|
|
4421
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4422
|
+
/**
|
|
4423
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4424
|
+
* and 1.
|
|
4425
|
+
*/
|
|
4426
|
+
percentage_discount?: number | null;
|
|
4427
|
+
/**
|
|
4428
|
+
* Only available if discount_type is `trial`
|
|
4429
|
+
*/
|
|
4430
|
+
trial_amount_discount?: string | null;
|
|
4431
|
+
/**
|
|
4432
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4433
|
+
* discount is for
|
|
4434
|
+
*/
|
|
4435
|
+
usage_discount?: number | null;
|
|
4436
|
+
}
|
|
4437
|
+
}
|
|
3657
4438
|
interface OverrideTieredWithMinimumPrice {
|
|
3658
4439
|
id: string;
|
|
3659
4440
|
model_type: 'tiered_with_minimum';
|
|
@@ -3661,7 +4442,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3661
4442
|
/**
|
|
3662
4443
|
* The subscription's override discount for the plan.
|
|
3663
4444
|
*/
|
|
3664
|
-
discount?:
|
|
4445
|
+
discount?: OverrideTieredWithMinimumPrice.Discount | null;
|
|
3665
4446
|
/**
|
|
3666
4447
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3667
4448
|
*/
|
|
@@ -3675,6 +4456,37 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3675
4456
|
*/
|
|
3676
4457
|
minimum_amount?: string | null;
|
|
3677
4458
|
}
|
|
4459
|
+
namespace OverrideTieredWithMinimumPrice {
|
|
4460
|
+
/**
|
|
4461
|
+
* The subscription's override discount for the plan.
|
|
4462
|
+
*/
|
|
4463
|
+
interface Discount {
|
|
4464
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4465
|
+
/**
|
|
4466
|
+
* Only available if discount_type is `amount`.
|
|
4467
|
+
*/
|
|
4468
|
+
amount_discount?: string | null;
|
|
4469
|
+
/**
|
|
4470
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4471
|
+
* this can be a subset of prices.
|
|
4472
|
+
*/
|
|
4473
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4474
|
+
/**
|
|
4475
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4476
|
+
* and 1.
|
|
4477
|
+
*/
|
|
4478
|
+
percentage_discount?: number | null;
|
|
4479
|
+
/**
|
|
4480
|
+
* Only available if discount_type is `trial`
|
|
4481
|
+
*/
|
|
4482
|
+
trial_amount_discount?: string | null;
|
|
4483
|
+
/**
|
|
4484
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4485
|
+
* discount is for
|
|
4486
|
+
*/
|
|
4487
|
+
usage_discount?: number | null;
|
|
4488
|
+
}
|
|
4489
|
+
}
|
|
3678
4490
|
interface OverridePackageWithAllocationPrice {
|
|
3679
4491
|
id: string;
|
|
3680
4492
|
model_type: 'package_with_allocation';
|
|
@@ -3682,7 +4494,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3682
4494
|
/**
|
|
3683
4495
|
* The subscription's override discount for the plan.
|
|
3684
4496
|
*/
|
|
3685
|
-
discount?:
|
|
4497
|
+
discount?: OverridePackageWithAllocationPrice.Discount | null;
|
|
3686
4498
|
/**
|
|
3687
4499
|
* The starting quantity of the price, if the price is a fixed price.
|
|
3688
4500
|
*/
|
|
@@ -3696,6 +4508,37 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
|
|
|
3696
4508
|
*/
|
|
3697
4509
|
minimum_amount?: string | null;
|
|
3698
4510
|
}
|
|
4511
|
+
namespace OverridePackageWithAllocationPrice {
|
|
4512
|
+
/**
|
|
4513
|
+
* The subscription's override discount for the plan.
|
|
4514
|
+
*/
|
|
4515
|
+
interface Discount {
|
|
4516
|
+
discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
|
|
4517
|
+
/**
|
|
4518
|
+
* Only available if discount_type is `amount`.
|
|
4519
|
+
*/
|
|
4520
|
+
amount_discount?: string | null;
|
|
4521
|
+
/**
|
|
4522
|
+
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
4523
|
+
* this can be a subset of prices.
|
|
4524
|
+
*/
|
|
4525
|
+
applies_to_price_ids?: Array<string> | null;
|
|
4526
|
+
/**
|
|
4527
|
+
* Only available if discount_type is `percentage`. This is a number between 0
|
|
4528
|
+
* and 1.
|
|
4529
|
+
*/
|
|
4530
|
+
percentage_discount?: number | null;
|
|
4531
|
+
/**
|
|
4532
|
+
* Only available if discount_type is `trial`
|
|
4533
|
+
*/
|
|
4534
|
+
trial_amount_discount?: string | null;
|
|
4535
|
+
/**
|
|
4536
|
+
* Only available if discount_type is `usage`. Number of usage units that this
|
|
4537
|
+
* discount is for
|
|
4538
|
+
*/
|
|
4539
|
+
usage_discount?: number | null;
|
|
4540
|
+
}
|
|
4541
|
+
}
|
|
3699
4542
|
}
|
|
3700
4543
|
export interface SubscriptionTriggerPhaseParams {
|
|
3701
4544
|
/**
|
|
@@ -3731,8 +4574,8 @@ export interface SubscriptionUpdateFixedFeeQuantityParams {
|
|
|
3731
4574
|
}
|
|
3732
4575
|
export declare namespace Subscriptions {
|
|
3733
4576
|
export import Subscription = SubscriptionsAPI.Subscription;
|
|
3734
|
-
export import Subscriptions = SubscriptionsAPI.Subscriptions;
|
|
3735
4577
|
export import SubscriptionUsage = SubscriptionsAPI.SubscriptionUsage;
|
|
4578
|
+
export import Subscriptions = SubscriptionsAPI.Subscriptions;
|
|
3736
4579
|
export import SubscriptionFetchCostsResponse = SubscriptionsAPI.SubscriptionFetchCostsResponse;
|
|
3737
4580
|
export import SubscriptionFetchScheduleResponse = SubscriptionsAPI.SubscriptionFetchScheduleResponse;
|
|
3738
4581
|
export import SubscriptionsPage = SubscriptionsAPI.SubscriptionsPage;
|