orb-billing 4.10.0 → 4.11.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 +13 -0
- package/package.json +1 -1
- package/resources/plans/plans.d.ts +664 -0
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/prices.d.ts +910 -28
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/subscriptions.d.ts +824 -0
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/resources/plans/plans.ts +766 -0
- package/src/resources/prices/prices.ts +1087 -25
- package/src/resources/subscriptions.ts +959 -7
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -268,6 +268,11 @@ export declare namespace PlanCreateParams {
|
|
|
268
268
|
* this is true, and in-arrears if this is false.
|
|
269
269
|
*/
|
|
270
270
|
billed_in_advance?: boolean | null;
|
|
271
|
+
/**
|
|
272
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
273
|
+
* months.
|
|
274
|
+
*/
|
|
275
|
+
billing_cycle_configuration?: NewPlanUnitPrice.BillingCycleConfiguration | null;
|
|
271
276
|
/**
|
|
272
277
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
273
278
|
*/
|
|
@@ -290,6 +295,11 @@ export declare namespace PlanCreateParams {
|
|
|
290
295
|
* The property used to group this price on an invoice
|
|
291
296
|
*/
|
|
292
297
|
invoice_grouping_key?: string | null;
|
|
298
|
+
/**
|
|
299
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
300
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
301
|
+
*/
|
|
302
|
+
invoicing_cycle_configuration?: NewPlanUnitPrice.InvoicingCycleConfiguration | null;
|
|
293
303
|
/**
|
|
294
304
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
295
305
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -304,6 +314,34 @@ export declare namespace PlanCreateParams {
|
|
|
304
314
|
*/
|
|
305
315
|
unit_amount: string;
|
|
306
316
|
}
|
|
317
|
+
/**
|
|
318
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
319
|
+
* months.
|
|
320
|
+
*/
|
|
321
|
+
interface BillingCycleConfiguration {
|
|
322
|
+
/**
|
|
323
|
+
* The duration of the billing period.
|
|
324
|
+
*/
|
|
325
|
+
duration: number;
|
|
326
|
+
/**
|
|
327
|
+
* The unit of billing period duration.
|
|
328
|
+
*/
|
|
329
|
+
duration_unit: 'day' | 'month';
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
333
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
334
|
+
*/
|
|
335
|
+
interface InvoicingCycleConfiguration {
|
|
336
|
+
/**
|
|
337
|
+
* The duration of the billing period.
|
|
338
|
+
*/
|
|
339
|
+
duration: number;
|
|
340
|
+
/**
|
|
341
|
+
* The unit of billing period duration.
|
|
342
|
+
*/
|
|
343
|
+
duration_unit: 'day' | 'month';
|
|
344
|
+
}
|
|
307
345
|
}
|
|
308
346
|
interface NewPlanPackagePrice {
|
|
309
347
|
/**
|
|
@@ -330,6 +368,11 @@ export declare namespace PlanCreateParams {
|
|
|
330
368
|
* this is true, and in-arrears if this is false.
|
|
331
369
|
*/
|
|
332
370
|
billed_in_advance?: boolean | null;
|
|
371
|
+
/**
|
|
372
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
373
|
+
* months.
|
|
374
|
+
*/
|
|
375
|
+
billing_cycle_configuration?: NewPlanPackagePrice.BillingCycleConfiguration | null;
|
|
333
376
|
/**
|
|
334
377
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
335
378
|
*/
|
|
@@ -352,6 +395,11 @@ export declare namespace PlanCreateParams {
|
|
|
352
395
|
* The property used to group this price on an invoice
|
|
353
396
|
*/
|
|
354
397
|
invoice_grouping_key?: string | null;
|
|
398
|
+
/**
|
|
399
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
400
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
401
|
+
*/
|
|
402
|
+
invoicing_cycle_configuration?: NewPlanPackagePrice.InvoicingCycleConfiguration | null;
|
|
355
403
|
/**
|
|
356
404
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
357
405
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -371,6 +419,34 @@ export declare namespace PlanCreateParams {
|
|
|
371
419
|
*/
|
|
372
420
|
package_size: number;
|
|
373
421
|
}
|
|
422
|
+
/**
|
|
423
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
424
|
+
* months.
|
|
425
|
+
*/
|
|
426
|
+
interface BillingCycleConfiguration {
|
|
427
|
+
/**
|
|
428
|
+
* The duration of the billing period.
|
|
429
|
+
*/
|
|
430
|
+
duration: number;
|
|
431
|
+
/**
|
|
432
|
+
* The unit of billing period duration.
|
|
433
|
+
*/
|
|
434
|
+
duration_unit: 'day' | 'month';
|
|
435
|
+
}
|
|
436
|
+
/**
|
|
437
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
438
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
439
|
+
*/
|
|
440
|
+
interface InvoicingCycleConfiguration {
|
|
441
|
+
/**
|
|
442
|
+
* The duration of the billing period.
|
|
443
|
+
*/
|
|
444
|
+
duration: number;
|
|
445
|
+
/**
|
|
446
|
+
* The unit of billing period duration.
|
|
447
|
+
*/
|
|
448
|
+
duration_unit: 'day' | 'month';
|
|
449
|
+
}
|
|
374
450
|
}
|
|
375
451
|
interface NewPlanMatrixPrice {
|
|
376
452
|
/**
|
|
@@ -397,6 +473,11 @@ export declare namespace PlanCreateParams {
|
|
|
397
473
|
* this is true, and in-arrears if this is false.
|
|
398
474
|
*/
|
|
399
475
|
billed_in_advance?: boolean | null;
|
|
476
|
+
/**
|
|
477
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
478
|
+
* months.
|
|
479
|
+
*/
|
|
480
|
+
billing_cycle_configuration?: NewPlanMatrixPrice.BillingCycleConfiguration | null;
|
|
400
481
|
/**
|
|
401
482
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
402
483
|
*/
|
|
@@ -419,6 +500,11 @@ export declare namespace PlanCreateParams {
|
|
|
419
500
|
* The property used to group this price on an invoice
|
|
420
501
|
*/
|
|
421
502
|
invoice_grouping_key?: string | null;
|
|
503
|
+
/**
|
|
504
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
505
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
506
|
+
*/
|
|
507
|
+
invoicing_cycle_configuration?: NewPlanMatrixPrice.InvoicingCycleConfiguration | null;
|
|
422
508
|
/**
|
|
423
509
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
424
510
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -455,6 +541,34 @@ export declare namespace PlanCreateParams {
|
|
|
455
541
|
unit_amount: string;
|
|
456
542
|
}
|
|
457
543
|
}
|
|
544
|
+
/**
|
|
545
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
546
|
+
* months.
|
|
547
|
+
*/
|
|
548
|
+
interface BillingCycleConfiguration {
|
|
549
|
+
/**
|
|
550
|
+
* The duration of the billing period.
|
|
551
|
+
*/
|
|
552
|
+
duration: number;
|
|
553
|
+
/**
|
|
554
|
+
* The unit of billing period duration.
|
|
555
|
+
*/
|
|
556
|
+
duration_unit: 'day' | 'month';
|
|
557
|
+
}
|
|
558
|
+
/**
|
|
559
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
560
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
561
|
+
*/
|
|
562
|
+
interface InvoicingCycleConfiguration {
|
|
563
|
+
/**
|
|
564
|
+
* The duration of the billing period.
|
|
565
|
+
*/
|
|
566
|
+
duration: number;
|
|
567
|
+
/**
|
|
568
|
+
* The unit of billing period duration.
|
|
569
|
+
*/
|
|
570
|
+
duration_unit: 'day' | 'month';
|
|
571
|
+
}
|
|
458
572
|
}
|
|
459
573
|
interface NewPlanTieredPrice {
|
|
460
574
|
/**
|
|
@@ -481,6 +595,11 @@ export declare namespace PlanCreateParams {
|
|
|
481
595
|
* this is true, and in-arrears if this is false.
|
|
482
596
|
*/
|
|
483
597
|
billed_in_advance?: boolean | null;
|
|
598
|
+
/**
|
|
599
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
600
|
+
* months.
|
|
601
|
+
*/
|
|
602
|
+
billing_cycle_configuration?: NewPlanTieredPrice.BillingCycleConfiguration | null;
|
|
484
603
|
/**
|
|
485
604
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
486
605
|
*/
|
|
@@ -503,6 +622,11 @@ export declare namespace PlanCreateParams {
|
|
|
503
622
|
* The property used to group this price on an invoice
|
|
504
623
|
*/
|
|
505
624
|
invoice_grouping_key?: string | null;
|
|
625
|
+
/**
|
|
626
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
627
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
628
|
+
*/
|
|
629
|
+
invoicing_cycle_configuration?: NewPlanTieredPrice.InvoicingCycleConfiguration | null;
|
|
506
630
|
/**
|
|
507
631
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
508
632
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -533,6 +657,34 @@ export declare namespace PlanCreateParams {
|
|
|
533
657
|
last_unit?: number | null;
|
|
534
658
|
}
|
|
535
659
|
}
|
|
660
|
+
/**
|
|
661
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
662
|
+
* months.
|
|
663
|
+
*/
|
|
664
|
+
interface BillingCycleConfiguration {
|
|
665
|
+
/**
|
|
666
|
+
* The duration of the billing period.
|
|
667
|
+
*/
|
|
668
|
+
duration: number;
|
|
669
|
+
/**
|
|
670
|
+
* The unit of billing period duration.
|
|
671
|
+
*/
|
|
672
|
+
duration_unit: 'day' | 'month';
|
|
673
|
+
}
|
|
674
|
+
/**
|
|
675
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
676
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
677
|
+
*/
|
|
678
|
+
interface InvoicingCycleConfiguration {
|
|
679
|
+
/**
|
|
680
|
+
* The duration of the billing period.
|
|
681
|
+
*/
|
|
682
|
+
duration: number;
|
|
683
|
+
/**
|
|
684
|
+
* The unit of billing period duration.
|
|
685
|
+
*/
|
|
686
|
+
duration_unit: 'day' | 'month';
|
|
687
|
+
}
|
|
536
688
|
}
|
|
537
689
|
interface NewPlanTieredBpsPrice {
|
|
538
690
|
/**
|
|
@@ -559,6 +711,11 @@ export declare namespace PlanCreateParams {
|
|
|
559
711
|
* this is true, and in-arrears if this is false.
|
|
560
712
|
*/
|
|
561
713
|
billed_in_advance?: boolean | null;
|
|
714
|
+
/**
|
|
715
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
716
|
+
* months.
|
|
717
|
+
*/
|
|
718
|
+
billing_cycle_configuration?: NewPlanTieredBpsPrice.BillingCycleConfiguration | null;
|
|
562
719
|
/**
|
|
563
720
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
564
721
|
*/
|
|
@@ -581,6 +738,11 @@ export declare namespace PlanCreateParams {
|
|
|
581
738
|
* The property used to group this price on an invoice
|
|
582
739
|
*/
|
|
583
740
|
invoice_grouping_key?: string | null;
|
|
741
|
+
/**
|
|
742
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
743
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
744
|
+
*/
|
|
745
|
+
invoicing_cycle_configuration?: NewPlanTieredBpsPrice.InvoicingCycleConfiguration | null;
|
|
584
746
|
/**
|
|
585
747
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
586
748
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -616,6 +778,34 @@ export declare namespace PlanCreateParams {
|
|
|
616
778
|
per_unit_maximum?: string | null;
|
|
617
779
|
}
|
|
618
780
|
}
|
|
781
|
+
/**
|
|
782
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
783
|
+
* months.
|
|
784
|
+
*/
|
|
785
|
+
interface BillingCycleConfiguration {
|
|
786
|
+
/**
|
|
787
|
+
* The duration of the billing period.
|
|
788
|
+
*/
|
|
789
|
+
duration: number;
|
|
790
|
+
/**
|
|
791
|
+
* The unit of billing period duration.
|
|
792
|
+
*/
|
|
793
|
+
duration_unit: 'day' | 'month';
|
|
794
|
+
}
|
|
795
|
+
/**
|
|
796
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
797
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
798
|
+
*/
|
|
799
|
+
interface InvoicingCycleConfiguration {
|
|
800
|
+
/**
|
|
801
|
+
* The duration of the billing period.
|
|
802
|
+
*/
|
|
803
|
+
duration: number;
|
|
804
|
+
/**
|
|
805
|
+
* The unit of billing period duration.
|
|
806
|
+
*/
|
|
807
|
+
duration_unit: 'day' | 'month';
|
|
808
|
+
}
|
|
619
809
|
}
|
|
620
810
|
interface NewPlanBpsPrice {
|
|
621
811
|
bps_config: NewPlanBpsPrice.BpsConfig;
|
|
@@ -642,6 +832,11 @@ export declare namespace PlanCreateParams {
|
|
|
642
832
|
* this is true, and in-arrears if this is false.
|
|
643
833
|
*/
|
|
644
834
|
billed_in_advance?: boolean | null;
|
|
835
|
+
/**
|
|
836
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
837
|
+
* months.
|
|
838
|
+
*/
|
|
839
|
+
billing_cycle_configuration?: NewPlanBpsPrice.BillingCycleConfiguration | null;
|
|
645
840
|
/**
|
|
646
841
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
647
842
|
*/
|
|
@@ -664,6 +859,11 @@ export declare namespace PlanCreateParams {
|
|
|
664
859
|
* The property used to group this price on an invoice
|
|
665
860
|
*/
|
|
666
861
|
invoice_grouping_key?: string | null;
|
|
862
|
+
/**
|
|
863
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
864
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
865
|
+
*/
|
|
866
|
+
invoicing_cycle_configuration?: NewPlanBpsPrice.InvoicingCycleConfiguration | null;
|
|
667
867
|
/**
|
|
668
868
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
669
869
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -682,6 +882,34 @@ export declare namespace PlanCreateParams {
|
|
|
682
882
|
*/
|
|
683
883
|
per_unit_maximum?: string | null;
|
|
684
884
|
}
|
|
885
|
+
/**
|
|
886
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
887
|
+
* months.
|
|
888
|
+
*/
|
|
889
|
+
interface BillingCycleConfiguration {
|
|
890
|
+
/**
|
|
891
|
+
* The duration of the billing period.
|
|
892
|
+
*/
|
|
893
|
+
duration: number;
|
|
894
|
+
/**
|
|
895
|
+
* The unit of billing period duration.
|
|
896
|
+
*/
|
|
897
|
+
duration_unit: 'day' | 'month';
|
|
898
|
+
}
|
|
899
|
+
/**
|
|
900
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
901
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
902
|
+
*/
|
|
903
|
+
interface InvoicingCycleConfiguration {
|
|
904
|
+
/**
|
|
905
|
+
* The duration of the billing period.
|
|
906
|
+
*/
|
|
907
|
+
duration: number;
|
|
908
|
+
/**
|
|
909
|
+
* The unit of billing period duration.
|
|
910
|
+
*/
|
|
911
|
+
duration_unit: 'day' | 'month';
|
|
912
|
+
}
|
|
685
913
|
}
|
|
686
914
|
interface NewPlanBulkBpsPrice {
|
|
687
915
|
bulk_bps_config: NewPlanBulkBpsPrice.BulkBpsConfig;
|
|
@@ -708,6 +936,11 @@ export declare namespace PlanCreateParams {
|
|
|
708
936
|
* this is true, and in-arrears if this is false.
|
|
709
937
|
*/
|
|
710
938
|
billed_in_advance?: boolean | null;
|
|
939
|
+
/**
|
|
940
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
941
|
+
* months.
|
|
942
|
+
*/
|
|
943
|
+
billing_cycle_configuration?: NewPlanBulkBpsPrice.BillingCycleConfiguration | null;
|
|
711
944
|
/**
|
|
712
945
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
713
946
|
*/
|
|
@@ -730,6 +963,11 @@ export declare namespace PlanCreateParams {
|
|
|
730
963
|
* The property used to group this price on an invoice
|
|
731
964
|
*/
|
|
732
965
|
invoice_grouping_key?: string | null;
|
|
966
|
+
/**
|
|
967
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
968
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
969
|
+
*/
|
|
970
|
+
invoicing_cycle_configuration?: NewPlanBulkBpsPrice.InvoicingCycleConfiguration | null;
|
|
733
971
|
/**
|
|
734
972
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
735
973
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -761,6 +999,34 @@ export declare namespace PlanCreateParams {
|
|
|
761
999
|
per_unit_maximum?: string | null;
|
|
762
1000
|
}
|
|
763
1001
|
}
|
|
1002
|
+
/**
|
|
1003
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1004
|
+
* months.
|
|
1005
|
+
*/
|
|
1006
|
+
interface BillingCycleConfiguration {
|
|
1007
|
+
/**
|
|
1008
|
+
* The duration of the billing period.
|
|
1009
|
+
*/
|
|
1010
|
+
duration: number;
|
|
1011
|
+
/**
|
|
1012
|
+
* The unit of billing period duration.
|
|
1013
|
+
*/
|
|
1014
|
+
duration_unit: 'day' | 'month';
|
|
1015
|
+
}
|
|
1016
|
+
/**
|
|
1017
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1018
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1019
|
+
*/
|
|
1020
|
+
interface InvoicingCycleConfiguration {
|
|
1021
|
+
/**
|
|
1022
|
+
* The duration of the billing period.
|
|
1023
|
+
*/
|
|
1024
|
+
duration: number;
|
|
1025
|
+
/**
|
|
1026
|
+
* The unit of billing period duration.
|
|
1027
|
+
*/
|
|
1028
|
+
duration_unit: 'day' | 'month';
|
|
1029
|
+
}
|
|
764
1030
|
}
|
|
765
1031
|
interface NewPlanBulkPrice {
|
|
766
1032
|
bulk_config: NewPlanBulkPrice.BulkConfig;
|
|
@@ -787,6 +1053,11 @@ export declare namespace PlanCreateParams {
|
|
|
787
1053
|
* this is true, and in-arrears if this is false.
|
|
788
1054
|
*/
|
|
789
1055
|
billed_in_advance?: boolean | null;
|
|
1056
|
+
/**
|
|
1057
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1058
|
+
* months.
|
|
1059
|
+
*/
|
|
1060
|
+
billing_cycle_configuration?: NewPlanBulkPrice.BillingCycleConfiguration | null;
|
|
790
1061
|
/**
|
|
791
1062
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
792
1063
|
*/
|
|
@@ -809,6 +1080,11 @@ export declare namespace PlanCreateParams {
|
|
|
809
1080
|
* The property used to group this price on an invoice
|
|
810
1081
|
*/
|
|
811
1082
|
invoice_grouping_key?: string | null;
|
|
1083
|
+
/**
|
|
1084
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1085
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1086
|
+
*/
|
|
1087
|
+
invoicing_cycle_configuration?: NewPlanBulkPrice.InvoicingCycleConfiguration | null;
|
|
812
1088
|
/**
|
|
813
1089
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
814
1090
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -835,6 +1111,34 @@ export declare namespace PlanCreateParams {
|
|
|
835
1111
|
maximum_units?: number | null;
|
|
836
1112
|
}
|
|
837
1113
|
}
|
|
1114
|
+
/**
|
|
1115
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1116
|
+
* months.
|
|
1117
|
+
*/
|
|
1118
|
+
interface BillingCycleConfiguration {
|
|
1119
|
+
/**
|
|
1120
|
+
* The duration of the billing period.
|
|
1121
|
+
*/
|
|
1122
|
+
duration: number;
|
|
1123
|
+
/**
|
|
1124
|
+
* The unit of billing period duration.
|
|
1125
|
+
*/
|
|
1126
|
+
duration_unit: 'day' | 'month';
|
|
1127
|
+
}
|
|
1128
|
+
/**
|
|
1129
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1130
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1131
|
+
*/
|
|
1132
|
+
interface InvoicingCycleConfiguration {
|
|
1133
|
+
/**
|
|
1134
|
+
* The duration of the billing period.
|
|
1135
|
+
*/
|
|
1136
|
+
duration: number;
|
|
1137
|
+
/**
|
|
1138
|
+
* The unit of billing period duration.
|
|
1139
|
+
*/
|
|
1140
|
+
duration_unit: 'day' | 'month';
|
|
1141
|
+
}
|
|
838
1142
|
}
|
|
839
1143
|
interface NewPlanThresholdTotalAmountPrice {
|
|
840
1144
|
/**
|
|
@@ -861,6 +1165,11 @@ export declare namespace PlanCreateParams {
|
|
|
861
1165
|
* this is true, and in-arrears if this is false.
|
|
862
1166
|
*/
|
|
863
1167
|
billed_in_advance?: boolean | null;
|
|
1168
|
+
/**
|
|
1169
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1170
|
+
* months.
|
|
1171
|
+
*/
|
|
1172
|
+
billing_cycle_configuration?: NewPlanThresholdTotalAmountPrice.BillingCycleConfiguration | null;
|
|
864
1173
|
/**
|
|
865
1174
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
866
1175
|
*/
|
|
@@ -883,6 +1192,11 @@ export declare namespace PlanCreateParams {
|
|
|
883
1192
|
* The property used to group this price on an invoice
|
|
884
1193
|
*/
|
|
885
1194
|
invoice_grouping_key?: string | null;
|
|
1195
|
+
/**
|
|
1196
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1197
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1198
|
+
*/
|
|
1199
|
+
invoicing_cycle_configuration?: NewPlanThresholdTotalAmountPrice.InvoicingCycleConfiguration | null;
|
|
886
1200
|
/**
|
|
887
1201
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
888
1202
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -890,6 +1204,36 @@ export declare namespace PlanCreateParams {
|
|
|
890
1204
|
*/
|
|
891
1205
|
metadata?: Record<string, string | null> | null;
|
|
892
1206
|
}
|
|
1207
|
+
namespace NewPlanThresholdTotalAmountPrice {
|
|
1208
|
+
/**
|
|
1209
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1210
|
+
* months.
|
|
1211
|
+
*/
|
|
1212
|
+
interface BillingCycleConfiguration {
|
|
1213
|
+
/**
|
|
1214
|
+
* The duration of the billing period.
|
|
1215
|
+
*/
|
|
1216
|
+
duration: number;
|
|
1217
|
+
/**
|
|
1218
|
+
* The unit of billing period duration.
|
|
1219
|
+
*/
|
|
1220
|
+
duration_unit: 'day' | 'month';
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1224
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1225
|
+
*/
|
|
1226
|
+
interface InvoicingCycleConfiguration {
|
|
1227
|
+
/**
|
|
1228
|
+
* The duration of the billing period.
|
|
1229
|
+
*/
|
|
1230
|
+
duration: number;
|
|
1231
|
+
/**
|
|
1232
|
+
* The unit of billing period duration.
|
|
1233
|
+
*/
|
|
1234
|
+
duration_unit: 'day' | 'month';
|
|
1235
|
+
}
|
|
1236
|
+
}
|
|
893
1237
|
interface NewPlanTieredPackagePrice {
|
|
894
1238
|
/**
|
|
895
1239
|
* The cadence to bill for this price on.
|
|
@@ -915,6 +1259,11 @@ export declare namespace PlanCreateParams {
|
|
|
915
1259
|
* this is true, and in-arrears if this is false.
|
|
916
1260
|
*/
|
|
917
1261
|
billed_in_advance?: boolean | null;
|
|
1262
|
+
/**
|
|
1263
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1264
|
+
* months.
|
|
1265
|
+
*/
|
|
1266
|
+
billing_cycle_configuration?: NewPlanTieredPackagePrice.BillingCycleConfiguration | null;
|
|
918
1267
|
/**
|
|
919
1268
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
920
1269
|
*/
|
|
@@ -937,6 +1286,11 @@ export declare namespace PlanCreateParams {
|
|
|
937
1286
|
* The property used to group this price on an invoice
|
|
938
1287
|
*/
|
|
939
1288
|
invoice_grouping_key?: string | null;
|
|
1289
|
+
/**
|
|
1290
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1291
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1292
|
+
*/
|
|
1293
|
+
invoicing_cycle_configuration?: NewPlanTieredPackagePrice.InvoicingCycleConfiguration | null;
|
|
940
1294
|
/**
|
|
941
1295
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
942
1296
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -944,6 +1298,36 @@ export declare namespace PlanCreateParams {
|
|
|
944
1298
|
*/
|
|
945
1299
|
metadata?: Record<string, string | null> | null;
|
|
946
1300
|
}
|
|
1301
|
+
namespace NewPlanTieredPackagePrice {
|
|
1302
|
+
/**
|
|
1303
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1304
|
+
* months.
|
|
1305
|
+
*/
|
|
1306
|
+
interface BillingCycleConfiguration {
|
|
1307
|
+
/**
|
|
1308
|
+
* The duration of the billing period.
|
|
1309
|
+
*/
|
|
1310
|
+
duration: number;
|
|
1311
|
+
/**
|
|
1312
|
+
* The unit of billing period duration.
|
|
1313
|
+
*/
|
|
1314
|
+
duration_unit: 'day' | 'month';
|
|
1315
|
+
}
|
|
1316
|
+
/**
|
|
1317
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1318
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1319
|
+
*/
|
|
1320
|
+
interface InvoicingCycleConfiguration {
|
|
1321
|
+
/**
|
|
1322
|
+
* The duration of the billing period.
|
|
1323
|
+
*/
|
|
1324
|
+
duration: number;
|
|
1325
|
+
/**
|
|
1326
|
+
* The unit of billing period duration.
|
|
1327
|
+
*/
|
|
1328
|
+
duration_unit: 'day' | 'month';
|
|
1329
|
+
}
|
|
1330
|
+
}
|
|
947
1331
|
interface NewPlanTieredWithMinimumPrice {
|
|
948
1332
|
/**
|
|
949
1333
|
* The cadence to bill for this price on.
|
|
@@ -969,6 +1353,11 @@ export declare namespace PlanCreateParams {
|
|
|
969
1353
|
* this is true, and in-arrears if this is false.
|
|
970
1354
|
*/
|
|
971
1355
|
billed_in_advance?: boolean | null;
|
|
1356
|
+
/**
|
|
1357
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1358
|
+
* months.
|
|
1359
|
+
*/
|
|
1360
|
+
billing_cycle_configuration?: NewPlanTieredWithMinimumPrice.BillingCycleConfiguration | null;
|
|
972
1361
|
/**
|
|
973
1362
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
974
1363
|
*/
|
|
@@ -991,6 +1380,11 @@ export declare namespace PlanCreateParams {
|
|
|
991
1380
|
* The property used to group this price on an invoice
|
|
992
1381
|
*/
|
|
993
1382
|
invoice_grouping_key?: string | null;
|
|
1383
|
+
/**
|
|
1384
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1385
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1386
|
+
*/
|
|
1387
|
+
invoicing_cycle_configuration?: NewPlanTieredWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
994
1388
|
/**
|
|
995
1389
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
996
1390
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -998,6 +1392,36 @@ export declare namespace PlanCreateParams {
|
|
|
998
1392
|
*/
|
|
999
1393
|
metadata?: Record<string, string | null> | null;
|
|
1000
1394
|
}
|
|
1395
|
+
namespace NewPlanTieredWithMinimumPrice {
|
|
1396
|
+
/**
|
|
1397
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1398
|
+
* months.
|
|
1399
|
+
*/
|
|
1400
|
+
interface BillingCycleConfiguration {
|
|
1401
|
+
/**
|
|
1402
|
+
* The duration of the billing period.
|
|
1403
|
+
*/
|
|
1404
|
+
duration: number;
|
|
1405
|
+
/**
|
|
1406
|
+
* The unit of billing period duration.
|
|
1407
|
+
*/
|
|
1408
|
+
duration_unit: 'day' | 'month';
|
|
1409
|
+
}
|
|
1410
|
+
/**
|
|
1411
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1412
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1413
|
+
*/
|
|
1414
|
+
interface InvoicingCycleConfiguration {
|
|
1415
|
+
/**
|
|
1416
|
+
* The duration of the billing period.
|
|
1417
|
+
*/
|
|
1418
|
+
duration: number;
|
|
1419
|
+
/**
|
|
1420
|
+
* The unit of billing period duration.
|
|
1421
|
+
*/
|
|
1422
|
+
duration_unit: 'day' | 'month';
|
|
1423
|
+
}
|
|
1424
|
+
}
|
|
1001
1425
|
interface NewPlanUnitWithPercentPrice {
|
|
1002
1426
|
/**
|
|
1003
1427
|
* The cadence to bill for this price on.
|
|
@@ -1023,6 +1447,11 @@ export declare namespace PlanCreateParams {
|
|
|
1023
1447
|
* this is true, and in-arrears if this is false.
|
|
1024
1448
|
*/
|
|
1025
1449
|
billed_in_advance?: boolean | null;
|
|
1450
|
+
/**
|
|
1451
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1452
|
+
* months.
|
|
1453
|
+
*/
|
|
1454
|
+
billing_cycle_configuration?: NewPlanUnitWithPercentPrice.BillingCycleConfiguration | null;
|
|
1026
1455
|
/**
|
|
1027
1456
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1028
1457
|
*/
|
|
@@ -1045,6 +1474,11 @@ export declare namespace PlanCreateParams {
|
|
|
1045
1474
|
* The property used to group this price on an invoice
|
|
1046
1475
|
*/
|
|
1047
1476
|
invoice_grouping_key?: string | null;
|
|
1477
|
+
/**
|
|
1478
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1479
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1480
|
+
*/
|
|
1481
|
+
invoicing_cycle_configuration?: NewPlanUnitWithPercentPrice.InvoicingCycleConfiguration | null;
|
|
1048
1482
|
/**
|
|
1049
1483
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1050
1484
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1052,6 +1486,36 @@ export declare namespace PlanCreateParams {
|
|
|
1052
1486
|
*/
|
|
1053
1487
|
metadata?: Record<string, string | null> | null;
|
|
1054
1488
|
}
|
|
1489
|
+
namespace NewPlanUnitWithPercentPrice {
|
|
1490
|
+
/**
|
|
1491
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1492
|
+
* months.
|
|
1493
|
+
*/
|
|
1494
|
+
interface BillingCycleConfiguration {
|
|
1495
|
+
/**
|
|
1496
|
+
* The duration of the billing period.
|
|
1497
|
+
*/
|
|
1498
|
+
duration: number;
|
|
1499
|
+
/**
|
|
1500
|
+
* The unit of billing period duration.
|
|
1501
|
+
*/
|
|
1502
|
+
duration_unit: 'day' | 'month';
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1506
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1507
|
+
*/
|
|
1508
|
+
interface InvoicingCycleConfiguration {
|
|
1509
|
+
/**
|
|
1510
|
+
* The duration of the billing period.
|
|
1511
|
+
*/
|
|
1512
|
+
duration: number;
|
|
1513
|
+
/**
|
|
1514
|
+
* The unit of billing period duration.
|
|
1515
|
+
*/
|
|
1516
|
+
duration_unit: 'day' | 'month';
|
|
1517
|
+
}
|
|
1518
|
+
}
|
|
1055
1519
|
interface NewPlanPackageWithAllocationPrice {
|
|
1056
1520
|
/**
|
|
1057
1521
|
* The cadence to bill for this price on.
|
|
@@ -1077,6 +1541,11 @@ export declare namespace PlanCreateParams {
|
|
|
1077
1541
|
* this is true, and in-arrears if this is false.
|
|
1078
1542
|
*/
|
|
1079
1543
|
billed_in_advance?: boolean | null;
|
|
1544
|
+
/**
|
|
1545
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1546
|
+
* months.
|
|
1547
|
+
*/
|
|
1548
|
+
billing_cycle_configuration?: NewPlanPackageWithAllocationPrice.BillingCycleConfiguration | null;
|
|
1080
1549
|
/**
|
|
1081
1550
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1082
1551
|
*/
|
|
@@ -1099,6 +1568,11 @@ export declare namespace PlanCreateParams {
|
|
|
1099
1568
|
* The property used to group this price on an invoice
|
|
1100
1569
|
*/
|
|
1101
1570
|
invoice_grouping_key?: string | null;
|
|
1571
|
+
/**
|
|
1572
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1573
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1574
|
+
*/
|
|
1575
|
+
invoicing_cycle_configuration?: NewPlanPackageWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
1102
1576
|
/**
|
|
1103
1577
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1104
1578
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1106,6 +1580,36 @@ export declare namespace PlanCreateParams {
|
|
|
1106
1580
|
*/
|
|
1107
1581
|
metadata?: Record<string, string | null> | null;
|
|
1108
1582
|
}
|
|
1583
|
+
namespace NewPlanPackageWithAllocationPrice {
|
|
1584
|
+
/**
|
|
1585
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1586
|
+
* months.
|
|
1587
|
+
*/
|
|
1588
|
+
interface BillingCycleConfiguration {
|
|
1589
|
+
/**
|
|
1590
|
+
* The duration of the billing period.
|
|
1591
|
+
*/
|
|
1592
|
+
duration: number;
|
|
1593
|
+
/**
|
|
1594
|
+
* The unit of billing period duration.
|
|
1595
|
+
*/
|
|
1596
|
+
duration_unit: 'day' | 'month';
|
|
1597
|
+
}
|
|
1598
|
+
/**
|
|
1599
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1600
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1601
|
+
*/
|
|
1602
|
+
interface InvoicingCycleConfiguration {
|
|
1603
|
+
/**
|
|
1604
|
+
* The duration of the billing period.
|
|
1605
|
+
*/
|
|
1606
|
+
duration: number;
|
|
1607
|
+
/**
|
|
1608
|
+
* The unit of billing period duration.
|
|
1609
|
+
*/
|
|
1610
|
+
duration_unit: 'day' | 'month';
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1109
1613
|
interface NewPlanTierWithProrationPrice {
|
|
1110
1614
|
/**
|
|
1111
1615
|
* The cadence to bill for this price on.
|
|
@@ -1131,6 +1635,11 @@ export declare namespace PlanCreateParams {
|
|
|
1131
1635
|
* this is true, and in-arrears if this is false.
|
|
1132
1636
|
*/
|
|
1133
1637
|
billed_in_advance?: boolean | null;
|
|
1638
|
+
/**
|
|
1639
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1640
|
+
* months.
|
|
1641
|
+
*/
|
|
1642
|
+
billing_cycle_configuration?: NewPlanTierWithProrationPrice.BillingCycleConfiguration | null;
|
|
1134
1643
|
/**
|
|
1135
1644
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1136
1645
|
*/
|
|
@@ -1153,6 +1662,11 @@ export declare namespace PlanCreateParams {
|
|
|
1153
1662
|
* The property used to group this price on an invoice
|
|
1154
1663
|
*/
|
|
1155
1664
|
invoice_grouping_key?: string | null;
|
|
1665
|
+
/**
|
|
1666
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1667
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1668
|
+
*/
|
|
1669
|
+
invoicing_cycle_configuration?: NewPlanTierWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
1156
1670
|
/**
|
|
1157
1671
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1158
1672
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1160,6 +1674,36 @@ export declare namespace PlanCreateParams {
|
|
|
1160
1674
|
*/
|
|
1161
1675
|
metadata?: Record<string, string | null> | null;
|
|
1162
1676
|
}
|
|
1677
|
+
namespace NewPlanTierWithProrationPrice {
|
|
1678
|
+
/**
|
|
1679
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1680
|
+
* months.
|
|
1681
|
+
*/
|
|
1682
|
+
interface BillingCycleConfiguration {
|
|
1683
|
+
/**
|
|
1684
|
+
* The duration of the billing period.
|
|
1685
|
+
*/
|
|
1686
|
+
duration: number;
|
|
1687
|
+
/**
|
|
1688
|
+
* The unit of billing period duration.
|
|
1689
|
+
*/
|
|
1690
|
+
duration_unit: 'day' | 'month';
|
|
1691
|
+
}
|
|
1692
|
+
/**
|
|
1693
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1694
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1695
|
+
*/
|
|
1696
|
+
interface InvoicingCycleConfiguration {
|
|
1697
|
+
/**
|
|
1698
|
+
* The duration of the billing period.
|
|
1699
|
+
*/
|
|
1700
|
+
duration: number;
|
|
1701
|
+
/**
|
|
1702
|
+
* The unit of billing period duration.
|
|
1703
|
+
*/
|
|
1704
|
+
duration_unit: 'day' | 'month';
|
|
1705
|
+
}
|
|
1706
|
+
}
|
|
1163
1707
|
interface NewPlanUnitWithProrationPrice {
|
|
1164
1708
|
/**
|
|
1165
1709
|
* The cadence to bill for this price on.
|
|
@@ -1185,6 +1729,11 @@ export declare namespace PlanCreateParams {
|
|
|
1185
1729
|
* this is true, and in-arrears if this is false.
|
|
1186
1730
|
*/
|
|
1187
1731
|
billed_in_advance?: boolean | null;
|
|
1732
|
+
/**
|
|
1733
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1734
|
+
* months.
|
|
1735
|
+
*/
|
|
1736
|
+
billing_cycle_configuration?: NewPlanUnitWithProrationPrice.BillingCycleConfiguration | null;
|
|
1188
1737
|
/**
|
|
1189
1738
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1190
1739
|
*/
|
|
@@ -1207,6 +1756,11 @@ export declare namespace PlanCreateParams {
|
|
|
1207
1756
|
* The property used to group this price on an invoice
|
|
1208
1757
|
*/
|
|
1209
1758
|
invoice_grouping_key?: string | null;
|
|
1759
|
+
/**
|
|
1760
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1761
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1762
|
+
*/
|
|
1763
|
+
invoicing_cycle_configuration?: NewPlanUnitWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
1210
1764
|
/**
|
|
1211
1765
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1212
1766
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1214,6 +1768,36 @@ export declare namespace PlanCreateParams {
|
|
|
1214
1768
|
*/
|
|
1215
1769
|
metadata?: Record<string, string | null> | null;
|
|
1216
1770
|
}
|
|
1771
|
+
namespace NewPlanUnitWithProrationPrice {
|
|
1772
|
+
/**
|
|
1773
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1774
|
+
* months.
|
|
1775
|
+
*/
|
|
1776
|
+
interface BillingCycleConfiguration {
|
|
1777
|
+
/**
|
|
1778
|
+
* The duration of the billing period.
|
|
1779
|
+
*/
|
|
1780
|
+
duration: number;
|
|
1781
|
+
/**
|
|
1782
|
+
* The unit of billing period duration.
|
|
1783
|
+
*/
|
|
1784
|
+
duration_unit: 'day' | 'month';
|
|
1785
|
+
}
|
|
1786
|
+
/**
|
|
1787
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1788
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1789
|
+
*/
|
|
1790
|
+
interface InvoicingCycleConfiguration {
|
|
1791
|
+
/**
|
|
1792
|
+
* The duration of the billing period.
|
|
1793
|
+
*/
|
|
1794
|
+
duration: number;
|
|
1795
|
+
/**
|
|
1796
|
+
* The unit of billing period duration.
|
|
1797
|
+
*/
|
|
1798
|
+
duration_unit: 'day' | 'month';
|
|
1799
|
+
}
|
|
1800
|
+
}
|
|
1217
1801
|
interface NewPlanGroupedAllocationPrice {
|
|
1218
1802
|
/**
|
|
1219
1803
|
* The cadence to bill for this price on.
|
|
@@ -1239,6 +1823,11 @@ export declare namespace PlanCreateParams {
|
|
|
1239
1823
|
* this is true, and in-arrears if this is false.
|
|
1240
1824
|
*/
|
|
1241
1825
|
billed_in_advance?: boolean | null;
|
|
1826
|
+
/**
|
|
1827
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1828
|
+
* months.
|
|
1829
|
+
*/
|
|
1830
|
+
billing_cycle_configuration?: NewPlanGroupedAllocationPrice.BillingCycleConfiguration | null;
|
|
1242
1831
|
/**
|
|
1243
1832
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1244
1833
|
*/
|
|
@@ -1261,6 +1850,11 @@ export declare namespace PlanCreateParams {
|
|
|
1261
1850
|
* The property used to group this price on an invoice
|
|
1262
1851
|
*/
|
|
1263
1852
|
invoice_grouping_key?: string | null;
|
|
1853
|
+
/**
|
|
1854
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1855
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1856
|
+
*/
|
|
1857
|
+
invoicing_cycle_configuration?: NewPlanGroupedAllocationPrice.InvoicingCycleConfiguration | null;
|
|
1264
1858
|
/**
|
|
1265
1859
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1266
1860
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1268,6 +1862,36 @@ export declare namespace PlanCreateParams {
|
|
|
1268
1862
|
*/
|
|
1269
1863
|
metadata?: Record<string, string | null> | null;
|
|
1270
1864
|
}
|
|
1865
|
+
namespace NewPlanGroupedAllocationPrice {
|
|
1866
|
+
/**
|
|
1867
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1868
|
+
* months.
|
|
1869
|
+
*/
|
|
1870
|
+
interface BillingCycleConfiguration {
|
|
1871
|
+
/**
|
|
1872
|
+
* The duration of the billing period.
|
|
1873
|
+
*/
|
|
1874
|
+
duration: number;
|
|
1875
|
+
/**
|
|
1876
|
+
* The unit of billing period duration.
|
|
1877
|
+
*/
|
|
1878
|
+
duration_unit: 'day' | 'month';
|
|
1879
|
+
}
|
|
1880
|
+
/**
|
|
1881
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1882
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1883
|
+
*/
|
|
1884
|
+
interface InvoicingCycleConfiguration {
|
|
1885
|
+
/**
|
|
1886
|
+
* The duration of the billing period.
|
|
1887
|
+
*/
|
|
1888
|
+
duration: number;
|
|
1889
|
+
/**
|
|
1890
|
+
* The unit of billing period duration.
|
|
1891
|
+
*/
|
|
1892
|
+
duration_unit: 'day' | 'month';
|
|
1893
|
+
}
|
|
1894
|
+
}
|
|
1271
1895
|
interface NewPlanBulkWithProrationPrice {
|
|
1272
1896
|
bulk_with_proration_config: Record<string, unknown>;
|
|
1273
1897
|
/**
|
|
@@ -1293,6 +1917,11 @@ export declare namespace PlanCreateParams {
|
|
|
1293
1917
|
* this is true, and in-arrears if this is false.
|
|
1294
1918
|
*/
|
|
1295
1919
|
billed_in_advance?: boolean | null;
|
|
1920
|
+
/**
|
|
1921
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1922
|
+
* months.
|
|
1923
|
+
*/
|
|
1924
|
+
billing_cycle_configuration?: NewPlanBulkWithProrationPrice.BillingCycleConfiguration | null;
|
|
1296
1925
|
/**
|
|
1297
1926
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1298
1927
|
*/
|
|
@@ -1315,6 +1944,11 @@ export declare namespace PlanCreateParams {
|
|
|
1315
1944
|
* The property used to group this price on an invoice
|
|
1316
1945
|
*/
|
|
1317
1946
|
invoice_grouping_key?: string | null;
|
|
1947
|
+
/**
|
|
1948
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1949
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1950
|
+
*/
|
|
1951
|
+
invoicing_cycle_configuration?: NewPlanBulkWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
1318
1952
|
/**
|
|
1319
1953
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1320
1954
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1322,6 +1956,36 @@ export declare namespace PlanCreateParams {
|
|
|
1322
1956
|
*/
|
|
1323
1957
|
metadata?: Record<string, string | null> | null;
|
|
1324
1958
|
}
|
|
1959
|
+
namespace NewPlanBulkWithProrationPrice {
|
|
1960
|
+
/**
|
|
1961
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1962
|
+
* months.
|
|
1963
|
+
*/
|
|
1964
|
+
interface BillingCycleConfiguration {
|
|
1965
|
+
/**
|
|
1966
|
+
* The duration of the billing period.
|
|
1967
|
+
*/
|
|
1968
|
+
duration: number;
|
|
1969
|
+
/**
|
|
1970
|
+
* The unit of billing period duration.
|
|
1971
|
+
*/
|
|
1972
|
+
duration_unit: 'day' | 'month';
|
|
1973
|
+
}
|
|
1974
|
+
/**
|
|
1975
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1976
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1977
|
+
*/
|
|
1978
|
+
interface InvoicingCycleConfiguration {
|
|
1979
|
+
/**
|
|
1980
|
+
* The duration of the billing period.
|
|
1981
|
+
*/
|
|
1982
|
+
duration: number;
|
|
1983
|
+
/**
|
|
1984
|
+
* The unit of billing period duration.
|
|
1985
|
+
*/
|
|
1986
|
+
duration_unit: 'day' | 'month';
|
|
1987
|
+
}
|
|
1988
|
+
}
|
|
1325
1989
|
}
|
|
1326
1990
|
export interface PlanUpdateParams {
|
|
1327
1991
|
/**
|