@stigg/typescript 0.1.0-alpha.21 → 0.1.0-alpha.23

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 (112) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/package.json +1 -1
  3. package/resources/v1/addons/addons.d.mts +493 -970
  4. package/resources/v1/addons/addons.d.mts.map +1 -1
  5. package/resources/v1/addons/addons.d.ts +493 -970
  6. package/resources/v1/addons/addons.d.ts.map +1 -1
  7. package/resources/v1/addons/addons.js +0 -6
  8. package/resources/v1/addons/addons.js.map +1 -1
  9. package/resources/v1/addons/addons.mjs +0 -6
  10. package/resources/v1/addons/addons.mjs.map +1 -1
  11. package/resources/v1/addons/entitlements.d.mts +28 -0
  12. package/resources/v1/addons/entitlements.d.mts.map +1 -1
  13. package/resources/v1/addons/entitlements.d.ts +28 -0
  14. package/resources/v1/addons/entitlements.d.ts.map +1 -1
  15. package/resources/v1/addons/index.d.mts +1 -1
  16. package/resources/v1/addons/index.d.mts.map +1 -1
  17. package/resources/v1/addons/index.d.ts +1 -1
  18. package/resources/v1/addons/index.d.ts.map +1 -1
  19. package/resources/v1/addons/index.js.map +1 -1
  20. package/resources/v1/addons/index.mjs.map +1 -1
  21. package/resources/v1/coupons.d.mts +3 -3
  22. package/resources/v1/coupons.d.ts +3 -3
  23. package/resources/v1/customers/customers.d.mts +935 -5
  24. package/resources/v1/customers/customers.d.mts.map +1 -1
  25. package/resources/v1/customers/customers.d.ts +935 -5
  26. package/resources/v1/customers/customers.d.ts.map +1 -1
  27. package/resources/v1/customers/customers.js +7 -0
  28. package/resources/v1/customers/customers.js.map +1 -1
  29. package/resources/v1/customers/customers.mjs +7 -0
  30. package/resources/v1/customers/customers.mjs.map +1 -1
  31. package/resources/v1/customers/index.d.mts +1 -1
  32. package/resources/v1/customers/index.d.mts.map +1 -1
  33. package/resources/v1/customers/index.d.ts +1 -1
  34. package/resources/v1/customers/index.d.ts.map +1 -1
  35. package/resources/v1/customers/index.js.map +1 -1
  36. package/resources/v1/customers/index.mjs.map +1 -1
  37. package/resources/v1/events/credits/credits.d.mts +1 -1
  38. package/resources/v1/events/credits/credits.d.mts.map +1 -1
  39. package/resources/v1/events/credits/credits.d.ts +1 -1
  40. package/resources/v1/events/credits/credits.d.ts.map +1 -1
  41. package/resources/v1/events/credits/credits.js.map +1 -1
  42. package/resources/v1/events/credits/credits.mjs.map +1 -1
  43. package/resources/v1/events/credits/grants.d.mts +1 -1
  44. package/resources/v1/events/credits/grants.d.ts +1 -1
  45. package/resources/v1/features.d.mts +9 -0
  46. package/resources/v1/features.d.mts.map +1 -1
  47. package/resources/v1/features.d.ts +9 -0
  48. package/resources/v1/features.d.ts.map +1 -1
  49. package/resources/v1/index.d.mts +3 -3
  50. package/resources/v1/index.d.mts.map +1 -1
  51. package/resources/v1/index.d.ts +3 -3
  52. package/resources/v1/index.d.ts.map +1 -1
  53. package/resources/v1/index.js.map +1 -1
  54. package/resources/v1/index.mjs.map +1 -1
  55. package/resources/v1/plans/entitlements.d.mts +28 -0
  56. package/resources/v1/plans/entitlements.d.mts.map +1 -1
  57. package/resources/v1/plans/entitlements.d.ts +28 -0
  58. package/resources/v1/plans/entitlements.d.ts.map +1 -1
  59. package/resources/v1/plans/index.d.mts +1 -1
  60. package/resources/v1/plans/index.d.mts.map +1 -1
  61. package/resources/v1/plans/index.d.ts +1 -1
  62. package/resources/v1/plans/index.d.ts.map +1 -1
  63. package/resources/v1/plans/index.js.map +1 -1
  64. package/resources/v1/plans/index.mjs.map +1 -1
  65. package/resources/v1/plans/plans.d.mts +392 -391
  66. package/resources/v1/plans/plans.d.mts.map +1 -1
  67. package/resources/v1/plans/plans.d.ts +392 -391
  68. package/resources/v1/plans/plans.d.ts.map +1 -1
  69. package/resources/v1/plans/plans.js +0 -7
  70. package/resources/v1/plans/plans.js.map +1 -1
  71. package/resources/v1/plans/plans.mjs +0 -7
  72. package/resources/v1/plans/plans.mjs.map +1 -1
  73. package/resources/v1/products.d.mts +9 -5
  74. package/resources/v1/products.d.mts.map +1 -1
  75. package/resources/v1/products.d.ts +9 -5
  76. package/resources/v1/products.d.ts.map +1 -1
  77. package/resources/v1/subscriptions/subscriptions.d.mts +31 -21
  78. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  79. package/resources/v1/subscriptions/subscriptions.d.ts +31 -21
  80. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  81. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  82. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  83. package/resources/v1/usage.d.mts +1 -1
  84. package/resources/v1/usage.d.ts +1 -1
  85. package/resources/v1/v1.d.mts +6 -6
  86. package/resources/v1/v1.d.mts.map +1 -1
  87. package/resources/v1/v1.d.ts +6 -6
  88. package/resources/v1/v1.d.ts.map +1 -1
  89. package/resources/v1/v1.js.map +1 -1
  90. package/resources/v1/v1.mjs.map +1 -1
  91. package/src/resources/v1/addons/addons.ts +1111 -2508
  92. package/src/resources/v1/addons/entitlements.ts +33 -0
  93. package/src/resources/v1/addons/index.ts +0 -3
  94. package/src/resources/v1/coupons.ts +3 -3
  95. package/src/resources/v1/customers/customers.ts +2064 -4
  96. package/src/resources/v1/customers/index.ts +2 -0
  97. package/src/resources/v1/events/credits/credits.ts +3 -1
  98. package/src/resources/v1/events/credits/grants.ts +1 -1
  99. package/src/resources/v1/features.ts +9 -0
  100. package/src/resources/v1/index.ts +2 -4
  101. package/src/resources/v1/plans/entitlements.ts +33 -0
  102. package/src/resources/v1/plans/index.ts +0 -1
  103. package/src/resources/v1/plans/plans.ts +924 -930
  104. package/src/resources/v1/products.ts +9 -5
  105. package/src/resources/v1/subscriptions/subscriptions.ts +28 -22
  106. package/src/resources/v1/usage.ts +1 -1
  107. package/src/resources/v1/v1.ts +4 -8
  108. package/src/version.ts +1 -1
  109. package/version.d.mts +1 -1
  110. package/version.d.ts +1 -1
  111. package/version.js +1 -1
  112. package/version.mjs +1 -1
@@ -1,7 +1,6 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  import { APIResource } from '../../../core/resource';
4
- import * as AddonsAPI from '../addons/addons';
5
4
  import * as EntitlementsAPI from './entitlements';
