@stigg/typescript 0.1.0-beta.2 → 0.1.0-beta.4

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.
Files changed (92) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/package.json +1 -1
  3. package/resources/v1/addons/addons.d.mts +172 -1
  4. package/resources/v1/addons/addons.d.mts.map +1 -1
  5. package/resources/v1/addons/addons.d.ts +172 -1
  6. package/resources/v1/addons/addons.d.ts.map +1 -1
  7. package/resources/v1/addons/addons.js +6 -0
  8. package/resources/v1/addons/addons.js.map +1 -1
  9. package/resources/v1/addons/addons.mjs +6 -0
  10. package/resources/v1/addons/addons.mjs.map +1 -1
  11. package/resources/v1/addons/index.d.mts +1 -1
  12. package/resources/v1/addons/index.d.mts.map +1 -1
  13. package/resources/v1/addons/index.d.ts +1 -1
  14. package/resources/v1/addons/index.d.ts.map +1 -1
  15. package/resources/v1/addons/index.js.map +1 -1
  16. package/resources/v1/addons/index.mjs.map +1 -1
  17. package/resources/v1/credits/credits.d.mts +78 -7
  18. package/resources/v1/credits/credits.d.mts.map +1 -1
  19. package/resources/v1/credits/credits.d.ts +78 -7
  20. package/resources/v1/credits/credits.d.ts.map +1 -1
  21. package/resources/v1/credits/credits.js +7 -4
  22. package/resources/v1/credits/credits.js.map +1 -1
  23. package/resources/v1/credits/credits.mjs +7 -4
  24. package/resources/v1/credits/credits.mjs.map +1 -1
  25. package/resources/v1/credits/custom-currencies.d.mts +8 -8
  26. package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
  27. package/resources/v1/credits/custom-currencies.d.ts +8 -8
  28. package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
  29. package/resources/v1/credits/index.d.mts +2 -3
  30. package/resources/v1/credits/index.d.mts.map +1 -1
  31. package/resources/v1/credits/index.d.ts +2 -3
  32. package/resources/v1/credits/index.d.ts.map +1 -1
  33. package/resources/v1/credits/index.js +1 -3
  34. package/resources/v1/credits/index.js.map +1 -1
  35. package/resources/v1/credits/index.mjs +0 -1
  36. package/resources/v1/credits/index.mjs.map +1 -1
  37. package/resources/v1/index.d.mts +3 -3
  38. package/resources/v1/index.d.mts.map +1 -1
  39. package/resources/v1/index.d.ts +3 -3
  40. package/resources/v1/index.d.ts.map +1 -1
  41. package/resources/v1/index.js.map +1 -1
  42. package/resources/v1/index.mjs.map +1 -1
  43. package/resources/v1/plans/index.d.mts +1 -1
  44. package/resources/v1/plans/index.d.mts.map +1 -1
  45. package/resources/v1/plans/index.d.ts +1 -1
  46. package/resources/v1/plans/index.d.ts.map +1 -1
  47. package/resources/v1/plans/index.js.map +1 -1
  48. package/resources/v1/plans/index.mjs.map +1 -1
  49. package/resources/v1/plans/plans.d.mts +343 -1
  50. package/resources/v1/plans/plans.d.mts.map +1 -1
  51. package/resources/v1/plans/plans.d.ts +343 -1
  52. package/resources/v1/plans/plans.d.ts.map +1 -1
  53. package/resources/v1/plans/plans.js +12 -0
  54. package/resources/v1/plans/plans.js.map +1 -1
  55. package/resources/v1/plans/plans.mjs +12 -0
  56. package/resources/v1/plans/plans.mjs.map +1 -1
  57. package/resources/v1/subscriptions/subscriptions.d.mts +12 -9
  58. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  59. package/resources/v1/subscriptions/subscriptions.d.ts +12 -9
  60. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  61. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  62. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  63. package/resources/v1/v1.d.mts +6 -6
  64. package/resources/v1/v1.d.mts.map +1 -1
  65. package/resources/v1/v1.d.ts +6 -6
  66. package/resources/v1/v1.d.ts.map +1 -1
  67. package/resources/v1/v1.js.map +1 -1
  68. package/resources/v1/v1.mjs.map +1 -1
  69. package/src/resources/v1/addons/addons.ts +566 -0
  70. package/src/resources/v1/addons/index.ts +3 -0
  71. package/src/resources/v1/credits/credits.ts +99 -16
  72. package/src/resources/v1/credits/custom-currencies.ts +8 -8
  73. package/src/resources/v1/credits/index.ts +3 -6
  74. package/src/resources/v1/index.ts +11 -0
  75. package/src/resources/v1/plans/index.ts +6 -0
  76. package/src/resources/v1/plans/plans.ts +1132 -0
  77. package/src/resources/v1/subscriptions/subscriptions.ts +12 -9
  78. package/src/resources/v1/v1.ts +22 -0
  79. package/src/version.ts +1 -1
  80. package/version.d.mts +1 -1
  81. package/version.d.ts +1 -1
  82. package/version.js +1 -1
  83. package/version.mjs +1 -1
  84. package/resources/v1/credits/auto-recharge.d.mts +0 -84
  85. package/resources/v1/credits/auto-recharge.d.mts.map +0 -1
  86. package/resources/v1/credits/auto-recharge.d.ts +0 -84
  87. package/resources/v1/credits/auto-recharge.d.ts.map +0 -1
  88. package/resources/v1/credits/auto-recharge.js +0 -16
  89. package/resources/v1/credits/auto-recharge.js.map +0 -1
  90. package/resources/v1/credits/auto-recharge.mjs +0 -12
  91. package/resources/v1/credits/auto-recharge.mjs.map +0 -1
  92. package/src/resources/v1/credits/auto-recharge.ts +0 -109
