autumn-js 1.2.35 → 1.2.37
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/dist/backend/adapters/express.d.mts +1 -1
- package/dist/backend/adapters/express.d.ts +1 -1
- package/dist/backend/adapters/express.js +699 -148
- package/dist/backend/adapters/express.mjs +5 -5
- package/dist/backend/adapters/fetch.d.mts +1 -1
- package/dist/backend/adapters/fetch.d.ts +1 -1
- package/dist/backend/adapters/fetch.js +699 -148
- package/dist/backend/adapters/fetch.mjs +5 -5
- package/dist/backend/adapters/hono.d.mts +1 -1
- package/dist/backend/adapters/hono.d.ts +1 -1
- package/dist/backend/adapters/hono.js +699 -148
- package/dist/backend/adapters/hono.mjs +5 -5
- package/dist/backend/adapters/index.d.mts +1 -1
- package/dist/backend/adapters/index.d.ts +1 -1
- package/dist/backend/adapters/index.js +699 -148
- package/dist/backend/adapters/index.mjs +8 -8
- package/dist/backend/adapters/next.d.mts +1 -1
- package/dist/backend/adapters/next.d.ts +1 -1
- package/dist/backend/adapters/next.js +699 -148
- package/dist/backend/adapters/next.mjs +5 -5
- package/dist/backend/{authTypes-B33BAaz1.d.mts → authTypes-jU7ON-I5.d.mts} +16 -0
- package/dist/backend/{authTypes-B33BAaz1.d.ts → authTypes-jU7ON-I5.d.ts} +16 -0
- package/dist/backend/{chunk-CTAEJHFX.mjs → chunk-AFWY6NDJ.mjs} +1 -1
- package/dist/backend/{chunk-FTV6MPLY.mjs → chunk-AOAGX4AS.mjs} +2 -2
- package/dist/backend/{chunk-VAAXORAG.mjs → chunk-DR35G6GS.mjs} +2 -2
- package/dist/backend/{chunk-TYGTZQUO.mjs → chunk-NHBJ3QDV.mjs} +260 -36
- package/dist/backend/{chunk-BTL6PH2D.mjs → chunk-PMD3Z6EM.mjs} +1 -1
- package/dist/backend/{chunk-SE42XPGB.mjs → chunk-QLH3M5PR.mjs} +439 -112
- package/dist/backend/{chunk-E5WAT35D.mjs → chunk-UWZYM74E.mjs} +1 -1
- package/dist/backend/{chunk-JRYUVNEG.mjs → chunk-VMYD4IWS.mjs} +1 -1
- package/dist/backend/core/handlers/coreHandler.d.mts +2 -2
- package/dist/backend/core/handlers/coreHandler.d.ts +2 -2
- package/dist/backend/core/handlers/coreHandler.js +699 -148
- package/dist/backend/core/handlers/coreHandler.mjs +3 -3
- package/dist/backend/core/handlers/executeRoute.d.mts +2 -2
- package/dist/backend/core/handlers/executeRoute.d.ts +2 -2
- package/dist/backend/core/handlers/handleRouteByName.d.mts +1 -1
- package/dist/backend/core/handlers/handleRouteByName.d.ts +1 -1
- package/dist/backend/core/handlers/handleRouteByName.js +699 -148
- package/dist/backend/core/handlers/handleRouteByName.mjs +3 -3
- package/dist/backend/core/handlers/index.d.mts +2 -2
- package/dist/backend/core/handlers/index.d.ts +2 -2
- package/dist/backend/core/handlers/index.js +699 -148
- package/dist/backend/core/handlers/index.mjs +4 -4
- package/dist/backend/core/handlers/resolveIdentity.d.mts +1 -1
- package/dist/backend/core/handlers/resolveIdentity.d.ts +1 -1
- package/dist/backend/core/index.d.mts +2 -2
- package/dist/backend/core/index.d.ts +2 -2
- package/dist/backend/core/index.js +699 -148
- package/dist/backend/core/index.mjs +4 -4
- package/dist/backend/core/routes/index.d.mts +2 -2
- package/dist/backend/core/routes/index.d.ts +2 -2
- package/dist/backend/core/routes/index.js +260 -36
- package/dist/backend/core/routes/index.mjs +1 -1
- package/dist/backend/core/routes/routeBuilder.d.mts +2 -2
- package/dist/backend/core/routes/routeBuilder.d.ts +2 -2
- package/dist/backend/core/routes/routeConfigs.d.mts +2 -2
- package/dist/backend/core/routes/routeConfigs.d.ts +2 -2
- package/dist/backend/core/routes/routeConfigs.js +260 -36
- package/dist/backend/core/routes/routeConfigs.mjs +1 -1
- package/dist/backend/core/types/authTypes.d.mts +1 -1
- package/dist/backend/core/types/authTypes.d.ts +1 -1
- package/dist/backend/core/types/handlerTypes.d.mts +2 -2
- package/dist/backend/core/types/handlerTypes.d.ts +2 -2
- package/dist/backend/core/types/index.d.mts +2 -2
- package/dist/backend/core/types/index.d.ts +2 -2
- package/dist/backend/core/types/routeTypes.d.mts +2 -2
- package/dist/backend/core/types/routeTypes.d.ts +2 -2
- package/dist/backend/index.d.mts +4 -4
- package/dist/backend/index.d.ts +4 -4
- package/dist/backend/index.js +699 -148
- package/dist/backend/index.mjs +4 -4
- package/dist/backend/{routeTypes-CX_fRpB1.d.ts → routeTypes-B0zHyzyX.d.ts} +615 -14
- package/dist/backend/{routeTypes-D-tNolqk.d.mts → routeTypes-M8hsq6U-.d.mts} +615 -14
- package/dist/better-auth/{chunk-DSE3KBZN.mjs → chunk-7NGK7FWC.mjs} +1 -1
- package/dist/better-auth/{chunk-RGU4M7DE.mjs → chunk-DG2IPLR6.mjs} +260 -36
- package/dist/better-auth/{chunk-MGUDRHQD.mjs → chunk-HCM5WABX.mjs} +440 -113
- package/dist/better-auth/index.js +699 -148
- package/dist/better-auth/index.mjs +3 -3
- package/dist/better-auth/types.d.mts +16 -0
- package/dist/better-auth/types.d.ts +16 -0
- package/dist/better-auth/utils/createAutumnEndpoint.js +260 -36
- package/dist/better-auth/utils/createAutumnEndpoint.mjs +2 -2
- package/dist/better-auth/utils/handleBetterAuthRoute.js +699 -148
- package/dist/better-auth/utils/handleBetterAuthRoute.mjs +2 -2
- package/dist/better-auth/utils/index.js +699 -148
- package/dist/better-auth/utils/index.mjs +3 -3
- package/dist/react/AutumnContext.d.mts +4 -4
- package/dist/react/AutumnContext.d.ts +4 -4
- package/dist/react/client/AutumnClient.d.mts +4 -4
- package/dist/react/client/AutumnClient.d.ts +4 -4
- package/dist/react/client/IAutumnClient.d.mts +4 -4
- package/dist/react/client/IAutumnClient.d.ts +4 -4
- package/dist/react/client/index.d.mts +4 -4
- package/dist/react/client/index.d.ts +4 -4
- package/dist/react/{customer-fjDreCb2.d.mts → customer-CkuydPCd.d.mts} +17 -1
- package/dist/react/{customer-DDciGja3.d.ts → customer-D811_jP2.d.ts} +17 -1
- package/dist/react/hooks/index.d.mts +4 -4
- package/dist/react/hooks/index.d.ts +4 -4
- package/dist/react/hooks/internal/check/balanceToAllowed.d.mts +2 -2
- package/dist/react/hooks/internal/check/balanceToAllowed.d.ts +2 -2
- package/dist/react/hooks/internal/check/customerToFeatures.d.mts +2 -2
- package/dist/react/hooks/internal/check/customerToFeatures.d.ts +2 -2
- package/dist/react/hooks/internal/check/findCreditSystemsByFeature.d.mts +2 -2
- package/dist/react/hooks/internal/check/findCreditSystemsByFeature.d.ts +2 -2
- package/dist/react/hooks/internal/check/getCreditCost.d.mts +2 -2
- package/dist/react/hooks/internal/check/getCreditCost.d.ts +2 -2
- package/dist/react/hooks/internal/getLocalCheckResponse.d.mts +3 -3
- package/dist/react/hooks/internal/getLocalCheckResponse.d.ts +3 -3
- package/dist/react/hooks/internal/useCustomerActions.d.mts +4 -4
- package/dist/react/hooks/internal/useCustomerActions.d.ts +4 -4
- package/dist/react/hooks/useAggregateEvents.d.mts +2 -2
- package/dist/react/hooks/useAggregateEvents.d.ts +2 -2
- package/dist/react/hooks/useCustomer.d.mts +3 -3
- package/dist/react/hooks/useCustomer.d.ts +3 -3
- package/dist/react/hooks/useEntity.d.mts +2 -2
- package/dist/react/hooks/useEntity.d.ts +2 -2
- package/dist/react/hooks/useListEvents.d.mts +2 -2
- package/dist/react/hooks/useListEvents.d.ts +2 -2
- package/dist/react/hooks/useListPlans.d.mts +3 -3
- package/dist/react/hooks/useListPlans.d.ts +3 -3
- package/dist/react/hooks/useReferrals.d.mts +2 -2
- package/dist/react/hooks/useReferrals.d.ts +2 -2
- package/dist/react/index.d.mts +4 -4
- package/dist/react/index.d.ts +4 -4
- package/dist/react/{list-plans-op-ByqRxdNR.d.mts → list-plans-op-Cwb5iIdA.d.ts} +33 -1
- package/dist/react/{list-plans-op-D-K2LRZV.d.ts → list-plans-op-DvXyRegM.d.mts} +33 -1
- package/dist/react/{params-BDzQ8IBN.d.mts → params-C0cH2cYK.d.mts} +214 -5
- package/dist/react/{params-DWmwIoI4.d.ts → params-CaUBdt-x.d.ts} +214 -5
- package/dist/react/{plan-DOxbvjQY.d.mts → plan-CUExbmy9.d.mts} +32 -0
- package/dist/react/{plan-DOxbvjQY.d.ts → plan-CUExbmy9.d.ts} +32 -0
- package/dist/sdk/index.d.mts +971 -22
- package/dist/sdk/index.d.ts +971 -22
- package/dist/sdk/index.js +854 -126
- package/dist/sdk/index.mjs +743 -121
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { O as OpenEnum } from './plan-
|
|
1
|
+
import { O as OpenEnum } from './plan-CUExbmy9.js';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Billing interval (e.g. 'month', 'year').
|
|
@@ -752,6 +752,10 @@ type ListPlansVariantDetailsSpendLimit = {
|
|
|
752
752
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
753
753
|
*/
|
|
754
754
|
overageLimit?: number | undefined;
|
|
755
|
+
/**
|
|
756
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
757
|
+
*/
|
|
758
|
+
skipOverageBilling?: boolean | undefined;
|
|
755
759
|
};
|
|
756
760
|
/**
|
|
757
761
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -766,6 +770,14 @@ declare const ListPlansVariantDetailsUsageLimitInterval: {
|
|
|
766
770
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
767
771
|
*/
|
|
768
772
|
type ListPlansVariantDetailsUsageLimitInterval = OpenEnum<typeof ListPlansVariantDetailsUsageLimitInterval>;
|
|
773
|
+
/**
|
|
774
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
775
|
+
*/
|
|
776
|
+
type ListPlansVariantDetailsFilter = {
|
|
777
|
+
properties: {
|
|
778
|
+
[k: string]: any;
|
|
779
|
+
};
|
|
780
|
+
};
|
|
769
781
|
type ListPlansVariantDetailsUsageLimit = {
|
|
770
782
|
/**
|
|
771
783
|
* The feature this usage limit applies to.
|
|
@@ -783,6 +795,10 @@ type ListPlansVariantDetailsUsageLimit = {
|
|
|
783
795
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
784
796
|
*/
|
|
785
797
|
interval: ListPlansVariantDetailsUsageLimitInterval;
|
|
798
|
+
/**
|
|
799
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
800
|
+
*/
|
|
801
|
+
filter?: ListPlansVariantDetailsFilter | undefined;
|
|
786
802
|
};
|
|
787
803
|
/**
|
|
788
804
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -985,6 +1001,10 @@ type ListPlansSpendLimit = {
|
|
|
985
1001
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
986
1002
|
*/
|
|
987
1003
|
overageLimit?: number | undefined;
|
|
1004
|
+
/**
|
|
1005
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
1006
|
+
*/
|
|
1007
|
+
skipOverageBilling?: boolean | undefined;
|
|
988
1008
|
};
|
|
989
1009
|
/**
|
|
990
1010
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -999,6 +1019,14 @@ declare const ListPlansUsageLimitInterval: {
|
|
|
999
1019
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
1000
1020
|
*/
|
|
1001
1021
|
type ListPlansUsageLimitInterval = OpenEnum<typeof ListPlansUsageLimitInterval>;
|
|
1022
|
+
/**
|
|
1023
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
1024
|
+
*/
|
|
1025
|
+
type ListPlansFilter = {
|
|
1026
|
+
properties: {
|
|
1027
|
+
[k: string]: any;
|
|
1028
|
+
};
|
|
1029
|
+
};
|
|
1002
1030
|
type ListPlansUsageLimit = {
|
|
1003
1031
|
/**
|
|
1004
1032
|
* The feature this usage limit applies to.
|
|
@@ -1016,6 +1044,10 @@ type ListPlansUsageLimit = {
|
|
|
1016
1044
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
1017
1045
|
*/
|
|
1018
1046
|
interval: ListPlansUsageLimitInterval;
|
|
1047
|
+
/**
|
|
1048
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
1049
|
+
*/
|
|
1050
|
+
filter?: ListPlansFilter | undefined;
|
|
1019
1051
|
};
|
|
1020
1052
|
/**
|
|
1021
1053
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { O as OpenEnum } from './plan-
|
|
1
|
+
import { O as OpenEnum } from './plan-CUExbmy9.mjs';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Billing interval (e.g. 'month', 'year').
|
|
@@ -752,6 +752,10 @@ type ListPlansVariantDetailsSpendLimit = {
|
|
|
752
752
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
753
753
|
*/
|
|
754
754
|
overageLimit?: number | undefined;
|
|
755
|
+
/**
|
|
756
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
757
|
+
*/
|
|
758
|
+
skipOverageBilling?: boolean | undefined;
|
|
755
759
|
};
|
|
756
760
|
/**
|
|
757
761
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -766,6 +770,14 @@ declare const ListPlansVariantDetailsUsageLimitInterval: {
|
|
|
766
770
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
767
771
|
*/
|
|
768
772
|
type ListPlansVariantDetailsUsageLimitInterval = OpenEnum<typeof ListPlansVariantDetailsUsageLimitInterval>;
|
|
773
|
+
/**
|
|
774
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
775
|
+
*/
|
|
776
|
+
type ListPlansVariantDetailsFilter = {
|
|
777
|
+
properties: {
|
|
778
|
+
[k: string]: any;
|
|
779
|
+
};
|
|
780
|
+
};
|
|
769
781
|
type ListPlansVariantDetailsUsageLimit = {
|
|
770
782
|
/**
|
|
771
783
|
* The feature this usage limit applies to.
|
|
@@ -783,6 +795,10 @@ type ListPlansVariantDetailsUsageLimit = {
|
|
|
783
795
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
784
796
|
*/
|
|
785
797
|
interval: ListPlansVariantDetailsUsageLimitInterval;
|
|
798
|
+
/**
|
|
799
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
800
|
+
*/
|
|
801
|
+
filter?: ListPlansVariantDetailsFilter | undefined;
|
|
786
802
|
};
|
|
787
803
|
/**
|
|
788
804
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -985,6 +1001,10 @@ type ListPlansSpendLimit = {
|
|
|
985
1001
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
986
1002
|
*/
|
|
987
1003
|
overageLimit?: number | undefined;
|
|
1004
|
+
/**
|
|
1005
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
1006
|
+
*/
|
|
1007
|
+
skipOverageBilling?: boolean | undefined;
|
|
988
1008
|
};
|
|
989
1009
|
/**
|
|
990
1010
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -999,6 +1019,14 @@ declare const ListPlansUsageLimitInterval: {
|
|
|
999
1019
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
1000
1020
|
*/
|
|
1001
1021
|
type ListPlansUsageLimitInterval = OpenEnum<typeof ListPlansUsageLimitInterval>;
|
|
1022
|
+
/**
|
|
1023
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
1024
|
+
*/
|
|
1025
|
+
type ListPlansFilter = {
|
|
1026
|
+
properties: {
|
|
1027
|
+
[k: string]: any;
|
|
1028
|
+
};
|
|
1029
|
+
};
|
|
1002
1030
|
type ListPlansUsageLimit = {
|
|
1003
1031
|
/**
|
|
1004
1032
|
* The feature this usage limit applies to.
|
|
@@ -1016,6 +1044,10 @@ type ListPlansUsageLimit = {
|
|
|
1016
1044
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
1017
1045
|
*/
|
|
1018
1046
|
interval: ListPlansUsageLimitInterval;
|
|
1047
|
+
/**
|
|
1048
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
1049
|
+
*/
|
|
1050
|
+
filter?: ListPlansFilter | undefined;
|
|
1019
1051
|
};
|
|
1020
1052
|
/**
|
|
1021
1053
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { C as ClosedEnum, O as OpenEnum, a as Balance, P as Plan } from './plan-
|
|
1
|
+
import { C as ClosedEnum, O as OpenEnum, a as Balance, P as Plan } from './plan-CUExbmy9.mjs';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Time range to aggregate events for. Either range or custom_range must be provided
|
|
@@ -764,6 +764,10 @@ type AttachSpendLimit = {
|
|
|
764
764
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
765
765
|
*/
|
|
766
766
|
overageLimit?: number | undefined;
|
|
767
|
+
/**
|
|
768
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
769
|
+
*/
|
|
770
|
+
skipOverageBilling?: boolean | undefined;
|
|
767
771
|
};
|
|
768
772
|
/**
|
|
769
773
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -778,6 +782,14 @@ declare const AttachUsageLimitInterval: {
|
|
|
778
782
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
779
783
|
*/
|
|
780
784
|
type AttachUsageLimitInterval = ClosedEnum<typeof AttachUsageLimitInterval>;
|
|
785
|
+
/**
|
|
786
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
787
|
+
*/
|
|
788
|
+
type AttachFilter = {
|
|
789
|
+
properties: {
|
|
790
|
+
[k: string]: string | number | boolean;
|
|
791
|
+
};
|
|
792
|
+
};
|
|
781
793
|
type AttachUsageLimit = {
|
|
782
794
|
/**
|
|
783
795
|
* The feature this usage limit applies to.
|
|
@@ -795,6 +807,10 @@ type AttachUsageLimit = {
|
|
|
795
807
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
796
808
|
*/
|
|
797
809
|
interval: AttachUsageLimitInterval;
|
|
810
|
+
/**
|
|
811
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
812
|
+
*/
|
|
813
|
+
filter?: AttachFilter | undefined;
|
|
798
814
|
};
|
|
799
815
|
/**
|
|
800
816
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -1149,6 +1165,7 @@ declare const AttachCode: {
|
|
|
1149
1165
|
readonly ThreedsRequired: "3ds_required";
|
|
1150
1166
|
readonly PaymentMethodRequired: "payment_method_required";
|
|
1151
1167
|
readonly PaymentFailed: "payment_failed";
|
|
1168
|
+
readonly PaymentProcessing: "payment_processing";
|
|
1152
1169
|
};
|
|
1153
1170
|
/**
|
|
1154
1171
|
* The type of action required to complete the payment.
|
|
@@ -1835,6 +1852,10 @@ type BillingUpdateSpendLimit = {
|
|
|
1835
1852
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
1836
1853
|
*/
|
|
1837
1854
|
overageLimit?: number | undefined;
|
|
1855
|
+
/**
|
|
1856
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
1857
|
+
*/
|
|
1858
|
+
skipOverageBilling?: boolean | undefined;
|
|
1838
1859
|
};
|
|
1839
1860
|
/**
|
|
1840
1861
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -1849,6 +1870,14 @@ declare const BillingUpdateUsageLimitInterval: {
|
|
|
1849
1870
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
1850
1871
|
*/
|
|
1851
1872
|
type BillingUpdateUsageLimitInterval = ClosedEnum<typeof BillingUpdateUsageLimitInterval>;
|
|
1873
|
+
/**
|
|
1874
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
1875
|
+
*/
|
|
1876
|
+
type BillingUpdateFilter = {
|
|
1877
|
+
properties: {
|
|
1878
|
+
[k: string]: string | number | boolean;
|
|
1879
|
+
};
|
|
1880
|
+
};
|
|
1852
1881
|
type BillingUpdateUsageLimit = {
|
|
1853
1882
|
/**
|
|
1854
1883
|
* The feature this usage limit applies to.
|
|
@@ -1866,6 +1895,10 @@ type BillingUpdateUsageLimit = {
|
|
|
1866
1895
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
1867
1896
|
*/
|
|
1868
1897
|
interval: BillingUpdateUsageLimitInterval;
|
|
1898
|
+
/**
|
|
1899
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
1900
|
+
*/
|
|
1901
|
+
filter?: BillingUpdateFilter | undefined;
|
|
1869
1902
|
};
|
|
1870
1903
|
/**
|
|
1871
1904
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -2039,6 +2072,17 @@ declare const BillingUpdateCancelAction: {
|
|
|
2039
2072
|
* Action to perform for cancellation. 'cancel_immediately' cancels now with prorated refund, 'cancel_end_of_cycle' cancels at period end, 'uncancel' reverses a pending cancellation.
|
|
2040
2073
|
*/
|
|
2041
2074
|
type BillingUpdateCancelAction = ClosedEnum<typeof BillingUpdateCancelAction>;
|
|
2075
|
+
/**
|
|
2076
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
2077
|
+
*/
|
|
2078
|
+
declare const BillingUpdateRefundLastPayment: {
|
|
2079
|
+
readonly Prorated: "prorated";
|
|
2080
|
+
readonly Full: "full";
|
|
2081
|
+
};
|
|
2082
|
+
/**
|
|
2083
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
2084
|
+
*/
|
|
2085
|
+
type BillingUpdateRefundLastPayment = ClosedEnum<typeof BillingUpdateRefundLastPayment>;
|
|
2042
2086
|
/**
|
|
2043
2087
|
* Controls whether balances should be recalculated during the subscription update.
|
|
2044
2088
|
*/
|
|
@@ -2118,6 +2162,10 @@ type UpdateSubscriptionParams = {
|
|
|
2118
2162
|
* If true, the subscription is updated internally without applying billing changes in Stripe.
|
|
2119
2163
|
*/
|
|
2120
2164
|
noBillingChanges?: boolean | undefined;
|
|
2165
|
+
/**
|
|
2166
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
2167
|
+
*/
|
|
2168
|
+
refundLastPayment?: BillingUpdateRefundLastPayment | undefined;
|
|
2121
2169
|
/**
|
|
2122
2170
|
* Controls whether balances should be recalculated during the subscription update.
|
|
2123
2171
|
*/
|
|
@@ -2159,6 +2207,7 @@ declare const BillingUpdateCode: {
|
|
|
2159
2207
|
readonly ThreedsRequired: "3ds_required";
|
|
2160
2208
|
readonly PaymentMethodRequired: "payment_method_required";
|
|
2161
2209
|
readonly PaymentFailed: "payment_failed";
|
|
2210
|
+
readonly PaymentProcessing: "payment_processing";
|
|
2162
2211
|
};
|
|
2163
2212
|
/**
|
|
2164
2213
|
* The type of action required to complete the payment.
|
|
@@ -2666,6 +2715,10 @@ type CheckSpendLimit2 = {
|
|
|
2666
2715
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
2667
2716
|
*/
|
|
2668
2717
|
overageLimit?: number | undefined;
|
|
2718
|
+
/**
|
|
2719
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
2720
|
+
*/
|
|
2721
|
+
skipOverageBilling?: boolean | undefined;
|
|
2669
2722
|
};
|
|
2670
2723
|
/**
|
|
2671
2724
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -2680,6 +2733,14 @@ declare const CheckUsageLimitInterval2: {
|
|
|
2680
2733
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
2681
2734
|
*/
|
|
2682
2735
|
type CheckUsageLimitInterval2 = OpenEnum<typeof CheckUsageLimitInterval2>;
|
|
2736
|
+
/**
|
|
2737
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
2738
|
+
*/
|
|
2739
|
+
type CheckFilter2 = {
|
|
2740
|
+
properties: {
|
|
2741
|
+
[k: string]: any;
|
|
2742
|
+
};
|
|
2743
|
+
};
|
|
2683
2744
|
type CheckUsageLimit2 = {
|
|
2684
2745
|
/**
|
|
2685
2746
|
* The feature this usage limit applies to.
|
|
@@ -2697,6 +2758,10 @@ type CheckUsageLimit2 = {
|
|
|
2697
2758
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
2698
2759
|
*/
|
|
2699
2760
|
interval: CheckUsageLimitInterval2;
|
|
2761
|
+
/**
|
|
2762
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
2763
|
+
*/
|
|
2764
|
+
filter?: CheckFilter2 | undefined;
|
|
2700
2765
|
};
|
|
2701
2766
|
/**
|
|
2702
2767
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -2787,7 +2852,7 @@ declare const ProductScenario2: {
|
|
|
2787
2852
|
* Scenario for when this product is used in attach flows
|
|
2788
2853
|
*/
|
|
2789
2854
|
type ProductScenario2 = OpenEnum<typeof ProductScenario2>;
|
|
2790
|
-
type
|
|
2855
|
+
type CheckProperties2 = {
|
|
2791
2856
|
/**
|
|
2792
2857
|
* True if the product has no base price or usage prices
|
|
2793
2858
|
*/
|
|
@@ -2866,7 +2931,7 @@ type CheckProduct2 = {
|
|
|
2866
2931
|
* Scenario for when this product is used in attach flows
|
|
2867
2932
|
*/
|
|
2868
2933
|
scenario?: ProductScenario2 | undefined;
|
|
2869
|
-
properties?:
|
|
2934
|
+
properties?: CheckProperties2 | undefined;
|
|
2870
2935
|
};
|
|
2871
2936
|
/**
|
|
2872
2937
|
* Upgrade/upsell information when access is denied. Only present if with_preview was true and allowed is false.
|
|
@@ -3346,6 +3411,10 @@ type CheckSpendLimit1 = {
|
|
|
3346
3411
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
3347
3412
|
*/
|
|
3348
3413
|
overageLimit?: number | undefined;
|
|
3414
|
+
/**
|
|
3415
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
3416
|
+
*/
|
|
3417
|
+
skipOverageBilling?: boolean | undefined;
|
|
3349
3418
|
};
|
|
3350
3419
|
/**
|
|
3351
3420
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -3360,6 +3429,14 @@ declare const CheckUsageLimitInterval1: {
|
|
|
3360
3429
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3361
3430
|
*/
|
|
3362
3431
|
type CheckUsageLimitInterval1 = OpenEnum<typeof CheckUsageLimitInterval1>;
|
|
3432
|
+
/**
|
|
3433
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3434
|
+
*/
|
|
3435
|
+
type CheckFilter1 = {
|
|
3436
|
+
properties: {
|
|
3437
|
+
[k: string]: any;
|
|
3438
|
+
};
|
|
3439
|
+
};
|
|
3363
3440
|
type CheckUsageLimit1 = {
|
|
3364
3441
|
/**
|
|
3365
3442
|
* The feature this usage limit applies to.
|
|
@@ -3377,6 +3454,10 @@ type CheckUsageLimit1 = {
|
|
|
3377
3454
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3378
3455
|
*/
|
|
3379
3456
|
interval: CheckUsageLimitInterval1;
|
|
3457
|
+
/**
|
|
3458
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3459
|
+
*/
|
|
3460
|
+
filter?: CheckFilter1 | undefined;
|
|
3380
3461
|
};
|
|
3381
3462
|
/**
|
|
3382
3463
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -3467,7 +3548,7 @@ declare const ProductScenario1: {
|
|
|
3467
3548
|
* Scenario for when this product is used in attach flows
|
|
3468
3549
|
*/
|
|
3469
3550
|
type ProductScenario1 = OpenEnum<typeof ProductScenario1>;
|
|
3470
|
-
type
|
|
3551
|
+
type CheckProperties1 = {
|
|
3471
3552
|
/**
|
|
3472
3553
|
* True if the product has no base price or usage prices
|
|
3473
3554
|
*/
|
|
@@ -3546,7 +3627,7 @@ type CheckProduct1 = {
|
|
|
3546
3627
|
* Scenario for when this product is used in attach flows
|
|
3547
3628
|
*/
|
|
3548
3629
|
scenario?: ProductScenario1 | undefined;
|
|
3549
|
-
properties?:
|
|
3630
|
+
properties?: CheckProperties1 | undefined;
|
|
3550
3631
|
};
|
|
3551
3632
|
/**
|
|
3552
3633
|
* Upgrade/upsell information when access is denied. Only present if with_preview was true and allowed is false.
|
|
@@ -3702,6 +3783,10 @@ type CustomerDataSpendLimit = {
|
|
|
3702
3783
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
3703
3784
|
*/
|
|
3704
3785
|
overageLimit?: number | undefined;
|
|
3786
|
+
/**
|
|
3787
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
3788
|
+
*/
|
|
3789
|
+
skipOverageBilling?: boolean | undefined;
|
|
3705
3790
|
};
|
|
3706
3791
|
/**
|
|
3707
3792
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -3716,6 +3801,14 @@ declare const CustomerDataUsageLimitInterval: {
|
|
|
3716
3801
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3717
3802
|
*/
|
|
3718
3803
|
type CustomerDataUsageLimitInterval = ClosedEnum<typeof CustomerDataUsageLimitInterval>;
|
|
3804
|
+
/**
|
|
3805
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3806
|
+
*/
|
|
3807
|
+
type CustomerDataFilter = {
|
|
3808
|
+
properties: {
|
|
3809
|
+
[k: string]: string | number | boolean;
|
|
3810
|
+
};
|
|
3811
|
+
};
|
|
3719
3812
|
type CustomerDataUsageLimit = {
|
|
3720
3813
|
/**
|
|
3721
3814
|
* The feature this usage limit applies to.
|
|
@@ -3733,6 +3826,10 @@ type CustomerDataUsageLimit = {
|
|
|
3733
3826
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3734
3827
|
*/
|
|
3735
3828
|
interval: CustomerDataUsageLimitInterval;
|
|
3829
|
+
/**
|
|
3830
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3831
|
+
*/
|
|
3832
|
+
filter?: CustomerDataFilter | undefined;
|
|
3736
3833
|
};
|
|
3737
3834
|
/**
|
|
3738
3835
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -4176,6 +4273,10 @@ type GetEntitySpendLimit = {
|
|
|
4176
4273
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
4177
4274
|
*/
|
|
4178
4275
|
overageLimit?: number | undefined;
|
|
4276
|
+
/**
|
|
4277
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
4278
|
+
*/
|
|
4279
|
+
skipOverageBilling?: boolean | undefined;
|
|
4179
4280
|
};
|
|
4180
4281
|
/**
|
|
4181
4282
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -4190,6 +4291,14 @@ declare const GetEntityInterval: {
|
|
|
4190
4291
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
4191
4292
|
*/
|
|
4192
4293
|
type GetEntityInterval = OpenEnum<typeof GetEntityInterval>;
|
|
4294
|
+
/**
|
|
4295
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
4296
|
+
*/
|
|
4297
|
+
type GetEntityFilter = {
|
|
4298
|
+
properties: {
|
|
4299
|
+
[k: string]: any;
|
|
4300
|
+
};
|
|
4301
|
+
};
|
|
4193
4302
|
type GetEntityUsageLimit = {
|
|
4194
4303
|
/**
|
|
4195
4304
|
* The feature this usage limit applies to.
|
|
@@ -4207,6 +4316,10 @@ type GetEntityUsageLimit = {
|
|
|
4207
4316
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
4208
4317
|
*/
|
|
4209
4318
|
interval: GetEntityInterval;
|
|
4319
|
+
/**
|
|
4320
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
4321
|
+
*/
|
|
4322
|
+
filter?: GetEntityFilter | undefined;
|
|
4210
4323
|
/**
|
|
4211
4324
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
4212
4325
|
*/
|
|
@@ -4914,6 +5027,10 @@ type MultiAttachSpendLimit = {
|
|
|
4914
5027
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
4915
5028
|
*/
|
|
4916
5029
|
overageLimit?: number | undefined;
|
|
5030
|
+
/**
|
|
5031
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
5032
|
+
*/
|
|
5033
|
+
skipOverageBilling?: boolean | undefined;
|
|
4917
5034
|
};
|
|
4918
5035
|
/**
|
|
4919
5036
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -4928,6 +5045,14 @@ declare const MultiAttachEntityDataInterval: {
|
|
|
4928
5045
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
4929
5046
|
*/
|
|
4930
5047
|
type MultiAttachEntityDataInterval = ClosedEnum<typeof MultiAttachEntityDataInterval>;
|
|
5048
|
+
/**
|
|
5049
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5050
|
+
*/
|
|
5051
|
+
type MultiAttachFilter = {
|
|
5052
|
+
properties: {
|
|
5053
|
+
[k: string]: string | number | boolean;
|
|
5054
|
+
};
|
|
5055
|
+
};
|
|
4931
5056
|
type MultiAttachUsageLimit = {
|
|
4932
5057
|
/**
|
|
4933
5058
|
* The feature this usage limit applies to.
|
|
@@ -4945,6 +5070,10 @@ type MultiAttachUsageLimit = {
|
|
|
4945
5070
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
4946
5071
|
*/
|
|
4947
5072
|
interval: MultiAttachEntityDataInterval;
|
|
5073
|
+
/**
|
|
5074
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5075
|
+
*/
|
|
5076
|
+
filter?: MultiAttachFilter | undefined;
|
|
4948
5077
|
};
|
|
4949
5078
|
/**
|
|
4950
5079
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -5111,6 +5240,7 @@ declare const MultiAttachCode: {
|
|
|
5111
5240
|
readonly ThreedsRequired: "3ds_required";
|
|
5112
5241
|
readonly PaymentMethodRequired: "payment_method_required";
|
|
5113
5242
|
readonly PaymentFailed: "payment_failed";
|
|
5243
|
+
readonly PaymentProcessing: "payment_processing";
|
|
5114
5244
|
};
|
|
5115
5245
|
/**
|
|
5116
5246
|
* The type of action required to complete the payment.
|
|
@@ -5825,6 +5955,10 @@ type PreviewAttachSpendLimit = {
|
|
|
5825
5955
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
5826
5956
|
*/
|
|
5827
5957
|
overageLimit?: number | undefined;
|
|
5958
|
+
/**
|
|
5959
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
5960
|
+
*/
|
|
5961
|
+
skipOverageBilling?: boolean | undefined;
|
|
5828
5962
|
};
|
|
5829
5963
|
/**
|
|
5830
5964
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -5839,6 +5973,14 @@ declare const PreviewAttachUsageLimitInterval: {
|
|
|
5839
5973
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5840
5974
|
*/
|
|
5841
5975
|
type PreviewAttachUsageLimitInterval = ClosedEnum<typeof PreviewAttachUsageLimitInterval>;
|
|
5976
|
+
/**
|
|
5977
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5978
|
+
*/
|
|
5979
|
+
type PreviewAttachFilter = {
|
|
5980
|
+
properties: {
|
|
5981
|
+
[k: string]: string | number | boolean;
|
|
5982
|
+
};
|
|
5983
|
+
};
|
|
5842
5984
|
type PreviewAttachUsageLimit = {
|
|
5843
5985
|
/**
|
|
5844
5986
|
* The feature this usage limit applies to.
|
|
@@ -5856,6 +5998,10 @@ type PreviewAttachUsageLimit = {
|
|
|
5856
5998
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5857
5999
|
*/
|
|
5858
6000
|
interval: PreviewAttachUsageLimitInterval;
|
|
6001
|
+
/**
|
|
6002
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
6003
|
+
*/
|
|
6004
|
+
filter?: PreviewAttachFilter | undefined;
|
|
5859
6005
|
};
|
|
5860
6006
|
/**
|
|
5861
6007
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -6935,6 +7081,10 @@ type PreviewMultiAttachSpendLimit = {
|
|
|
6935
7081
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
6936
7082
|
*/
|
|
6937
7083
|
overageLimit?: number | undefined;
|
|
7084
|
+
/**
|
|
7085
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
7086
|
+
*/
|
|
7087
|
+
skipOverageBilling?: boolean | undefined;
|
|
6938
7088
|
};
|
|
6939
7089
|
/**
|
|
6940
7090
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -6949,6 +7099,14 @@ declare const PreviewMultiAttachEntityDataInterval: {
|
|
|
6949
7099
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
6950
7100
|
*/
|
|
6951
7101
|
type PreviewMultiAttachEntityDataInterval = ClosedEnum<typeof PreviewMultiAttachEntityDataInterval>;
|
|
7102
|
+
/**
|
|
7103
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
7104
|
+
*/
|
|
7105
|
+
type PreviewMultiAttachFilter = {
|
|
7106
|
+
properties: {
|
|
7107
|
+
[k: string]: string | number | boolean;
|
|
7108
|
+
};
|
|
7109
|
+
};
|
|
6952
7110
|
type PreviewMultiAttachUsageLimit = {
|
|
6953
7111
|
/**
|
|
6954
7112
|
* The feature this usage limit applies to.
|
|
@@ -6966,6 +7124,10 @@ type PreviewMultiAttachUsageLimit = {
|
|
|
6966
7124
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
6967
7125
|
*/
|
|
6968
7126
|
interval: PreviewMultiAttachEntityDataInterval;
|
|
7127
|
+
/**
|
|
7128
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
7129
|
+
*/
|
|
7130
|
+
filter?: PreviewMultiAttachFilter | undefined;
|
|
6969
7131
|
};
|
|
6970
7132
|
/**
|
|
6971
7133
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -8087,6 +8249,10 @@ type PreviewUpdateSpendLimit = {
|
|
|
8087
8249
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
8088
8250
|
*/
|
|
8089
8251
|
overageLimit?: number | undefined;
|
|
8252
|
+
/**
|
|
8253
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
8254
|
+
*/
|
|
8255
|
+
skipOverageBilling?: boolean | undefined;
|
|
8090
8256
|
};
|
|
8091
8257
|
/**
|
|
8092
8258
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -8101,6 +8267,14 @@ declare const PreviewUpdateUsageLimitInterval: {
|
|
|
8101
8267
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
8102
8268
|
*/
|
|
8103
8269
|
type PreviewUpdateUsageLimitInterval = ClosedEnum<typeof PreviewUpdateUsageLimitInterval>;
|
|
8270
|
+
/**
|
|
8271
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
8272
|
+
*/
|
|
8273
|
+
type PreviewUpdateFilter = {
|
|
8274
|
+
properties: {
|
|
8275
|
+
[k: string]: string | number | boolean;
|
|
8276
|
+
};
|
|
8277
|
+
};
|
|
8104
8278
|
type PreviewUpdateUsageLimit = {
|
|
8105
8279
|
/**
|
|
8106
8280
|
* The feature this usage limit applies to.
|
|
@@ -8118,6 +8292,10 @@ type PreviewUpdateUsageLimit = {
|
|
|
8118
8292
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
8119
8293
|
*/
|
|
8120
8294
|
interval: PreviewUpdateUsageLimitInterval;
|
|
8295
|
+
/**
|
|
8296
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
8297
|
+
*/
|
|
8298
|
+
filter?: PreviewUpdateFilter | undefined;
|
|
8121
8299
|
};
|
|
8122
8300
|
/**
|
|
8123
8301
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -8291,6 +8469,17 @@ declare const PreviewUpdateCancelAction: {
|
|
|
8291
8469
|
* Action to perform for cancellation. 'cancel_immediately' cancels now with prorated refund, 'cancel_end_of_cycle' cancels at period end, 'uncancel' reverses a pending cancellation.
|
|
8292
8470
|
*/
|
|
8293
8471
|
type PreviewUpdateCancelAction = ClosedEnum<typeof PreviewUpdateCancelAction>;
|
|
8472
|
+
/**
|
|
8473
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
8474
|
+
*/
|
|
8475
|
+
declare const PreviewUpdateRefundLastPayment: {
|
|
8476
|
+
readonly Prorated: "prorated";
|
|
8477
|
+
readonly Full: "full";
|
|
8478
|
+
};
|
|
8479
|
+
/**
|
|
8480
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
8481
|
+
*/
|
|
8482
|
+
type PreviewUpdateRefundLastPayment = ClosedEnum<typeof PreviewUpdateRefundLastPayment>;
|
|
8294
8483
|
/**
|
|
8295
8484
|
* Controls whether balances should be recalculated during the subscription update.
|
|
8296
8485
|
*/
|
|
@@ -8370,6 +8559,10 @@ type PreviewUpdateParams = {
|
|
|
8370
8559
|
* If true, the subscription is updated internally without applying billing changes in Stripe.
|
|
8371
8560
|
*/
|
|
8372
8561
|
noBillingChanges?: boolean | undefined;
|
|
8562
|
+
/**
|
|
8563
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
8564
|
+
*/
|
|
8565
|
+
refundLastPayment?: PreviewUpdateRefundLastPayment | undefined;
|
|
8373
8566
|
/**
|
|
8374
8567
|
* Controls whether balances should be recalculated during the subscription update.
|
|
8375
8568
|
*/
|
|
@@ -9394,6 +9587,10 @@ type SetupPaymentSpendLimit = {
|
|
|
9394
9587
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
9395
9588
|
*/
|
|
9396
9589
|
overageLimit?: number | undefined;
|
|
9590
|
+
/**
|
|
9591
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
9592
|
+
*/
|
|
9593
|
+
skipOverageBilling?: boolean | undefined;
|
|
9397
9594
|
};
|
|
9398
9595
|
/**
|
|
9399
9596
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -9408,6 +9605,14 @@ declare const SetupPaymentUsageLimitInterval: {
|
|
|
9408
9605
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
9409
9606
|
*/
|
|
9410
9607
|
type SetupPaymentUsageLimitInterval = ClosedEnum<typeof SetupPaymentUsageLimitInterval>;
|
|
9608
|
+
/**
|
|
9609
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
9610
|
+
*/
|
|
9611
|
+
type SetupPaymentFilter = {
|
|
9612
|
+
properties: {
|
|
9613
|
+
[k: string]: string | number | boolean;
|
|
9614
|
+
};
|
|
9615
|
+
};
|
|
9411
9616
|
type SetupPaymentUsageLimit = {
|
|
9412
9617
|
/**
|
|
9413
9618
|
* The feature this usage limit applies to.
|
|
@@ -9425,6 +9630,10 @@ type SetupPaymentUsageLimit = {
|
|
|
9425
9630
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
9426
9631
|
*/
|
|
9427
9632
|
interval: SetupPaymentUsageLimitInterval;
|
|
9633
|
+
/**
|
|
9634
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
9635
|
+
*/
|
|
9636
|
+
filter?: SetupPaymentFilter | undefined;
|
|
9428
9637
|
};
|
|
9429
9638
|
/**
|
|
9430
9639
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|