orb-billing 4.72.3 → 4.74.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 +30 -0
- package/README.md +18 -30
- package/index.d.mts +7 -4
- package/index.d.ts +7 -4
- package/index.d.ts.map +1 -1
- package/index.js +3 -0
- package/index.js.map +1 -1
- package/index.mjs +3 -0
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/alerts.d.ts +18 -0
- package/resources/alerts.d.ts.map +1 -1
- package/resources/alerts.js.map +1 -1
- package/resources/alerts.mjs.map +1 -1
- package/resources/beta/beta.d.ts +7492 -0
- package/resources/beta/beta.d.ts.map +1 -0
- package/resources/beta/beta.js +67 -0
- package/resources/beta/beta.js.map +1 -0
- package/resources/beta/beta.mjs +40 -0
- package/resources/beta/beta.mjs.map +1 -0
- package/resources/beta/external-plan-id.d.ts +7218 -0
- package/resources/beta/external-plan-id.d.ts.map +1 -0
- package/resources/beta/external-plan-id.js +40 -0
- package/resources/beta/external-plan-id.js.map +1 -0
- package/resources/beta/external-plan-id.mjs +36 -0
- package/resources/beta/external-plan-id.mjs.map +1 -0
- package/resources/beta/index.d.ts +3 -0
- package/resources/beta/index.d.ts.map +1 -0
- package/resources/beta/index.js +9 -0
- package/resources/beta/index.js.map +1 -0
- package/resources/beta/index.mjs +4 -0
- package/resources/beta/index.mjs.map +1 -0
- package/resources/beta.d.ts +2 -0
- package/resources/beta.d.ts.map +1 -0
- package/resources/beta.js +19 -0
- package/resources/beta.js.map +1 -0
- package/resources/beta.mjs +3 -0
- package/resources/beta.mjs.map +1 -0
- package/resources/credit-notes.d.ts +4 -4
- package/resources/credit-notes.d.ts.map +1 -1
- package/resources/customers/balance-transactions.d.ts +0 -7
- 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 +17 -0
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/credits/top-ups.d.ts +26 -14
- package/resources/customers/credits/top-ups.d.ts.map +1 -1
- package/resources/customers/credits/top-ups.js.map +1 -1
- package/resources/customers/credits/top-ups.mjs.map +1 -1
- package/resources/customers/customers.d.ts +16 -7
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js +1 -4
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs +1 -4
- 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/events.d.ts +3 -3
- package/resources/events/events.d.ts.map +1 -1
- package/resources/index.d.ts +3 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +150 -10
- package/resources/invoice-line-items.d.ts.map +1 -1
- package/resources/invoices.d.ts +388 -28
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs.map +1 -1
- package/resources/items.d.ts +23 -0
- package/resources/items.d.ts.map +1 -1
- package/resources/items.js +6 -0
- package/resources/items.js.map +1 -1
- package/resources/items.mjs +6 -0
- package/resources/items.mjs.map +1 -1
- package/resources/plans/external-plan-id.d.ts +1 -1
- package/resources/plans/external-plan-id.js +1 -1
- package/resources/plans/external-plan-id.mjs +1 -1
- package/resources/plans/plans.d.ts +1153 -22
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs +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.map +1 -1
- package/resources/prices/index.mjs.map +1 -1
- package/resources/prices/prices.d.ts +6180 -123
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js +40 -1
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs +40 -1
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/shared.d.ts +14 -14
- package/resources/shared.d.ts.map +1 -1
- package/resources/subscription-changes.d.ts +648 -87
- package/resources/subscription-changes.d.ts.map +1 -1
- package/resources/subscriptions.d.ts +10981 -3716
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +6 -0
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +6 -0
- package/resources/subscriptions.mjs.map +1 -1
- package/src/index.ts +25 -0
- package/src/resources/alerts.ts +21 -0
- package/src/resources/beta/beta.ts +9106 -0
- package/src/resources/beta/external-plan-id.ts +8748 -0
- package/src/resources/beta/index.ts +14 -0
- package/src/resources/beta.ts +3 -0
- package/src/resources/credit-notes.ts +4 -4
- package/src/resources/customers/balance-transactions.ts +0 -7
- package/src/resources/customers/credits/ledger.ts +21 -0
- package/src/resources/customers/credits/top-ups.ts +26 -14
- package/src/resources/customers/customers.ts +22 -4
- package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +1 -1
- package/src/resources/events/events.ts +3 -3
- package/src/resources/index.ts +11 -0
- package/src/resources/invoice-line-items.ts +178 -10
- package/src/resources/invoices.ts +460 -28
- package/src/resources/items.ts +29 -0
- package/src/resources/plans/external-plan-id.ts +1 -1
- package/src/resources/plans/plans.ts +1375 -30
- package/src/resources/prices/index.ts +2 -0
- package/src/resources/prices/prices.ts +7345 -135
- package/src/resources/shared.ts +18 -18
- package/src/resources/subscription-changes.ts +771 -102
- package/src/resources/subscriptions.ts +13383 -4686
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -15,7 +15,7 @@ export declare class Plans extends APIResource {
|
|
|
15
15
|
* This endpoint can be used to update the `external_plan_id`, and `metadata` of an
|
|
16
16
|
* existing plan.
|
|
17
17
|
*
|
|
18
|
-
* Other fields on a
|
|
18
|
+
* Other fields on a plan are currently immutable.
|
|
19
19
|
*/
|
|
20
20
|
update(planId: string, body: PlanUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Plan>;
|
|
21
21
|
/**
|
|
@@ -81,6 +81,9 @@ export interface Plan {
|
|
|
81
81
|
*/
|
|
82
82
|
default_invoice_memo: string | null;
|
|
83
83
|
description: string;
|
|
84
|
+
/**
|
|
85
|
+
* @deprecated
|
|
86
|
+
*/
|
|
84
87
|
discount: Shared.Discount | null;
|
|
85
88
|
/**
|
|
86
89
|
* An optional user-defined ID for this plan resource, used throughout the system
|
|
@@ -93,7 +96,13 @@ export interface Plan {
|
|
|
93
96
|
* unless `currency` is a custom pricing unit.
|
|
94
97
|
*/
|
|
95
98
|
invoicing_currency: string;
|
|
99
|
+
/**
|
|
100
|
+
* @deprecated
|
|
101
|
+
*/
|
|
96
102
|
maximum: Plan.Maximum | null;
|
|
103
|
+
/**
|
|
104
|
+
* @deprecated
|
|
105
|
+
*/
|
|
97
106
|
maximum_amount: string | null;
|
|
98
107
|
/**
|
|
99
108
|
* User specified key-value pairs for the resource. If not present, this defaults
|
|
@@ -102,7 +111,13 @@ export interface Plan {
|
|
|
102
111
|
* `null`.
|
|
103
112
|
*/
|
|
104
113
|
metadata: Record<string, string>;
|
|
114
|
+
/**
|
|
115
|
+
* @deprecated
|
|
116
|
+
*/
|
|
105
117
|
minimum: Plan.Minimum | null;
|
|
118
|
+
/**
|
|
119
|
+
* @deprecated
|
|
120
|
+
*/
|
|
106
121
|
minimum_amount: string | null;
|
|
107
122
|
name: string;
|
|
108
123
|
/**
|
|
@@ -129,9 +144,13 @@ export declare namespace Plan {
|
|
|
129
144
|
id: string;
|
|
130
145
|
adjustment_type: 'usage_discount';
|
|
131
146
|
/**
|
|
132
|
-
* The price IDs that this adjustment applies to.
|
|
147
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
133
148
|
*/
|
|
134
149
|
applies_to_price_ids: Array<string>;
|
|
150
|
+
/**
|
|
151
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
152
|
+
*/
|
|
153
|
+
filters: Array<PlanPhaseUsageDiscountAdjustment.Filter>;
|
|
135
154
|
/**
|
|
136
155
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
137
156
|
* that apply to only one price.
|
|
@@ -151,6 +170,22 @@ export declare namespace Plan {
|
|
|
151
170
|
*/
|
|
152
171
|
usage_discount: number;
|
|
153
172
|
}
|
|
173
|
+
namespace PlanPhaseUsageDiscountAdjustment {
|
|
174
|
+
interface Filter {
|
|
175
|
+
/**
|
|
176
|
+
* The property of the price to filter on.
|
|
177
|
+
*/
|
|
178
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
179
|
+
/**
|
|
180
|
+
* Should prices that match the filter be included or excluded.
|
|
181
|
+
*/
|
|
182
|
+
operator: 'includes' | 'excludes';
|
|
183
|
+
/**
|
|
184
|
+
* The IDs or values that match this filter.
|
|
185
|
+
*/
|
|
186
|
+
values: Array<string>;
|
|
187
|
+
}
|
|
188
|
+
}
|
|
154
189
|
interface PlanPhaseAmountDiscountAdjustment {
|
|
155
190
|
id: string;
|
|
156
191
|
adjustment_type: 'amount_discount';
|
|
@@ -160,9 +195,13 @@ export declare namespace Plan {
|
|
|
160
195
|
*/
|
|
161
196
|
amount_discount: string;
|
|
162
197
|
/**
|
|
163
|
-
* The price IDs that this adjustment applies to.
|
|
198
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
164
199
|
*/
|
|
165
200
|
applies_to_price_ids: Array<string>;
|
|
201
|
+
/**
|
|
202
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
203
|
+
*/
|
|
204
|
+
filters: Array<PlanPhaseAmountDiscountAdjustment.Filter>;
|
|
166
205
|
/**
|
|
167
206
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
168
207
|
* that apply to only one price.
|
|
@@ -177,13 +216,33 @@ export declare namespace Plan {
|
|
|
177
216
|
*/
|
|
178
217
|
reason: string | null;
|
|
179
218
|
}
|
|
219
|
+
namespace PlanPhaseAmountDiscountAdjustment {
|
|
220
|
+
interface Filter {
|
|
221
|
+
/**
|
|
222
|
+
* The property of the price to filter on.
|
|
223
|
+
*/
|
|
224
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
225
|
+
/**
|
|
226
|
+
* Should prices that match the filter be included or excluded.
|
|
227
|
+
*/
|
|
228
|
+
operator: 'includes' | 'excludes';
|
|
229
|
+
/**
|
|
230
|
+
* The IDs or values that match this filter.
|
|
231
|
+
*/
|
|
232
|
+
values: Array<string>;
|
|
233
|
+
}
|
|
234
|
+
}
|
|
180
235
|
interface PlanPhasePercentageDiscountAdjustment {
|
|
181
236
|
id: string;
|
|
182
237
|
adjustment_type: 'percentage_discount';
|
|
183
238
|
/**
|
|
184
|
-
* The price IDs that this adjustment applies to.
|
|
239
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
185
240
|
*/
|
|
186
241
|
applies_to_price_ids: Array<string>;
|
|
242
|
+
/**
|
|
243
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
244
|
+
*/
|
|
245
|
+
filters: Array<PlanPhasePercentageDiscountAdjustment.Filter>;
|
|
187
246
|
/**
|
|
188
247
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
189
248
|
* that apply to only one price.
|
|
@@ -203,13 +262,33 @@ export declare namespace Plan {
|
|
|
203
262
|
*/
|
|
204
263
|
reason: string | null;
|
|
205
264
|
}
|
|
265
|
+
namespace PlanPhasePercentageDiscountAdjustment {
|
|
266
|
+
interface Filter {
|
|
267
|
+
/**
|
|
268
|
+
* The property of the price to filter on.
|
|
269
|
+
*/
|
|
270
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
271
|
+
/**
|
|
272
|
+
* Should prices that match the filter be included or excluded.
|
|
273
|
+
*/
|
|
274
|
+
operator: 'includes' | 'excludes';
|
|
275
|
+
/**
|
|
276
|
+
* The IDs or values that match this filter.
|
|
277
|
+
*/
|
|
278
|
+
values: Array<string>;
|
|
279
|
+
}
|
|
280
|
+
}
|
|
206
281
|
interface PlanPhaseMinimumAdjustment {
|
|
207
282
|
id: string;
|
|
208
283
|
adjustment_type: 'minimum';
|
|
209
284
|
/**
|
|
210
|
-
* The price IDs that this adjustment applies to.
|
|
285
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
211
286
|
*/
|
|
212
287
|
applies_to_price_ids: Array<string>;
|
|
288
|
+
/**
|
|
289
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
290
|
+
*/
|
|
291
|
+
filters: Array<PlanPhaseMinimumAdjustment.Filter>;
|
|
213
292
|
/**
|
|
214
293
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
215
294
|
* that apply to only one price.
|
|
@@ -233,13 +312,33 @@ export declare namespace Plan {
|
|
|
233
312
|
*/
|
|
234
313
|
reason: string | null;
|
|
235
314
|
}
|
|
315
|
+
namespace PlanPhaseMinimumAdjustment {
|
|
316
|
+
interface Filter {
|
|
317
|
+
/**
|
|
318
|
+
* The property of the price to filter on.
|
|
319
|
+
*/
|
|
320
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
321
|
+
/**
|
|
322
|
+
* Should prices that match the filter be included or excluded.
|
|
323
|
+
*/
|
|
324
|
+
operator: 'includes' | 'excludes';
|
|
325
|
+
/**
|
|
326
|
+
* The IDs or values that match this filter.
|
|
327
|
+
*/
|
|
328
|
+
values: Array<string>;
|
|
329
|
+
}
|
|
330
|
+
}
|
|
236
331
|
interface PlanPhaseMaximumAdjustment {
|
|
237
332
|
id: string;
|
|
238
333
|
adjustment_type: 'maximum';
|
|
239
334
|
/**
|
|
240
|
-
* The price IDs that this adjustment applies to.
|
|
335
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
241
336
|
*/
|
|
242
337
|
applies_to_price_ids: Array<string>;
|
|
338
|
+
/**
|
|
339
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
340
|
+
*/
|
|
341
|
+
filters: Array<PlanPhaseMaximumAdjustment.Filter>;
|
|
243
342
|
/**
|
|
244
343
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
245
344
|
* that apply to only one price.
|
|
@@ -259,6 +358,22 @@ export declare namespace Plan {
|
|
|
259
358
|
*/
|
|
260
359
|
reason: string | null;
|
|
261
360
|
}
|
|
361
|
+
namespace PlanPhaseMaximumAdjustment {
|
|
362
|
+
interface Filter {
|
|
363
|
+
/**
|
|
364
|
+
* The property of the price to filter on.
|
|
365
|
+
*/
|
|
366
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
367
|
+
/**
|
|
368
|
+
* Should prices that match the filter be included or excluded.
|
|
369
|
+
*/
|
|
370
|
+
operator: 'includes' | 'excludes';
|
|
371
|
+
/**
|
|
372
|
+
* The IDs or values that match this filter.
|
|
373
|
+
*/
|
|
374
|
+
values: Array<string>;
|
|
375
|
+
}
|
|
376
|
+
}
|
|
262
377
|
interface BasePlan {
|
|
263
378
|
id: string | null;
|
|
264
379
|
/**
|
|
@@ -269,28 +384,74 @@ export declare namespace Plan {
|
|
|
269
384
|
external_plan_id: string | null;
|
|
270
385
|
name: string | null;
|
|
271
386
|
}
|
|
387
|
+
/**
|
|
388
|
+
* @deprecated
|
|
389
|
+
*/
|
|
272
390
|
interface Maximum {
|
|
273
391
|
/**
|
|
274
|
-
* List of price_ids that this maximum amount applies to. For plan/plan
|
|
275
|
-
* maximums, this can be a subset of prices.
|
|
392
|
+
* @deprecated List of price_ids that this maximum amount applies to. For plan/plan
|
|
393
|
+
* phase maximums, this can be a subset of prices.
|
|
276
394
|
*/
|
|
277
395
|
applies_to_price_ids: Array<string>;
|
|
396
|
+
/**
|
|
397
|
+
* The filters that determine which prices to apply this maximum to.
|
|
398
|
+
*/
|
|
399
|
+
filters: Array<Maximum.Filter>;
|
|
278
400
|
/**
|
|
279
401
|
* Maximum amount applied
|
|
280
402
|
*/
|
|
281
403
|
maximum_amount: string;
|
|
282
404
|
}
|
|
405
|
+
namespace Maximum {
|
|
406
|
+
interface Filter {
|
|
407
|
+
/**
|
|
408
|
+
* The property of the price to filter on.
|
|
409
|
+
*/
|
|
410
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
411
|
+
/**
|
|
412
|
+
* Should prices that match the filter be included or excluded.
|
|
413
|
+
*/
|
|
414
|
+
operator: 'includes' | 'excludes';
|
|
415
|
+
/**
|
|
416
|
+
* The IDs or values that match this filter.
|
|
417
|
+
*/
|
|
418
|
+
values: Array<string>;
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* @deprecated
|
|
423
|
+
*/
|
|
283
424
|
interface Minimum {
|
|
284
425
|
/**
|
|
285
|
-
* List of price_ids that this minimum amount applies to. For plan/plan
|
|
286
|
-
* minimums, this can be a subset of prices.
|
|
426
|
+
* @deprecated List of price_ids that this minimum amount applies to. For plan/plan
|
|
427
|
+
* phase minimums, this can be a subset of prices.
|
|
287
428
|
*/
|
|
288
429
|
applies_to_price_ids: Array<string>;
|
|
430
|
+
/**
|
|
431
|
+
* The filters that determine which prices to apply this minimum to.
|
|
432
|
+
*/
|
|
433
|
+
filters: Array<Minimum.Filter>;
|
|
289
434
|
/**
|
|
290
435
|
* Minimum amount applied
|
|
291
436
|
*/
|
|
292
437
|
minimum_amount: string;
|
|
293
438
|
}
|
|
439
|
+
namespace Minimum {
|
|
440
|
+
interface Filter {
|
|
441
|
+
/**
|
|
442
|
+
* The property of the price to filter on.
|
|
443
|
+
*/
|
|
444
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
445
|
+
/**
|
|
446
|
+
* Should prices that match the filter be included or excluded.
|
|
447
|
+
*/
|
|
448
|
+
operator: 'includes' | 'excludes';
|
|
449
|
+
/**
|
|
450
|
+
* The IDs or values that match this filter.
|
|
451
|
+
*/
|
|
452
|
+
values: Array<string>;
|
|
453
|
+
}
|
|
454
|
+
}
|
|
294
455
|
interface PlanPhase {
|
|
295
456
|
id: string;
|
|
296
457
|
description: string | null;
|
|
@@ -314,26 +475,66 @@ export declare namespace Plan {
|
|
|
314
475
|
namespace PlanPhase {
|
|
315
476
|
interface Maximum {
|
|
316
477
|
/**
|
|
317
|
-
* List of price_ids that this maximum amount applies to. For plan/plan
|
|
318
|
-
* maximums, this can be a subset of prices.
|
|
478
|
+
* @deprecated List of price_ids that this maximum amount applies to. For plan/plan
|
|
479
|
+
* phase maximums, this can be a subset of prices.
|
|
319
480
|
*/
|
|
320
481
|
applies_to_price_ids: Array<string>;
|
|
482
|
+
/**
|
|
483
|
+
* The filters that determine which prices to apply this maximum to.
|
|
484
|
+
*/
|
|
485
|
+
filters: Array<Maximum.Filter>;
|
|
321
486
|
/**
|
|
322
487
|
* Maximum amount applied
|
|
323
488
|
*/
|
|
324
489
|
maximum_amount: string;
|
|
325
490
|
}
|
|
491
|
+
namespace Maximum {
|
|
492
|
+
interface Filter {
|
|
493
|
+
/**
|
|
494
|
+
* The property of the price to filter on.
|
|
495
|
+
*/
|
|
496
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
497
|
+
/**
|
|
498
|
+
* Should prices that match the filter be included or excluded.
|
|
499
|
+
*/
|
|
500
|
+
operator: 'includes' | 'excludes';
|
|
501
|
+
/**
|
|
502
|
+
* The IDs or values that match this filter.
|
|
503
|
+
*/
|
|
504
|
+
values: Array<string>;
|
|
505
|
+
}
|
|
506
|
+
}
|
|
326
507
|
interface Minimum {
|
|
327
508
|
/**
|
|
328
|
-
* List of price_ids that this minimum amount applies to. For plan/plan
|
|
329
|
-
* minimums, this can be a subset of prices.
|
|
509
|
+
* @deprecated List of price_ids that this minimum amount applies to. For plan/plan
|
|
510
|
+
* phase minimums, this can be a subset of prices.
|
|
330
511
|
*/
|
|
331
512
|
applies_to_price_ids: Array<string>;
|
|
513
|
+
/**
|
|
514
|
+
* The filters that determine which prices to apply this minimum to.
|
|
515
|
+
*/
|
|
516
|
+
filters: Array<Minimum.Filter>;
|
|
332
517
|
/**
|
|
333
518
|
* Minimum amount applied
|
|
334
519
|
*/
|
|
335
520
|
minimum_amount: string;
|
|
336
521
|
}
|
|
522
|
+
namespace Minimum {
|
|
523
|
+
interface Filter {
|
|
524
|
+
/**
|
|
525
|
+
* The property of the price to filter on.
|
|
526
|
+
*/
|
|
527
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
528
|
+
/**
|
|
529
|
+
* Should prices that match the filter be included or excluded.
|
|
530
|
+
*/
|
|
531
|
+
operator: 'includes' | 'excludes';
|
|
532
|
+
/**
|
|
533
|
+
* The IDs or values that match this filter.
|
|
534
|
+
*/
|
|
535
|
+
values: Array<string>;
|
|
536
|
+
}
|
|
537
|
+
}
|
|
337
538
|
}
|
|
338
539
|
interface Product {
|
|
339
540
|
id: string;
|
|
@@ -356,7 +557,7 @@ export interface PlanCreateParams {
|
|
|
356
557
|
* Prices for this plan. If the plan has phases, this includes prices across all
|
|
357
558
|
* phases of the plan.
|
|
358
559
|
*/
|
|
359
|
-
prices: Array<PlanCreateParams.NewPlanUnitPrice | PlanCreateParams.NewPlanPackagePrice | PlanCreateParams.NewPlanMatrixPrice | PlanCreateParams.NewPlanTieredPrice | PlanCreateParams.NewPlanTieredBpsPrice | PlanCreateParams.NewPlanBpsPrice | PlanCreateParams.NewPlanBulkBpsPrice | PlanCreateParams.NewPlanBulkPrice | PlanCreateParams.NewPlanThresholdTotalAmountPrice | PlanCreateParams.NewPlanTieredPackagePrice | PlanCreateParams.NewPlanTieredWithMinimumPrice | PlanCreateParams.NewPlanUnitWithPercentPrice | PlanCreateParams.NewPlanPackageWithAllocationPrice | PlanCreateParams.NewPlanTierWithProrationPrice | PlanCreateParams.NewPlanUnitWithProrationPrice | PlanCreateParams.NewPlanGroupedAllocationPrice | PlanCreateParams.NewPlanGroupedWithProratedMinimumPrice | PlanCreateParams.NewPlanGroupedWithMeteredMinimumPrice | PlanCreateParams.NewPlanMatrixWithDisplayNamePrice | PlanCreateParams.NewPlanBulkWithProrationPrice | PlanCreateParams.NewPlanGroupedTieredPackagePrice | PlanCreateParams.NewPlanMaxGroupTieredPackagePrice | PlanCreateParams.NewPlanScalableMatrixWithUnitPricingPrice | PlanCreateParams.NewPlanScalableMatrixWithTieredPricingPrice | PlanCreateParams.NewPlanCumulativeGroupedBulkPrice>;
|
|
560
|
+
prices: Array<PlanCreateParams.NewPlanUnitPrice | PlanCreateParams.NewPlanPackagePrice | PlanCreateParams.NewPlanMatrixPrice | PlanCreateParams.NewPlanTieredPrice | PlanCreateParams.NewPlanTieredBpsPrice | PlanCreateParams.NewPlanBpsPrice | PlanCreateParams.NewPlanBulkBpsPrice | PlanCreateParams.NewPlanBulkPrice | PlanCreateParams.NewPlanThresholdTotalAmountPrice | PlanCreateParams.NewPlanTieredPackagePrice | PlanCreateParams.NewPlanTieredWithMinimumPrice | PlanCreateParams.NewPlanUnitWithPercentPrice | PlanCreateParams.NewPlanPackageWithAllocationPrice | PlanCreateParams.NewPlanTierWithProrationPrice | PlanCreateParams.NewPlanUnitWithProrationPrice | PlanCreateParams.NewPlanGroupedAllocationPrice | PlanCreateParams.NewPlanGroupedWithProratedMinimumPrice | PlanCreateParams.NewPlanGroupedWithMeteredMinimumPrice | PlanCreateParams.NewPlanMatrixWithDisplayNamePrice | PlanCreateParams.NewPlanBulkWithProrationPrice | PlanCreateParams.NewPlanGroupedTieredPackagePrice | PlanCreateParams.NewPlanMaxGroupTieredPackagePrice | PlanCreateParams.NewPlanScalableMatrixWithUnitPricingPrice | PlanCreateParams.NewPlanScalableMatrixWithTieredPricingPrice | PlanCreateParams.NewPlanCumulativeGroupedBulkPrice | PlanCreateParams.NewPlanTieredPackageWithMinimumPrice | PlanCreateParams.NewPlanMatrixWithAllocationPrice | PlanCreateParams.NewPlanGroupedTieredPrice>;
|
|
360
561
|
/**
|
|
361
562
|
* Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
|
362
563
|
*/
|
|
@@ -420,6 +621,10 @@ export declare namespace PlanCreateParams {
|
|
|
420
621
|
* price is billed.
|
|
421
622
|
*/
|
|
422
623
|
currency?: string | null;
|
|
624
|
+
/**
|
|
625
|
+
* For dimensional price: specifies a price group and dimension values
|
|
626
|
+
*/
|
|
627
|
+
dimensional_price_configuration?: NewPlanUnitPrice.DimensionalPriceConfiguration | null;
|
|
423
628
|
/**
|
|
424
629
|
* An alias for the price.
|
|
425
630
|
*/
|
|
@@ -466,6 +671,24 @@ export declare namespace PlanCreateParams {
|
|
|
466
671
|
*/
|
|
467
672
|
duration_unit: 'day' | 'month';
|
|
468
673
|
}
|
|
674
|
+
/**
|
|
675
|
+
* For dimensional price: specifies a price group and dimension values
|
|
676
|
+
*/
|
|
677
|
+
interface DimensionalPriceConfiguration {
|
|
678
|
+
/**
|
|
679
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
680
|
+
* group
|
|
681
|
+
*/
|
|
682
|
+
dimension_values: Array<string>;
|
|
683
|
+
/**
|
|
684
|
+
* The id of the dimensional price group to include this price in
|
|
685
|
+
*/
|
|
686
|
+
dimensional_price_group_id?: string | null;
|
|
687
|
+
/**
|
|
688
|
+
* The external id of the dimensional price group to include this price in
|
|
689
|
+
*/
|
|
690
|
+
external_dimensional_price_group_id?: string | null;
|
|
691
|
+
}
|
|
469
692
|
/**
|
|
470
693
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
471
694
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -520,6 +743,10 @@ export declare namespace PlanCreateParams {
|
|
|
520
743
|
* price is billed.
|
|
521
744
|
*/
|
|
522
745
|
currency?: string | null;
|
|
746
|
+
/**
|
|
747
|
+
* For dimensional price: specifies a price group and dimension values
|
|
748
|
+
*/
|
|
749
|
+
dimensional_price_configuration?: NewPlanPackagePrice.DimensionalPriceConfiguration | null;
|
|
523
750
|
/**
|
|
524
751
|
* An alias for the price.
|
|
525
752
|
*/
|
|
@@ -571,6 +798,24 @@ export declare namespace PlanCreateParams {
|
|
|
571
798
|
*/
|
|
572
799
|
duration_unit: 'day' | 'month';
|
|
573
800
|
}
|
|
801
|
+
/**
|
|
802
|
+
* For dimensional price: specifies a price group and dimension values
|
|
803
|
+
*/
|
|
804
|
+
interface DimensionalPriceConfiguration {
|
|
805
|
+
/**
|
|
806
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
807
|
+
* group
|
|
808
|
+
*/
|
|
809
|
+
dimension_values: Array<string>;
|
|
810
|
+
/**
|
|
811
|
+
* The id of the dimensional price group to include this price in
|
|
812
|
+
*/
|
|
813
|
+
dimensional_price_group_id?: string | null;
|
|
814
|
+
/**
|
|
815
|
+
* The external id of the dimensional price group to include this price in
|
|
816
|
+
*/
|
|
817
|
+
external_dimensional_price_group_id?: string | null;
|
|
818
|
+
}
|
|
574
819
|
/**
|
|
575
820
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
576
821
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -625,6 +870,10 @@ export declare namespace PlanCreateParams {
|
|
|
625
870
|
* price is billed.
|
|
626
871
|
*/
|
|
627
872
|
currency?: string | null;
|
|
873
|
+
/**
|
|
874
|
+
* For dimensional price: specifies a price group and dimension values
|
|
875
|
+
*/
|
|
876
|
+
dimensional_price_configuration?: NewPlanMatrixPrice.DimensionalPriceConfiguration | null;
|
|
628
877
|
/**
|
|
629
878
|
* An alias for the price.
|
|
630
879
|
*/
|
|
@@ -693,6 +942,24 @@ export declare namespace PlanCreateParams {
|
|
|
693
942
|
*/
|
|
694
943
|
duration_unit: 'day' | 'month';
|
|
695
944
|
}
|
|
945
|
+
/**
|
|
946
|
+
* For dimensional price: specifies a price group and dimension values
|
|
947
|
+
*/
|
|
948
|
+
interface DimensionalPriceConfiguration {
|
|
949
|
+
/**
|
|
950
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
951
|
+
* group
|
|
952
|
+
*/
|
|
953
|
+
dimension_values: Array<string>;
|
|
954
|
+
/**
|
|
955
|
+
* The id of the dimensional price group to include this price in
|
|
956
|
+
*/
|
|
957
|
+
dimensional_price_group_id?: string | null;
|
|
958
|
+
/**
|
|
959
|
+
* The external id of the dimensional price group to include this price in
|
|
960
|
+
*/
|
|
961
|
+
external_dimensional_price_group_id?: string | null;
|
|
962
|
+
}
|
|
696
963
|
/**
|
|
697
964
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
698
965
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -747,6 +1014,10 @@ export declare namespace PlanCreateParams {
|
|
|
747
1014
|
* price is billed.
|
|
748
1015
|
*/
|
|
749
1016
|
currency?: string | null;
|
|
1017
|
+
/**
|
|
1018
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1019
|
+
*/
|
|
1020
|
+
dimensional_price_configuration?: NewPlanTieredPrice.DimensionalPriceConfiguration | null;
|
|
750
1021
|
/**
|
|
751
1022
|
* An alias for the price.
|
|
752
1023
|
*/
|
|
@@ -809,6 +1080,24 @@ export declare namespace PlanCreateParams {
|
|
|
809
1080
|
*/
|
|
810
1081
|
duration_unit: 'day' | 'month';
|
|
811
1082
|
}
|
|
1083
|
+
/**
|
|
1084
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1085
|
+
*/
|
|
1086
|
+
interface DimensionalPriceConfiguration {
|
|
1087
|
+
/**
|
|
1088
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1089
|
+
* group
|
|
1090
|
+
*/
|
|
1091
|
+
dimension_values: Array<string>;
|
|
1092
|
+
/**
|
|
1093
|
+
* The id of the dimensional price group to include this price in
|
|
1094
|
+
*/
|
|
1095
|
+
dimensional_price_group_id?: string | null;
|
|
1096
|
+
/**
|
|
1097
|
+
* The external id of the dimensional price group to include this price in
|
|
1098
|
+
*/
|
|
1099
|
+
external_dimensional_price_group_id?: string | null;
|
|
1100
|
+
}
|
|
812
1101
|
/**
|
|
813
1102
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
814
1103
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -863,6 +1152,10 @@ export declare namespace PlanCreateParams {
|
|
|
863
1152
|
* price is billed.
|
|
864
1153
|
*/
|
|
865
1154
|
currency?: string | null;
|
|
1155
|
+
/**
|
|
1156
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1157
|
+
*/
|
|
1158
|
+
dimensional_price_configuration?: NewPlanTieredBpsPrice.DimensionalPriceConfiguration | null;
|
|
866
1159
|
/**
|
|
867
1160
|
* An alias for the price.
|
|
868
1161
|
*/
|
|
@@ -930,6 +1223,24 @@ export declare namespace PlanCreateParams {
|
|
|
930
1223
|
*/
|
|
931
1224
|
duration_unit: 'day' | 'month';
|
|
932
1225
|
}
|
|
1226
|
+
/**
|
|
1227
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1228
|
+
*/
|
|
1229
|
+
interface DimensionalPriceConfiguration {
|
|
1230
|
+
/**
|
|
1231
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1232
|
+
* group
|
|
1233
|
+
*/
|
|
1234
|
+
dimension_values: Array<string>;
|
|
1235
|
+
/**
|
|
1236
|
+
* The id of the dimensional price group to include this price in
|
|
1237
|
+
*/
|
|
1238
|
+
dimensional_price_group_id?: string | null;
|
|
1239
|
+
/**
|
|
1240
|
+
* The external id of the dimensional price group to include this price in
|
|
1241
|
+
*/
|
|
1242
|
+
external_dimensional_price_group_id?: string | null;
|
|
1243
|
+
}
|
|
933
1244
|
/**
|
|
934
1245
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
935
1246
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -984,6 +1295,10 @@ export declare namespace PlanCreateParams {
|
|
|
984
1295
|
* price is billed.
|
|
985
1296
|
*/
|
|
986
1297
|
currency?: string | null;
|
|
1298
|
+
/**
|
|
1299
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1300
|
+
*/
|
|
1301
|
+
dimensional_price_configuration?: NewPlanBpsPrice.DimensionalPriceConfiguration | null;
|
|
987
1302
|
/**
|
|
988
1303
|
* An alias for the price.
|
|
989
1304
|
*/
|
|
@@ -1034,6 +1349,24 @@ export declare namespace PlanCreateParams {
|
|
|
1034
1349
|
*/
|
|
1035
1350
|
duration_unit: 'day' | 'month';
|
|
1036
1351
|
}
|
|
1352
|
+
/**
|
|
1353
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1354
|
+
*/
|
|
1355
|
+
interface DimensionalPriceConfiguration {
|
|
1356
|
+
/**
|
|
1357
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1358
|
+
* group
|
|
1359
|
+
*/
|
|
1360
|
+
dimension_values: Array<string>;
|
|
1361
|
+
/**
|
|
1362
|
+
* The id of the dimensional price group to include this price in
|
|
1363
|
+
*/
|
|
1364
|
+
dimensional_price_group_id?: string | null;
|
|
1365
|
+
/**
|
|
1366
|
+
* The external id of the dimensional price group to include this price in
|
|
1367
|
+
*/
|
|
1368
|
+
external_dimensional_price_group_id?: string | null;
|
|
1369
|
+
}
|
|
1037
1370
|
/**
|
|
1038
1371
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1039
1372
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1088,6 +1421,10 @@ export declare namespace PlanCreateParams {
|
|
|
1088
1421
|
* price is billed.
|
|
1089
1422
|
*/
|
|
1090
1423
|
currency?: string | null;
|
|
1424
|
+
/**
|
|
1425
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1426
|
+
*/
|
|
1427
|
+
dimensional_price_configuration?: NewPlanBulkBpsPrice.DimensionalPriceConfiguration | null;
|
|
1091
1428
|
/**
|
|
1092
1429
|
* An alias for the price.
|
|
1093
1430
|
*/
|
|
@@ -1151,6 +1488,24 @@ export declare namespace PlanCreateParams {
|
|
|
1151
1488
|
*/
|
|
1152
1489
|
duration_unit: 'day' | 'month';
|
|
1153
1490
|
}
|
|
1491
|
+
/**
|
|
1492
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1493
|
+
*/
|
|
1494
|
+
interface DimensionalPriceConfiguration {
|
|
1495
|
+
/**
|
|
1496
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1497
|
+
* group
|
|
1498
|
+
*/
|
|
1499
|
+
dimension_values: Array<string>;
|
|
1500
|
+
/**
|
|
1501
|
+
* The id of the dimensional price group to include this price in
|
|
1502
|
+
*/
|
|
1503
|
+
dimensional_price_group_id?: string | null;
|
|
1504
|
+
/**
|
|
1505
|
+
* The external id of the dimensional price group to include this price in
|
|
1506
|
+
*/
|
|
1507
|
+
external_dimensional_price_group_id?: string | null;
|
|
1508
|
+
}
|
|
1154
1509
|
/**
|
|
1155
1510
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1156
1511
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1205,6 +1560,10 @@ export declare namespace PlanCreateParams {
|
|
|
1205
1560
|
* price is billed.
|
|
1206
1561
|
*/
|
|
1207
1562
|
currency?: string | null;
|
|
1563
|
+
/**
|
|
1564
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1565
|
+
*/
|
|
1566
|
+
dimensional_price_configuration?: NewPlanBulkPrice.DimensionalPriceConfiguration | null;
|
|
1208
1567
|
/**
|
|
1209
1568
|
* An alias for the price.
|
|
1210
1569
|
*/
|
|
@@ -1263,6 +1622,24 @@ export declare namespace PlanCreateParams {
|
|
|
1263
1622
|
*/
|
|
1264
1623
|
duration_unit: 'day' | 'month';
|
|
1265
1624
|
}
|
|
1625
|
+
/**
|
|
1626
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1627
|
+
*/
|
|
1628
|
+
interface DimensionalPriceConfiguration {
|
|
1629
|
+
/**
|
|
1630
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1631
|
+
* group
|
|
1632
|
+
*/
|
|
1633
|
+
dimension_values: Array<string>;
|
|
1634
|
+
/**
|
|
1635
|
+
* The id of the dimensional price group to include this price in
|
|
1636
|
+
*/
|
|
1637
|
+
dimensional_price_group_id?: string | null;
|
|
1638
|
+
/**
|
|
1639
|
+
* The external id of the dimensional price group to include this price in
|
|
1640
|
+
*/
|
|
1641
|
+
external_dimensional_price_group_id?: string | null;
|
|
1642
|
+
}
|
|
1266
1643
|
/**
|
|
1267
1644
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1268
1645
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1317,6 +1694,10 @@ export declare namespace PlanCreateParams {
|
|
|
1317
1694
|
* price is billed.
|
|
1318
1695
|
*/
|
|
1319
1696
|
currency?: string | null;
|
|
1697
|
+
/**
|
|
1698
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1699
|
+
*/
|
|
1700
|
+
dimensional_price_configuration?: NewPlanThresholdTotalAmountPrice.DimensionalPriceConfiguration | null;
|
|
1320
1701
|
/**
|
|
1321
1702
|
* An alias for the price.
|
|
1322
1703
|
*/
|
|
@@ -1357,6 +1738,24 @@ export declare namespace PlanCreateParams {
|
|
|
1357
1738
|
*/
|
|
1358
1739
|
duration_unit: 'day' | 'month';
|
|
1359
1740
|
}
|
|
1741
|
+
/**
|
|
1742
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1743
|
+
*/
|
|
1744
|
+
interface DimensionalPriceConfiguration {
|
|
1745
|
+
/**
|
|
1746
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1747
|
+
* group
|
|
1748
|
+
*/
|
|
1749
|
+
dimension_values: Array<string>;
|
|
1750
|
+
/**
|
|
1751
|
+
* The id of the dimensional price group to include this price in
|
|
1752
|
+
*/
|
|
1753
|
+
dimensional_price_group_id?: string | null;
|
|
1754
|
+
/**
|
|
1755
|
+
* The external id of the dimensional price group to include this price in
|
|
1756
|
+
*/
|
|
1757
|
+
external_dimensional_price_group_id?: string | null;
|
|
1758
|
+
}
|
|
1360
1759
|
/**
|
|
1361
1760
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1362
1761
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1411,6 +1810,10 @@ export declare namespace PlanCreateParams {
|
|
|
1411
1810
|
* price is billed.
|
|
1412
1811
|
*/
|
|
1413
1812
|
currency?: string | null;
|
|
1813
|
+
/**
|
|
1814
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1815
|
+
*/
|
|
1816
|
+
dimensional_price_configuration?: NewPlanTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
1414
1817
|
/**
|
|
1415
1818
|
* An alias for the price.
|
|
1416
1819
|
*/
|
|
@@ -1451,6 +1854,24 @@ export declare namespace PlanCreateParams {
|
|
|
1451
1854
|
*/
|
|
1452
1855
|
duration_unit: 'day' | 'month';
|
|
1453
1856
|
}
|
|
1857
|
+
/**
|
|
1858
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1859
|
+
*/
|
|
1860
|
+
interface DimensionalPriceConfiguration {
|
|
1861
|
+
/**
|
|
1862
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1863
|
+
* group
|
|
1864
|
+
*/
|
|
1865
|
+
dimension_values: Array<string>;
|
|
1866
|
+
/**
|
|
1867
|
+
* The id of the dimensional price group to include this price in
|
|
1868
|
+
*/
|
|
1869
|
+
dimensional_price_group_id?: string | null;
|
|
1870
|
+
/**
|
|
1871
|
+
* The external id of the dimensional price group to include this price in
|
|
1872
|
+
*/
|
|
1873
|
+
external_dimensional_price_group_id?: string | null;
|
|
1874
|
+
}
|
|
1454
1875
|
/**
|
|
1455
1876
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1456
1877
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1505,6 +1926,10 @@ export declare namespace PlanCreateParams {
|
|
|
1505
1926
|
* price is billed.
|
|
1506
1927
|
*/
|
|
1507
1928
|
currency?: string | null;
|
|
1929
|
+
/**
|
|
1930
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1931
|
+
*/
|
|
1932
|
+
dimensional_price_configuration?: NewPlanTieredWithMinimumPrice.DimensionalPriceConfiguration | null;
|
|
1508
1933
|
/**
|
|
1509
1934
|
* An alias for the price.
|
|
1510
1935
|
*/
|
|
@@ -1545,6 +1970,24 @@ export declare namespace PlanCreateParams {
|
|
|
1545
1970
|
*/
|
|
1546
1971
|
duration_unit: 'day' | 'month';
|
|
1547
1972
|
}
|
|
1973
|
+
/**
|
|
1974
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1975
|
+
*/
|
|
1976
|
+
interface DimensionalPriceConfiguration {
|
|
1977
|
+
/**
|
|
1978
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1979
|
+
* group
|
|
1980
|
+
*/
|
|
1981
|
+
dimension_values: Array<string>;
|
|
1982
|
+
/**
|
|
1983
|
+
* The id of the dimensional price group to include this price in
|
|
1984
|
+
*/
|
|
1985
|
+
dimensional_price_group_id?: string | null;
|
|
1986
|
+
/**
|
|
1987
|
+
* The external id of the dimensional price group to include this price in
|
|
1988
|
+
*/
|
|
1989
|
+
external_dimensional_price_group_id?: string | null;
|
|
1990
|
+
}
|
|
1548
1991
|
/**
|
|
1549
1992
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1550
1993
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1599,6 +2042,10 @@ export declare namespace PlanCreateParams {
|
|
|
1599
2042
|
* price is billed.
|
|
1600
2043
|
*/
|
|
1601
2044
|
currency?: string | null;
|
|
2045
|
+
/**
|
|
2046
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2047
|
+
*/
|
|
2048
|
+
dimensional_price_configuration?: NewPlanUnitWithPercentPrice.DimensionalPriceConfiguration | null;
|
|
1602
2049
|
/**
|
|
1603
2050
|
* An alias for the price.
|
|
1604
2051
|
*/
|
|
@@ -1639,6 +2086,24 @@ export declare namespace PlanCreateParams {
|
|
|
1639
2086
|
*/
|
|
1640
2087
|
duration_unit: 'day' | 'month';
|
|
1641
2088
|
}
|
|
2089
|
+
/**
|
|
2090
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2091
|
+
*/
|
|
2092
|
+
interface DimensionalPriceConfiguration {
|
|
2093
|
+
/**
|
|
2094
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2095
|
+
* group
|
|
2096
|
+
*/
|
|
2097
|
+
dimension_values: Array<string>;
|
|
2098
|
+
/**
|
|
2099
|
+
* The id of the dimensional price group to include this price in
|
|
2100
|
+
*/
|
|
2101
|
+
dimensional_price_group_id?: string | null;
|
|
2102
|
+
/**
|
|
2103
|
+
* The external id of the dimensional price group to include this price in
|
|
2104
|
+
*/
|
|
2105
|
+
external_dimensional_price_group_id?: string | null;
|
|
2106
|
+
}
|
|
1642
2107
|
/**
|
|
1643
2108
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1644
2109
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1693,6 +2158,10 @@ export declare namespace PlanCreateParams {
|
|
|
1693
2158
|
* price is billed.
|
|
1694
2159
|
*/
|
|
1695
2160
|
currency?: string | null;
|
|
2161
|
+
/**
|
|
2162
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2163
|
+
*/
|
|
2164
|
+
dimensional_price_configuration?: NewPlanPackageWithAllocationPrice.DimensionalPriceConfiguration | null;
|
|
1696
2165
|
/**
|
|
1697
2166
|
* An alias for the price.
|
|
1698
2167
|
*/
|
|
@@ -1733,6 +2202,24 @@ export declare namespace PlanCreateParams {
|
|
|
1733
2202
|
*/
|
|
1734
2203
|
duration_unit: 'day' | 'month';
|
|
1735
2204
|
}
|
|
2205
|
+
/**
|
|
2206
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2207
|
+
*/
|
|
2208
|
+
interface DimensionalPriceConfiguration {
|
|
2209
|
+
/**
|
|
2210
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2211
|
+
* group
|
|
2212
|
+
*/
|
|
2213
|
+
dimension_values: Array<string>;
|
|
2214
|
+
/**
|
|
2215
|
+
* The id of the dimensional price group to include this price in
|
|
2216
|
+
*/
|
|
2217
|
+
dimensional_price_group_id?: string | null;
|
|
2218
|
+
/**
|
|
2219
|
+
* The external id of the dimensional price group to include this price in
|
|
2220
|
+
*/
|
|
2221
|
+
external_dimensional_price_group_id?: string | null;
|
|
2222
|
+
}
|
|
1736
2223
|
/**
|
|
1737
2224
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1738
2225
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1787,6 +2274,10 @@ export declare namespace PlanCreateParams {
|
|
|
1787
2274
|
* price is billed.
|
|
1788
2275
|
*/
|
|
1789
2276
|
currency?: string | null;
|
|
2277
|
+
/**
|
|
2278
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2279
|
+
*/
|
|
2280
|
+
dimensional_price_configuration?: NewPlanTierWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
1790
2281
|
/**
|
|
1791
2282
|
* An alias for the price.
|
|
1792
2283
|
*/
|
|
@@ -1828,18 +2319,36 @@ export declare namespace PlanCreateParams {
|
|
|
1828
2319
|
duration_unit: 'day' | 'month';
|
|
1829
2320
|
}
|
|
1830
2321
|
/**
|
|
1831
|
-
*
|
|
1832
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
2322
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1833
2323
|
*/
|
|
1834
|
-
interface
|
|
2324
|
+
interface DimensionalPriceConfiguration {
|
|
1835
2325
|
/**
|
|
1836
|
-
* The
|
|
2326
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2327
|
+
* group
|
|
1837
2328
|
*/
|
|
1838
|
-
|
|
2329
|
+
dimension_values: Array<string>;
|
|
1839
2330
|
/**
|
|
1840
|
-
* The
|
|
2331
|
+
* The id of the dimensional price group to include this price in
|
|
1841
2332
|
*/
|
|
1842
|
-
|
|
2333
|
+
dimensional_price_group_id?: string | null;
|
|
2334
|
+
/**
|
|
2335
|
+
* The external id of the dimensional price group to include this price in
|
|
2336
|
+
*/
|
|
2337
|
+
external_dimensional_price_group_id?: string | null;
|
|
2338
|
+
}
|
|
2339
|
+
/**
|
|
2340
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2341
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2342
|
+
*/
|
|
2343
|
+
interface InvoicingCycleConfiguration {
|
|
2344
|
+
/**
|
|
2345
|
+
* The duration of the billing period.
|
|
2346
|
+
*/
|
|
2347
|
+
duration: number;
|
|
2348
|
+
/**
|
|
2349
|
+
* The unit of billing period duration.
|
|
2350
|
+
*/
|
|
2351
|
+
duration_unit: 'day' | 'month';
|
|
1843
2352
|
}
|
|
1844
2353
|
}
|
|
1845
2354
|
interface NewPlanUnitWithProrationPrice {
|
|
@@ -1881,6 +2390,10 @@ export declare namespace PlanCreateParams {
|
|
|
1881
2390
|
* price is billed.
|
|
1882
2391
|
*/
|
|
1883
2392
|
currency?: string | null;
|
|
2393
|
+
/**
|
|
2394
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2395
|
+
*/
|
|
2396
|
+
dimensional_price_configuration?: NewPlanUnitWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
1884
2397
|
/**
|
|
1885
2398
|
* An alias for the price.
|
|
1886
2399
|
*/
|
|
@@ -1921,6 +2434,24 @@ export declare namespace PlanCreateParams {
|
|
|
1921
2434
|
*/
|
|
1922
2435
|
duration_unit: 'day' | 'month';
|
|
1923
2436
|
}
|
|
2437
|
+
/**
|
|
2438
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2439
|
+
*/
|
|
2440
|
+
interface DimensionalPriceConfiguration {
|
|
2441
|
+
/**
|
|
2442
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2443
|
+
* group
|
|
2444
|
+
*/
|
|
2445
|
+
dimension_values: Array<string>;
|
|
2446
|
+
/**
|
|
2447
|
+
* The id of the dimensional price group to include this price in
|
|
2448
|
+
*/
|
|
2449
|
+
dimensional_price_group_id?: string | null;
|
|
2450
|
+
/**
|
|
2451
|
+
* The external id of the dimensional price group to include this price in
|
|
2452
|
+
*/
|
|
2453
|
+
external_dimensional_price_group_id?: string | null;
|
|
2454
|
+
}
|
|
1924
2455
|
/**
|
|
1925
2456
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1926
2457
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1975,6 +2506,10 @@ export declare namespace PlanCreateParams {
|
|
|
1975
2506
|
* price is billed.
|
|
1976
2507
|
*/
|
|
1977
2508
|
currency?: string | null;
|
|
2509
|
+
/**
|
|
2510
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2511
|
+
*/
|
|
2512
|
+
dimensional_price_configuration?: NewPlanGroupedAllocationPrice.DimensionalPriceConfiguration | null;
|
|
1978
2513
|
/**
|
|
1979
2514
|
* An alias for the price.
|
|
1980
2515
|
*/
|
|
@@ -2015,6 +2550,24 @@ export declare namespace PlanCreateParams {
|
|
|
2015
2550
|
*/
|
|
2016
2551
|
duration_unit: 'day' | 'month';
|
|
2017
2552
|
}
|
|
2553
|
+
/**
|
|
2554
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2555
|
+
*/
|
|
2556
|
+
interface DimensionalPriceConfiguration {
|
|
2557
|
+
/**
|
|
2558
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2559
|
+
* group
|
|
2560
|
+
*/
|
|
2561
|
+
dimension_values: Array<string>;
|
|
2562
|
+
/**
|
|
2563
|
+
* The id of the dimensional price group to include this price in
|
|
2564
|
+
*/
|
|
2565
|
+
dimensional_price_group_id?: string | null;
|
|
2566
|
+
/**
|
|
2567
|
+
* The external id of the dimensional price group to include this price in
|
|
2568
|
+
*/
|
|
2569
|
+
external_dimensional_price_group_id?: string | null;
|
|
2570
|
+
}
|
|
2018
2571
|
/**
|
|
2019
2572
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2020
2573
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2069,6 +2622,10 @@ export declare namespace PlanCreateParams {
|
|
|
2069
2622
|
* price is billed.
|
|
2070
2623
|
*/
|
|
2071
2624
|
currency?: string | null;
|
|
2625
|
+
/**
|
|
2626
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2627
|
+
*/
|
|
2628
|
+
dimensional_price_configuration?: NewPlanGroupedWithProratedMinimumPrice.DimensionalPriceConfiguration | null;
|
|
2072
2629
|
/**
|
|
2073
2630
|
* An alias for the price.
|
|
2074
2631
|
*/
|
|
@@ -2109,6 +2666,24 @@ export declare namespace PlanCreateParams {
|
|
|
2109
2666
|
*/
|
|
2110
2667
|
duration_unit: 'day' | 'month';
|
|
2111
2668
|
}
|
|
2669
|
+
/**
|
|
2670
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2671
|
+
*/
|
|
2672
|
+
interface DimensionalPriceConfiguration {
|
|
2673
|
+
/**
|
|
2674
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2675
|
+
* group
|
|
2676
|
+
*/
|
|
2677
|
+
dimension_values: Array<string>;
|
|
2678
|
+
/**
|
|
2679
|
+
* The id of the dimensional price group to include this price in
|
|
2680
|
+
*/
|
|
2681
|
+
dimensional_price_group_id?: string | null;
|
|
2682
|
+
/**
|
|
2683
|
+
* The external id of the dimensional price group to include this price in
|
|
2684
|
+
*/
|
|
2685
|
+
external_dimensional_price_group_id?: string | null;
|
|
2686
|
+
}
|
|
2112
2687
|
/**
|
|
2113
2688
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2114
2689
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2163,6 +2738,10 @@ export declare namespace PlanCreateParams {
|
|
|
2163
2738
|
* price is billed.
|
|
2164
2739
|
*/
|
|
2165
2740
|
currency?: string | null;
|
|
2741
|
+
/**
|
|
2742
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2743
|
+
*/
|
|
2744
|
+
dimensional_price_configuration?: NewPlanGroupedWithMeteredMinimumPrice.DimensionalPriceConfiguration | null;
|
|
2166
2745
|
/**
|
|
2167
2746
|
* An alias for the price.
|
|
2168
2747
|
*/
|
|
@@ -2203,6 +2782,24 @@ export declare namespace PlanCreateParams {
|
|
|
2203
2782
|
*/
|
|
2204
2783
|
duration_unit: 'day' | 'month';
|
|
2205
2784
|
}
|
|
2785
|
+
/**
|
|
2786
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2787
|
+
*/
|
|
2788
|
+
interface DimensionalPriceConfiguration {
|
|
2789
|
+
/**
|
|
2790
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2791
|
+
* group
|
|
2792
|
+
*/
|
|
2793
|
+
dimension_values: Array<string>;
|
|
2794
|
+
/**
|
|
2795
|
+
* The id of the dimensional price group to include this price in
|
|
2796
|
+
*/
|
|
2797
|
+
dimensional_price_group_id?: string | null;
|
|
2798
|
+
/**
|
|
2799
|
+
* The external id of the dimensional price group to include this price in
|
|
2800
|
+
*/
|
|
2801
|
+
external_dimensional_price_group_id?: string | null;
|
|
2802
|
+
}
|
|
2206
2803
|
/**
|
|
2207
2804
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2208
2805
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2257,6 +2854,10 @@ export declare namespace PlanCreateParams {
|
|
|
2257
2854
|
* price is billed.
|
|
2258
2855
|
*/
|
|
2259
2856
|
currency?: string | null;
|
|
2857
|
+
/**
|
|
2858
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2859
|
+
*/
|
|
2860
|
+
dimensional_price_configuration?: NewPlanMatrixWithDisplayNamePrice.DimensionalPriceConfiguration | null;
|
|
2260
2861
|
/**
|
|
2261
2862
|
* An alias for the price.
|
|
2262
2863
|
*/
|
|
@@ -2297,6 +2898,24 @@ export declare namespace PlanCreateParams {
|
|
|
2297
2898
|
*/
|
|
2298
2899
|
duration_unit: 'day' | 'month';
|
|
2299
2900
|
}
|
|
2901
|
+
/**
|
|
2902
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2903
|
+
*/
|
|
2904
|
+
interface DimensionalPriceConfiguration {
|
|
2905
|
+
/**
|
|
2906
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2907
|
+
* group
|
|
2908
|
+
*/
|
|
2909
|
+
dimension_values: Array<string>;
|
|
2910
|
+
/**
|
|
2911
|
+
* The id of the dimensional price group to include this price in
|
|
2912
|
+
*/
|
|
2913
|
+
dimensional_price_group_id?: string | null;
|
|
2914
|
+
/**
|
|
2915
|
+
* The external id of the dimensional price group to include this price in
|
|
2916
|
+
*/
|
|
2917
|
+
external_dimensional_price_group_id?: string | null;
|
|
2918
|
+
}
|
|
2300
2919
|
/**
|
|
2301
2920
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2302
2921
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2351,6 +2970,10 @@ export declare namespace PlanCreateParams {
|
|
|
2351
2970
|
* price is billed.
|
|
2352
2971
|
*/
|
|
2353
2972
|
currency?: string | null;
|
|
2973
|
+
/**
|
|
2974
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2975
|
+
*/
|
|
2976
|
+
dimensional_price_configuration?: NewPlanBulkWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
2354
2977
|
/**
|
|
2355
2978
|
* An alias for the price.
|
|
2356
2979
|
*/
|
|
@@ -2391,6 +3014,24 @@ export declare namespace PlanCreateParams {
|
|
|
2391
3014
|
*/
|
|
2392
3015
|
duration_unit: 'day' | 'month';
|
|
2393
3016
|
}
|
|
3017
|
+
/**
|
|
3018
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3019
|
+
*/
|
|
3020
|
+
interface DimensionalPriceConfiguration {
|
|
3021
|
+
/**
|
|
3022
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3023
|
+
* group
|
|
3024
|
+
*/
|
|
3025
|
+
dimension_values: Array<string>;
|
|
3026
|
+
/**
|
|
3027
|
+
* The id of the dimensional price group to include this price in
|
|
3028
|
+
*/
|
|
3029
|
+
dimensional_price_group_id?: string | null;
|
|
3030
|
+
/**
|
|
3031
|
+
* The external id of the dimensional price group to include this price in
|
|
3032
|
+
*/
|
|
3033
|
+
external_dimensional_price_group_id?: string | null;
|
|
3034
|
+
}
|
|
2394
3035
|
/**
|
|
2395
3036
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2396
3037
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2445,6 +3086,10 @@ export declare namespace PlanCreateParams {
|
|
|
2445
3086
|
* price is billed.
|
|
2446
3087
|
*/
|
|
2447
3088
|
currency?: string | null;
|
|
3089
|
+
/**
|
|
3090
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3091
|
+
*/
|
|
3092
|
+
dimensional_price_configuration?: NewPlanGroupedTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
2448
3093
|
/**
|
|
2449
3094
|
* An alias for the price.
|
|
2450
3095
|
*/
|
|
@@ -2485,6 +3130,24 @@ export declare namespace PlanCreateParams {
|
|
|
2485
3130
|
*/
|
|
2486
3131
|
duration_unit: 'day' | 'month';
|
|
2487
3132
|
}
|
|
3133
|
+
/**
|
|
3134
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3135
|
+
*/
|
|
3136
|
+
interface DimensionalPriceConfiguration {
|
|
3137
|
+
/**
|
|
3138
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3139
|
+
* group
|
|
3140
|
+
*/
|
|
3141
|
+
dimension_values: Array<string>;
|
|
3142
|
+
/**
|
|
3143
|
+
* The id of the dimensional price group to include this price in
|
|
3144
|
+
*/
|
|
3145
|
+
dimensional_price_group_id?: string | null;
|
|
3146
|
+
/**
|
|
3147
|
+
* The external id of the dimensional price group to include this price in
|
|
3148
|
+
*/
|
|
3149
|
+
external_dimensional_price_group_id?: string | null;
|
|
3150
|
+
}
|
|
2488
3151
|
/**
|
|
2489
3152
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2490
3153
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2539,6 +3202,10 @@ export declare namespace PlanCreateParams {
|
|
|
2539
3202
|
* price is billed.
|
|
2540
3203
|
*/
|
|
2541
3204
|
currency?: string | null;
|
|
3205
|
+
/**
|
|
3206
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3207
|
+
*/
|
|
3208
|
+
dimensional_price_configuration?: NewPlanMaxGroupTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
2542
3209
|
/**
|
|
2543
3210
|
* An alias for the price.
|
|
2544
3211
|
*/
|
|
@@ -2579,6 +3246,24 @@ export declare namespace PlanCreateParams {
|
|
|
2579
3246
|
*/
|
|
2580
3247
|
duration_unit: 'day' | 'month';
|
|
2581
3248
|
}
|
|
3249
|
+
/**
|
|
3250
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3251
|
+
*/
|
|
3252
|
+
interface DimensionalPriceConfiguration {
|
|
3253
|
+
/**
|
|
3254
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3255
|
+
* group
|
|
3256
|
+
*/
|
|
3257
|
+
dimension_values: Array<string>;
|
|
3258
|
+
/**
|
|
3259
|
+
* The id of the dimensional price group to include this price in
|
|
3260
|
+
*/
|
|
3261
|
+
dimensional_price_group_id?: string | null;
|
|
3262
|
+
/**
|
|
3263
|
+
* The external id of the dimensional price group to include this price in
|
|
3264
|
+
*/
|
|
3265
|
+
external_dimensional_price_group_id?: string | null;
|
|
3266
|
+
}
|
|
2582
3267
|
/**
|
|
2583
3268
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2584
3269
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2633,6 +3318,10 @@ export declare namespace PlanCreateParams {
|
|
|
2633
3318
|
* price is billed.
|
|
2634
3319
|
*/
|
|
2635
3320
|
currency?: string | null;
|
|
3321
|
+
/**
|
|
3322
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3323
|
+
*/
|
|
3324
|
+
dimensional_price_configuration?: NewPlanScalableMatrixWithUnitPricingPrice.DimensionalPriceConfiguration | null;
|
|
2636
3325
|
/**
|
|
2637
3326
|
* An alias for the price.
|
|
2638
3327
|
*/
|
|
@@ -2673,6 +3362,24 @@ export declare namespace PlanCreateParams {
|
|
|
2673
3362
|
*/
|
|
2674
3363
|
duration_unit: 'day' | 'month';
|
|
2675
3364
|
}
|
|
3365
|
+
/**
|
|
3366
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3367
|
+
*/
|
|
3368
|
+
interface DimensionalPriceConfiguration {
|
|
3369
|
+
/**
|
|
3370
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3371
|
+
* group
|
|
3372
|
+
*/
|
|
3373
|
+
dimension_values: Array<string>;
|
|
3374
|
+
/**
|
|
3375
|
+
* The id of the dimensional price group to include this price in
|
|
3376
|
+
*/
|
|
3377
|
+
dimensional_price_group_id?: string | null;
|
|
3378
|
+
/**
|
|
3379
|
+
* The external id of the dimensional price group to include this price in
|
|
3380
|
+
*/
|
|
3381
|
+
external_dimensional_price_group_id?: string | null;
|
|
3382
|
+
}
|
|
2676
3383
|
/**
|
|
2677
3384
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2678
3385
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2727,6 +3434,10 @@ export declare namespace PlanCreateParams {
|
|
|
2727
3434
|
* price is billed.
|
|
2728
3435
|
*/
|
|
2729
3436
|
currency?: string | null;
|
|
3437
|
+
/**
|
|
3438
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3439
|
+
*/
|
|
3440
|
+
dimensional_price_configuration?: NewPlanScalableMatrixWithTieredPricingPrice.DimensionalPriceConfiguration | null;
|
|
2730
3441
|
/**
|
|
2731
3442
|
* An alias for the price.
|
|
2732
3443
|
*/
|
|
@@ -2767,6 +3478,24 @@ export declare namespace PlanCreateParams {
|
|
|
2767
3478
|
*/
|
|
2768
3479
|
duration_unit: 'day' | 'month';
|
|
2769
3480
|
}
|
|
3481
|
+
/**
|
|
3482
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3483
|
+
*/
|
|
3484
|
+
interface DimensionalPriceConfiguration {
|
|
3485
|
+
/**
|
|
3486
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3487
|
+
* group
|
|
3488
|
+
*/
|
|
3489
|
+
dimension_values: Array<string>;
|
|
3490
|
+
/**
|
|
3491
|
+
* The id of the dimensional price group to include this price in
|
|
3492
|
+
*/
|
|
3493
|
+
dimensional_price_group_id?: string | null;
|
|
3494
|
+
/**
|
|
3495
|
+
* The external id of the dimensional price group to include this price in
|
|
3496
|
+
*/
|
|
3497
|
+
external_dimensional_price_group_id?: string | null;
|
|
3498
|
+
}
|
|
2770
3499
|
/**
|
|
2771
3500
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2772
3501
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2821,6 +3550,10 @@ export declare namespace PlanCreateParams {
|
|
|
2821
3550
|
* price is billed.
|
|
2822
3551
|
*/
|
|
2823
3552
|
currency?: string | null;
|
|
3553
|
+
/**
|
|
3554
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3555
|
+
*/
|
|
3556
|
+
dimensional_price_configuration?: NewPlanCumulativeGroupedBulkPrice.DimensionalPriceConfiguration | null;
|
|
2824
3557
|
/**
|
|
2825
3558
|
* An alias for the price.
|
|
2826
3559
|
*/
|
|
@@ -2861,6 +3594,404 @@ export declare namespace PlanCreateParams {
|
|
|
2861
3594
|
*/
|
|
2862
3595
|
duration_unit: 'day' | 'month';
|
|
2863
3596
|
}
|
|
3597
|
+
/**
|
|
3598
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3599
|
+
*/
|
|
3600
|
+
interface DimensionalPriceConfiguration {
|
|
3601
|
+
/**
|
|
3602
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3603
|
+
* group
|
|
3604
|
+
*/
|
|
3605
|
+
dimension_values: Array<string>;
|
|
3606
|
+
/**
|
|
3607
|
+
* The id of the dimensional price group to include this price in
|
|
3608
|
+
*/
|
|
3609
|
+
dimensional_price_group_id?: string | null;
|
|
3610
|
+
/**
|
|
3611
|
+
* The external id of the dimensional price group to include this price in
|
|
3612
|
+
*/
|
|
3613
|
+
external_dimensional_price_group_id?: string | null;
|
|
3614
|
+
}
|
|
3615
|
+
/**
|
|
3616
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3617
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3618
|
+
*/
|
|
3619
|
+
interface InvoicingCycleConfiguration {
|
|
3620
|
+
/**
|
|
3621
|
+
* The duration of the billing period.
|
|
3622
|
+
*/
|
|
3623
|
+
duration: number;
|
|
3624
|
+
/**
|
|
3625
|
+
* The unit of billing period duration.
|
|
3626
|
+
*/
|
|
3627
|
+
duration_unit: 'day' | 'month';
|
|
3628
|
+
}
|
|
3629
|
+
}
|
|
3630
|
+
interface NewPlanTieredPackageWithMinimumPrice {
|
|
3631
|
+
/**
|
|
3632
|
+
* The cadence to bill for this price on.
|
|
3633
|
+
*/
|
|
3634
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3635
|
+
/**
|
|
3636
|
+
* The id of the item the price will be associated with.
|
|
3637
|
+
*/
|
|
3638
|
+
item_id: string;
|
|
3639
|
+
model_type: 'tiered_package_with_minimum';
|
|
3640
|
+
/**
|
|
3641
|
+
* The name of the price.
|
|
3642
|
+
*/
|
|
3643
|
+
name: string;
|
|
3644
|
+
tiered_package_with_minimum_config: Record<string, unknown>;
|
|
3645
|
+
/**
|
|
3646
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3647
|
+
* usage-based.
|
|
3648
|
+
*/
|
|
3649
|
+
billable_metric_id?: string | null;
|
|
3650
|
+
/**
|
|
3651
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3652
|
+
* this is true, and in-arrears if this is false.
|
|
3653
|
+
*/
|
|
3654
|
+
billed_in_advance?: boolean | null;
|
|
3655
|
+
/**
|
|
3656
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3657
|
+
* months.
|
|
3658
|
+
*/
|
|
3659
|
+
billing_cycle_configuration?: NewPlanTieredPackageWithMinimumPrice.BillingCycleConfiguration | null;
|
|
3660
|
+
/**
|
|
3661
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3662
|
+
*/
|
|
3663
|
+
conversion_rate?: number | null;
|
|
3664
|
+
/**
|
|
3665
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
3666
|
+
* price is billed.
|
|
3667
|
+
*/
|
|
3668
|
+
currency?: string | null;
|
|
3669
|
+
/**
|
|
3670
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3671
|
+
*/
|
|
3672
|
+
dimensional_price_configuration?: NewPlanTieredPackageWithMinimumPrice.DimensionalPriceConfiguration | null;
|
|
3673
|
+
/**
|
|
3674
|
+
* An alias for the price.
|
|
3675
|
+
*/
|
|
3676
|
+
external_price_id?: string | null;
|
|
3677
|
+
/**
|
|
3678
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3679
|
+
* applied.
|
|
3680
|
+
*/
|
|
3681
|
+
fixed_price_quantity?: number | null;
|
|
3682
|
+
/**
|
|
3683
|
+
* The property used to group this price on an invoice
|
|
3684
|
+
*/
|
|
3685
|
+
invoice_grouping_key?: string | null;
|
|
3686
|
+
/**
|
|
3687
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3688
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3689
|
+
*/
|
|
3690
|
+
invoicing_cycle_configuration?: NewPlanTieredPackageWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
3691
|
+
/**
|
|
3692
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3693
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3694
|
+
* by setting `metadata` to `null`.
|
|
3695
|
+
*/
|
|
3696
|
+
metadata?: Record<string, string | null> | null;
|
|
3697
|
+
}
|
|
3698
|
+
namespace NewPlanTieredPackageWithMinimumPrice {
|
|
3699
|
+
/**
|
|
3700
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3701
|
+
* months.
|
|
3702
|
+
*/
|
|
3703
|
+
interface BillingCycleConfiguration {
|
|
3704
|
+
/**
|
|
3705
|
+
* The duration of the billing period.
|
|
3706
|
+
*/
|
|
3707
|
+
duration: number;
|
|
3708
|
+
/**
|
|
3709
|
+
* The unit of billing period duration.
|
|
3710
|
+
*/
|
|
3711
|
+
duration_unit: 'day' | 'month';
|
|
3712
|
+
}
|
|
3713
|
+
/**
|
|
3714
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3715
|
+
*/
|
|
3716
|
+
interface DimensionalPriceConfiguration {
|
|
3717
|
+
/**
|
|
3718
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3719
|
+
* group
|
|
3720
|
+
*/
|
|
3721
|
+
dimension_values: Array<string>;
|
|
3722
|
+
/**
|
|
3723
|
+
* The id of the dimensional price group to include this price in
|
|
3724
|
+
*/
|
|
3725
|
+
dimensional_price_group_id?: string | null;
|
|
3726
|
+
/**
|
|
3727
|
+
* The external id of the dimensional price group to include this price in
|
|
3728
|
+
*/
|
|
3729
|
+
external_dimensional_price_group_id?: string | null;
|
|
3730
|
+
}
|
|
3731
|
+
/**
|
|
3732
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3733
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3734
|
+
*/
|
|
3735
|
+
interface InvoicingCycleConfiguration {
|
|
3736
|
+
/**
|
|
3737
|
+
* The duration of the billing period.
|
|
3738
|
+
*/
|
|
3739
|
+
duration: number;
|
|
3740
|
+
/**
|
|
3741
|
+
* The unit of billing period duration.
|
|
3742
|
+
*/
|
|
3743
|
+
duration_unit: 'day' | 'month';
|
|
3744
|
+
}
|
|
3745
|
+
}
|
|
3746
|
+
interface NewPlanMatrixWithAllocationPrice {
|
|
3747
|
+
/**
|
|
3748
|
+
* The cadence to bill for this price on.
|
|
3749
|
+
*/
|
|
3750
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3751
|
+
/**
|
|
3752
|
+
* The id of the item the price will be associated with.
|
|
3753
|
+
*/
|
|
3754
|
+
item_id: string;
|
|
3755
|
+
matrix_with_allocation_config: NewPlanMatrixWithAllocationPrice.MatrixWithAllocationConfig;
|
|
3756
|
+
model_type: 'matrix_with_allocation';
|
|
3757
|
+
/**
|
|
3758
|
+
* The name of the price.
|
|
3759
|
+
*/
|
|
3760
|
+
name: string;
|
|
3761
|
+
/**
|
|
3762
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3763
|
+
* usage-based.
|
|
3764
|
+
*/
|
|
3765
|
+
billable_metric_id?: string | null;
|
|
3766
|
+
/**
|
|
3767
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3768
|
+
* this is true, and in-arrears if this is false.
|
|
3769
|
+
*/
|
|
3770
|
+
billed_in_advance?: boolean | null;
|
|
3771
|
+
/**
|
|
3772
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3773
|
+
* months.
|
|
3774
|
+
*/
|
|
3775
|
+
billing_cycle_configuration?: NewPlanMatrixWithAllocationPrice.BillingCycleConfiguration | null;
|
|
3776
|
+
/**
|
|
3777
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3778
|
+
*/
|
|
3779
|
+
conversion_rate?: number | null;
|
|
3780
|
+
/**
|
|
3781
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
3782
|
+
* price is billed.
|
|
3783
|
+
*/
|
|
3784
|
+
currency?: string | null;
|
|
3785
|
+
/**
|
|
3786
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3787
|
+
*/
|
|
3788
|
+
dimensional_price_configuration?: NewPlanMatrixWithAllocationPrice.DimensionalPriceConfiguration | null;
|
|
3789
|
+
/**
|
|
3790
|
+
* An alias for the price.
|
|
3791
|
+
*/
|
|
3792
|
+
external_price_id?: string | null;
|
|
3793
|
+
/**
|
|
3794
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3795
|
+
* applied.
|
|
3796
|
+
*/
|
|
3797
|
+
fixed_price_quantity?: number | null;
|
|
3798
|
+
/**
|
|
3799
|
+
* The property used to group this price on an invoice
|
|
3800
|
+
*/
|
|
3801
|
+
invoice_grouping_key?: string | null;
|
|
3802
|
+
/**
|
|
3803
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3804
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3805
|
+
*/
|
|
3806
|
+
invoicing_cycle_configuration?: NewPlanMatrixWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
3807
|
+
/**
|
|
3808
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3809
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3810
|
+
* by setting `metadata` to `null`.
|
|
3811
|
+
*/
|
|
3812
|
+
metadata?: Record<string, string | null> | null;
|
|
3813
|
+
}
|
|
3814
|
+
namespace NewPlanMatrixWithAllocationPrice {
|
|
3815
|
+
interface MatrixWithAllocationConfig {
|
|
3816
|
+
/**
|
|
3817
|
+
* Allocation to be used to calculate the price
|
|
3818
|
+
*/
|
|
3819
|
+
allocation: number;
|
|
3820
|
+
/**
|
|
3821
|
+
* Default per unit rate for any usage not bucketed into a specified matrix_value
|
|
3822
|
+
*/
|
|
3823
|
+
default_unit_amount: string;
|
|
3824
|
+
/**
|
|
3825
|
+
* One or two event property values to evaluate matrix groups by
|
|
3826
|
+
*/
|
|
3827
|
+
dimensions: Array<string | null>;
|
|
3828
|
+
/**
|
|
3829
|
+
* Matrix values for specified matrix grouping keys
|
|
3830
|
+
*/
|
|
3831
|
+
matrix_values: Array<MatrixWithAllocationConfig.MatrixValue>;
|
|
3832
|
+
}
|
|
3833
|
+
namespace MatrixWithAllocationConfig {
|
|
3834
|
+
interface MatrixValue {
|
|
3835
|
+
/**
|
|
3836
|
+
* One or two matrix keys to filter usage to this Matrix value by. For example,
|
|
3837
|
+
* ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
|
3838
|
+
* instance tier.
|
|
3839
|
+
*/
|
|
3840
|
+
dimension_values: Array<string | null>;
|
|
3841
|
+
/**
|
|
3842
|
+
* Unit price for the specified dimension_values
|
|
3843
|
+
*/
|
|
3844
|
+
unit_amount: string;
|
|
3845
|
+
}
|
|
3846
|
+
}
|
|
3847
|
+
/**
|
|
3848
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3849
|
+
* months.
|
|
3850
|
+
*/
|
|
3851
|
+
interface BillingCycleConfiguration {
|
|
3852
|
+
/**
|
|
3853
|
+
* The duration of the billing period.
|
|
3854
|
+
*/
|
|
3855
|
+
duration: number;
|
|
3856
|
+
/**
|
|
3857
|
+
* The unit of billing period duration.
|
|
3858
|
+
*/
|
|
3859
|
+
duration_unit: 'day' | 'month';
|
|
3860
|
+
}
|
|
3861
|
+
/**
|
|
3862
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3863
|
+
*/
|
|
3864
|
+
interface DimensionalPriceConfiguration {
|
|
3865
|
+
/**
|
|
3866
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3867
|
+
* group
|
|
3868
|
+
*/
|
|
3869
|
+
dimension_values: Array<string>;
|
|
3870
|
+
/**
|
|
3871
|
+
* The id of the dimensional price group to include this price in
|
|
3872
|
+
*/
|
|
3873
|
+
dimensional_price_group_id?: string | null;
|
|
3874
|
+
/**
|
|
3875
|
+
* The external id of the dimensional price group to include this price in
|
|
3876
|
+
*/
|
|
3877
|
+
external_dimensional_price_group_id?: string | null;
|
|
3878
|
+
}
|
|
3879
|
+
/**
|
|
3880
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3881
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3882
|
+
*/
|
|
3883
|
+
interface InvoicingCycleConfiguration {
|
|
3884
|
+
/**
|
|
3885
|
+
* The duration of the billing period.
|
|
3886
|
+
*/
|
|
3887
|
+
duration: number;
|
|
3888
|
+
/**
|
|
3889
|
+
* The unit of billing period duration.
|
|
3890
|
+
*/
|
|
3891
|
+
duration_unit: 'day' | 'month';
|
|
3892
|
+
}
|
|
3893
|
+
}
|
|
3894
|
+
interface NewPlanGroupedTieredPrice {
|
|
3895
|
+
/**
|
|
3896
|
+
* The cadence to bill for this price on.
|
|
3897
|
+
*/
|
|
3898
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
3899
|
+
grouped_tiered_config: Record<string, unknown>;
|
|
3900
|
+
/**
|
|
3901
|
+
* The id of the item the price will be associated with.
|
|
3902
|
+
*/
|
|
3903
|
+
item_id: string;
|
|
3904
|
+
model_type: 'grouped_tiered';
|
|
3905
|
+
/**
|
|
3906
|
+
* The name of the price.
|
|
3907
|
+
*/
|
|
3908
|
+
name: string;
|
|
3909
|
+
/**
|
|
3910
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
3911
|
+
* usage-based.
|
|
3912
|
+
*/
|
|
3913
|
+
billable_metric_id?: string | null;
|
|
3914
|
+
/**
|
|
3915
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3916
|
+
* this is true, and in-arrears if this is false.
|
|
3917
|
+
*/
|
|
3918
|
+
billed_in_advance?: boolean | null;
|
|
3919
|
+
/**
|
|
3920
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3921
|
+
* months.
|
|
3922
|
+
*/
|
|
3923
|
+
billing_cycle_configuration?: NewPlanGroupedTieredPrice.BillingCycleConfiguration | null;
|
|
3924
|
+
/**
|
|
3925
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3926
|
+
*/
|
|
3927
|
+
conversion_rate?: number | null;
|
|
3928
|
+
/**
|
|
3929
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
3930
|
+
* price is billed.
|
|
3931
|
+
*/
|
|
3932
|
+
currency?: string | null;
|
|
3933
|
+
/**
|
|
3934
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3935
|
+
*/
|
|
3936
|
+
dimensional_price_configuration?: NewPlanGroupedTieredPrice.DimensionalPriceConfiguration | null;
|
|
3937
|
+
/**
|
|
3938
|
+
* An alias for the price.
|
|
3939
|
+
*/
|
|
3940
|
+
external_price_id?: string | null;
|
|
3941
|
+
/**
|
|
3942
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
3943
|
+
* applied.
|
|
3944
|
+
*/
|
|
3945
|
+
fixed_price_quantity?: number | null;
|
|
3946
|
+
/**
|
|
3947
|
+
* The property used to group this price on an invoice
|
|
3948
|
+
*/
|
|
3949
|
+
invoice_grouping_key?: string | null;
|
|
3950
|
+
/**
|
|
3951
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3952
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
3953
|
+
*/
|
|
3954
|
+
invoicing_cycle_configuration?: NewPlanGroupedTieredPrice.InvoicingCycleConfiguration | null;
|
|
3955
|
+
/**
|
|
3956
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3957
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3958
|
+
* by setting `metadata` to `null`.
|
|
3959
|
+
*/
|
|
3960
|
+
metadata?: Record<string, string | null> | null;
|
|
3961
|
+
}
|
|
3962
|
+
namespace NewPlanGroupedTieredPrice {
|
|
3963
|
+
/**
|
|
3964
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
3965
|
+
* months.
|
|
3966
|
+
*/
|
|
3967
|
+
interface BillingCycleConfiguration {
|
|
3968
|
+
/**
|
|
3969
|
+
* The duration of the billing period.
|
|
3970
|
+
*/
|
|
3971
|
+
duration: number;
|
|
3972
|
+
/**
|
|
3973
|
+
* The unit of billing period duration.
|
|
3974
|
+
*/
|
|
3975
|
+
duration_unit: 'day' | 'month';
|
|
3976
|
+
}
|
|
3977
|
+
/**
|
|
3978
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3979
|
+
*/
|
|
3980
|
+
interface DimensionalPriceConfiguration {
|
|
3981
|
+
/**
|
|
3982
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3983
|
+
* group
|
|
3984
|
+
*/
|
|
3985
|
+
dimension_values: Array<string>;
|
|
3986
|
+
/**
|
|
3987
|
+
* The id of the dimensional price group to include this price in
|
|
3988
|
+
*/
|
|
3989
|
+
dimensional_price_group_id?: string | null;
|
|
3990
|
+
/**
|
|
3991
|
+
* The external id of the dimensional price group to include this price in
|
|
3992
|
+
*/
|
|
3993
|
+
external_dimensional_price_group_id?: string | null;
|
|
3994
|
+
}
|
|
2864
3995
|
/**
|
|
2865
3996
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2866
3997
|
* If unspecified, a single invoice is produced per billing cycle.
|