@@ -69,6 +69,36 @@ export class Plans extends APIResource {
69
69
  return this._client.post(path`/api/v1/plans/${id}/draft`, options);
70
70
  }
71
71
 
72
+ /**
73
+ * Retrieves the list of charges configured on a plan.
74
+ */
75
+ listCharges(
76
+ id: string,
77
+ query: PlanListChargesParams | null | undefined = {},
78
+ options?: RequestOptions,
79
+ ): PagePromise<PlanListChargesResponsesMyCursorIDPage, PlanListChargesResponse> {
80
+ return this._client.getAPIList(
81
+ path`/api/v1/plans/${id}/charges`,
82
+ MyCursorIDPage<PlanListChargesResponse>,
83
+ { query, ...options },
84
+ );
85
+ }
86
+
87
+ /**
88
+ * Retrieves the list of overage charges configured on a plan.
89
+ */
90
+ listOverageCharges(
91
+ id: string,
92
+ query: PlanListOverageChargesParams | null | undefined = {},
93
+ options?: RequestOptions,
94
+ ): PagePromise<PlanListOverageChargesResponsesMyCursorIDPage, PlanListOverageChargesResponse> {
95
+ return this._client.getAPIList(
96
+ path`/api/v1/plans/${id}/overage-charges`,
97
+ MyCursorIDPage<PlanListOverageChargesResponse>,
98
+ { query, ...options },
99
+ );
100
+ }
101
+
72
102
  /**
73
103
  * Publishes a draft plan, making it available for use in subscriptions.
74
104
  */
@@ -86,6 +116,10 @@ export class Plans extends APIResource {
86
116
 
87
117
  export type PlanListResponsesMyCursorIDPage = MyCursorIDPage<PlanListResponse>;
88
118
 
119
+ export type PlanListChargesResponsesMyCursorIDPage = MyCursorIDPage<PlanListChargesResponse>;
120
+
121
+ export type PlanListOverageChargesResponsesMyCursorIDPage = MyCursorIDPage<PlanListOverageChargesResponse>;
122
+
89
123
  /**
90
124
  * Response object
91
125
  */
@@ -374,6 +408,1094 @@ export namespace PlanListResponse {
374
408
  }
375
409
  }
376
410
 