6
5
  import {
7
6
  EntitlementCreateParams,
@@ -83,18 +82,6 @@ export class Plans extends APIResource {
83
82
  removeDraft(id: string, options?: RequestOptions): APIPromise<PlanRemoveDraftResponse> {
84
83
  return this._client.delete(path`/api/v1/plans/${id}/draft`, options);
85
84
  }
86
-
87
- /**
88
- * Sets the pricing configuration for a plan, including pricing models, overage
89
- * pricing, and minimum spend.
90
- */
91
- setPricing(
92
- id: string,
93
- body: PlanSetPricingParams,
94
- options?: RequestOptions,
95
- ): APIPromise<AddonsAPI.SetPackagePricingResponse> {
96
- return this._client.put(path`/api/v1/plans/${id}/charges`, { body, ...options });
97
- }
98
85
  }
99
86
 
100
87
  export type PlanListResponsesMyCursorIDPage = MyCursorIDPage<PlanListResponse>;
@@ -521,6 +508,11 @@ export interface PlanUpdateParams {
521
508
  */
522
509
  billingId?: string | null;
523
510
 
511
+ /**
512
+ * Pricing configuration to set on the plan draft
513
+ */
514
+ charges?: PlanUpdateParams.Charges;
515
+
524
516
  compatibleAddonIds?: Array<string> | null;
525
517
 
526
518
  /**
@@ -551,381 +543,61 @@ export interface PlanUpdateParams {
551
543
 
552
544
  export namespace PlanUpdateParams {
553
545
  /**
554
- * Default trial configuration for the plan
555
- */
556
- export interface DefaultTrialConfig {
557
- /**
558
- * The duration of the trial in the specified units
559
- */
560
- duration: number;
561
-
562
- /**
563
- * The time unit for the trial duration (DAY or MONTH)
564
- */
565
- units: 'DAY' | 'MONTH';
566
-
567
- /**
568
- * Budget configuration for the trial
569
- */
570
- budget?: DefaultTrialConfig.Budget | null;
571
-
572
- /**
573
- * Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)
574
- */
575
- trialEndBehavior?: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION' | null;
576
- }
577
-
578
- export namespace DefaultTrialConfig {
579
- /**
580
- * Budget configuration for the trial
581
- */
582
- export interface Budget {
583
- /**
584
- * Whether the budget limit is a soft limit (allows overage) or hard limit
585
- */
586
- hasSoftLimit: boolean;
587
-
588
- /**
589
- * The budget limit amount
590
- */
591
- limit: number;
592
- }
593
- }
594
- }
595
-
596
- export interface PlanListParams extends MyCursorIDPageParams {
597
- /**
598
- * Filter by creation date using range operators: gt, gte, lt, lte
599
- */
600
- createdAt?: PlanListParams.CreatedAt;
601
-
602
- /**
603
- * Filter by product ID
604
- */
605
- productId?: string;
606
-
607
- /**
608
- * Filter by status. Supports comma-separated values for multiple statuses
609
- */
610
- status?: string;
611
- }
612
-
613
- export namespace PlanListParams {
614
- /**
615
- * Filter by creation date using range operators: gt, gte, lt, lte
616
- */
617
- export interface CreatedAt {
618
- /**
619
- * Greater than the specified createdAt value
620
- */
621
- gt?: string;
622
-
623
- /**
624
- * Greater than or equal to the specified createdAt value
625
- */
626
- gte?: string;
627
-
628
- /**
629
- * Less than the specified createdAt value
630
- */
631
- lt?: string;
632
-
633
- /**
634
- * Less than or equal to the specified createdAt value
635
- */
636
- lte?: string;
637
- }
638
- }
639
-
640
- export interface PlanPublishParams {
641
- /**
642
- * The migration type of the package
643
- */
644
- migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
645
- }
646
-
647
- export interface PlanSetPricingParams {
648
- /**
649
- * The pricing type (FREE, PAID, or CUSTOM)
650
- */
651
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
652
-
653
- /**
654
- * Deprecated: billing integration ID
655
- */
656
- billingId?: string;
657
-
658
- /**
659
- * Minimum spend configuration per billing period
660
- */
661
- minimumSpend?: Array<PlanSetPricingParams.MinimumSpend> | null;
662
-
663
- /**
664
- * When overage charges are billed
665
- */
666
- overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
667
-
668
- /**
669
- * Array of overage pricing model configurations
670
- */
671
- overagePricingModels?: Array<PlanSetPricingParams.OveragePricingModel>;
672
-
673
- /**
674
- * Array of pricing model configurations
675
- */
676
- pricingModels?: Array<PlanSetPricingParams.PricingModel>;
677
- }
678
-
679
- export namespace PlanSetPricingParams {
680
- /**
681
- * Minimum spend configuration for a billing period.
682
- */
683
- export interface MinimumSpend {
684
- /**
685
- * The billing period
686
- */
687
- billingPeriod: 'MONTHLY' | 'ANNUALLY';
688
-
689
- /**
690
- * The minimum spend amount
691
- */
692
- minimum: MinimumSpend.Minimum;
693
- }
694
-
695
- export namespace MinimumSpend {
696
- /**
697
- * The minimum spend amount
698
- */
699
- export interface Minimum {
700
- /**
701
- * The price amount
702
- */
703
- amount: number;
704
-
705
- /**
706
- * The price currency
707
- */
708
- currency?:
709
- | 'usd'
710
- | 'aed'
711
- | 'all'
712
- | 'amd'
713
- | 'ang'
714
- | 'aud'
715
- | 'awg'
716
- | 'azn'
717
- | 'bam'
718
- | 'bbd'
719
- | 'bdt'
720
- | 'bgn'
721
- | 'bif'
722
- | 'bmd'
723
- | 'bnd'
724
- | 'bsd'
725
- | 'bwp'
726
- | 'byn'
727
- | 'bzd'
728
- | 'brl'
729
- | 'cad'
730
- | 'cdf'
731
- | 'chf'
732
- | 'cny'
733
- | 'czk'
734
- | 'dkk'
735
- | 'dop'
736
- | 'dzd'
737
- | 'egp'
738
- | 'etb'
739
- | 'eur'
740
- | 'fjd'
741
- | 'gbp'
742
- | 'gel'
743
- | 'gip'
744
- | 'gmd'
745
- | 'gyd'
746
- | 'hkd'
747
- | 'hrk'
748
- | 'htg'
749
- | 'idr'
750
- | 'ils'
751
- | 'inr'
752
- | 'isk'
753
- | 'jmd'
754
- | 'jpy'
755
- | 'kes'
756
- | 'kgs'
757
- | 'khr'
758
- | 'kmf'
759
- | 'krw'
760
- | 'kyd'
761
- | 'kzt'
762
- | 'lbp'
763
- | 'lkr'
764
- | 'lrd'
765
- | 'lsl'
766
- | 'mad'
767
- | 'mdl'
768
- | 'mga'
769
- | 'mkd'
770
- | 'mmk'
771
- | 'mnt'
772
- | 'mop'
773
- | 'mro'
774
- | 'mvr'
775
- | 'mwk'
776
- | 'mxn'
777
- | 'myr'
778
- | 'mzn'
779
- | 'nad'
780
- | 'ngn'
781
- | 'nok'
782
- | 'npr'
783
- | 'nzd'
784
- | 'pgk'
785
- | 'php'
786
- | 'pkr'
787
- | 'pln'
788
- | 'qar'
789
- | 'ron'
790
- | 'rsd'
791
- | 'rub'
792
- | 'rwf'
793
- | 'sar'
794
- | 'sbd'
795
- | 'scr'
796
- | 'sek'
797
- | 'sgd'
798
- | 'sle'
799
- | 'sll'
800
- | 'sos'
801
- | 'szl'
802
- | 'thb'
803
- | 'tjs'
804
- | 'top'
805
- | 'try'
806
- | 'ttd'
807
- | 'tzs'
808
- | 'uah'
809
- | 'uzs'
810
- | 'vnd'
811
- | 'vuv'
812
- | 'wst'
813
- | 'xaf'
814
- | 'xcd'
815
- | 'yer'
816
- | 'zar'
817
- | 'zmw'
818
- | 'clp'
819
- | 'djf'
820
- | 'gnf'
821
- | 'ugx'
822
- | 'pyg'
823
- | 'xof'
824
- | 'xpf';
825
- }
826
- }
827
-
828
- /**
829
- * Overage pricing model configuration.
546
+ * Pricing configuration to set on the plan draft
830
547
  */
831
- export interface OveragePricingModel {
548
+ export interface Charges {
832
549
  /**
833
- * The billing model for overages
550
+ * The pricing type (FREE, PAID, or CUSTOM)
834
551
  */
835
- billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
552
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
836
553
 
837
554
  /**
838
- * Price periods for overage pricing
555
+ * Deprecated: billing integration ID
839
556
  */
840
- pricePeriods: Array<OveragePricingModel.PricePeriod>;
557
+ billingId?: string;
841
558
 
842
559
  /**
843
- * The billing cadence for overages
560
+ * Minimum spend configuration per billing period
844
561
  */
845
- billingCadence?: 'RECURRING' | 'ONE_OFF';
562
+ minimumSpend?: Array<Charges.MinimumSpend> | null;
846
563
 
847
564
  /**
848
- * Entitlement configuration for the overage feature
565
+ * When overage charges are billed
849
566
  */
850
- entitlement?: OveragePricingModel.Entitlement;
567
+ overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
851
568
 
852
569
  /**
853
- * The feature ID for overage pricing
570
+ * Array of overage pricing model configurations
854
571
  */
855
- featureId?: string;
572
+ overagePricingModels?: Array<Charges.OveragePricingModel>;
856
573
 
857
574
  /**
858
- * Custom currency ID for overage top-up
575
+ * Array of pricing model configurations
859
576
  */
860
- topUpCustomCurrencyId?: string;
577
+ pricingModels?: Array<Charges.PricingModel>;
861
578
  }
862
579
 
863
- export namespace OveragePricingModel {
580
+ export namespace Charges {
864
581
  /**
865
- * Price configuration for a specific billing period.
582
+ * Minimum spend configuration for a billing period.
866
583
  */
867
- export interface PricePeriod {
584
+ export interface MinimumSpend {
868
585
  /**
869
- * The billing period (MONTHLY or ANNUALLY)
586
+ * The billing period
870
587
  */
871
588
  billingPeriod: 'MONTHLY' | 'ANNUALLY';
872
589
 
873
590
  /**
874
- * ISO country code for localized pricing
875
- */
876
- billingCountryCode?: string;
877
-
878
- /**
879
- * Block size for usage-based pricing
880
- */
881
- blockSize?: number;
882
-
883
- /**
884
- * When credits are granted
885
- */
886
- creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
887
-
888
- /**
889
- * Credit rate configuration for credit-based pricing
890
- */
891
- creditRate?: PricePeriod.CreditRate;
892
-
893
- /**
894
- * The price amount and currency
591
+ * The minimum spend amount
895
592
  */
896
- price?: PricePeriod.Price;
897
-
898
- /**
899
- * Tiered pricing configuration
900
- */
901
- tiers?: Array<PricePeriod.Tier>;
593
+ minimum: MinimumSpend.Minimum;
902
594
  }
903
595
 
904
- export namespace PricePeriod {
905
- /**
906
- * Credit rate configuration for credit-based pricing
907
- */
908
- export interface CreditRate {
909
- /**
910
- * The credit rate amount
911
- */
912
- amount: number;
913
-
914
- /**
915
- * The custom currency ID
916
- */
917
- currencyId: string;
918
-
919
- /**
920
- * Optional cost formula expression
921
- */
922
- costFormula?: string;
923
- }
924
-
596
+ export namespace MinimumSpend {
925
597
  /**
926
- * The price amount and currency
598
+ * The minimum spend amount
927
599
  */
928
- export interface Price {
600
+ export interface Minimum {
929
601
  /**
930
602
  * The price amount
931
603
  */
@@ -1052,32 +724,109 @@ export namespace PlanSetPricingParams {
1052
724
  | 'xof'
1053
725
  | 'xpf';
1054
726
  }
727
+ }
728
+
729
+ /**
730
+ * Overage pricing model configuration.
731
+ */
732
+ export interface OveragePricingModel {
733
+ /**
734
+ * The billing model for overages
735
+ */
736
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
737
+
738
+ /**
739
+ * Price periods for overage pricing
740
+ */
741
+ pricePeriods: Array<OveragePricingModel.PricePeriod>;
742
+
743
+ /**
744
+ * The billing cadence for overages
745
+ */
746
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
747
+
748
+ /**
749
+ * Entitlement configuration for the overage feature
750
+ */
751
+ entitlement?: OveragePricingModel.Entitlement;
752
+
753
+ /**
754
+ * The feature ID for overage pricing
755
+ */
756
+ featureId?: string;
757
+
758
+ /**
759
+ * Custom currency ID for overage top-up
760
+ */
761
+ topUpCustomCurrencyId?: string;
762
+ }
1055
763
 
764
+ export namespace OveragePricingModel {
1056
765
  /**
1057
- * A tier in tiered pricing.
766
+ * Price configuration for a specific billing period.
1058
767
  */
1059
- export interface Tier {
768
+ export interface PricePeriod {
769
+ /**
770
+ * The billing period (MONTHLY or ANNUALLY)
771
+ */
772
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
773
+
774
+ /**
775
+ * ISO country code for localized pricing
776
+ */
777
+ billingCountryCode?: string;
778
+
779
+ /**
780
+ * Block size for usage-based pricing
781
+ */
782
+ blockSize?: number;
783
+
784
+ /**
785
+ * When credits are granted
786
+ */
787
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
788
+
1060
789
  /**
1061
- * Flat price for this tier
790
+ * Credit rate configuration for credit-based pricing
1062
791
  */
1063
- flatPrice?: Tier.FlatPrice;
792
+ creditRate?: PricePeriod.CreditRate;
1064
793
 
1065
794
  /**
1066
- * Per-unit price in this tier
795
+ * The price amount and currency
1067
796
  */
1068
- unitPrice?: Tier.UnitPrice;
797
+ price?: PricePeriod.Price;
1069
798
 
1070
799
  /**
1071
- * Upper bound of this tier (null for unlimited)
800
+ * Tiered pricing configuration
1072
801
  */
1073
- upTo?: number;
802
+ tiers?: Array<PricePeriod.Tier>;
1074
803
  }
1075
804
 
1076
- export namespace Tier {
805
+ export namespace PricePeriod {
806
+ /**
807
+ * Credit rate configuration for credit-based pricing
808
+ */
809
+ export interface CreditRate {
810
+ /**
811
+ * The credit rate amount
812
+ */
813
+ amount: number;
814
+
815
+ /**
816
+ * The custom currency ID
817
+ */
818
+ currencyId: string;
819
+
820
+ /**
821
+ * Optional cost formula expression
822
+ */
823
+ costFormula?: string;
824
+ }
825
+
1077
826
  /**
1078
- * Flat price for this tier
827
+ * The price amount and currency
1079
828
  */
1080
- export interface FlatPrice {
829
+ export interface Price {
1081
830
  /**
1082
831
  * The price amount
1083
832
  */
@@ -1206,507 +955,507 @@ export namespace PlanSetPricingParams {
1206
955
  }
1207
956
 
1208
957
  /**
1209
- * Per-unit price in this tier
958
+ * A tier in tiered pricing.
1210
959
  */
1211
- export interface UnitPrice {
960
+ export interface Tier {
1212
961
  /**
1213
- * The price amount
962
+ * Flat price for this tier
1214
963
  */
1215
- amount: number;
964
+ flatPrice?: Tier.FlatPrice;
1216
965
 
1217
966
  /**
1218
- * The price currency
967
+ * Per-unit price in this tier
1219
968
  */
1220
- currency?:
1221
- | 'usd'
1222
- | 'aed'
1223
- | 'all'
1224
- | 'amd'
1225
- | 'ang'
1226
- | 'aud'
1227
- | 'awg'
1228
- | 'azn'
1229
- | 'bam'
1230
- | 'bbd'
1231
- | 'bdt'
1232
- | 'bgn'
1233
- | 'bif'
1234
- | 'bmd'
1235
- | 'bnd'
1236
- | 'bsd'
1237
- | 'bwp'
1238
- | 'byn'
1239
- | 'bzd'
1240
- | 'brl'
1241
- | 'cad'
1242
- | 'cdf'
1243
- | 'chf'
1244
- | 'cny'
1245
- | 'czk'
1246
- | 'dkk'
1247
- | 'dop'
1248
- | 'dzd'
1249
- | 'egp'
1250
- | 'etb'
1251
- | 'eur'
1252
- | 'fjd'
1253
- | 'gbp'
1254
- | 'gel'
1255
- | 'gip'
1256
- | 'gmd'
1257
- | 'gyd'
1258
- | 'hkd'
1259
- | 'hrk'
1260
- | 'htg'
1261
- | 'idr'
1262
- | 'ils'
1263
- | 'inr'
1264
- | 'isk'
1265
- | 'jmd'
1266
- | 'jpy'
1267
- | 'kes'
1268
- | 'kgs'
1269
- | 'khr'
1270
- | 'kmf'
1271
- | 'krw'
1272
- | 'kyd'
1273
- | 'kzt'
1274
- | 'lbp'
1275
- | 'lkr'
1276
- | 'lrd'
1277
- | 'lsl'
1278
- | 'mad'
1279
- | 'mdl'
1280
- | 'mga'
1281
- | 'mkd'
1282
- | 'mmk'
1283
- | 'mnt'
1284
- | 'mop'
1285
- | 'mro'
1286
- | 'mvr'
1287
- | 'mwk'
1288
- | 'mxn'
1289
- | 'myr'
1290
- | 'mzn'
1291
- | 'nad'
1292
- | 'ngn'
1293
- | 'nok'
1294
- | 'npr'
1295
- | 'nzd'
1296
- | 'pgk'
1297
- | 'php'
1298
- | 'pkr'
1299
- | 'pln'
1300
- | 'qar'
1301
- | 'ron'
1302
- | 'rsd'
1303
- | 'rub'
1304
- | 'rwf'
1305
- | 'sar'
1306
- | 'sbd'
1307
- | 'scr'
1308
- | 'sek'
1309
- | 'sgd'
1310
- | 'sle'
1311
- | 'sll'
1312
- | 'sos'
1313
- | 'szl'
1314
- | 'thb'
1315
- | 'tjs'
1316
- | 'top'
1317
- | 'try'
1318
- | 'ttd'
1319
- | 'tzs'
1320
- | 'uah'
1321
- | 'uzs'
1322
- | 'vnd'
1323
- | 'vuv'
1324
- | 'wst'
1325
- | 'xaf'
1326
- | 'xcd'
1327
- | 'yer'
1328
- | 'zar'
1329
- | 'zmw'
1330
- | 'clp'
1331
- | 'djf'
1332
- | 'gnf'
1333
- | 'ugx'
1334
- | 'pyg'
1335
- | 'xof'
1336
- | 'xpf';
1337
- }
1338
- }
1339
- }
969
+ unitPrice?: Tier.UnitPrice;
1340
970
 
1341
- /**
1342
- * Entitlement configuration for the overage feature
1343
- */
1344
- export interface Entitlement {
1345
- /**
1346
- * The feature ID for the entitlement
1347
- */
1348
- featureId: string;
971
+ /**
972
+ * Upper bound of this tier (null for unlimited)
973
+ */
974
+ upTo?: number;
975
+ }
1349
976
 
1350
- /**
1351
- * Whether the limit is soft (allows overage)
1352
- */
1353
- hasSoftLimit?: boolean;
977
+ export namespace Tier {
978
+ /**
979
+ * Flat price for this tier
980
+ */
981
+ export interface FlatPrice {
982
+ /**
983
+ * The price amount
984
+ */
985
+ amount: number;
986
+
987
+ /**
988
+ * The price currency
989
+ */
990
+ currency?:
991
+ | 'usd'
992
+ | 'aed'
993
+ | 'all'
994
+ | 'amd'
995
+ | 'ang'
996
+ | 'aud'
997
+ | 'awg'
998
+ | 'azn'
999
+ | 'bam'
1000
+ | 'bbd'
1001
+ | 'bdt'
1002
+ | 'bgn'
1003
+ | 'bif'
1004
+ | 'bmd'
1005
+ | 'bnd'
1006
+ | 'bsd'
1007
+ | 'bwp'
1008
+ | 'byn'
1009
+ | 'bzd'
1010
+ | 'brl'
1011
+ | 'cad'
1012
+ | 'cdf'
1013
+ | 'chf'
1014
+ | 'cny'
1015
+ | 'czk'
1016
+ | 'dkk'
1017
+ | 'dop'
1018
+ | 'dzd'
1019
+ | 'egp'
1020
+ | 'etb'
1021
+ | 'eur'
1022
+ | 'fjd'
1023
+ | 'gbp'
1024
+ | 'gel'
1025
+ | 'gip'
1026
+ | 'gmd'
1027
+ | 'gyd'
1028
+ | 'hkd'
1029
+ | 'hrk'
1030
+ | 'htg'
1031
+ | 'idr'
1032
+ | 'ils'
1033
+ | 'inr'
1034
+ | 'isk'
1035
+ | 'jmd'
1036
+ | 'jpy'
1037
+ | 'kes'
1038
+ | 'kgs'
1039
+ | 'khr'
1040
+ | 'kmf'
1041
+ | 'krw'
1042
+ | 'kyd'
1043
+ | 'kzt'
1044
+ | 'lbp'
1045
+ | 'lkr'
1046
+ | 'lrd'
1047
+ | 'lsl'
1048
+ | 'mad'
1049
+ | 'mdl'
1050
+ | 'mga'
1051
+ | 'mkd'
1052
+ | 'mmk'
1053
+ | 'mnt'
1054
+ | 'mop'
1055
+ | 'mro'
1056
+ | 'mvr'
1057
+ | 'mwk'
1058
+ | 'mxn'
1059
+ | 'myr'
1060
+ | 'mzn'
1061
+ | 'nad'
1062
+ | 'ngn'
1063
+ | 'nok'
1064
+ | 'npr'
1065
+ | 'nzd'
1066
+ | 'pgk'
1067
+ | 'php'
1068
+ | 'pkr'
1069
+ | 'pln'
1070
+ | 'qar'
1071
+ | 'ron'
1072
+ | 'rsd'
1073
+ | 'rub'
1074
+ | 'rwf'
1075
+ | 'sar'
1076
+ | 'sbd'
1077
+ | 'scr'
1078
+ | 'sek'
1079
+ | 'sgd'
1080
+ | 'sle'
1081
+ | 'sll'
1082
+ | 'sos'
1083
+ | 'szl'
1084
+ | 'thb'
1085
+ | 'tjs'
1086
+ | 'top'
1087
+ | 'try'
1088
+ | 'ttd'
1089
+ | 'tzs'
1090
+ | 'uah'
1091
+ | 'uzs'
1092
+ | 'vnd'
1093
+ | 'vuv'
1094
+ | 'wst'
1095
+ | 'xaf'
1096
+ | 'xcd'
1097
+ | 'yer'
1098
+ | 'zar'
1099
+ | 'zmw'
1100
+ | 'clp'
1101
+ | 'djf'
1102
+ | 'gnf'
1103
+ | 'ugx'
1104
+ | 'pyg'
1105
+ | 'xof'
1106
+ | 'xpf';
1107
+ }
1354
1108
 
1355
- /**
1356
- * Whether usage is unlimited
1357
- */
1358
- hasUnlimitedUsage?: boolean;
1109
+ /**
1110
+ * Per-unit price in this tier
1111
+ */
1112
+ export interface UnitPrice {
1113
+ /**
1114
+ * The price amount
1115
+ */
1116
+ amount: number;
1117
+
1118
+ /**
1119
+ * The price currency
1120
+ */
1121
+ currency?:
1122
+ | 'usd'
1123
+ | 'aed'
1124
+ | 'all'
1125
+ | 'amd'
1126
+ | 'ang'
1127
+ | 'aud'
1128
+ | 'awg'
1129
+ | 'azn'
1130
+ | 'bam'
1131
+ | 'bbd'
1132
+ | 'bdt'
1133
+ | 'bgn'
1134
+ | 'bif'
1135
+ | 'bmd'
1136
+ | 'bnd'
1137
+ | 'bsd'
1138
+ | 'bwp'
1139
+ | 'byn'
1140
+ | 'bzd'
1141
+ | 'brl'
1142
+ | 'cad'
1143
+ | 'cdf'
1144
+ | 'chf'
1145
+ | 'cny'
1146
+ | 'czk'
1147
+ | 'dkk'
1148
+ | 'dop'
1149
+ | 'dzd'
1150
+ | 'egp'
1151
+ | 'etb'
1152
+ | 'eur'
1153
+ | 'fjd'
1154
+ | 'gbp'
1155
+ | 'gel'
1156
+ | 'gip'
1157
+ | 'gmd'
1158
+ | 'gyd'
1159
+ | 'hkd'
1160
+ | 'hrk'
1161
+ | 'htg'
1162
+ | 'idr'
1163
+ | 'ils'
1164
+ | 'inr'
1165
+ | 'isk'
1166
+ | 'jmd'
1167
+ | 'jpy'
1168
+ | 'kes'
1169
+ | 'kgs'
1170
+ | 'khr'
1171
+ | 'kmf'
1172
+ | 'krw'
1173
+ | 'kyd'
1174
+ | 'kzt'
1175
+ | 'lbp'
1176
+ | 'lkr'
1177
+ | 'lrd'
1178
+ | 'lsl'
1179
+ | 'mad'
1180
+ | 'mdl'
1181
+ | 'mga'
1182
+ | 'mkd'
1183
+ | 'mmk'
1184
+ | 'mnt'
1185
+ | 'mop'
1186
+ | 'mro'
1187
+ | 'mvr'
1188
+ | 'mwk'
1189
+ | 'mxn'
1190
+ | 'myr'
1191
+ | 'mzn'
1192
+ | 'nad'
1193
+ | 'ngn'
1194
+ | 'nok'
1195
+ | 'npr'
1196
+ | 'nzd'
1197
+ | 'pgk'
1198
+ | 'php'
1199
+ | 'pkr'
1200
+ | 'pln'
1201
+ | 'qar'
1202
+ | 'ron'
1203
+ | 'rsd'
1204
+ | 'rub'
1205
+ | 'rwf'
1206
+ | 'sar'
1207
+ | 'sbd'
1208
+ | 'scr'
1209
+ | 'sek'
1210
+ | 'sgd'
1211
+ | 'sle'
1212
+ | 'sll'
1213
+ | 'sos'
1214
+ | 'szl'
1215
+ | 'thb'
1216
+ | 'tjs'
1217
+ | 'top'
1218
+ | 'try'
1219
+ | 'ttd'
1220
+ | 'tzs'
1221
+ | 'uah'
1222
+ | 'uzs'
1223
+ | 'vnd'
1224
+ | 'vuv'
1225
+ | 'wst'
1226
+ | 'xaf'
1227
+ | 'xcd'
1228
+ | 'yer'
1229
+ | 'zar'
1230
+ | 'zmw'
1231
+ | 'clp'
1232
+ | 'djf'
1233
+ | 'gnf'
1234
+ | 'ugx'
1235
+ | 'pyg'
1236
+ | 'xof'
1237
+ | 'xpf';
1238
+ }
1239
+ }
1240
+ }
1359
1241
 
1360
1242
  /**
1361
- * Monthly reset configuration
1243
+ * Entitlement configuration for the overage feature
1362
1244
  */
1363
- monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
1245
+ export interface Entitlement {
1246
+ /**
1247
+ * The feature ID for the entitlement
1248
+ */
1249
+ featureId: string;
1364
1250
 
1365
- /**
1366
- * The usage reset period
1367
- */
1368
- resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1251
+ /**
1252
+ * Whether the limit is soft (allows overage)
1253
+ */
1254
+ hasSoftLimit?: boolean;
1369
1255
 
1370
- /**
1371
- * The usage limit before overage kicks in
1372
- */
1373
- usageLimit?: number;
1256
+ /**
1257
+ * Whether usage is unlimited
1258
+ */
1259
+ hasUnlimitedUsage?: boolean;
1374
1260
 
1375
- /**
1376
- * Weekly reset configuration
1377
- */
1378
- weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
1261
+ /**
1262
+ * Monthly reset configuration
1263
+ */
1264
+ monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
1379
1265
 
1380
- /**
1381
- * Yearly reset configuration
1382
- */
1383
- yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
1384
- }
1266
+ /**
1267
+ * The usage reset period
1268
+ */
1269
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1385
1270
 
1386
- export namespace Entitlement {
1387
- /**
1388
- * Monthly reset configuration
1389
- */
1390
- export interface MonthlyResetPeriodConfiguration {
1391
1271
  /**
1392
- * Reset anchor (SubscriptionStart or StartOfTheMonth)
1272
+ * The usage limit before overage kicks in
1393
1273
  */
1394
- accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1395
- }
1274
+ usageLimit?: number;
1396
1275
 
1397
- /**
1398
- * Weekly reset configuration
1399
- */
1400
- export interface WeeklyResetPeriodConfiguration {
1401
1276
  /**
1402
- * Reset anchor (SubscriptionStart or specific day)
1277
+ * Weekly reset configuration
1403
1278
  */
1404
- accordingTo:
1405
- | 'SubscriptionStart'
1406
- | 'EverySunday'
1407
- | 'EveryMonday'
1408
- | 'EveryTuesday'
1409
- | 'EveryWednesday'
1410
- | 'EveryThursday'
1411
- | 'EveryFriday'
1412
- | 'EverySaturday';
1413
- }
1279
+ weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
1414
1280
 
1415
- /**
1416
- * Yearly reset configuration
1417
- */
1418
- export interface YearlyResetPeriodConfiguration {
1419
1281
  /**
1420
- * Reset anchor (SubscriptionStart)
1282
+ * Yearly reset configuration
1421
1283
  */
1422
- accordingTo: 'SubscriptionStart';
1284
+ yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
1423
1285
  }
1424
- }
1425
- }
1426
1286
 
1427
- /**
1428
- * A pricing model configuration with billing details and price periods.
1429
- */
1430
- export interface PricingModel {
1431
- /**
1432
- * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
1433
- */
1434
- billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
1435
-
1436
- /**
1437
- * Array of price period configurations (at least one required)
1438
- */
1439
- pricePeriods: Array<PricingModel.PricePeriod>;
1440
-
1441
- /**
1442
- * The billing cadence (RECURRING or ONE_OFF)
1443
- */
1444
- billingCadence?: 'RECURRING' | 'ONE_OFF';
1445
-
1446
- /**
1447
- * The feature ID this pricing model is associated with
1448
- */
1449
- featureId?: string;
1450
-
1451
- /**
1452
- * Maximum number of units (max 999999)
1453
- */
1454
- maxUnitQuantity?: number;
1287
+ export namespace Entitlement {
1288
+ /**
1289
+ * Monthly reset configuration
1290
+ */
1291
+ export interface MonthlyResetPeriodConfiguration {
1292
+ /**
1293
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
1294
+ */
1295
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1296
+ }
1455
1297
 
1456
- /**
1457
- * Minimum number of units
1458
- */
1459
- minUnitQuantity?: number;
1298
+ /**
1299
+ * Weekly reset configuration
1300
+ */
1301
+ export interface WeeklyResetPeriodConfiguration {
1302
+ /**
1303
+ * Reset anchor (SubscriptionStart or specific day)
1304
+ */
1305
+ accordingTo:
1306
+ | 'SubscriptionStart'
1307
+ | 'EverySunday'
1308
+ | 'EveryMonday'
1309
+ | 'EveryTuesday'
1310
+ | 'EveryWednesday'
1311
+ | 'EveryThursday'
1312
+ | 'EveryFriday'
1313
+ | 'EverySaturday';
1314
+ }
1460
1315
 
1461
- /**
1462
- * Monthly reset period configuration
1463
- */
1464
- monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
1316
+ /**
1317
+ * Yearly reset configuration
1318
+ */
1319
+ export interface YearlyResetPeriodConfiguration {
1320
+ /**
1321
+ * Reset anchor (SubscriptionStart)
1322
+ */
1323
+ accordingTo: 'SubscriptionStart';
1324
+ }
1325
+ }
1326
+ }
1465
1327
 
1466
1328
  /**
1467
- * The usage reset period
1329
+ * A pricing model configuration with billing details and price periods.
1468
1330
  */
1469
- resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1331
+ export interface PricingModel {
1332
+ /**
1333
+ * The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
1334
+ */
1335
+ billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
1470
1336
 
1471
- /**
1472
- * The tiered pricing mode (VOLUME or GRADUATED)
1473
- */
1474
- tiersMode?: 'VOLUME' | 'GRADUATED';
1337
+ /**
1338
+ * Array of price period configurations (at least one required)
1339
+ */
1340
+ pricePeriods: Array<PricingModel.PricePeriod>;
1475
1341
 
1476
- /**
1477
- * The custom currency ID for top-up pricing
1478
- */
1479
- topUpCustomCurrencyId?: string;
1342
+ /**
1343
+ * The billing cadence (RECURRING or ONE_OFF)
1344
+ */
1345
+ billingCadence?: 'RECURRING' | 'ONE_OFF';
1480
1346
 
1481
- /**
1482
- * Weekly reset period configuration
1483
- */
1484
- weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
1347
+ /**
1348
+ * The feature ID this pricing model is associated with
1349
+ */
1350
+ featureId?: string;
1485
1351
 
1486
- /**
1487
- * Yearly reset period configuration
1488
- */
1489
- yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
1490
- }
1352
+ /**
1353
+ * Maximum number of units (max 999999)
1354
+ */
1355
+ maxUnitQuantity?: number;
1491
1356
 
1492
- export namespace PricingModel {
1493
- /**
1494
- * Price configuration for a specific billing period.
1495
- */
1496
- export interface PricePeriod {
1497
1357
  /**
1498
- * The billing period (MONTHLY or ANNUALLY)
1358
+ * Minimum number of units
1499
1359
  */
1500
- billingPeriod: 'MONTHLY' | 'ANNUALLY';
1360
+ minUnitQuantity?: number;
1501
1361
 
1502
1362
  /**
1503
- * ISO country code for localized pricing
1363
+ * Monthly reset period configuration
1504
1364
  */
1505
- billingCountryCode?: string;
1365
+ monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
1506
1366
 
1507
1367
  /**
1508
- * Block size for usage-based pricing
1368
+ * The usage reset period
1509
1369
  */
1510
- blockSize?: number;
1370
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1511
1371
 
1512
1372
  /**
1513
- * When credits are granted
1373
+ * The tiered pricing mode (VOLUME or GRADUATED)
1514
1374
  */
1515
- creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1375
+ tiersMode?: 'VOLUME' | 'GRADUATED';
1516
1376
 
1517
1377
  /**
1518
- * Credit rate configuration for credit-based pricing
1378
+ * The custom currency ID for top-up pricing
1519
1379
  */
1520
- creditRate?: PricePeriod.CreditRate;
1380
+ topUpCustomCurrencyId?: string;
1521
1381
 
1522
1382
  /**
1523
- * The price amount and currency
1383
+ * Weekly reset period configuration
1524
1384
  */
1525
- price?: PricePeriod.Price;
1385
+ weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
1526
1386
 
1527
1387
  /**
1528
- * Tiered pricing configuration
1388
+ * Yearly reset period configuration
1529
1389
  */
1530
- tiers?: Array<PricePeriod.Tier>;
1390
+ yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
1531
1391
  }
1532
1392
 
1533
- export namespace PricePeriod {
1393
+ export namespace PricingModel {
1534
1394
  /**
1535
- * Credit rate configuration for credit-based pricing
1395
+ * Price configuration for a specific billing period.
1536
1396
  */
1537
- export interface CreditRate {
1397
+ export interface PricePeriod {
1538
1398
  /**
1539
- * The credit rate amount
1399
+ * The billing period (MONTHLY or ANNUALLY)
1540
1400
  */
1541
- amount: number;
1401
+ billingPeriod: 'MONTHLY' | 'ANNUALLY';
1542
1402
 
1543
1403
  /**
1544
- * The custom currency ID
1404
+ * ISO country code for localized pricing
1545
1405
  */
1546
- currencyId: string;
1406
+ billingCountryCode?: string;
1547
1407
 
1548
1408
  /**
1549
- * Optional cost formula expression
1409
+ * Block size for usage-based pricing
1550
1410
  */
1551
- costFormula?: string;
1552
- }
1411
+ blockSize?: number;
1553
1412
 
1554
- /**
1555
- * The price amount and currency
1556
- */
1557
- export interface Price {
1558
1413
  /**
1559
- * The price amount
1414
+ * When credits are granted
1560
1415
  */
1561
- amount: number;
1416
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1562
1417
 
1563
1418
  /**
1564
- * The price currency
1419
+ * Credit rate configuration for credit-based pricing
1565
1420
  */
1566
- currency?:
1567
- | 'usd'
1568
- | 'aed'
1569
- | 'all'
1570
- | 'amd'
1571
- | 'ang'
1572
- | 'aud'
1573
- | 'awg'
1574
- | 'azn'
1575
- | 'bam'
1576
- | 'bbd'
1577
- | 'bdt'
1578
- | 'bgn'
1579
- | 'bif'
1580
- | 'bmd'
1581
- | 'bnd'
1582
- | 'bsd'
1583
- | 'bwp'
1584
- | 'byn'
1585
- | 'bzd'
1586
- | 'brl'
1587
- | 'cad'
1588
- | 'cdf'
1589
- | 'chf'
1590
- | 'cny'
1591
- | 'czk'
1592
- | 'dkk'
1593
- | 'dop'
1594
- | 'dzd'
1595
- | 'egp'
1596
- | 'etb'
1597
- | 'eur'
1598
- | 'fjd'
1599
- | 'gbp'
1600
- | 'gel'
1601
- | 'gip'
1602
- | 'gmd'
1603
- | 'gyd'
1604
- | 'hkd'
1605
- | 'hrk'
1606
- | 'htg'
1607
- | 'idr'
1608
- | 'ils'
1609
- | 'inr'
1610
- | 'isk'
1611
- | 'jmd'
1612
- | 'jpy'
1613
- | 'kes'
1614
- | 'kgs'
1615
- | 'khr'
1616
- | 'kmf'
1617
- | 'krw'
1618
- | 'kyd'
1619
- | 'kzt'
1620
- | 'lbp'
1621
- | 'lkr'
1622
- | 'lrd'
1623
- | 'lsl'
1624
- | 'mad'
1625
- | 'mdl'
1626
- | 'mga'
1627
- | 'mkd'
1628
- | 'mmk'
1629
- | 'mnt'
1630
- | 'mop'
1631
- | 'mro'
1632
- | 'mvr'
1633
- | 'mwk'
1634
- | 'mxn'
1635
- | 'myr'
1636
- | 'mzn'
1637
- | 'nad'
1638
- | 'ngn'
1639
- | 'nok'
1640
- | 'npr'
1641
- | 'nzd'
1642
- | 'pgk'
1643
- | 'php'
1644
- | 'pkr'
1645
- | 'pln'
1646
- | 'qar'
1647
- | 'ron'
1648
- | 'rsd'
1649
- | 'rub'
1650
- | 'rwf'
1651
- | 'sar'
1652
- | 'sbd'
1653
- | 'scr'
1654
- | 'sek'
1655
- | 'sgd'
1656
- | 'sle'
1657
- | 'sll'
1658
- | 'sos'
1659
- | 'szl'
1660
- | 'thb'
1661
- | 'tjs'
1662
- | 'top'
1663
- | 'try'
1664
- | 'ttd'
1665
- | 'tzs'
1666
- | 'uah'
1667
- | 'uzs'
1668
- | 'vnd'
1669
- | 'vuv'
1670
- | 'wst'
1671
- | 'xaf'
1672
- | 'xcd'
1673
- | 'yer'
1674
- | 'zar'
1675
- | 'zmw'
1676
- | 'clp'
1677
- | 'djf'
1678
- | 'gnf'
1679
- | 'ugx'
1680
- | 'pyg'
1681
- | 'xof'
1682
- | 'xpf';
1683
- }
1421
+ creditRate?: PricePeriod.CreditRate;
1684
1422
 
1685
- /**
1686
- * A tier in tiered pricing.
1687
- */
1688
- export interface Tier {
1689
1423
  /**
1690
- * Flat price for this tier
1424
+ * The price amount and currency
1691
1425
  */
1692
- flatPrice?: Tier.FlatPrice;
1426
+ price?: PricePeriod.Price;
1693
1427
 
1694
1428
  /**
1695
- * Per-unit price in this tier
1429
+ * Tiered pricing configuration
1696
1430
  */
1697
- unitPrice?: Tier.UnitPrice;
1431
+ tiers?: Array<PricePeriod.Tier>;
1432
+ }
1698
1433
 
1434
+ export namespace PricePeriod {
1699
1435
  /**
1700
- * Upper bound of this tier (null for unlimited)
1436
+ * Credit rate configuration for credit-based pricing
1701
1437
  */
1702
- upTo?: number;
1703
- }
1438
+ export interface CreditRate {
1439
+ /**
1440
+ * The credit rate amount
1441
+ */
1442
+ amount: number;
1443
+
1444
+ /**
1445
+ * The custom currency ID
1446
+ */
1447
+ currencyId: string;
1448
+
1449
+ /**
1450
+ * Optional cost formula expression
1451
+ */
1452
+ costFormula?: string;
1453
+ }
1704
1454
 
1705
- export namespace Tier {
1706
1455
  /**
1707
- * Flat price for this tier
1456
+ * The price amount and currency
1708
1457
  */
1709
- export interface FlatPrice {
1458
+ export interface Price {
1710
1459
  /**
1711
1460
  * The price amount
1712
1461
  */
@@ -1835,178 +1584,424 @@ export namespace PlanSetPricingParams {
1835
1584
  }
1836
1585
 
1837
1586
  /**
1838
- * Per-unit price in this tier
1587
+ * A tier in tiered pricing.
1839
1588
  */
1840
- export interface UnitPrice {
1589
+ export interface Tier {
1841
1590
  /**
1842
- * The price amount
1591
+ * Flat price for this tier
1843
1592
  */
1844
- amount: number;
1593
+ flatPrice?: Tier.FlatPrice;
1845
1594
 
1846
1595
  /**
1847
- * The price currency
1596
+ * Per-unit price in this tier
1848
1597
  */
1849
- currency?:
1850
- | 'usd'
1851
- | 'aed'
1852
- | 'all'
1853
- | 'amd'
1854
- | 'ang'
1855
- | 'aud'
1856
- | 'awg'
1857
- | 'azn'
1858
- | 'bam'
1859
- | 'bbd'
1860
- | 'bdt'
1861
- | 'bgn'
1862
- | 'bif'
1863
- | 'bmd'
1864
- | 'bnd'
1865
- | 'bsd'
1866
- | 'bwp'
1867
- | 'byn'
1868
- | 'bzd'
1869
- | 'brl'
1870
- | 'cad'
1871
- | 'cdf'
1872
- | 'chf'
1873
- | 'cny'
1874
- | 'czk'
1875
- | 'dkk'
1876
- | 'dop'
1877
- | 'dzd'
1878
- | 'egp'
1879
- | 'etb'
1880
- | 'eur'
1881
- | 'fjd'
1882
- | 'gbp'
1883
- | 'gel'
1884
- | 'gip'
1885
- | 'gmd'
1886
- | 'gyd'
1887
- | 'hkd'
1888
- | 'hrk'
1889
- | 'htg'
1890
- | 'idr'
1891
- | 'ils'
1892
- | 'inr'
1893
- | 'isk'
1894
- | 'jmd'
1895
- | 'jpy'
1896
- | 'kes'
1897
- | 'kgs'
1898
- | 'khr'
1899
- | 'kmf'
1900
- | 'krw'
1901
- | 'kyd'
1902
- | 'kzt'
1903
- | 'lbp'
1904
- | 'lkr'
1905
- | 'lrd'
1906
- | 'lsl'
1907
- | 'mad'
1908
- | 'mdl'
1909
- | 'mga'
1910
- | 'mkd'
1911
- | 'mmk'
1912
- | 'mnt'
1913
- | 'mop'
1914
- | 'mro'
1915
- | 'mvr'
1916
- | 'mwk'
1917
- | 'mxn'
1918
- | 'myr'
1919
- | 'mzn'
1920
- | 'nad'
1921
- | 'ngn'
1922
- | 'nok'
1923
- | 'npr'
1924
- | 'nzd'
1925
- | 'pgk'
1926
- | 'php'
1927
- | 'pkr'
1928
- | 'pln'
1929
- | 'qar'
1930
- | 'ron'
1931
- | 'rsd'
1932
- | 'rub'
1933
- | 'rwf'
1934
- | 'sar'
1935
- | 'sbd'
1936
- | 'scr'
1937
- | 'sek'
1938
- | 'sgd'
1939
- | 'sle'
1940
- | 'sll'
1941
- | 'sos'
1942
- | 'szl'
1943
- | 'thb'
1944
- | 'tjs'
1945
- | 'top'
1946
- | 'try'
1947
- | 'ttd'
1948
- | 'tzs'
1949
- | 'uah'
1950
- | 'uzs'
1951
- | 'vnd'
1952
- | 'vuv'
1953
- | 'wst'
1954
- | 'xaf'
1955
- | 'xcd'
1956
- | 'yer'
1957
- | 'zar'
1958
- | 'zmw'
1959
- | 'clp'
1960
- | 'djf'
1961
- | 'gnf'
1962
- | 'ugx'
1963
- | 'pyg'
1964
- | 'xof'
1965
- | 'xpf';
1598
+ unitPrice?: Tier.UnitPrice;
1599
+
1600
+ /**
1601
+ * Upper bound of this tier (null for unlimited)
1602
+ */
1603
+ upTo?: number;
1604
+ }
1605
+
1606
+ export namespace Tier {
1607
+ /**
1608
+ * Flat price for this tier
1609
+ */
1610
+ export interface FlatPrice {
1611
+ /**
1612
+ * The price amount
1613
+ */
1614
+ amount: number;
1615
+
1616
+ /**
1617
+ * The price currency
1618
+ */
1619
+ currency?:
1620
+ | 'usd'
1621
+ | 'aed'
1622
+ | 'all'
1623
+ | 'amd'
1624
+ | 'ang'
1625
+ | 'aud'
1626
+ | 'awg'
1627
+ | 'azn'
1628
+ | 'bam'
1629
+ | 'bbd'
1630
+ | 'bdt'
1631
+ | 'bgn'
1632
+ | 'bif'
1633
+ | 'bmd'
1634
+ | 'bnd'
1635
+ | 'bsd'
1636
+ | 'bwp'
1637
+ | 'byn'
1638
+ | 'bzd'
1639
+ | 'brl'
1640
+ | 'cad'
1641
+ | 'cdf'
1642
+ | 'chf'
1643
+ | 'cny'
1644
+ | 'czk'
1645
+ | 'dkk'
1646
+ | 'dop'
1647
+ | 'dzd'
1648
+ | 'egp'
1649
+ | 'etb'
1650
+ | 'eur'
1651
+ | 'fjd'
1652
+ | 'gbp'
1653
+ | 'gel'
1654
+ | 'gip'
1655
+ | 'gmd'
1656
+ | 'gyd'
1657
+ | 'hkd'
1658
+ | 'hrk'
1659
+ | 'htg'
1660
+ | 'idr'
1661
+ | 'ils'
1662
+ | 'inr'
1663
+ | 'isk'
1664
+ | 'jmd'
1665
+ | 'jpy'
1666
+ | 'kes'
1667
+ | 'kgs'
1668
+ | 'khr'
1669
+ | 'kmf'
1670
+ | 'krw'
1671
+ | 'kyd'
1672
+ | 'kzt'
1673
+ | 'lbp'
1674
+ | 'lkr'
1675
+ | 'lrd'
1676
+ | 'lsl'
1677
+ | 'mad'
1678
+ | 'mdl'
1679
+ | 'mga'
1680
+ | 'mkd'
1681
+ | 'mmk'
1682
+ | 'mnt'
1683
+ | 'mop'
1684
+ | 'mro'
1685
+ | 'mvr'
1686
+ | 'mwk'
1687
+ | 'mxn'
1688
+ | 'myr'
1689
+ | 'mzn'
1690
+ | 'nad'
1691
+ | 'ngn'
1692
+ | 'nok'
1693
+ | 'npr'
1694
+ | 'nzd'
1695
+ | 'pgk'
1696
+ | 'php'
1697
+ | 'pkr'
1698
+ | 'pln'
1699
+ | 'qar'
1700
+ | 'ron'
1701
+ | 'rsd'
1702
+ | 'rub'
1703
+ | 'rwf'
1704
+ | 'sar'
1705
+ | 'sbd'
1706
+ | 'scr'
1707
+ | 'sek'
1708
+ | 'sgd'
1709
+ | 'sle'
1710
+ | 'sll'
1711
+ | 'sos'
1712
+ | 'szl'
1713
+ | 'thb'
1714
+ | 'tjs'
1715
+ | 'top'
1716
+ | 'try'
1717
+ | 'ttd'
1718
+ | 'tzs'
1719
+ | 'uah'
1720
+ | 'uzs'
1721
+ | 'vnd'
1722
+ | 'vuv'
1723
+ | 'wst'
1724
+ | 'xaf'
1725
+ | 'xcd'
1726
+ | 'yer'
1727
+ | 'zar'
1728
+ | 'zmw'
1729
+ | 'clp'
1730
+ | 'djf'
1731
+ | 'gnf'
1732
+ | 'ugx'
1733
+ | 'pyg'
1734
+ | 'xof'
1735
+ | 'xpf';
1736
+ }
1737
+
1738
+ /**
1739
+ * Per-unit price in this tier
1740
+ */
1741
+ export interface UnitPrice {
1742
+ /**
1743
+ * The price amount
1744
+ */
1745
+ amount: number;
1746
+
1747
+ /**
1748
+ * The price currency
1749
+ */
1750
+ currency?:
1751
+ | 'usd'
1752
+ | 'aed'
1753
+ | 'all'
1754
+ | 'amd'
1755
+ | 'ang'
1756
+ | 'aud'
1757
+ | 'awg'
1758
+ | 'azn'
1759
+ | 'bam'
1760
+ | 'bbd'
1761
+ | 'bdt'
1762
+ | 'bgn'
1763
+ | 'bif'
1764
+ | 'bmd'
1765
+ | 'bnd'
1766
+ | 'bsd'
1767
+ | 'bwp'
1768
+ | 'byn'
1769
+ | 'bzd'
1770
+ | 'brl'
1771
+ | 'cad'
1772
+ | 'cdf'
1773
+ | 'chf'
1774
+ | 'cny'
1775
+ | 'czk'
1776
+ | 'dkk'
1777
+ | 'dop'
1778
+ | 'dzd'
1779
+ | 'egp'
1780
+ | 'etb'
1781
+ | 'eur'
1782
+ | 'fjd'
1783
+ | 'gbp'
1784
+ | 'gel'
1785
+ | 'gip'
1786
+ | 'gmd'
1787
+ | 'gyd'
1788
+ | 'hkd'
1789
+ | 'hrk'
1790
+ | 'htg'
1791
+ | 'idr'
1792
+ | 'ils'
1793
+ | 'inr'
1794
+ | 'isk'
1795
+ | 'jmd'
1796
+ | 'jpy'
1797
+ | 'kes'
1798
+ | 'kgs'
1799
+ | 'khr'
1800
+ | 'kmf'
1801
+ | 'krw'
1802
+ | 'kyd'
1803
+ | 'kzt'
1804
+ | 'lbp'
1805
+ | 'lkr'
1806
+ | 'lrd'
1807
+ | 'lsl'
1808
+ | 'mad'
1809
+ | 'mdl'
1810
+ | 'mga'
1811
+ | 'mkd'
1812
+ | 'mmk'
1813
+ | 'mnt'
1814
+ | 'mop'
1815
+ | 'mro'
1816
+ | 'mvr'
1817
+ | 'mwk'
1818
+ | 'mxn'
1819
+ | 'myr'
1820
+ | 'mzn'
1821
+ | 'nad'
1822
+ | 'ngn'
1823
+ | 'nok'
1824
+ | 'npr'
1825
+ | 'nzd'
1826
+ | 'pgk'
1827
+ | 'php'
1828
+ | 'pkr'
1829
+ | 'pln'
1830
+ | 'qar'
1831
+ | 'ron'
1832
+ | 'rsd'
1833
+ | 'rub'
1834
+ | 'rwf'
1835
+ | 'sar'
1836
+ | 'sbd'
1837
+ | 'scr'
1838
+ | 'sek'
1839
+ | 'sgd'
1840
+ | 'sle'
1841
+ | 'sll'
1842
+ | 'sos'
1843
+ | 'szl'
1844
+ | 'thb'
1845
+ | 'tjs'
1846
+ | 'top'
1847
+ | 'try'
1848
+ | 'ttd'
1849
+ | 'tzs'
1850
+ | 'uah'
1851
+ | 'uzs'
1852
+ | 'vnd'
1853
+ | 'vuv'
1854
+ | 'wst'
1855
+ | 'xaf'
1856
+ | 'xcd'
1857
+ | 'yer'
1858
+ | 'zar'
1859
+ | 'zmw'
1860
+ | 'clp'
1861
+ | 'djf'
1862
+ | 'gnf'
1863
+ | 'ugx'
1864
+ | 'pyg'
1865
+ | 'xof'
1866
+ | 'xpf';
1867
+ }
1966
1868
  }
1967
1869
  }
1968
- }
1969
1870
 
1970
- /**
1971
- * Monthly reset period configuration
1972
- */
1973
- export interface MonthlyResetPeriodConfiguration {
1974
1871
  /**
1975
- * Reset anchor (SubscriptionStart or StartOfTheMonth)
1872
+ * Monthly reset period configuration
1976
1873
  */
1977
- accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1978
- }
1874
+ export interface MonthlyResetPeriodConfiguration {
1875
+ /**
1876
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
1877
+ */
1878
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1879
+ }
1880
+
1881
+ /**
1882
+ * Weekly reset period configuration
1883
+ */
1884
+ export interface WeeklyResetPeriodConfiguration {
1885
+ /**
1886
+ * Reset anchor (SubscriptionStart or specific day)
1887
+ */
1888
+ accordingTo:
1889
+ | 'SubscriptionStart'
1890
+ | 'EverySunday'
1891
+ | 'EveryMonday'
1892
+ | 'EveryTuesday'
1893
+ | 'EveryWednesday'
1894
+ | 'EveryThursday'
1895
+ | 'EveryFriday'
1896
+ | 'EverySaturday';
1897
+ }
1979
1898
 
1980
- /**
1981
- * Weekly reset period configuration
1982
- */
1983
- export interface WeeklyResetPeriodConfiguration {
1984
1899
  /**
1985
- * Reset anchor (SubscriptionStart or specific day)
1900
+ * Yearly reset period configuration
1986
1901
  */
1987
- accordingTo:
1988
- | 'SubscriptionStart'
1989
- | 'EverySunday'
1990
- | 'EveryMonday'
1991
- | 'EveryTuesday'
1992
- | 'EveryWednesday'
1993
- | 'EveryThursday'
1994
- | 'EveryFriday'
1995
- | 'EverySaturday';
1902
+ export interface YearlyResetPeriodConfiguration {
1903
+ /**
1904
+ * Reset anchor (SubscriptionStart)
1905
+ */
1906
+ accordingTo: 'SubscriptionStart';
1907
+ }
1996
1908
  }
1909
+ }
1910
+
1911
+ /**
1912
+ * Default trial configuration for the plan
1913
+ */
1914
+ export interface DefaultTrialConfig {
1915
+ /**
1916
+ * The duration of the trial in the specified units
1917
+ */
1918
+ duration: number;
1919
+
1920
+ /**
1921
+ * The time unit for the trial duration (DAY or MONTH)
1922
+ */
1923
+ units: 'DAY' | 'MONTH';
1924
+
1925
+ /**
1926
+ * Budget configuration for the trial
1927
+ */
1928
+ budget?: DefaultTrialConfig.Budget | null;
1929
+
1930
+ /**
1931
+ * Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)
1932
+ */
1933
+ trialEndBehavior?: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION' | null;
1934
+ }
1997
1935
 
1936
+ export namespace DefaultTrialConfig {
1998
1937
  /**
1999
- * Yearly reset period configuration
1938
+ * Budget configuration for the trial
2000
1939
  */
2001
- export interface YearlyResetPeriodConfiguration {
1940
+ export interface Budget {
1941
+ /**
1942
+ * Whether the budget limit is a soft limit (allows overage) or hard limit
1943
+ */
1944
+ hasSoftLimit: boolean;
1945
+
2002
1946
  /**
2003
- * Reset anchor (SubscriptionStart)
1947
+ * The budget limit amount
2004
1948
  */
2005
- accordingTo: 'SubscriptionStart';
1949
+ limit: number;
2006
1950
  }
2007
1951
  }
2008
1952
  }
2009
1953
 
1954
+ export interface PlanListParams extends MyCursorIDPageParams {
1955
+ /**
1956
+ * Filter by creation date using range operators: gt, gte, lt, lte
1957
+ */
1958
+ createdAt?: PlanListParams.CreatedAt;
1959
+
1960
+ /**
1961
+ * Filter by product ID
1962
+ */
1963
+ productId?: string;
1964
+
1965
+ /**
1966
+ * Filter by status. Supports comma-separated values for multiple statuses
1967
+ */
1968
+ status?: string;
1969
+ }
1970
+
1971
+ export namespace PlanListParams {
1972
+ /**
1973
+ * Filter by creation date using range operators: gt, gte, lt, lte
1974
+ */
1975
+ export interface CreatedAt {
1976
+ /**
1977
+ * Greater than the specified createdAt value
1978
+ */
1979
+ gt?: string;
1980
+
1981
+ /**
1982
+ * Greater than or equal to the specified createdAt value
1983
+ */
1984
+ gte?: string;
1985
+
1986
+ /**
1987
+ * Less than the specified createdAt value
1988
+ */
1989
+ lt?: string;
1990
+
1991
+ /**
1992
+ * Less than or equal to the specified createdAt value
1993
+ */
1994
+ lte?: string;
1995
+ }
1996
+ }
1997
+
1998
+ export interface PlanPublishParams {
1999
+ /**
2000
+ * The migration type of the package
2001
+ */
2002
+ migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
2003
+ }
2004
+
2010
2005
  Plans.Entitlements = Entitlements;
2011
2006
 
2012
2007
  export declare namespace Plans {
@@ -2020,7 +2015,6 @@ export declare namespace Plans {
2020
2015
  type PlanUpdateParams as PlanUpdateParams,
2021
2016
  type PlanListParams as PlanListParams,
2022
2017
  type PlanPublishParams as PlanPublishParams,
2023
- type PlanSetPricingParams as PlanSetPricingParams,
2024
2018
  };
2025
2019
 
2026
2020
  export {