autumn-js 1.2.38 → 1.2.39
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.js +319 -101
- package/dist/backend/adapters/express.mjs +8 -8
- package/dist/backend/adapters/fetch.js +319 -101
- package/dist/backend/adapters/fetch.mjs +8 -8
- package/dist/backend/adapters/hono.js +319 -101
- package/dist/backend/adapters/hono.mjs +8 -8
- package/dist/backend/adapters/index.js +319 -101
- package/dist/backend/adapters/index.mjs +11 -11
- package/dist/backend/adapters/next.js +319 -101
- package/dist/backend/adapters/next.mjs +8 -8
- package/dist/backend/{chunk-CEUAUTNB.mjs → chunk-5IUIFE55.mjs} +1 -1
- package/dist/backend/{chunk-ZR5K6VMA.mjs → chunk-GL2SBEQ5.mjs} +1 -1
- package/dist/backend/{chunk-Y3AJLHVL.mjs → chunk-KJP3DHPM.mjs} +1 -1
- package/dist/backend/{chunk-N52JKSJ7.mjs → chunk-KM5AXZWJ.mjs} +4 -4
- package/dist/backend/{chunk-5C7KP2BU.mjs → chunk-MSMJS42G.mjs} +319 -101
- package/dist/backend/{chunk-TIFFBW34.mjs → chunk-UMTASWZL.mjs} +1 -1
- package/dist/backend/{chunk-PKM7CEE3.mjs → chunk-V32P22RC.mjs} +6 -6
- package/dist/backend/core/handlers/coreHandler.d.mts +1 -1
- package/dist/backend/core/handlers/coreHandler.d.ts +1 -1
- package/dist/backend/core/handlers/coreHandler.js +319 -101
- package/dist/backend/core/handlers/coreHandler.mjs +6 -6
- package/dist/backend/core/handlers/executeRoute.d.mts +1 -1
- package/dist/backend/core/handlers/executeRoute.d.ts +1 -1
- package/dist/backend/core/handlers/executeRoute.mjs +4 -4
- package/dist/backend/core/handlers/handleRouteByName.js +319 -101
- package/dist/backend/core/handlers/handleRouteByName.mjs +6 -6
- package/dist/backend/core/handlers/index.d.mts +1 -1
- package/dist/backend/core/handlers/index.d.ts +1 -1
- package/dist/backend/core/handlers/index.js +319 -101
- package/dist/backend/core/handlers/index.mjs +10 -10
- package/dist/backend/core/index.d.mts +1 -1
- package/dist/backend/core/index.d.ts +1 -1
- package/dist/backend/core/index.js +319 -101
- package/dist/backend/core/index.mjs +9 -9
- package/dist/backend/core/routes/index.d.mts +1 -1
- package/dist/backend/core/routes/index.d.ts +1 -1
- package/dist/backend/core/routes/index.mjs +1 -1
- package/dist/backend/core/routes/routeBuilder.d.mts +1 -1
- package/dist/backend/core/routes/routeBuilder.d.ts +1 -1
- package/dist/backend/core/routes/routeConfigs.d.mts +1 -1
- package/dist/backend/core/routes/routeConfigs.d.ts +1 -1
- package/dist/backend/core/routes/routeConfigs.mjs +1 -1
- package/dist/backend/core/types/handlerTypes.d.mts +1 -1
- package/dist/backend/core/types/handlerTypes.d.ts +1 -1
- package/dist/backend/core/types/index.d.mts +1 -1
- package/dist/backend/core/types/index.d.ts +1 -1
- package/dist/backend/core/types/routeTypes.d.mts +1 -1
- package/dist/backend/core/types/routeTypes.d.ts +1 -1
- package/dist/backend/core/utils/index.mjs +3 -3
- package/dist/backend/index.d.mts +2 -2
- package/dist/backend/index.d.ts +2 -2
- package/dist/backend/index.js +319 -101
- package/dist/backend/index.mjs +9 -9
- package/dist/backend/{routeTypes-gWhxv6xo.d.mts → routeTypes-CIqS7yVo.d.mts} +641 -97
- package/dist/backend/{routeTypes-C8YKwtFL.d.ts → routeTypes-uWaE8YYa.d.ts} +641 -97
- package/dist/better-auth/{chunk-A3ZOJU54.mjs → chunk-LLBM6UQN.mjs} +319 -101
- package/dist/better-auth/index.js +319 -101
- package/dist/better-auth/index.mjs +1 -1
- package/dist/better-auth/utils/handleBetterAuthRoute.js +319 -101
- package/dist/better-auth/utils/handleBetterAuthRoute.mjs +1 -1
- package/dist/better-auth/utils/index.js +319 -101
- package/dist/better-auth/utils/index.mjs +1 -1
- package/dist/react/AutumnContext.d.mts +2 -2
- package/dist/react/AutumnContext.d.ts +2 -2
- package/dist/react/client/AutumnClient.d.mts +2 -2
- package/dist/react/client/AutumnClient.d.ts +2 -2
- package/dist/react/client/IAutumnClient.d.mts +2 -2
- package/dist/react/client/IAutumnClient.d.ts +2 -2
- package/dist/react/client/index.d.mts +2 -2
- package/dist/react/client/index.d.ts +2 -2
- package/dist/react/{customer-D811_jP2.d.ts → customer-CrxRrY4o.d.ts} +99 -24
- package/dist/react/{customer-CkuydPCd.d.mts → customer-DM044m1a.d.mts} +99 -24
- package/dist/react/hooks/index.d.mts +2 -2
- package/dist/react/hooks/index.d.ts +2 -2
- package/dist/react/hooks/internal/check/balanceToAllowed.d.mts +1 -1
- package/dist/react/hooks/internal/check/balanceToAllowed.d.ts +1 -1
- package/dist/react/hooks/internal/check/customerToFeatures.d.mts +1 -1
- package/dist/react/hooks/internal/check/customerToFeatures.d.ts +1 -1
- package/dist/react/hooks/internal/check/findCreditSystemsByFeature.d.mts +1 -1
- package/dist/react/hooks/internal/check/findCreditSystemsByFeature.d.ts +1 -1
- package/dist/react/hooks/internal/check/getCreditCost.d.mts +1 -1
- package/dist/react/hooks/internal/check/getCreditCost.d.ts +1 -1
- package/dist/react/hooks/internal/getLocalCheckResponse.d.mts +2 -2
- package/dist/react/hooks/internal/getLocalCheckResponse.d.ts +2 -2
- package/dist/react/hooks/internal/useCustomerActions.d.mts +2 -2
- package/dist/react/hooks/internal/useCustomerActions.d.ts +2 -2
- package/dist/react/hooks/useAggregateEvents.d.mts +1 -1
- package/dist/react/hooks/useAggregateEvents.d.ts +1 -1
- package/dist/react/hooks/useCustomer.d.mts +2 -2
- package/dist/react/hooks/useCustomer.d.ts +2 -2
- package/dist/react/hooks/useEntity.d.mts +1 -1
- package/dist/react/hooks/useEntity.d.ts +1 -1
- package/dist/react/hooks/useListEvents.d.mts +1 -1
- package/dist/react/hooks/useListEvents.d.ts +1 -1
- package/dist/react/hooks/useListPlans.d.mts +1 -1
- package/dist/react/hooks/useListPlans.d.ts +1 -1
- package/dist/react/hooks/useReferrals.d.mts +1 -1
- package/dist/react/hooks/useReferrals.d.ts +1 -1
- package/dist/react/index.d.mts +2 -2
- package/dist/react/index.d.ts +2 -2
- package/dist/react/{params-CaUBdt-x.d.ts → params-B-1vi9za.d.ts} +60 -0
- package/dist/react/{params-C0cH2cYK.d.mts → params-Bf18ATYi.d.mts} +60 -0
- package/dist/sdk/index.d.mts +723 -106
- package/dist/sdk/index.d.ts +723 -106
- package/dist/sdk/index.js +391 -101
- package/dist/sdk/index.mjs +320 -102
- package/package.json +1 -1
- package/dist/backend/{chunk-MOHYGUMA.mjs → chunk-IXUCY7AU.mjs} +3 -3
|
@@ -6181,6 +6181,17 @@ declare const CreateEntityLimitTypeResponse: {
|
|
|
6181
6181
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
6182
6182
|
*/
|
|
6183
6183
|
type CreateEntityLimitTypeResponse = OpenEnum<typeof CreateEntityLimitTypeResponse>;
|
|
6184
|
+
/**
|
|
6185
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6186
|
+
*/
|
|
6187
|
+
declare const CreateEntitySpendLimitSource: {
|
|
6188
|
+
readonly Customer: "customer";
|
|
6189
|
+
readonly Plan: "plan";
|
|
6190
|
+
};
|
|
6191
|
+
/**
|
|
6192
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6193
|
+
*/
|
|
6194
|
+
type CreateEntitySpendLimitSource = OpenEnum<typeof CreateEntitySpendLimitSource>;
|
|
6184
6195
|
type CreateEntitySpendLimitResponse = {
|
|
6185
6196
|
/**
|
|
6186
6197
|
* Optional feature ID this spend limit applies to.
|
|
@@ -6202,6 +6213,10 @@ type CreateEntitySpendLimitResponse = {
|
|
|
6202
6213
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
6203
6214
|
*/
|
|
6204
6215
|
skipOverageBilling?: boolean | undefined;
|
|
6216
|
+
/**
|
|
6217
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6218
|
+
*/
|
|
6219
|
+
source?: CreateEntitySpendLimitSource | undefined;
|
|
6205
6220
|
};
|
|
6206
6221
|
/**
|
|
6207
6222
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -6224,6 +6239,17 @@ type CreateEntityFilterResponse = {
|
|
|
6224
6239
|
[k: string]: any;
|
|
6225
6240
|
};
|
|
6226
6241
|
};
|
|
6242
|
+
/**
|
|
6243
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6244
|
+
*/
|
|
6245
|
+
declare const CreateEntityUsageLimitSource: {
|
|
6246
|
+
readonly Customer: "customer";
|
|
6247
|
+
readonly Plan: "plan";
|
|
6248
|
+
};
|
|
6249
|
+
/**
|
|
6250
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6251
|
+
*/
|
|
6252
|
+
type CreateEntityUsageLimitSource = OpenEnum<typeof CreateEntityUsageLimitSource>;
|
|
6227
6253
|
type CreateEntityUsageLimitResponse = {
|
|
6228
6254
|
/**
|
|
6229
6255
|
* The feature this usage limit applies to.
|
|
@@ -6249,6 +6275,10 @@ type CreateEntityUsageLimitResponse = {
|
|
|
6249
6275
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
6250
6276
|
*/
|
|
6251
6277
|
usage?: number | undefined;
|
|
6278
|
+
/**
|
|
6279
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6280
|
+
*/
|
|
6281
|
+
source?: CreateEntityUsageLimitSource | undefined;
|
|
6252
6282
|
};
|
|
6253
6283
|
/**
|
|
6254
6284
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -6263,6 +6293,17 @@ declare const CreateEntityThresholdTypeResponse: {
|
|
|
6263
6293
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
6264
6294
|
*/
|
|
6265
6295
|
type CreateEntityThresholdTypeResponse = OpenEnum<typeof CreateEntityThresholdTypeResponse>;
|
|
6296
|
+
/**
|
|
6297
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6298
|
+
*/
|
|
6299
|
+
declare const CreateEntityUsageAlertSource: {
|
|
6300
|
+
readonly Customer: "customer";
|
|
6301
|
+
readonly Plan: "plan";
|
|
6302
|
+
};
|
|
6303
|
+
/**
|
|
6304
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6305
|
+
*/
|
|
6306
|
+
type CreateEntityUsageAlertSource = OpenEnum<typeof CreateEntityUsageAlertSource>;
|
|
6266
6307
|
type CreateEntityUsageAlertResponse = {
|
|
6267
6308
|
/**
|
|
6268
6309
|
* The feature ID this alert applies to.
|
|
@@ -6284,7 +6325,22 @@ type CreateEntityUsageAlertResponse = {
|
|
|
6284
6325
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
6285
6326
|
*/
|
|
6286
6327
|
name?: string | undefined;
|
|
6328
|
+
/**
|
|
6329
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6330
|
+
*/
|
|
6331
|
+
source?: CreateEntityUsageAlertSource | undefined;
|
|
6287
6332
|
};
|
|
6333
|
+
/**
|
|
6334
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6335
|
+
*/
|
|
6336
|
+
declare const CreateEntityOverageAllowedSource: {
|
|
6337
|
+
readonly Customer: "customer";
|
|
6338
|
+
readonly Plan: "plan";
|
|
6339
|
+
};
|
|
6340
|
+
/**
|
|
6341
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6342
|
+
*/
|
|
6343
|
+
type CreateEntityOverageAllowedSource = OpenEnum<typeof CreateEntityOverageAllowedSource>;
|
|
6288
6344
|
type CreateEntityOverageAllowedResponse = {
|
|
6289
6345
|
/**
|
|
6290
6346
|
* The feature ID this overage allowed control applies to.
|
|
@@ -6294,6 +6350,10 @@ type CreateEntityOverageAllowedResponse = {
|
|
|
6294
6350
|
* Whether overage is allowed for this feature.
|
|
6295
6351
|
*/
|
|
6296
6352
|
enabled: boolean;
|
|
6353
|
+
/**
|
|
6354
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
6355
|
+
*/
|
|
6356
|
+
source?: CreateEntityOverageAllowedSource | undefined;
|
|
6297
6357
|
};
|
|
6298
6358
|
/**
|
|
6299
6359
|
* Billing controls for the entity.
|
|
@@ -9444,18 +9504,45 @@ declare const CustomerEnv: {
|
|
|
9444
9504
|
* The environment this customer was created in.
|
|
9445
9505
|
*/
|
|
9446
9506
|
type CustomerEnv = OpenEnum<typeof CustomerEnv>;
|
|
9507
|
+
/**
|
|
9508
|
+
* The time interval for the purchase limit window.
|
|
9509
|
+
*/
|
|
9447
9510
|
declare const CustomerPurchaseLimitInterval2: {
|
|
9448
9511
|
readonly Hour: "hour";
|
|
9449
9512
|
readonly Day: "day";
|
|
9450
9513
|
readonly Week: "week";
|
|
9451
9514
|
readonly Month: "month";
|
|
9452
9515
|
};
|
|
9516
|
+
/**
|
|
9517
|
+
* The time interval for the purchase limit window.
|
|
9518
|
+
*/
|
|
9453
9519
|
type CustomerPurchaseLimitInterval2 = OpenEnum<typeof CustomerPurchaseLimitInterval2>;
|
|
9454
9520
|
type CustomerPurchaseLimit2 = {
|
|
9521
|
+
/**
|
|
9522
|
+
* The time interval for the purchase limit window.
|
|
9523
|
+
*/
|
|
9524
|
+
interval: CustomerPurchaseLimitInterval2;
|
|
9525
|
+
/**
|
|
9526
|
+
* Number of intervals in the purchase limit window.
|
|
9527
|
+
*/
|
|
9528
|
+
intervalCount: number;
|
|
9529
|
+
/**
|
|
9530
|
+
* Maximum number of auto top-ups allowed within the interval.
|
|
9531
|
+
*/
|
|
9532
|
+
limit: number;
|
|
9533
|
+
};
|
|
9534
|
+
declare const CustomerPurchaseLimitInterval1: {
|
|
9535
|
+
readonly Hour: "hour";
|
|
9536
|
+
readonly Day: "day";
|
|
9537
|
+
readonly Week: "week";
|
|
9538
|
+
readonly Month: "month";
|
|
9539
|
+
};
|
|
9540
|
+
type CustomerPurchaseLimitInterval1 = OpenEnum<typeof CustomerPurchaseLimitInterval1>;
|
|
9541
|
+
type CustomerPurchaseLimit1 = {
|
|
9455
9542
|
/**
|
|
9456
9543
|
* The time interval for the purchase limit window. Null when no purchase limit is configured.
|
|
9457
9544
|
*/
|
|
9458
|
-
interval:
|
|
9545
|
+
interval: CustomerPurchaseLimitInterval1 | null;
|
|
9459
9546
|
/**
|
|
9460
9547
|
* Number of intervals in the purchase limit window. Null when no purchase limit is configured.
|
|
9461
9548
|
*/
|
|
@@ -9474,32 +9561,16 @@ type CustomerPurchaseLimit2 = {
|
|
|
9474
9561
|
nextResetAt: number;
|
|
9475
9562
|
};
|
|
9476
9563
|
/**
|
|
9477
|
-
*
|
|
9564
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9478
9565
|
*/
|
|
9479
|
-
declare const
|
|
9480
|
-
readonly
|
|
9481
|
-
readonly
|
|
9482
|
-
readonly Week: "week";
|
|
9483
|
-
readonly Month: "month";
|
|
9566
|
+
declare const AutoTopupSource: {
|
|
9567
|
+
readonly Customer: "customer";
|
|
9568
|
+
readonly Plan: "plan";
|
|
9484
9569
|
};
|
|
9485
9570
|
/**
|
|
9486
|
-
*
|
|
9571
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9487
9572
|
*/
|
|
9488
|
-
type
|
|
9489
|
-
type CustomerPurchaseLimit1 = {
|
|
9490
|
-
/**
|
|
9491
|
-
* The time interval for the purchase limit window.
|
|
9492
|
-
*/
|
|
9493
|
-
interval: CustomerPurchaseLimitInterval1;
|
|
9494
|
-
/**
|
|
9495
|
-
* Number of intervals in the purchase limit window.
|
|
9496
|
-
*/
|
|
9497
|
-
intervalCount: number;
|
|
9498
|
-
/**
|
|
9499
|
-
* Maximum number of auto top-ups allowed within the interval.
|
|
9500
|
-
*/
|
|
9501
|
-
limit: number;
|
|
9502
|
-
};
|
|
9573
|
+
type AutoTopupSource = OpenEnum<typeof AutoTopupSource>;
|
|
9503
9574
|
type CustomerAutoTopup = {
|
|
9504
9575
|
/**
|
|
9505
9576
|
* The ID of the feature (credit balance) to auto top-up.
|
|
@@ -9520,11 +9591,15 @@ type CustomerAutoTopup = {
|
|
|
9520
9591
|
/**
|
|
9521
9592
|
* Optional rate limit to cap how often auto top-ups occur. Expand billing_controls.auto_topups.purchase_limit for a count of top ups and the next_reset_at.
|
|
9522
9593
|
*/
|
|
9523
|
-
purchaseLimit?:
|
|
9594
|
+
purchaseLimit?: CustomerPurchaseLimit1 | CustomerPurchaseLimit2 | undefined;
|
|
9524
9595
|
/**
|
|
9525
9596
|
* When true, auto top-up creates a send_invoice invoice instead of auto-charging.
|
|
9526
9597
|
*/
|
|
9527
9598
|
invoiceMode?: boolean | undefined;
|
|
9599
|
+
/**
|
|
9600
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9601
|
+
*/
|
|
9602
|
+
source?: AutoTopupSource | undefined;
|
|
9528
9603
|
};
|
|
9529
9604
|
/**
|
|
9530
9605
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
@@ -9537,6 +9612,17 @@ declare const CustomerLimitType: {
|
|
|
9537
9612
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
9538
9613
|
*/
|
|
9539
9614
|
type CustomerLimitType = OpenEnum<typeof CustomerLimitType>;
|
|
9615
|
+
/**
|
|
9616
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9617
|
+
*/
|
|
9618
|
+
declare const SpendLimitSource: {
|
|
9619
|
+
readonly Customer: "customer";
|
|
9620
|
+
readonly Plan: "plan";
|
|
9621
|
+
};
|
|
9622
|
+
/**
|
|
9623
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9624
|
+
*/
|
|
9625
|
+
type SpendLimitSource = OpenEnum<typeof SpendLimitSource>;
|
|
9540
9626
|
type CustomerSpendLimit = {
|
|
9541
9627
|
/**
|
|
9542
9628
|
* Optional feature ID this spend limit applies to.
|
|
@@ -9558,6 +9644,10 @@ type CustomerSpendLimit = {
|
|
|
9558
9644
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
9559
9645
|
*/
|
|
9560
9646
|
skipOverageBilling?: boolean | undefined;
|
|
9647
|
+
/**
|
|
9648
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9649
|
+
*/
|
|
9650
|
+
source?: SpendLimitSource | undefined;
|
|
9561
9651
|
};
|
|
9562
9652
|
/**
|
|
9563
9653
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -9580,6 +9670,17 @@ type CustomerFilter = {
|
|
|
9580
9670
|
[k: string]: any;
|
|
9581
9671
|
};
|
|
9582
9672
|
};
|
|
9673
|
+
/**
|
|
9674
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9675
|
+
*/
|
|
9676
|
+
declare const UsageLimitSource: {
|
|
9677
|
+
readonly Customer: "customer";
|
|
9678
|
+
readonly Plan: "plan";
|
|
9679
|
+
};
|
|
9680
|
+
/**
|
|
9681
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9682
|
+
*/
|
|
9683
|
+
type UsageLimitSource = OpenEnum<typeof UsageLimitSource>;
|
|
9583
9684
|
type CustomerUsageLimit = {
|
|
9584
9685
|
/**
|
|
9585
9686
|
* The feature this usage limit applies to.
|
|
@@ -9605,6 +9706,10 @@ type CustomerUsageLimit = {
|
|
|
9605
9706
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
9606
9707
|
*/
|
|
9607
9708
|
usage?: number | undefined;
|
|
9709
|
+
/**
|
|
9710
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9711
|
+
*/
|
|
9712
|
+
source?: UsageLimitSource | undefined;
|
|
9608
9713
|
};
|
|
9609
9714
|
/**
|
|
9610
9715
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -9619,6 +9724,17 @@ declare const CustomerThresholdType: {
|
|
|
9619
9724
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
9620
9725
|
*/
|
|
9621
9726
|
type CustomerThresholdType = OpenEnum<typeof CustomerThresholdType>;
|
|
9727
|
+
/**
|
|
9728
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9729
|
+
*/
|
|
9730
|
+
declare const UsageAlertSource: {
|
|
9731
|
+
readonly Customer: "customer";
|
|
9732
|
+
readonly Plan: "plan";
|
|
9733
|
+
};
|
|
9734
|
+
/**
|
|
9735
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9736
|
+
*/
|
|
9737
|
+
type UsageAlertSource = OpenEnum<typeof UsageAlertSource>;
|
|
9622
9738
|
type CustomerUsageAlert = {
|
|
9623
9739
|
/**
|
|
9624
9740
|
* The feature ID this alert applies to.
|
|
@@ -9640,7 +9756,22 @@ type CustomerUsageAlert = {
|
|
|
9640
9756
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
9641
9757
|
*/
|
|
9642
9758
|
name?: string | undefined;
|
|
9759
|
+
/**
|
|
9760
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9761
|
+
*/
|
|
9762
|
+
source?: UsageAlertSource | undefined;
|
|
9763
|
+
};
|
|
9764
|
+
/**
|
|
9765
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9766
|
+
*/
|
|
9767
|
+
declare const OverageAllowedSource: {
|
|
9768
|
+
readonly Customer: "customer";
|
|
9769
|
+
readonly Plan: "plan";
|
|
9643
9770
|
};
|
|
9771
|
+
/**
|
|
9772
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9773
|
+
*/
|
|
9774
|
+
type OverageAllowedSource = OpenEnum<typeof OverageAllowedSource>;
|
|
9644
9775
|
type CustomerOverageAllowed = {
|
|
9645
9776
|
/**
|
|
9646
9777
|
* The feature ID this overage allowed control applies to.
|
|
@@ -9650,6 +9781,10 @@ type CustomerOverageAllowed = {
|
|
|
9650
9781
|
* Whether overage is allowed for this feature.
|
|
9651
9782
|
*/
|
|
9652
9783
|
enabled: boolean;
|
|
9784
|
+
/**
|
|
9785
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
9786
|
+
*/
|
|
9787
|
+
source?: OverageAllowedSource | undefined;
|
|
9653
9788
|
};
|
|
9654
9789
|
/**
|
|
9655
9790
|
* Billing controls for the customer (auto top-ups, etc.)
|
|
@@ -10425,18 +10560,45 @@ declare const GetCustomerEnv: {
|
|
|
10425
10560
|
* The environment this customer was created in.
|
|
10426
10561
|
*/
|
|
10427
10562
|
type GetCustomerEnv = OpenEnum<typeof GetCustomerEnv>;
|
|
10563
|
+
/**
|
|
10564
|
+
* The time interval for the purchase limit window.
|
|
10565
|
+
*/
|
|
10428
10566
|
declare const GetCustomerPurchaseLimitInterval2: {
|
|
10429
10567
|
readonly Hour: "hour";
|
|
10430
10568
|
readonly Day: "day";
|
|
10431
10569
|
readonly Week: "week";
|
|
10432
10570
|
readonly Month: "month";
|
|
10433
10571
|
};
|
|
10572
|
+
/**
|
|
10573
|
+
* The time interval for the purchase limit window.
|
|
10574
|
+
*/
|
|
10434
10575
|
type GetCustomerPurchaseLimitInterval2 = OpenEnum<typeof GetCustomerPurchaseLimitInterval2>;
|
|
10435
10576
|
type GetCustomerPurchaseLimit2 = {
|
|
10577
|
+
/**
|
|
10578
|
+
* The time interval for the purchase limit window.
|
|
10579
|
+
*/
|
|
10580
|
+
interval: GetCustomerPurchaseLimitInterval2;
|
|
10581
|
+
/**
|
|
10582
|
+
* Number of intervals in the purchase limit window.
|
|
10583
|
+
*/
|
|
10584
|
+
intervalCount: number;
|
|
10585
|
+
/**
|
|
10586
|
+
* Maximum number of auto top-ups allowed within the interval.
|
|
10587
|
+
*/
|
|
10588
|
+
limit: number;
|
|
10589
|
+
};
|
|
10590
|
+
declare const GetCustomerPurchaseLimitInterval1: {
|
|
10591
|
+
readonly Hour: "hour";
|
|
10592
|
+
readonly Day: "day";
|
|
10593
|
+
readonly Week: "week";
|
|
10594
|
+
readonly Month: "month";
|
|
10595
|
+
};
|
|
10596
|
+
type GetCustomerPurchaseLimitInterval1 = OpenEnum<typeof GetCustomerPurchaseLimitInterval1>;
|
|
10597
|
+
type GetCustomerPurchaseLimit1 = {
|
|
10436
10598
|
/**
|
|
10437
10599
|
* The time interval for the purchase limit window. Null when no purchase limit is configured.
|
|
10438
10600
|
*/
|
|
10439
|
-
interval:
|
|
10601
|
+
interval: GetCustomerPurchaseLimitInterval1 | null;
|
|
10440
10602
|
/**
|
|
10441
10603
|
* Number of intervals in the purchase limit window. Null when no purchase limit is configured.
|
|
10442
10604
|
*/
|
|
@@ -10455,32 +10617,16 @@ type GetCustomerPurchaseLimit2 = {
|
|
|
10455
10617
|
nextResetAt: number;
|
|
10456
10618
|
};
|
|
10457
10619
|
/**
|
|
10458
|
-
*
|
|
10620
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10459
10621
|
*/
|
|
10460
|
-
declare const
|
|
10461
|
-
readonly
|
|
10462
|
-
readonly
|
|
10463
|
-
readonly Week: "week";
|
|
10464
|
-
readonly Month: "month";
|
|
10622
|
+
declare const GetCustomerAutoTopupSource: {
|
|
10623
|
+
readonly Customer: "customer";
|
|
10624
|
+
readonly Plan: "plan";
|
|
10465
10625
|
};
|
|
10466
10626
|
/**
|
|
10467
|
-
*
|
|
10627
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10468
10628
|
*/
|
|
10469
|
-
type
|
|
10470
|
-
type GetCustomerPurchaseLimit1 = {
|
|
10471
|
-
/**
|
|
10472
|
-
* The time interval for the purchase limit window.
|
|
10473
|
-
*/
|
|
10474
|
-
interval: GetCustomerPurchaseLimitInterval1;
|
|
10475
|
-
/**
|
|
10476
|
-
* Number of intervals in the purchase limit window.
|
|
10477
|
-
*/
|
|
10478
|
-
intervalCount: number;
|
|
10479
|
-
/**
|
|
10480
|
-
* Maximum number of auto top-ups allowed within the interval.
|
|
10481
|
-
*/
|
|
10482
|
-
limit: number;
|
|
10483
|
-
};
|
|
10629
|
+
type GetCustomerAutoTopupSource = OpenEnum<typeof GetCustomerAutoTopupSource>;
|
|
10484
10630
|
type GetCustomerAutoTopup = {
|
|
10485
10631
|
/**
|
|
10486
10632
|
* The ID of the feature (credit balance) to auto top-up.
|
|
@@ -10501,11 +10647,15 @@ type GetCustomerAutoTopup = {
|
|
|
10501
10647
|
/**
|
|
10502
10648
|
* Optional rate limit to cap how often auto top-ups occur. Expand billing_controls.auto_topups.purchase_limit for a count of top ups and the next_reset_at.
|
|
10503
10649
|
*/
|
|
10504
|
-
purchaseLimit?:
|
|
10650
|
+
purchaseLimit?: GetCustomerPurchaseLimit1 | GetCustomerPurchaseLimit2 | undefined;
|
|
10505
10651
|
/**
|
|
10506
10652
|
* When true, auto top-up creates a send_invoice invoice instead of auto-charging.
|
|
10507
10653
|
*/
|
|
10508
10654
|
invoiceMode?: boolean | undefined;
|
|
10655
|
+
/**
|
|
10656
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10657
|
+
*/
|
|
10658
|
+
source?: GetCustomerAutoTopupSource | undefined;
|
|
10509
10659
|
};
|
|
10510
10660
|
/**
|
|
10511
10661
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
@@ -10518,6 +10668,17 @@ declare const GetCustomerLimitType: {
|
|
|
10518
10668
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
10519
10669
|
*/
|
|
10520
10670
|
type GetCustomerLimitType = OpenEnum<typeof GetCustomerLimitType>;
|
|
10671
|
+
/**
|
|
10672
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10673
|
+
*/
|
|
10674
|
+
declare const GetCustomerSpendLimitSource: {
|
|
10675
|
+
readonly Customer: "customer";
|
|
10676
|
+
readonly Plan: "plan";
|
|
10677
|
+
};
|
|
10678
|
+
/**
|
|
10679
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10680
|
+
*/
|
|
10681
|
+
type GetCustomerSpendLimitSource = OpenEnum<typeof GetCustomerSpendLimitSource>;
|
|
10521
10682
|
type GetCustomerSpendLimit = {
|
|
10522
10683
|
/**
|
|
10523
10684
|
* Optional feature ID this spend limit applies to.
|
|
@@ -10539,6 +10700,10 @@ type GetCustomerSpendLimit = {
|
|
|
10539
10700
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
10540
10701
|
*/
|
|
10541
10702
|
skipOverageBilling?: boolean | undefined;
|
|
10703
|
+
/**
|
|
10704
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10705
|
+
*/
|
|
10706
|
+
source?: GetCustomerSpendLimitSource | undefined;
|
|
10542
10707
|
};
|
|
10543
10708
|
/**
|
|
10544
10709
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -10561,6 +10726,17 @@ type GetCustomerFilter = {
|
|
|
10561
10726
|
[k: string]: any;
|
|
10562
10727
|
};
|
|
10563
10728
|
};
|
|
10729
|
+
/**
|
|
10730
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10731
|
+
*/
|
|
10732
|
+
declare const GetCustomerUsageLimitSource: {
|
|
10733
|
+
readonly Customer: "customer";
|
|
10734
|
+
readonly Plan: "plan";
|
|
10735
|
+
};
|
|
10736
|
+
/**
|
|
10737
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10738
|
+
*/
|
|
10739
|
+
type GetCustomerUsageLimitSource = OpenEnum<typeof GetCustomerUsageLimitSource>;
|
|
10564
10740
|
type GetCustomerUsageLimit = {
|
|
10565
10741
|
/**
|
|
10566
10742
|
* The feature this usage limit applies to.
|
|
@@ -10586,6 +10762,10 @@ type GetCustomerUsageLimit = {
|
|
|
10586
10762
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
10587
10763
|
*/
|
|
10588
10764
|
usage?: number | undefined;
|
|
10765
|
+
/**
|
|
10766
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10767
|
+
*/
|
|
10768
|
+
source?: GetCustomerUsageLimitSource | undefined;
|
|
10589
10769
|
};
|
|
10590
10770
|
/**
|
|
10591
10771
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -10600,6 +10780,17 @@ declare const GetCustomerThresholdType: {
|
|
|
10600
10780
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
10601
10781
|
*/
|
|
10602
10782
|
type GetCustomerThresholdType = OpenEnum<typeof GetCustomerThresholdType>;
|
|
10783
|
+
/**
|
|
10784
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10785
|
+
*/
|
|
10786
|
+
declare const GetCustomerUsageAlertSource: {
|
|
10787
|
+
readonly Customer: "customer";
|
|
10788
|
+
readonly Plan: "plan";
|
|
10789
|
+
};
|
|
10790
|
+
/**
|
|
10791
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10792
|
+
*/
|
|
10793
|
+
type GetCustomerUsageAlertSource = OpenEnum<typeof GetCustomerUsageAlertSource>;
|
|
10603
10794
|
type GetCustomerUsageAlert = {
|
|
10604
10795
|
/**
|
|
10605
10796
|
* The feature ID this alert applies to.
|
|
@@ -10621,7 +10812,22 @@ type GetCustomerUsageAlert = {
|
|
|
10621
10812
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
10622
10813
|
*/
|
|
10623
10814
|
name?: string | undefined;
|
|
10815
|
+
/**
|
|
10816
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10817
|
+
*/
|
|
10818
|
+
source?: GetCustomerUsageAlertSource | undefined;
|
|
10624
10819
|
};
|
|
10820
|
+
/**
|
|
10821
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10822
|
+
*/
|
|
10823
|
+
declare const GetCustomerOverageAllowedSource: {
|
|
10824
|
+
readonly Customer: "customer";
|
|
10825
|
+
readonly Plan: "plan";
|
|
10826
|
+
};
|
|
10827
|
+
/**
|
|
10828
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10829
|
+
*/
|
|
10830
|
+
type GetCustomerOverageAllowedSource = OpenEnum<typeof GetCustomerOverageAllowedSource>;
|
|
10625
10831
|
type GetCustomerOverageAllowed = {
|
|
10626
10832
|
/**
|
|
10627
10833
|
* The feature ID this overage allowed control applies to.
|
|
@@ -10631,6 +10837,10 @@ type GetCustomerOverageAllowed = {
|
|
|
10631
10837
|
* Whether overage is allowed for this feature.
|
|
10632
10838
|
*/
|
|
10633
10839
|
enabled: boolean;
|
|
10840
|
+
/**
|
|
10841
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
10842
|
+
*/
|
|
10843
|
+
source?: GetCustomerOverageAllowedSource | undefined;
|
|
10634
10844
|
};
|
|
10635
10845
|
/**
|
|
10636
10846
|
* Billing controls for the customer (auto top-ups, etc.)
|
|
@@ -11494,6 +11704,17 @@ declare const GetEntityLimitType: {
|
|
|
11494
11704
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
11495
11705
|
*/
|
|
11496
11706
|
type GetEntityLimitType = OpenEnum<typeof GetEntityLimitType>;
|
|
11707
|
+
/**
|
|
11708
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11709
|
+
*/
|
|
11710
|
+
declare const GetEntitySpendLimitSource: {
|
|
11711
|
+
readonly Customer: "customer";
|
|
11712
|
+
readonly Plan: "plan";
|
|
11713
|
+
};
|
|
11714
|
+
/**
|
|
11715
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11716
|
+
*/
|
|
11717
|
+
type GetEntitySpendLimitSource = OpenEnum<typeof GetEntitySpendLimitSource>;
|
|
11497
11718
|
type GetEntitySpendLimit = {
|
|
11498
11719
|
/**
|
|
11499
11720
|
* Optional feature ID this spend limit applies to.
|
|
@@ -11515,6 +11736,10 @@ type GetEntitySpendLimit = {
|
|
|
11515
11736
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
11516
11737
|
*/
|
|
11517
11738
|
skipOverageBilling?: boolean | undefined;
|
|
11739
|
+
/**
|
|
11740
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11741
|
+
*/
|
|
11742
|
+
source?: GetEntitySpendLimitSource | undefined;
|
|
11518
11743
|
};
|
|
11519
11744
|
/**
|
|
11520
11745
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -11537,6 +11762,17 @@ type GetEntityFilter = {
|
|
|
11537
11762
|
[k: string]: any;
|
|
11538
11763
|
};
|
|
11539
11764
|
};
|
|
11765
|
+
/**
|
|
11766
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11767
|
+
*/
|
|
11768
|
+
declare const GetEntityUsageLimitSource: {
|
|
11769
|
+
readonly Customer: "customer";
|
|
11770
|
+
readonly Plan: "plan";
|
|
11771
|
+
};
|
|
11772
|
+
/**
|
|
11773
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11774
|
+
*/
|
|
11775
|
+
type GetEntityUsageLimitSource = OpenEnum<typeof GetEntityUsageLimitSource>;
|
|
11540
11776
|
type GetEntityUsageLimit = {
|
|
11541
11777
|
/**
|
|
11542
11778
|
* The feature this usage limit applies to.
|
|
@@ -11562,6 +11798,10 @@ type GetEntityUsageLimit = {
|
|
|
11562
11798
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
11563
11799
|
*/
|
|
11564
11800
|
usage?: number | undefined;
|
|
11801
|
+
/**
|
|
11802
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11803
|
+
*/
|
|
11804
|
+
source?: GetEntityUsageLimitSource | undefined;
|
|
11565
11805
|
};
|
|
11566
11806
|
/**
|
|
11567
11807
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -11576,6 +11816,17 @@ declare const GetEntityThresholdType: {
|
|
|
11576
11816
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
11577
11817
|
*/
|
|
11578
11818
|
type GetEntityThresholdType = OpenEnum<typeof GetEntityThresholdType>;
|
|
11819
|
+
/**
|
|
11820
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11821
|
+
*/
|
|
11822
|
+
declare const GetEntityUsageAlertSource: {
|
|
11823
|
+
readonly Customer: "customer";
|
|
11824
|
+
readonly Plan: "plan";
|
|
11825
|
+
};
|
|
11826
|
+
/**
|
|
11827
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11828
|
+
*/
|
|
11829
|
+
type GetEntityUsageAlertSource = OpenEnum<typeof GetEntityUsageAlertSource>;
|
|
11579
11830
|
type GetEntityUsageAlert = {
|
|
11580
11831
|
/**
|
|
11581
11832
|
* The feature ID this alert applies to.
|
|
@@ -11597,7 +11848,22 @@ type GetEntityUsageAlert = {
|
|
|
11597
11848
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
11598
11849
|
*/
|
|
11599
11850
|
name?: string | undefined;
|
|
11851
|
+
/**
|
|
11852
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11853
|
+
*/
|
|
11854
|
+
source?: GetEntityUsageAlertSource | undefined;
|
|
11855
|
+
};
|
|
11856
|
+
/**
|
|
11857
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11858
|
+
*/
|
|
11859
|
+
declare const GetEntityOverageAllowedSource: {
|
|
11860
|
+
readonly Customer: "customer";
|
|
11861
|
+
readonly Plan: "plan";
|
|
11600
11862
|
};
|
|
11863
|
+
/**
|
|
11864
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11865
|
+
*/
|
|
11866
|
+
type GetEntityOverageAllowedSource = OpenEnum<typeof GetEntityOverageAllowedSource>;
|
|
11601
11867
|
type GetEntityOverageAllowed = {
|
|
11602
11868
|
/**
|
|
11603
11869
|
* The feature ID this overage allowed control applies to.
|
|
@@ -11607,6 +11873,10 @@ type GetEntityOverageAllowed = {
|
|
|
11607
11873
|
* Whether overage is allowed for this feature.
|
|
11608
11874
|
*/
|
|
11609
11875
|
enabled: boolean;
|
|
11876
|
+
/**
|
|
11877
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
11878
|
+
*/
|
|
11879
|
+
source?: GetEntityOverageAllowedSource | undefined;
|
|
11610
11880
|
};
|
|
11611
11881
|
/**
|
|
11612
11882
|
* Billing controls for the entity.
|
|
@@ -13524,18 +13794,45 @@ declare const ListCustomersEnv: {
|
|
|
13524
13794
|
* The environment this customer was created in.
|
|
13525
13795
|
*/
|
|
13526
13796
|
type ListCustomersEnv = OpenEnum<typeof ListCustomersEnv>;
|
|
13797
|
+
/**
|
|
13798
|
+
* The time interval for the purchase limit window.
|
|
13799
|
+
*/
|
|
13527
13800
|
declare const ListCustomersPurchaseLimitInterval2: {
|
|
13528
13801
|
readonly Hour: "hour";
|
|
13529
13802
|
readonly Day: "day";
|
|
13530
13803
|
readonly Week: "week";
|
|
13531
13804
|
readonly Month: "month";
|
|
13532
13805
|
};
|
|
13806
|
+
/**
|
|
13807
|
+
* The time interval for the purchase limit window.
|
|
13808
|
+
*/
|
|
13533
13809
|
type ListCustomersPurchaseLimitInterval2 = OpenEnum<typeof ListCustomersPurchaseLimitInterval2>;
|
|
13534
13810
|
type ListCustomersPurchaseLimit2 = {
|
|
13811
|
+
/**
|
|
13812
|
+
* The time interval for the purchase limit window.
|
|
13813
|
+
*/
|
|
13814
|
+
interval: ListCustomersPurchaseLimitInterval2;
|
|
13815
|
+
/**
|
|
13816
|
+
* Number of intervals in the purchase limit window.
|
|
13817
|
+
*/
|
|
13818
|
+
intervalCount: number;
|
|
13819
|
+
/**
|
|
13820
|
+
* Maximum number of auto top-ups allowed within the interval.
|
|
13821
|
+
*/
|
|
13822
|
+
limit: number;
|
|
13823
|
+
};
|
|
13824
|
+
declare const ListCustomersPurchaseLimitInterval1: {
|
|
13825
|
+
readonly Hour: "hour";
|
|
13826
|
+
readonly Day: "day";
|
|
13827
|
+
readonly Week: "week";
|
|
13828
|
+
readonly Month: "month";
|
|
13829
|
+
};
|
|
13830
|
+
type ListCustomersPurchaseLimitInterval1 = OpenEnum<typeof ListCustomersPurchaseLimitInterval1>;
|
|
13831
|
+
type ListCustomersPurchaseLimit1 = {
|
|
13535
13832
|
/**
|
|
13536
13833
|
* The time interval for the purchase limit window. Null when no purchase limit is configured.
|
|
13537
13834
|
*/
|
|
13538
|
-
interval:
|
|
13835
|
+
interval: ListCustomersPurchaseLimitInterval1 | null;
|
|
13539
13836
|
/**
|
|
13540
13837
|
* Number of intervals in the purchase limit window. Null when no purchase limit is configured.
|
|
13541
13838
|
*/
|
|
@@ -13554,32 +13851,16 @@ type ListCustomersPurchaseLimit2 = {
|
|
|
13554
13851
|
nextResetAt: number;
|
|
13555
13852
|
};
|
|
13556
13853
|
/**
|
|
13557
|
-
*
|
|
13854
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13558
13855
|
*/
|
|
13559
|
-
declare const
|
|
13560
|
-
readonly
|
|
13561
|
-
readonly
|
|
13562
|
-
readonly Week: "week";
|
|
13563
|
-
readonly Month: "month";
|
|
13856
|
+
declare const ListCustomersAutoTopupSource: {
|
|
13857
|
+
readonly Customer: "customer";
|
|
13858
|
+
readonly Plan: "plan";
|
|
13564
13859
|
};
|
|
13565
13860
|
/**
|
|
13566
|
-
*
|
|
13861
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13567
13862
|
*/
|
|
13568
|
-
type
|
|
13569
|
-
type ListCustomersPurchaseLimit1 = {
|
|
13570
|
-
/**
|
|
13571
|
-
* The time interval for the purchase limit window.
|
|
13572
|
-
*/
|
|
13573
|
-
interval: ListCustomersPurchaseLimitInterval1;
|
|
13574
|
-
/**
|
|
13575
|
-
* Number of intervals in the purchase limit window.
|
|
13576
|
-
*/
|
|
13577
|
-
intervalCount: number;
|
|
13578
|
-
/**
|
|
13579
|
-
* Maximum number of auto top-ups allowed within the interval.
|
|
13580
|
-
*/
|
|
13581
|
-
limit: number;
|
|
13582
|
-
};
|
|
13863
|
+
type ListCustomersAutoTopupSource = OpenEnum<typeof ListCustomersAutoTopupSource>;
|
|
13583
13864
|
type ListCustomersAutoTopup = {
|
|
13584
13865
|
/**
|
|
13585
13866
|
* The ID of the feature (credit balance) to auto top-up.
|
|
@@ -13600,11 +13881,15 @@ type ListCustomersAutoTopup = {
|
|
|
13600
13881
|
/**
|
|
13601
13882
|
* Optional rate limit to cap how often auto top-ups occur. Expand billing_controls.auto_topups.purchase_limit for a count of top ups and the next_reset_at.
|
|
13602
13883
|
*/
|
|
13603
|
-
purchaseLimit?:
|
|
13884
|
+
purchaseLimit?: ListCustomersPurchaseLimit1 | ListCustomersPurchaseLimit2 | undefined;
|
|
13604
13885
|
/**
|
|
13605
13886
|
* When true, auto top-up creates a send_invoice invoice instead of auto-charging.
|
|
13606
13887
|
*/
|
|
13607
13888
|
invoiceMode?: boolean | undefined;
|
|
13889
|
+
/**
|
|
13890
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13891
|
+
*/
|
|
13892
|
+
source?: ListCustomersAutoTopupSource | undefined;
|
|
13608
13893
|
};
|
|
13609
13894
|
/**
|
|
13610
13895
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
@@ -13617,6 +13902,17 @@ declare const ListCustomersLimitType: {
|
|
|
13617
13902
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
13618
13903
|
*/
|
|
13619
13904
|
type ListCustomersLimitType = OpenEnum<typeof ListCustomersLimitType>;
|
|
13905
|
+
/**
|
|
13906
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13907
|
+
*/
|
|
13908
|
+
declare const ListCustomersSpendLimitSource: {
|
|
13909
|
+
readonly Customer: "customer";
|
|
13910
|
+
readonly Plan: "plan";
|
|
13911
|
+
};
|
|
13912
|
+
/**
|
|
13913
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13914
|
+
*/
|
|
13915
|
+
type ListCustomersSpendLimitSource = OpenEnum<typeof ListCustomersSpendLimitSource>;
|
|
13620
13916
|
type ListCustomersSpendLimit = {
|
|
13621
13917
|
/**
|
|
13622
13918
|
* Optional feature ID this spend limit applies to.
|
|
@@ -13638,6 +13934,10 @@ type ListCustomersSpendLimit = {
|
|
|
13638
13934
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
13639
13935
|
*/
|
|
13640
13936
|
skipOverageBilling?: boolean | undefined;
|
|
13937
|
+
/**
|
|
13938
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13939
|
+
*/
|
|
13940
|
+
source?: ListCustomersSpendLimitSource | undefined;
|
|
13641
13941
|
};
|
|
13642
13942
|
/**
|
|
13643
13943
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -13660,6 +13960,17 @@ type ListCustomersFilter = {
|
|
|
13660
13960
|
[k: string]: any;
|
|
13661
13961
|
};
|
|
13662
13962
|
};
|
|
13963
|
+
/**
|
|
13964
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13965
|
+
*/
|
|
13966
|
+
declare const ListCustomersUsageLimitSource: {
|
|
13967
|
+
readonly Customer: "customer";
|
|
13968
|
+
readonly Plan: "plan";
|
|
13969
|
+
};
|
|
13970
|
+
/**
|
|
13971
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
13972
|
+
*/
|
|
13973
|
+
type ListCustomersUsageLimitSource = OpenEnum<typeof ListCustomersUsageLimitSource>;
|
|
13663
13974
|
type ListCustomersUsageLimit = {
|
|
13664
13975
|
/**
|
|
13665
13976
|
* The feature this usage limit applies to.
|
|
@@ -13685,6 +13996,10 @@ type ListCustomersUsageLimit = {
|
|
|
13685
13996
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
13686
13997
|
*/
|
|
13687
13998
|
usage?: number | undefined;
|
|
13999
|
+
/**
|
|
14000
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14001
|
+
*/
|
|
14002
|
+
source?: ListCustomersUsageLimitSource | undefined;
|
|
13688
14003
|
};
|
|
13689
14004
|
/**
|
|
13690
14005
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -13699,6 +14014,17 @@ declare const ListCustomersThresholdType: {
|
|
|
13699
14014
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
13700
14015
|
*/
|
|
13701
14016
|
type ListCustomersThresholdType = OpenEnum<typeof ListCustomersThresholdType>;
|
|
14017
|
+
/**
|
|
14018
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14019
|
+
*/
|
|
14020
|
+
declare const ListCustomersUsageAlertSource: {
|
|
14021
|
+
readonly Customer: "customer";
|
|
14022
|
+
readonly Plan: "plan";
|
|
14023
|
+
};
|
|
14024
|
+
/**
|
|
14025
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14026
|
+
*/
|
|
14027
|
+
type ListCustomersUsageAlertSource = OpenEnum<typeof ListCustomersUsageAlertSource>;
|
|
13702
14028
|
type ListCustomersUsageAlert = {
|
|
13703
14029
|
/**
|
|
13704
14030
|
* The feature ID this alert applies to.
|
|
@@ -13720,7 +14046,22 @@ type ListCustomersUsageAlert = {
|
|
|
13720
14046
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
13721
14047
|
*/
|
|
13722
14048
|
name?: string | undefined;
|
|
14049
|
+
/**
|
|
14050
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14051
|
+
*/
|
|
14052
|
+
source?: ListCustomersUsageAlertSource | undefined;
|
|
13723
14053
|
};
|
|
14054
|
+
/**
|
|
14055
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14056
|
+
*/
|
|
14057
|
+
declare const ListCustomersOverageAllowedSource: {
|
|
14058
|
+
readonly Customer: "customer";
|
|
14059
|
+
readonly Plan: "plan";
|
|
14060
|
+
};
|
|
14061
|
+
/**
|
|
14062
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14063
|
+
*/
|
|
14064
|
+
type ListCustomersOverageAllowedSource = OpenEnum<typeof ListCustomersOverageAllowedSource>;
|
|
13724
14065
|
type ListCustomersOverageAllowed = {
|
|
13725
14066
|
/**
|
|
13726
14067
|
* The feature ID this overage allowed control applies to.
|
|
@@ -13730,6 +14071,10 @@ type ListCustomersOverageAllowed = {
|
|
|
13730
14071
|
* Whether overage is allowed for this feature.
|
|
13731
14072
|
*/
|
|
13732
14073
|
enabled: boolean;
|
|
14074
|
+
/**
|
|
14075
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14076
|
+
*/
|
|
14077
|
+
source?: ListCustomersOverageAllowedSource | undefined;
|
|
13733
14078
|
};
|
|
13734
14079
|
/**
|
|
13735
14080
|
* Billing controls for the customer (auto top-ups, etc.)
|
|
@@ -14444,6 +14789,17 @@ declare const ListEntitiesLimitType: {
|
|
|
14444
14789
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
14445
14790
|
*/
|
|
14446
14791
|
type ListEntitiesLimitType = OpenEnum<typeof ListEntitiesLimitType>;
|
|
14792
|
+
/**
|
|
14793
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14794
|
+
*/
|
|
14795
|
+
declare const ListEntitiesSpendLimitSource: {
|
|
14796
|
+
readonly Customer: "customer";
|
|
14797
|
+
readonly Plan: "plan";
|
|
14798
|
+
};
|
|
14799
|
+
/**
|
|
14800
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14801
|
+
*/
|
|
14802
|
+
type ListEntitiesSpendLimitSource = OpenEnum<typeof ListEntitiesSpendLimitSource>;
|
|
14447
14803
|
type ListEntitiesSpendLimit = {
|
|
14448
14804
|
/**
|
|
14449
14805
|
* Optional feature ID this spend limit applies to.
|
|
@@ -14465,6 +14821,10 @@ type ListEntitiesSpendLimit = {
|
|
|
14465
14821
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
14466
14822
|
*/
|
|
14467
14823
|
skipOverageBilling?: boolean | undefined;
|
|
14824
|
+
/**
|
|
14825
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14826
|
+
*/
|
|
14827
|
+
source?: ListEntitiesSpendLimitSource | undefined;
|
|
14468
14828
|
};
|
|
14469
14829
|
/**
|
|
14470
14830
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -14487,6 +14847,17 @@ type ListEntitiesFilter = {
|
|
|
14487
14847
|
[k: string]: any;
|
|
14488
14848
|
};
|
|
14489
14849
|
};
|
|
14850
|
+
/**
|
|
14851
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14852
|
+
*/
|
|
14853
|
+
declare const ListEntitiesUsageLimitSource: {
|
|
14854
|
+
readonly Customer: "customer";
|
|
14855
|
+
readonly Plan: "plan";
|
|
14856
|
+
};
|
|
14857
|
+
/**
|
|
14858
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14859
|
+
*/
|
|
14860
|
+
type ListEntitiesUsageLimitSource = OpenEnum<typeof ListEntitiesUsageLimitSource>;
|
|
14490
14861
|
type ListEntitiesUsageLimit = {
|
|
14491
14862
|
/**
|
|
14492
14863
|
* The feature this usage limit applies to.
|
|
@@ -14512,6 +14883,10 @@ type ListEntitiesUsageLimit = {
|
|
|
14512
14883
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
14513
14884
|
*/
|
|
14514
14885
|
usage?: number | undefined;
|
|
14886
|
+
/**
|
|
14887
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14888
|
+
*/
|
|
14889
|
+
source?: ListEntitiesUsageLimitSource | undefined;
|
|
14515
14890
|
};
|
|
14516
14891
|
/**
|
|
14517
14892
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -14526,6 +14901,17 @@ declare const ListEntitiesThresholdType: {
|
|
|
14526
14901
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
14527
14902
|
*/
|
|
14528
14903
|
type ListEntitiesThresholdType = OpenEnum<typeof ListEntitiesThresholdType>;
|
|
14904
|
+
/**
|
|
14905
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14906
|
+
*/
|
|
14907
|
+
declare const ListEntitiesUsageAlertSource: {
|
|
14908
|
+
readonly Customer: "customer";
|
|
14909
|
+
readonly Plan: "plan";
|
|
14910
|
+
};
|
|
14911
|
+
/**
|
|
14912
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14913
|
+
*/
|
|
14914
|
+
type ListEntitiesUsageAlertSource = OpenEnum<typeof ListEntitiesUsageAlertSource>;
|
|
14529
14915
|
type ListEntitiesUsageAlert = {
|
|
14530
14916
|
/**
|
|
14531
14917
|
* The feature ID this alert applies to.
|
|
@@ -14547,7 +14933,22 @@ type ListEntitiesUsageAlert = {
|
|
|
14547
14933
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
14548
14934
|
*/
|
|
14549
14935
|
name?: string | undefined;
|
|
14936
|
+
/**
|
|
14937
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14938
|
+
*/
|
|
14939
|
+
source?: ListEntitiesUsageAlertSource | undefined;
|
|
14940
|
+
};
|
|
14941
|
+
/**
|
|
14942
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14943
|
+
*/
|
|
14944
|
+
declare const ListEntitiesOverageAllowedSource: {
|
|
14945
|
+
readonly Customer: "customer";
|
|
14946
|
+
readonly Plan: "plan";
|
|
14550
14947
|
};
|
|
14948
|
+
/**
|
|
14949
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14950
|
+
*/
|
|
14951
|
+
type ListEntitiesOverageAllowedSource = OpenEnum<typeof ListEntitiesOverageAllowedSource>;
|
|
14551
14952
|
type ListEntitiesOverageAllowed = {
|
|
14552
14953
|
/**
|
|
14553
14954
|
* The feature ID this overage allowed control applies to.
|
|
@@ -14557,6 +14958,10 @@ type ListEntitiesOverageAllowed = {
|
|
|
14557
14958
|
* Whether overage is allowed for this feature.
|
|
14558
14959
|
*/
|
|
14559
14960
|
enabled: boolean;
|
|
14961
|
+
/**
|
|
14962
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
14963
|
+
*/
|
|
14964
|
+
source?: ListEntitiesOverageAllowedSource | undefined;
|
|
14560
14965
|
};
|
|
14561
14966
|
/**
|
|
14562
14967
|
* Billing controls for the entity.
|
|
@@ -22821,6 +23226,10 @@ type UpdateBalanceParams = {
|
|
|
22821
23226
|
* The next reset time for the balance. If there are multiple breakdowns, this will update the breakdown with the next reset time.
|
|
22822
23227
|
*/
|
|
22823
23228
|
nextResetAt?: number | undefined;
|
|
23229
|
+
/**
|
|
23230
|
+
* Unix timestamp (milliseconds) when the balance expires. Targets a specific balance via balance_id / interval when the customer has multiple balances for the same feature.
|
|
23231
|
+
*/
|
|
23232
|
+
expiresAt?: number | undefined;
|
|
22824
23233
|
};
|
|
22825
23234
|
/**
|
|
22826
23235
|
* OK
|
|
@@ -23099,18 +23508,45 @@ declare const UpdateCustomerEnv: {
|
|
|
23099
23508
|
* The environment this customer was created in.
|
|
23100
23509
|
*/
|
|
23101
23510
|
type UpdateCustomerEnv = OpenEnum<typeof UpdateCustomerEnv>;
|
|
23511
|
+
/**
|
|
23512
|
+
* The time interval for the purchase limit window.
|
|
23513
|
+
*/
|
|
23102
23514
|
declare const UpdateCustomerPurchaseLimitIntervalResponse2: {
|
|
23103
23515
|
readonly Hour: "hour";
|
|
23104
23516
|
readonly Day: "day";
|
|
23105
23517
|
readonly Week: "week";
|
|
23106
23518
|
readonly Month: "month";
|
|
23107
23519
|
};
|
|
23520
|
+
/**
|
|
23521
|
+
* The time interval for the purchase limit window.
|
|
23522
|
+
*/
|
|
23108
23523
|
type UpdateCustomerPurchaseLimitIntervalResponse2 = OpenEnum<typeof UpdateCustomerPurchaseLimitIntervalResponse2>;
|
|
23109
23524
|
type UpdateCustomerPurchaseLimitResponse2 = {
|
|
23525
|
+
/**
|
|
23526
|
+
* The time interval for the purchase limit window.
|
|
23527
|
+
*/
|
|
23528
|
+
interval: UpdateCustomerPurchaseLimitIntervalResponse2;
|
|
23529
|
+
/**
|
|
23530
|
+
* Number of intervals in the purchase limit window.
|
|
23531
|
+
*/
|
|
23532
|
+
intervalCount: number;
|
|
23533
|
+
/**
|
|
23534
|
+
* Maximum number of auto top-ups allowed within the interval.
|
|
23535
|
+
*/
|
|
23536
|
+
limit: number;
|
|
23537
|
+
};
|
|
23538
|
+
declare const UpdateCustomerPurchaseLimitIntervalResponse1: {
|
|
23539
|
+
readonly Hour: "hour";
|
|
23540
|
+
readonly Day: "day";
|
|
23541
|
+
readonly Week: "week";
|
|
23542
|
+
readonly Month: "month";
|
|
23543
|
+
};
|
|
23544
|
+
type UpdateCustomerPurchaseLimitIntervalResponse1 = OpenEnum<typeof UpdateCustomerPurchaseLimitIntervalResponse1>;
|
|
23545
|
+
type UpdateCustomerPurchaseLimitResponse1 = {
|
|
23110
23546
|
/**
|
|
23111
23547
|
* The time interval for the purchase limit window. Null when no purchase limit is configured.
|
|
23112
23548
|
*/
|
|
23113
|
-
interval:
|
|
23549
|
+
interval: UpdateCustomerPurchaseLimitIntervalResponse1 | null;
|
|
23114
23550
|
/**
|
|
23115
23551
|
* Number of intervals in the purchase limit window. Null when no purchase limit is configured.
|
|
23116
23552
|
*/
|
|
@@ -23129,32 +23565,16 @@ type UpdateCustomerPurchaseLimitResponse2 = {
|
|
|
23129
23565
|
nextResetAt: number;
|
|
23130
23566
|
};
|
|
23131
23567
|
/**
|
|
23132
|
-
*
|
|
23568
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23133
23569
|
*/
|
|
23134
|
-
declare const
|
|
23135
|
-
readonly
|
|
23136
|
-
readonly
|
|
23137
|
-
readonly Week: "week";
|
|
23138
|
-
readonly Month: "month";
|
|
23570
|
+
declare const UpdateCustomerAutoTopupSource: {
|
|
23571
|
+
readonly Customer: "customer";
|
|
23572
|
+
readonly Plan: "plan";
|
|
23139
23573
|
};
|
|
23140
23574
|
/**
|
|
23141
|
-
*
|
|
23575
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23142
23576
|
*/
|
|
23143
|
-
type
|
|
23144
|
-
type UpdateCustomerPurchaseLimitResponse1 = {
|
|
23145
|
-
/**
|
|
23146
|
-
* The time interval for the purchase limit window.
|
|
23147
|
-
*/
|
|
23148
|
-
interval: UpdateCustomerPurchaseLimitIntervalResponse1;
|
|
23149
|
-
/**
|
|
23150
|
-
* Number of intervals in the purchase limit window.
|
|
23151
|
-
*/
|
|
23152
|
-
intervalCount: number;
|
|
23153
|
-
/**
|
|
23154
|
-
* Maximum number of auto top-ups allowed within the interval.
|
|
23155
|
-
*/
|
|
23156
|
-
limit: number;
|
|
23157
|
-
};
|
|
23577
|
+
type UpdateCustomerAutoTopupSource = OpenEnum<typeof UpdateCustomerAutoTopupSource>;
|
|
23158
23578
|
type UpdateCustomerAutoTopupResponse = {
|
|
23159
23579
|
/**
|
|
23160
23580
|
* The ID of the feature (credit balance) to auto top-up.
|
|
@@ -23175,11 +23595,15 @@ type UpdateCustomerAutoTopupResponse = {
|
|
|
23175
23595
|
/**
|
|
23176
23596
|
* Optional rate limit to cap how often auto top-ups occur. Expand billing_controls.auto_topups.purchase_limit for a count of top ups and the next_reset_at.
|
|
23177
23597
|
*/
|
|
23178
|
-
purchaseLimit?:
|
|
23598
|
+
purchaseLimit?: UpdateCustomerPurchaseLimitResponse1 | UpdateCustomerPurchaseLimitResponse2 | undefined;
|
|
23179
23599
|
/**
|
|
23180
23600
|
* When true, auto top-up creates a send_invoice invoice instead of auto-charging.
|
|
23181
23601
|
*/
|
|
23182
23602
|
invoiceMode?: boolean | undefined;
|
|
23603
|
+
/**
|
|
23604
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23605
|
+
*/
|
|
23606
|
+
source?: UpdateCustomerAutoTopupSource | undefined;
|
|
23183
23607
|
};
|
|
23184
23608
|
/**
|
|
23185
23609
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
@@ -23192,6 +23616,17 @@ declare const UpdateCustomerLimitTypeResponse: {
|
|
|
23192
23616
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
23193
23617
|
*/
|
|
23194
23618
|
type UpdateCustomerLimitTypeResponse = OpenEnum<typeof UpdateCustomerLimitTypeResponse>;
|
|
23619
|
+
/**
|
|
23620
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23621
|
+
*/
|
|
23622
|
+
declare const UpdateCustomerSpendLimitSource: {
|
|
23623
|
+
readonly Customer: "customer";
|
|
23624
|
+
readonly Plan: "plan";
|
|
23625
|
+
};
|
|
23626
|
+
/**
|
|
23627
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23628
|
+
*/
|
|
23629
|
+
type UpdateCustomerSpendLimitSource = OpenEnum<typeof UpdateCustomerSpendLimitSource>;
|
|
23195
23630
|
type UpdateCustomerSpendLimitResponse = {
|
|
23196
23631
|
/**
|
|
23197
23632
|
* Optional feature ID this spend limit applies to.
|
|
@@ -23213,6 +23648,10 @@ type UpdateCustomerSpendLimitResponse = {
|
|
|
23213
23648
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
23214
23649
|
*/
|
|
23215
23650
|
skipOverageBilling?: boolean | undefined;
|
|
23651
|
+
/**
|
|
23652
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23653
|
+
*/
|
|
23654
|
+
source?: UpdateCustomerSpendLimitSource | undefined;
|
|
23216
23655
|
};
|
|
23217
23656
|
/**
|
|
23218
23657
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -23235,6 +23674,17 @@ type UpdateCustomerFilterResponse = {
|
|
|
23235
23674
|
[k: string]: any;
|
|
23236
23675
|
};
|
|
23237
23676
|
};
|
|
23677
|
+
/**
|
|
23678
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23679
|
+
*/
|
|
23680
|
+
declare const UpdateCustomerUsageLimitSource: {
|
|
23681
|
+
readonly Customer: "customer";
|
|
23682
|
+
readonly Plan: "plan";
|
|
23683
|
+
};
|
|
23684
|
+
/**
|
|
23685
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23686
|
+
*/
|
|
23687
|
+
type UpdateCustomerUsageLimitSource = OpenEnum<typeof UpdateCustomerUsageLimitSource>;
|
|
23238
23688
|
type UpdateCustomerUsageLimitResponse = {
|
|
23239
23689
|
/**
|
|
23240
23690
|
* The feature this usage limit applies to.
|
|
@@ -23260,6 +23710,10 @@ type UpdateCustomerUsageLimitResponse = {
|
|
|
23260
23710
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
23261
23711
|
*/
|
|
23262
23712
|
usage?: number | undefined;
|
|
23713
|
+
/**
|
|
23714
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23715
|
+
*/
|
|
23716
|
+
source?: UpdateCustomerUsageLimitSource | undefined;
|
|
23263
23717
|
};
|
|
23264
23718
|
/**
|
|
23265
23719
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -23274,6 +23728,17 @@ declare const UpdateCustomerThresholdTypeResponse: {
|
|
|
23274
23728
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
23275
23729
|
*/
|
|
23276
23730
|
type UpdateCustomerThresholdTypeResponse = OpenEnum<typeof UpdateCustomerThresholdTypeResponse>;
|
|
23731
|
+
/**
|
|
23732
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23733
|
+
*/
|
|
23734
|
+
declare const UpdateCustomerUsageAlertSource: {
|
|
23735
|
+
readonly Customer: "customer";
|
|
23736
|
+
readonly Plan: "plan";
|
|
23737
|
+
};
|
|
23738
|
+
/**
|
|
23739
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23740
|
+
*/
|
|
23741
|
+
type UpdateCustomerUsageAlertSource = OpenEnum<typeof UpdateCustomerUsageAlertSource>;
|
|
23277
23742
|
type UpdateCustomerUsageAlertResponse = {
|
|
23278
23743
|
/**
|
|
23279
23744
|
* The feature ID this alert applies to.
|
|
@@ -23295,7 +23760,22 @@ type UpdateCustomerUsageAlertResponse = {
|
|
|
23295
23760
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
23296
23761
|
*/
|
|
23297
23762
|
name?: string | undefined;
|
|
23763
|
+
/**
|
|
23764
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23765
|
+
*/
|
|
23766
|
+
source?: UpdateCustomerUsageAlertSource | undefined;
|
|
23298
23767
|
};
|
|
23768
|
+
/**
|
|
23769
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23770
|
+
*/
|
|
23771
|
+
declare const UpdateCustomerOverageAllowedSource: {
|
|
23772
|
+
readonly Customer: "customer";
|
|
23773
|
+
readonly Plan: "plan";
|
|
23774
|
+
};
|
|
23775
|
+
/**
|
|
23776
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23777
|
+
*/
|
|
23778
|
+
type UpdateCustomerOverageAllowedSource = OpenEnum<typeof UpdateCustomerOverageAllowedSource>;
|
|
23299
23779
|
type UpdateCustomerOverageAllowedResponse = {
|
|
23300
23780
|
/**
|
|
23301
23781
|
* The feature ID this overage allowed control applies to.
|
|
@@ -23305,6 +23785,10 @@ type UpdateCustomerOverageAllowedResponse = {
|
|
|
23305
23785
|
* Whether overage is allowed for this feature.
|
|
23306
23786
|
*/
|
|
23307
23787
|
enabled: boolean;
|
|
23788
|
+
/**
|
|
23789
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
23790
|
+
*/
|
|
23791
|
+
source?: UpdateCustomerOverageAllowedSource | undefined;
|
|
23308
23792
|
};
|
|
23309
23793
|
/**
|
|
23310
23794
|
* Billing controls for the customer (auto top-ups, etc.)
|
|
@@ -24114,6 +24598,17 @@ declare const UpdateEntityLimitTypeResponse: {
|
|
|
24114
24598
|
* How overage_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
|
|
24115
24599
|
*/
|
|
24116
24600
|
type UpdateEntityLimitTypeResponse = OpenEnum<typeof UpdateEntityLimitTypeResponse>;
|
|
24601
|
+
/**
|
|
24602
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24603
|
+
*/
|
|
24604
|
+
declare const UpdateEntitySpendLimitSource: {
|
|
24605
|
+
readonly Customer: "customer";
|
|
24606
|
+
readonly Plan: "plan";
|
|
24607
|
+
};
|
|
24608
|
+
/**
|
|
24609
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24610
|
+
*/
|
|
24611
|
+
type UpdateEntitySpendLimitSource = OpenEnum<typeof UpdateEntitySpendLimitSource>;
|
|
24117
24612
|
type UpdateEntitySpendLimitResponse = {
|
|
24118
24613
|
/**
|
|
24119
24614
|
* Optional feature ID this spend limit applies to.
|
|
@@ -24135,6 +24630,10 @@ type UpdateEntitySpendLimitResponse = {
|
|
|
24135
24630
|
* When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
|
|
24136
24631
|
*/
|
|
24137
24632
|
skipOverageBilling?: boolean | undefined;
|
|
24633
|
+
/**
|
|
24634
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24635
|
+
*/
|
|
24636
|
+
source?: UpdateEntitySpendLimitSource | undefined;
|
|
24138
24637
|
};
|
|
24139
24638
|
/**
|
|
24140
24639
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
@@ -24157,6 +24656,17 @@ type UpdateEntityFilterResponse = {
|
|
|
24157
24656
|
[k: string]: any;
|
|
24158
24657
|
};
|
|
24159
24658
|
};
|
|
24659
|
+
/**
|
|
24660
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24661
|
+
*/
|
|
24662
|
+
declare const UpdateEntityUsageLimitSource: {
|
|
24663
|
+
readonly Customer: "customer";
|
|
24664
|
+
readonly Plan: "plan";
|
|
24665
|
+
};
|
|
24666
|
+
/**
|
|
24667
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24668
|
+
*/
|
|
24669
|
+
type UpdateEntityUsageLimitSource = OpenEnum<typeof UpdateEntityUsageLimitSource>;
|
|
24160
24670
|
type UpdateEntityUsageLimitResponse = {
|
|
24161
24671
|
/**
|
|
24162
24672
|
* The feature this usage limit applies to.
|
|
@@ -24182,6 +24692,10 @@ type UpdateEntityUsageLimitResponse = {
|
|
|
24182
24692
|
* Current usage already consumed in the active interval. Response-only; not stored on billing controls.
|
|
24183
24693
|
*/
|
|
24184
24694
|
usage?: number | undefined;
|
|
24695
|
+
/**
|
|
24696
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24697
|
+
*/
|
|
24698
|
+
source?: UpdateEntityUsageLimitSource | undefined;
|
|
24185
24699
|
};
|
|
24186
24700
|
/**
|
|
24187
24701
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
@@ -24196,6 +24710,17 @@ declare const UpdateEntityThresholdTypeResponse: {
|
|
|
24196
24710
|
* Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
|
|
24197
24711
|
*/
|
|
24198
24712
|
type UpdateEntityThresholdTypeResponse = OpenEnum<typeof UpdateEntityThresholdTypeResponse>;
|
|
24713
|
+
/**
|
|
24714
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24715
|
+
*/
|
|
24716
|
+
declare const UpdateEntityUsageAlertSource: {
|
|
24717
|
+
readonly Customer: "customer";
|
|
24718
|
+
readonly Plan: "plan";
|
|
24719
|
+
};
|
|
24720
|
+
/**
|
|
24721
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24722
|
+
*/
|
|
24723
|
+
type UpdateEntityUsageAlertSource = OpenEnum<typeof UpdateEntityUsageAlertSource>;
|
|
24199
24724
|
type UpdateEntityUsageAlertResponse = {
|
|
24200
24725
|
/**
|
|
24201
24726
|
* The feature ID this alert applies to.
|
|
@@ -24217,7 +24742,22 @@ type UpdateEntityUsageAlertResponse = {
|
|
|
24217
24742
|
* Optional user-defined label to distinguish multiple alerts on the same feature.
|
|
24218
24743
|
*/
|
|
24219
24744
|
name?: string | undefined;
|
|
24745
|
+
/**
|
|
24746
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24747
|
+
*/
|
|
24748
|
+
source?: UpdateEntityUsageAlertSource | undefined;
|
|
24749
|
+
};
|
|
24750
|
+
/**
|
|
24751
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24752
|
+
*/
|
|
24753
|
+
declare const UpdateEntityOverageAllowedSource: {
|
|
24754
|
+
readonly Customer: "customer";
|
|
24755
|
+
readonly Plan: "plan";
|
|
24220
24756
|
};
|
|
24757
|
+
/**
|
|
24758
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24759
|
+
*/
|
|
24760
|
+
type UpdateEntityOverageAllowedSource = OpenEnum<typeof UpdateEntityOverageAllowedSource>;
|
|
24221
24761
|
type UpdateEntityOverageAllowedResponse = {
|
|
24222
24762
|
/**
|
|
24223
24763
|
* The feature ID this overage allowed control applies to.
|
|
@@ -24227,6 +24767,10 @@ type UpdateEntityOverageAllowedResponse = {
|
|
|
24227
24767
|
* Whether overage is allowed for this feature.
|
|
24228
24768
|
*/
|
|
24229
24769
|
enabled: boolean;
|
|
24770
|
+
/**
|
|
24771
|
+
* Response-only: whether the entry is a customer-level override or inherited from an attached plan's defaults.
|
|
24772
|
+
*/
|
|
24773
|
+
source?: UpdateEntityOverageAllowedSource | undefined;
|
|
24230
24774
|
};
|
|
24231
24775
|
/**
|
|
24232
24776
|
* Billing controls for the entity.
|
|
@@ -27191,7 +27735,7 @@ declare class Billing extends ClientSDK {
|
|
|
27191
27735
|
* @example
|
|
27192
27736
|
* ```typescript
|
|
27193
27737
|
* // Schedule a transition from a trial plan to a paid plan
|
|
27194
|
-
* const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":
|
|
27738
|
+
* const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":1783701939170,"plans":[{"planId":"trial_plan"}]},{"startsAt":1784911539170,"plans":[{"planId":"pro_plan"}]}] });
|
|
27195
27739
|
* ```
|
|
27196
27740
|
*
|
|
27197
27741
|
* @param customerId - The ID of the customer to create the schedule for.
|