411
+ /**
412
+ * A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
413
+ * billingModel, billingCadence, billingCountryCode) combination. Plans and addons
414
+ * own many of these — one per currency / billing period / feature.
415
+ */
416
+ export interface PlanListChargesResponse {
417
+ /**
418
+ * Unique identifier of the charge
419
+ */
420
+ id: string;
421
+
422
+ /**
423
+ * The billing cadence (RECURRING or ONE_OFF)
424
+ */
425
+ billingCadence: 'RECURRING' | 'ONE_OFF';
426
+
427
+ /**
428
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
429
+ */
430
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
431
+
432
+ /**
433
+ * The billing period (MONTHLY or ANNUALLY)
434
+ */
435
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
436
+
437
+ /**
438
+ * Timestamp when the charge was created
439
+ */
440
+ createdAt: string;
441
+
442
+ /**
443
+ * ISO country code for localized pricing, if any
444
+ */
445
+ billingCountryCode?: string | null;
446
+
447
+ /**
448
+ * Identifier in the external billing integration (e.g. Stripe price id), if any
449
+ */
450
+ billingId?: string | null;
451
+
452
+ /**
453
+ * Block size for usage-based pricing
454
+ */
455
+ blockSize?: number | null;
456
+
457
+ /**
458
+ * When credits are granted (for credit-based pricing)
459
+ */
460
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
461
+
462
+ /**
463
+ * Credit rate configuration for credit-based pricing
464
+ */
465
+ creditRate?: PlanListChargesResponse.CreditRate | null;
466
+
467
+ /**
468
+ * Identifier in the linked CRM, if any
469
+ */
470
+ crmId?: string | null;
471
+
472
+ /**
473
+ * Deep link to the charge in the linked CRM, if any
474
+ */
475
+ crmLinkUrl?: string | null;
476
+
477
+ /**
478
+ * The feature this charge meters, if metered
479
+ */
480
+ featureId?: string | null;
481
+
482
+ /**
483
+ * Maximum unit quantity that can be purchased
484
+ */
485
+ maxUnitQuantity?: number | null;
486
+
487
+ /**
488
+ * Minimum unit quantity that can be purchased
489
+ */
490
+ minUnitQuantity?: number | null;
491
+
492
+ /**
493
+ * The flat price amount and currency, when applicable
494
+ */
495
+ price?: PlanListChargesResponse.Price | null;
496
+
497
+ /**
498
+ * Tiered pricing rows when the charge is tiered
499
+ */
500
+ tiers?: Array<PlanListChargesResponse.Tier> | null;
501
+
502
+ /**
503
+ * Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
504
+ */
505
+ tiersMode?: 'VOLUME' | 'GRADUATED' | null;
506
+
507
+ /**
508
+ * Custom currency identifier for top-up pricing, if any
509
+ */
510
+ topUpCustomCurrencyId?: string | null;
511
+
512
+ /**
513
+ * True if this charge is referenced by at least one subscription
514
+ */
515
+ usedInSubscriptions?: boolean | null;
516
+ }
517
+
518
+ export namespace PlanListChargesResponse {
519
+ /**
520
+ * Credit rate configuration for credit-based pricing
521
+ */
522
+ export interface CreditRate {
523
+ /**
524
+ * Credit rate amount
525
+ */
526
+ amount: number;
527
+
528
+ /**
529
+ * Custom currency identifier
530
+ */
531
+ currencyId: string;
532
+
533
+ /**
534
+ * Optional cost formula expression
535
+ */
536
+ costFormula?: string | null;
537
+ }
538
+
539
+ /**
540
+ * The flat price amount and currency, when applicable
541
+ */
542
+ export interface Price {
543
+ /**
544
+ * The price amount
545
+ */
546
+ amount: number;
547
+
548
+ /**
549
+ * ISO 4217 currency code
550
+ */
551
+ currency:
552
+ | 'usd'
553
+ | 'aed'
554
+ | 'all'
555
+ | 'amd'
556
+ | 'ang'
557
+ | 'aud'
558
+ | 'awg'
559
+ | 'azn'
560
+ | 'bam'
561
+ | 'bbd'
562
+ | 'bdt'
563
+ | 'bgn'
564
+ | 'bif'
565
+ | 'bmd'
566
+ | 'bnd'
567
+ | 'bsd'
568
+ | 'bwp'
569
+ | 'byn'
570
+ | 'bzd'
571
+ | 'brl'
572
+ | 'cad'
573
+ | 'cdf'
574
+ | 'chf'
575
+ | 'cny'
576
+ | 'czk'
577
+ | 'dkk'
578
+ | 'dop'
579
+ | 'dzd'
580
+ | 'egp'
581
+ | 'etb'
582
+ | 'eur'
583
+ | 'fjd'
584
+ | 'gbp'
585
+ | 'gel'
586
+ | 'gip'
587
+ | 'gmd'
588
+ | 'gyd'
589
+ | 'hkd'
590
+ | 'hrk'
591
+ | 'htg'
592
+ | 'idr'
593
+ | 'ils'
594
+ | 'inr'
595
+ | 'isk'
596
+ | 'jmd'
597
+ | 'jpy'
598
+ | 'kes'
599
+ | 'kgs'
600
+ | 'khr'
601
+ | 'kmf'
602
+ | 'krw'
603
+ | 'kyd'
604
+ | 'kzt'
605
+ | 'lbp'
606
+ | 'lkr'
607
+ | 'lrd'
608
+ | 'lsl'
609
+ | 'mad'
610
+ | 'mdl'
611
+ | 'mga'
612
+ | 'mkd'
613
+ | 'mmk'
614
+ | 'mnt'
615
+ | 'mop'
616
+ | 'mro'
617
+ | 'mvr'
618
+ | 'mwk'
619
+ | 'mxn'
620
+ | 'myr'
621
+ | 'mzn'
622
+ | 'nad'
623
+ | 'ngn'
624
+ | 'nok'
625
+ | 'npr'
626
+ | 'nzd'
627
+ | 'pgk'
628
+ | 'php'
629
+ | 'pkr'
630
+ | 'pln'
631
+ | 'qar'
632
+ | 'ron'
633
+ | 'rsd'
634
+ | 'rub'
635
+ | 'rwf'
636
+ | 'sar'
637
+ | 'sbd'
638
+ | 'scr'
639
+ | 'sek'
640
+ | 'sgd'
641
+ | 'sle'
642
+ | 'sll'
643
+ | 'sos'
644
+ | 'szl'
645
+ | 'thb'
646
+ | 'tjs'
647
+ | 'top'
648
+ | 'try'
649
+ | 'ttd'
650
+ | 'tzs'
651
+ | 'uah'
652
+ | 'uzs'
653
+ | 'vnd'
654
+ | 'vuv'
655
+ | 'wst'
656
+ | 'xaf'
657
+ | 'xcd'
658
+ | 'yer'
659
+ | 'zar'
660
+ | 'zmw'
661
+ | 'clp'
662
+ | 'djf'
663
+ | 'gnf'
664
+ | 'ugx'
665
+ | 'pyg'
666
+ | 'xof'
667
+ | 'xpf';
668
+ }
669
+
670
+ /**
671
+ * A single tier within a tiered charge
672
+ */
673
+ export interface Tier {
674
+ /**
675
+ * Flat price for this tier
676
+ */
677
+ flatPrice?: Tier.FlatPrice | null;
678
+
679
+ /**
680
+ * Per-unit price in this tier
681
+ */
682
+ unitPrice?: Tier.UnitPrice | null;
683
+
684
+ /**
685
+ * Upper bound of this tier (null for unlimited)
686
+ */
687
+ upTo?: number | null;
688
+ }
689
+
690
+ export namespace Tier {
691
+ /**
692
+ * Flat price for this tier
693
+ */
694
+ export interface FlatPrice {
695
+ /**
696
+ * The price amount
697
+ */
698
+ amount: number;
699
+
700
+ /**
701
+ * ISO 4217 currency code
702
+ */
703
+ currency:
704
+ | 'usd'
705
+ | 'aed'
706
+ | 'all'
707
+ | 'amd'
708
+ | 'ang'
709
+ | 'aud'
710
+ | 'awg'
711
+ | 'azn'
712
+ | 'bam'
713
+ | 'bbd'
714
+ | 'bdt'
715
+ | 'bgn'
716
+ | 'bif'
717
+ | 'bmd'
718
+ | 'bnd'
719
+ | 'bsd'
720
+ | 'bwp'
721
+ | 'byn'
722
+ | 'bzd'
723
+ | 'brl'
724
+ | 'cad'
725
+ | 'cdf'
726
+ | 'chf'
727
+ | 'cny'
728
+ | 'czk'
729
+ | 'dkk'
730
+ | 'dop'
731
+ | 'dzd'
732
+ | 'egp'
733
+ | 'etb'
734
+ | 'eur'
735
+ | 'fjd'
736
+ | 'gbp'
737
+ | 'gel'
738
+ | 'gip'
739
+ | 'gmd'
740
+ | 'gyd'
741
+ | 'hkd'
742
+ | 'hrk'
743
+ | 'htg'
744
+ | 'idr'
745
+ | 'ils'
746
+ | 'inr'
747
+ | 'isk'
748
+ | 'jmd'
749
+ | 'jpy'
750
+ | 'kes'
751
+ | 'kgs'
752
+ | 'khr'
753
+ | 'kmf'
754
+ | 'krw'
755
+ | 'kyd'
756
+ | 'kzt'
757
+ | 'lbp'
758
+ | 'lkr'
759
+ | 'lrd'
760
+ | 'lsl'
761
+ | 'mad'
762
+ | 'mdl'
763
+ | 'mga'
764
+ | 'mkd'
765
+ | 'mmk'
766
+ | 'mnt'
767
+ | 'mop'
768
+ | 'mro'
769
+ | 'mvr'
770
+ | 'mwk'
771
+ | 'mxn'
772
+ | 'myr'
773
+ | 'mzn'
774
+ | 'nad'
775
+ | 'ngn'
776
+ | 'nok'
777
+ | 'npr'
778
+ | 'nzd'
779
+ | 'pgk'
780
+ | 'php'
781
+ | 'pkr'
782
+ | 'pln'
783
+ | 'qar'
784
+ | 'ron'
785
+ | 'rsd'
786
+ | 'rub'
787
+ | 'rwf'
788
+ | 'sar'
789
+ | 'sbd'
790
+ | 'scr'
791
+ | 'sek'
792
+ | 'sgd'
793
+ | 'sle'
794
+ | 'sll'
795
+ | 'sos'
796
+ | 'szl'
797
+ | 'thb'
798
+ | 'tjs'
799
+ | 'top'
800
+ | 'try'
801
+ | 'ttd'
802
+ | 'tzs'
803
+ | 'uah'
804
+ | 'uzs'
805
+ | 'vnd'
806
+ | 'vuv'
807
+ | 'wst'
808
+ | 'xaf'
809
+ | 'xcd'
810
+ | 'yer'
811
+ | 'zar'
812
+ | 'zmw'
813
+ | 'clp'
814
+ | 'djf'
815
+ | 'gnf'
816
+ | 'ugx'
817
+ | 'pyg'
818
+ | 'xof'
819
+ | 'xpf';
820
+ }
821
+
822
+ /**
823
+ * Per-unit price in this tier
824
+ */
825
+ export interface UnitPrice {
826
+ /**
827
+ * The price amount
828
+ */
829
+ amount: number;
830
+
831
+ /**
832
+ * ISO 4217 currency code
833
+ */
834
+ currency:
835
+ | 'usd'
836
+ | 'aed'
837
+ | 'all'
838
+ | 'amd'
839
+ | 'ang'
840
+ | 'aud'
841
+ | 'awg'
842
+ | 'azn'
843
+ | 'bam'
844
+ | 'bbd'
845
+ | 'bdt'
846
+ | 'bgn'
847
+ | 'bif'
848
+ | 'bmd'
849
+ | 'bnd'
850
+ | 'bsd'
851
+ | 'bwp'
852
+ | 'byn'
853
+ | 'bzd'
854
+ | 'brl'
855
+ | 'cad'
856
+ | 'cdf'
857
+ | 'chf'
858
+ | 'cny'
859
+ | 'czk'
860
+ | 'dkk'
861
+ | 'dop'
862
+ | 'dzd'
863
+ | 'egp'
864
+ | 'etb'
865
+ | 'eur'
866
+ | 'fjd'
867
+ | 'gbp'
868
+ | 'gel'
869
+ | 'gip'
870
+ | 'gmd'
871
+ | 'gyd'
872
+ | 'hkd'
873
+ | 'hrk'
874
+ | 'htg'
875
+ | 'idr'
876
+ | 'ils'
877
+ | 'inr'
878
+ | 'isk'
879
+ | 'jmd'
880
+ | 'jpy'
881
+ | 'kes'
882
+ | 'kgs'
883
+ | 'khr'
884
+ | 'kmf'
885
+ | 'krw'
886
+ | 'kyd'
887
+ | 'kzt'
888
+ | 'lbp'
889
+ | 'lkr'
890
+ | 'lrd'
891
+ | 'lsl'
892
+ | 'mad'
893
+ | 'mdl'
894
+ | 'mga'
895
+ | 'mkd'
896
+ | 'mmk'
897
+ | 'mnt'
898
+ | 'mop'
899
+ | 'mro'
900
+ | 'mvr'
901
+ | 'mwk'
902
+ | 'mxn'
903
+ | 'myr'
904
+ | 'mzn'
905
+ | 'nad'
906
+ | 'ngn'
907
+ | 'nok'
908
+ | 'npr'
909
+ | 'nzd'
910
+ | 'pgk'
911
+ | 'php'
912
+ | 'pkr'
913
+ | 'pln'
914
+ | 'qar'
915
+ | 'ron'
916
+ | 'rsd'
917
+ | 'rub'
918
+ | 'rwf'
919
+ | 'sar'
920
+ | 'sbd'
921
+ | 'scr'
922
+ | 'sek'
923
+ | 'sgd'
924
+ | 'sle'
925
+ | 'sll'
926
+ | 'sos'
927
+ | 'szl'
928
+ | 'thb'
929
+ | 'tjs'
930
+ | 'top'
931
+ | 'try'
932
+ | 'ttd'
933
+ | 'tzs'
934
+ | 'uah'
935
+ | 'uzs'
936
+ | 'vnd'
937
+ | 'vuv'
938
+ | 'wst'
939
+ | 'xaf'
940
+ | 'xcd'
941
+ | 'yer'
942
+ | 'zar'
943
+ | 'zmw'
944
+ | 'clp'
945
+ | 'djf'
946
+ | 'gnf'
947
+ | 'ugx'
948
+ | 'pyg'
949
+ | 'xof'
950
+ | 'xpf';
951
+ }
952
+ }
953
+ }
954
+
955
+ /**
956
+ * A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
957
+ * billingModel, billingCadence, billingCountryCode) combination. Plans and addons
958
+ * own many of these — one per currency / billing period / feature.
959
+ */
960
+ export interface PlanListOverageChargesResponse {
961
+ /**
962
+ * Unique identifier of the charge
963
+ */
964
+ id: string;
965
+
966
+ /**
967
+ * The billing cadence (RECURRING or ONE_OFF)
968
+ */
969
+ billingCadence: 'RECURRING' | 'ONE_OFF';
970
+
971
+ /**
972
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
973
+ */
974
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
975
+
976
+ /**
977
+ * The billing period (MONTHLY or ANNUALLY)
978
+ */
979
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
980
+
981
+ /**
982
+ * Timestamp when the charge was created
983
+ */
984
+ createdAt: string;
985
+
986
+ /**
987
+ * ISO country code for localized pricing, if any
988
+ */
989
+ billingCountryCode?: string | null;
990
+
991
+ /**
992
+ * Identifier in the external billing integration (e.g. Stripe price id), if any
993
+ */
994
+ billingId?: string | null;
995
+
996
+ /**
997
+ * Block size for usage-based pricing
998
+ */
999
+ blockSize?: number | null;
1000
+
1001
+ /**
1002
+ * When credits are granted (for credit-based pricing)
1003
+ */
1004
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
1005
+
1006
+ /**
1007
+ * Credit rate configuration for credit-based pricing
1008
+ */
1009
+ creditRate?: PlanListOverageChargesResponse.CreditRate | null;
1010
+
1011
+ /**
1012
+ * Identifier in the linked CRM, if any
1013
+ */
1014
+ crmId?: string | null;
1015
+
1016
+ /**
1017
+ * Deep link to the charge in the linked CRM, if any
1018
+ */
1019
+ crmLinkUrl?: string | null;
1020
+
1021
+ /**
1022
+ * The feature this charge meters, if metered
1023
+ */
1024
+ featureId?: string | null;
1025
+
1026
+ /**
1027
+ * Maximum unit quantity that can be purchased
1028
+ */
1029
+ maxUnitQuantity?: number | null;
1030
+
1031
+ /**
1032
+ * Minimum unit quantity that can be purchased
1033
+ */
1034
+ minUnitQuantity?: number | null;
1035
+
1036
+ /**
1037
+ * The flat price amount and currency, when applicable
1038
+ */
1039
+ price?: PlanListOverageChargesResponse.Price | null;
1040
+
1041
+ /**
1042
+ * Tiered pricing rows when the charge is tiered
1043
+ */
1044
+ tiers?: Array<PlanListOverageChargesResponse.Tier> | null;
1045
+
1046
+ /**
1047
+ * Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
1048
+ */
1049
+ tiersMode?: 'VOLUME' | 'GRADUATED' | null;
1050
+
1051
+ /**
1052
+ * Custom currency identifier for top-up pricing, if any
1053
+ */
1054
+ topUpCustomCurrencyId?: string | null;
1055
+
1056
+ /**
1057
+ * True if this charge is referenced by at least one subscription
1058
+ */
1059
+ usedInSubscriptions?: boolean | null;
1060
+ }
1061
+
1062
+ export namespace PlanListOverageChargesResponse {
1063
+ /**
1064
+ * Credit rate configuration for credit-based pricing
1065
+ */
1066
+ export interface CreditRate {
1067
+ /**
1068
+ * Credit rate amount
1069
+ */
1070
+ amount: number;
1071
+
1072
+ /**
1073
+ * Custom currency identifier
1074
+ */
1075
+ currencyId: string;
1076
+
1077
+ /**
1078
+ * Optional cost formula expression
1079
+ */
1080
+ costFormula?: string | null;
1081
+ }
1082
+
1083
+ /**
1084
+ * The flat price amount and currency, when applicable
1085
+ */
1086
+ export interface Price {
1087
+ /**
1088
+ * The price amount
1089
+ */
1090
+ amount: number;
1091
+
1092
+ /**
1093
+ * ISO 4217 currency code
1094
+ */
1095
+ currency:
1096
+ | 'usd'
1097
+ | 'aed'
1098
+ | 'all'
1099
+ | 'amd'
1100
+ | 'ang'
1101
+ | 'aud'
1102
+ | 'awg'
1103
+ | 'azn'
1104
+ | 'bam'
1105
+ | 'bbd'
1106
+ | 'bdt'
1107
+ | 'bgn'
1108
+ | 'bif'
1109
+ | 'bmd'
1110
+ | 'bnd'
1111
+ | 'bsd'
1112
+ | 'bwp'
1113
+ | 'byn'
1114
+ | 'bzd'
1115
+ | 'brl'
1116
+ | 'cad'
1117
+ | 'cdf'
1118
+ | 'chf'
1119
+ | 'cny'
1120
+ | 'czk'
1121
+ | 'dkk'
1122
+ | 'dop'
1123
+ | 'dzd'
1124
+ | 'egp'
1125
+ | 'etb'
1126
+ | 'eur'
1127
+ | 'fjd'
1128
+ | 'gbp'
1129
+ | 'gel'
1130
+ | 'gip'
1131
+ | 'gmd'
1132
+ | 'gyd'
1133
+ | 'hkd'
1134
+ | 'hrk'
1135
+ | 'htg'
1136
+ | 'idr'
1137
+ | 'ils'
1138
+ | 'inr'
1139
+ | 'isk'
1140
+ | 'jmd'
1141
+ | 'jpy'
1142
+ | 'kes'
1143
+ | 'kgs'
1144
+ | 'khr'
1145
+ | 'kmf'
1146
+ | 'krw'
1147
+ | 'kyd'
1148
+ | 'kzt'
1149
+ | 'lbp'
1150
+ | 'lkr'
1151
+ | 'lrd'
1152
+ | 'lsl'
1153
+ | 'mad'
1154
+ | 'mdl'
1155
+ | 'mga'
1156
+ | 'mkd'
1157
+ | 'mmk'
1158
+ | 'mnt'
1159
+ | 'mop'
1160
+ | 'mro'
1161
+ | 'mvr'
1162
+ | 'mwk'
1163
+ | 'mxn'
1164
+ | 'myr'
1165
+ | 'mzn'
1166
+ | 'nad'
1167
+ | 'ngn'
1168
+ | 'nok'
1169
+ | 'npr'
1170
+ | 'nzd'
1171
+ | 'pgk'
1172
+ | 'php'
1173
+ | 'pkr'
1174
+ | 'pln'
1175
+ | 'qar'
1176
+ | 'ron'
1177
+ | 'rsd'
1178
+ | 'rub'
1179
+ | 'rwf'
1180
+ | 'sar'
1181
+ | 'sbd'
1182
+ | 'scr'
1183
+ | 'sek'
1184
+ | 'sgd'
1185
+ | 'sle'
1186
+ | 'sll'
1187
+ | 'sos'
1188
+ | 'szl'
1189
+ | 'thb'
1190
+ | 'tjs'
1191
+ | 'top'
1192
+ | 'try'
1193
+ | 'ttd'
1194
+ | 'tzs'
1195
+ | 'uah'
1196
+ | 'uzs'
1197
+ | 'vnd'
1198
+ | 'vuv'
1199
+ | 'wst'
1200
+ | 'xaf'
1201
+ | 'xcd'
1202
+ | 'yer'
1203
+ | 'zar'
1204
+ | 'zmw'
1205
+ | 'clp'
1206
+ | 'djf'
1207
+ | 'gnf'
1208
+ | 'ugx'
1209
+ | 'pyg'
1210
+ | 'xof'
1211
+ | 'xpf';
1212
+ }
1213
+
1214
+ /**
1215
+ * A single tier within a tiered charge
1216
+ */
1217
+ export interface Tier {
1218
+ /**
1219
+ * Flat price for this tier
1220
+ */
1221
+ flatPrice?: Tier.FlatPrice | null;
1222
+
1223
+ /**
1224
+ * Per-unit price in this tier
1225
+ */
1226
+ unitPrice?: Tier.UnitPrice | null;
1227
+
1228
+ /**
1229
+ * Upper bound of this tier (null for unlimited)
1230
+ */
1231
+ upTo?: number | null;
1232
+ }
1233
+
1234
+ export namespace Tier {
1235
+ /**
1236
+ * Flat price for this tier
1237
+ */
1238
+ export interface FlatPrice {
1239
+ /**
1240
+ * The price amount
1241
+ */
1242
+ amount: number;
1243
+
1244
+ /**
1245
+ * ISO 4217 currency code
1246
+ */
1247
+ currency:
1248
+ | 'usd'
1249
+ | 'aed'
1250
+ | 'all'
1251
+ | 'amd'
1252
+ | 'ang'
1253
+ | 'aud'
1254
+ | 'awg'
1255
+ | 'azn'
1256
+ | 'bam'
1257
+ | 'bbd'
1258
+ | 'bdt'
1259
+ | 'bgn'
1260
+ | 'bif'
1261
+ | 'bmd'
1262
+ | 'bnd'
1263
+ | 'bsd'
1264
+ | 'bwp'
1265
+ | 'byn'
1266
+ | 'bzd'
1267
+ | 'brl'
1268
+ | 'cad'
1269
+ | 'cdf'
1270
+ | 'chf'
1271
+ | 'cny'
1272
+ | 'czk'
1273
+ | 'dkk'
1274
+ | 'dop'
1275
+ | 'dzd'
1276
+ | 'egp'
1277
+ | 'etb'
1278
+ | 'eur'
1279
+ | 'fjd'
1280
+ | 'gbp'
1281
+ | 'gel'
1282
+ | 'gip'
1283
+ | 'gmd'
1284
+ | 'gyd'
1285
+ | 'hkd'
1286
+ | 'hrk'
1287
+ | 'htg'
1288
+ | 'idr'
1289
+ | 'ils'
1290
+ | 'inr'
1291
+ | 'isk'
1292
+ | 'jmd'
1293
+ | 'jpy'
1294
+ | 'kes'
1295
+ | 'kgs'
1296
+ | 'khr'
1297
+ | 'kmf'
1298
+ | 'krw'
1299
+ | 'kyd'
1300
+ | 'kzt'
1301
+ | 'lbp'
1302
+ | 'lkr'
1303
+ | 'lrd'
1304
+ | 'lsl'
1305
+ | 'mad'
1306
+ | 'mdl'
1307
+ | 'mga'
1308
+ | 'mkd'
1309
+ | 'mmk'
1310
+ | 'mnt'
1311
+ | 'mop'
1312
+ | 'mro'
1313
+ | 'mvr'
1314
+ | 'mwk'
1315
+ | 'mxn'
1316
+ | 'myr'
1317
+ | 'mzn'
1318
+ | 'nad'
1319
+ | 'ngn'
1320
+ | 'nok'
1321
+ | 'npr'
1322
+ | 'nzd'
1323
+ | 'pgk'
1324
+ | 'php'
1325
+ | 'pkr'
1326
+ | 'pln'
1327
+ | 'qar'
1328
+ | 'ron'
1329
+ | 'rsd'
1330
+ | 'rub'
1331
+ | 'rwf'
1332
+ | 'sar'
1333
+ | 'sbd'
1334
+ | 'scr'
1335
+ | 'sek'
1336
+ | 'sgd'
1337
+ | 'sle'
1338
+ | 'sll'
1339
+ | 'sos'
1340
+ | 'szl'
1341
+ | 'thb'
1342
+ | 'tjs'
1343
+ | 'top'
1344
+ | 'try'
1345
+ | 'ttd'
1346
+ | 'tzs'
1347
+ | 'uah'
1348
+ | 'uzs'
1349
+ | 'vnd'
1350
+ | 'vuv'
1351
+ | 'wst'
1352
+ | 'xaf'
1353
+ | 'xcd'
1354
+ | 'yer'
1355
+ | 'zar'
1356
+ | 'zmw'
1357
+ | 'clp'
1358
+ | 'djf'
1359
+ | 'gnf'
1360
+ | 'ugx'
1361
+ | 'pyg'
1362
+ | 'xof'
1363
+ | 'xpf';
1364
+ }
1365
+
1366
+ /**
1367
+ * Per-unit price in this tier
1368
+ */
1369
+ export interface UnitPrice {
1370
+ /**
1371
+ * The price amount
1372
+ */
1373
+ amount: number;
1374
+
1375
+ /**
1376
+ * ISO 4217 currency code
1377
+ */
1378
+ currency:
1379
+ | 'usd'
1380
+ | 'aed'
1381
+ | 'all'
1382
+ | 'amd'
1383
+ | 'ang'
1384
+ | 'aud'
1385
+ | 'awg'
1386
+ | 'azn'
1387
+ | 'bam'
1388
+ | 'bbd'
1389
+ | 'bdt'
1390
+ | 'bgn'
1391
+ | 'bif'
1392
+ | 'bmd'
1393
+ | 'bnd'
1394
+ | 'bsd'
1395
+ | 'bwp'
1396
+ | 'byn'
1397
+ | 'bzd'
1398
+ | 'brl'
1399
+ | 'cad'
1400
+ | 'cdf'
1401
+ | 'chf'
1402
+ | 'cny'
1403
+ | 'czk'
1404
+ | 'dkk'
1405
+ | 'dop'
1406
+ | 'dzd'
1407
+ | 'egp'
1408
+ | 'etb'
1409
+ | 'eur'
1410
+ | 'fjd'
1411
+ | 'gbp'
1412
+ | 'gel'
1413
+ | 'gip'
1414
+ | 'gmd'
1415
+ | 'gyd'
1416
+ | 'hkd'
1417
+ | 'hrk'
1418
+ | 'htg'
1419
+ | 'idr'
1420
+ | 'ils'
1421
+ | 'inr'
1422
+ | 'isk'
1423
+ | 'jmd'
1424
+ | 'jpy'
1425
+ | 'kes'
1426
+ | 'kgs'
1427
+ | 'khr'
1428
+ | 'kmf'
1429
+ | 'krw'
1430
+ | 'kyd'
1431
+ | 'kzt'
1432
+ | 'lbp'
1433
+ | 'lkr'
1434
+ | 'lrd'
1435
+ | 'lsl'
1436
+ | 'mad'
1437
+ | 'mdl'
1438
+ | 'mga'
1439
+ | 'mkd'
1440
+ | 'mmk'
1441
+ | 'mnt'
1442
+ | 'mop'
1443
+ | 'mro'
1444
+ | 'mvr'
1445
+ | 'mwk'
1446
+ | 'mxn'
1447
+ | 'myr'
1448
+ | 'mzn'
1449
+ | 'nad'
1450
+ | 'ngn'
1451
+ | 'nok'
1452
+ | 'npr'
1453
+ | 'nzd'
1454
+ | 'pgk'
1455
+ | 'php'
1456
+ | 'pkr'
1457
+ | 'pln'
1458
+ | 'qar'
1459
+ | 'ron'
1460
+ | 'rsd'
1461
+ | 'rub'
1462
+ | 'rwf'
1463
+ | 'sar'
1464
+ | 'sbd'
1465
+ | 'scr'
1466
+ | 'sek'
1467
+ | 'sgd'
1468
+ | 'sle'
1469
+ | 'sll'
1470
+ | 'sos'
1471
+ | 'szl'
1472
+ | 'thb'
1473
+ | 'tjs'
1474
+ | 'top'
1475
+ | 'try'
1476
+ | 'ttd'
1477
+ | 'tzs'
1478
+ | 'uah'
1479
+ | 'uzs'
1480
+ | 'vnd'
1481
+ | 'vuv'
1482
+ | 'wst'
1483
+ | 'xaf'
1484
+ | 'xcd'
1485
+ | 'yer'
1486
+ | 'zar'
1487
+ | 'zmw'
1488
+ | 'clp'
1489
+ | 'djf'
1490
+ | 'gnf'
1491
+ | 'ugx'
1492
+ | 'pyg'
1493
+ | 'xof'
1494
+ | 'xpf';
1495
+ }
1496
+ }
1497
+ }
1498
+
377
1499
  /**
378
1500
  * Response containing task ID for publish operation
379
1501
  */
