orb-billing 4.8.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 +29 -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 +829 -3
- 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 +962 -8
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -383,6 +383,12 @@ export namespace PlanCreateParams {
|
|
|
383
383
|
*/
|
|
384
384
|
billed_in_advance?: boolean | null;
|
|
385
385
|
|
|
386
|
+
/**
|
|
387
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
388
|
+
* months.
|
|
389
|
+
*/
|
|
390
|
+
billing_cycle_configuration?: NewPlanUnitPrice.BillingCycleConfiguration | null;
|
|
391
|
+
|
|
386
392
|
/**
|
|
387
393
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
388
394
|
*/
|
|
@@ -410,6 +416,12 @@ export namespace PlanCreateParams {
|
|
|
410
416
|
*/
|
|
411
417
|
invoice_grouping_key?: string | null;
|
|
412
418
|
|
|
419
|
+
/**
|
|
420
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
421
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
422
|
+
*/
|
|
423
|
+
invoicing_cycle_configuration?: NewPlanUnitPrice.InvoicingCycleConfiguration | null;
|
|
424
|
+
|
|
413
425
|
/**
|
|
414
426
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
415
427
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -425,6 +437,38 @@ export namespace PlanCreateParams {
|
|
|
425
437
|
*/
|
|
426
438
|
unit_amount: string;
|
|
427
439
|
}
|
|
440
|
+
|
|
441
|
+
/**
|
|
442
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
443
|
+
* months.
|
|
444
|
+
*/
|
|
445
|
+
export interface BillingCycleConfiguration {
|
|
446
|
+
/**
|
|
447
|
+
* The duration of the billing period.
|
|
448
|
+
*/
|
|
449
|
+
duration: number;
|
|
450
|
+
|
|
451
|
+
/**
|
|
452
|
+
* The unit of billing period duration.
|
|
453
|
+
*/
|
|
454
|
+
duration_unit: 'day' | 'month';
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
459
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
460
|
+
*/
|
|
461
|
+
export interface InvoicingCycleConfiguration {
|
|
462
|
+
/**
|
|
463
|
+
* The duration of the billing period.
|
|
464
|
+
*/
|
|
465
|
+
duration: number;
|
|
466
|
+
|
|
467
|
+
/**
|
|
468
|
+
* The unit of billing period duration.
|
|
469
|
+
*/
|
|
470
|
+
duration_unit: 'day' | 'month';
|
|
471
|
+
}
|
|
428
472
|
}
|
|
429
473
|
|
|
430
474
|
export interface NewPlanPackagePrice {
|
|
@@ -459,6 +503,12 @@ export namespace PlanCreateParams {
|
|
|
459
503
|
*/
|
|
460
504
|
billed_in_advance?: boolean | null;
|
|
461
505
|
|
|
506
|
+
/**
|
|
507
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
508
|
+
* months.
|
|
509
|
+
*/
|
|
510
|
+
billing_cycle_configuration?: NewPlanPackagePrice.BillingCycleConfiguration | null;
|
|
511
|
+
|
|
462
512
|
/**
|
|
463
513
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
464
514
|
*/
|
|
@@ -486,6 +536,12 @@ export namespace PlanCreateParams {
|
|
|
486
536
|
*/
|
|
487
537
|
invoice_grouping_key?: string | null;
|
|
488
538
|
|
|
539
|
+
/**
|
|
540
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
541
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
542
|
+
*/
|
|
543
|
+
invoicing_cycle_configuration?: NewPlanPackagePrice.InvoicingCycleConfiguration | null;
|
|
544
|
+
|
|
489
545
|
/**
|
|
490
546
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
491
547
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -507,6 +563,38 @@ export namespace PlanCreateParams {
|
|
|
507
563
|
*/
|
|
508
564
|
package_size: number;
|
|
509
565
|
}
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
569
|
+
* months.
|
|
570
|
+
*/
|
|
571
|
+
export interface BillingCycleConfiguration {
|
|
572
|
+
/**
|
|
573
|
+
* The duration of the billing period.
|
|
574
|
+
*/
|
|
575
|
+
duration: number;
|
|
576
|
+
|
|
577
|
+
/**
|
|
578
|
+
* The unit of billing period duration.
|
|
579
|
+
*/
|
|
580
|
+
duration_unit: 'day' | 'month';
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
/**
|
|
584
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
585
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
586
|
+
*/
|
|
587
|
+
export interface InvoicingCycleConfiguration {
|
|
588
|
+
/**
|
|
589
|
+
* The duration of the billing period.
|
|
590
|
+
*/
|
|
591
|
+
duration: number;
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* The unit of billing period duration.
|
|
595
|
+
*/
|
|
596
|
+
duration_unit: 'day' | 'month';
|
|
597
|
+
}
|
|
510
598
|
}
|
|
511
599
|
|
|
512
600
|
export interface NewPlanMatrixPrice {
|
|
@@ -541,6 +629,12 @@ export namespace PlanCreateParams {
|
|
|
541
629
|
*/
|
|
542
630
|
billed_in_advance?: boolean | null;
|
|
543
631
|
|
|
632
|
+
/**
|
|
633
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
634
|
+
* months.
|
|
635
|
+
*/
|
|
636
|
+
billing_cycle_configuration?: NewPlanMatrixPrice.BillingCycleConfiguration | null;
|
|
637
|
+
|
|
544
638
|
/**
|
|
545
639
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
546
640
|
*/
|
|
@@ -568,6 +662,12 @@ export namespace PlanCreateParams {
|
|
|
568
662
|
*/
|
|
569
663
|
invoice_grouping_key?: string | null;
|
|
570
664
|
|
|
665
|
+
/**
|
|
666
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
667
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
668
|
+
*/
|
|
669
|
+
invoicing_cycle_configuration?: NewPlanMatrixPrice.InvoicingCycleConfiguration | null;
|
|
670
|
+
|
|
571
671
|
/**
|
|
572
672
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
573
673
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -609,6 +709,38 @@ export namespace PlanCreateParams {
|
|
|
609
709
|
unit_amount: string;
|
|
610
710
|
}
|
|
611
711
|
}
|
|
712
|
+
|
|
713
|
+
/**
|
|
714
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
715
|
+
* months.
|
|
716
|
+
*/
|
|
717
|
+
export interface BillingCycleConfiguration {
|
|
718
|
+
/**
|
|
719
|
+
* The duration of the billing period.
|
|
720
|
+
*/
|
|
721
|
+
duration: number;
|
|
722
|
+
|
|
723
|
+
/**
|
|
724
|
+
* The unit of billing period duration.
|
|
725
|
+
*/
|
|
726
|
+
duration_unit: 'day' | 'month';
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
/**
|
|
730
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
731
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
732
|
+
*/
|
|
733
|
+
export interface InvoicingCycleConfiguration {
|
|
734
|
+
/**
|
|
735
|
+
* The duration of the billing period.
|
|
736
|
+
*/
|
|
737
|
+
duration: number;
|
|
738
|
+
|
|
739
|
+
/**
|
|
740
|
+
* The unit of billing period duration.
|
|
741
|
+
*/
|
|
742
|
+
duration_unit: 'day' | 'month';
|
|
743
|
+
}
|
|
612
744
|
}
|
|
613
745
|
|
|
614
746
|
export interface NewPlanTieredPrice {
|
|
@@ -643,6 +775,12 @@ export namespace PlanCreateParams {
|
|
|
643
775
|
*/
|
|
644
776
|
billed_in_advance?: boolean | null;
|
|
645
777
|
|
|
778
|
+
/**
|
|
779
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
780
|
+
* months.
|
|
781
|
+
*/
|
|
782
|
+
billing_cycle_configuration?: NewPlanTieredPrice.BillingCycleConfiguration | null;
|
|
783
|
+
|
|
646
784
|
/**
|
|
647
785
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
648
786
|
*/
|
|
@@ -670,6 +808,12 @@ export namespace PlanCreateParams {
|
|
|
670
808
|
*/
|
|
671
809
|
invoice_grouping_key?: string | null;
|
|
672
810
|
|
|
811
|
+
/**
|
|
812
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
813
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
814
|
+
*/
|
|
815
|
+
invoicing_cycle_configuration?: NewPlanTieredPrice.InvoicingCycleConfiguration | null;
|
|
816
|
+
|
|
673
817
|
/**
|
|
674
818
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
675
819
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -704,6 +848,38 @@ export namespace PlanCreateParams {
|
|
|
704
848
|
last_unit?: number | null;
|
|
705
849
|
}
|
|
706
850
|
}
|
|
851
|
+
|
|
852
|
+
/**
|
|
853
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
854
|
+
* months.
|
|
855
|
+
*/
|
|
856
|
+
export interface BillingCycleConfiguration {
|
|
857
|
+
/**
|
|
858
|
+
* The duration of the billing period.
|
|
859
|
+
*/
|
|
860
|
+
duration: number;
|
|
861
|
+
|
|
862
|
+
/**
|
|
863
|
+
* The unit of billing period duration.
|
|
864
|
+
*/
|
|
865
|
+
duration_unit: 'day' | 'month';
|
|
866
|
+
}
|
|
867
|
+
|
|
868
|
+
/**
|
|
869
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
870
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
871
|
+
*/
|
|
872
|
+
export interface InvoicingCycleConfiguration {
|
|
873
|
+
/**
|
|
874
|
+
* The duration of the billing period.
|
|
875
|
+
*/
|
|
876
|
+
duration: number;
|
|
877
|
+
|
|
878
|
+
/**
|
|
879
|
+
* The unit of billing period duration.
|
|
880
|
+
*/
|
|
881
|
+
duration_unit: 'day' | 'month';
|
|
882
|
+
}
|
|
707
883
|
}
|
|
708
884
|
|
|
709
885
|
export interface NewPlanTieredBpsPrice {
|
|
@@ -738,6 +914,12 @@ export namespace PlanCreateParams {
|
|
|
738
914
|
*/
|
|
739
915
|
billed_in_advance?: boolean | null;
|
|
740
916
|
|
|
917
|
+
/**
|
|
918
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
919
|
+
* months.
|
|
920
|
+
*/
|
|
921
|
+
billing_cycle_configuration?: NewPlanTieredBpsPrice.BillingCycleConfiguration | null;
|
|
922
|
+
|
|
741
923
|
/**
|
|
742
924
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
743
925
|
*/
|
|
@@ -765,6 +947,12 @@ export namespace PlanCreateParams {
|
|
|
765
947
|
*/
|
|
766
948
|
invoice_grouping_key?: string | null;
|
|
767
949
|
|
|
950
|
+
/**
|
|
951
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
952
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
953
|
+
*/
|
|
954
|
+
invoicing_cycle_configuration?: NewPlanTieredBpsPrice.InvoicingCycleConfiguration | null;
|
|
955
|
+
|
|
768
956
|
/**
|
|
769
957
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
770
958
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -805,6 +993,38 @@ export namespace PlanCreateParams {
|
|
|
805
993
|
per_unit_maximum?: string | null;
|
|
806
994
|
}
|
|
807
995
|
}
|
|
996
|
+
|
|
997
|
+
/**
|
|
998
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
999
|
+
* months.
|
|
1000
|
+
*/
|
|
1001
|
+
export interface BillingCycleConfiguration {
|
|
1002
|
+
/**
|
|
1003
|
+
* The duration of the billing period.
|
|
1004
|
+
*/
|
|
1005
|
+
duration: number;
|
|
1006
|
+
|
|
1007
|
+
/**
|
|
1008
|
+
* The unit of billing period duration.
|
|
1009
|
+
*/
|
|
1010
|
+
duration_unit: 'day' | 'month';
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
/**
|
|
1014
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1015
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1016
|
+
*/
|
|
1017
|
+
export interface InvoicingCycleConfiguration {
|
|
1018
|
+
/**
|
|
1019
|
+
* The duration of the billing period.
|
|
1020
|
+
*/
|
|
1021
|
+
duration: number;
|
|
1022
|
+
|
|
1023
|
+
/**
|
|
1024
|
+
* The unit of billing period duration.
|
|
1025
|
+
*/
|
|
1026
|
+
duration_unit: 'day' | 'month';
|
|
1027
|
+
}
|
|
808
1028
|
}
|
|
809
1029
|
|
|
810
1030
|
export interface NewPlanBpsPrice {
|
|
@@ -839,6 +1059,12 @@ export namespace PlanCreateParams {
|
|
|
839
1059
|
*/
|
|
840
1060
|
billed_in_advance?: boolean | null;
|
|
841
1061
|
|
|
1062
|
+
/**
|
|
1063
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1064
|
+
* months.
|
|
1065
|
+
*/
|
|
1066
|
+
billing_cycle_configuration?: NewPlanBpsPrice.BillingCycleConfiguration | null;
|
|
1067
|
+
|
|
842
1068
|
/**
|
|
843
1069
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
844
1070
|
*/
|
|
@@ -866,6 +1092,12 @@ export namespace PlanCreateParams {
|
|
|
866
1092
|
*/
|
|
867
1093
|
invoice_grouping_key?: string | null;
|
|
868
1094
|
|
|
1095
|
+
/**
|
|
1096
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1097
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1098
|
+
*/
|
|
1099
|
+
invoicing_cycle_configuration?: NewPlanBpsPrice.InvoicingCycleConfiguration | null;
|
|
1100
|
+
|
|
869
1101
|
/**
|
|
870
1102
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
871
1103
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -886,6 +1118,38 @@ export namespace PlanCreateParams {
|
|
|
886
1118
|
*/
|
|
887
1119
|
per_unit_maximum?: string | null;
|
|
888
1120
|
}
|
|
1121
|
+
|
|
1122
|
+
/**
|
|
1123
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1124
|
+
* months.
|
|
1125
|
+
*/
|
|
1126
|
+
export interface BillingCycleConfiguration {
|
|
1127
|
+
/**
|
|
1128
|
+
* The duration of the billing period.
|
|
1129
|
+
*/
|
|
1130
|
+
duration: number;
|
|
1131
|
+
|
|
1132
|
+
/**
|
|
1133
|
+
* The unit of billing period duration.
|
|
1134
|
+
*/
|
|
1135
|
+
duration_unit: 'day' | 'month';
|
|
1136
|
+
}
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1140
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1141
|
+
*/
|
|
1142
|
+
export interface InvoicingCycleConfiguration {
|
|
1143
|
+
/**
|
|
1144
|
+
* The duration of the billing period.
|
|
1145
|
+
*/
|
|
1146
|
+
duration: number;
|
|
1147
|
+
|
|
1148
|
+
/**
|
|
1149
|
+
* The unit of billing period duration.
|
|
1150
|
+
*/
|
|
1151
|
+
duration_unit: 'day' | 'month';
|
|
1152
|
+
}
|
|
889
1153
|
}
|
|
890
1154
|
|
|
891
1155
|
export interface NewPlanBulkBpsPrice {
|
|
@@ -920,6 +1184,12 @@ export namespace PlanCreateParams {
|
|
|
920
1184
|
*/
|
|
921
1185
|
billed_in_advance?: boolean | null;
|
|
922
1186
|
|
|
1187
|
+
/**
|
|
1188
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1189
|
+
* months.
|
|
1190
|
+
*/
|
|
1191
|
+
billing_cycle_configuration?: NewPlanBulkBpsPrice.BillingCycleConfiguration | null;
|
|
1192
|
+
|
|
923
1193
|
/**
|
|
924
1194
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
925
1195
|
*/
|
|
@@ -947,6 +1217,12 @@ export namespace PlanCreateParams {
|
|
|
947
1217
|
*/
|
|
948
1218
|
invoice_grouping_key?: string | null;
|
|
949
1219
|
|
|
1220
|
+
/**
|
|
1221
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1222
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1223
|
+
*/
|
|
1224
|
+
invoicing_cycle_configuration?: NewPlanBulkBpsPrice.InvoicingCycleConfiguration | null;
|
|
1225
|
+
|
|
950
1226
|
/**
|
|
951
1227
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
952
1228
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -982,6 +1258,38 @@ export namespace PlanCreateParams {
|
|
|
982
1258
|
per_unit_maximum?: string | null;
|
|
983
1259
|
}
|
|
984
1260
|
}
|
|
1261
|
+
|
|
1262
|
+
/**
|
|
1263
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1264
|
+
* months.
|
|
1265
|
+
*/
|
|
1266
|
+
export interface BillingCycleConfiguration {
|
|
1267
|
+
/**
|
|
1268
|
+
* The duration of the billing period.
|
|
1269
|
+
*/
|
|
1270
|
+
duration: number;
|
|
1271
|
+
|
|
1272
|
+
/**
|
|
1273
|
+
* The unit of billing period duration.
|
|
1274
|
+
*/
|
|
1275
|
+
duration_unit: 'day' | 'month';
|
|
1276
|
+
}
|
|
1277
|
+
|
|
1278
|
+
/**
|
|
1279
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1280
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1281
|
+
*/
|
|
1282
|
+
export interface InvoicingCycleConfiguration {
|
|
1283
|
+
/**
|
|
1284
|
+
* The duration of the billing period.
|
|
1285
|
+
*/
|
|
1286
|
+
duration: number;
|
|
1287
|
+
|
|
1288
|
+
/**
|
|
1289
|
+
* The unit of billing period duration.
|
|
1290
|
+
*/
|
|
1291
|
+
duration_unit: 'day' | 'month';
|
|
1292
|
+
}
|
|
985
1293
|
}
|
|
986
1294
|
|
|
987
1295
|
export interface NewPlanBulkPrice {
|
|
@@ -1016,6 +1324,12 @@ export namespace PlanCreateParams {
|
|
|
1016
1324
|
*/
|
|
1017
1325
|
billed_in_advance?: boolean | null;
|
|
1018
1326
|
|
|
1327
|
+
/**
|
|
1328
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1329
|
+
* months.
|
|
1330
|
+
*/
|
|
1331
|
+
billing_cycle_configuration?: NewPlanBulkPrice.BillingCycleConfiguration | null;
|
|
1332
|
+
|
|
1019
1333
|
/**
|
|
1020
1334
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1021
1335
|
*/
|
|
@@ -1043,6 +1357,12 @@ export namespace PlanCreateParams {
|
|
|
1043
1357
|
*/
|
|
1044
1358
|
invoice_grouping_key?: string | null;
|
|
1045
1359
|
|
|
1360
|
+
/**
|
|
1361
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1362
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1363
|
+
*/
|
|
1364
|
+
invoicing_cycle_configuration?: NewPlanBulkPrice.InvoicingCycleConfiguration | null;
|
|
1365
|
+
|
|
1046
1366
|
/**
|
|
1047
1367
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1048
1368
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1072,6 +1392,38 @@ export namespace PlanCreateParams {
|
|
|
1072
1392
|
maximum_units?: number | null;
|
|
1073
1393
|
}
|
|
1074
1394
|
}
|
|
1395
|
+
|
|
1396
|
+
/**
|
|
1397
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1398
|
+
* months.
|
|
1399
|
+
*/
|
|
1400
|
+
export interface BillingCycleConfiguration {
|
|
1401
|
+
/**
|
|
1402
|
+
* The duration of the billing period.
|
|
1403
|
+
*/
|
|
1404
|
+
duration: number;
|
|
1405
|
+
|
|
1406
|
+
/**
|
|
1407
|
+
* The unit of billing period duration.
|
|
1408
|
+
*/
|
|
1409
|
+
duration_unit: 'day' | 'month';
|
|
1410
|
+
}
|
|
1411
|
+
|
|
1412
|
+
/**
|
|
1413
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1414
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1415
|
+
*/
|
|
1416
|
+
export interface InvoicingCycleConfiguration {
|
|
1417
|
+
/**
|
|
1418
|
+
* The duration of the billing period.
|
|
1419
|
+
*/
|
|
1420
|
+
duration: number;
|
|
1421
|
+
|
|
1422
|
+
/**
|
|
1423
|
+
* The unit of billing period duration.
|
|
1424
|
+
*/
|
|
1425
|
+
duration_unit: 'day' | 'month';
|
|
1426
|
+
}
|
|
1075
1427
|
}
|
|
1076
1428
|
|
|
1077
1429
|
export interface NewPlanThresholdTotalAmountPrice {
|
|
@@ -1106,6 +1458,12 @@ export namespace PlanCreateParams {
|
|
|
1106
1458
|
*/
|
|
1107
1459
|
billed_in_advance?: boolean | null;
|
|
1108
1460
|
|
|
1461
|
+
/**
|
|
1462
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1463
|
+
* months.
|
|
1464
|
+
*/
|
|
1465
|
+
billing_cycle_configuration?: NewPlanThresholdTotalAmountPrice.BillingCycleConfiguration | null;
|
|
1466
|
+
|
|
1109
1467
|
/**
|
|
1110
1468
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1111
1469
|
*/
|
|
@@ -1133,6 +1491,12 @@ export namespace PlanCreateParams {
|
|
|
1133
1491
|
*/
|
|
1134
1492
|
invoice_grouping_key?: string | null;
|
|
1135
1493
|
|
|
1494
|
+
/**
|
|
1495
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1496
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1497
|
+
*/
|
|
1498
|
+
invoicing_cycle_configuration?: NewPlanThresholdTotalAmountPrice.InvoicingCycleConfiguration | null;
|
|
1499
|
+
|
|
1136
1500
|
/**
|
|
1137
1501
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1138
1502
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1141,6 +1505,40 @@ export namespace PlanCreateParams {
|
|
|
1141
1505
|
metadata?: Record<string, string | null> | null;
|
|
1142
1506
|
}
|
|
1143
1507
|
|
|
1508
|
+
export namespace NewPlanThresholdTotalAmountPrice {
|
|
1509
|
+
/**
|
|
1510
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1511
|
+
* months.
|
|
1512
|
+
*/
|
|
1513
|
+
export interface BillingCycleConfiguration {
|
|
1514
|
+
/**
|
|
1515
|
+
* The duration of the billing period.
|
|
1516
|
+
*/
|
|
1517
|
+
duration: number;
|
|
1518
|
+
|
|
1519
|
+
/**
|
|
1520
|
+
* The unit of billing period duration.
|
|
1521
|
+
*/
|
|
1522
|
+
duration_unit: 'day' | 'month';
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1527
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1528
|
+
*/
|
|
1529
|
+
export interface InvoicingCycleConfiguration {
|
|
1530
|
+
/**
|
|
1531
|
+
* The duration of the billing period.
|
|
1532
|
+
*/
|
|
1533
|
+
duration: number;
|
|
1534
|
+
|
|
1535
|
+
/**
|
|
1536
|
+
* The unit of billing period duration.
|
|
1537
|
+
*/
|
|
1538
|
+
duration_unit: 'day' | 'month';
|
|
1539
|
+
}
|
|
1540
|
+
}
|
|
1541
|
+
|
|
1144
1542
|
export interface NewPlanTieredPackagePrice {
|
|
1145
1543
|
/**
|
|
1146
1544
|
* The cadence to bill for this price on.
|
|
@@ -1173,6 +1571,12 @@ export namespace PlanCreateParams {
|
|
|
1173
1571
|
*/
|
|
1174
1572
|
billed_in_advance?: boolean | null;
|
|
1175
1573
|
|
|
1574
|
+
/**
|
|
1575
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1576
|
+
* months.
|
|
1577
|
+
*/
|
|
1578
|
+
billing_cycle_configuration?: NewPlanTieredPackagePrice.BillingCycleConfiguration | null;
|
|
1579
|
+
|
|
1176
1580
|
/**
|
|
1177
1581
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1178
1582
|
*/
|
|
@@ -1200,6 +1604,12 @@ export namespace PlanCreateParams {
|
|
|
1200
1604
|
*/
|
|
1201
1605
|
invoice_grouping_key?: string | null;
|
|
1202
1606
|
|
|
1607
|
+
/**
|
|
1608
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1609
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1610
|
+
*/
|
|
1611
|
+
invoicing_cycle_configuration?: NewPlanTieredPackagePrice.InvoicingCycleConfiguration | null;
|
|
1612
|
+
|
|
1203
1613
|
/**
|
|
1204
1614
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1205
1615
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1208,6 +1618,40 @@ export namespace PlanCreateParams {
|
|
|
1208
1618
|
metadata?: Record<string, string | null> | null;
|
|
1209
1619
|
}
|
|
1210
1620
|
|
|
1621
|
+
export namespace NewPlanTieredPackagePrice {
|
|
1622
|
+
/**
|
|
1623
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1624
|
+
* months.
|
|
1625
|
+
*/
|
|
1626
|
+
export interface BillingCycleConfiguration {
|
|
1627
|
+
/**
|
|
1628
|
+
* The duration of the billing period.
|
|
1629
|
+
*/
|
|
1630
|
+
duration: number;
|
|
1631
|
+
|
|
1632
|
+
/**
|
|
1633
|
+
* The unit of billing period duration.
|
|
1634
|
+
*/
|
|
1635
|
+
duration_unit: 'day' | 'month';
|
|
1636
|
+
}
|
|
1637
|
+
|
|
1638
|
+
/**
|
|
1639
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1640
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1641
|
+
*/
|
|
1642
|
+
export interface InvoicingCycleConfiguration {
|
|
1643
|
+
/**
|
|
1644
|
+
* The duration of the billing period.
|
|
1645
|
+
*/
|
|
1646
|
+
duration: number;
|
|
1647
|
+
|
|
1648
|
+
/**
|
|
1649
|
+
* The unit of billing period duration.
|
|
1650
|
+
*/
|
|
1651
|
+
duration_unit: 'day' | 'month';
|
|
1652
|
+
}
|
|
1653
|
+
}
|
|
1654
|
+
|
|
1211
1655
|
export interface NewPlanTieredWithMinimumPrice {
|
|
1212
1656
|
/**
|
|
1213
1657
|
* The cadence to bill for this price on.
|
|
@@ -1240,6 +1684,12 @@ export namespace PlanCreateParams {
|
|
|
1240
1684
|
*/
|
|
1241
1685
|
billed_in_advance?: boolean | null;
|
|
1242
1686
|
|
|
1687
|
+
/**
|
|
1688
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1689
|
+
* months.
|
|
1690
|
+
*/
|
|
1691
|
+
billing_cycle_configuration?: NewPlanTieredWithMinimumPrice.BillingCycleConfiguration | null;
|
|
1692
|
+
|
|
1243
1693
|
/**
|
|
1244
1694
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1245
1695
|
*/
|
|
@@ -1267,6 +1717,12 @@ export namespace PlanCreateParams {
|
|
|
1267
1717
|
*/
|
|
1268
1718
|
invoice_grouping_key?: string | null;
|
|
1269
1719
|
|
|
1720
|
+
/**
|
|
1721
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1722
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1723
|
+
*/
|
|
1724
|
+
invoicing_cycle_configuration?: NewPlanTieredWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
1725
|
+
|
|
1270
1726
|
/**
|
|
1271
1727
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1272
1728
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1275,6 +1731,40 @@ export namespace PlanCreateParams {
|
|
|
1275
1731
|
metadata?: Record<string, string | null> | null;
|
|
1276
1732
|
}
|
|
1277
1733
|
|
|
1734
|
+
export namespace NewPlanTieredWithMinimumPrice {
|
|
1735
|
+
/**
|
|
1736
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1737
|
+
* months.
|
|
1738
|
+
*/
|
|
1739
|
+
export interface BillingCycleConfiguration {
|
|
1740
|
+
/**
|
|
1741
|
+
* The duration of the billing period.
|
|
1742
|
+
*/
|
|
1743
|
+
duration: number;
|
|
1744
|
+
|
|
1745
|
+
/**
|
|
1746
|
+
* The unit of billing period duration.
|
|
1747
|
+
*/
|
|
1748
|
+
duration_unit: 'day' | 'month';
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1751
|
+
/**
|
|
1752
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1753
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1754
|
+
*/
|
|
1755
|
+
export interface InvoicingCycleConfiguration {
|
|
1756
|
+
/**
|
|
1757
|
+
* The duration of the billing period.
|
|
1758
|
+
*/
|
|
1759
|
+
duration: number;
|
|
1760
|
+
|
|
1761
|
+
/**
|
|
1762
|
+
* The unit of billing period duration.
|
|
1763
|
+
*/
|
|
1764
|
+
duration_unit: 'day' | 'month';
|
|
1765
|
+
}
|
|
1766
|
+
}
|
|
1767
|
+
|
|
1278
1768
|
export interface NewPlanUnitWithPercentPrice {
|
|
1279
1769
|
/**
|
|
1280
1770
|
* The cadence to bill for this price on.
|
|
@@ -1307,6 +1797,12 @@ export namespace PlanCreateParams {
|
|
|
1307
1797
|
*/
|
|
1308
1798
|
billed_in_advance?: boolean | null;
|
|
1309
1799
|
|
|
1800
|
+
/**
|
|
1801
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1802
|
+
* months.
|
|
1803
|
+
*/
|
|
1804
|
+
billing_cycle_configuration?: NewPlanUnitWithPercentPrice.BillingCycleConfiguration | null;
|
|
1805
|
+
|
|
1310
1806
|
/**
|
|
1311
1807
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1312
1808
|
*/
|
|
@@ -1334,6 +1830,12 @@ export namespace PlanCreateParams {
|
|
|
1334
1830
|
*/
|
|
1335
1831
|
invoice_grouping_key?: string | null;
|
|
1336
1832
|
|
|
1833
|
+
/**
|
|
1834
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1835
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1836
|
+
*/
|
|
1837
|
+
invoicing_cycle_configuration?: NewPlanUnitWithPercentPrice.InvoicingCycleConfiguration | null;
|
|
1838
|
+
|
|
1337
1839
|
/**
|
|
1338
1840
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1339
1841
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1342,6 +1844,40 @@ export namespace PlanCreateParams {
|
|
|
1342
1844
|
metadata?: Record<string, string | null> | null;
|
|
1343
1845
|
}
|
|
1344
1846
|
|
|
1847
|
+
export namespace NewPlanUnitWithPercentPrice {
|
|
1848
|
+
/**
|
|
1849
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1850
|
+
* months.
|
|
1851
|
+
*/
|
|
1852
|
+
export interface BillingCycleConfiguration {
|
|
1853
|
+
/**
|
|
1854
|
+
* The duration of the billing period.
|
|
1855
|
+
*/
|
|
1856
|
+
duration: number;
|
|
1857
|
+
|
|
1858
|
+
/**
|
|
1859
|
+
* The unit of billing period duration.
|
|
1860
|
+
*/
|
|
1861
|
+
duration_unit: 'day' | 'month';
|
|
1862
|
+
}
|
|
1863
|
+
|
|
1864
|
+
/**
|
|
1865
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1866
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1867
|
+
*/
|
|
1868
|
+
export interface InvoicingCycleConfiguration {
|
|
1869
|
+
/**
|
|
1870
|
+
* The duration of the billing period.
|
|
1871
|
+
*/
|
|
1872
|
+
duration: number;
|
|
1873
|
+
|
|
1874
|
+
/**
|
|
1875
|
+
* The unit of billing period duration.
|
|
1876
|
+
*/
|
|
1877
|
+
duration_unit: 'day' | 'month';
|
|
1878
|
+
}
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1345
1881
|
export interface NewPlanPackageWithAllocationPrice {
|
|
1346
1882
|
/**
|
|
1347
1883
|
* The cadence to bill for this price on.
|
|
@@ -1374,6 +1910,12 @@ export namespace PlanCreateParams {
|
|
|
1374
1910
|
*/
|
|
1375
1911
|
billed_in_advance?: boolean | null;
|
|
1376
1912
|
|
|
1913
|
+
/**
|
|
1914
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1915
|
+
* months.
|
|
1916
|
+
*/
|
|
1917
|
+
billing_cycle_configuration?: NewPlanPackageWithAllocationPrice.BillingCycleConfiguration | null;
|
|
1918
|
+
|
|
1377
1919
|
/**
|
|
1378
1920
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1379
1921
|
*/
|
|
@@ -1401,6 +1943,12 @@ export namespace PlanCreateParams {
|
|
|
1401
1943
|
*/
|
|
1402
1944
|
invoice_grouping_key?: string | null;
|
|
1403
1945
|
|
|
1946
|
+
/**
|
|
1947
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1948
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1949
|
+
*/
|
|
1950
|
+
invoicing_cycle_configuration?: NewPlanPackageWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
1951
|
+
|
|
1404
1952
|
/**
|
|
1405
1953
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1406
1954
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1409,6 +1957,40 @@ export namespace PlanCreateParams {
|
|
|
1409
1957
|
metadata?: Record<string, string | null> | null;
|
|
1410
1958
|
}
|
|
1411
1959
|
|
|
1960
|
+
export namespace NewPlanPackageWithAllocationPrice {
|
|
1961
|
+
/**
|
|
1962
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
1963
|
+
* months.
|
|
1964
|
+
*/
|
|
1965
|
+
export interface BillingCycleConfiguration {
|
|
1966
|
+
/**
|
|
1967
|
+
* The duration of the billing period.
|
|
1968
|
+
*/
|
|
1969
|
+
duration: number;
|
|
1970
|
+
|
|
1971
|
+
/**
|
|
1972
|
+
* The unit of billing period duration.
|
|
1973
|
+
*/
|
|
1974
|
+
duration_unit: 'day' | 'month';
|
|
1975
|
+
}
|
|
1976
|
+
|
|
1977
|
+
/**
|
|
1978
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1979
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
1980
|
+
*/
|
|
1981
|
+
export interface InvoicingCycleConfiguration {
|
|
1982
|
+
/**
|
|
1983
|
+
* The duration of the billing period.
|
|
1984
|
+
*/
|
|
1985
|
+
duration: number;
|
|
1986
|
+
|
|
1987
|
+
/**
|
|
1988
|
+
* The unit of billing period duration.
|
|
1989
|
+
*/
|
|
1990
|
+
duration_unit: 'day' | 'month';
|
|
1991
|
+
}
|
|
1992
|
+
}
|
|
1993
|
+
|
|
1412
1994
|
export interface NewPlanTierWithProrationPrice {
|
|
1413
1995
|
/**
|
|
1414
1996
|
* The cadence to bill for this price on.
|
|
@@ -1441,6 +2023,12 @@ export namespace PlanCreateParams {
|
|
|
1441
2023
|
*/
|
|
1442
2024
|
billed_in_advance?: boolean | null;
|
|
1443
2025
|
|
|
2026
|
+
/**
|
|
2027
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2028
|
+
* months.
|
|
2029
|
+
*/
|
|
2030
|
+
billing_cycle_configuration?: NewPlanTierWithProrationPrice.BillingCycleConfiguration | null;
|
|
2031
|
+
|
|
1444
2032
|
/**
|
|
1445
2033
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1446
2034
|
*/
|
|
@@ -1468,6 +2056,12 @@ export namespace PlanCreateParams {
|
|
|
1468
2056
|
*/
|
|
1469
2057
|
invoice_grouping_key?: string | null;
|
|
1470
2058
|
|
|
2059
|
+
/**
|
|
2060
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2061
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2062
|
+
*/
|
|
2063
|
+
invoicing_cycle_configuration?: NewPlanTierWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
2064
|
+
|
|
1471
2065
|
/**
|
|
1472
2066
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1473
2067
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1476,6 +2070,40 @@ export namespace PlanCreateParams {
|
|
|
1476
2070
|
metadata?: Record<string, string | null> | null;
|
|
1477
2071
|
}
|
|
1478
2072
|
|
|
2073
|
+
export namespace NewPlanTierWithProrationPrice {
|
|
2074
|
+
/**
|
|
2075
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2076
|
+
* months.
|
|
2077
|
+
*/
|
|
2078
|
+
export interface BillingCycleConfiguration {
|
|
2079
|
+
/**
|
|
2080
|
+
* The duration of the billing period.
|
|
2081
|
+
*/
|
|
2082
|
+
duration: number;
|
|
2083
|
+
|
|
2084
|
+
/**
|
|
2085
|
+
* The unit of billing period duration.
|
|
2086
|
+
*/
|
|
2087
|
+
duration_unit: 'day' | 'month';
|
|
2088
|
+
}
|
|
2089
|
+
|
|
2090
|
+
/**
|
|
2091
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2092
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2093
|
+
*/
|
|
2094
|
+
export interface InvoicingCycleConfiguration {
|
|
2095
|
+
/**
|
|
2096
|
+
* The duration of the billing period.
|
|
2097
|
+
*/
|
|
2098
|
+
duration: number;
|
|
2099
|
+
|
|
2100
|
+
/**
|
|
2101
|
+
* The unit of billing period duration.
|
|
2102
|
+
*/
|
|
2103
|
+
duration_unit: 'day' | 'month';
|
|
2104
|
+
}
|
|
2105
|
+
}
|
|
2106
|
+
|
|
1479
2107
|
export interface NewPlanUnitWithProrationPrice {
|
|
1480
2108
|
/**
|
|
1481
2109
|
* The cadence to bill for this price on.
|
|
@@ -1508,6 +2136,12 @@ export namespace PlanCreateParams {
|
|
|
1508
2136
|
*/
|
|
1509
2137
|
billed_in_advance?: boolean | null;
|
|
1510
2138
|
|
|
2139
|
+
/**
|
|
2140
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2141
|
+
* months.
|
|
2142
|
+
*/
|
|
2143
|
+
billing_cycle_configuration?: NewPlanUnitWithProrationPrice.BillingCycleConfiguration | null;
|
|
2144
|
+
|
|
1511
2145
|
/**
|
|
1512
2146
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1513
2147
|
*/
|
|
@@ -1535,6 +2169,12 @@ export namespace PlanCreateParams {
|
|
|
1535
2169
|
*/
|
|
1536
2170
|
invoice_grouping_key?: string | null;
|
|
1537
2171
|
|
|
2172
|
+
/**
|
|
2173
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2174
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2175
|
+
*/
|
|
2176
|
+
invoicing_cycle_configuration?: NewPlanUnitWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
2177
|
+
|
|
1538
2178
|
/**
|
|
1539
2179
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1540
2180
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1543,6 +2183,40 @@ export namespace PlanCreateParams {
|
|
|
1543
2183
|
metadata?: Record<string, string | null> | null;
|
|
1544
2184
|
}
|
|
1545
2185
|
|
|
2186
|
+
export namespace NewPlanUnitWithProrationPrice {
|
|
2187
|
+
/**
|
|
2188
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2189
|
+
* months.
|
|
2190
|
+
*/
|
|
2191
|
+
export interface BillingCycleConfiguration {
|
|
2192
|
+
/**
|
|
2193
|
+
* The duration of the billing period.
|
|
2194
|
+
*/
|
|
2195
|
+
duration: number;
|
|
2196
|
+
|
|
2197
|
+
/**
|
|
2198
|
+
* The unit of billing period duration.
|
|
2199
|
+
*/
|
|
2200
|
+
duration_unit: 'day' | 'month';
|
|
2201
|
+
}
|
|
2202
|
+
|
|
2203
|
+
/**
|
|
2204
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2205
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2206
|
+
*/
|
|
2207
|
+
export interface InvoicingCycleConfiguration {
|
|
2208
|
+
/**
|
|
2209
|
+
* The duration of the billing period.
|
|
2210
|
+
*/
|
|
2211
|
+
duration: number;
|
|
2212
|
+
|
|
2213
|
+
/**
|
|
2214
|
+
* The unit of billing period duration.
|
|
2215
|
+
*/
|
|
2216
|
+
duration_unit: 'day' | 'month';
|
|
2217
|
+
}
|
|
2218
|
+
}
|
|
2219
|
+
|
|
1546
2220
|
export interface NewPlanGroupedAllocationPrice {
|
|
1547
2221
|
/**
|
|
1548
2222
|
* The cadence to bill for this price on.
|
|
@@ -1575,6 +2249,12 @@ export namespace PlanCreateParams {
|
|
|
1575
2249
|
*/
|
|
1576
2250
|
billed_in_advance?: boolean | null;
|
|
1577
2251
|
|
|
2252
|
+
/**
|
|
2253
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2254
|
+
* months.
|
|
2255
|
+
*/
|
|
2256
|
+
billing_cycle_configuration?: NewPlanGroupedAllocationPrice.BillingCycleConfiguration | null;
|
|
2257
|
+
|
|
1578
2258
|
/**
|
|
1579
2259
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1580
2260
|
*/
|
|
@@ -1602,6 +2282,12 @@ export namespace PlanCreateParams {
|
|
|
1602
2282
|
*/
|
|
1603
2283
|
invoice_grouping_key?: string | null;
|
|
1604
2284
|
|
|
2285
|
+
/**
|
|
2286
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2287
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2288
|
+
*/
|
|
2289
|
+
invoicing_cycle_configuration?: NewPlanGroupedAllocationPrice.InvoicingCycleConfiguration | null;
|
|
2290
|
+
|
|
1605
2291
|
/**
|
|
1606
2292
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1607
2293
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1610,6 +2296,40 @@ export namespace PlanCreateParams {
|
|
|
1610
2296
|
metadata?: Record<string, string | null> | null;
|
|
1611
2297
|
}
|
|
1612
2298
|
|
|
2299
|
+
export namespace NewPlanGroupedAllocationPrice {
|
|
2300
|
+
/**
|
|
2301
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2302
|
+
* months.
|
|
2303
|
+
*/
|
|
2304
|
+
export interface BillingCycleConfiguration {
|
|
2305
|
+
/**
|
|
2306
|
+
* The duration of the billing period.
|
|
2307
|
+
*/
|
|
2308
|
+
duration: number;
|
|
2309
|
+
|
|
2310
|
+
/**
|
|
2311
|
+
* The unit of billing period duration.
|
|
2312
|
+
*/
|
|
2313
|
+
duration_unit: 'day' | 'month';
|
|
2314
|
+
}
|
|
2315
|
+
|
|
2316
|
+
/**
|
|
2317
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2318
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2319
|
+
*/
|
|
2320
|
+
export interface InvoicingCycleConfiguration {
|
|
2321
|
+
/**
|
|
2322
|
+
* The duration of the billing period.
|
|
2323
|
+
*/
|
|
2324
|
+
duration: number;
|
|
2325
|
+
|
|
2326
|
+
/**
|
|
2327
|
+
* The unit of billing period duration.
|
|
2328
|
+
*/
|
|
2329
|
+
duration_unit: 'day' | 'month';
|
|
2330
|
+
}
|
|
2331
|
+
}
|
|
2332
|
+
|
|
1613
2333
|
export interface NewPlanBulkWithProrationPrice {
|
|
1614
2334
|
bulk_with_proration_config: Record<string, unknown>;
|
|
1615
2335
|
|
|
@@ -1642,6 +2362,12 @@ export namespace PlanCreateParams {
|
|
|
1642
2362
|
*/
|
|
1643
2363
|
billed_in_advance?: boolean | null;
|
|
1644
2364
|
|
|
2365
|
+
/**
|
|
2366
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2367
|
+
* months.
|
|
2368
|
+
*/
|
|
2369
|
+
billing_cycle_configuration?: NewPlanBulkWithProrationPrice.BillingCycleConfiguration | null;
|
|
2370
|
+
|
|
1645
2371
|
/**
|
|
1646
2372
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
1647
2373
|
*/
|
|
@@ -1669,6 +2395,12 @@ export namespace PlanCreateParams {
|
|
|
1669
2395
|
*/
|
|
1670
2396
|
invoice_grouping_key?: string | null;
|
|
1671
2397
|
|
|
2398
|
+
/**
|
|
2399
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2400
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2401
|
+
*/
|
|
2402
|
+
invoicing_cycle_configuration?: NewPlanBulkWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
2403
|
+
|
|
1672
2404
|
/**
|
|
1673
2405
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1674
2406
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -1676,6 +2408,40 @@ export namespace PlanCreateParams {
|
|
|
1676
2408
|
*/
|
|
1677
2409
|
metadata?: Record<string, string | null> | null;
|
|
1678
2410
|
}
|
|
2411
|
+
|
|
2412
|
+
export namespace NewPlanBulkWithProrationPrice {
|
|
2413
|
+
/**
|
|
2414
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
2415
|
+
* months.
|
|
2416
|
+
*/
|
|
2417
|
+
export interface BillingCycleConfiguration {
|
|
2418
|
+
/**
|
|
2419
|
+
* The duration of the billing period.
|
|
2420
|
+
*/
|
|
2421
|
+
duration: number;
|
|
2422
|
+
|
|
2423
|
+
/**
|
|
2424
|
+
* The unit of billing period duration.
|
|
2425
|
+
*/
|
|
2426
|
+
duration_unit: 'day' | 'month';
|
|
2427
|
+
}
|
|
2428
|
+
|
|
2429
|
+
/**
|
|
2430
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2431
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
2432
|
+
*/
|
|
2433
|
+
export interface InvoicingCycleConfiguration {
|
|
2434
|
+
/**
|
|
2435
|
+
* The duration of the billing period.
|
|
2436
|
+
*/
|
|
2437
|
+
duration: number;
|
|
2438
|
+
|
|
2439
|
+
/**
|
|
2440
|
+
* The unit of billing period duration.
|
|
2441
|
+
*/
|
|
2442
|
+
duration_unit: 'day' | 'month';
|
|
2443
|
+
}
|
|
2444
|
+
}
|
|
1679
2445
|
}
|
|
1680
2446
|
|
|
1681
2447
|
export interface PlanUpdateParams {
|