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 { b as ClosedEnum, O as OpenEnum, c as CustomerExpand, G as GetOrCreateCustomerParams, R as ResolvedIdentity } from './authTypes-
|
|
1
|
+
import { b as ClosedEnum, O as OpenEnum, c as CustomerExpand, G as GetOrCreateCustomerParams, R as ResolvedIdentity } from './authTypes-jU7ON-I5.js';
|
|
2
2
|
import { z } from 'zod/v4';
|
|
3
3
|
import { ProtectedBodyField } from './core/utils/sanitizeBody.js';
|
|
4
4
|
import { BackendResult } from './core/types/responseTypes.js';
|
|
@@ -888,6 +888,10 @@ type AttachSpendLimit = {
|
|
|
888
888
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
889
889
|
*/
|
|
890
890
|
overageLimit?: number | undefined;
|
|
891
|
+
/**
|
|
892
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
893
|
+
*/
|
|
894
|
+
skipOverageBilling?: boolean | undefined;
|
|
891
895
|
};
|
|
892
896
|
/**
|
|
893
897
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -902,6 +906,14 @@ declare const AttachUsageLimitInterval: {
|
|
|
902
906
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
903
907
|
*/
|
|
904
908
|
type AttachUsageLimitInterval = ClosedEnum<typeof AttachUsageLimitInterval>;
|
|
909
|
+
/**
|
|
910
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
911
|
+
*/
|
|
912
|
+
type AttachFilter = {
|
|
913
|
+
properties: {
|
|
914
|
+
[k: string]: string | number | boolean;
|
|
915
|
+
};
|
|
916
|
+
};
|
|
905
917
|
type AttachUsageLimit = {
|
|
906
918
|
/**
|
|
907
919
|
* The feature this usage limit applies to.
|
|
@@ -919,6 +931,10 @@ type AttachUsageLimit = {
|
|
|
919
931
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
920
932
|
*/
|
|
921
933
|
interval: AttachUsageLimitInterval;
|
|
934
|
+
/**
|
|
935
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
936
|
+
*/
|
|
937
|
+
filter?: AttachFilter | undefined;
|
|
922
938
|
};
|
|
923
939
|
/**
|
|
924
940
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -1273,6 +1289,7 @@ declare const AttachCode: {
|
|
|
1273
1289
|
readonly ThreedsRequired: "3ds_required";
|
|
1274
1290
|
readonly PaymentMethodRequired: "payment_method_required";
|
|
1275
1291
|
readonly PaymentFailed: "payment_failed";
|
|
1292
|
+
readonly PaymentProcessing: "payment_processing";
|
|
1276
1293
|
};
|
|
1277
1294
|
/**
|
|
1278
1295
|
* The type of action required to complete the payment.
|
|
@@ -2292,6 +2309,10 @@ type BillingUpdateSpendLimit = {
|
|
|
2292
2309
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
2293
2310
|
*/
|
|
2294
2311
|
overageLimit?: number | undefined;
|
|
2312
|
+
/**
|
|
2313
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
2314
|
+
*/
|
|
2315
|
+
skipOverageBilling?: boolean | undefined;
|
|
2295
2316
|
};
|
|
2296
2317
|
/**
|
|
2297
2318
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -2306,6 +2327,14 @@ declare const BillingUpdateUsageLimitInterval: {
|
|
|
2306
2327
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
2307
2328
|
*/
|
|
2308
2329
|
type BillingUpdateUsageLimitInterval = ClosedEnum<typeof BillingUpdateUsageLimitInterval>;
|
|
2330
|
+
/**
|
|
2331
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
2332
|
+
*/
|
|
2333
|
+
type BillingUpdateFilter = {
|
|
2334
|
+
properties: {
|
|
2335
|
+
[k: string]: string | number | boolean;
|
|
2336
|
+
};
|
|
2337
|
+
};
|
|
2309
2338
|
type BillingUpdateUsageLimit = {
|
|
2310
2339
|
/**
|
|
2311
2340
|
* The feature this usage limit applies to.
|
|
@@ -2323,6 +2352,10 @@ type BillingUpdateUsageLimit = {
|
|
|
2323
2352
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
2324
2353
|
*/
|
|
2325
2354
|
interval: BillingUpdateUsageLimitInterval;
|
|
2355
|
+
/**
|
|
2356
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
2357
|
+
*/
|
|
2358
|
+
filter?: BillingUpdateFilter | undefined;
|
|
2326
2359
|
};
|
|
2327
2360
|
/**
|
|
2328
2361
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -2496,6 +2529,17 @@ declare const BillingUpdateCancelAction: {
|
|
|
2496
2529
|
* 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.
|
|
2497
2530
|
*/
|
|
2498
2531
|
type BillingUpdateCancelAction = ClosedEnum<typeof BillingUpdateCancelAction>;
|
|
2532
|
+
/**
|
|
2533
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
2534
|
+
*/
|
|
2535
|
+
declare const BillingUpdateRefundLastPayment: {
|
|
2536
|
+
readonly Prorated: "prorated";
|
|
2537
|
+
readonly Full: "full";
|
|
2538
|
+
};
|
|
2539
|
+
/**
|
|
2540
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
2541
|
+
*/
|
|
2542
|
+
type BillingUpdateRefundLastPayment = ClosedEnum<typeof BillingUpdateRefundLastPayment>;
|
|
2499
2543
|
/**
|
|
2500
2544
|
* Controls whether balances should be recalculated during the subscription update.
|
|
2501
2545
|
*/
|
|
@@ -2575,6 +2619,10 @@ type UpdateSubscriptionParams = {
|
|
|
2575
2619
|
* If true, the subscription is updated internally without applying billing changes in Stripe.
|
|
2576
2620
|
*/
|
|
2577
2621
|
noBillingChanges?: boolean | undefined;
|
|
2622
|
+
/**
|
|
2623
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
2624
|
+
*/
|
|
2625
|
+
refundLastPayment?: BillingUpdateRefundLastPayment | undefined;
|
|
2578
2626
|
/**
|
|
2579
2627
|
* Controls whether balances should be recalculated during the subscription update.
|
|
2580
2628
|
*/
|
|
@@ -2616,6 +2664,7 @@ declare const BillingUpdateCode: {
|
|
|
2616
2664
|
readonly ThreedsRequired: "3ds_required";
|
|
2617
2665
|
readonly PaymentMethodRequired: "payment_method_required";
|
|
2618
2666
|
readonly PaymentFailed: "payment_failed";
|
|
2667
|
+
readonly PaymentProcessing: "payment_processing";
|
|
2619
2668
|
};
|
|
2620
2669
|
/**
|
|
2621
2670
|
* The type of action required to complete the payment.
|
|
@@ -3123,6 +3172,10 @@ type CheckSpendLimit2 = {
|
|
|
3123
3172
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
3124
3173
|
*/
|
|
3125
3174
|
overageLimit?: number | undefined;
|
|
3175
|
+
/**
|
|
3176
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
3177
|
+
*/
|
|
3178
|
+
skipOverageBilling?: boolean | undefined;
|
|
3126
3179
|
};
|
|
3127
3180
|
/**
|
|
3128
3181
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -3137,6 +3190,14 @@ declare const CheckUsageLimitInterval2: {
|
|
|
3137
3190
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3138
3191
|
*/
|
|
3139
3192
|
type CheckUsageLimitInterval2 = OpenEnum<typeof CheckUsageLimitInterval2>;
|
|
3193
|
+
/**
|
|
3194
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3195
|
+
*/
|
|
3196
|
+
type CheckFilter2 = {
|
|
3197
|
+
properties: {
|
|
3198
|
+
[k: string]: any;
|
|
3199
|
+
};
|
|
3200
|
+
};
|
|
3140
3201
|
type CheckUsageLimit2 = {
|
|
3141
3202
|
/**
|
|
3142
3203
|
* The feature this usage limit applies to.
|
|
@@ -3154,6 +3215,10 @@ type CheckUsageLimit2 = {
|
|
|
3154
3215
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3155
3216
|
*/
|
|
3156
3217
|
interval: CheckUsageLimitInterval2;
|
|
3218
|
+
/**
|
|
3219
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3220
|
+
*/
|
|
3221
|
+
filter?: CheckFilter2 | undefined;
|
|
3157
3222
|
};
|
|
3158
3223
|
/**
|
|
3159
3224
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -3244,7 +3309,7 @@ declare const ProductScenario2: {
|
|
|
3244
3309
|
* Scenario for when this product is used in attach flows
|
|
3245
3310
|
*/
|
|
3246
3311
|
type ProductScenario2 = OpenEnum<typeof ProductScenario2>;
|
|
3247
|
-
type
|
|
3312
|
+
type CheckProperties2 = {
|
|
3248
3313
|
/**
|
|
3249
3314
|
* True if the product has no base price or usage prices
|
|
3250
3315
|
*/
|
|
@@ -3323,7 +3388,7 @@ type CheckProduct2 = {
|
|
|
3323
3388
|
* Scenario for when this product is used in attach flows
|
|
3324
3389
|
*/
|
|
3325
3390
|
scenario?: ProductScenario2 | undefined;
|
|
3326
|
-
properties?:
|
|
3391
|
+
properties?: CheckProperties2 | undefined;
|
|
3327
3392
|
};
|
|
3328
3393
|
/**
|
|
3329
3394
|
* Upgrade/upsell information when access is denied. Only present if with_preview was true and allowed is false.
|
|
@@ -3803,6 +3868,10 @@ type CheckSpendLimit1 = {
|
|
|
3803
3868
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
3804
3869
|
*/
|
|
3805
3870
|
overageLimit?: number | undefined;
|
|
3871
|
+
/**
|
|
3872
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
3873
|
+
*/
|
|
3874
|
+
skipOverageBilling?: boolean | undefined;
|
|
3806
3875
|
};
|
|
3807
3876
|
/**
|
|
3808
3877
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -3817,6 +3886,14 @@ declare const CheckUsageLimitInterval1: {
|
|
|
3817
3886
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3818
3887
|
*/
|
|
3819
3888
|
type CheckUsageLimitInterval1 = OpenEnum<typeof CheckUsageLimitInterval1>;
|
|
3889
|
+
/**
|
|
3890
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3891
|
+
*/
|
|
3892
|
+
type CheckFilter1 = {
|
|
3893
|
+
properties: {
|
|
3894
|
+
[k: string]: any;
|
|
3895
|
+
};
|
|
3896
|
+
};
|
|
3820
3897
|
type CheckUsageLimit1 = {
|
|
3821
3898
|
/**
|
|
3822
3899
|
* The feature this usage limit applies to.
|
|
@@ -3834,6 +3911,10 @@ type CheckUsageLimit1 = {
|
|
|
3834
3911
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
3835
3912
|
*/
|
|
3836
3913
|
interval: CheckUsageLimitInterval1;
|
|
3914
|
+
/**
|
|
3915
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
3916
|
+
*/
|
|
3917
|
+
filter?: CheckFilter1 | undefined;
|
|
3837
3918
|
};
|
|
3838
3919
|
/**
|
|
3839
3920
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -3924,7 +4005,7 @@ declare const ProductScenario1: {
|
|
|
3924
4005
|
* Scenario for when this product is used in attach flows
|
|
3925
4006
|
*/
|
|
3926
4007
|
type ProductScenario1 = OpenEnum<typeof ProductScenario1>;
|
|
3927
|
-
type
|
|
4008
|
+
type CheckProperties1 = {
|
|
3928
4009
|
/**
|
|
3929
4010
|
* True if the product has no base price or usage prices
|
|
3930
4011
|
*/
|
|
@@ -4003,7 +4084,7 @@ type CheckProduct1 = {
|
|
|
4003
4084
|
* Scenario for when this product is used in attach flows
|
|
4004
4085
|
*/
|
|
4005
4086
|
scenario?: ProductScenario1 | undefined;
|
|
4006
|
-
properties?:
|
|
4087
|
+
properties?: CheckProperties1 | undefined;
|
|
4007
4088
|
};
|
|
4008
4089
|
/**
|
|
4009
4090
|
* Upgrade/upsell information when access is denied. Only present if with_preview was true and allowed is false.
|
|
@@ -4253,6 +4334,10 @@ type CustomerDataSpendLimit = {
|
|
|
4253
4334
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
4254
4335
|
*/
|
|
4255
4336
|
overageLimit?: number | undefined;
|
|
4337
|
+
/**
|
|
4338
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
4339
|
+
*/
|
|
4340
|
+
skipOverageBilling?: boolean | undefined;
|
|
4256
4341
|
};
|
|
4257
4342
|
/**
|
|
4258
4343
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -4267,6 +4352,14 @@ declare const CustomerDataUsageLimitInterval: {
|
|
|
4267
4352
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
4268
4353
|
*/
|
|
4269
4354
|
type CustomerDataUsageLimitInterval = ClosedEnum<typeof CustomerDataUsageLimitInterval>;
|
|
4355
|
+
/**
|
|
4356
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
4357
|
+
*/
|
|
4358
|
+
type CustomerDataFilter = {
|
|
4359
|
+
properties: {
|
|
4360
|
+
[k: string]: string | number | boolean;
|
|
4361
|
+
};
|
|
4362
|
+
};
|
|
4270
4363
|
type CustomerDataUsageLimit = {
|
|
4271
4364
|
/**
|
|
4272
4365
|
* The feature this usage limit applies to.
|
|
@@ -4284,6 +4377,10 @@ type CustomerDataUsageLimit = {
|
|
|
4284
4377
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
4285
4378
|
*/
|
|
4286
4379
|
interval: CustomerDataUsageLimitInterval;
|
|
4380
|
+
/**
|
|
4381
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
4382
|
+
*/
|
|
4383
|
+
filter?: CustomerDataFilter | undefined;
|
|
4287
4384
|
};
|
|
4288
4385
|
/**
|
|
4289
4386
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -5168,6 +5265,10 @@ type PlanVariantDetailsSpendLimit = {
|
|
|
5168
5265
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
5169
5266
|
*/
|
|
5170
5267
|
overageLimit?: number | undefined;
|
|
5268
|
+
/**
|
|
5269
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
5270
|
+
*/
|
|
5271
|
+
skipOverageBilling?: boolean | undefined;
|
|
5171
5272
|
};
|
|
5172
5273
|
/**
|
|
5173
5274
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -5182,6 +5283,14 @@ declare const PlanVariantDetailsUsageLimitInterval: {
|
|
|
5182
5283
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5183
5284
|
*/
|
|
5184
5285
|
type PlanVariantDetailsUsageLimitInterval = OpenEnum<typeof PlanVariantDetailsUsageLimitInterval>;
|
|
5286
|
+
/**
|
|
5287
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5288
|
+
*/
|
|
5289
|
+
type PlanVariantDetailsFilter = {
|
|
5290
|
+
properties: {
|
|
5291
|
+
[k: string]: any;
|
|
5292
|
+
};
|
|
5293
|
+
};
|
|
5185
5294
|
type PlanVariantDetailsUsageLimit = {
|
|
5186
5295
|
/**
|
|
5187
5296
|
* The feature this usage limit applies to.
|
|
@@ -5199,6 +5308,10 @@ type PlanVariantDetailsUsageLimit = {
|
|
|
5199
5308
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5200
5309
|
*/
|
|
5201
5310
|
interval: PlanVariantDetailsUsageLimitInterval;
|
|
5311
|
+
/**
|
|
5312
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5313
|
+
*/
|
|
5314
|
+
filter?: PlanVariantDetailsFilter | undefined;
|
|
5202
5315
|
};
|
|
5203
5316
|
/**
|
|
5204
5317
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -5401,6 +5514,10 @@ type PlanSpendLimit = {
|
|
|
5401
5514
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
5402
5515
|
*/
|
|
5403
5516
|
overageLimit?: number | undefined;
|
|
5517
|
+
/**
|
|
5518
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
5519
|
+
*/
|
|
5520
|
+
skipOverageBilling?: boolean | undefined;
|
|
5404
5521
|
};
|
|
5405
5522
|
/**
|
|
5406
5523
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -5415,6 +5532,14 @@ declare const PlanUsageLimitInterval: {
|
|
|
5415
5532
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5416
5533
|
*/
|
|
5417
5534
|
type PlanUsageLimitInterval = OpenEnum<typeof PlanUsageLimitInterval>;
|
|
5535
|
+
/**
|
|
5536
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5537
|
+
*/
|
|
5538
|
+
type PlanFilter = {
|
|
5539
|
+
properties: {
|
|
5540
|
+
[k: string]: any;
|
|
5541
|
+
};
|
|
5542
|
+
};
|
|
5418
5543
|
type PlanUsageLimit = {
|
|
5419
5544
|
/**
|
|
5420
5545
|
* The feature this usage limit applies to.
|
|
@@ -5432,6 +5557,10 @@ type PlanUsageLimit = {
|
|
|
5432
5557
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5433
5558
|
*/
|
|
5434
5559
|
interval: PlanUsageLimitInterval;
|
|
5560
|
+
/**
|
|
5561
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5562
|
+
*/
|
|
5563
|
+
filter?: PlanFilter | undefined;
|
|
5435
5564
|
};
|
|
5436
5565
|
/**
|
|
5437
5566
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -5656,6 +5785,10 @@ type CreateEntitySpendLimitRequest = {
|
|
|
5656
5785
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
5657
5786
|
*/
|
|
5658
5787
|
overageLimit?: number | undefined;
|
|
5788
|
+
/**
|
|
5789
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
5790
|
+
*/
|
|
5791
|
+
skipOverageBilling?: boolean | undefined;
|
|
5659
5792
|
};
|
|
5660
5793
|
/**
|
|
5661
5794
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -5670,6 +5803,14 @@ declare const CreateEntityIntervalRequestBody: {
|
|
|
5670
5803
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5671
5804
|
*/
|
|
5672
5805
|
type CreateEntityIntervalRequestBody = ClosedEnum<typeof CreateEntityIntervalRequestBody>;
|
|
5806
|
+
/**
|
|
5807
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5808
|
+
*/
|
|
5809
|
+
type CreateEntityFilterRequest = {
|
|
5810
|
+
properties: {
|
|
5811
|
+
[k: string]: string | number | boolean;
|
|
5812
|
+
};
|
|
5813
|
+
};
|
|
5673
5814
|
type CreateEntityUsageLimitRequest = {
|
|
5674
5815
|
/**
|
|
5675
5816
|
* The feature this usage limit applies to.
|
|
@@ -5687,6 +5828,10 @@ type CreateEntityUsageLimitRequest = {
|
|
|
5687
5828
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
5688
5829
|
*/
|
|
5689
5830
|
interval: CreateEntityIntervalRequestBody;
|
|
5831
|
+
/**
|
|
5832
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
5833
|
+
*/
|
|
5834
|
+
filter?: CreateEntityFilterRequest | undefined;
|
|
5690
5835
|
};
|
|
5691
5836
|
/**
|
|
5692
5837
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -6053,6 +6198,10 @@ type CreateEntitySpendLimitResponse = {
|
|
|
6053
6198
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
6054
6199
|
*/
|
|
6055
6200
|
overageLimit?: number | undefined;
|
|
6201
|
+
/**
|
|
6202
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
6203
|
+
*/
|
|
6204
|
+
skipOverageBilling?: boolean | undefined;
|
|
6056
6205
|
};
|
|
6057
6206
|
/**
|
|
6058
6207
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -6067,6 +6216,14 @@ declare const CreateEntityIntervalResponse: {
|
|
|
6067
6216
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
6068
6217
|
*/
|
|
6069
6218
|
type CreateEntityIntervalResponse = OpenEnum<typeof CreateEntityIntervalResponse>;
|
|
6219
|
+
/**
|
|
6220
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
6221
|
+
*/
|
|
6222
|
+
type CreateEntityFilterResponse = {
|
|
6223
|
+
properties: {
|
|
6224
|
+
[k: string]: any;
|
|
6225
|
+
};
|
|
6226
|
+
};
|
|
6070
6227
|
type CreateEntityUsageLimitResponse = {
|
|
6071
6228
|
/**
|
|
6072
6229
|
* The feature this usage limit applies to.
|
|
@@ -6084,6 +6241,10 @@ type CreateEntityUsageLimitResponse = {
|
|
|
6084
6241
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
6085
6242
|
*/
|
|
6086
6243
|
interval: CreateEntityIntervalResponse;
|
|
6244
|
+
/**
|
|
6245
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
6246
|
+
*/
|
|
6247
|
+
filter?: CreateEntityFilterResponse | undefined;
|
|
6087
6248
|
/**
|
|
6088
6249
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
6089
6250
|
*/
|
|
@@ -6794,6 +6955,10 @@ type CreatePlanSpendLimitRequest = {
|
|
|
6794
6955
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
6795
6956
|
*/
|
|
6796
6957
|
overageLimit?: number | undefined;
|
|
6958
|
+
/**
|
|
6959
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
6960
|
+
*/
|
|
6961
|
+
skipOverageBilling?: boolean | undefined;
|
|
6797
6962
|
};
|
|
6798
6963
|
/**
|
|
6799
6964
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -6808,6 +6973,14 @@ declare const CreatePlanUsageLimitIntervalRequestBody: {
|
|
|
6808
6973
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
6809
6974
|
*/
|
|
6810
6975
|
type CreatePlanUsageLimitIntervalRequestBody = ClosedEnum<typeof CreatePlanUsageLimitIntervalRequestBody>;
|
|
6976
|
+
/**
|
|
6977
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
6978
|
+
*/
|
|
6979
|
+
type CreatePlanFilterRequest = {
|
|
6980
|
+
properties: {
|
|
6981
|
+
[k: string]: string | number | boolean;
|
|
6982
|
+
};
|
|
6983
|
+
};
|
|
6811
6984
|
type CreatePlanUsageLimitRequest = {
|
|
6812
6985
|
/**
|
|
6813
6986
|
* The feature this usage limit applies to.
|
|
@@ -6825,6 +6998,10 @@ type CreatePlanUsageLimitRequest = {
|
|
|
6825
6998
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
6826
6999
|
*/
|
|
6827
7000
|
interval: CreatePlanUsageLimitIntervalRequestBody;
|
|
7001
|
+
/**
|
|
7002
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
7003
|
+
*/
|
|
7004
|
+
filter?: CreatePlanFilterRequest | undefined;
|
|
6828
7005
|
};
|
|
6829
7006
|
/**
|
|
6830
7007
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -7701,6 +7878,10 @@ type CreatePlanVariantDetailsSpendLimit = {
|
|
|
7701
7878
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
7702
7879
|
*/
|
|
7703
7880
|
overageLimit?: number | undefined;
|
|
7881
|
+
/**
|
|
7882
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
7883
|
+
*/
|
|
7884
|
+
skipOverageBilling?: boolean | undefined;
|
|
7704
7885
|
};
|
|
7705
7886
|
/**
|
|
7706
7887
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -7715,6 +7896,14 @@ declare const CreatePlanVariantDetailsUsageLimitInterval: {
|
|
|
7715
7896
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
7716
7897
|
*/
|
|
7717
7898
|
type CreatePlanVariantDetailsUsageLimitInterval = OpenEnum<typeof CreatePlanVariantDetailsUsageLimitInterval>;
|
|
7899
|
+
/**
|
|
7900
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
7901
|
+
*/
|
|
7902
|
+
type CreatePlanVariantDetailsFilter = {
|
|
7903
|
+
properties: {
|
|
7904
|
+
[k: string]: any;
|
|
7905
|
+
};
|
|
7906
|
+
};
|
|
7718
7907
|
type CreatePlanVariantDetailsUsageLimit = {
|
|
7719
7908
|
/**
|
|
7720
7909
|
* The feature this usage limit applies to.
|
|
@@ -7732,6 +7921,10 @@ type CreatePlanVariantDetailsUsageLimit = {
|
|
|
7732
7921
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
7733
7922
|
*/
|
|
7734
7923
|
interval: CreatePlanVariantDetailsUsageLimitInterval;
|
|
7924
|
+
/**
|
|
7925
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
7926
|
+
*/
|
|
7927
|
+
filter?: CreatePlanVariantDetailsFilter | undefined;
|
|
7735
7928
|
};
|
|
7736
7929
|
/**
|
|
7737
7930
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -7934,6 +8127,10 @@ type CreatePlanSpendLimitResponse = {
|
|
|
7934
8127
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
7935
8128
|
*/
|
|
7936
8129
|
overageLimit?: number | undefined;
|
|
8130
|
+
/**
|
|
8131
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
8132
|
+
*/
|
|
8133
|
+
skipOverageBilling?: boolean | undefined;
|
|
7937
8134
|
};
|
|
7938
8135
|
/**
|
|
7939
8136
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -7948,6 +8145,14 @@ declare const CreatePlanUsageLimitIntervalResponse: {
|
|
|
7948
8145
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
7949
8146
|
*/
|
|
7950
8147
|
type CreatePlanUsageLimitIntervalResponse = OpenEnum<typeof CreatePlanUsageLimitIntervalResponse>;
|
|
8148
|
+
/**
|
|
8149
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
8150
|
+
*/
|
|
8151
|
+
type CreatePlanFilterResponse = {
|
|
8152
|
+
properties: {
|
|
8153
|
+
[k: string]: any;
|
|
8154
|
+
};
|
|
8155
|
+
};
|
|
7951
8156
|
type CreatePlanUsageLimitResponse = {
|
|
7952
8157
|
/**
|
|
7953
8158
|
* The feature this usage limit applies to.
|
|
@@ -7965,6 +8170,10 @@ type CreatePlanUsageLimitResponse = {
|
|
|
7965
8170
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
7966
8171
|
*/
|
|
7967
8172
|
interval: CreatePlanUsageLimitIntervalResponse;
|
|
8173
|
+
/**
|
|
8174
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
8175
|
+
*/
|
|
8176
|
+
filter?: CreatePlanFilterResponse | undefined;
|
|
7968
8177
|
};
|
|
7969
8178
|
/**
|
|
7970
8179
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -8875,6 +9084,10 @@ type CreateScheduleSpendLimit2 = {
|
|
|
8875
9084
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
8876
9085
|
*/
|
|
8877
9086
|
overageLimit?: number | undefined;
|
|
9087
|
+
/**
|
|
9088
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
9089
|
+
*/
|
|
9090
|
+
skipOverageBilling?: boolean | undefined;
|
|
8878
9091
|
};
|
|
8879
9092
|
/**
|
|
8880
9093
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -8889,6 +9102,14 @@ declare const CreateScheduleUsageLimitInterval2: {
|
|
|
8889
9102
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
8890
9103
|
*/
|
|
8891
9104
|
type CreateScheduleUsageLimitInterval2 = ClosedEnum<typeof CreateScheduleUsageLimitInterval2>;
|
|
9105
|
+
/**
|
|
9106
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
9107
|
+
*/
|
|
9108
|
+
type CreateScheduleFilter2 = {
|
|
9109
|
+
properties: {
|
|
9110
|
+
[k: string]: any;
|
|
9111
|
+
};
|
|
9112
|
+
};
|
|
8892
9113
|
type CreateScheduleUsageLimit2 = {
|
|
8893
9114
|
/**
|
|
8894
9115
|
* The feature this usage limit applies to.
|
|
@@ -8906,6 +9127,10 @@ type CreateScheduleUsageLimit2 = {
|
|
|
8906
9127
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
8907
9128
|
*/
|
|
8908
9129
|
interval: CreateScheduleUsageLimitInterval2;
|
|
9130
|
+
/**
|
|
9131
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
9132
|
+
*/
|
|
9133
|
+
filter?: CreateScheduleFilter2 | undefined;
|
|
8909
9134
|
};
|
|
8910
9135
|
/**
|
|
8911
9136
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -9157,6 +9382,7 @@ declare const CreateScheduleCode: {
|
|
|
9157
9382
|
readonly ThreedsRequired: "3ds_required";
|
|
9158
9383
|
readonly PaymentMethodRequired: "payment_method_required";
|
|
9159
9384
|
readonly PaymentFailed: "payment_failed";
|
|
9385
|
+
readonly PaymentProcessing: "payment_processing";
|
|
9160
9386
|
};
|
|
9161
9387
|
/**
|
|
9162
9388
|
* The type of action required to complete the payment.
|
|
@@ -9328,6 +9554,10 @@ type CustomerSpendLimit = {
|
|
|
9328
9554
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
9329
9555
|
*/
|
|
9330
9556
|
overageLimit?: number | undefined;
|
|
9557
|
+
/**
|
|
9558
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
9559
|
+
*/
|
|
9560
|
+
skipOverageBilling?: boolean | undefined;
|
|
9331
9561
|
};
|
|
9332
9562
|
/**
|
|
9333
9563
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -9342,6 +9572,14 @@ declare const CustomerUsageLimitInterval: {
|
|
|
9342
9572
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
9343
9573
|
*/
|
|
9344
9574
|
type CustomerUsageLimitInterval = OpenEnum<typeof CustomerUsageLimitInterval>;
|
|
9575
|
+
/**
|
|
9576
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
9577
|
+
*/
|
|
9578
|
+
type CustomerFilter = {
|
|
9579
|
+
properties: {
|
|
9580
|
+
[k: string]: any;
|
|
9581
|
+
};
|
|
9582
|
+
};
|
|
9345
9583
|
type CustomerUsageLimit = {
|
|
9346
9584
|
/**
|
|
9347
9585
|
* The feature this usage limit applies to.
|
|
@@ -9359,6 +9597,10 @@ type CustomerUsageLimit = {
|
|
|
9359
9597
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
9360
9598
|
*/
|
|
9361
9599
|
interval: CustomerUsageLimitInterval;
|
|
9600
|
+
/**
|
|
9601
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
9602
|
+
*/
|
|
9603
|
+
filter?: CustomerFilter | undefined;
|
|
9362
9604
|
/**
|
|
9363
9605
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
9364
9606
|
*/
|
|
@@ -10293,6 +10535,10 @@ type GetCustomerSpendLimit = {
|
|
|
10293
10535
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
10294
10536
|
*/
|
|
10295
10537
|
overageLimit?: number | undefined;
|
|
10538
|
+
/**
|
|
10539
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
10540
|
+
*/
|
|
10541
|
+
skipOverageBilling?: boolean | undefined;
|
|
10296
10542
|
};
|
|
10297
10543
|
/**
|
|
10298
10544
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -10307,6 +10553,14 @@ declare const GetCustomerUsageLimitInterval: {
|
|
|
10307
10553
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
10308
10554
|
*/
|
|
10309
10555
|
type GetCustomerUsageLimitInterval = OpenEnum<typeof GetCustomerUsageLimitInterval>;
|
|
10556
|
+
/**
|
|
10557
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
10558
|
+
*/
|
|
10559
|
+
type GetCustomerFilter = {
|
|
10560
|
+
properties: {
|
|
10561
|
+
[k: string]: any;
|
|
10562
|
+
};
|
|
10563
|
+
};
|
|
10310
10564
|
type GetCustomerUsageLimit = {
|
|
10311
10565
|
/**
|
|
10312
10566
|
* The feature this usage limit applies to.
|
|
@@ -10324,6 +10578,10 @@ type GetCustomerUsageLimit = {
|
|
|
10324
10578
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
10325
10579
|
*/
|
|
10326
10580
|
interval: GetCustomerUsageLimitInterval;
|
|
10581
|
+
/**
|
|
10582
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
10583
|
+
*/
|
|
10584
|
+
filter?: GetCustomerFilter | undefined;
|
|
10327
10585
|
/**
|
|
10328
10586
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
10329
10587
|
*/
|
|
@@ -11253,6 +11511,10 @@ type GetEntitySpendLimit = {
|
|
|
11253
11511
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
11254
11512
|
*/
|
|
11255
11513
|
overageLimit?: number | undefined;
|
|
11514
|
+
/**
|
|
11515
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
11516
|
+
*/
|
|
11517
|
+
skipOverageBilling?: boolean | undefined;
|
|
11256
11518
|
};
|
|
11257
11519
|
/**
|
|
11258
11520
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -11267,6 +11529,14 @@ declare const GetEntityInterval: {
|
|
|
11267
11529
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
11268
11530
|
*/
|
|
11269
11531
|
type GetEntityInterval = OpenEnum<typeof GetEntityInterval>;
|
|
11532
|
+
/**
|
|
11533
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
11534
|
+
*/
|
|
11535
|
+
type GetEntityFilter = {
|
|
11536
|
+
properties: {
|
|
11537
|
+
[k: string]: any;
|
|
11538
|
+
};
|
|
11539
|
+
};
|
|
11270
11540
|
type GetEntityUsageLimit = {
|
|
11271
11541
|
/**
|
|
11272
11542
|
* The feature this usage limit applies to.
|
|
@@ -11284,6 +11554,10 @@ type GetEntityUsageLimit = {
|
|
|
11284
11554
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
11285
11555
|
*/
|
|
11286
11556
|
interval: GetEntityInterval;
|
|
11557
|
+
/**
|
|
11558
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
11559
|
+
*/
|
|
11560
|
+
filter?: GetEntityFilter | undefined;
|
|
11287
11561
|
/**
|
|
11288
11562
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
11289
11563
|
*/
|
|
@@ -12312,6 +12586,10 @@ type GetPlanVariantDetailsSpendLimit = {
|
|
|
12312
12586
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
12313
12587
|
*/
|
|
12314
12588
|
overageLimit?: number | undefined;
|
|
12589
|
+
/**
|
|
12590
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
12591
|
+
*/
|
|
12592
|
+
skipOverageBilling?: boolean | undefined;
|
|
12315
12593
|
};
|
|
12316
12594
|
/**
|
|
12317
12595
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -12326,6 +12604,14 @@ declare const GetPlanVariantDetailsUsageLimitInterval: {
|
|
|
12326
12604
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
12327
12605
|
*/
|
|
12328
12606
|
type GetPlanVariantDetailsUsageLimitInterval = OpenEnum<typeof GetPlanVariantDetailsUsageLimitInterval>;
|
|
12607
|
+
/**
|
|
12608
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
12609
|
+
*/
|
|
12610
|
+
type GetPlanVariantDetailsFilter = {
|
|
12611
|
+
properties: {
|
|
12612
|
+
[k: string]: any;
|
|
12613
|
+
};
|
|
12614
|
+
};
|
|
12329
12615
|
type GetPlanVariantDetailsUsageLimit = {
|
|
12330
12616
|
/**
|
|
12331
12617
|
* The feature this usage limit applies to.
|
|
@@ -12343,6 +12629,10 @@ type GetPlanVariantDetailsUsageLimit = {
|
|
|
12343
12629
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
12344
12630
|
*/
|
|
12345
12631
|
interval: GetPlanVariantDetailsUsageLimitInterval;
|
|
12632
|
+
/**
|
|
12633
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
12634
|
+
*/
|
|
12635
|
+
filter?: GetPlanVariantDetailsFilter | undefined;
|
|
12346
12636
|
};
|
|
12347
12637
|
/**
|
|
12348
12638
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -12545,6 +12835,10 @@ type GetPlanSpendLimit = {
|
|
|
12545
12835
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
12546
12836
|
*/
|
|
12547
12837
|
overageLimit?: number | undefined;
|
|
12838
|
+
/**
|
|
12839
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
12840
|
+
*/
|
|
12841
|
+
skipOverageBilling?: boolean | undefined;
|
|
12548
12842
|
};
|
|
12549
12843
|
/**
|
|
12550
12844
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -12559,6 +12853,14 @@ declare const GetPlanUsageLimitInterval: {
|
|
|
12559
12853
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
12560
12854
|
*/
|
|
12561
12855
|
type GetPlanUsageLimitInterval = OpenEnum<typeof GetPlanUsageLimitInterval>;
|
|
12856
|
+
/**
|
|
12857
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
12858
|
+
*/
|
|
12859
|
+
type GetPlanFilter = {
|
|
12860
|
+
properties: {
|
|
12861
|
+
[k: string]: any;
|
|
12862
|
+
};
|
|
12863
|
+
};
|
|
12562
12864
|
type GetPlanUsageLimit = {
|
|
12563
12865
|
/**
|
|
12564
12866
|
* The feature this usage limit applies to.
|
|
@@ -12576,6 +12878,10 @@ type GetPlanUsageLimit = {
|
|
|
12576
12878
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
12577
12879
|
*/
|
|
12578
12880
|
interval: GetPlanUsageLimitInterval;
|
|
12881
|
+
/**
|
|
12882
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
12883
|
+
*/
|
|
12884
|
+
filter?: GetPlanFilter | undefined;
|
|
12579
12885
|
};
|
|
12580
12886
|
/**
|
|
12581
12887
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -12873,7 +13179,7 @@ declare class ConnectionError extends HTTPClientError {
|
|
|
12873
13179
|
}
|
|
12874
13180
|
|
|
12875
13181
|
/**
|
|
12876
|
-
* Optional identity fields
|
|
13182
|
+
* Optional identity fields upserted onto the customer (applied to existing customers too).
|
|
12877
13183
|
*/
|
|
12878
13184
|
type ImportCustomerData = {
|
|
12879
13185
|
/**
|
|
@@ -12959,34 +13265,39 @@ type ImportFeatureQuantity = {
|
|
|
12959
13265
|
quantity: number;
|
|
12960
13266
|
};
|
|
12961
13267
|
declare const ImportInterval: {
|
|
13268
|
+
readonly Lifetime: "lifetime";
|
|
13269
|
+
readonly Minute: "minute";
|
|
12962
13270
|
readonly Hour: "hour";
|
|
12963
13271
|
readonly Day: "day";
|
|
12964
13272
|
readonly Week: "week";
|
|
12965
13273
|
readonly Month: "month";
|
|
13274
|
+
readonly Quarter: "quarter";
|
|
13275
|
+
readonly SemiAnnual: "semi_annual";
|
|
12966
13276
|
readonly Year: "year";
|
|
12967
13277
|
};
|
|
12968
13278
|
type ImportInterval = ClosedEnum<typeof ImportInterval>;
|
|
12969
13279
|
/**
|
|
12970
|
-
* Selects the included vs prepaid entitlement line when a feature has
|
|
13280
|
+
* Selects the included vs prepaid vs usage-based (pay-per-use) entitlement line when a feature has several.
|
|
12971
13281
|
*/
|
|
12972
13282
|
declare const ImportBillingBehavior: {
|
|
12973
13283
|
readonly Included: "included";
|
|
12974
13284
|
readonly Prepaid: "prepaid";
|
|
13285
|
+
readonly UsageBased: "usage_based";
|
|
12975
13286
|
};
|
|
12976
13287
|
/**
|
|
12977
|
-
* Selects the included vs prepaid entitlement line when a feature has
|
|
13288
|
+
* Selects the included vs prepaid vs usage-based (pay-per-use) entitlement line when a feature has several.
|
|
12978
13289
|
*/
|
|
12979
13290
|
type ImportBillingBehavior = ClosedEnum<typeof ImportBillingBehavior>;
|
|
12980
13291
|
/**
|
|
12981
13292
|
* Disambiguates which entitlement line to target when the feature has multiple.
|
|
12982
13293
|
*/
|
|
12983
|
-
type
|
|
13294
|
+
type ImportFilter = {
|
|
12984
13295
|
/**
|
|
12985
|
-
* Reset interval selecting which entitlement line to target when a feature has several (null = the non-resetting one-off line).
|
|
13296
|
+
* Reset interval selecting which entitlement line to target when a feature has several ('lifetime' or null = the non-resetting one-off line).
|
|
12986
13297
|
*/
|
|
12987
13298
|
interval?: ImportInterval | null | undefined;
|
|
12988
13299
|
/**
|
|
12989
|
-
* Selects the included vs prepaid entitlement line when a feature has
|
|
13300
|
+
* Selects the included vs prepaid vs usage-based (pay-per-use) entitlement line when a feature has several.
|
|
12990
13301
|
*/
|
|
12991
13302
|
billingBehavior?: ImportBillingBehavior | undefined;
|
|
12992
13303
|
};
|
|
@@ -12998,7 +13309,7 @@ type ImportBalance = {
|
|
|
12998
13309
|
/**
|
|
12999
13310
|
* Disambiguates which entitlement line to target when the feature has multiple.
|
|
13000
13311
|
*/
|
|
13001
|
-
filter?:
|
|
13312
|
+
filter?: ImportFilter | undefined;
|
|
13002
13313
|
/**
|
|
13003
13314
|
* Units already consumed; remaining balance is derived from the plan allowance minus this.
|
|
13004
13315
|
*/
|
|
@@ -13069,7 +13380,7 @@ type DfuFlashParams = {
|
|
|
13069
13380
|
*/
|
|
13070
13381
|
customerId: string;
|
|
13071
13382
|
/**
|
|
13072
|
-
* Optional identity fields
|
|
13383
|
+
* Optional identity fields upserted onto the customer (applied to existing customers too).
|
|
13073
13384
|
*/
|
|
13074
13385
|
customerData?: ImportCustomerData | undefined;
|
|
13075
13386
|
/**
|
|
@@ -13323,6 +13634,10 @@ type ListCustomersSpendLimit = {
|
|
|
13323
13634
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
13324
13635
|
*/
|
|
13325
13636
|
overageLimit?: number | undefined;
|
|
13637
|
+
/**
|
|
13638
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
13639
|
+
*/
|
|
13640
|
+
skipOverageBilling?: boolean | undefined;
|
|
13326
13641
|
};
|
|
13327
13642
|
/**
|
|
13328
13643
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -13337,6 +13652,14 @@ declare const ListCustomersUsageLimitInterval: {
|
|
|
13337
13652
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
13338
13653
|
*/
|
|
13339
13654
|
type ListCustomersUsageLimitInterval = OpenEnum<typeof ListCustomersUsageLimitInterval>;
|
|
13655
|
+
/**
|
|
13656
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
13657
|
+
*/
|
|
13658
|
+
type ListCustomersFilter = {
|
|
13659
|
+
properties: {
|
|
13660
|
+
[k: string]: any;
|
|
13661
|
+
};
|
|
13662
|
+
};
|
|
13340
13663
|
type ListCustomersUsageLimit = {
|
|
13341
13664
|
/**
|
|
13342
13665
|
* The feature this usage limit applies to.
|
|
@@ -13354,6 +13677,10 @@ type ListCustomersUsageLimit = {
|
|
|
13354
13677
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
13355
13678
|
*/
|
|
13356
13679
|
interval: ListCustomersUsageLimitInterval;
|
|
13680
|
+
/**
|
|
13681
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
13682
|
+
*/
|
|
13683
|
+
filter?: ListCustomersFilter | undefined;
|
|
13357
13684
|
/**
|
|
13358
13685
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
13359
13686
|
*/
|
|
@@ -14134,6 +14461,10 @@ type ListEntitiesSpendLimit = {
|
|
|
14134
14461
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
14135
14462
|
*/
|
|
14136
14463
|
overageLimit?: number | undefined;
|
|
14464
|
+
/**
|
|
14465
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
14466
|
+
*/
|
|
14467
|
+
skipOverageBilling?: boolean | undefined;
|
|
14137
14468
|
};
|
|
14138
14469
|
/**
|
|
14139
14470
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -14148,6 +14479,14 @@ declare const ListEntitiesInterval: {
|
|
|
14148
14479
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
14149
14480
|
*/
|
|
14150
14481
|
type ListEntitiesInterval = OpenEnum<typeof ListEntitiesInterval>;
|
|
14482
|
+
/**
|
|
14483
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
14484
|
+
*/
|
|
14485
|
+
type ListEntitiesFilter = {
|
|
14486
|
+
properties: {
|
|
14487
|
+
[k: string]: any;
|
|
14488
|
+
};
|
|
14489
|
+
};
|
|
14151
14490
|
type ListEntitiesUsageLimit = {
|
|
14152
14491
|
/**
|
|
14153
14492
|
* The feature this usage limit applies to.
|
|
@@ -14165,6 +14504,10 @@ type ListEntitiesUsageLimit = {
|
|
|
14165
14504
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
14166
14505
|
*/
|
|
14167
14506
|
interval: ListEntitiesInterval;
|
|
14507
|
+
/**
|
|
14508
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
14509
|
+
*/
|
|
14510
|
+
filter?: ListEntitiesFilter | undefined;
|
|
14168
14511
|
/**
|
|
14169
14512
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
14170
14513
|
*/
|
|
@@ -15342,6 +15685,10 @@ type ListPlansVariantDetailsSpendLimit = {
|
|
|
15342
15685
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
15343
15686
|
*/
|
|
15344
15687
|
overageLimit?: number | undefined;
|
|
15688
|
+
/**
|
|
15689
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
15690
|
+
*/
|
|
15691
|
+
skipOverageBilling?: boolean | undefined;
|
|
15345
15692
|
};
|
|
15346
15693
|
/**
|
|
15347
15694
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -15356,6 +15703,14 @@ declare const ListPlansVariantDetailsUsageLimitInterval: {
|
|
|
15356
15703
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
15357
15704
|
*/
|
|
15358
15705
|
type ListPlansVariantDetailsUsageLimitInterval = OpenEnum<typeof ListPlansVariantDetailsUsageLimitInterval>;
|
|
15706
|
+
/**
|
|
15707
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
15708
|
+
*/
|
|
15709
|
+
type ListPlansVariantDetailsFilter = {
|
|
15710
|
+
properties: {
|
|
15711
|
+
[k: string]: any;
|
|
15712
|
+
};
|
|
15713
|
+
};
|
|
15359
15714
|
type ListPlansVariantDetailsUsageLimit = {
|
|
15360
15715
|
/**
|
|
15361
15716
|
* The feature this usage limit applies to.
|
|
@@ -15373,6 +15728,10 @@ type ListPlansVariantDetailsUsageLimit = {
|
|
|
15373
15728
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
15374
15729
|
*/
|
|
15375
15730
|
interval: ListPlansVariantDetailsUsageLimitInterval;
|
|
15731
|
+
/**
|
|
15732
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
15733
|
+
*/
|
|
15734
|
+
filter?: ListPlansVariantDetailsFilter | undefined;
|
|
15376
15735
|
};
|
|
15377
15736
|
/**
|
|
15378
15737
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -15575,6 +15934,10 @@ type ListPlansSpendLimit = {
|
|
|
15575
15934
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
15576
15935
|
*/
|
|
15577
15936
|
overageLimit?: number | undefined;
|
|
15937
|
+
/**
|
|
15938
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
15939
|
+
*/
|
|
15940
|
+
skipOverageBilling?: boolean | undefined;
|
|
15578
15941
|
};
|
|
15579
15942
|
/**
|
|
15580
15943
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -15589,6 +15952,14 @@ declare const ListPlansUsageLimitInterval: {
|
|
|
15589
15952
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
15590
15953
|
*/
|
|
15591
15954
|
type ListPlansUsageLimitInterval = OpenEnum<typeof ListPlansUsageLimitInterval>;
|
|
15955
|
+
/**
|
|
15956
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
15957
|
+
*/
|
|
15958
|
+
type ListPlansFilter = {
|
|
15959
|
+
properties: {
|
|
15960
|
+
[k: string]: any;
|
|
15961
|
+
};
|
|
15962
|
+
};
|
|
15592
15963
|
type ListPlansUsageLimit = {
|
|
15593
15964
|
/**
|
|
15594
15965
|
* The feature this usage limit applies to.
|
|
@@ -15606,6 +15977,10 @@ type ListPlansUsageLimit = {
|
|
|
15606
15977
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
15607
15978
|
*/
|
|
15608
15979
|
interval: ListPlansUsageLimitInterval;
|
|
15980
|
+
/**
|
|
15981
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
15982
|
+
*/
|
|
15983
|
+
filter?: ListPlansFilter | undefined;
|
|
15609
15984
|
};
|
|
15610
15985
|
/**
|
|
15611
15986
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -16424,6 +16799,10 @@ type MultiAttachSpendLimit = {
|
|
|
16424
16799
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
16425
16800
|
*/
|
|
16426
16801
|
overageLimit?: number | undefined;
|
|
16802
|
+
/**
|
|
16803
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
16804
|
+
*/
|
|
16805
|
+
skipOverageBilling?: boolean | undefined;
|
|
16427
16806
|
};
|
|
16428
16807
|
/**
|
|
16429
16808
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -16438,6 +16817,14 @@ declare const MultiAttachEntityDataInterval: {
|
|
|
16438
16817
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
16439
16818
|
*/
|
|
16440
16819
|
type MultiAttachEntityDataInterval = ClosedEnum<typeof MultiAttachEntityDataInterval>;
|
|
16820
|
+
/**
|
|
16821
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
16822
|
+
*/
|
|
16823
|
+
type MultiAttachFilter = {
|
|
16824
|
+
properties: {
|
|
16825
|
+
[k: string]: string | number | boolean;
|
|
16826
|
+
};
|
|
16827
|
+
};
|
|
16441
16828
|
type MultiAttachUsageLimit = {
|
|
16442
16829
|
/**
|
|
16443
16830
|
* The feature this usage limit applies to.
|
|
@@ -16455,6 +16842,10 @@ type MultiAttachUsageLimit = {
|
|
|
16455
16842
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
16456
16843
|
*/
|
|
16457
16844
|
interval: MultiAttachEntityDataInterval;
|
|
16845
|
+
/**
|
|
16846
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
16847
|
+
*/
|
|
16848
|
+
filter?: MultiAttachFilter | undefined;
|
|
16458
16849
|
};
|
|
16459
16850
|
/**
|
|
16460
16851
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -16621,6 +17012,7 @@ declare const MultiAttachCode: {
|
|
|
16621
17012
|
readonly ThreedsRequired: "3ds_required";
|
|
16622
17013
|
readonly PaymentMethodRequired: "payment_method_required";
|
|
16623
17014
|
readonly PaymentFailed: "payment_failed";
|
|
17015
|
+
readonly PaymentProcessing: "payment_processing";
|
|
16624
17016
|
};
|
|
16625
17017
|
/**
|
|
16626
17018
|
* The type of action required to complete the payment.
|
|
@@ -17335,6 +17727,10 @@ type PreviewAttachSpendLimit = {
|
|
|
17335
17727
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
17336
17728
|
*/
|
|
17337
17729
|
overageLimit?: number | undefined;
|
|
17730
|
+
/**
|
|
17731
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
17732
|
+
*/
|
|
17733
|
+
skipOverageBilling?: boolean | undefined;
|
|
17338
17734
|
};
|
|
17339
17735
|
/**
|
|
17340
17736
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -17349,6 +17745,14 @@ declare const PreviewAttachUsageLimitInterval: {
|
|
|
17349
17745
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
17350
17746
|
*/
|
|
17351
17747
|
type PreviewAttachUsageLimitInterval = ClosedEnum<typeof PreviewAttachUsageLimitInterval>;
|
|
17748
|
+
/**
|
|
17749
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
17750
|
+
*/
|
|
17751
|
+
type PreviewAttachFilter = {
|
|
17752
|
+
properties: {
|
|
17753
|
+
[k: string]: string | number | boolean;
|
|
17754
|
+
};
|
|
17755
|
+
};
|
|
17352
17756
|
type PreviewAttachUsageLimit = {
|
|
17353
17757
|
/**
|
|
17354
17758
|
* The feature this usage limit applies to.
|
|
@@ -17366,6 +17770,10 @@ type PreviewAttachUsageLimit = {
|
|
|
17366
17770
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
17367
17771
|
*/
|
|
17368
17772
|
interval: PreviewAttachUsageLimitInterval;
|
|
17773
|
+
/**
|
|
17774
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
17775
|
+
*/
|
|
17776
|
+
filter?: PreviewAttachFilter | undefined;
|
|
17369
17777
|
};
|
|
17370
17778
|
/**
|
|
17371
17779
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -18445,6 +18853,10 @@ type PreviewMultiAttachSpendLimit = {
|
|
|
18445
18853
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
18446
18854
|
*/
|
|
18447
18855
|
overageLimit?: number | undefined;
|
|
18856
|
+
/**
|
|
18857
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
18858
|
+
*/
|
|
18859
|
+
skipOverageBilling?: boolean | undefined;
|
|
18448
18860
|
};
|
|
18449
18861
|
/**
|
|
18450
18862
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -18459,6 +18871,14 @@ declare const PreviewMultiAttachEntityDataInterval: {
|
|
|
18459
18871
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
18460
18872
|
*/
|
|
18461
18873
|
type PreviewMultiAttachEntityDataInterval = ClosedEnum<typeof PreviewMultiAttachEntityDataInterval>;
|
|
18874
|
+
/**
|
|
18875
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
18876
|
+
*/
|
|
18877
|
+
type PreviewMultiAttachFilter = {
|
|
18878
|
+
properties: {
|
|
18879
|
+
[k: string]: string | number | boolean;
|
|
18880
|
+
};
|
|
18881
|
+
};
|
|
18462
18882
|
type PreviewMultiAttachUsageLimit = {
|
|
18463
18883
|
/**
|
|
18464
18884
|
* The feature this usage limit applies to.
|
|
@@ -18476,6 +18896,10 @@ type PreviewMultiAttachUsageLimit = {
|
|
|
18476
18896
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
18477
18897
|
*/
|
|
18478
18898
|
interval: PreviewMultiAttachEntityDataInterval;
|
|
18899
|
+
/**
|
|
18900
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
18901
|
+
*/
|
|
18902
|
+
filter?: PreviewMultiAttachFilter | undefined;
|
|
18479
18903
|
};
|
|
18480
18904
|
/**
|
|
18481
18905
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -19597,6 +20021,10 @@ type PreviewUpdateSpendLimit = {
|
|
|
19597
20021
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
19598
20022
|
*/
|
|
19599
20023
|
overageLimit?: number | undefined;
|
|
20024
|
+
/**
|
|
20025
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
20026
|
+
*/
|
|
20027
|
+
skipOverageBilling?: boolean | undefined;
|
|
19600
20028
|
};
|
|
19601
20029
|
/**
|
|
19602
20030
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -19611,6 +20039,14 @@ declare const PreviewUpdateUsageLimitInterval: {
|
|
|
19611
20039
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
19612
20040
|
*/
|
|
19613
20041
|
type PreviewUpdateUsageLimitInterval = ClosedEnum<typeof PreviewUpdateUsageLimitInterval>;
|
|
20042
|
+
/**
|
|
20043
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
20044
|
+
*/
|
|
20045
|
+
type PreviewUpdateFilter = {
|
|
20046
|
+
properties: {
|
|
20047
|
+
[k: string]: string | number | boolean;
|
|
20048
|
+
};
|
|
20049
|
+
};
|
|
19614
20050
|
type PreviewUpdateUsageLimit = {
|
|
19615
20051
|
/**
|
|
19616
20052
|
* The feature this usage limit applies to.
|
|
@@ -19628,6 +20064,10 @@ type PreviewUpdateUsageLimit = {
|
|
|
19628
20064
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
19629
20065
|
*/
|
|
19630
20066
|
interval: PreviewUpdateUsageLimitInterval;
|
|
20067
|
+
/**
|
|
20068
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
20069
|
+
*/
|
|
20070
|
+
filter?: PreviewUpdateFilter | undefined;
|
|
19631
20071
|
};
|
|
19632
20072
|
/**
|
|
19633
20073
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -19801,6 +20241,17 @@ declare const PreviewUpdateCancelAction: {
|
|
|
19801
20241
|
* 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.
|
|
19802
20242
|
*/
|
|
19803
20243
|
type PreviewUpdateCancelAction = ClosedEnum<typeof PreviewUpdateCancelAction>;
|
|
20244
|
+
/**
|
|
20245
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
20246
|
+
*/
|
|
20247
|
+
declare const PreviewUpdateRefundLastPayment: {
|
|
20248
|
+
readonly Prorated: "prorated";
|
|
20249
|
+
readonly Full: "full";
|
|
20250
|
+
};
|
|
20251
|
+
/**
|
|
20252
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
20253
|
+
*/
|
|
20254
|
+
type PreviewUpdateRefundLastPayment = ClosedEnum<typeof PreviewUpdateRefundLastPayment>;
|
|
19804
20255
|
/**
|
|
19805
20256
|
* Controls whether balances should be recalculated during the subscription update.
|
|
19806
20257
|
*/
|
|
@@ -19880,6 +20331,10 @@ type PreviewUpdateParams = {
|
|
|
19880
20331
|
* If true, the subscription is updated internally without applying billing changes in Stripe.
|
|
19881
20332
|
*/
|
|
19882
20333
|
noBillingChanges?: boolean | undefined;
|
|
20334
|
+
/**
|
|
20335
|
+
* Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.
|
|
20336
|
+
*/
|
|
20337
|
+
refundLastPayment?: PreviewUpdateRefundLastPayment | undefined;
|
|
19883
20338
|
/**
|
|
19884
20339
|
* Controls whether balances should be recalculated during the subscription update.
|
|
19885
20340
|
*/
|
|
@@ -20977,6 +21432,10 @@ type SetupPaymentSpendLimit = {
|
|
|
20977
21432
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
20978
21433
|
*/
|
|
20979
21434
|
overageLimit?: number | undefined;
|
|
21435
|
+
/**
|
|
21436
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
21437
|
+
*/
|
|
21438
|
+
skipOverageBilling?: boolean | undefined;
|
|
20980
21439
|
};
|
|
20981
21440
|
/**
|
|
20982
21441
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -20991,6 +21450,14 @@ declare const SetupPaymentUsageLimitInterval: {
|
|
|
20991
21450
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
20992
21451
|
*/
|
|
20993
21452
|
type SetupPaymentUsageLimitInterval = ClosedEnum<typeof SetupPaymentUsageLimitInterval>;
|
|
21453
|
+
/**
|
|
21454
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
21455
|
+
*/
|
|
21456
|
+
type SetupPaymentFilter = {
|
|
21457
|
+
properties: {
|
|
21458
|
+
[k: string]: string | number | boolean;
|
|
21459
|
+
};
|
|
21460
|
+
};
|
|
20994
21461
|
type SetupPaymentUsageLimit = {
|
|
20995
21462
|
/**
|
|
20996
21463
|
* The feature this usage limit applies to.
|
|
@@ -21008,6 +21475,10 @@ type SetupPaymentUsageLimit = {
|
|
|
21008
21475
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
21009
21476
|
*/
|
|
21010
21477
|
interval: SetupPaymentUsageLimitInterval;
|
|
21478
|
+
/**
|
|
21479
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
21480
|
+
*/
|
|
21481
|
+
filter?: SetupPaymentFilter | undefined;
|
|
21011
21482
|
};
|
|
21012
21483
|
/**
|
|
21013
21484
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -21947,6 +22418,10 @@ type UpdateCustomerSpendLimitRequest = {
|
|
|
21947
22418
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
21948
22419
|
*/
|
|
21949
22420
|
overageLimit?: number | undefined;
|
|
22421
|
+
/**
|
|
22422
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
22423
|
+
*/
|
|
22424
|
+
skipOverageBilling?: boolean | undefined;
|
|
21950
22425
|
};
|
|
21951
22426
|
/**
|
|
21952
22427
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -21961,6 +22436,14 @@ declare const UpdateCustomerUsageLimitIntervalRequestBody: {
|
|
|
21961
22436
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
21962
22437
|
*/
|
|
21963
22438
|
type UpdateCustomerUsageLimitIntervalRequestBody = ClosedEnum<typeof UpdateCustomerUsageLimitIntervalRequestBody>;
|
|
22439
|
+
/**
|
|
22440
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
22441
|
+
*/
|
|
22442
|
+
type UpdateCustomerFilterRequest = {
|
|
22443
|
+
properties: {
|
|
22444
|
+
[k: string]: string | number | boolean;
|
|
22445
|
+
};
|
|
22446
|
+
};
|
|
21964
22447
|
type UpdateCustomerUsageLimitRequest = {
|
|
21965
22448
|
/**
|
|
21966
22449
|
* The feature this usage limit applies to.
|
|
@@ -21978,6 +22461,10 @@ type UpdateCustomerUsageLimitRequest = {
|
|
|
21978
22461
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
21979
22462
|
*/
|
|
21980
22463
|
interval: UpdateCustomerUsageLimitIntervalRequestBody;
|
|
22464
|
+
/**
|
|
22465
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
22466
|
+
*/
|
|
22467
|
+
filter?: UpdateCustomerFilterRequest | undefined;
|
|
21981
22468
|
};
|
|
21982
22469
|
/**
|
|
21983
22470
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -22227,6 +22714,10 @@ type UpdateCustomerSpendLimitResponse = {
|
|
|
22227
22714
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
22228
22715
|
*/
|
|
22229
22716
|
overageLimit?: number | undefined;
|
|
22717
|
+
/**
|
|
22718
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
22719
|
+
*/
|
|
22720
|
+
skipOverageBilling?: boolean | undefined;
|
|
22230
22721
|
};
|
|
22231
22722
|
/**
|
|
22232
22723
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -22241,6 +22732,14 @@ declare const UpdateCustomerUsageLimitIntervalResponse: {
|
|
|
22241
22732
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
22242
22733
|
*/
|
|
22243
22734
|
type UpdateCustomerUsageLimitIntervalResponse = OpenEnum<typeof UpdateCustomerUsageLimitIntervalResponse>;
|
|
22735
|
+
/**
|
|
22736
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
22737
|
+
*/
|
|
22738
|
+
type UpdateCustomerFilterResponse = {
|
|
22739
|
+
properties: {
|
|
22740
|
+
[k: string]: any;
|
|
22741
|
+
};
|
|
22742
|
+
};
|
|
22244
22743
|
type UpdateCustomerUsageLimitResponse = {
|
|
22245
22744
|
/**
|
|
22246
22745
|
* The feature this usage limit applies to.
|
|
@@ -22258,6 +22757,10 @@ type UpdateCustomerUsageLimitResponse = {
|
|
|
22258
22757
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
22259
22758
|
*/
|
|
22260
22759
|
interval: UpdateCustomerUsageLimitIntervalResponse;
|
|
22760
|
+
/**
|
|
22761
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
22762
|
+
*/
|
|
22763
|
+
filter?: UpdateCustomerFilterResponse | undefined;
|
|
22261
22764
|
/**
|
|
22262
22765
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
22263
22766
|
*/
|
|
@@ -22732,6 +23235,10 @@ type UpdateEntitySpendLimitRequest = {
|
|
|
22732
23235
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
22733
23236
|
*/
|
|
22734
23237
|
overageLimit?: number | undefined;
|
|
23238
|
+
/**
|
|
23239
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
23240
|
+
*/
|
|
23241
|
+
skipOverageBilling?: boolean | undefined;
|
|
22735
23242
|
};
|
|
22736
23243
|
/**
|
|
22737
23244
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -22746,6 +23253,14 @@ declare const UpdateEntityIntervalRequestBody: {
|
|
|
22746
23253
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
22747
23254
|
*/
|
|
22748
23255
|
type UpdateEntityIntervalRequestBody = ClosedEnum<typeof UpdateEntityIntervalRequestBody>;
|
|
23256
|
+
/**
|
|
23257
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
23258
|
+
*/
|
|
23259
|
+
type UpdateEntityFilterRequest = {
|
|
23260
|
+
properties: {
|
|
23261
|
+
[k: string]: string | number | boolean;
|
|
23262
|
+
};
|
|
23263
|
+
};
|
|
22749
23264
|
type UpdateEntityUsageLimitRequest = {
|
|
22750
23265
|
/**
|
|
22751
23266
|
* The feature this usage limit applies to.
|
|
@@ -22763,6 +23278,10 @@ type UpdateEntityUsageLimitRequest = {
|
|
|
22763
23278
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
22764
23279
|
*/
|
|
22765
23280
|
interval: UpdateEntityIntervalRequestBody;
|
|
23281
|
+
/**
|
|
23282
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
23283
|
+
*/
|
|
23284
|
+
filter?: UpdateEntityFilterRequest | undefined;
|
|
22766
23285
|
};
|
|
22767
23286
|
/**
|
|
22768
23287
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -23117,6 +23636,10 @@ type UpdateEntitySpendLimitResponse = {
|
|
|
23117
23636
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
23118
23637
|
*/
|
|
23119
23638
|
overageLimit?: number | undefined;
|
|
23639
|
+
/**
|
|
23640
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
23641
|
+
*/
|
|
23642
|
+
skipOverageBilling?: boolean | undefined;
|
|
23120
23643
|
};
|
|
23121
23644
|
/**
|
|
23122
23645
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -23131,6 +23654,14 @@ declare const UpdateEntityIntervalResponse: {
|
|
|
23131
23654
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
23132
23655
|
*/
|
|
23133
23656
|
type UpdateEntityIntervalResponse = OpenEnum<typeof UpdateEntityIntervalResponse>;
|
|
23657
|
+
/**
|
|
23658
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
23659
|
+
*/
|
|
23660
|
+
type UpdateEntityFilterResponse = {
|
|
23661
|
+
properties: {
|
|
23662
|
+
[k: string]: any;
|
|
23663
|
+
};
|
|
23664
|
+
};
|
|
23134
23665
|
type UpdateEntityUsageLimitResponse = {
|
|
23135
23666
|
/**
|
|
23136
23667
|
* The feature this usage limit applies to.
|
|
@@ -23148,6 +23679,10 @@ type UpdateEntityUsageLimitResponse = {
|
|
|
23148
23679
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
23149
23680
|
*/
|
|
23150
23681
|
interval: UpdateEntityIntervalResponse;
|
|
23682
|
+
/**
|
|
23683
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
23684
|
+
*/
|
|
23685
|
+
filter?: UpdateEntityFilterResponse | undefined;
|
|
23151
23686
|
/**
|
|
23152
23687
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
23153
23688
|
*/
|
|
@@ -23866,6 +24401,10 @@ type UpdatePlanSpendLimitRequest = {
|
|
|
23866
24401
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
23867
24402
|
*/
|
|
23868
24403
|
overageLimit?: number | undefined;
|
|
24404
|
+
/**
|
|
24405
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
24406
|
+
*/
|
|
24407
|
+
skipOverageBilling?: boolean | undefined;
|
|
23869
24408
|
};
|
|
23870
24409
|
/**
|
|
23871
24410
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -23880,6 +24419,14 @@ declare const UpdatePlanUsageLimitIntervalRequestBody: {
|
|
|
23880
24419
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
23881
24420
|
*/
|
|
23882
24421
|
type UpdatePlanUsageLimitIntervalRequestBody = ClosedEnum<typeof UpdatePlanUsageLimitIntervalRequestBody>;
|
|
24422
|
+
/**
|
|
24423
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
24424
|
+
*/
|
|
24425
|
+
type UpdatePlanFilterRequest = {
|
|
24426
|
+
properties: {
|
|
24427
|
+
[k: string]: string | number | boolean;
|
|
24428
|
+
};
|
|
24429
|
+
};
|
|
23883
24430
|
type UpdatePlanUsageLimitRequest = {
|
|
23884
24431
|
/**
|
|
23885
24432
|
* The feature this usage limit applies to.
|
|
@@ -23897,6 +24444,10 @@ type UpdatePlanUsageLimitRequest = {
|
|
|
23897
24444
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
23898
24445
|
*/
|
|
23899
24446
|
interval: UpdatePlanUsageLimitIntervalRequestBody;
|
|
24447
|
+
/**
|
|
24448
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
24449
|
+
*/
|
|
24450
|
+
filter?: UpdatePlanFilterRequest | undefined;
|
|
23900
24451
|
};
|
|
23901
24452
|
/**
|
|
23902
24453
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -24391,6 +24942,10 @@ type VariantSpendLimit = {
|
|
|
24391
24942
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
24392
24943
|
*/
|
|
24393
24944
|
overageLimit?: number | undefined;
|
|
24945
|
+
/**
|
|
24946
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
24947
|
+
*/
|
|
24948
|
+
skipOverageBilling?: boolean | undefined;
|
|
24394
24949
|
};
|
|
24395
24950
|
/**
|
|
24396
24951
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -24405,6 +24960,14 @@ declare const VariantUsageLimitInterval: {
|
|
|
24405
24960
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
24406
24961
|
*/
|
|
24407
24962
|
type VariantUsageLimitInterval = ClosedEnum<typeof VariantUsageLimitInterval>;
|
|
24963
|
+
/**
|
|
24964
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
24965
|
+
*/
|
|
24966
|
+
type VariantFilter = {
|
|
24967
|
+
properties: {
|
|
24968
|
+
[k: string]: string | number | boolean;
|
|
24969
|
+
};
|
|
24970
|
+
};
|
|
24408
24971
|
type VariantUsageLimit = {
|
|
24409
24972
|
/**
|
|
24410
24973
|
* The feature this usage limit applies to.
|
|
@@ -24422,6 +24985,10 @@ type VariantUsageLimit = {
|
|
|
24422
24985
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
24423
24986
|
*/
|
|
24424
24987
|
interval: VariantUsageLimitInterval;
|
|
24988
|
+
/**
|
|
24989
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
24990
|
+
*/
|
|
24991
|
+
filter?: VariantFilter | undefined;
|
|
24425
24992
|
};
|
|
24426
24993
|
/**
|
|
24427
24994
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -25382,6 +25949,10 @@ type UpdatePlanVariantDetailsSpendLimit = {
|
|
|
25382
25949
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
25383
25950
|
*/
|
|
25384
25951
|
overageLimit?: number | undefined;
|
|
25952
|
+
/**
|
|
25953
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
25954
|
+
*/
|
|
25955
|
+
skipOverageBilling?: boolean | undefined;
|
|
25385
25956
|
};
|
|
25386
25957
|
/**
|
|
25387
25958
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -25396,6 +25967,14 @@ declare const UpdatePlanVariantDetailsUsageLimitInterval: {
|
|
|
25396
25967
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
25397
25968
|
*/
|
|
25398
25969
|
type UpdatePlanVariantDetailsUsageLimitInterval = OpenEnum<typeof UpdatePlanVariantDetailsUsageLimitInterval>;
|
|
25970
|
+
/**
|
|
25971
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
25972
|
+
*/
|
|
25973
|
+
type UpdatePlanVariantDetailsFilter = {
|
|
25974
|
+
properties: {
|
|
25975
|
+
[k: string]: any;
|
|
25976
|
+
};
|
|
25977
|
+
};
|
|
25399
25978
|
type UpdatePlanVariantDetailsUsageLimit = {
|
|
25400
25979
|
/**
|
|
25401
25980
|
* The feature this usage limit applies to.
|
|
@@ -25413,6 +25992,10 @@ type UpdatePlanVariantDetailsUsageLimit = {
|
|
|
25413
25992
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
25414
25993
|
*/
|
|
25415
25994
|
interval: UpdatePlanVariantDetailsUsageLimitInterval;
|
|
25995
|
+
/**
|
|
25996
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
25997
|
+
*/
|
|
25998
|
+
filter?: UpdatePlanVariantDetailsFilter | undefined;
|
|
25416
25999
|
};
|
|
25417
26000
|
/**
|
|
25418
26001
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -25615,6 +26198,10 @@ type UpdatePlanSpendLimitResponse = {
|
|
|
25615
26198
|
* Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit_type is usage_percentage.
|
|
25616
26199
|
*/
|
|
25617
26200
|
overageLimit?: number | undefined;
|
|
26201
|
+
/**
|
|
26202
|
+
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
26203
|
+
*/
|
|
26204
|
+
skipOverageBilling?: boolean | undefined;
|
|
25618
26205
|
};
|
|
25619
26206
|
/**
|
|
25620
26207
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -25629,6 +26216,14 @@ declare const UpdatePlanUsageLimitIntervalResponse: {
|
|
|
25629
26216
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
25630
26217
|
*/
|
|
25631
26218
|
type UpdatePlanUsageLimitIntervalResponse = OpenEnum<typeof UpdatePlanUsageLimitIntervalResponse>;
|
|
26219
|
+
/**
|
|
26220
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
26221
|
+
*/
|
|
26222
|
+
type UpdatePlanFilterResponse = {
|
|
26223
|
+
properties: {
|
|
26224
|
+
[k: string]: any;
|
|
26225
|
+
};
|
|
26226
|
+
};
|
|
25632
26227
|
type UpdatePlanUsageLimitResponse = {
|
|
25633
26228
|
/**
|
|
25634
26229
|
* The feature this usage limit applies to.
|
|
@@ -25646,6 +26241,10 @@ type UpdatePlanUsageLimitResponse = {
|
|
|
25646
26241
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
25647
26242
|
*/
|
|
25648
26243
|
interval: UpdatePlanUsageLimitIntervalResponse;
|
|
26244
|
+
/**
|
|
26245
|
+
* When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
|
|
26246
|
+
*/
|
|
26247
|
+
filter?: UpdatePlanFilterResponse | undefined;
|
|
25649
26248
|
};
|
|
25650
26249
|
/**
|
|
25651
26250
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -26097,7 +26696,7 @@ declare class Billing extends ClientSDK {
|
|
|
26097
26696
|
* @example
|
|
26098
26697
|
* ```typescript
|
|
26099
26698
|
* // Schedule a transition from a trial plan to a paid plan
|
|
26100
|
-
* const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":
|
|
26699
|
+
* const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":1783539171816,"plans":[{"planId":"trial_plan"}]},{"startsAt":1784748771816,"plans":[{"planId":"pro_plan"}]}] });
|
|
26101
26700
|
* ```
|
|
26102
26701
|
*
|
|
26103
26702
|
* @param customerId - The ID of the customer to create the schedule for.
|
|
@@ -26258,6 +26857,7 @@ declare class Billing extends ClientSDK {
|
|
|
26258
26857
|
* @param cancelAction - 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. (optional)
|
|
26259
26858
|
* @param billingCycleAnchor - Reset the billing cycle anchor immediately with 'now' (optional)
|
|
26260
26859
|
* @param noBillingChanges - If true, the subscription is updated internally without applying billing changes in Stripe. (optional)
|
|
26860
|
+
* @param refundLastPayment - Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment. (optional)
|
|
26261
26861
|
* @param recalculateBalances - Controls whether balances should be recalculated during the subscription update. (optional)
|
|
26262
26862
|
* @param carryOverUsages - Whether to carry over usages from the previous plan. (optional)
|
|
26263
26863
|
*
|
|
@@ -26289,6 +26889,7 @@ declare class Billing extends ClientSDK {
|
|
|
26289
26889
|
* @param cancelAction - 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. (optional)
|
|
26290
26890
|
* @param billingCycleAnchor - Reset the billing cycle anchor immediately with 'now' (optional)
|
|
26291
26891
|
* @param noBillingChanges - If true, the subscription is updated internally without applying billing changes in Stripe. (optional)
|
|
26892
|
+
* @param refundLastPayment - Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment. (optional)
|
|
26292
26893
|
* @param recalculateBalances - Controls whether balances should be recalculated during the subscription update. (optional)
|
|
26293
26894
|
* @param carryOverUsages - Whether to carry over usages from the previous plan. (optional)
|
|
26294
26895
|
*
|