@@ -1995,6 +3117,10 @@ export namespace PlanListParams {
1995
3117
  }
1996
3118
  }
1997
3119
 
3120
+ export interface PlanListChargesParams extends MyCursorIDPageParams {}
3121
+
3122
+ export interface PlanListOverageChargesParams extends MyCursorIDPageParams {}
3123
+
1998
3124
  export interface PlanPublishParams {
1999
3125
  /**
2000
3126
  * The migration type of the package
@@ -2008,12 +3134,18 @@ export declare namespace Plans {
2008
3134
  export {
2009
3135
  type Plan as Plan,
2010
3136
  type PlanListResponse as PlanListResponse,
3137
+ type PlanListChargesResponse as PlanListChargesResponse,
3138
+ type PlanListOverageChargesResponse as PlanListOverageChargesResponse,
2011
3139
  type PlanPublishResponse as PlanPublishResponse,
2012
3140
  type PlanRemoveDraftResponse as PlanRemoveDraftResponse,
2013
3141
  type PlanListResponsesMyCursorIDPage as PlanListResponsesMyCursorIDPage,
3142
+ type PlanListChargesResponsesMyCursorIDPage as PlanListChargesResponsesMyCursorIDPage,
3143
+ type PlanListOverageChargesResponsesMyCursorIDPage as PlanListOverageChargesResponsesMyCursorIDPage,
2014
3144
  type PlanCreateParams as PlanCreateParams,
2015
3145
  type PlanUpdateParams as PlanUpdateParams,
2016
3146
  type PlanListParams as PlanListParams,
3147
+ type PlanListChargesParams as PlanListChargesParams,
3148
+ type PlanListOverageChargesParams as PlanListOverageChargesParams,
2017
3149
  type PlanPublishParams as PlanPublishParams,
2018
3150
  };
2019
3151