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
|
@@ -23,7 +23,7 @@ export class Plans extends APIResource {
|
|
|
23
23
|
* This endpoint can be used to update the `external_plan_id`, and `metadata` of an
|
|
24
24
|
* existing plan.
|
|
25
25
|
*
|
|
26
|
-
* Other fields on a
|
|
26
|
+
* Other fields on a plan are currently immutable.
|
|
27
27
|
*/
|
|
28
28
|
update(planId: string, body: PlanUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Plan> {
|
|
29
29
|
return this._client.put(`/plans/${planId}`, { body, ...options });
|
|
@@ -119,6 +119,9 @@ export interface Plan {
|
|
|
119
119
|
|
|
120
120
|
description: string;
|
|
121
121
|
|
|
122
|
+
/**
|
|
123
|
+
* @deprecated
|
|
124
|
+
*/
|
|
122
125
|
discount: Shared.Discount | null;
|
|
123
126
|
|
|
124
127
|
/**
|
|
@@ -134,8 +137,14 @@ export interface Plan {
|
|
|
134
137
|
*/
|
|
135
138
|
invoicing_currency: string;
|
|
136
139
|
|
|
140
|
+
/**
|
|
141
|
+
* @deprecated
|
|
142
|
+
*/
|
|
137
143
|
maximum: Plan.Maximum | null;
|
|
138
144
|
|
|
145
|
+
/**
|
|
146
|
+
* @deprecated
|
|
147
|
+
*/
|
|
139
148
|
maximum_amount: string | null;
|
|
140
149
|
|
|
141
150
|
/**
|
|
@@ -146,8 +155,14 @@ export interface Plan {
|
|
|
146
155
|
*/
|
|
147
156
|
metadata: Record<string, string>;
|
|
148
157
|
|
|
158
|
+
/**
|
|
159
|
+
* @deprecated
|
|
160
|
+
*/
|
|
149
161
|
minimum: Plan.Minimum | null;
|
|
150
162
|
|
|
163
|
+
/**
|
|
164
|
+
* @deprecated
|
|
165
|
+
*/
|
|
151
166
|
minimum_amount: string | null;
|
|
152
167
|
|
|
153
168
|
name: string;
|
|
@@ -185,10 +200,15 @@ export namespace Plan {
|
|
|
185
200
|
adjustment_type: 'usage_discount';
|
|
186
201
|
|
|
187
202
|
/**
|
|
188
|
-
* The price IDs that this adjustment applies to.
|
|
203
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
189
204
|
*/
|
|
190
205
|
applies_to_price_ids: Array<string>;
|
|
191
206
|
|
|
207
|
+
/**
|
|
208
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
209
|
+
*/
|
|
210
|
+
filters: Array<PlanPhaseUsageDiscountAdjustment.Filter>;
|
|
211
|
+
|
|
192
212
|
/**
|
|
193
213
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
194
214
|
* that apply to only one price.
|
|
@@ -212,6 +232,25 @@ export namespace Plan {
|
|
|
212
232
|
usage_discount: number;
|
|
213
233
|
}
|
|
214
234
|
|
|
235
|
+
export namespace PlanPhaseUsageDiscountAdjustment {
|
|
236
|
+
export interface Filter {
|
|
237
|
+
/**
|
|
238
|
+
* The property of the price to filter on.
|
|
239
|
+
*/
|
|
240
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Should prices that match the filter be included or excluded.
|
|
244
|
+
*/
|
|
245
|
+
operator: 'includes' | 'excludes';
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* The IDs or values that match this filter.
|
|
249
|
+
*/
|
|
250
|
+
values: Array<string>;
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
|
|
215
254
|
export interface PlanPhaseAmountDiscountAdjustment {
|
|
216
255
|
id: string;
|
|
217
256
|
|
|
@@ -224,10 +263,15 @@ export namespace Plan {
|
|
|
224
263
|
amount_discount: string;
|
|
225
264
|
|
|
226
265
|
/**
|
|
227
|
-
* The price IDs that this adjustment applies to.
|
|
266
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
228
267
|
*/
|
|
229
268
|
applies_to_price_ids: Array<string>;
|
|
230
269
|
|
|
270
|
+
/**
|
|
271
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
272
|
+
*/
|
|
273
|
+
filters: Array<PlanPhaseAmountDiscountAdjustment.Filter>;
|
|
274
|
+
|
|
231
275
|
/**
|
|
232
276
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
233
277
|
* that apply to only one price.
|
|
@@ -245,16 +289,40 @@ export namespace Plan {
|
|
|
245
289
|
reason: string | null;
|
|
246
290
|
}
|
|
247
291
|
|
|
292
|
+
export namespace PlanPhaseAmountDiscountAdjustment {
|
|
293
|
+
export interface Filter {
|
|
294
|
+
/**
|
|
295
|
+
* The property of the price to filter on.
|
|
296
|
+
*/
|
|
297
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
* Should prices that match the filter be included or excluded.
|
|
301
|
+
*/
|
|
302
|
+
operator: 'includes' | 'excludes';
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* The IDs or values that match this filter.
|
|
306
|
+
*/
|
|
307
|
+
values: Array<string>;
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
|
|
248
311
|
export interface PlanPhasePercentageDiscountAdjustment {
|
|
249
312
|
id: string;
|
|
250
313
|
|
|
251
314
|
adjustment_type: 'percentage_discount';
|
|
252
315
|
|
|
253
316
|
/**
|
|
254
|
-
* The price IDs that this adjustment applies to.
|
|
317
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
255
318
|
*/
|
|
256
319
|
applies_to_price_ids: Array<string>;
|
|
257
320
|
|
|
321
|
+
/**
|
|
322
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
323
|
+
*/
|
|
324
|
+
filters: Array<PlanPhasePercentageDiscountAdjustment.Filter>;
|
|
325
|
+
|
|
258
326
|
/**
|
|
259
327
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
260
328
|
* that apply to only one price.
|
|
@@ -278,16 +346,40 @@ export namespace Plan {
|
|
|
278
346
|
reason: string | null;
|
|
279
347
|
}
|
|
280
348
|
|
|
349
|
+
export namespace PlanPhasePercentageDiscountAdjustment {
|
|
350
|
+
export interface Filter {
|
|
351
|
+
/**
|
|
352
|
+
* The property of the price to filter on.
|
|
353
|
+
*/
|
|
354
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
355
|
+
|
|
356
|
+
/**
|
|
357
|
+
* Should prices that match the filter be included or excluded.
|
|
358
|
+
*/
|
|
359
|
+
operator: 'includes' | 'excludes';
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* The IDs or values that match this filter.
|
|
363
|
+
*/
|
|
364
|
+
values: Array<string>;
|
|
365
|
+
}
|
|
366
|
+
}
|
|
367
|
+
|
|
281
368
|
export interface PlanPhaseMinimumAdjustment {
|
|
282
369
|
id: string;
|
|
283
370
|
|
|
284
371
|
adjustment_type: 'minimum';
|
|
285
372
|
|
|
286
373
|
/**
|
|
287
|
-
* The price IDs that this adjustment applies to.
|
|
374
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
288
375
|
*/
|
|
289
376
|
applies_to_price_ids: Array<string>;
|
|
290
377
|
|
|
378
|
+
/**
|
|
379
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
380
|
+
*/
|
|
381
|
+
filters: Array<PlanPhaseMinimumAdjustment.Filter>;
|
|
382
|
+
|
|
291
383
|
/**
|
|
292
384
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
293
385
|
* that apply to only one price.
|
|
@@ -316,16 +408,40 @@ export namespace Plan {
|
|
|
316
408
|
reason: string | null;
|
|
317
409
|
}
|
|
318
410
|
|
|
411
|
+
export namespace PlanPhaseMinimumAdjustment {
|
|
412
|
+
export interface Filter {
|
|
413
|
+
/**
|
|
414
|
+
* The property of the price to filter on.
|
|
415
|
+
*/
|
|
416
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* Should prices that match the filter be included or excluded.
|
|
420
|
+
*/
|
|
421
|
+
operator: 'includes' | 'excludes';
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* The IDs or values that match this filter.
|
|
425
|
+
*/
|
|
426
|
+
values: Array<string>;
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
|
|
319
430
|
export interface PlanPhaseMaximumAdjustment {
|
|
320
431
|
id: string;
|
|
321
432
|
|
|
322
433
|
adjustment_type: 'maximum';
|
|
323
434
|
|
|
324
435
|
/**
|
|
325
|
-
* The price IDs that this adjustment applies to.
|
|
436
|
+
* @deprecated The price IDs that this adjustment applies to.
|
|
326
437
|
*/
|
|
327
438
|
applies_to_price_ids: Array<string>;
|
|
328
439
|
|
|
440
|
+
/**
|
|
441
|
+
* The filters that determine which prices to apply this adjustment to.
|
|
442
|
+
*/
|
|
443
|
+
filters: Array<PlanPhaseMaximumAdjustment.Filter>;
|
|
444
|
+
|
|
329
445
|
/**
|
|
330
446
|
* True for adjustments that apply to an entire invocice, false for adjustments
|
|
331
447
|
* that apply to only one price.
|
|
@@ -349,6 +465,25 @@ export namespace Plan {
|
|
|
349
465
|
reason: string | null;
|
|
350
466
|
}
|
|
351
467
|
|
|
468
|
+
export namespace PlanPhaseMaximumAdjustment {
|
|
469
|
+
export interface Filter {
|
|
470
|
+
/**
|
|
471
|
+
* The property of the price to filter on.
|
|
472
|
+
*/
|
|
473
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Should prices that match the filter be included or excluded.
|
|
477
|
+
*/
|
|
478
|
+
operator: 'includes' | 'excludes';
|
|
479
|
+
|
|
480
|
+
/**
|
|
481
|
+
* The IDs or values that match this filter.
|
|
482
|
+
*/
|
|
483
|
+
values: Array<string>;
|
|
484
|
+
}
|
|
485
|
+
}
|
|
486
|
+
|
|
352
487
|
export interface BasePlan {
|
|
353
488
|
id: string | null;
|
|
354
489
|
|
|
@@ -362,32 +497,86 @@ export namespace Plan {
|
|
|
362
497
|
name: string | null;
|
|
363
498
|
}
|
|
364
499
|
|
|
500
|
+
/**
|
|
501
|
+
* @deprecated
|
|
502
|
+
*/
|
|
365
503
|
export interface Maximum {
|
|
366
504
|
/**
|
|
367
|
-
* List of price_ids that this maximum amount applies to. For plan/plan
|
|
368
|
-
* maximums, this can be a subset of prices.
|
|
505
|
+
* @deprecated List of price_ids that this maximum amount applies to. For plan/plan
|
|
506
|
+
* phase maximums, this can be a subset of prices.
|
|
369
507
|
*/
|
|
370
508
|
applies_to_price_ids: Array<string>;
|
|
371
509
|
|
|
510
|
+
/**
|
|
511
|
+
* The filters that determine which prices to apply this maximum to.
|
|
512
|
+
*/
|
|
513
|
+
filters: Array<Maximum.Filter>;
|
|
514
|
+
|
|
372
515
|
/**
|
|
373
516
|
* Maximum amount applied
|
|
374
517
|
*/
|
|
375
518
|
maximum_amount: string;
|
|
376
519
|
}
|
|
377
520
|
|
|
521
|
+
export namespace Maximum {
|
|
522
|
+
export interface Filter {
|
|
523
|
+
/**
|
|
524
|
+
* The property of the price to filter on.
|
|
525
|
+
*/
|
|
526
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
527
|
+
|
|
528
|
+
/**
|
|
529
|
+
* Should prices that match the filter be included or excluded.
|
|
530
|
+
*/
|
|
531
|
+
operator: 'includes' | 'excludes';
|
|
532
|
+
|
|
533
|
+
/**
|
|
534
|
+
* The IDs or values that match this filter.
|
|
535
|
+
*/
|
|
536
|
+
values: Array<string>;
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
/**
|
|
541
|
+
* @deprecated
|
|
542
|
+
*/
|
|
378
543
|
export interface Minimum {
|
|
379
544
|
/**
|
|
380
|
-
* List of price_ids that this minimum amount applies to. For plan/plan
|
|
381
|
-
* minimums, this can be a subset of prices.
|
|
545
|
+
* @deprecated List of price_ids that this minimum amount applies to. For plan/plan
|
|
546
|
+
* phase minimums, this can be a subset of prices.
|
|
382
547
|
*/
|
|
383
548
|
applies_to_price_ids: Array<string>;
|
|
384
549
|
|
|
550
|
+
/**
|
|
551
|
+
* The filters that determine which prices to apply this minimum to.
|
|
552
|
+
*/
|
|
553
|
+
filters: Array<Minimum.Filter>;
|
|
554
|
+
|
|
385
555
|
/**
|
|
386
556
|
* Minimum amount applied
|
|
387
557
|
*/
|
|
388
558
|
minimum_amount: string;
|
|
389
559
|
}
|
|
390
560
|
|
|
561
|
+
export namespace Minimum {
|
|
562
|
+
export interface Filter {
|
|
563
|
+
/**
|
|
564
|
+
* The property of the price to filter on.
|
|
565
|
+
*/
|
|
566
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Should prices that match the filter be included or excluded.
|
|
570
|
+
*/
|
|
571
|
+
operator: 'includes' | 'excludes';
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* The IDs or values that match this filter.
|
|
575
|
+
*/
|
|
576
|
+
values: Array<string>;
|
|
577
|
+
}
|
|
578
|
+
}
|
|
579
|
+
|
|
391
580
|
export interface PlanPhase {
|
|
392
581
|
id: string;
|
|
393
582
|
|
|
@@ -422,29 +611,77 @@ export namespace Plan {
|
|
|
422
611
|
export namespace PlanPhase {
|
|
423
612
|
export interface Maximum {
|
|
424
613
|
/**
|
|
425
|
-
* List of price_ids that this maximum amount applies to. For plan/plan
|
|
426
|
-
* maximums, this can be a subset of prices.
|
|
614
|
+
* @deprecated List of price_ids that this maximum amount applies to. For plan/plan
|
|
615
|
+
* phase maximums, this can be a subset of prices.
|
|
427
616
|
*/
|
|
428
617
|
applies_to_price_ids: Array<string>;
|
|
429
618
|
|
|
619
|
+
/**
|
|
620
|
+
* The filters that determine which prices to apply this maximum to.
|
|
621
|
+
*/
|
|
622
|
+
filters: Array<Maximum.Filter>;
|
|
623
|
+
|
|
430
624
|
/**
|
|
431
625
|
* Maximum amount applied
|
|
432
626
|
*/
|
|
433
627
|
maximum_amount: string;
|
|
434
628
|
}
|
|
435
629
|
|
|
630
|
+
export namespace Maximum {
|
|
631
|
+
export interface Filter {
|
|
632
|
+
/**
|
|
633
|
+
* The property of the price to filter on.
|
|
634
|
+
*/
|
|
635
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
636
|
+
|
|
637
|
+
/**
|
|
638
|
+
* Should prices that match the filter be included or excluded.
|
|
639
|
+
*/
|
|
640
|
+
operator: 'includes' | 'excludes';
|
|
641
|
+
|
|
642
|
+
/**
|
|
643
|
+
* The IDs or values that match this filter.
|
|
644
|
+
*/
|
|
645
|
+
values: Array<string>;
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
|
|
436
649
|
export interface Minimum {
|
|
437
650
|
/**
|
|
438
|
-
* List of price_ids that this minimum amount applies to. For plan/plan
|
|
439
|
-
* minimums, this can be a subset of prices.
|
|
651
|
+
* @deprecated List of price_ids that this minimum amount applies to. For plan/plan
|
|
652
|
+
* phase minimums, this can be a subset of prices.
|
|
440
653
|
*/
|
|
441
654
|
applies_to_price_ids: Array<string>;
|
|
442
655
|
|
|
656
|
+
/**
|
|
657
|
+
* The filters that determine which prices to apply this minimum to.
|
|
658
|
+
*/
|
|
659
|
+
filters: Array<Minimum.Filter>;
|
|
660
|
+
|
|
443
661
|
/**
|
|
444
662
|
* Minimum amount applied
|
|
445
663
|
*/
|
|
446
664
|
minimum_amount: string;
|
|
447
665
|
}
|
|
666
|
+
|
|
667
|
+
export namespace Minimum {
|
|
668
|
+
export interface Filter {
|
|
669
|
+
/**
|
|
670
|
+
* The property of the price to filter on.
|
|
671
|
+
*/
|
|
672
|
+
field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
|
|
673
|
+
|
|
674
|
+
/**
|
|
675
|
+
* Should prices that match the filter be included or excluded.
|
|
676
|
+
*/
|
|
677
|
+
operator: 'includes' | 'excludes';
|
|
678
|
+
|
|
679
|
+
/**
|
|
680
|
+
* The IDs or values that match this filter.
|
|
681
|
+
*/
|
|
682
|
+
values: Array<string>;
|
|
683
|
+
}
|
|
684
|
+
}
|
|
448
685
|
}
|
|
449
686
|
|
|
450
687
|
export interface Product {
|
|
@@ -501,6 +738,9 @@ export interface PlanCreateParams {
|
|
|
501
738
|
| PlanCreateParams.NewPlanScalableMatrixWithUnitPricingPrice
|
|
502
739
|
| PlanCreateParams.NewPlanScalableMatrixWithTieredPricingPrice
|
|
503
740
|
| PlanCreateParams.NewPlanCumulativeGroupedBulkPrice
|
|
741
|
+
| PlanCreateParams.NewPlanTieredPackageWithMinimumPrice
|
|
742
|
+
| PlanCreateParams.NewPlanMatrixWithAllocationPrice
|
|
743
|
+
| PlanCreateParams.NewPlanGroupedTieredPrice
|
|
504
744
|
>;
|
|
505
745
|
|
|
506
746
|
/**
|
|
@@ -581,6 +821,11 @@ export namespace PlanCreateParams {
|
|
|
581
821
|
*/
|
|
582
822
|
currency?: string | null;
|
|
583
823
|
|
|
824
|
+
/**
|
|
825
|
+
* For dimensional price: specifies a price group and dimension values
|
|
826
|
+
*/
|
|
827
|
+
dimensional_price_configuration?: NewPlanUnitPrice.DimensionalPriceConfiguration | null;
|
|
828
|
+
|
|
584
829
|
/**
|
|
585
830
|
* An alias for the price.
|
|
586
831
|
*/
|
|
@@ -635,6 +880,27 @@ export namespace PlanCreateParams {
|
|
|
635
880
|
duration_unit: 'day' | 'month';
|
|
636
881
|
}
|
|
637
882
|
|
|
883
|
+
/**
|
|
884
|
+
* For dimensional price: specifies a price group and dimension values
|
|
885
|
+
*/
|
|
886
|
+
export interface DimensionalPriceConfiguration {
|
|
887
|
+
/**
|
|
888
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
889
|
+
* group
|
|
890
|
+
*/
|
|
891
|
+
dimension_values: Array<string>;
|
|
892
|
+
|
|
893
|
+
/**
|
|
894
|
+
* The id of the dimensional price group to include this price in
|
|
895
|
+
*/
|
|
896
|
+
dimensional_price_group_id?: string | null;
|
|
897
|
+
|
|
898
|
+
/**
|
|
899
|
+
* The external id of the dimensional price group to include this price in
|
|
900
|
+
*/
|
|
901
|
+
external_dimensional_price_group_id?: string | null;
|
|
902
|
+
}
|
|
903
|
+
|
|
638
904
|
/**
|
|
639
905
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
640
906
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -701,6 +967,11 @@ export namespace PlanCreateParams {
|
|
|
701
967
|
*/
|
|
702
968
|
currency?: string | null;
|
|
703
969
|
|
|
970
|
+
/**
|
|
971
|
+
* For dimensional price: specifies a price group and dimension values
|
|
972
|
+
*/
|
|
973
|
+
dimensional_price_configuration?: NewPlanPackagePrice.DimensionalPriceConfiguration | null;
|
|
974
|
+
|
|
704
975
|
/**
|
|
705
976
|
* An alias for the price.
|
|
706
977
|
*/
|
|
@@ -761,6 +1032,27 @@ export namespace PlanCreateParams {
|
|
|
761
1032
|
duration_unit: 'day' | 'month';
|
|
762
1033
|
}
|
|
763
1034
|
|
|
1035
|
+
/**
|
|
1036
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1037
|
+
*/
|
|
1038
|
+
export interface DimensionalPriceConfiguration {
|
|
1039
|
+
/**
|
|
1040
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1041
|
+
* group
|
|
1042
|
+
*/
|
|
1043
|
+
dimension_values: Array<string>;
|
|
1044
|
+
|
|
1045
|
+
/**
|
|
1046
|
+
* The id of the dimensional price group to include this price in
|
|
1047
|
+
*/
|
|
1048
|
+
dimensional_price_group_id?: string | null;
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* The external id of the dimensional price group to include this price in
|
|
1052
|
+
*/
|
|
1053
|
+
external_dimensional_price_group_id?: string | null;
|
|
1054
|
+
}
|
|
1055
|
+
|
|
764
1056
|
/**
|
|
765
1057
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
766
1058
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -827,6 +1119,11 @@ export namespace PlanCreateParams {
|
|
|
827
1119
|
*/
|
|
828
1120
|
currency?: string | null;
|
|
829
1121
|
|
|
1122
|
+
/**
|
|
1123
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1124
|
+
*/
|
|
1125
|
+
dimensional_price_configuration?: NewPlanMatrixPrice.DimensionalPriceConfiguration | null;
|
|
1126
|
+
|
|
830
1127
|
/**
|
|
831
1128
|
* An alias for the price.
|
|
832
1129
|
*/
|
|
@@ -907,6 +1204,27 @@ export namespace PlanCreateParams {
|
|
|
907
1204
|
duration_unit: 'day' | 'month';
|
|
908
1205
|
}
|
|
909
1206
|
|
|
1207
|
+
/**
|
|
1208
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1209
|
+
*/
|
|
1210
|
+
export interface DimensionalPriceConfiguration {
|
|
1211
|
+
/**
|
|
1212
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1213
|
+
* group
|
|
1214
|
+
*/
|
|
1215
|
+
dimension_values: Array<string>;
|
|
1216
|
+
|
|
1217
|
+
/**
|
|
1218
|
+
* The id of the dimensional price group to include this price in
|
|
1219
|
+
*/
|
|
1220
|
+
dimensional_price_group_id?: string | null;
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* The external id of the dimensional price group to include this price in
|
|
1224
|
+
*/
|
|
1225
|
+
external_dimensional_price_group_id?: string | null;
|
|
1226
|
+
}
|
|
1227
|
+
|
|
910
1228
|
/**
|
|
911
1229
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
912
1230
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -973,6 +1291,11 @@ export namespace PlanCreateParams {
|
|
|
973
1291
|
*/
|
|
974
1292
|
currency?: string | null;
|
|
975
1293
|
|
|
1294
|
+
/**
|
|
1295
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1296
|
+
*/
|
|
1297
|
+
dimensional_price_configuration?: NewPlanTieredPrice.DimensionalPriceConfiguration | null;
|
|
1298
|
+
|
|
976
1299
|
/**
|
|
977
1300
|
* An alias for the price.
|
|
978
1301
|
*/
|
|
@@ -1046,6 +1369,27 @@ export namespace PlanCreateParams {
|
|
|
1046
1369
|
duration_unit: 'day' | 'month';
|
|
1047
1370
|
}
|
|
1048
1371
|
|
|
1372
|
+
/**
|
|
1373
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1374
|
+
*/
|
|
1375
|
+
export interface DimensionalPriceConfiguration {
|
|
1376
|
+
/**
|
|
1377
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1378
|
+
* group
|
|
1379
|
+
*/
|
|
1380
|
+
dimension_values: Array<string>;
|
|
1381
|
+
|
|
1382
|
+
/**
|
|
1383
|
+
* The id of the dimensional price group to include this price in
|
|
1384
|
+
*/
|
|
1385
|
+
dimensional_price_group_id?: string | null;
|
|
1386
|
+
|
|
1387
|
+
/**
|
|
1388
|
+
* The external id of the dimensional price group to include this price in
|
|
1389
|
+
*/
|
|
1390
|
+
external_dimensional_price_group_id?: string | null;
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1049
1393
|
/**
|
|
1050
1394
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1051
1395
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1112,6 +1456,11 @@ export namespace PlanCreateParams {
|
|
|
1112
1456
|
*/
|
|
1113
1457
|
currency?: string | null;
|
|
1114
1458
|
|
|
1459
|
+
/**
|
|
1460
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1461
|
+
*/
|
|
1462
|
+
dimensional_price_configuration?: NewPlanTieredBpsPrice.DimensionalPriceConfiguration | null;
|
|
1463
|
+
|
|
1115
1464
|
/**
|
|
1116
1465
|
* An alias for the price.
|
|
1117
1466
|
*/
|
|
@@ -1191,6 +1540,27 @@ export namespace PlanCreateParams {
|
|
|
1191
1540
|
duration_unit: 'day' | 'month';
|
|
1192
1541
|
}
|
|
1193
1542
|
|
|
1543
|
+
/**
|
|
1544
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1545
|
+
*/
|
|
1546
|
+
export interface DimensionalPriceConfiguration {
|
|
1547
|
+
/**
|
|
1548
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1549
|
+
* group
|
|
1550
|
+
*/
|
|
1551
|
+
dimension_values: Array<string>;
|
|
1552
|
+
|
|
1553
|
+
/**
|
|
1554
|
+
* The id of the dimensional price group to include this price in
|
|
1555
|
+
*/
|
|
1556
|
+
dimensional_price_group_id?: string | null;
|
|
1557
|
+
|
|
1558
|
+
/**
|
|
1559
|
+
* The external id of the dimensional price group to include this price in
|
|
1560
|
+
*/
|
|
1561
|
+
external_dimensional_price_group_id?: string | null;
|
|
1562
|
+
}
|
|
1563
|
+
|
|
1194
1564
|
/**
|
|
1195
1565
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1196
1566
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1257,6 +1627,11 @@ export namespace PlanCreateParams {
|
|
|
1257
1627
|
*/
|
|
1258
1628
|
currency?: string | null;
|
|
1259
1629
|
|
|
1630
|
+
/**
|
|
1631
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1632
|
+
*/
|
|
1633
|
+
dimensional_price_configuration?: NewPlanBpsPrice.DimensionalPriceConfiguration | null;
|
|
1634
|
+
|
|
1260
1635
|
/**
|
|
1261
1636
|
* An alias for the price.
|
|
1262
1637
|
*/
|
|
@@ -1316,6 +1691,27 @@ export namespace PlanCreateParams {
|
|
|
1316
1691
|
duration_unit: 'day' | 'month';
|
|
1317
1692
|
}
|
|
1318
1693
|
|
|
1694
|
+
/**
|
|
1695
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1696
|
+
*/
|
|
1697
|
+
export interface DimensionalPriceConfiguration {
|
|
1698
|
+
/**
|
|
1699
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1700
|
+
* group
|
|
1701
|
+
*/
|
|
1702
|
+
dimension_values: Array<string>;
|
|
1703
|
+
|
|
1704
|
+
/**
|
|
1705
|
+
* The id of the dimensional price group to include this price in
|
|
1706
|
+
*/
|
|
1707
|
+
dimensional_price_group_id?: string | null;
|
|
1708
|
+
|
|
1709
|
+
/**
|
|
1710
|
+
* The external id of the dimensional price group to include this price in
|
|
1711
|
+
*/
|
|
1712
|
+
external_dimensional_price_group_id?: string | null;
|
|
1713
|
+
}
|
|
1714
|
+
|
|
1319
1715
|
/**
|
|
1320
1716
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1321
1717
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1382,6 +1778,11 @@ export namespace PlanCreateParams {
|
|
|
1382
1778
|
*/
|
|
1383
1779
|
currency?: string | null;
|
|
1384
1780
|
|
|
1781
|
+
/**
|
|
1782
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1783
|
+
*/
|
|
1784
|
+
dimensional_price_configuration?: NewPlanBulkBpsPrice.DimensionalPriceConfiguration | null;
|
|
1785
|
+
|
|
1385
1786
|
/**
|
|
1386
1787
|
* An alias for the price.
|
|
1387
1788
|
*/
|
|
@@ -1456,6 +1857,27 @@ export namespace PlanCreateParams {
|
|
|
1456
1857
|
duration_unit: 'day' | 'month';
|
|
1457
1858
|
}
|
|
1458
1859
|
|
|
1860
|
+
/**
|
|
1861
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1862
|
+
*/
|
|
1863
|
+
export interface DimensionalPriceConfiguration {
|
|
1864
|
+
/**
|
|
1865
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
1866
|
+
* group
|
|
1867
|
+
*/
|
|
1868
|
+
dimension_values: Array<string>;
|
|
1869
|
+
|
|
1870
|
+
/**
|
|
1871
|
+
* The id of the dimensional price group to include this price in
|
|
1872
|
+
*/
|
|
1873
|
+
dimensional_price_group_id?: string | null;
|
|
1874
|
+
|
|
1875
|
+
/**
|
|
1876
|
+
* The external id of the dimensional price group to include this price in
|
|
1877
|
+
*/
|
|
1878
|
+
external_dimensional_price_group_id?: string | null;
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1459
1881
|
/**
|
|
1460
1882
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1461
1883
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1522,6 +1944,11 @@ export namespace PlanCreateParams {
|
|
|
1522
1944
|
*/
|
|
1523
1945
|
currency?: string | null;
|
|
1524
1946
|
|
|
1947
|
+
/**
|
|
1948
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1949
|
+
*/
|
|
1950
|
+
dimensional_price_configuration?: NewPlanBulkPrice.DimensionalPriceConfiguration | null;
|
|
1951
|
+
|
|
1525
1952
|
/**
|
|
1526
1953
|
* An alias for the price.
|
|
1527
1954
|
*/
|
|
@@ -1591,20 +2018,41 @@ export namespace PlanCreateParams {
|
|
|
1591
2018
|
}
|
|
1592
2019
|
|
|
1593
2020
|
/**
|
|
1594
|
-
*
|
|
1595
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
2021
|
+
* For dimensional price: specifies a price group and dimension values
|
|
1596
2022
|
*/
|
|
1597
|
-
export interface
|
|
2023
|
+
export interface DimensionalPriceConfiguration {
|
|
1598
2024
|
/**
|
|
1599
|
-
* The
|
|
2025
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2026
|
+
* group
|
|
1600
2027
|
*/
|
|
1601
|
-
|
|
2028
|
+
dimension_values: Array<string>;
|
|
1602
2029
|
|
|
1603
2030
|
/**
|
|
1604
|
-
* The
|
|
2031
|
+
* The id of the dimensional price group to include this price in
|
|
1605
2032
|
*/
|
|
1606
|
-
|
|
1607
|
-
|
|
2033
|
+
dimensional_price_group_id?: string | null;
|
|
2034
|
+
|
|
2035
|
+
/**
|
|
2036
|
+
* The external id of the dimensional price group to include this price in
|
|
2037
|
+
*/
|
|
2038
|
+
external_dimensional_price_group_id?: string | null;
|
|
2039
|
+
}
|
|
2040
|
+
|
|
2041
|
+
/**
|
|
2042
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2043
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2044
|
+
*/
|
|
2045
|
+
export interface InvoicingCycleConfiguration {
|
|
2046
|
+
/**
|
|
2047
|
+
* The duration of the billing period.
|
|
2048
|
+
*/
|
|
2049
|
+
duration: number;
|
|
2050
|
+
|
|
2051
|
+
/**
|
|
2052
|
+
* The unit of billing period duration.
|
|
2053
|
+
*/
|
|
2054
|
+
duration_unit: 'day' | 'month';
|
|
2055
|
+
}
|
|
1608
2056
|
}
|
|
1609
2057
|
|
|
1610
2058
|
export interface NewPlanThresholdTotalAmountPrice {
|
|
@@ -1656,6 +2104,11 @@ export namespace PlanCreateParams {
|
|
|
1656
2104
|
*/
|
|
1657
2105
|
currency?: string | null;
|
|
1658
2106
|
|
|
2107
|
+
/**
|
|
2108
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2109
|
+
*/
|
|
2110
|
+
dimensional_price_configuration?: NewPlanThresholdTotalAmountPrice.DimensionalPriceConfiguration | null;
|
|
2111
|
+
|
|
1659
2112
|
/**
|
|
1660
2113
|
* An alias for the price.
|
|
1661
2114
|
*/
|
|
@@ -1703,6 +2156,27 @@ export namespace PlanCreateParams {
|
|
|
1703
2156
|
duration_unit: 'day' | 'month';
|
|
1704
2157
|
}
|
|
1705
2158
|
|
|
2159
|
+
/**
|
|
2160
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2161
|
+
*/
|
|
2162
|
+
export interface DimensionalPriceConfiguration {
|
|
2163
|
+
/**
|
|
2164
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2165
|
+
* group
|
|
2166
|
+
*/
|
|
2167
|
+
dimension_values: Array<string>;
|
|
2168
|
+
|
|
2169
|
+
/**
|
|
2170
|
+
* The id of the dimensional price group to include this price in
|
|
2171
|
+
*/
|
|
2172
|
+
dimensional_price_group_id?: string | null;
|
|
2173
|
+
|
|
2174
|
+
/**
|
|
2175
|
+
* The external id of the dimensional price group to include this price in
|
|
2176
|
+
*/
|
|
2177
|
+
external_dimensional_price_group_id?: string | null;
|
|
2178
|
+
}
|
|
2179
|
+
|
|
1706
2180
|
/**
|
|
1707
2181
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1708
2182
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1769,6 +2243,11 @@ export namespace PlanCreateParams {
|
|
|
1769
2243
|
*/
|
|
1770
2244
|
currency?: string | null;
|
|
1771
2245
|
|
|
2246
|
+
/**
|
|
2247
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2248
|
+
*/
|
|
2249
|
+
dimensional_price_configuration?: NewPlanTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
2250
|
+
|
|
1772
2251
|
/**
|
|
1773
2252
|
* An alias for the price.
|
|
1774
2253
|
*/
|
|
@@ -1816,6 +2295,27 @@ export namespace PlanCreateParams {
|
|
|
1816
2295
|
duration_unit: 'day' | 'month';
|
|
1817
2296
|
}
|
|
1818
2297
|
|
|
2298
|
+
/**
|
|
2299
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2300
|
+
*/
|
|
2301
|
+
export interface DimensionalPriceConfiguration {
|
|
2302
|
+
/**
|
|
2303
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2304
|
+
* group
|
|
2305
|
+
*/
|
|
2306
|
+
dimension_values: Array<string>;
|
|
2307
|
+
|
|
2308
|
+
/**
|
|
2309
|
+
* The id of the dimensional price group to include this price in
|
|
2310
|
+
*/
|
|
2311
|
+
dimensional_price_group_id?: string | null;
|
|
2312
|
+
|
|
2313
|
+
/**
|
|
2314
|
+
* The external id of the dimensional price group to include this price in
|
|
2315
|
+
*/
|
|
2316
|
+
external_dimensional_price_group_id?: string | null;
|
|
2317
|
+
}
|
|
2318
|
+
|
|
1819
2319
|
/**
|
|
1820
2320
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1821
2321
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1882,6 +2382,11 @@ export namespace PlanCreateParams {
|
|
|
1882
2382
|
*/
|
|
1883
2383
|
currency?: string | null;
|
|
1884
2384
|
|
|
2385
|
+
/**
|
|
2386
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2387
|
+
*/
|
|
2388
|
+
dimensional_price_configuration?: NewPlanTieredWithMinimumPrice.DimensionalPriceConfiguration | null;
|
|
2389
|
+
|
|
1885
2390
|
/**
|
|
1886
2391
|
* An alias for the price.
|
|
1887
2392
|
*/
|
|
@@ -1929,6 +2434,27 @@ export namespace PlanCreateParams {
|
|
|
1929
2434
|
duration_unit: 'day' | 'month';
|
|
1930
2435
|
}
|
|
1931
2436
|
|
|
2437
|
+
/**
|
|
2438
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2439
|
+
*/
|
|
2440
|
+
export 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
|
+
/**
|
|
2448
|
+
* The id of the dimensional price group to include this price in
|
|
2449
|
+
*/
|
|
2450
|
+
dimensional_price_group_id?: string | null;
|
|
2451
|
+
|
|
2452
|
+
/**
|
|
2453
|
+
* The external id of the dimensional price group to include this price in
|
|
2454
|
+
*/
|
|
2455
|
+
external_dimensional_price_group_id?: string | null;
|
|
2456
|
+
}
|
|
2457
|
+
|
|
1932
2458
|
/**
|
|
1933
2459
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1934
2460
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -1995,6 +2521,11 @@ export namespace PlanCreateParams {
|
|
|
1995
2521
|
*/
|
|
1996
2522
|
currency?: string | null;
|
|
1997
2523
|
|
|
2524
|
+
/**
|
|
2525
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2526
|
+
*/
|
|
2527
|
+
dimensional_price_configuration?: NewPlanUnitWithPercentPrice.DimensionalPriceConfiguration | null;
|
|
2528
|
+
|
|
1998
2529
|
/**
|
|
1999
2530
|
* An alias for the price.
|
|
2000
2531
|
*/
|
|
@@ -2042,6 +2573,27 @@ export namespace PlanCreateParams {
|
|
|
2042
2573
|
duration_unit: 'day' | 'month';
|
|
2043
2574
|
}
|
|
2044
2575
|
|
|
2576
|
+
/**
|
|
2577
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2578
|
+
*/
|
|
2579
|
+
export interface DimensionalPriceConfiguration {
|
|
2580
|
+
/**
|
|
2581
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2582
|
+
* group
|
|
2583
|
+
*/
|
|
2584
|
+
dimension_values: Array<string>;
|
|
2585
|
+
|
|
2586
|
+
/**
|
|
2587
|
+
* The id of the dimensional price group to include this price in
|
|
2588
|
+
*/
|
|
2589
|
+
dimensional_price_group_id?: string | null;
|
|
2590
|
+
|
|
2591
|
+
/**
|
|
2592
|
+
* The external id of the dimensional price group to include this price in
|
|
2593
|
+
*/
|
|
2594
|
+
external_dimensional_price_group_id?: string | null;
|
|
2595
|
+
}
|
|
2596
|
+
|
|
2045
2597
|
/**
|
|
2046
2598
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2047
2599
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2108,6 +2660,11 @@ export namespace PlanCreateParams {
|
|
|
2108
2660
|
*/
|
|
2109
2661
|
currency?: string | null;
|
|
2110
2662
|
|
|
2663
|
+
/**
|
|
2664
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2665
|
+
*/
|
|
2666
|
+
dimensional_price_configuration?: NewPlanPackageWithAllocationPrice.DimensionalPriceConfiguration | null;
|
|
2667
|
+
|
|
2111
2668
|
/**
|
|
2112
2669
|
* An alias for the price.
|
|
2113
2670
|
*/
|
|
@@ -2155,6 +2712,27 @@ export namespace PlanCreateParams {
|
|
|
2155
2712
|
duration_unit: 'day' | 'month';
|
|
2156
2713
|
}
|
|
2157
2714
|
|
|
2715
|
+
/**
|
|
2716
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2717
|
+
*/
|
|
2718
|
+
export interface DimensionalPriceConfiguration {
|
|
2719
|
+
/**
|
|
2720
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2721
|
+
* group
|
|
2722
|
+
*/
|
|
2723
|
+
dimension_values: Array<string>;
|
|
2724
|
+
|
|
2725
|
+
/**
|
|
2726
|
+
* The id of the dimensional price group to include this price in
|
|
2727
|
+
*/
|
|
2728
|
+
dimensional_price_group_id?: string | null;
|
|
2729
|
+
|
|
2730
|
+
/**
|
|
2731
|
+
* The external id of the dimensional price group to include this price in
|
|
2732
|
+
*/
|
|
2733
|
+
external_dimensional_price_group_id?: string | null;
|
|
2734
|
+
}
|
|
2735
|
+
|
|
2158
2736
|
/**
|
|
2159
2737
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2160
2738
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2221,6 +2799,11 @@ export namespace PlanCreateParams {
|
|
|
2221
2799
|
*/
|
|
2222
2800
|
currency?: string | null;
|
|
2223
2801
|
|
|
2802
|
+
/**
|
|
2803
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2804
|
+
*/
|
|
2805
|
+
dimensional_price_configuration?: NewPlanTierWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
2806
|
+
|
|
2224
2807
|
/**
|
|
2225
2808
|
* An alias for the price.
|
|
2226
2809
|
*/
|
|
@@ -2268,6 +2851,27 @@ export namespace PlanCreateParams {
|
|
|
2268
2851
|
duration_unit: 'day' | 'month';
|
|
2269
2852
|
}
|
|
2270
2853
|
|
|
2854
|
+
/**
|
|
2855
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2856
|
+
*/
|
|
2857
|
+
export interface DimensionalPriceConfiguration {
|
|
2858
|
+
/**
|
|
2859
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2860
|
+
* group
|
|
2861
|
+
*/
|
|
2862
|
+
dimension_values: Array<string>;
|
|
2863
|
+
|
|
2864
|
+
/**
|
|
2865
|
+
* The id of the dimensional price group to include this price in
|
|
2866
|
+
*/
|
|
2867
|
+
dimensional_price_group_id?: string | null;
|
|
2868
|
+
|
|
2869
|
+
/**
|
|
2870
|
+
* The external id of the dimensional price group to include this price in
|
|
2871
|
+
*/
|
|
2872
|
+
external_dimensional_price_group_id?: string | null;
|
|
2873
|
+
}
|
|
2874
|
+
|
|
2271
2875
|
/**
|
|
2272
2876
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2273
2877
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2334,6 +2938,11 @@ export namespace PlanCreateParams {
|
|
|
2334
2938
|
*/
|
|
2335
2939
|
currency?: string | null;
|
|
2336
2940
|
|
|
2941
|
+
/**
|
|
2942
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2943
|
+
*/
|
|
2944
|
+
dimensional_price_configuration?: NewPlanUnitWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
2945
|
+
|
|
2337
2946
|
/**
|
|
2338
2947
|
* An alias for the price.
|
|
2339
2948
|
*/
|
|
@@ -2381,6 +2990,27 @@ export namespace PlanCreateParams {
|
|
|
2381
2990
|
duration_unit: 'day' | 'month';
|
|
2382
2991
|
}
|
|
2383
2992
|
|
|
2993
|
+
/**
|
|
2994
|
+
* For dimensional price: specifies a price group and dimension values
|
|
2995
|
+
*/
|
|
2996
|
+
export interface DimensionalPriceConfiguration {
|
|
2997
|
+
/**
|
|
2998
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
2999
|
+
* group
|
|
3000
|
+
*/
|
|
3001
|
+
dimension_values: Array<string>;
|
|
3002
|
+
|
|
3003
|
+
/**
|
|
3004
|
+
* The id of the dimensional price group to include this price in
|
|
3005
|
+
*/
|
|
3006
|
+
dimensional_price_group_id?: string | null;
|
|
3007
|
+
|
|
3008
|
+
/**
|
|
3009
|
+
* The external id of the dimensional price group to include this price in
|
|
3010
|
+
*/
|
|
3011
|
+
external_dimensional_price_group_id?: string | null;
|
|
3012
|
+
}
|
|
3013
|
+
|
|
2384
3014
|
/**
|
|
2385
3015
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2386
3016
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2447,6 +3077,11 @@ export namespace PlanCreateParams {
|
|
|
2447
3077
|
*/
|
|
2448
3078
|
currency?: string | null;
|
|
2449
3079
|
|
|
3080
|
+
/**
|
|
3081
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3082
|
+
*/
|
|
3083
|
+
dimensional_price_configuration?: NewPlanGroupedAllocationPrice.DimensionalPriceConfiguration | null;
|
|
3084
|
+
|
|
2450
3085
|
/**
|
|
2451
3086
|
* An alias for the price.
|
|
2452
3087
|
*/
|
|
@@ -2494,6 +3129,27 @@ export namespace PlanCreateParams {
|
|
|
2494
3129
|
duration_unit: 'day' | 'month';
|
|
2495
3130
|
}
|
|
2496
3131
|
|
|
3132
|
+
/**
|
|
3133
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3134
|
+
*/
|
|
3135
|
+
export interface DimensionalPriceConfiguration {
|
|
3136
|
+
/**
|
|
3137
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3138
|
+
* group
|
|
3139
|
+
*/
|
|
3140
|
+
dimension_values: Array<string>;
|
|
3141
|
+
|
|
3142
|
+
/**
|
|
3143
|
+
* The id of the dimensional price group to include this price in
|
|
3144
|
+
*/
|
|
3145
|
+
dimensional_price_group_id?: string | null;
|
|
3146
|
+
|
|
3147
|
+
/**
|
|
3148
|
+
* The external id of the dimensional price group to include this price in
|
|
3149
|
+
*/
|
|
3150
|
+
external_dimensional_price_group_id?: string | null;
|
|
3151
|
+
}
|
|
3152
|
+
|
|
2497
3153
|
/**
|
|
2498
3154
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2499
3155
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2560,6 +3216,11 @@ export namespace PlanCreateParams {
|
|
|
2560
3216
|
*/
|
|
2561
3217
|
currency?: string | null;
|
|
2562
3218
|
|
|
3219
|
+
/**
|
|
3220
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3221
|
+
*/
|
|
3222
|
+
dimensional_price_configuration?: NewPlanGroupedWithProratedMinimumPrice.DimensionalPriceConfiguration | null;
|
|
3223
|
+
|
|
2563
3224
|
/**
|
|
2564
3225
|
* An alias for the price.
|
|
2565
3226
|
*/
|
|
@@ -2607,6 +3268,27 @@ export namespace PlanCreateParams {
|
|
|
2607
3268
|
duration_unit: 'day' | 'month';
|
|
2608
3269
|
}
|
|
2609
3270
|
|
|
3271
|
+
/**
|
|
3272
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3273
|
+
*/
|
|
3274
|
+
export interface DimensionalPriceConfiguration {
|
|
3275
|
+
/**
|
|
3276
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3277
|
+
* group
|
|
3278
|
+
*/
|
|
3279
|
+
dimension_values: Array<string>;
|
|
3280
|
+
|
|
3281
|
+
/**
|
|
3282
|
+
* The id of the dimensional price group to include this price in
|
|
3283
|
+
*/
|
|
3284
|
+
dimensional_price_group_id?: string | null;
|
|
3285
|
+
|
|
3286
|
+
/**
|
|
3287
|
+
* The external id of the dimensional price group to include this price in
|
|
3288
|
+
*/
|
|
3289
|
+
external_dimensional_price_group_id?: string | null;
|
|
3290
|
+
}
|
|
3291
|
+
|
|
2610
3292
|
/**
|
|
2611
3293
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2612
3294
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2673,6 +3355,11 @@ export namespace PlanCreateParams {
|
|
|
2673
3355
|
*/
|
|
2674
3356
|
currency?: string | null;
|
|
2675
3357
|
|
|
3358
|
+
/**
|
|
3359
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3360
|
+
*/
|
|
3361
|
+
dimensional_price_configuration?: NewPlanGroupedWithMeteredMinimumPrice.DimensionalPriceConfiguration | null;
|
|
3362
|
+
|
|
2676
3363
|
/**
|
|
2677
3364
|
* An alias for the price.
|
|
2678
3365
|
*/
|
|
@@ -2720,6 +3407,27 @@ export namespace PlanCreateParams {
|
|
|
2720
3407
|
duration_unit: 'day' | 'month';
|
|
2721
3408
|
}
|
|
2722
3409
|
|
|
3410
|
+
/**
|
|
3411
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3412
|
+
*/
|
|
3413
|
+
export interface DimensionalPriceConfiguration {
|
|
3414
|
+
/**
|
|
3415
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3416
|
+
* group
|
|
3417
|
+
*/
|
|
3418
|
+
dimension_values: Array<string>;
|
|
3419
|
+
|
|
3420
|
+
/**
|
|
3421
|
+
* The id of the dimensional price group to include this price in
|
|
3422
|
+
*/
|
|
3423
|
+
dimensional_price_group_id?: string | null;
|
|
3424
|
+
|
|
3425
|
+
/**
|
|
3426
|
+
* The external id of the dimensional price group to include this price in
|
|
3427
|
+
*/
|
|
3428
|
+
external_dimensional_price_group_id?: string | null;
|
|
3429
|
+
}
|
|
3430
|
+
|
|
2723
3431
|
/**
|
|
2724
3432
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2725
3433
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2786,6 +3494,11 @@ export namespace PlanCreateParams {
|
|
|
2786
3494
|
*/
|
|
2787
3495
|
currency?: string | null;
|
|
2788
3496
|
|
|
3497
|
+
/**
|
|
3498
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3499
|
+
*/
|
|
3500
|
+
dimensional_price_configuration?: NewPlanMatrixWithDisplayNamePrice.DimensionalPriceConfiguration | null;
|
|
3501
|
+
|
|
2789
3502
|
/**
|
|
2790
3503
|
* An alias for the price.
|
|
2791
3504
|
*/
|
|
@@ -2833,6 +3546,27 @@ export namespace PlanCreateParams {
|
|
|
2833
3546
|
duration_unit: 'day' | 'month';
|
|
2834
3547
|
}
|
|
2835
3548
|
|
|
3549
|
+
/**
|
|
3550
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3551
|
+
*/
|
|
3552
|
+
export interface DimensionalPriceConfiguration {
|
|
3553
|
+
/**
|
|
3554
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3555
|
+
* group
|
|
3556
|
+
*/
|
|
3557
|
+
dimension_values: Array<string>;
|
|
3558
|
+
|
|
3559
|
+
/**
|
|
3560
|
+
* The id of the dimensional price group to include this price in
|
|
3561
|
+
*/
|
|
3562
|
+
dimensional_price_group_id?: string | null;
|
|
3563
|
+
|
|
3564
|
+
/**
|
|
3565
|
+
* The external id of the dimensional price group to include this price in
|
|
3566
|
+
*/
|
|
3567
|
+
external_dimensional_price_group_id?: string | null;
|
|
3568
|
+
}
|
|
3569
|
+
|
|
2836
3570
|
/**
|
|
2837
3571
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2838
3572
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -2899,6 +3633,11 @@ export namespace PlanCreateParams {
|
|
|
2899
3633
|
*/
|
|
2900
3634
|
currency?: string | null;
|
|
2901
3635
|
|
|
3636
|
+
/**
|
|
3637
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3638
|
+
*/
|
|
3639
|
+
dimensional_price_configuration?: NewPlanBulkWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
3640
|
+
|
|
2902
3641
|
/**
|
|
2903
3642
|
* An alias for the price.
|
|
2904
3643
|
*/
|
|
@@ -2946,6 +3685,27 @@ export namespace PlanCreateParams {
|
|
|
2946
3685
|
duration_unit: 'day' | 'month';
|
|
2947
3686
|
}
|
|
2948
3687
|
|
|
3688
|
+
/**
|
|
3689
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3690
|
+
*/
|
|
3691
|
+
export interface DimensionalPriceConfiguration {
|
|
3692
|
+
/**
|
|
3693
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3694
|
+
* group
|
|
3695
|
+
*/
|
|
3696
|
+
dimension_values: Array<string>;
|
|
3697
|
+
|
|
3698
|
+
/**
|
|
3699
|
+
* The id of the dimensional price group to include this price in
|
|
3700
|
+
*/
|
|
3701
|
+
dimensional_price_group_id?: string | null;
|
|
3702
|
+
|
|
3703
|
+
/**
|
|
3704
|
+
* The external id of the dimensional price group to include this price in
|
|
3705
|
+
*/
|
|
3706
|
+
external_dimensional_price_group_id?: string | null;
|
|
3707
|
+
}
|
|
3708
|
+
|
|
2949
3709
|
/**
|
|
2950
3710
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2951
3711
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -3012,6 +3772,11 @@ export namespace PlanCreateParams {
|
|
|
3012
3772
|
*/
|
|
3013
3773
|
currency?: string | null;
|
|
3014
3774
|
|
|
3775
|
+
/**
|
|
3776
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3777
|
+
*/
|
|
3778
|
+
dimensional_price_configuration?: NewPlanGroupedTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
3779
|
+
|
|
3015
3780
|
/**
|
|
3016
3781
|
* An alias for the price.
|
|
3017
3782
|
*/
|
|
@@ -3059,6 +3824,27 @@ export namespace PlanCreateParams {
|
|
|
3059
3824
|
duration_unit: 'day' | 'month';
|
|
3060
3825
|
}
|
|
3061
3826
|
|
|
3827
|
+
/**
|
|
3828
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3829
|
+
*/
|
|
3830
|
+
export interface DimensionalPriceConfiguration {
|
|
3831
|
+
/**
|
|
3832
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3833
|
+
* group
|
|
3834
|
+
*/
|
|
3835
|
+
dimension_values: Array<string>;
|
|
3836
|
+
|
|
3837
|
+
/**
|
|
3838
|
+
* The id of the dimensional price group to include this price in
|
|
3839
|
+
*/
|
|
3840
|
+
dimensional_price_group_id?: string | null;
|
|
3841
|
+
|
|
3842
|
+
/**
|
|
3843
|
+
* The external id of the dimensional price group to include this price in
|
|
3844
|
+
*/
|
|
3845
|
+
external_dimensional_price_group_id?: string | null;
|
|
3846
|
+
}
|
|
3847
|
+
|
|
3062
3848
|
/**
|
|
3063
3849
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3064
3850
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -3125,6 +3911,11 @@ export namespace PlanCreateParams {
|
|
|
3125
3911
|
*/
|
|
3126
3912
|
currency?: string | null;
|
|
3127
3913
|
|
|
3914
|
+
/**
|
|
3915
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3916
|
+
*/
|
|
3917
|
+
dimensional_price_configuration?: NewPlanMaxGroupTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
3918
|
+
|
|
3128
3919
|
/**
|
|
3129
3920
|
* An alias for the price.
|
|
3130
3921
|
*/
|
|
@@ -3172,6 +3963,27 @@ export namespace PlanCreateParams {
|
|
|
3172
3963
|
duration_unit: 'day' | 'month';
|
|
3173
3964
|
}
|
|
3174
3965
|
|
|
3966
|
+
/**
|
|
3967
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3968
|
+
*/
|
|
3969
|
+
export interface DimensionalPriceConfiguration {
|
|
3970
|
+
/**
|
|
3971
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
3972
|
+
* group
|
|
3973
|
+
*/
|
|
3974
|
+
dimension_values: Array<string>;
|
|
3975
|
+
|
|
3976
|
+
/**
|
|
3977
|
+
* The id of the dimensional price group to include this price in
|
|
3978
|
+
*/
|
|
3979
|
+
dimensional_price_group_id?: string | null;
|
|
3980
|
+
|
|
3981
|
+
/**
|
|
3982
|
+
* The external id of the dimensional price group to include this price in
|
|
3983
|
+
*/
|
|
3984
|
+
external_dimensional_price_group_id?: string | null;
|
|
3985
|
+
}
|
|
3986
|
+
|
|
3175
3987
|
/**
|
|
3176
3988
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3177
3989
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -3238,6 +4050,11 @@ export namespace PlanCreateParams {
|
|
|
3238
4050
|
*/
|
|
3239
4051
|
currency?: string | null;
|
|
3240
4052
|
|
|
4053
|
+
/**
|
|
4054
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4055
|
+
*/
|
|
4056
|
+
dimensional_price_configuration?: NewPlanScalableMatrixWithUnitPricingPrice.DimensionalPriceConfiguration | null;
|
|
4057
|
+
|
|
3241
4058
|
/**
|
|
3242
4059
|
* An alias for the price.
|
|
3243
4060
|
*/
|
|
@@ -3285,6 +4102,27 @@ export namespace PlanCreateParams {
|
|
|
3285
4102
|
duration_unit: 'day' | 'month';
|
|
3286
4103
|
}
|
|
3287
4104
|
|
|
4105
|
+
/**
|
|
4106
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4107
|
+
*/
|
|
4108
|
+
export interface DimensionalPriceConfiguration {
|
|
4109
|
+
/**
|
|
4110
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
4111
|
+
* group
|
|
4112
|
+
*/
|
|
4113
|
+
dimension_values: Array<string>;
|
|
4114
|
+
|
|
4115
|
+
/**
|
|
4116
|
+
* The id of the dimensional price group to include this price in
|
|
4117
|
+
*/
|
|
4118
|
+
dimensional_price_group_id?: string | null;
|
|
4119
|
+
|
|
4120
|
+
/**
|
|
4121
|
+
* The external id of the dimensional price group to include this price in
|
|
4122
|
+
*/
|
|
4123
|
+
external_dimensional_price_group_id?: string | null;
|
|
4124
|
+
}
|
|
4125
|
+
|
|
3288
4126
|
/**
|
|
3289
4127
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3290
4128
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
@@ -3351,6 +4189,11 @@ export namespace PlanCreateParams {
|
|
|
3351
4189
|
*/
|
|
3352
4190
|
currency?: string | null;
|
|
3353
4191
|
|
|
4192
|
+
/**
|
|
4193
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4194
|
+
*/
|
|
4195
|
+
dimensional_price_configuration?: NewPlanScalableMatrixWithTieredPricingPrice.DimensionalPriceConfiguration | null;
|
|
4196
|
+
|
|
3354
4197
|
/**
|
|
3355
4198
|
* An alias for the price.
|
|
3356
4199
|
*/
|
|
@@ -3399,20 +4242,41 @@ export namespace PlanCreateParams {
|
|
|
3399
4242
|
}
|
|
3400
4243
|
|
|
3401
4244
|
/**
|
|
3402
|
-
*
|
|
3403
|
-
* If unspecified, a single invoice is produced per billing cycle.
|
|
4245
|
+
* For dimensional price: specifies a price group and dimension values
|
|
3404
4246
|
*/
|
|
3405
|
-
export interface
|
|
4247
|
+
export interface DimensionalPriceConfiguration {
|
|
3406
4248
|
/**
|
|
3407
|
-
* The
|
|
4249
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
4250
|
+
* group
|
|
3408
4251
|
*/
|
|
3409
|
-
|
|
4252
|
+
dimension_values: Array<string>;
|
|
3410
4253
|
|
|
3411
4254
|
/**
|
|
3412
|
-
* The
|
|
4255
|
+
* The id of the dimensional price group to include this price in
|
|
3413
4256
|
*/
|
|
3414
|
-
|
|
3415
|
-
|
|
4257
|
+
dimensional_price_group_id?: string | null;
|
|
4258
|
+
|
|
4259
|
+
/**
|
|
4260
|
+
* The external id of the dimensional price group to include this price in
|
|
4261
|
+
*/
|
|
4262
|
+
external_dimensional_price_group_id?: string | null;
|
|
4263
|
+
}
|
|
4264
|
+
|
|
4265
|
+
/**
|
|
4266
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4267
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4268
|
+
*/
|
|
4269
|
+
export interface InvoicingCycleConfiguration {
|
|
4270
|
+
/**
|
|
4271
|
+
* The duration of the billing period.
|
|
4272
|
+
*/
|
|
4273
|
+
duration: number;
|
|
4274
|
+
|
|
4275
|
+
/**
|
|
4276
|
+
* The unit of billing period duration.
|
|
4277
|
+
*/
|
|
4278
|
+
duration_unit: 'day' | 'month';
|
|
4279
|
+
}
|
|
3416
4280
|
}
|
|
3417
4281
|
|
|
3418
4282
|
export interface NewPlanCumulativeGroupedBulkPrice {
|
|
@@ -3464,6 +4328,11 @@ export namespace PlanCreateParams {
|
|
|
3464
4328
|
*/
|
|
3465
4329
|
currency?: string | null;
|
|
3466
4330
|
|
|
4331
|
+
/**
|
|
4332
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4333
|
+
*/
|
|
4334
|
+
dimensional_price_configuration?: NewPlanCumulativeGroupedBulkPrice.DimensionalPriceConfiguration | null;
|
|
4335
|
+
|
|
3467
4336
|
/**
|
|
3468
4337
|
* An alias for the price.
|
|
3469
4338
|
*/
|
|
@@ -3511,6 +4380,482 @@ export namespace PlanCreateParams {
|
|
|
3511
4380
|
duration_unit: 'day' | 'month';
|
|
3512
4381
|
}
|
|
3513
4382
|
|
|
4383
|
+
/**
|
|
4384
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4385
|
+
*/
|
|
4386
|
+
export interface DimensionalPriceConfiguration {
|
|
4387
|
+
/**
|
|
4388
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
4389
|
+
* group
|
|
4390
|
+
*/
|
|
4391
|
+
dimension_values: Array<string>;
|
|
4392
|
+
|
|
4393
|
+
/**
|
|
4394
|
+
* The id of the dimensional price group to include this price in
|
|
4395
|
+
*/
|
|
4396
|
+
dimensional_price_group_id?: string | null;
|
|
4397
|
+
|
|
4398
|
+
/**
|
|
4399
|
+
* The external id of the dimensional price group to include this price in
|
|
4400
|
+
*/
|
|
4401
|
+
external_dimensional_price_group_id?: string | null;
|
|
4402
|
+
}
|
|
4403
|
+
|
|
4404
|
+
/**
|
|
4405
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4406
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4407
|
+
*/
|
|
4408
|
+
export interface InvoicingCycleConfiguration {
|
|
4409
|
+
/**
|
|
4410
|
+
* The duration of the billing period.
|
|
4411
|
+
*/
|
|
4412
|
+
duration: number;
|
|
4413
|
+
|
|
4414
|
+
/**
|
|
4415
|
+
* The unit of billing period duration.
|
|
4416
|
+
*/
|
|
4417
|
+
duration_unit: 'day' | 'month';
|
|
4418
|
+
}
|
|
4419
|
+
}
|
|
4420
|
+
|
|
4421
|
+
export interface NewPlanTieredPackageWithMinimumPrice {
|
|
4422
|
+
/**
|
|
4423
|
+
* The cadence to bill for this price on.
|
|
4424
|
+
*/
|
|
4425
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4426
|
+
|
|
4427
|
+
/**
|
|
4428
|
+
* The id of the item the price will be associated with.
|
|
4429
|
+
*/
|
|
4430
|
+
item_id: string;
|
|
4431
|
+
|
|
4432
|
+
model_type: 'tiered_package_with_minimum';
|
|
4433
|
+
|
|
4434
|
+
/**
|
|
4435
|
+
* The name of the price.
|
|
4436
|
+
*/
|
|
4437
|
+
name: string;
|
|
4438
|
+
|
|
4439
|
+
tiered_package_with_minimum_config: Record<string, unknown>;
|
|
4440
|
+
|
|
4441
|
+
/**
|
|
4442
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4443
|
+
* usage-based.
|
|
4444
|
+
*/
|
|
4445
|
+
billable_metric_id?: string | null;
|
|
4446
|
+
|
|
4447
|
+
/**
|
|
4448
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4449
|
+
* this is true, and in-arrears if this is false.
|
|
4450
|
+
*/
|
|
4451
|
+
billed_in_advance?: boolean | null;
|
|
4452
|
+
|
|
4453
|
+
/**
|
|
4454
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4455
|
+
* months.
|
|
4456
|
+
*/
|
|
4457
|
+
billing_cycle_configuration?: NewPlanTieredPackageWithMinimumPrice.BillingCycleConfiguration | null;
|
|
4458
|
+
|
|
4459
|
+
/**
|
|
4460
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4461
|
+
*/
|
|
4462
|
+
conversion_rate?: number | null;
|
|
4463
|
+
|
|
4464
|
+
/**
|
|
4465
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4466
|
+
* price is billed.
|
|
4467
|
+
*/
|
|
4468
|
+
currency?: string | null;
|
|
4469
|
+
|
|
4470
|
+
/**
|
|
4471
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4472
|
+
*/
|
|
4473
|
+
dimensional_price_configuration?: NewPlanTieredPackageWithMinimumPrice.DimensionalPriceConfiguration | null;
|
|
4474
|
+
|
|
4475
|
+
/**
|
|
4476
|
+
* An alias for the price.
|
|
4477
|
+
*/
|
|
4478
|
+
external_price_id?: string | null;
|
|
4479
|
+
|
|
4480
|
+
/**
|
|
4481
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4482
|
+
* applied.
|
|
4483
|
+
*/
|
|
4484
|
+
fixed_price_quantity?: number | null;
|
|
4485
|
+
|
|
4486
|
+
/**
|
|
4487
|
+
* The property used to group this price on an invoice
|
|
4488
|
+
*/
|
|
4489
|
+
invoice_grouping_key?: string | null;
|
|
4490
|
+
|
|
4491
|
+
/**
|
|
4492
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4493
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4494
|
+
*/
|
|
4495
|
+
invoicing_cycle_configuration?: NewPlanTieredPackageWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
4496
|
+
|
|
4497
|
+
/**
|
|
4498
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4499
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4500
|
+
* by setting `metadata` to `null`.
|
|
4501
|
+
*/
|
|
4502
|
+
metadata?: Record<string, string | null> | null;
|
|
4503
|
+
}
|
|
4504
|
+
|
|
4505
|
+
export namespace NewPlanTieredPackageWithMinimumPrice {
|
|
4506
|
+
/**
|
|
4507
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4508
|
+
* months.
|
|
4509
|
+
*/
|
|
4510
|
+
export interface BillingCycleConfiguration {
|
|
4511
|
+
/**
|
|
4512
|
+
* The duration of the billing period.
|
|
4513
|
+
*/
|
|
4514
|
+
duration: number;
|
|
4515
|
+
|
|
4516
|
+
/**
|
|
4517
|
+
* The unit of billing period duration.
|
|
4518
|
+
*/
|
|
4519
|
+
duration_unit: 'day' | 'month';
|
|
4520
|
+
}
|
|
4521
|
+
|
|
4522
|
+
/**
|
|
4523
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4524
|
+
*/
|
|
4525
|
+
export interface DimensionalPriceConfiguration {
|
|
4526
|
+
/**
|
|
4527
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
4528
|
+
* group
|
|
4529
|
+
*/
|
|
4530
|
+
dimension_values: Array<string>;
|
|
4531
|
+
|
|
4532
|
+
/**
|
|
4533
|
+
* The id of the dimensional price group to include this price in
|
|
4534
|
+
*/
|
|
4535
|
+
dimensional_price_group_id?: string | null;
|
|
4536
|
+
|
|
4537
|
+
/**
|
|
4538
|
+
* The external id of the dimensional price group to include this price in
|
|
4539
|
+
*/
|
|
4540
|
+
external_dimensional_price_group_id?: string | null;
|
|
4541
|
+
}
|
|
4542
|
+
|
|
4543
|
+
/**
|
|
4544
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4545
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4546
|
+
*/
|
|
4547
|
+
export interface InvoicingCycleConfiguration {
|
|
4548
|
+
/**
|
|
4549
|
+
* The duration of the billing period.
|
|
4550
|
+
*/
|
|
4551
|
+
duration: number;
|
|
4552
|
+
|
|
4553
|
+
/**
|
|
4554
|
+
* The unit of billing period duration.
|
|
4555
|
+
*/
|
|
4556
|
+
duration_unit: 'day' | 'month';
|
|
4557
|
+
}
|
|
4558
|
+
}
|
|
4559
|
+
|
|
4560
|
+
export interface NewPlanMatrixWithAllocationPrice {
|
|
4561
|
+
/**
|
|
4562
|
+
* The cadence to bill for this price on.
|
|
4563
|
+
*/
|
|
4564
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4565
|
+
|
|
4566
|
+
/**
|
|
4567
|
+
* The id of the item the price will be associated with.
|
|
4568
|
+
*/
|
|
4569
|
+
item_id: string;
|
|
4570
|
+
|
|
4571
|
+
matrix_with_allocation_config: NewPlanMatrixWithAllocationPrice.MatrixWithAllocationConfig;
|
|
4572
|
+
|
|
4573
|
+
model_type: 'matrix_with_allocation';
|
|
4574
|
+
|
|
4575
|
+
/**
|
|
4576
|
+
* The name of the price.
|
|
4577
|
+
*/
|
|
4578
|
+
name: string;
|
|
4579
|
+
|
|
4580
|
+
/**
|
|
4581
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4582
|
+
* usage-based.
|
|
4583
|
+
*/
|
|
4584
|
+
billable_metric_id?: string | null;
|
|
4585
|
+
|
|
4586
|
+
/**
|
|
4587
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4588
|
+
* this is true, and in-arrears if this is false.
|
|
4589
|
+
*/
|
|
4590
|
+
billed_in_advance?: boolean | null;
|
|
4591
|
+
|
|
4592
|
+
/**
|
|
4593
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4594
|
+
* months.
|
|
4595
|
+
*/
|
|
4596
|
+
billing_cycle_configuration?: NewPlanMatrixWithAllocationPrice.BillingCycleConfiguration | null;
|
|
4597
|
+
|
|
4598
|
+
/**
|
|
4599
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4600
|
+
*/
|
|
4601
|
+
conversion_rate?: number | null;
|
|
4602
|
+
|
|
4603
|
+
/**
|
|
4604
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4605
|
+
* price is billed.
|
|
4606
|
+
*/
|
|
4607
|
+
currency?: string | null;
|
|
4608
|
+
|
|
4609
|
+
/**
|
|
4610
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4611
|
+
*/
|
|
4612
|
+
dimensional_price_configuration?: NewPlanMatrixWithAllocationPrice.DimensionalPriceConfiguration | null;
|
|
4613
|
+
|
|
4614
|
+
/**
|
|
4615
|
+
* An alias for the price.
|
|
4616
|
+
*/
|
|
4617
|
+
external_price_id?: string | null;
|
|
4618
|
+
|
|
4619
|
+
/**
|
|
4620
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4621
|
+
* applied.
|
|
4622
|
+
*/
|
|
4623
|
+
fixed_price_quantity?: number | null;
|
|
4624
|
+
|
|
4625
|
+
/**
|
|
4626
|
+
* The property used to group this price on an invoice
|
|
4627
|
+
*/
|
|
4628
|
+
invoice_grouping_key?: string | null;
|
|
4629
|
+
|
|
4630
|
+
/**
|
|
4631
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4632
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4633
|
+
*/
|
|
4634
|
+
invoicing_cycle_configuration?: NewPlanMatrixWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
4635
|
+
|
|
4636
|
+
/**
|
|
4637
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4638
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4639
|
+
* by setting `metadata` to `null`.
|
|
4640
|
+
*/
|
|
4641
|
+
metadata?: Record<string, string | null> | null;
|
|
4642
|
+
}
|
|
4643
|
+
|
|
4644
|
+
export namespace NewPlanMatrixWithAllocationPrice {
|
|
4645
|
+
export interface MatrixWithAllocationConfig {
|
|
4646
|
+
/**
|
|
4647
|
+
* Allocation to be used to calculate the price
|
|
4648
|
+
*/
|
|
4649
|
+
allocation: number;
|
|
4650
|
+
|
|
4651
|
+
/**
|
|
4652
|
+
* Default per unit rate for any usage not bucketed into a specified matrix_value
|
|
4653
|
+
*/
|
|
4654
|
+
default_unit_amount: string;
|
|
4655
|
+
|
|
4656
|
+
/**
|
|
4657
|
+
* One or two event property values to evaluate matrix groups by
|
|
4658
|
+
*/
|
|
4659
|
+
dimensions: Array<string | null>;
|
|
4660
|
+
|
|
4661
|
+
/**
|
|
4662
|
+
* Matrix values for specified matrix grouping keys
|
|
4663
|
+
*/
|
|
4664
|
+
matrix_values: Array<MatrixWithAllocationConfig.MatrixValue>;
|
|
4665
|
+
}
|
|
4666
|
+
|
|
4667
|
+
export namespace MatrixWithAllocationConfig {
|
|
4668
|
+
export interface MatrixValue {
|
|
4669
|
+
/**
|
|
4670
|
+
* One or two matrix keys to filter usage to this Matrix value by. For example,
|
|
4671
|
+
* ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
|
4672
|
+
* instance tier.
|
|
4673
|
+
*/
|
|
4674
|
+
dimension_values: Array<string | null>;
|
|
4675
|
+
|
|
4676
|
+
/**
|
|
4677
|
+
* Unit price for the specified dimension_values
|
|
4678
|
+
*/
|
|
4679
|
+
unit_amount: string;
|
|
4680
|
+
}
|
|
4681
|
+
}
|
|
4682
|
+
|
|
4683
|
+
/**
|
|
4684
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4685
|
+
* months.
|
|
4686
|
+
*/
|
|
4687
|
+
export interface BillingCycleConfiguration {
|
|
4688
|
+
/**
|
|
4689
|
+
* The duration of the billing period.
|
|
4690
|
+
*/
|
|
4691
|
+
duration: number;
|
|
4692
|
+
|
|
4693
|
+
/**
|
|
4694
|
+
* The unit of billing period duration.
|
|
4695
|
+
*/
|
|
4696
|
+
duration_unit: 'day' | 'month';
|
|
4697
|
+
}
|
|
4698
|
+
|
|
4699
|
+
/**
|
|
4700
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4701
|
+
*/
|
|
4702
|
+
export interface DimensionalPriceConfiguration {
|
|
4703
|
+
/**
|
|
4704
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
4705
|
+
* group
|
|
4706
|
+
*/
|
|
4707
|
+
dimension_values: Array<string>;
|
|
4708
|
+
|
|
4709
|
+
/**
|
|
4710
|
+
* The id of the dimensional price group to include this price in
|
|
4711
|
+
*/
|
|
4712
|
+
dimensional_price_group_id?: string | null;
|
|
4713
|
+
|
|
4714
|
+
/**
|
|
4715
|
+
* The external id of the dimensional price group to include this price in
|
|
4716
|
+
*/
|
|
4717
|
+
external_dimensional_price_group_id?: string | null;
|
|
4718
|
+
}
|
|
4719
|
+
|
|
4720
|
+
/**
|
|
4721
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4722
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4723
|
+
*/
|
|
4724
|
+
export interface InvoicingCycleConfiguration {
|
|
4725
|
+
/**
|
|
4726
|
+
* The duration of the billing period.
|
|
4727
|
+
*/
|
|
4728
|
+
duration: number;
|
|
4729
|
+
|
|
4730
|
+
/**
|
|
4731
|
+
* The unit of billing period duration.
|
|
4732
|
+
*/
|
|
4733
|
+
duration_unit: 'day' | 'month';
|
|
4734
|
+
}
|
|
4735
|
+
}
|
|
4736
|
+
|
|
4737
|
+
export interface NewPlanGroupedTieredPrice {
|
|
4738
|
+
/**
|
|
4739
|
+
* The cadence to bill for this price on.
|
|
4740
|
+
*/
|
|
4741
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4742
|
+
|
|
4743
|
+
grouped_tiered_config: Record<string, unknown>;
|
|
4744
|
+
|
|
4745
|
+
/**
|
|
4746
|
+
* The id of the item the price will be associated with.
|
|
4747
|
+
*/
|
|
4748
|
+
item_id: string;
|
|
4749
|
+
|
|
4750
|
+
model_type: 'grouped_tiered';
|
|
4751
|
+
|
|
4752
|
+
/**
|
|
4753
|
+
* The name of the price.
|
|
4754
|
+
*/
|
|
4755
|
+
name: string;
|
|
4756
|
+
|
|
4757
|
+
/**
|
|
4758
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4759
|
+
* usage-based.
|
|
4760
|
+
*/
|
|
4761
|
+
billable_metric_id?: string | null;
|
|
4762
|
+
|
|
4763
|
+
/**
|
|
4764
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4765
|
+
* this is true, and in-arrears if this is false.
|
|
4766
|
+
*/
|
|
4767
|
+
billed_in_advance?: boolean | null;
|
|
4768
|
+
|
|
4769
|
+
/**
|
|
4770
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4771
|
+
* months.
|
|
4772
|
+
*/
|
|
4773
|
+
billing_cycle_configuration?: NewPlanGroupedTieredPrice.BillingCycleConfiguration | null;
|
|
4774
|
+
|
|
4775
|
+
/**
|
|
4776
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4777
|
+
*/
|
|
4778
|
+
conversion_rate?: number | null;
|
|
4779
|
+
|
|
4780
|
+
/**
|
|
4781
|
+
* An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
4782
|
+
* price is billed.
|
|
4783
|
+
*/
|
|
4784
|
+
currency?: string | null;
|
|
4785
|
+
|
|
4786
|
+
/**
|
|
4787
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4788
|
+
*/
|
|
4789
|
+
dimensional_price_configuration?: NewPlanGroupedTieredPrice.DimensionalPriceConfiguration | null;
|
|
4790
|
+
|
|
4791
|
+
/**
|
|
4792
|
+
* An alias for the price.
|
|
4793
|
+
*/
|
|
4794
|
+
external_price_id?: string | null;
|
|
4795
|
+
|
|
4796
|
+
/**
|
|
4797
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4798
|
+
* applied.
|
|
4799
|
+
*/
|
|
4800
|
+
fixed_price_quantity?: number | null;
|
|
4801
|
+
|
|
4802
|
+
/**
|
|
4803
|
+
* The property used to group this price on an invoice
|
|
4804
|
+
*/
|
|
4805
|
+
invoice_grouping_key?: string | null;
|
|
4806
|
+
|
|
4807
|
+
/**
|
|
4808
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4809
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4810
|
+
*/
|
|
4811
|
+
invoicing_cycle_configuration?: NewPlanGroupedTieredPrice.InvoicingCycleConfiguration | null;
|
|
4812
|
+
|
|
4813
|
+
/**
|
|
4814
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4815
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4816
|
+
* by setting `metadata` to `null`.
|
|
4817
|
+
*/
|
|
4818
|
+
metadata?: Record<string, string | null> | null;
|
|
4819
|
+
}
|
|
4820
|
+
|
|
4821
|
+
export namespace NewPlanGroupedTieredPrice {
|
|
4822
|
+
/**
|
|
4823
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4824
|
+
* months.
|
|
4825
|
+
*/
|
|
4826
|
+
export interface BillingCycleConfiguration {
|
|
4827
|
+
/**
|
|
4828
|
+
* The duration of the billing period.
|
|
4829
|
+
*/
|
|
4830
|
+
duration: number;
|
|
4831
|
+
|
|
4832
|
+
/**
|
|
4833
|
+
* The unit of billing period duration.
|
|
4834
|
+
*/
|
|
4835
|
+
duration_unit: 'day' | 'month';
|
|
4836
|
+
}
|
|
4837
|
+
|
|
4838
|
+
/**
|
|
4839
|
+
* For dimensional price: specifies a price group and dimension values
|
|
4840
|
+
*/
|
|
4841
|
+
export interface DimensionalPriceConfiguration {
|
|
4842
|
+
/**
|
|
4843
|
+
* The list of dimension values matching (in order) the dimensions of the price
|
|
4844
|
+
* group
|
|
4845
|
+
*/
|
|
4846
|
+
dimension_values: Array<string>;
|
|
4847
|
+
|
|
4848
|
+
/**
|
|
4849
|
+
* The id of the dimensional price group to include this price in
|
|
4850
|
+
*/
|
|
4851
|
+
dimensional_price_group_id?: string | null;
|
|
4852
|
+
|
|
4853
|
+
/**
|
|
4854
|
+
* The external id of the dimensional price group to include this price in
|
|
4855
|
+
*/
|
|
4856
|
+
external_dimensional_price_group_id?: string | null;
|
|
4857
|
+
}
|
|
4858
|
+
|
|
3514
4859
|
/**
|
|
3515
4860
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3516
4861
|
* If unspecified, a single invoice is produced per billing cycle.
|