autumn-js 1.3.2 → 1.3.3
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 +6018 -6627
- package/dist/backend/adapters/express.mjs +9 -9
- package/dist/backend/adapters/fetch.js +6018 -6627
- package/dist/backend/adapters/fetch.mjs +9 -9
- package/dist/backend/adapters/hono.js +6018 -6627
- package/dist/backend/adapters/hono.mjs +9 -9
- package/dist/backend/adapters/index.js +6019 -6628
- package/dist/backend/adapters/index.mjs +12 -12
- package/dist/backend/adapters/next.js +6018 -6627
- package/dist/backend/adapters/next.mjs +9 -9
- package/dist/backend/{chunk-P3NB2TPD.mjs → chunk-65W4TZTS.mjs} +1 -1
- package/dist/backend/{chunk-U3XVAFP3.mjs → chunk-7KCCF4EQ.mjs} +1 -1
- package/dist/backend/{chunk-BN2RKNWA.mjs → chunk-7M2QJK3F.mjs} +1 -1
- package/dist/backend/{chunk-WBVNGT6C.mjs → chunk-ALCYAWIU.mjs} +5615 -5173
- package/dist/backend/{chunk-UFFJTOUP.mjs → chunk-DMYETTMK.mjs} +1 -1
- package/dist/backend/{chunk-O2FNE4BV.mjs → chunk-ECPEYFTT.mjs} +7 -7
- package/dist/backend/{chunk-MMTTJRJ7.mjs → chunk-QTW6YBAQ.mjs} +790 -1841
- package/dist/backend/{chunk-2WFPFKXF.mjs → chunk-UCE7X36J.mjs} +5 -5
- 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 +6018 -6627
- package/dist/backend/core/handlers/coreHandler.mjs +7 -7
- 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 +6018 -6627
- package/dist/backend/core/handlers/handleRouteByName.mjs +7 -7
- 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 +6018 -6627
- 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 +6018 -6627
- package/dist/backend/core/index.mjs +10 -10
- 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.js +790 -1841
- package/dist/backend/core/routes/index.mjs +2 -2
- 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.js +790 -1841
- package/dist/backend/core/routes/routeConfigs.mjs +2 -2
- 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 +6018 -6627
- package/dist/backend/index.mjs +10 -10
- package/dist/backend/{routeTypes-B4IhP62O.d.mts → routeTypes-CIyvTbT-.d.mts} +933 -268
- package/dist/backend/{routeTypes-Clg-tGZs.d.ts → routeTypes-Dovw-kXS.d.ts} +933 -268
- package/dist/better-auth/{chunk-QRHWL7PJ.mjs → chunk-AYUZ7BAL.mjs} +1 -1
- package/dist/better-auth/{chunk-ZSPHK3QP.mjs → chunk-MAM2SPNT.mjs} +790 -1841
- package/dist/better-auth/{chunk-GHX3KM47.mjs → chunk-RXQY5TZP.mjs} +5616 -5174
- package/dist/better-auth/index.js +6247 -6856
- package/dist/better-auth/index.mjs +3 -3
- package/dist/better-auth/utils/createAutumnEndpoint.js +790 -1841
- package/dist/better-auth/utils/createAutumnEndpoint.mjs +2 -2
- package/dist/better-auth/utils/handleBetterAuthRoute.js +6018 -6627
- package/dist/better-auth/utils/handleBetterAuthRoute.mjs +2 -2
- package/dist/better-auth/utils/index.js +6247 -6856
- 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-7v3j-HM8.d.ts → customer-Bp7Npmb4.d.ts} +1 -5
- package/dist/react/{customer-B1dHh-Kx.d.mts → customer-Ho7hCUyc.d.mts} +1 -5
- package/dist/react/hooks/index.d.mts +4 -4
- package/dist/react/hooks/index.d.ts +4 -4
- package/dist/react/hooks/index.mjs +5 -5
- 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/index.mjs +5 -5
- package/dist/react/{list-plans-response-BdNdM3Qx.d.ts → list-plans-response-CN5npYlB.d.mts} +126 -5
- package/dist/react/{list-plans-response-CH1VbFIg.d.mts → list-plans-response-ZA4i4qbk.d.ts} +126 -5
- package/dist/react/{params-ClWEGYj-.d.mts → params-ChTAunjw.d.ts} +344 -25
- package/dist/react/{params-cj_zZr99.d.ts → params-xlsDk_Hb.d.mts} +344 -25
- package/dist/react/{plan-Dq6s6t9I.d.mts → plan-CrpW2EZo.d.mts} +52 -5
- package/dist/react/{plan-Dq6s6t9I.d.ts → plan-CrpW2EZo.d.ts} +52 -5
- package/dist/sdk/index.d.mts +4387 -3312
- package/dist/sdk/index.d.ts +4387 -3312
- package/dist/sdk/index.js +19203 -18287
- package/dist/sdk/index.mjs +19003 -18271
- package/package.json +3 -2
- package/dist/backend/{chunk-IXUCY7AU.mjs → chunk-MOHYGUMA.mjs} +3 -3
|
@@ -336,6 +336,32 @@ type AggregateEventsResponse = {
|
|
|
336
336
|
deductions?: Array<AggregateEventsDeduction> | undefined;
|
|
337
337
|
};
|
|
338
338
|
|
|
339
|
+
type AttachLicenseEntity = {
|
|
340
|
+
/**
|
|
341
|
+
* The ID of the entity to assign the license to.
|
|
342
|
+
*/
|
|
343
|
+
entityId: string;
|
|
344
|
+
/**
|
|
345
|
+
* The name of the entity, used when creating it.
|
|
346
|
+
*/
|
|
347
|
+
name?: string | null | undefined;
|
|
348
|
+
/**
|
|
349
|
+
* The feature the entity is associated with. Required when the entity does not exist yet.
|
|
350
|
+
*/
|
|
351
|
+
featureId?: string | undefined;
|
|
352
|
+
};
|
|
353
|
+
type AttachLicenseParams = {
|
|
354
|
+
customerId: string;
|
|
355
|
+
planId: string;
|
|
356
|
+
entities: Array<AttachLicenseEntity>;
|
|
357
|
+
};
|
|
358
|
+
/**
|
|
359
|
+
* OK
|
|
360
|
+
*/
|
|
361
|
+
type AttachLicenseResponse = {
|
|
362
|
+
success: boolean;
|
|
363
|
+
};
|
|
364
|
+
|
|
339
365
|
/**
|
|
340
366
|
* Quantity configuration for a prepaid feature.
|
|
341
367
|
*/
|
|
@@ -651,6 +677,20 @@ type AttachItemRollover = {
|
|
|
651
677
|
*/
|
|
652
678
|
expiryDurationLength?: number | undefined;
|
|
653
679
|
};
|
|
680
|
+
declare const AttachItemDuration: {
|
|
681
|
+
readonly Day: "day";
|
|
682
|
+
readonly Week: "week";
|
|
683
|
+
readonly Month: "month";
|
|
684
|
+
readonly Year: "year";
|
|
685
|
+
};
|
|
686
|
+
type AttachItemDuration = ClosedEnum<typeof AttachItemDuration>;
|
|
687
|
+
/**
|
|
688
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
689
|
+
*/
|
|
690
|
+
type AttachItemExpiry = {
|
|
691
|
+
duration: AttachItemDuration;
|
|
692
|
+
length: number;
|
|
693
|
+
};
|
|
654
694
|
type AttachDimensionsItem4 = {
|
|
655
695
|
/**
|
|
656
696
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -917,6 +957,10 @@ type AttachItemPlanItem = {
|
|
|
917
957
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
918
958
|
*/
|
|
919
959
|
rollover?: AttachItemRollover | undefined;
|
|
960
|
+
/**
|
|
961
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
962
|
+
*/
|
|
963
|
+
expiry?: AttachItemExpiry | undefined;
|
|
920
964
|
/**
|
|
921
965
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
922
966
|
*/
|
|
@@ -1130,6 +1174,20 @@ type AttachAddItemRollover = {
|
|
|
1130
1174
|
*/
|
|
1131
1175
|
expiryDurationLength?: number | undefined;
|
|
1132
1176
|
};
|
|
1177
|
+
declare const AttachAddItemDuration: {
|
|
1178
|
+
readonly Day: "day";
|
|
1179
|
+
readonly Week: "week";
|
|
1180
|
+
readonly Month: "month";
|
|
1181
|
+
readonly Year: "year";
|
|
1182
|
+
};
|
|
1183
|
+
type AttachAddItemDuration = ClosedEnum<typeof AttachAddItemDuration>;
|
|
1184
|
+
/**
|
|
1185
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
1186
|
+
*/
|
|
1187
|
+
type AttachAddItemExpiry = {
|
|
1188
|
+
duration: AttachAddItemDuration;
|
|
1189
|
+
length: number;
|
|
1190
|
+
};
|
|
1133
1191
|
type AttachDimensionsAddItem4 = {
|
|
1134
1192
|
/**
|
|
1135
1193
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -1396,6 +1454,10 @@ type AttachAddItemPlanItem = {
|
|
|
1396
1454
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
1397
1455
|
*/
|
|
1398
1456
|
rollover?: AttachAddItemRollover | undefined;
|
|
1457
|
+
/**
|
|
1458
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
1459
|
+
*/
|
|
1460
|
+
expiry?: AttachAddItemExpiry | undefined;
|
|
1399
1461
|
/**
|
|
1400
1462
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
1401
1463
|
*/
|
|
@@ -2006,6 +2068,21 @@ type AttachUpsertLicenseRollover = {
|
|
|
2006
2068
|
*/
|
|
2007
2069
|
expiryDurationLength?: number | undefined;
|
|
2008
2070
|
};
|
|
2071
|
+
|
|
2072
|
+
declare const AttachUpsertLicenseDuration: {
|
|
2073
|
+
readonly Day: "day";
|
|
2074
|
+
readonly Week: "week";
|
|
2075
|
+
readonly Month: "month";
|
|
2076
|
+
readonly Year: "year";
|
|
2077
|
+
};
|
|
2078
|
+
type AttachUpsertLicenseDuration = ClosedEnum<typeof AttachUpsertLicenseDuration>;
|
|
2079
|
+
/**
|
|
2080
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
2081
|
+
*/
|
|
2082
|
+
type AttachUpsertLicenseExpiry = {
|
|
2083
|
+
duration: AttachUpsertLicenseDuration;
|
|
2084
|
+
length: number;
|
|
2085
|
+
};
|
|
2009
2086
|
type AttachDimensionsUpsertLicense4 = {
|
|
2010
2087
|
/**
|
|
2011
2088
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -2022,38 +2099,10 @@ type AttachDimensionsUpsertLicense4 = {
|
|
|
2022
2099
|
*/
|
|
2023
2100
|
creditCost: number;
|
|
2024
2101
|
};
|
|
2025
|
-
type AttachDimensionsUpsertLicenseMatch3 = string | number | boolean;
|
|
2026
2102
|
declare const AttachDimensionsToUpsertLicenseEnum2: {
|
|
2027
2103
|
readonly Inf: "inf";
|
|
2028
2104
|
};
|
|
2029
2105
|
type AttachDimensionsToUpsertLicenseEnum2 = ClosedEnum<typeof AttachDimensionsToUpsertLicenseEnum2>;
|
|
2030
|
-
|
|
2031
|
-
type AttachLicenseEntity = {
|
|
2032
|
-
/**
|
|
2033
|
-
* The ID of the entity to assign the license to.
|
|
2034
|
-
*/
|
|
2035
|
-
entityId: string;
|
|
2036
|
-
/**
|
|
2037
|
-
* The name of the entity, used when creating it.
|
|
2038
|
-
*/
|
|
2039
|
-
name?: string | null | undefined;
|
|
2040
|
-
/**
|
|
2041
|
-
* The feature the entity is associated with. Required when the entity does not exist yet.
|
|
2042
|
-
*/
|
|
2043
|
-
featureId?: string | undefined;
|
|
2044
|
-
};
|
|
2045
|
-
type AttachLicenseParams = {
|
|
2046
|
-
customerId: string;
|
|
2047
|
-
planId: string;
|
|
2048
|
-
entities: Array<AttachLicenseEntity>;
|
|
2049
|
-
};
|
|
2050
|
-
/**
|
|
2051
|
-
* OK
|
|
2052
|
-
*/
|
|
2053
|
-
type AttachLicenseResponse = {
|
|
2054
|
-
success: boolean;
|
|
2055
|
-
};
|
|
2056
|
-
|
|
2057
2106
|
type AttachDimensionsUpsertLicenseTier2 = {
|
|
2058
2107
|
/**
|
|
2059
2108
|
* Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'.
|
|
@@ -2069,7 +2118,7 @@ type AttachDimensionsUpsertLicense3 = {
|
|
|
2069
2118
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
2070
2119
|
*/
|
|
2071
2120
|
match: {
|
|
2072
|
-
[k: string]:
|
|
2121
|
+
[k: string]: string | number | boolean;
|
|
2073
2122
|
};
|
|
2074
2123
|
/**
|
|
2075
2124
|
* Breaks ties between dimensions that match the same number of keys. Higher wins.
|
|
@@ -2300,6 +2349,10 @@ type AttachUpsertLicensePlanItem = {
|
|
|
2300
2349
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
2301
2350
|
*/
|
|
2302
2351
|
rollover?: AttachUpsertLicenseRollover | undefined;
|
|
2352
|
+
/**
|
|
2353
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
2354
|
+
*/
|
|
2355
|
+
expiry?: AttachUpsertLicenseExpiry | undefined;
|
|
2303
2356
|
/**
|
|
2304
2357
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
2305
2358
|
*/
|
|
@@ -3087,10 +3140,6 @@ type BalanceFeature = {
|
|
|
3087
3140
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
3088
3141
|
*/
|
|
3089
3142
|
creditSchema?: Array<BalanceCreditSchema1 | BalanceCreditSchema2 | BalanceCreditSchema3> | undefined;
|
|
3090
|
-
/**
|
|
3091
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
3092
|
-
*/
|
|
3093
|
-
invoiceCredit?: boolean | undefined;
|
|
3094
3143
|
/**
|
|
3095
3144
|
* Per-model markup overrides for AI credit systems.
|
|
3096
3145
|
*/
|
|
@@ -3690,6 +3739,20 @@ type BillingUpdateItemRollover = {
|
|
|
3690
3739
|
*/
|
|
3691
3740
|
expiryDurationLength?: number | undefined;
|
|
3692
3741
|
};
|
|
3742
|
+
declare const BillingUpdateItemDuration: {
|
|
3743
|
+
readonly Day: "day";
|
|
3744
|
+
readonly Week: "week";
|
|
3745
|
+
readonly Month: "month";
|
|
3746
|
+
readonly Year: "year";
|
|
3747
|
+
};
|
|
3748
|
+
type BillingUpdateItemDuration = ClosedEnum<typeof BillingUpdateItemDuration>;
|
|
3749
|
+
/**
|
|
3750
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
3751
|
+
*/
|
|
3752
|
+
type BillingUpdateItemExpiry = {
|
|
3753
|
+
duration: BillingUpdateItemDuration;
|
|
3754
|
+
length: number;
|
|
3755
|
+
};
|
|
3693
3756
|
type BillingUpdateDimensionsItem4 = {
|
|
3694
3757
|
/**
|
|
3695
3758
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -3956,6 +4019,10 @@ type BillingUpdateItemPlanItem = {
|
|
|
3956
4019
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
3957
4020
|
*/
|
|
3958
4021
|
rollover?: BillingUpdateItemRollover | undefined;
|
|
4022
|
+
/**
|
|
4023
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
4024
|
+
*/
|
|
4025
|
+
expiry?: BillingUpdateItemExpiry | undefined;
|
|
3959
4026
|
/**
|
|
3960
4027
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
3961
4028
|
*/
|
|
@@ -4169,6 +4236,20 @@ type BillingUpdateAddItemRollover = {
|
|
|
4169
4236
|
*/
|
|
4170
4237
|
expiryDurationLength?: number | undefined;
|
|
4171
4238
|
};
|
|
4239
|
+
declare const BillingUpdateAddItemDuration: {
|
|
4240
|
+
readonly Day: "day";
|
|
4241
|
+
readonly Week: "week";
|
|
4242
|
+
readonly Month: "month";
|
|
4243
|
+
readonly Year: "year";
|
|
4244
|
+
};
|
|
4245
|
+
type BillingUpdateAddItemDuration = ClosedEnum<typeof BillingUpdateAddItemDuration>;
|
|
4246
|
+
/**
|
|
4247
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
4248
|
+
*/
|
|
4249
|
+
type BillingUpdateAddItemExpiry = {
|
|
4250
|
+
duration: BillingUpdateAddItemDuration;
|
|
4251
|
+
length: number;
|
|
4252
|
+
};
|
|
4172
4253
|
type BillingUpdateDimensionsAddItem4 = {
|
|
4173
4254
|
/**
|
|
4174
4255
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -4435,6 +4516,10 @@ type BillingUpdateAddItemPlanItem = {
|
|
|
4435
4516
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
4436
4517
|
*/
|
|
4437
4518
|
rollover?: BillingUpdateAddItemRollover | undefined;
|
|
4519
|
+
/**
|
|
4520
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
4521
|
+
*/
|
|
4522
|
+
expiry?: BillingUpdateAddItemExpiry | undefined;
|
|
4438
4523
|
/**
|
|
4439
4524
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
4440
4525
|
*/
|
|
@@ -5045,6 +5130,21 @@ type BillingUpdateUpsertLicenseRollover = {
|
|
|
5045
5130
|
*/
|
|
5046
5131
|
expiryDurationLength?: number | undefined;
|
|
5047
5132
|
};
|
|
5133
|
+
|
|
5134
|
+
declare const BillingUpdateUpsertLicenseDuration: {
|
|
5135
|
+
readonly Day: "day";
|
|
5136
|
+
readonly Week: "week";
|
|
5137
|
+
readonly Month: "month";
|
|
5138
|
+
readonly Year: "year";
|
|
5139
|
+
};
|
|
5140
|
+
type BillingUpdateUpsertLicenseDuration = ClosedEnum<typeof BillingUpdateUpsertLicenseDuration>;
|
|
5141
|
+
/**
|
|
5142
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
5143
|
+
*/
|
|
5144
|
+
type BillingUpdateUpsertLicenseExpiry = {
|
|
5145
|
+
duration: BillingUpdateUpsertLicenseDuration;
|
|
5146
|
+
length: number;
|
|
5147
|
+
};
|
|
5048
5148
|
type BillingUpdateDimensionsUpsertLicense4 = {
|
|
5049
5149
|
/**
|
|
5050
5150
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -5061,12 +5161,10 @@ type BillingUpdateDimensionsUpsertLicense4 = {
|
|
|
5061
5161
|
*/
|
|
5062
5162
|
creditCost: number;
|
|
5063
5163
|
};
|
|
5064
|
-
type BillingUpdateDimensionsUpsertLicenseMatch3 = string | number | boolean;
|
|
5065
5164
|
declare const BillingUpdateDimensionsToUpsertLicenseEnum2: {
|
|
5066
5165
|
readonly Inf: "inf";
|
|
5067
5166
|
};
|
|
5068
5167
|
type BillingUpdateDimensionsToUpsertLicenseEnum2 = ClosedEnum<typeof BillingUpdateDimensionsToUpsertLicenseEnum2>;
|
|
5069
|
-
|
|
5070
5168
|
type BillingUpdateDimensionsUpsertLicenseTier2 = {
|
|
5071
5169
|
/**
|
|
5072
5170
|
* Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'.
|
|
@@ -5082,7 +5180,7 @@ type BillingUpdateDimensionsUpsertLicense3 = {
|
|
|
5082
5180
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
5083
5181
|
*/
|
|
5084
5182
|
match: {
|
|
5085
|
-
[k: string]:
|
|
5183
|
+
[k: string]: string | number | boolean;
|
|
5086
5184
|
};
|
|
5087
5185
|
/**
|
|
5088
5186
|
* Breaks ties between dimensions that match the same number of keys. Higher wins.
|
|
@@ -5313,6 +5411,10 @@ type BillingUpdateUpsertLicensePlanItem = {
|
|
|
5313
5411
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
5314
5412
|
*/
|
|
5315
5413
|
rollover?: BillingUpdateUpsertLicenseRollover | undefined;
|
|
5414
|
+
/**
|
|
5415
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
5416
|
+
*/
|
|
5417
|
+
expiry?: BillingUpdateUpsertLicenseExpiry | undefined;
|
|
5316
5418
|
/**
|
|
5317
5419
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
5318
5420
|
*/
|
|
@@ -5491,6 +5593,16 @@ type BillingUpdateAttachDiscount = {
|
|
|
5491
5593
|
*/
|
|
5492
5594
|
promotionCode?: string | undefined;
|
|
5493
5595
|
};
|
|
5596
|
+
type BillingUpdateCustomLineItem = {
|
|
5597
|
+
/**
|
|
5598
|
+
* Amount in dollars for this line item (e.g. 10.50). Can be negative for credits.
|
|
5599
|
+
*/
|
|
5600
|
+
amount: number;
|
|
5601
|
+
/**
|
|
5602
|
+
* Description for the line item.
|
|
5603
|
+
*/
|
|
5604
|
+
description: string;
|
|
5605
|
+
};
|
|
5494
5606
|
/**
|
|
5495
5607
|
* 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.
|
|
5496
5608
|
*/
|
|
@@ -5595,6 +5707,10 @@ type UpdateSubscriptionParams = {
|
|
|
5595
5707
|
* List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.
|
|
5596
5708
|
*/
|
|
5597
5709
|
discounts?: Array<BillingUpdateAttachDiscount> | undefined;
|
|
5710
|
+
/**
|
|
5711
|
+
* Custom line items that replace the auto-generated proration invoice, or bill a standalone invoice when nothing else changes. Only valid on an existing recurring subscription.
|
|
5712
|
+
*/
|
|
5713
|
+
customLineItems?: Array<BillingUpdateCustomLineItem> | undefined;
|
|
5598
5714
|
/**
|
|
5599
5715
|
* 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.
|
|
5600
5716
|
*/
|
|
@@ -6120,10 +6236,6 @@ type CheckFeature2 = {
|
|
|
6120
6236
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
6121
6237
|
*/
|
|
6122
6238
|
creditSchema?: Array<CheckCreditSchema4 | CheckCreditSchema5 | CheckCreditSchema6> | undefined;
|
|
6123
|
-
/**
|
|
6124
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
6125
|
-
*/
|
|
6126
|
-
invoiceCredit?: boolean | undefined;
|
|
6127
6239
|
/**
|
|
6128
6240
|
* Per-model markup overrides for AI credit systems.
|
|
6129
6241
|
*/
|
|
@@ -7141,10 +7253,6 @@ type CheckFeature1 = {
|
|
|
7141
7253
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
7142
7254
|
*/
|
|
7143
7255
|
creditSchema?: Array<CheckCreditSchema1 | CheckCreditSchema2 | CheckCreditSchema3> | undefined;
|
|
7144
|
-
/**
|
|
7145
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
7146
|
-
*/
|
|
7147
|
-
invoiceCredit?: boolean | undefined;
|
|
7148
7256
|
/**
|
|
7149
7257
|
* Per-model markup overrides for AI credit systems.
|
|
7150
7258
|
*/
|
|
@@ -8556,6 +8664,17 @@ type PlanItemRollover = {
|
|
|
8556
8664
|
*/
|
|
8557
8665
|
expiryDurationLength?: number | undefined;
|
|
8558
8666
|
};
|
|
8667
|
+
declare const ItemDuration: {
|
|
8668
|
+
readonly Day: "day";
|
|
8669
|
+
readonly Week: "week";
|
|
8670
|
+
readonly Month: "month";
|
|
8671
|
+
readonly Year: "year";
|
|
8672
|
+
};
|
|
8673
|
+
type ItemDuration = OpenEnum<typeof ItemDuration>;
|
|
8674
|
+
type ItemExpiry = {
|
|
8675
|
+
duration: ItemDuration;
|
|
8676
|
+
length: number;
|
|
8677
|
+
};
|
|
8559
8678
|
type PlanDimensionsItem4 = {
|
|
8560
8679
|
/**
|
|
8561
8680
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -8823,6 +8942,10 @@ type Item = {
|
|
|
8823
8942
|
* Rollover configuration for unused units. If set, unused included units roll over to the next period.
|
|
8824
8943
|
*/
|
|
8825
8944
|
rollover?: PlanItemRollover | undefined;
|
|
8945
|
+
/**
|
|
8946
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
8947
|
+
*/
|
|
8948
|
+
expiry?: ItemExpiry | null | undefined;
|
|
8826
8949
|
/**
|
|
8827
8950
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
8828
8951
|
*/
|
|
@@ -9467,6 +9590,20 @@ type PlanVariantDetailsRollover = {
|
|
|
9467
9590
|
*/
|
|
9468
9591
|
expiryDurationLength?: number | undefined;
|
|
9469
9592
|
};
|
|
9593
|
+
declare const VariantDetailsDuration: {
|
|
9594
|
+
readonly Day: "day";
|
|
9595
|
+
readonly Week: "week";
|
|
9596
|
+
readonly Month: "month";
|
|
9597
|
+
readonly Year: "year";
|
|
9598
|
+
};
|
|
9599
|
+
type VariantDetailsDuration = OpenEnum<typeof VariantDetailsDuration>;
|
|
9600
|
+
/**
|
|
9601
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
9602
|
+
*/
|
|
9603
|
+
type VariantDetailsExpiry = {
|
|
9604
|
+
duration: VariantDetailsDuration;
|
|
9605
|
+
length: number;
|
|
9606
|
+
};
|
|
9470
9607
|
type PlanDimensionsVariantDetails4 = {
|
|
9471
9608
|
/**
|
|
9472
9609
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -9733,6 +9870,10 @@ type PlanItem = {
|
|
|
9733
9870
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
9734
9871
|
*/
|
|
9735
9872
|
rollover?: PlanVariantDetailsRollover | undefined;
|
|
9873
|
+
/**
|
|
9874
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
9875
|
+
*/
|
|
9876
|
+
expiry?: VariantDetailsExpiry | undefined;
|
|
9736
9877
|
/**
|
|
9737
9878
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
9738
9879
|
*/
|
|
@@ -10089,6 +10230,7 @@ type PlanVariantDetailsBillingControls1 = {
|
|
|
10089
10230
|
*/
|
|
10090
10231
|
overageAllowed?: Array<PlanVariantDetailsOverageAllowed1> | undefined;
|
|
10091
10232
|
};
|
|
10233
|
+
|
|
10092
10234
|
/**
|
|
10093
10235
|
* Billing interval (e.g. 'month', 'year').
|
|
10094
10236
|
*/
|
|
@@ -10138,7 +10280,6 @@ type UpsertLicenseBasePrice = {
|
|
|
10138
10280
|
type UpsertLicenseThresholdBilling = {
|
|
10139
10281
|
threshold: number;
|
|
10140
10282
|
};
|
|
10141
|
-
|
|
10142
10283
|
/**
|
|
10143
10284
|
* Interval at which balance resets (e.g. 'month', 'year'). For consumable features only.
|
|
10144
10285
|
*/
|
|
@@ -10341,6 +10482,20 @@ type PlanUpsertLicenseRollover = {
|
|
|
10341
10482
|
*/
|
|
10342
10483
|
expiryDurationLength?: number | undefined;
|
|
10343
10484
|
};
|
|
10485
|
+
declare const UpsertLicenseDuration: {
|
|
10486
|
+
readonly Day: "day";
|
|
10487
|
+
readonly Week: "week";
|
|
10488
|
+
readonly Month: "month";
|
|
10489
|
+
readonly Year: "year";
|
|
10490
|
+
};
|
|
10491
|
+
type UpsertLicenseDuration = OpenEnum<typeof UpsertLicenseDuration>;
|
|
10492
|
+
/**
|
|
10493
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
10494
|
+
*/
|
|
10495
|
+
type UpsertLicenseExpiry = {
|
|
10496
|
+
duration: UpsertLicenseDuration;
|
|
10497
|
+
length: number;
|
|
10498
|
+
};
|
|
10344
10499
|
type PlanDimensionsUpsertLicense4 = {
|
|
10345
10500
|
/**
|
|
10346
10501
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -10607,6 +10762,10 @@ type UpsertLicensePlanItem = {
|
|
|
10607
10762
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
10608
10763
|
*/
|
|
10609
10764
|
rollover?: PlanUpsertLicenseRollover | undefined;
|
|
10765
|
+
/**
|
|
10766
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
10767
|
+
*/
|
|
10768
|
+
expiry?: UpsertLicenseExpiry | undefined;
|
|
10610
10769
|
/**
|
|
10611
10770
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
10612
10771
|
*/
|
|
@@ -11506,10 +11665,6 @@ type CreateEntityFeature = {
|
|
|
11506
11665
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
11507
11666
|
*/
|
|
11508
11667
|
creditSchema?: Array<CreateEntityCreditSchema1 | CreateEntityCreditSchema2 | CreateEntityCreditSchema3> | undefined;
|
|
11509
|
-
/**
|
|
11510
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
11511
|
-
*/
|
|
11512
|
-
invoiceCredit?: boolean | undefined;
|
|
11513
11668
|
/**
|
|
11514
11669
|
* Per-model markup overrides for AI credit systems.
|
|
11515
11670
|
*/
|
|
@@ -12135,10 +12290,6 @@ type CreateFeatureParams = {
|
|
|
12135
12290
|
* A schema that maps metered feature IDs to flat or graduated credit costs. For classic credit systems only — AI credit systems use model_markups instead.
|
|
12136
12291
|
*/
|
|
12137
12292
|
creditSchema?: Array<CreateFeatureCreditSchemaRequestBody1 | CreateFeatureCreditSchemaRequestBody2> | undefined;
|
|
12138
|
-
/**
|
|
12139
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
12140
|
-
*/
|
|
12141
|
-
invoiceCredit?: boolean | undefined;
|
|
12142
12293
|
/**
|
|
12143
12294
|
* Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration.
|
|
12144
12295
|
*/
|
|
@@ -12506,10 +12657,6 @@ type CreateFeatureResponse = {
|
|
|
12506
12657
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
12507
12658
|
*/
|
|
12508
12659
|
creditSchema?: Array<CreateFeatureCreditSchemaResponse1 | CreateFeatureCreditSchemaResponse2 | CreateFeatureCreditSchemaResponse3> | undefined;
|
|
12509
|
-
/**
|
|
12510
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
12511
|
-
*/
|
|
12512
|
-
invoiceCredit?: boolean | undefined;
|
|
12513
12660
|
/**
|
|
12514
12661
|
* Per-model markup overrides for AI credit systems.
|
|
12515
12662
|
*/
|
|
@@ -12794,6 +12941,20 @@ type CreatePlanItemRolloverRequestBody = {
|
|
|
12794
12941
|
*/
|
|
12795
12942
|
expiryDurationLength?: number | undefined;
|
|
12796
12943
|
};
|
|
12944
|
+
declare const CreatePlanItemDurationRequestBody: {
|
|
12945
|
+
readonly Day: "day";
|
|
12946
|
+
readonly Week: "week";
|
|
12947
|
+
readonly Month: "month";
|
|
12948
|
+
readonly Year: "year";
|
|
12949
|
+
};
|
|
12950
|
+
type CreatePlanItemDurationRequestBody = ClosedEnum<typeof CreatePlanItemDurationRequestBody>;
|
|
12951
|
+
/**
|
|
12952
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
12953
|
+
*/
|
|
12954
|
+
type CreatePlanItemExpiryRequestBody = {
|
|
12955
|
+
duration: CreatePlanItemDurationRequestBody;
|
|
12956
|
+
length: number;
|
|
12957
|
+
};
|
|
12797
12958
|
type CreatePlanDimensionsItemRequestBody4 = {
|
|
12798
12959
|
/**
|
|
12799
12960
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -13060,6 +13221,10 @@ type CreatePlanItemPlanItem = {
|
|
|
13060
13221
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
13061
13222
|
*/
|
|
13062
13223
|
rollover?: CreatePlanItemRolloverRequestBody | undefined;
|
|
13224
|
+
/**
|
|
13225
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
13226
|
+
*/
|
|
13227
|
+
expiry?: CreatePlanItemExpiryRequestBody | undefined;
|
|
13063
13228
|
/**
|
|
13064
13229
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
13065
13230
|
*/
|
|
@@ -13319,6 +13484,20 @@ type CreatePlanLicenseRollover = {
|
|
|
13319
13484
|
*/
|
|
13320
13485
|
expiryDurationLength?: number | undefined;
|
|
13321
13486
|
};
|
|
13487
|
+
declare const CreatePlanLicenseDuration: {
|
|
13488
|
+
readonly Day: "day";
|
|
13489
|
+
readonly Week: "week";
|
|
13490
|
+
readonly Month: "month";
|
|
13491
|
+
readonly Year: "year";
|
|
13492
|
+
};
|
|
13493
|
+
type CreatePlanLicenseDuration = ClosedEnum<typeof CreatePlanLicenseDuration>;
|
|
13494
|
+
/**
|
|
13495
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
13496
|
+
*/
|
|
13497
|
+
type CreatePlanLicenseExpiry = {
|
|
13498
|
+
duration: CreatePlanLicenseDuration;
|
|
13499
|
+
length: number;
|
|
13500
|
+
};
|
|
13322
13501
|
type CreatePlanDimensionsLicense4 = {
|
|
13323
13502
|
/**
|
|
13324
13503
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -13585,6 +13764,10 @@ type CreatePlanLicensePlanItem = {
|
|
|
13585
13764
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
13586
13765
|
*/
|
|
13587
13766
|
rollover?: CreatePlanLicenseRollover | undefined;
|
|
13767
|
+
/**
|
|
13768
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
13769
|
+
*/
|
|
13770
|
+
expiry?: CreatePlanLicenseExpiry | undefined;
|
|
13588
13771
|
/**
|
|
13589
13772
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
13590
13773
|
*/
|
|
@@ -14203,6 +14386,7 @@ type CreatePlanItemAdditionalCurrencyResponse = {
|
|
|
14203
14386
|
*/
|
|
14204
14387
|
amount: number;
|
|
14205
14388
|
};
|
|
14389
|
+
type CreatePlanPriceItemToResponse = number | string;
|
|
14206
14390
|
type CreatePlanItemTierAdditionalCurrencyResponse = {
|
|
14207
14391
|
/**
|
|
14208
14392
|
* Three-letter Stripe-supported currency code (e.g. 'eur', 'gbp').
|
|
@@ -14217,8 +14401,9 @@ type CreatePlanItemTierAdditionalCurrencyResponse = {
|
|
|
14217
14401
|
*/
|
|
14218
14402
|
flatAmount?: number | undefined;
|
|
14219
14403
|
};
|
|
14404
|
+
|
|
14220
14405
|
type CreatePlanPriceItemTierResponse = {
|
|
14221
|
-
to:
|
|
14406
|
+
to: CreatePlanPriceItemToResponse;
|
|
14222
14407
|
amount: number;
|
|
14223
14408
|
flatAmount?: number | undefined;
|
|
14224
14409
|
additionalCurrencies?: Array<CreatePlanItemTierAdditionalCurrencyResponse> | undefined;
|
|
@@ -14254,7 +14439,6 @@ declare const CreatePlanItemBillingMethodResponse: {
|
|
|
14254
14439
|
* 'prepaid' for features like seats where customers pay upfront, 'usage_based' for pay-as-you-go after included usage.
|
|
14255
14440
|
*/
|
|
14256
14441
|
type CreatePlanItemBillingMethodResponse = OpenEnum<typeof CreatePlanItemBillingMethodResponse>;
|
|
14257
|
-
|
|
14258
14442
|
type CreatePlanItemStripe = {
|
|
14259
14443
|
/**
|
|
14260
14444
|
* Stripe price ID. For prepaid with included > 0 this is the V2 price.
|
|
@@ -14351,6 +14535,17 @@ type CreatePlanItemRolloverResponse = {
|
|
|
14351
14535
|
*/
|
|
14352
14536
|
expiryDurationLength?: number | undefined;
|
|
14353
14537
|
};
|
|
14538
|
+
declare const CreatePlanItemDurationResponse: {
|
|
14539
|
+
readonly Day: "day";
|
|
14540
|
+
readonly Week: "week";
|
|
14541
|
+
readonly Month: "month";
|
|
14542
|
+
readonly Year: "year";
|
|
14543
|
+
};
|
|
14544
|
+
type CreatePlanItemDurationResponse = OpenEnum<typeof CreatePlanItemDurationResponse>;
|
|
14545
|
+
type CreatePlanItemExpiryResponse = {
|
|
14546
|
+
duration: CreatePlanItemDurationResponse;
|
|
14547
|
+
length: number;
|
|
14548
|
+
};
|
|
14354
14549
|
type CreatePlanDimensionsItemResponse4 = {
|
|
14355
14550
|
/**
|
|
14356
14551
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -14618,6 +14813,10 @@ type CreatePlanItem = {
|
|
|
14618
14813
|
* Rollover configuration for unused units. If set, unused included units roll over to the next period.
|
|
14619
14814
|
*/
|
|
14620
14815
|
rollover?: CreatePlanItemRolloverResponse | undefined;
|
|
14816
|
+
/**
|
|
14817
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
14818
|
+
*/
|
|
14819
|
+
expiry?: CreatePlanItemExpiryResponse | null | undefined;
|
|
14621
14820
|
/**
|
|
14622
14821
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
14623
14822
|
*/
|
|
@@ -15262,6 +15461,20 @@ type CreatePlanVariantDetailsRollover = {
|
|
|
15262
15461
|
*/
|
|
15263
15462
|
expiryDurationLength?: number | undefined;
|
|
15264
15463
|
};
|
|
15464
|
+
declare const CreatePlanVariantDetailsDuration: {
|
|
15465
|
+
readonly Day: "day";
|
|
15466
|
+
readonly Week: "week";
|
|
15467
|
+
readonly Month: "month";
|
|
15468
|
+
readonly Year: "year";
|
|
15469
|
+
};
|
|
15470
|
+
type CreatePlanVariantDetailsDuration = OpenEnum<typeof CreatePlanVariantDetailsDuration>;
|
|
15471
|
+
/**
|
|
15472
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
15473
|
+
*/
|
|
15474
|
+
type CreatePlanVariantDetailsExpiry = {
|
|
15475
|
+
duration: CreatePlanVariantDetailsDuration;
|
|
15476
|
+
length: number;
|
|
15477
|
+
};
|
|
15265
15478
|
type CreatePlanDimensionsVariantDetails4 = {
|
|
15266
15479
|
/**
|
|
15267
15480
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -15528,6 +15741,10 @@ type CreatePlanPlanItemResponse = {
|
|
|
15528
15741
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
15529
15742
|
*/
|
|
15530
15743
|
rollover?: CreatePlanVariantDetailsRollover | undefined;
|
|
15744
|
+
/**
|
|
15745
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
15746
|
+
*/
|
|
15747
|
+
expiry?: CreatePlanVariantDetailsExpiry | undefined;
|
|
15531
15748
|
/**
|
|
15532
15749
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
15533
15750
|
*/
|
|
@@ -16090,6 +16307,7 @@ declare const CreatePlanUpsertLicenseOnDecrease: {
|
|
|
16090
16307
|
* Credit behavior when quantity decreases mid-cycle.
|
|
16091
16308
|
*/
|
|
16092
16309
|
type CreatePlanUpsertLicenseOnDecrease = OpenEnum<typeof CreatePlanUpsertLicenseOnDecrease>;
|
|
16310
|
+
|
|
16093
16311
|
/**
|
|
16094
16312
|
* Proration settings for prepaid features. Controls mid-cycle quantity change billing.
|
|
16095
16313
|
*/
|
|
@@ -16135,6 +16353,20 @@ type CreatePlanUpsertLicenseRollover = {
|
|
|
16135
16353
|
*/
|
|
16136
16354
|
expiryDurationLength?: number | undefined;
|
|
16137
16355
|
};
|
|
16356
|
+
declare const CreatePlanUpsertLicenseDuration: {
|
|
16357
|
+
readonly Day: "day";
|
|
16358
|
+
readonly Week: "week";
|
|
16359
|
+
readonly Month: "month";
|
|
16360
|
+
readonly Year: "year";
|
|
16361
|
+
};
|
|
16362
|
+
type CreatePlanUpsertLicenseDuration = OpenEnum<typeof CreatePlanUpsertLicenseDuration>;
|
|
16363
|
+
/**
|
|
16364
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
16365
|
+
*/
|
|
16366
|
+
type CreatePlanUpsertLicenseExpiry = {
|
|
16367
|
+
duration: CreatePlanUpsertLicenseDuration;
|
|
16368
|
+
length: number;
|
|
16369
|
+
};
|
|
16138
16370
|
type CreatePlanDimensionsUpsertLicense4 = {
|
|
16139
16371
|
/**
|
|
16140
16372
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -16179,7 +16411,6 @@ type CreatePlanDimensionsUpsertLicense3 = {
|
|
|
16179
16411
|
tierBehavior: "graduated";
|
|
16180
16412
|
tiers: Array<CreatePlanDimensionsUpsertLicenseTier2>;
|
|
16181
16413
|
};
|
|
16182
|
-
|
|
16183
16414
|
type CreatePlanUpsertLicenseMultipliers2 = {
|
|
16184
16415
|
/**
|
|
16185
16416
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -16402,6 +16633,10 @@ type CreatePlanUpsertLicensePlanItem = {
|
|
|
16402
16633
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
16403
16634
|
*/
|
|
16404
16635
|
rollover?: CreatePlanUpsertLicenseRollover | undefined;
|
|
16636
|
+
/**
|
|
16637
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
16638
|
+
*/
|
|
16639
|
+
expiry?: CreatePlanUpsertLicenseExpiry | undefined;
|
|
16405
16640
|
/**
|
|
16406
16641
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
16407
16642
|
*/
|
|
@@ -16823,7 +17058,7 @@ declare const CreateRewardExpiryTypeRequestBody: {
|
|
|
16823
17058
|
* The unit of time the grant lasts.
|
|
16824
17059
|
*/
|
|
16825
17060
|
type CreateRewardExpiryTypeRequestBody = ClosedEnum<typeof CreateRewardExpiryTypeRequestBody>;
|
|
16826
|
-
type
|
|
17061
|
+
type CreateRewardExpiryRequestBody = {
|
|
16827
17062
|
/**
|
|
16828
17063
|
* The unit of time the grant lasts.
|
|
16829
17064
|
*/
|
|
@@ -16839,7 +17074,7 @@ type CreateRewardGrant = {
|
|
|
16839
17074
|
* A non-negative amount to grant, or null for boolean features.
|
|
16840
17075
|
*/
|
|
16841
17076
|
included: number | null;
|
|
16842
|
-
expiry:
|
|
17077
|
+
expiry: CreateRewardExpiryRequestBody | null;
|
|
16843
17078
|
};
|
|
16844
17079
|
type CreateRewardFeatureGrantPromoCode = {
|
|
16845
17080
|
code: string;
|
|
@@ -17484,6 +17719,20 @@ type UnscheduledPlanItemRollover = {
|
|
|
17484
17719
|
*/
|
|
17485
17720
|
expiryDurationLength?: number | undefined;
|
|
17486
17721
|
};
|
|
17722
|
+
declare const UnscheduledPlanItemDuration: {
|
|
17723
|
+
readonly Day: "day";
|
|
17724
|
+
readonly Week: "week";
|
|
17725
|
+
readonly Month: "month";
|
|
17726
|
+
readonly Year: "year";
|
|
17727
|
+
};
|
|
17728
|
+
type UnscheduledPlanItemDuration = ClosedEnum<typeof UnscheduledPlanItemDuration>;
|
|
17729
|
+
/**
|
|
17730
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
17731
|
+
*/
|
|
17732
|
+
type UnscheduledPlanItemExpiry = {
|
|
17733
|
+
duration: UnscheduledPlanItemDuration;
|
|
17734
|
+
length: number;
|
|
17735
|
+
};
|
|
17487
17736
|
type DimensionsUnscheduledPlanItem4 = {
|
|
17488
17737
|
/**
|
|
17489
17738
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -17750,6 +17999,10 @@ type UnscheduledPlanItemPlanItem = {
|
|
|
17750
17999
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
17751
18000
|
*/
|
|
17752
18001
|
rollover?: UnscheduledPlanItemRollover | undefined;
|
|
18002
|
+
/**
|
|
18003
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
18004
|
+
*/
|
|
18005
|
+
expiry?: UnscheduledPlanItemExpiry | undefined;
|
|
17753
18006
|
/**
|
|
17754
18007
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
17755
18008
|
*/
|
|
@@ -17963,6 +18216,20 @@ type UnscheduledPlanAddItemRollover = {
|
|
|
17963
18216
|
*/
|
|
17964
18217
|
expiryDurationLength?: number | undefined;
|
|
17965
18218
|
};
|
|
18219
|
+
declare const UnscheduledPlanAddItemDuration: {
|
|
18220
|
+
readonly Day: "day";
|
|
18221
|
+
readonly Week: "week";
|
|
18222
|
+
readonly Month: "month";
|
|
18223
|
+
readonly Year: "year";
|
|
18224
|
+
};
|
|
18225
|
+
type UnscheduledPlanAddItemDuration = ClosedEnum<typeof UnscheduledPlanAddItemDuration>;
|
|
18226
|
+
/**
|
|
18227
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
18228
|
+
*/
|
|
18229
|
+
type UnscheduledPlanAddItemExpiry = {
|
|
18230
|
+
duration: UnscheduledPlanAddItemDuration;
|
|
18231
|
+
length: number;
|
|
18232
|
+
};
|
|
17966
18233
|
type DimensionsUnscheduledPlanAddItem4 = {
|
|
17967
18234
|
/**
|
|
17968
18235
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -18229,6 +18496,10 @@ type UnscheduledPlanAddItemPlanItem = {
|
|
|
18229
18496
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
18230
18497
|
*/
|
|
18231
18498
|
rollover?: UnscheduledPlanAddItemRollover | undefined;
|
|
18499
|
+
/**
|
|
18500
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
18501
|
+
*/
|
|
18502
|
+
expiry?: UnscheduledPlanAddItemExpiry | undefined;
|
|
18232
18503
|
/**
|
|
18233
18504
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
18234
18505
|
*/
|
|
@@ -18774,6 +19045,7 @@ declare const UnscheduledPlanUpsertLicenseExpiryDurationType: {
|
|
|
18774
19045
|
* When rolled over units expire.
|
|
18775
19046
|
*/
|
|
18776
19047
|
type UnscheduledPlanUpsertLicenseExpiryDurationType = ClosedEnum<typeof UnscheduledPlanUpsertLicenseExpiryDurationType>;
|
|
19048
|
+
|
|
18777
19049
|
/**
|
|
18778
19050
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
18779
19051
|
*/
|
|
@@ -18795,6 +19067,20 @@ type UnscheduledPlanUpsertLicenseRollover = {
|
|
|
18795
19067
|
*/
|
|
18796
19068
|
expiryDurationLength?: number | undefined;
|
|
18797
19069
|
};
|
|
19070
|
+
declare const UnscheduledPlanUpsertLicenseDuration: {
|
|
19071
|
+
readonly Day: "day";
|
|
19072
|
+
readonly Week: "week";
|
|
19073
|
+
readonly Month: "month";
|
|
19074
|
+
readonly Year: "year";
|
|
19075
|
+
};
|
|
19076
|
+
type UnscheduledPlanUpsertLicenseDuration = ClosedEnum<typeof UnscheduledPlanUpsertLicenseDuration>;
|
|
19077
|
+
/**
|
|
19078
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
19079
|
+
*/
|
|
19080
|
+
type UnscheduledPlanUpsertLicenseExpiry = {
|
|
19081
|
+
duration: UnscheduledPlanUpsertLicenseDuration;
|
|
19082
|
+
length: number;
|
|
19083
|
+
};
|
|
18798
19084
|
type DimensionsUnscheduledPlanUpsertLicense4 = {
|
|
18799
19085
|
/**
|
|
18800
19086
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -18811,8 +19097,6 @@ type DimensionsUnscheduledPlanUpsertLicense4 = {
|
|
|
18811
19097
|
*/
|
|
18812
19098
|
creditCost: number;
|
|
18813
19099
|
};
|
|
18814
|
-
type DimensionsUnscheduledPlanUpsertLicenseMatch3 = string | number | boolean;
|
|
18815
|
-
|
|
18816
19100
|
declare const DimensionsToUnscheduledPlanUpsertLicenseEnum2: {
|
|
18817
19101
|
readonly Inf: "inf";
|
|
18818
19102
|
};
|
|
@@ -18832,7 +19116,7 @@ type DimensionsUnscheduledPlanUpsertLicense3 = {
|
|
|
18832
19116
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
18833
19117
|
*/
|
|
18834
19118
|
match: {
|
|
18835
|
-
[k: string]:
|
|
19119
|
+
[k: string]: string | number | boolean;
|
|
18836
19120
|
};
|
|
18837
19121
|
/**
|
|
18838
19122
|
* Breaks ties between dimensions that match the same number of keys. Higher wins.
|
|
@@ -19063,6 +19347,10 @@ type UnscheduledPlanUpsertLicensePlanItem = {
|
|
|
19063
19347
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
19064
19348
|
*/
|
|
19065
19349
|
rollover?: UnscheduledPlanUpsertLicenseRollover | undefined;
|
|
19350
|
+
/**
|
|
19351
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
19352
|
+
*/
|
|
19353
|
+
expiry?: UnscheduledPlanUpsertLicenseExpiry | undefined;
|
|
19066
19354
|
/**
|
|
19067
19355
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
19068
19356
|
*/
|
|
@@ -19501,6 +19789,20 @@ type PhaseStartItemRollover = {
|
|
|
19501
19789
|
*/
|
|
19502
19790
|
expiryDurationLength?: number | undefined;
|
|
19503
19791
|
};
|
|
19792
|
+
declare const PhaseStartItemDuration: {
|
|
19793
|
+
readonly Day: "day";
|
|
19794
|
+
readonly Week: "week";
|
|
19795
|
+
readonly Month: "month";
|
|
19796
|
+
readonly Year: "year";
|
|
19797
|
+
};
|
|
19798
|
+
type PhaseStartItemDuration = ClosedEnum<typeof PhaseStartItemDuration>;
|
|
19799
|
+
/**
|
|
19800
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
19801
|
+
*/
|
|
19802
|
+
type PhaseStartItemExpiry = {
|
|
19803
|
+
duration: PhaseStartItemDuration;
|
|
19804
|
+
length: number;
|
|
19805
|
+
};
|
|
19504
19806
|
type PhaseStartDimensionsItem4 = {
|
|
19505
19807
|
/**
|
|
19506
19808
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -19767,6 +20069,10 @@ type PhaseStartItemPlanItem = {
|
|
|
19767
20069
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
19768
20070
|
*/
|
|
19769
20071
|
rollover?: PhaseStartItemRollover | undefined;
|
|
20072
|
+
/**
|
|
20073
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
20074
|
+
*/
|
|
20075
|
+
expiry?: PhaseStartItemExpiry | undefined;
|
|
19770
20076
|
/**
|
|
19771
20077
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
19772
20078
|
*/
|
|
@@ -19980,6 +20286,20 @@ type PhaseStartAddItemRollover = {
|
|
|
19980
20286
|
*/
|
|
19981
20287
|
expiryDurationLength?: number | undefined;
|
|
19982
20288
|
};
|
|
20289
|
+
declare const PhaseStartAddItemDuration: {
|
|
20290
|
+
readonly Day: "day";
|
|
20291
|
+
readonly Week: "week";
|
|
20292
|
+
readonly Month: "month";
|
|
20293
|
+
readonly Year: "year";
|
|
20294
|
+
};
|
|
20295
|
+
type PhaseStartAddItemDuration = ClosedEnum<typeof PhaseStartAddItemDuration>;
|
|
20296
|
+
/**
|
|
20297
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
20298
|
+
*/
|
|
20299
|
+
type PhaseStartAddItemExpiry = {
|
|
20300
|
+
duration: PhaseStartAddItemDuration;
|
|
20301
|
+
length: number;
|
|
20302
|
+
};
|
|
19983
20303
|
type PhaseStartDimensionsAddItem4 = {
|
|
19984
20304
|
/**
|
|
19985
20305
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -20246,6 +20566,10 @@ type PhaseStartAddItemPlanItem = {
|
|
|
20246
20566
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
20247
20567
|
*/
|
|
20248
20568
|
rollover?: PhaseStartAddItemRollover | undefined;
|
|
20569
|
+
/**
|
|
20570
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
20571
|
+
*/
|
|
20572
|
+
expiry?: PhaseStartAddItemExpiry | undefined;
|
|
20249
20573
|
/**
|
|
20250
20574
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
20251
20575
|
*/
|
|
@@ -20262,6 +20586,7 @@ declare const PhaseStartRemoveItemBillingMethod: {
|
|
|
20262
20586
|
* Match items with this billing method (prepaid or usage_based).
|
|
20263
20587
|
*/
|
|
20264
20588
|
type PhaseStartRemoveItemBillingMethod = ClosedEnum<typeof PhaseStartRemoveItemBillingMethod>;
|
|
20589
|
+
|
|
20265
20590
|
declare const PhaseStartIntervalRemoveItemEnum2: {
|
|
20266
20591
|
readonly OneOff: "one_off";
|
|
20267
20592
|
readonly Minute: "minute";
|
|
@@ -20414,7 +20739,6 @@ declare const PhaseStartUsageLimitInterval: {
|
|
|
20414
20739
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
20415
20740
|
*/
|
|
20416
20741
|
type PhaseStartUsageLimitInterval = ClosedEnum<typeof PhaseStartUsageLimitInterval>;
|
|
20417
|
-
|
|
20418
20742
|
/**
|
|
20419
20743
|
* Window alignment. 'billing_cycle' phases the interval to the customer's renewal time; 'utc' aligns to the UTC calendar.
|
|
20420
20744
|
*/
|
|
@@ -20813,6 +21137,20 @@ type PhaseStartUpsertLicenseRollover = {
|
|
|
20813
21137
|
*/
|
|
20814
21138
|
expiryDurationLength?: number | undefined;
|
|
20815
21139
|
};
|
|
21140
|
+
declare const PhaseStartUpsertLicenseDuration: {
|
|
21141
|
+
readonly Day: "day";
|
|
21142
|
+
readonly Week: "week";
|
|
21143
|
+
readonly Month: "month";
|
|
21144
|
+
readonly Year: "year";
|
|
21145
|
+
};
|
|
21146
|
+
type PhaseStartUpsertLicenseDuration = ClosedEnum<typeof PhaseStartUpsertLicenseDuration>;
|
|
21147
|
+
/**
|
|
21148
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
21149
|
+
*/
|
|
21150
|
+
type PhaseStartUpsertLicenseExpiry = {
|
|
21151
|
+
duration: PhaseStartUpsertLicenseDuration;
|
|
21152
|
+
length: number;
|
|
21153
|
+
};
|
|
20816
21154
|
type PhaseStartDimensionsUpsertLicense4 = {
|
|
20817
21155
|
/**
|
|
20818
21156
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -21071,6 +21409,10 @@ type PhaseStartUpsertLicensePlanItem = {
|
|
|
21071
21409
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
21072
21410
|
*/
|
|
21073
21411
|
rollover?: PhaseStartUpsertLicenseRollover | undefined;
|
|
21412
|
+
/**
|
|
21413
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
21414
|
+
*/
|
|
21415
|
+
expiry?: PhaseStartUpsertLicenseExpiry | undefined;
|
|
21074
21416
|
/**
|
|
21075
21417
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
21076
21418
|
*/
|
|
@@ -22266,10 +22608,6 @@ type CustomerFeature = {
|
|
|
22266
22608
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
22267
22609
|
*/
|
|
22268
22610
|
creditSchema?: Array<CustomerCreditSchema1 | CustomerCreditSchema2 | CustomerCreditSchema3> | undefined;
|
|
22269
|
-
/**
|
|
22270
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
22271
|
-
*/
|
|
22272
|
-
invoiceCredit?: boolean | undefined;
|
|
22273
22611
|
/**
|
|
22274
22612
|
* Per-model markup overrides for AI credit systems.
|
|
22275
22613
|
*/
|
|
@@ -23810,10 +24148,6 @@ type GetCustomerFeature = {
|
|
|
23810
24148
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
23811
24149
|
*/
|
|
23812
24150
|
creditSchema?: Array<GetCustomerCreditSchema1 | GetCustomerCreditSchema2 | GetCustomerCreditSchema3> | undefined;
|
|
23813
|
-
/**
|
|
23814
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
23815
|
-
*/
|
|
23816
|
-
invoiceCredit?: boolean | undefined;
|
|
23817
24151
|
/**
|
|
23818
24152
|
* Per-model markup overrides for AI credit systems.
|
|
23819
24153
|
*/
|
|
@@ -24774,10 +25108,6 @@ type GetEntityFeature = {
|
|
|
24774
25108
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
24775
25109
|
*/
|
|
24776
25110
|
creditSchema?: Array<GetEntityCreditSchema1 | GetEntityCreditSchema2 | GetEntityCreditSchema3> | undefined;
|
|
24777
|
-
/**
|
|
24778
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
24779
|
-
*/
|
|
24780
|
-
invoiceCredit?: boolean | undefined;
|
|
24781
25111
|
/**
|
|
24782
25112
|
* Per-model markup overrides for AI credit systems.
|
|
24783
25113
|
*/
|
|
@@ -25521,10 +25851,6 @@ type GetFeatureResponse = {
|
|
|
25521
25851
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
25522
25852
|
*/
|
|
25523
25853
|
creditSchema?: Array<GetFeatureCreditSchema1 | GetFeatureCreditSchema2 | GetFeatureCreditSchema3> | undefined;
|
|
25524
|
-
/**
|
|
25525
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
25526
|
-
*/
|
|
25527
|
-
invoiceCredit?: boolean | undefined;
|
|
25528
25854
|
/**
|
|
25529
25855
|
* Per-model markup overrides for AI credit systems.
|
|
25530
25856
|
*/
|
|
@@ -25893,6 +26219,17 @@ type GetPlanItemRollover = {
|
|
|
25893
26219
|
*/
|
|
25894
26220
|
expiryDurationLength?: number | undefined;
|
|
25895
26221
|
};
|
|
26222
|
+
declare const GetPlanItemDuration: {
|
|
26223
|
+
readonly Day: "day";
|
|
26224
|
+
readonly Week: "week";
|
|
26225
|
+
readonly Month: "month";
|
|
26226
|
+
readonly Year: "year";
|
|
26227
|
+
};
|
|
26228
|
+
type GetPlanItemDuration = OpenEnum<typeof GetPlanItemDuration>;
|
|
26229
|
+
type GetPlanItemExpiry = {
|
|
26230
|
+
duration: GetPlanItemDuration;
|
|
26231
|
+
length: number;
|
|
26232
|
+
};
|
|
25896
26233
|
type GetPlanDimensionsItem4 = {
|
|
25897
26234
|
/**
|
|
25898
26235
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -26160,6 +26497,10 @@ type GetPlanItem = {
|
|
|
26160
26497
|
* Rollover configuration for unused units. If set, unused included units roll over to the next period.
|
|
26161
26498
|
*/
|
|
26162
26499
|
rollover?: GetPlanItemRollover | undefined;
|
|
26500
|
+
/**
|
|
26501
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
26502
|
+
*/
|
|
26503
|
+
expiry?: GetPlanItemExpiry | null | undefined;
|
|
26163
26504
|
/**
|
|
26164
26505
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
26165
26506
|
*/
|
|
@@ -26804,6 +27145,20 @@ type GetPlanVariantDetailsRollover = {
|
|
|
26804
27145
|
*/
|
|
26805
27146
|
expiryDurationLength?: number | undefined;
|
|
26806
27147
|
};
|
|
27148
|
+
declare const GetPlanVariantDetailsDuration: {
|
|
27149
|
+
readonly Day: "day";
|
|
27150
|
+
readonly Week: "week";
|
|
27151
|
+
readonly Month: "month";
|
|
27152
|
+
readonly Year: "year";
|
|
27153
|
+
};
|
|
27154
|
+
type GetPlanVariantDetailsDuration = OpenEnum<typeof GetPlanVariantDetailsDuration>;
|
|
27155
|
+
/**
|
|
27156
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
27157
|
+
*/
|
|
27158
|
+
type GetPlanVariantDetailsExpiry = {
|
|
27159
|
+
duration: GetPlanVariantDetailsDuration;
|
|
27160
|
+
length: number;
|
|
27161
|
+
};
|
|
26807
27162
|
type GetPlanDimensionsVariantDetails4 = {
|
|
26808
27163
|
/**
|
|
26809
27164
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -27070,6 +27425,10 @@ type GetPlanPlanItem = {
|
|
|
27070
27425
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
27071
27426
|
*/
|
|
27072
27427
|
rollover?: GetPlanVariantDetailsRollover | undefined;
|
|
27428
|
+
/**
|
|
27429
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
27430
|
+
*/
|
|
27431
|
+
expiry?: GetPlanVariantDetailsExpiry | undefined;
|
|
27073
27432
|
/**
|
|
27074
27433
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
27075
27434
|
*/
|
|
@@ -27391,6 +27750,7 @@ type GetPlanVariantDetailsUsageAlert = {
|
|
|
27391
27750
|
*/
|
|
27392
27751
|
name?: string | undefined;
|
|
27393
27752
|
};
|
|
27753
|
+
|
|
27394
27754
|
type GetPlanVariantDetailsOverageAllowed = {
|
|
27395
27755
|
/**
|
|
27396
27756
|
* The feature ID this overage allowed control applies to.
|
|
@@ -27451,7 +27811,6 @@ type GetPlanUpsertLicenseAdditionalCurrency = {
|
|
|
27451
27811
|
*/
|
|
27452
27812
|
amount: number;
|
|
27453
27813
|
};
|
|
27454
|
-
|
|
27455
27814
|
/**
|
|
27456
27815
|
* Base price configuration for a plan.
|
|
27457
27816
|
*/
|
|
@@ -27678,6 +28037,20 @@ type GetPlanUpsertLicenseRollover = {
|
|
|
27678
28037
|
*/
|
|
27679
28038
|
expiryDurationLength?: number | undefined;
|
|
27680
28039
|
};
|
|
28040
|
+
declare const GetPlanUpsertLicenseDuration: {
|
|
28041
|
+
readonly Day: "day";
|
|
28042
|
+
readonly Week: "week";
|
|
28043
|
+
readonly Month: "month";
|
|
28044
|
+
readonly Year: "year";
|
|
28045
|
+
};
|
|
28046
|
+
type GetPlanUpsertLicenseDuration = OpenEnum<typeof GetPlanUpsertLicenseDuration>;
|
|
28047
|
+
/**
|
|
28048
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
28049
|
+
*/
|
|
28050
|
+
type GetPlanUpsertLicenseExpiry = {
|
|
28051
|
+
duration: GetPlanUpsertLicenseDuration;
|
|
28052
|
+
length: number;
|
|
28053
|
+
};
|
|
27681
28054
|
type GetPlanDimensionsUpsertLicense4 = {
|
|
27682
28055
|
/**
|
|
27683
28056
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -27944,6 +28317,10 @@ type GetPlanUpsertLicensePlanItem = {
|
|
|
27944
28317
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
27945
28318
|
*/
|
|
27946
28319
|
rollover?: GetPlanUpsertLicenseRollover | undefined;
|
|
28320
|
+
/**
|
|
28321
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
28322
|
+
*/
|
|
28323
|
+
expiry?: GetPlanUpsertLicenseExpiry | undefined;
|
|
27947
28324
|
/**
|
|
27948
28325
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
27949
28326
|
*/
|
|
@@ -29865,10 +30242,6 @@ type ListCustomersFeature = {
|
|
|
29865
30242
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
29866
30243
|
*/
|
|
29867
30244
|
creditSchema?: Array<ListCustomersCreditSchema1 | ListCustomersCreditSchema2 | ListCustomersCreditSchema3> | undefined;
|
|
29868
|
-
/**
|
|
29869
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
29870
|
-
*/
|
|
29871
|
-
invoiceCredit?: boolean | undefined;
|
|
29872
30245
|
/**
|
|
29873
30246
|
* Per-model markup overrides for AI credit systems.
|
|
29874
30247
|
*/
|
|
@@ -30593,10 +30966,6 @@ type ListEntitiesFeature = {
|
|
|
30593
30966
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
30594
30967
|
*/
|
|
30595
30968
|
creditSchema?: Array<ListEntitiesCreditSchema1 | ListEntitiesCreditSchema2 | ListEntitiesCreditSchema3> | undefined;
|
|
30596
|
-
/**
|
|
30597
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
30598
|
-
*/
|
|
30599
|
-
invoiceCredit?: boolean | undefined;
|
|
30600
30969
|
/**
|
|
30601
30970
|
* Per-model markup overrides for AI credit systems.
|
|
30602
30971
|
*/
|
|
@@ -31475,10 +31844,6 @@ type ListFeaturesList = {
|
|
|
31475
31844
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
31476
31845
|
*/
|
|
31477
31846
|
creditSchema?: Array<ListFeaturesCreditSchema1 | ListFeaturesCreditSchema2 | ListFeaturesCreditSchema3> | undefined;
|
|
31478
|
-
/**
|
|
31479
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
31480
|
-
*/
|
|
31481
|
-
invoiceCredit?: boolean | undefined;
|
|
31482
31847
|
/**
|
|
31483
31848
|
* Per-model markup overrides for AI credit systems.
|
|
31484
31849
|
*/
|
|
@@ -32035,6 +32400,17 @@ type ListPlansItemRollover = {
|
|
|
32035
32400
|
*/
|
|
32036
32401
|
expiryDurationLength?: number | undefined;
|
|
32037
32402
|
};
|
|
32403
|
+
declare const ListPlansItemDuration: {
|
|
32404
|
+
readonly Day: "day";
|
|
32405
|
+
readonly Week: "week";
|
|
32406
|
+
readonly Month: "month";
|
|
32407
|
+
readonly Year: "year";
|
|
32408
|
+
};
|
|
32409
|
+
type ListPlansItemDuration = OpenEnum<typeof ListPlansItemDuration>;
|
|
32410
|
+
type ListPlansItemExpiry = {
|
|
32411
|
+
duration: ListPlansItemDuration;
|
|
32412
|
+
length: number;
|
|
32413
|
+
};
|
|
32038
32414
|
type ListPlansDimensionsItem4 = {
|
|
32039
32415
|
/**
|
|
32040
32416
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -32302,6 +32678,10 @@ type ListPlansItem = {
|
|
|
32302
32678
|
* Rollover configuration for unused units. If set, unused included units roll over to the next period.
|
|
32303
32679
|
*/
|
|
32304
32680
|
rollover?: ListPlansItemRollover | undefined;
|
|
32681
|
+
/**
|
|
32682
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
32683
|
+
*/
|
|
32684
|
+
expiry?: ListPlansItemExpiry | null | undefined;
|
|
32305
32685
|
/**
|
|
32306
32686
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
32307
32687
|
*/
|
|
@@ -32946,6 +33326,20 @@ type ListPlansVariantDetailsRollover = {
|
|
|
32946
33326
|
*/
|
|
32947
33327
|
expiryDurationLength?: number | undefined;
|
|
32948
33328
|
};
|
|
33329
|
+
declare const ListPlansVariantDetailsDuration: {
|
|
33330
|
+
readonly Day: "day";
|
|
33331
|
+
readonly Week: "week";
|
|
33332
|
+
readonly Month: "month";
|
|
33333
|
+
readonly Year: "year";
|
|
33334
|
+
};
|
|
33335
|
+
type ListPlansVariantDetailsDuration = OpenEnum<typeof ListPlansVariantDetailsDuration>;
|
|
33336
|
+
/**
|
|
33337
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
33338
|
+
*/
|
|
33339
|
+
type ListPlansVariantDetailsExpiry = {
|
|
33340
|
+
duration: ListPlansVariantDetailsDuration;
|
|
33341
|
+
length: number;
|
|
33342
|
+
};
|
|
32949
33343
|
type ListPlansDimensionsVariantDetails4 = {
|
|
32950
33344
|
/**
|
|
32951
33345
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -33212,6 +33606,10 @@ type ListPlansVariantDetailsPlanItem = {
|
|
|
33212
33606
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
33213
33607
|
*/
|
|
33214
33608
|
rollover?: ListPlansVariantDetailsRollover | undefined;
|
|
33609
|
+
/**
|
|
33610
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
33611
|
+
*/
|
|
33612
|
+
expiry?: ListPlansVariantDetailsExpiry | undefined;
|
|
33215
33613
|
/**
|
|
33216
33614
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
33217
33615
|
*/
|
|
@@ -33533,6 +33931,7 @@ type ListPlansVariantDetailsUsageAlert = {
|
|
|
33533
33931
|
*/
|
|
33534
33932
|
name?: string | undefined;
|
|
33535
33933
|
};
|
|
33934
|
+
|
|
33536
33935
|
type ListPlansVariantDetailsOverageAllowed = {
|
|
33537
33936
|
/**
|
|
33538
33937
|
* The feature ID this overage allowed control applies to.
|
|
@@ -33593,7 +33992,6 @@ type ListPlansVariantDetailsUpsertLicenseAdditionalCurrency = {
|
|
|
33593
33992
|
*/
|
|
33594
33993
|
amount: number;
|
|
33595
33994
|
};
|
|
33596
|
-
|
|
33597
33995
|
/**
|
|
33598
33996
|
* Base price configuration for a plan.
|
|
33599
33997
|
*/
|
|
@@ -33820,6 +34218,20 @@ type ListPlansVariantDetailsUpsertLicenseRollover = {
|
|
|
33820
34218
|
*/
|
|
33821
34219
|
expiryDurationLength?: number | undefined;
|
|
33822
34220
|
};
|
|
34221
|
+
declare const ListPlansVariantDetailsUpsertLicenseDuration: {
|
|
34222
|
+
readonly Day: "day";
|
|
34223
|
+
readonly Week: "week";
|
|
34224
|
+
readonly Month: "month";
|
|
34225
|
+
readonly Year: "year";
|
|
34226
|
+
};
|
|
34227
|
+
type ListPlansVariantDetailsUpsertLicenseDuration = OpenEnum<typeof ListPlansVariantDetailsUpsertLicenseDuration>;
|
|
34228
|
+
/**
|
|
34229
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
34230
|
+
*/
|
|
34231
|
+
type ListPlansVariantDetailsUpsertLicenseExpiry = {
|
|
34232
|
+
duration: ListPlansVariantDetailsUpsertLicenseDuration;
|
|
34233
|
+
length: number;
|
|
34234
|
+
};
|
|
33823
34235
|
type ListPlansDimensionsVariantDetailsUpsertLicense4 = {
|
|
33824
34236
|
/**
|
|
33825
34237
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -34086,6 +34498,10 @@ type ListPlansVariantDetailsUpsertLicensePlanItem = {
|
|
|
34086
34498
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
34087
34499
|
*/
|
|
34088
34500
|
rollover?: ListPlansVariantDetailsUpsertLicenseRollover | undefined;
|
|
34501
|
+
/**
|
|
34502
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
34503
|
+
*/
|
|
34504
|
+
expiry?: ListPlansVariantDetailsUpsertLicenseExpiry | undefined;
|
|
34089
34505
|
/**
|
|
34090
34506
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
34091
34507
|
*/
|
|
@@ -34463,6 +34879,20 @@ type ListPlansLicenseRollover = {
|
|
|
34463
34879
|
*/
|
|
34464
34880
|
expiryDurationLength?: number | undefined;
|
|
34465
34881
|
};
|
|
34882
|
+
declare const ListPlansLicenseDuration: {
|
|
34883
|
+
readonly Day: "day";
|
|
34884
|
+
readonly Week: "week";
|
|
34885
|
+
readonly Month: "month";
|
|
34886
|
+
readonly Year: "year";
|
|
34887
|
+
};
|
|
34888
|
+
type ListPlansLicenseDuration = OpenEnum<typeof ListPlansLicenseDuration>;
|
|
34889
|
+
/**
|
|
34890
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
34891
|
+
*/
|
|
34892
|
+
type ListPlansLicenseExpiry = {
|
|
34893
|
+
duration: ListPlansLicenseDuration;
|
|
34894
|
+
length: number;
|
|
34895
|
+
};
|
|
34466
34896
|
type ListPlansDimensionsLicense4 = {
|
|
34467
34897
|
/**
|
|
34468
34898
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -34729,6 +35159,10 @@ type ListPlansLicensePlanItem = {
|
|
|
34729
35159
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
34730
35160
|
*/
|
|
34731
35161
|
rollover?: ListPlansLicenseRollover | undefined;
|
|
35162
|
+
/**
|
|
35163
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
35164
|
+
*/
|
|
35165
|
+
expiry?: ListPlansLicenseExpiry | undefined;
|
|
34732
35166
|
/**
|
|
34733
35167
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
34734
35168
|
*/
|
|
@@ -35083,6 +35517,20 @@ type ListPlansVariantAddItemRollover = {
|
|
|
35083
35517
|
*/
|
|
35084
35518
|
expiryDurationLength?: number | undefined;
|
|
35085
35519
|
};
|
|
35520
|
+
declare const ListPlansVariantAddItemDuration: {
|
|
35521
|
+
readonly Day: "day";
|
|
35522
|
+
readonly Week: "week";
|
|
35523
|
+
readonly Month: "month";
|
|
35524
|
+
readonly Year: "year";
|
|
35525
|
+
};
|
|
35526
|
+
type ListPlansVariantAddItemDuration = OpenEnum<typeof ListPlansVariantAddItemDuration>;
|
|
35527
|
+
/**
|
|
35528
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
35529
|
+
*/
|
|
35530
|
+
type ListPlansVariantAddItemExpiry = {
|
|
35531
|
+
duration: ListPlansVariantAddItemDuration;
|
|
35532
|
+
length: number;
|
|
35533
|
+
};
|
|
35086
35534
|
type ListPlansDimensionsVariantAddItem4 = {
|
|
35087
35535
|
/**
|
|
35088
35536
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -35213,6 +35661,7 @@ type ListPlansDimensionsVariantAddItem1 = {
|
|
|
35213
35661
|
tierBehavior: "graduated";
|
|
35214
35662
|
tiers: Array<ListPlansDimensionsVariantAddItemTier1>;
|
|
35215
35663
|
};
|
|
35664
|
+
type ListPlansVariantAddItemDimensionsUnion1 = ListPlansDimensionsVariantAddItem1 | ListPlansDimensionsVariantAddItem2;
|
|
35216
35665
|
type ListPlansVariantAddItemMultipliers1 = {
|
|
35217
35666
|
/**
|
|
35218
35667
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -35243,6 +35692,7 @@ type ListPlansVariantAddItemFeatureOverrideTier = {
|
|
|
35243
35692
|
*/
|
|
35244
35693
|
creditCost: number;
|
|
35245
35694
|
};
|
|
35695
|
+
|
|
35246
35696
|
type ListPlansCreditSchemaVariantAddItem1 = {
|
|
35247
35697
|
/**
|
|
35248
35698
|
* ID of the metered feature that draws from this credit system.
|
|
@@ -35256,7 +35706,7 @@ type ListPlansCreditSchemaVariantAddItem1 = {
|
|
|
35256
35706
|
* Named rates chosen by event properties. The most specific match sets the rate; with no match the item's own rate applies.
|
|
35257
35707
|
*/
|
|
35258
35708
|
dimensions?: {
|
|
35259
|
-
[k: string]:
|
|
35709
|
+
[k: string]: ListPlansVariantAddItemDimensionsUnion1;
|
|
35260
35710
|
} | undefined;
|
|
35261
35711
|
/**
|
|
35262
35712
|
* Named adjustments chosen by event properties. Every match applies: factors multiply, then adds are summed.
|
|
@@ -35349,6 +35799,10 @@ type ListPlansVariantPlanItem = {
|
|
|
35349
35799
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
35350
35800
|
*/
|
|
35351
35801
|
rollover?: ListPlansVariantAddItemRollover | undefined;
|
|
35802
|
+
/**
|
|
35803
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
35804
|
+
*/
|
|
35805
|
+
expiry?: ListPlansVariantAddItemExpiry | undefined;
|
|
35352
35806
|
/**
|
|
35353
35807
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
35354
35808
|
*/
|
|
@@ -35386,7 +35840,6 @@ declare const ListPlansIntervalVariantRemoveItemEnum1: {
|
|
|
35386
35840
|
readonly Year: "year";
|
|
35387
35841
|
};
|
|
35388
35842
|
type ListPlansIntervalVariantRemoveItemEnum1 = OpenEnum<typeof ListPlansIntervalVariantRemoveItemEnum1>;
|
|
35389
|
-
|
|
35390
35843
|
/**
|
|
35391
35844
|
* Filter for matching plan items. All provided fields must match (AND).
|
|
35392
35845
|
*/
|
|
@@ -35957,6 +36410,20 @@ type ListPlansVariantUpsertLicenseRollover = {
|
|
|
35957
36410
|
*/
|
|
35958
36411
|
expiryDurationLength?: number | undefined;
|
|
35959
36412
|
};
|
|
36413
|
+
declare const ListPlansVariantUpsertLicenseDuration: {
|
|
36414
|
+
readonly Day: "day";
|
|
36415
|
+
readonly Week: "week";
|
|
36416
|
+
readonly Month: "month";
|
|
36417
|
+
readonly Year: "year";
|
|
36418
|
+
};
|
|
36419
|
+
type ListPlansVariantUpsertLicenseDuration = OpenEnum<typeof ListPlansVariantUpsertLicenseDuration>;
|
|
36420
|
+
/**
|
|
36421
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
36422
|
+
*/
|
|
36423
|
+
type ListPlansVariantUpsertLicenseExpiry = {
|
|
36424
|
+
duration: ListPlansVariantUpsertLicenseDuration;
|
|
36425
|
+
length: number;
|
|
36426
|
+
};
|
|
35960
36427
|
type ListPlansDimensionsVariantUpsertLicense4 = {
|
|
35961
36428
|
/**
|
|
35962
36429
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -36215,6 +36682,10 @@ type ListPlansVariantUpsertLicensePlanItem = {
|
|
|
36215
36682
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
36216
36683
|
*/
|
|
36217
36684
|
rollover?: ListPlansVariantUpsertLicenseRollover | undefined;
|
|
36685
|
+
/**
|
|
36686
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
36687
|
+
*/
|
|
36688
|
+
expiry?: ListPlansVariantUpsertLicenseExpiry | undefined;
|
|
36218
36689
|
/**
|
|
36219
36690
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
36220
36691
|
*/
|
|
@@ -36656,6 +37127,17 @@ type VariantPlanRollover = {
|
|
|
36656
37127
|
*/
|
|
36657
37128
|
expiryDurationLength?: number | undefined;
|
|
36658
37129
|
};
|
|
37130
|
+
declare const VariantPlanDuration: {
|
|
37131
|
+
readonly Day: "day";
|
|
37132
|
+
readonly Week: "week";
|
|
37133
|
+
readonly Month: "month";
|
|
37134
|
+
readonly Year: "year";
|
|
37135
|
+
};
|
|
37136
|
+
type VariantPlanDuration = OpenEnum<typeof VariantPlanDuration>;
|
|
37137
|
+
type VariantPlanExpiry = {
|
|
37138
|
+
duration: VariantPlanDuration;
|
|
37139
|
+
length: number;
|
|
37140
|
+
};
|
|
36659
37141
|
type DimensionsVariantPlan4 = {
|
|
36660
37142
|
/**
|
|
36661
37143
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -36923,6 +37405,10 @@ type VariantItem = {
|
|
|
36923
37405
|
* Rollover configuration for unused units. If set, unused included units roll over to the next period.
|
|
36924
37406
|
*/
|
|
36925
37407
|
rollover?: VariantPlanRollover | undefined;
|
|
37408
|
+
/**
|
|
37409
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
37410
|
+
*/
|
|
37411
|
+
expiry?: VariantPlanExpiry | null | undefined;
|
|
36926
37412
|
/**
|
|
36927
37413
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
36928
37414
|
*/
|
|
@@ -37125,6 +37611,7 @@ declare const VariantPlanUsageLimitInterval: {
|
|
|
37125
37611
|
* Interval for the cap, aligned to the customer's billing cycle.
|
|
37126
37612
|
*/
|
|
37127
37613
|
type VariantPlanUsageLimitInterval = OpenEnum<typeof VariantPlanUsageLimitInterval>;
|
|
37614
|
+
|
|
37128
37615
|
/**
|
|
37129
37616
|
* Window alignment. 'billing_cycle' phases the interval to the customer's renewal time; 'utc' aligns to the UTC calendar.
|
|
37130
37617
|
*/
|
|
@@ -37422,7 +37909,6 @@ type ListPlansVariant = {
|
|
|
37422
37909
|
*/
|
|
37423
37910
|
plan?: ListPlansPlan | undefined;
|
|
37424
37911
|
};
|
|
37425
|
-
|
|
37426
37912
|
/**
|
|
37427
37913
|
* A plan defines features, pricing, entitlements, assignable licenses, and derived variants.
|
|
37428
37914
|
*/
|
|
@@ -38104,6 +38590,20 @@ type MultiAttachRollover = {
|
|
|
38104
38590
|
*/
|
|
38105
38591
|
expiryDurationLength?: number | undefined;
|
|
38106
38592
|
};
|
|
38593
|
+
declare const MultiAttachDuration: {
|
|
38594
|
+
readonly Day: "day";
|
|
38595
|
+
readonly Week: "week";
|
|
38596
|
+
readonly Month: "month";
|
|
38597
|
+
readonly Year: "year";
|
|
38598
|
+
};
|
|
38599
|
+
type MultiAttachDuration = ClosedEnum<typeof MultiAttachDuration>;
|
|
38600
|
+
/**
|
|
38601
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
38602
|
+
*/
|
|
38603
|
+
type MultiAttachExpiry = {
|
|
38604
|
+
duration: MultiAttachDuration;
|
|
38605
|
+
length: number;
|
|
38606
|
+
};
|
|
38107
38607
|
type MultiAttachDimensions4 = {
|
|
38108
38608
|
/**
|
|
38109
38609
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -38370,6 +38870,10 @@ type MultiAttachPlanItem = {
|
|
|
38370
38870
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
38371
38871
|
*/
|
|
38372
38872
|
rollover?: MultiAttachRollover | undefined;
|
|
38873
|
+
/**
|
|
38874
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
38875
|
+
*/
|
|
38876
|
+
expiry?: MultiAttachExpiry | undefined;
|
|
38373
38877
|
/**
|
|
38374
38878
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
38375
38879
|
*/
|
|
@@ -39067,140 +39571,6 @@ type OpenCustomerPortalResponse = {
|
|
|
39067
39571
|
url: string;
|
|
39068
39572
|
};
|
|
39069
39573
|
|
|
39070
|
-
type PayInvoiceParams = {
|
|
39071
|
-
/**
|
|
39072
|
-
* The Autumn invoice ID to mark as paid.
|
|
39073
|
-
*/
|
|
39074
|
-
invoiceId: string;
|
|
39075
|
-
};
|
|
39076
|
-
/**
|
|
39077
|
-
* The billing processor that owns this invoice.
|
|
39078
|
-
*/
|
|
39079
|
-
declare const PayInvoiceProcessorType: {
|
|
39080
|
-
readonly Stripe: "stripe";
|
|
39081
|
-
readonly Revenuecat: "revenuecat";
|
|
39082
|
-
};
|
|
39083
|
-
/**
|
|
39084
|
-
* The billing processor that owns this invoice.
|
|
39085
|
-
*/
|
|
39086
|
-
type PayInvoiceProcessorType = OpenEnum<typeof PayInvoiceProcessorType>;
|
|
39087
|
-
type PayInvoiceEntity = {
|
|
39088
|
-
/**
|
|
39089
|
-
* The entity this share of the line item is attributed to
|
|
39090
|
-
*/
|
|
39091
|
-
entityId: string;
|
|
39092
|
-
/**
|
|
39093
|
-
* Quantity charged to this entity. Null on fixed-price lines.
|
|
39094
|
-
*/
|
|
39095
|
-
quantity: number | null;
|
|
39096
|
-
/**
|
|
39097
|
-
* Amount attributed to this entity, pre-discount and pre-tax
|
|
39098
|
-
*/
|
|
39099
|
-
amount: number;
|
|
39100
|
-
};
|
|
39101
|
-
type PayInvoiceItem = {
|
|
39102
|
-
/**
|
|
39103
|
-
* Description of the invoice line item
|
|
39104
|
-
*/
|
|
39105
|
-
description: string;
|
|
39106
|
-
/**
|
|
39107
|
-
* Timestamp when the billing period starts
|
|
39108
|
-
*/
|
|
39109
|
-
periodStart: number | null;
|
|
39110
|
-
/**
|
|
39111
|
-
* Timestamp when the billing period ends
|
|
39112
|
-
*/
|
|
39113
|
-
periodEnd: number | null;
|
|
39114
|
-
/**
|
|
39115
|
-
* The plan this line item came from. Null for lines with no Autumn plan behind them.
|
|
39116
|
-
*/
|
|
39117
|
-
planId: string | null;
|
|
39118
|
-
/**
|
|
39119
|
-
* The ID of the feature associated with this line item
|
|
39120
|
-
*/
|
|
39121
|
-
featureId: string | null;
|
|
39122
|
-
/**
|
|
39123
|
-
* The name of the feature associated with this line item
|
|
39124
|
-
*/
|
|
39125
|
-
featureName: string | null;
|
|
39126
|
-
/**
|
|
39127
|
-
* Quantity actually charged on this line. Null on fixed-price lines.
|
|
39128
|
-
*/
|
|
39129
|
-
quantity: number | null;
|
|
39130
|
-
/**
|
|
39131
|
-
* Amount charged on this line, pre-discount and pre-tax. Negative for credits.
|
|
39132
|
-
*/
|
|
39133
|
-
amount: number;
|
|
39134
|
-
/**
|
|
39135
|
-
* How this line splits by entity. Empty for customer-level lines. Only populated for invoices finalized after entity attribution shipped.
|
|
39136
|
-
*/
|
|
39137
|
-
entities: Array<PayInvoiceEntity>;
|
|
39138
|
-
};
|
|
39139
|
-
type PayInvoiceInvoice = {
|
|
39140
|
-
/**
|
|
39141
|
-
* Array of plan IDs included in this invoice
|
|
39142
|
-
*/
|
|
39143
|
-
planIds: Array<string>;
|
|
39144
|
-
/**
|
|
39145
|
-
* The Stripe invoice ID
|
|
39146
|
-
*/
|
|
39147
|
-
stripeId: string;
|
|
39148
|
-
/**
|
|
39149
|
-
* The billing processor that owns this invoice.
|
|
39150
|
-
*/
|
|
39151
|
-
processorType: PayInvoiceProcessorType;
|
|
39152
|
-
/**
|
|
39153
|
-
* The status of the invoice
|
|
39154
|
-
*/
|
|
39155
|
-
status: string;
|
|
39156
|
-
/**
|
|
39157
|
-
* The total amount of the invoice
|
|
39158
|
-
*/
|
|
39159
|
-
total: number;
|
|
39160
|
-
/**
|
|
39161
|
-
* The currency code for the invoice
|
|
39162
|
-
*/
|
|
39163
|
-
currency: string;
|
|
39164
|
-
/**
|
|
39165
|
-
* Timestamp when the invoice was created
|
|
39166
|
-
*/
|
|
39167
|
-
createdAt: number;
|
|
39168
|
-
/**
|
|
39169
|
-
* URL to the Stripe-hosted invoice page
|
|
39170
|
-
*/
|
|
39171
|
-
hostedInvoiceUrl?: string | null | undefined;
|
|
39172
|
-
/**
|
|
39173
|
-
* The Autumn invoice ID
|
|
39174
|
-
*/
|
|
39175
|
-
id: string;
|
|
39176
|
-
/**
|
|
39177
|
-
* The ID of the customer this invoice belongs to. Null for customers created without an ID.
|
|
39178
|
-
*/
|
|
39179
|
-
customerId: string | null;
|
|
39180
|
-
/**
|
|
39181
|
-
* The ID of the entity this invoice belongs to, if entity-scoped
|
|
39182
|
-
*/
|
|
39183
|
-
entityId: string | null;
|
|
39184
|
-
/**
|
|
39185
|
-
* The amount paid on the invoice. Null on invoices recorded before amounts paid were tracked.
|
|
39186
|
-
*/
|
|
39187
|
-
amountPaid: number | null;
|
|
39188
|
-
/**
|
|
39189
|
-
* The total amount refunded on the invoice
|
|
39190
|
-
*/
|
|
39191
|
-
refundedAmount: number;
|
|
39192
|
-
/**
|
|
39193
|
-
* Line items on the invoice, one per line as shown in Stripe. Capped at 100. Empty for invoices recorded before line item storage.
|
|
39194
|
-
*/
|
|
39195
|
-
items?: Array<PayInvoiceItem> | undefined;
|
|
39196
|
-
};
|
|
39197
|
-
/**
|
|
39198
|
-
* OK
|
|
39199
|
-
*/
|
|
39200
|
-
type PayInvoiceResponse = {
|
|
39201
|
-
invoice: PayInvoiceInvoice;
|
|
39202
|
-
};
|
|
39203
|
-
|
|
39204
39574
|
/**
|
|
39205
39575
|
* Quantity configuration for a prepaid feature.
|
|
39206
39576
|
*/
|
|
@@ -39516,6 +39886,20 @@ type PreviewAttachItemRollover = {
|
|
|
39516
39886
|
*/
|
|
39517
39887
|
expiryDurationLength?: number | undefined;
|
|
39518
39888
|
};
|
|
39889
|
+
declare const PreviewAttachItemDuration: {
|
|
39890
|
+
readonly Day: "day";
|
|
39891
|
+
readonly Week: "week";
|
|
39892
|
+
readonly Month: "month";
|
|
39893
|
+
readonly Year: "year";
|
|
39894
|
+
};
|
|
39895
|
+
type PreviewAttachItemDuration = ClosedEnum<typeof PreviewAttachItemDuration>;
|
|
39896
|
+
/**
|
|
39897
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
39898
|
+
*/
|
|
39899
|
+
type PreviewAttachItemExpiry = {
|
|
39900
|
+
duration: PreviewAttachItemDuration;
|
|
39901
|
+
length: number;
|
|
39902
|
+
};
|
|
39519
39903
|
type PreviewAttachDimensionsItem4 = {
|
|
39520
39904
|
/**
|
|
39521
39905
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -39782,6 +40166,10 @@ type PreviewAttachItemPlanItem = {
|
|
|
39782
40166
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
39783
40167
|
*/
|
|
39784
40168
|
rollover?: PreviewAttachItemRollover | undefined;
|
|
40169
|
+
/**
|
|
40170
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
40171
|
+
*/
|
|
40172
|
+
expiry?: PreviewAttachItemExpiry | undefined;
|
|
39785
40173
|
/**
|
|
39786
40174
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
39787
40175
|
*/
|
|
@@ -39995,6 +40383,20 @@ type PreviewAttachAddItemRollover = {
|
|
|
39995
40383
|
*/
|
|
39996
40384
|
expiryDurationLength?: number | undefined;
|
|
39997
40385
|
};
|
|
40386
|
+
declare const PreviewAttachAddItemDuration: {
|
|
40387
|
+
readonly Day: "day";
|
|
40388
|
+
readonly Week: "week";
|
|
40389
|
+
readonly Month: "month";
|
|
40390
|
+
readonly Year: "year";
|
|
40391
|
+
};
|
|
40392
|
+
type PreviewAttachAddItemDuration = ClosedEnum<typeof PreviewAttachAddItemDuration>;
|
|
40393
|
+
/**
|
|
40394
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
40395
|
+
*/
|
|
40396
|
+
type PreviewAttachAddItemExpiry = {
|
|
40397
|
+
duration: PreviewAttachAddItemDuration;
|
|
40398
|
+
length: number;
|
|
40399
|
+
};
|
|
39998
40400
|
type PreviewAttachDimensionsAddItem4 = {
|
|
39999
40401
|
/**
|
|
40000
40402
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -40261,6 +40663,10 @@ type PreviewAttachAddItemPlanItem = {
|
|
|
40261
40663
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
40262
40664
|
*/
|
|
40263
40665
|
rollover?: PreviewAttachAddItemRollover | undefined;
|
|
40666
|
+
/**
|
|
40667
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
40668
|
+
*/
|
|
40669
|
+
expiry?: PreviewAttachAddItemExpiry | undefined;
|
|
40264
40670
|
/**
|
|
40265
40671
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
40266
40672
|
*/
|
|
@@ -40871,6 +41277,21 @@ type PreviewAttachUpsertLicenseRollover = {
|
|
|
40871
41277
|
*/
|
|
40872
41278
|
expiryDurationLength?: number | undefined;
|
|
40873
41279
|
};
|
|
41280
|
+
|
|
41281
|
+
declare const PreviewAttachUpsertLicenseDuration: {
|
|
41282
|
+
readonly Day: "day";
|
|
41283
|
+
readonly Week: "week";
|
|
41284
|
+
readonly Month: "month";
|
|
41285
|
+
readonly Year: "year";
|
|
41286
|
+
};
|
|
41287
|
+
type PreviewAttachUpsertLicenseDuration = ClosedEnum<typeof PreviewAttachUpsertLicenseDuration>;
|
|
41288
|
+
/**
|
|
41289
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
41290
|
+
*/
|
|
41291
|
+
type PreviewAttachUpsertLicenseExpiry = {
|
|
41292
|
+
duration: PreviewAttachUpsertLicenseDuration;
|
|
41293
|
+
length: number;
|
|
41294
|
+
};
|
|
40874
41295
|
type PreviewAttachDimensionsUpsertLicense4 = {
|
|
40875
41296
|
/**
|
|
40876
41297
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -40887,12 +41308,10 @@ type PreviewAttachDimensionsUpsertLicense4 = {
|
|
|
40887
41308
|
*/
|
|
40888
41309
|
creditCost: number;
|
|
40889
41310
|
};
|
|
40890
|
-
type PreviewAttachDimensionsUpsertLicenseMatch3 = string | number | boolean;
|
|
40891
41311
|
declare const PreviewAttachDimensionsToUpsertLicenseEnum2: {
|
|
40892
41312
|
readonly Inf: "inf";
|
|
40893
41313
|
};
|
|
40894
41314
|
type PreviewAttachDimensionsToUpsertLicenseEnum2 = ClosedEnum<typeof PreviewAttachDimensionsToUpsertLicenseEnum2>;
|
|
40895
|
-
|
|
40896
41315
|
type PreviewAttachDimensionsUpsertLicenseTier2 = {
|
|
40897
41316
|
/**
|
|
40898
41317
|
* Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'.
|
|
@@ -40908,7 +41327,7 @@ type PreviewAttachDimensionsUpsertLicense3 = {
|
|
|
40908
41327
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
40909
41328
|
*/
|
|
40910
41329
|
match: {
|
|
40911
|
-
[k: string]:
|
|
41330
|
+
[k: string]: string | number | boolean;
|
|
40912
41331
|
};
|
|
40913
41332
|
/**
|
|
40914
41333
|
* Breaks ties between dimensions that match the same number of keys. Higher wins.
|
|
@@ -41139,6 +41558,10 @@ type PreviewAttachUpsertLicensePlanItem = {
|
|
|
41139
41558
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
41140
41559
|
*/
|
|
41141
41560
|
rollover?: PreviewAttachUpsertLicenseRollover | undefined;
|
|
41561
|
+
/**
|
|
41562
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
41563
|
+
*/
|
|
41564
|
+
expiry?: PreviewAttachUpsertLicenseExpiry | undefined;
|
|
41142
41565
|
/**
|
|
41143
41566
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
41144
41567
|
*/
|
|
@@ -42107,6 +42530,20 @@ type PreviewMultiAttachRollover = {
|
|
|
42107
42530
|
*/
|
|
42108
42531
|
expiryDurationLength?: number | undefined;
|
|
42109
42532
|
};
|
|
42533
|
+
declare const PreviewMultiAttachDuration: {
|
|
42534
|
+
readonly Day: "day";
|
|
42535
|
+
readonly Week: "week";
|
|
42536
|
+
readonly Month: "month";
|
|
42537
|
+
readonly Year: "year";
|
|
42538
|
+
};
|
|
42539
|
+
type PreviewMultiAttachDuration = ClosedEnum<typeof PreviewMultiAttachDuration>;
|
|
42540
|
+
/**
|
|
42541
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
42542
|
+
*/
|
|
42543
|
+
type PreviewMultiAttachExpiry = {
|
|
42544
|
+
duration: PreviewMultiAttachDuration;
|
|
42545
|
+
length: number;
|
|
42546
|
+
};
|
|
42110
42547
|
type PreviewMultiAttachDimensions4 = {
|
|
42111
42548
|
/**
|
|
42112
42549
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -42373,6 +42810,10 @@ type PreviewMultiAttachPlanItem = {
|
|
|
42373
42810
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
42374
42811
|
*/
|
|
42375
42812
|
rollover?: PreviewMultiAttachRollover | undefined;
|
|
42813
|
+
/**
|
|
42814
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
42815
|
+
*/
|
|
42816
|
+
expiry?: PreviewMultiAttachExpiry | undefined;
|
|
42376
42817
|
/**
|
|
42377
42818
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
42378
42819
|
*/
|
|
@@ -43856,6 +44297,20 @@ type PreviewUpdateItemRollover = {
|
|
|
43856
44297
|
*/
|
|
43857
44298
|
expiryDurationLength?: number | undefined;
|
|
43858
44299
|
};
|
|
44300
|
+
declare const PreviewUpdateItemDuration: {
|
|
44301
|
+
readonly Day: "day";
|
|
44302
|
+
readonly Week: "week";
|
|
44303
|
+
readonly Month: "month";
|
|
44304
|
+
readonly Year: "year";
|
|
44305
|
+
};
|
|
44306
|
+
type PreviewUpdateItemDuration = ClosedEnum<typeof PreviewUpdateItemDuration>;
|
|
44307
|
+
/**
|
|
44308
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
44309
|
+
*/
|
|
44310
|
+
type PreviewUpdateItemExpiry = {
|
|
44311
|
+
duration: PreviewUpdateItemDuration;
|
|
44312
|
+
length: number;
|
|
44313
|
+
};
|
|
43859
44314
|
type PreviewUpdateDimensionsItem4 = {
|
|
43860
44315
|
/**
|
|
43861
44316
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -44122,6 +44577,10 @@ type PreviewUpdateItemPlanItem = {
|
|
|
44122
44577
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
44123
44578
|
*/
|
|
44124
44579
|
rollover?: PreviewUpdateItemRollover | undefined;
|
|
44580
|
+
/**
|
|
44581
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
44582
|
+
*/
|
|
44583
|
+
expiry?: PreviewUpdateItemExpiry | undefined;
|
|
44125
44584
|
/**
|
|
44126
44585
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
44127
44586
|
*/
|
|
@@ -44335,6 +44794,20 @@ type PreviewUpdateAddItemRollover = {
|
|
|
44335
44794
|
*/
|
|
44336
44795
|
expiryDurationLength?: number | undefined;
|
|
44337
44796
|
};
|
|
44797
|
+
declare const PreviewUpdateAddItemDuration: {
|
|
44798
|
+
readonly Day: "day";
|
|
44799
|
+
readonly Week: "week";
|
|
44800
|
+
readonly Month: "month";
|
|
44801
|
+
readonly Year: "year";
|
|
44802
|
+
};
|
|
44803
|
+
type PreviewUpdateAddItemDuration = ClosedEnum<typeof PreviewUpdateAddItemDuration>;
|
|
44804
|
+
/**
|
|
44805
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
44806
|
+
*/
|
|
44807
|
+
type PreviewUpdateAddItemExpiry = {
|
|
44808
|
+
duration: PreviewUpdateAddItemDuration;
|
|
44809
|
+
length: number;
|
|
44810
|
+
};
|
|
44338
44811
|
type PreviewUpdateDimensionsAddItem4 = {
|
|
44339
44812
|
/**
|
|
44340
44813
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -44601,6 +45074,10 @@ type PreviewUpdateAddItemPlanItem = {
|
|
|
44601
45074
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
44602
45075
|
*/
|
|
44603
45076
|
rollover?: PreviewUpdateAddItemRollover | undefined;
|
|
45077
|
+
/**
|
|
45078
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
45079
|
+
*/
|
|
45080
|
+
expiry?: PreviewUpdateAddItemExpiry | undefined;
|
|
44604
45081
|
/**
|
|
44605
45082
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
44606
45083
|
*/
|
|
@@ -45211,6 +45688,21 @@ type PreviewUpdateUpsertLicenseRollover = {
|
|
|
45211
45688
|
*/
|
|
45212
45689
|
expiryDurationLength?: number | undefined;
|
|
45213
45690
|
};
|
|
45691
|
+
|
|
45692
|
+
declare const PreviewUpdateUpsertLicenseDuration: {
|
|
45693
|
+
readonly Day: "day";
|
|
45694
|
+
readonly Week: "week";
|
|
45695
|
+
readonly Month: "month";
|
|
45696
|
+
readonly Year: "year";
|
|
45697
|
+
};
|
|
45698
|
+
type PreviewUpdateUpsertLicenseDuration = ClosedEnum<typeof PreviewUpdateUpsertLicenseDuration>;
|
|
45699
|
+
/**
|
|
45700
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
45701
|
+
*/
|
|
45702
|
+
type PreviewUpdateUpsertLicenseExpiry = {
|
|
45703
|
+
duration: PreviewUpdateUpsertLicenseDuration;
|
|
45704
|
+
length: number;
|
|
45705
|
+
};
|
|
45214
45706
|
type PreviewUpdateDimensionsUpsertLicense4 = {
|
|
45215
45707
|
/**
|
|
45216
45708
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -45227,12 +45719,10 @@ type PreviewUpdateDimensionsUpsertLicense4 = {
|
|
|
45227
45719
|
*/
|
|
45228
45720
|
creditCost: number;
|
|
45229
45721
|
};
|
|
45230
|
-
type PreviewUpdateDimensionsUpsertLicenseMatch3 = string | number | boolean;
|
|
45231
45722
|
declare const PreviewUpdateDimensionsToUpsertLicenseEnum2: {
|
|
45232
45723
|
readonly Inf: "inf";
|
|
45233
45724
|
};
|
|
45234
45725
|
type PreviewUpdateDimensionsToUpsertLicenseEnum2 = ClosedEnum<typeof PreviewUpdateDimensionsToUpsertLicenseEnum2>;
|
|
45235
|
-
|
|
45236
45726
|
type PreviewUpdateDimensionsUpsertLicenseTier2 = {
|
|
45237
45727
|
/**
|
|
45238
45728
|
* Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'.
|
|
@@ -45248,7 +45738,7 @@ type PreviewUpdateDimensionsUpsertLicense3 = {
|
|
|
45248
45738
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
45249
45739
|
*/
|
|
45250
45740
|
match: {
|
|
45251
|
-
[k: string]:
|
|
45741
|
+
[k: string]: string | number | boolean;
|
|
45252
45742
|
};
|
|
45253
45743
|
/**
|
|
45254
45744
|
* Breaks ties between dimensions that match the same number of keys. Higher wins.
|
|
@@ -45479,6 +45969,10 @@ type PreviewUpdateUpsertLicensePlanItem = {
|
|
|
45479
45969
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
45480
45970
|
*/
|
|
45481
45971
|
rollover?: PreviewUpdateUpsertLicenseRollover | undefined;
|
|
45972
|
+
/**
|
|
45973
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
45974
|
+
*/
|
|
45975
|
+
expiry?: PreviewUpdateUpsertLicenseExpiry | undefined;
|
|
45482
45976
|
/**
|
|
45483
45977
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
45484
45978
|
*/
|
|
@@ -45657,6 +46151,16 @@ type PreviewUpdateAttachDiscount = {
|
|
|
45657
46151
|
*/
|
|
45658
46152
|
promotionCode?: string | undefined;
|
|
45659
46153
|
};
|
|
46154
|
+
type PreviewUpdateCustomLineItem = {
|
|
46155
|
+
/**
|
|
46156
|
+
* Amount in dollars for this line item (e.g. 10.50). Can be negative for credits.
|
|
46157
|
+
*/
|
|
46158
|
+
amount: number;
|
|
46159
|
+
/**
|
|
46160
|
+
* Description for the line item.
|
|
46161
|
+
*/
|
|
46162
|
+
description: string;
|
|
46163
|
+
};
|
|
45660
46164
|
/**
|
|
45661
46165
|
* 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.
|
|
45662
46166
|
*/
|
|
@@ -45761,6 +46265,10 @@ type PreviewUpdateParams = {
|
|
|
45761
46265
|
* List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.
|
|
45762
46266
|
*/
|
|
45763
46267
|
discounts?: Array<PreviewUpdateAttachDiscount> | undefined;
|
|
46268
|
+
/**
|
|
46269
|
+
* Custom line items that replace the auto-generated proration invoice, or bill a standalone invoice when nothing else changes. Only valid on an existing recurring subscription.
|
|
46270
|
+
*/
|
|
46271
|
+
customLineItems?: Array<PreviewUpdateCustomLineItem> | undefined;
|
|
45764
46272
|
/**
|
|
45765
46273
|
* 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.
|
|
45766
46274
|
*/
|
|
@@ -46590,6 +47098,20 @@ type SetupPaymentItemRollover = {
|
|
|
46590
47098
|
*/
|
|
46591
47099
|
expiryDurationLength?: number | undefined;
|
|
46592
47100
|
};
|
|
47101
|
+
declare const SetupPaymentItemDuration: {
|
|
47102
|
+
readonly Day: "day";
|
|
47103
|
+
readonly Week: "week";
|
|
47104
|
+
readonly Month: "month";
|
|
47105
|
+
readonly Year: "year";
|
|
47106
|
+
};
|
|
47107
|
+
type SetupPaymentItemDuration = ClosedEnum<typeof SetupPaymentItemDuration>;
|
|
47108
|
+
/**
|
|
47109
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
47110
|
+
*/
|
|
47111
|
+
type SetupPaymentItemExpiry = {
|
|
47112
|
+
duration: SetupPaymentItemDuration;
|
|
47113
|
+
length: number;
|
|
47114
|
+
};
|
|
46593
47115
|
type SetupPaymentDimensionsItem4 = {
|
|
46594
47116
|
/**
|
|
46595
47117
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -46856,6 +47378,10 @@ type SetupPaymentItemPlanItem = {
|
|
|
46856
47378
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
46857
47379
|
*/
|
|
46858
47380
|
rollover?: SetupPaymentItemRollover | undefined;
|
|
47381
|
+
/**
|
|
47382
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
47383
|
+
*/
|
|
47384
|
+
expiry?: SetupPaymentItemExpiry | undefined;
|
|
46859
47385
|
/**
|
|
46860
47386
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
46861
47387
|
*/
|
|
@@ -47069,6 +47595,20 @@ type SetupPaymentAddItemRollover = {
|
|
|
47069
47595
|
*/
|
|
47070
47596
|
expiryDurationLength?: number | undefined;
|
|
47071
47597
|
};
|
|
47598
|
+
declare const SetupPaymentAddItemDuration: {
|
|
47599
|
+
readonly Day: "day";
|
|
47600
|
+
readonly Week: "week";
|
|
47601
|
+
readonly Month: "month";
|
|
47602
|
+
readonly Year: "year";
|
|
47603
|
+
};
|
|
47604
|
+
type SetupPaymentAddItemDuration = ClosedEnum<typeof SetupPaymentAddItemDuration>;
|
|
47605
|
+
/**
|
|
47606
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
47607
|
+
*/
|
|
47608
|
+
type SetupPaymentAddItemExpiry = {
|
|
47609
|
+
duration: SetupPaymentAddItemDuration;
|
|
47610
|
+
length: number;
|
|
47611
|
+
};
|
|
47072
47612
|
type SetupPaymentDimensionsAddItem4 = {
|
|
47073
47613
|
/**
|
|
47074
47614
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -47335,6 +47875,10 @@ type SetupPaymentAddItemPlanItem = {
|
|
|
47335
47875
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
47336
47876
|
*/
|
|
47337
47877
|
rollover?: SetupPaymentAddItemRollover | undefined;
|
|
47878
|
+
/**
|
|
47879
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
47880
|
+
*/
|
|
47881
|
+
expiry?: SetupPaymentAddItemExpiry | undefined;
|
|
47338
47882
|
/**
|
|
47339
47883
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
47340
47884
|
*/
|
|
@@ -47945,6 +48489,21 @@ type SetupPaymentUpsertLicenseRollover = {
|
|
|
47945
48489
|
*/
|
|
47946
48490
|
expiryDurationLength?: number | undefined;
|
|
47947
48491
|
};
|
|
48492
|
+
|
|
48493
|
+
declare const SetupPaymentUpsertLicenseDuration: {
|
|
48494
|
+
readonly Day: "day";
|
|
48495
|
+
readonly Week: "week";
|
|
48496
|
+
readonly Month: "month";
|
|
48497
|
+
readonly Year: "year";
|
|
48498
|
+
};
|
|
48499
|
+
type SetupPaymentUpsertLicenseDuration = ClosedEnum<typeof SetupPaymentUpsertLicenseDuration>;
|
|
48500
|
+
/**
|
|
48501
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
48502
|
+
*/
|
|
48503
|
+
type SetupPaymentUpsertLicenseExpiry = {
|
|
48504
|
+
duration: SetupPaymentUpsertLicenseDuration;
|
|
48505
|
+
length: number;
|
|
48506
|
+
};
|
|
47948
48507
|
type SetupPaymentDimensionsUpsertLicense4 = {
|
|
47949
48508
|
/**
|
|
47950
48509
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -48211,6 +48770,10 @@ type SetupPaymentUpsertLicensePlanItem = {
|
|
|
48211
48770
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
48212
48771
|
*/
|
|
48213
48772
|
rollover?: SetupPaymentUpsertLicenseRollover | undefined;
|
|
48773
|
+
/**
|
|
48774
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
48775
|
+
*/
|
|
48776
|
+
expiry?: SetupPaymentUpsertLicenseExpiry | undefined;
|
|
48214
48777
|
/**
|
|
48215
48778
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
48216
48779
|
*/
|
|
@@ -50356,10 +50919,6 @@ type UpdateCustomerFeature = {
|
|
|
50356
50919
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
50357
50920
|
*/
|
|
50358
50921
|
creditSchema?: Array<UpdateCustomerCreditSchema1 | UpdateCustomerCreditSchema2 | UpdateCustomerCreditSchema3> | undefined;
|
|
50359
|
-
/**
|
|
50360
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
50361
|
-
*/
|
|
50362
|
-
invoiceCredit?: boolean | undefined;
|
|
50363
50922
|
/**
|
|
50364
50923
|
* Per-model markup overrides for AI credit systems.
|
|
50365
50924
|
*/
|
|
@@ -51279,10 +51838,6 @@ type UpdateEntityFeature = {
|
|
|
51279
51838
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
51280
51839
|
*/
|
|
51281
51840
|
creditSchema?: Array<UpdateEntityCreditSchema1 | UpdateEntityCreditSchema2 | UpdateEntityCreditSchema3> | undefined;
|
|
51282
|
-
/**
|
|
51283
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
51284
|
-
*/
|
|
51285
|
-
invoiceCredit?: boolean | undefined;
|
|
51286
51841
|
/**
|
|
51287
51842
|
* Per-model markup overrides for AI credit systems.
|
|
51288
51843
|
*/
|
|
@@ -51908,10 +52463,6 @@ type UpdateFeatureParams = {
|
|
|
51908
52463
|
* A schema that maps metered feature IDs to flat or graduated credit costs. For classic credit systems only — AI credit systems use model_markups instead.
|
|
51909
52464
|
*/
|
|
51910
52465
|
creditSchema?: Array<UpdateFeatureCreditSchemaRequestBody1 | UpdateFeatureCreditSchemaRequestBody2> | undefined;
|
|
51911
|
-
/**
|
|
51912
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
51913
|
-
*/
|
|
51914
|
-
invoiceCredit?: boolean | undefined;
|
|
51915
52466
|
/**
|
|
51916
52467
|
* Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration.
|
|
51917
52468
|
*/
|
|
@@ -52287,10 +52838,6 @@ type UpdateFeatureResponse = {
|
|
|
52287
52838
|
* For classic credit systems: maps metered features to flat or graduated credit costs.
|
|
52288
52839
|
*/
|
|
52289
52840
|
creditSchema?: Array<UpdateFeatureCreditSchemaResponse1 | UpdateFeatureCreditSchemaResponse2 | UpdateFeatureCreditSchemaResponse3> | undefined;
|
|
52290
|
-
/**
|
|
52291
|
-
* Whether usage of this classic credit system should be itemized as invoice credits.
|
|
52292
|
-
*/
|
|
52293
|
-
invoiceCredit?: boolean | undefined;
|
|
52294
52841
|
/**
|
|
52295
52842
|
* Per-model markup overrides for AI credit systems.
|
|
52296
52843
|
*/
|
|
@@ -52575,6 +53122,20 @@ type UpdatePlanItemRolloverRequestBody = {
|
|
|
52575
53122
|
*/
|
|
52576
53123
|
expiryDurationLength?: number | undefined;
|
|
52577
53124
|
};
|
|
53125
|
+
declare const UpdatePlanItemDurationRequestBody: {
|
|
53126
|
+
readonly Day: "day";
|
|
53127
|
+
readonly Week: "week";
|
|
53128
|
+
readonly Month: "month";
|
|
53129
|
+
readonly Year: "year";
|
|
53130
|
+
};
|
|
53131
|
+
type UpdatePlanItemDurationRequestBody = ClosedEnum<typeof UpdatePlanItemDurationRequestBody>;
|
|
53132
|
+
/**
|
|
53133
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
53134
|
+
*/
|
|
53135
|
+
type UpdatePlanItemExpiryRequestBody = {
|
|
53136
|
+
duration: UpdatePlanItemDurationRequestBody;
|
|
53137
|
+
length: number;
|
|
53138
|
+
};
|
|
52578
53139
|
type UpdatePlanDimensionsItemRequestBody4 = {
|
|
52579
53140
|
/**
|
|
52580
53141
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -52841,6 +53402,10 @@ type UpdatePlanItemPlanItem = {
|
|
|
52841
53402
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
52842
53403
|
*/
|
|
52843
53404
|
rollover?: UpdatePlanItemRolloverRequestBody | undefined;
|
|
53405
|
+
/**
|
|
53406
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
53407
|
+
*/
|
|
53408
|
+
expiry?: UpdatePlanItemExpiryRequestBody | undefined;
|
|
52844
53409
|
/**
|
|
52845
53410
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
52846
53411
|
*/
|
|
@@ -53100,6 +53665,20 @@ type UpdatePlanLicenseRollover = {
|
|
|
53100
53665
|
*/
|
|
53101
53666
|
expiryDurationLength?: number | undefined;
|
|
53102
53667
|
};
|
|
53668
|
+
declare const UpdatePlanLicenseDuration: {
|
|
53669
|
+
readonly Day: "day";
|
|
53670
|
+
readonly Week: "week";
|
|
53671
|
+
readonly Month: "month";
|
|
53672
|
+
readonly Year: "year";
|
|
53673
|
+
};
|
|
53674
|
+
type UpdatePlanLicenseDuration = ClosedEnum<typeof UpdatePlanLicenseDuration>;
|
|
53675
|
+
/**
|
|
53676
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
53677
|
+
*/
|
|
53678
|
+
type UpdatePlanLicenseExpiry = {
|
|
53679
|
+
duration: UpdatePlanLicenseDuration;
|
|
53680
|
+
length: number;
|
|
53681
|
+
};
|
|
53103
53682
|
type UpdatePlanDimensionsLicense4 = {
|
|
53104
53683
|
/**
|
|
53105
53684
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -53366,6 +53945,10 @@ type UpdatePlanLicensePlanItem = {
|
|
|
53366
53945
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
53367
53946
|
*/
|
|
53368
53947
|
rollover?: UpdatePlanLicenseRollover | undefined;
|
|
53948
|
+
/**
|
|
53949
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
53950
|
+
*/
|
|
53951
|
+
expiry?: UpdatePlanLicenseExpiry | undefined;
|
|
53369
53952
|
/**
|
|
53370
53953
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
53371
53954
|
*/
|
|
@@ -53937,6 +54520,7 @@ type UpdatePlanVariantPrice = {
|
|
|
53937
54520
|
*/
|
|
53938
54521
|
maxPurchase?: number | null | undefined;
|
|
53939
54522
|
};
|
|
54523
|
+
|
|
53940
54524
|
/**
|
|
53941
54525
|
* Billing behavior when quantity increases mid-cycle.
|
|
53942
54526
|
*/
|
|
@@ -53988,7 +54572,6 @@ declare const UpdatePlanVariantExpiryDurationType: {
|
|
|
53988
54572
|
* When rolled over units expire.
|
|
53989
54573
|
*/
|
|
53990
54574
|
type UpdatePlanVariantExpiryDurationType = ClosedEnum<typeof UpdatePlanVariantExpiryDurationType>;
|
|
53991
|
-
|
|
53992
54575
|
/**
|
|
53993
54576
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
53994
54577
|
*/
|
|
@@ -54010,6 +54593,20 @@ type UpdatePlanVariantRollover = {
|
|
|
54010
54593
|
*/
|
|
54011
54594
|
expiryDurationLength?: number | undefined;
|
|
54012
54595
|
};
|
|
54596
|
+
declare const UpdatePlanVariantDuration: {
|
|
54597
|
+
readonly Day: "day";
|
|
54598
|
+
readonly Week: "week";
|
|
54599
|
+
readonly Month: "month";
|
|
54600
|
+
readonly Year: "year";
|
|
54601
|
+
};
|
|
54602
|
+
type UpdatePlanVariantDuration = ClosedEnum<typeof UpdatePlanVariantDuration>;
|
|
54603
|
+
/**
|
|
54604
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
54605
|
+
*/
|
|
54606
|
+
type UpdatePlanVariantExpiry = {
|
|
54607
|
+
duration: UpdatePlanVariantDuration;
|
|
54608
|
+
length: number;
|
|
54609
|
+
};
|
|
54013
54610
|
type UpdatePlanDimensionsVariant4 = {
|
|
54014
54611
|
/**
|
|
54015
54612
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -54276,6 +54873,10 @@ type UpdatePlanVariantPlanItem = {
|
|
|
54276
54873
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
54277
54874
|
*/
|
|
54278
54875
|
rollover?: UpdatePlanVariantRollover | undefined;
|
|
54876
|
+
/**
|
|
54877
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
54878
|
+
*/
|
|
54879
|
+
expiry?: UpdatePlanVariantExpiry | undefined;
|
|
54279
54880
|
/**
|
|
54280
54881
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
54281
54882
|
*/
|
|
@@ -54886,6 +55487,20 @@ type UpdatePlanVariantUpsertLicenseRollover = {
|
|
|
54886
55487
|
*/
|
|
54887
55488
|
expiryDurationLength?: number | undefined;
|
|
54888
55489
|
};
|
|
55490
|
+
declare const UpdatePlanVariantUpsertLicenseDuration: {
|
|
55491
|
+
readonly Day: "day";
|
|
55492
|
+
readonly Week: "week";
|
|
55493
|
+
readonly Month: "month";
|
|
55494
|
+
readonly Year: "year";
|
|
55495
|
+
};
|
|
55496
|
+
type UpdatePlanVariantUpsertLicenseDuration = ClosedEnum<typeof UpdatePlanVariantUpsertLicenseDuration>;
|
|
55497
|
+
/**
|
|
55498
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
55499
|
+
*/
|
|
55500
|
+
type UpdatePlanVariantUpsertLicenseExpiry = {
|
|
55501
|
+
duration: UpdatePlanVariantUpsertLicenseDuration;
|
|
55502
|
+
length: number;
|
|
55503
|
+
};
|
|
54889
55504
|
type UpdatePlanDimensionsVariantUpsertLicense4 = {
|
|
54890
55505
|
/**
|
|
54891
55506
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -55152,6 +55767,10 @@ type UpdatePlanVariantUpsertLicensePlanItem = {
|
|
|
55152
55767
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
55153
55768
|
*/
|
|
55154
55769
|
rollover?: UpdatePlanVariantUpsertLicenseRollover | undefined;
|
|
55770
|
+
/**
|
|
55771
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
55772
|
+
*/
|
|
55773
|
+
expiry?: UpdatePlanVariantUpsertLicenseExpiry | undefined;
|
|
55155
55774
|
/**
|
|
55156
55775
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
55157
55776
|
*/
|
|
@@ -55626,6 +56245,7 @@ type UpdatePlanItemStripe = {
|
|
|
55626
56245
|
type UpdatePlanItemProcessors = {
|
|
55627
56246
|
stripe?: UpdatePlanItemStripe | null | undefined;
|
|
55628
56247
|
};
|
|
56248
|
+
|
|
55629
56249
|
type UpdatePlanItemPriceResponse = {
|
|
55630
56250
|
/**
|
|
55631
56251
|
* Price per billing_units after included usage is consumed. Mutually exclusive with tiers.
|
|
@@ -55710,6 +56330,17 @@ type UpdatePlanItemRolloverResponse = {
|
|
|
55710
56330
|
*/
|
|
55711
56331
|
expiryDurationLength?: number | undefined;
|
|
55712
56332
|
};
|
|
56333
|
+
declare const UpdatePlanItemDurationResponse: {
|
|
56334
|
+
readonly Day: "day";
|
|
56335
|
+
readonly Week: "week";
|
|
56336
|
+
readonly Month: "month";
|
|
56337
|
+
readonly Year: "year";
|
|
56338
|
+
};
|
|
56339
|
+
type UpdatePlanItemDurationResponse = OpenEnum<typeof UpdatePlanItemDurationResponse>;
|
|
56340
|
+
type UpdatePlanItemExpiryResponse = {
|
|
56341
|
+
duration: UpdatePlanItemDurationResponse;
|
|
56342
|
+
length: number;
|
|
56343
|
+
};
|
|
55713
56344
|
type UpdatePlanDimensionsItemResponse4 = {
|
|
55714
56345
|
/**
|
|
55715
56346
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -55740,7 +56371,6 @@ type UpdatePlanDimensionsItemTierResponse2 = {
|
|
|
55740
56371
|
*/
|
|
55741
56372
|
creditCost: number;
|
|
55742
56373
|
};
|
|
55743
|
-
|
|
55744
56374
|
type UpdatePlanDimensionsItemResponse3 = {
|
|
55745
56375
|
/**
|
|
55746
56376
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -55978,6 +56608,10 @@ type UpdatePlanItem = {
|
|
|
55978
56608
|
* Rollover configuration for unused units. If set, unused included units roll over to the next period.
|
|
55979
56609
|
*/
|
|
55980
56610
|
rollover?: UpdatePlanItemRolloverResponse | undefined;
|
|
56611
|
+
/**
|
|
56612
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
56613
|
+
*/
|
|
56614
|
+
expiry?: UpdatePlanItemExpiryResponse | null | undefined;
|
|
55981
56615
|
/**
|
|
55982
56616
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
55983
56617
|
*/
|
|
@@ -56622,6 +57256,20 @@ type UpdatePlanVariantDetailsRollover = {
|
|
|
56622
57256
|
*/
|
|
56623
57257
|
expiryDurationLength?: number | undefined;
|
|
56624
57258
|
};
|
|
57259
|
+
declare const UpdatePlanVariantDetailsDuration: {
|
|
57260
|
+
readonly Day: "day";
|
|
57261
|
+
readonly Week: "week";
|
|
57262
|
+
readonly Month: "month";
|
|
57263
|
+
readonly Year: "year";
|
|
57264
|
+
};
|
|
57265
|
+
type UpdatePlanVariantDetailsDuration = OpenEnum<typeof UpdatePlanVariantDetailsDuration>;
|
|
57266
|
+
/**
|
|
57267
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
57268
|
+
*/
|
|
57269
|
+
type UpdatePlanVariantDetailsExpiry = {
|
|
57270
|
+
duration: UpdatePlanVariantDetailsDuration;
|
|
57271
|
+
length: number;
|
|
57272
|
+
};
|
|
56625
57273
|
type UpdatePlanDimensionsVariantDetails4 = {
|
|
56626
57274
|
/**
|
|
56627
57275
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -56888,6 +57536,10 @@ type UpdatePlanPlanItemResponse = {
|
|
|
56888
57536
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
56889
57537
|
*/
|
|
56890
57538
|
rollover?: UpdatePlanVariantDetailsRollover | undefined;
|
|
57539
|
+
/**
|
|
57540
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
57541
|
+
*/
|
|
57542
|
+
expiry?: UpdatePlanVariantDetailsExpiry | undefined;
|
|
56891
57543
|
/**
|
|
56892
57544
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
56893
57545
|
*/
|
|
@@ -57495,6 +58147,20 @@ type UpdatePlanVariantDetailsUpsertLicenseRollover = {
|
|
|
57495
58147
|
*/
|
|
57496
58148
|
expiryDurationLength?: number | undefined;
|
|
57497
58149
|
};
|
|
58150
|
+
declare const UpdatePlanVariantDetailsUpsertLicenseDuration: {
|
|
58151
|
+
readonly Day: "day";
|
|
58152
|
+
readonly Week: "week";
|
|
58153
|
+
readonly Month: "month";
|
|
58154
|
+
readonly Year: "year";
|
|
58155
|
+
};
|
|
58156
|
+
type UpdatePlanVariantDetailsUpsertLicenseDuration = OpenEnum<typeof UpdatePlanVariantDetailsUpsertLicenseDuration>;
|
|
58157
|
+
/**
|
|
58158
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
58159
|
+
*/
|
|
58160
|
+
type UpdatePlanVariantDetailsUpsertLicenseExpiry = {
|
|
58161
|
+
duration: UpdatePlanVariantDetailsUpsertLicenseDuration;
|
|
58162
|
+
length: number;
|
|
58163
|
+
};
|
|
57498
58164
|
type UpdatePlanDimensionsVariantDetailsUpsertLicense4 = {
|
|
57499
58165
|
/**
|
|
57500
58166
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -57511,6 +58177,7 @@ type UpdatePlanDimensionsVariantDetailsUpsertLicense4 = {
|
|
|
57511
58177
|
*/
|
|
57512
58178
|
creditCost: number;
|
|
57513
58179
|
};
|
|
58180
|
+
|
|
57514
58181
|
declare const UpdatePlanDimensionsToVariantDetailsUpsertLicenseEnum2: {
|
|
57515
58182
|
readonly Inf: "inf";
|
|
57516
58183
|
};
|
|
@@ -57625,7 +58292,6 @@ type UpdatePlanDimensionsVariantDetailsUpsertLicense1 = {
|
|
|
57625
58292
|
tierBehavior: "graduated";
|
|
57626
58293
|
tiers: Array<UpdatePlanDimensionsVariantDetailsUpsertLicenseTier1>;
|
|
57627
58294
|
};
|
|
57628
|
-
type UpdatePlanVariantDetailsUpsertLicenseDimensionsUnion1 = UpdatePlanDimensionsVariantDetailsUpsertLicense1 | UpdatePlanDimensionsVariantDetailsUpsertLicense2;
|
|
57629
58295
|
type UpdatePlanVariantDetailsUpsertLicenseMultipliers1 = {
|
|
57630
58296
|
/**
|
|
57631
58297
|
* Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
|
|
@@ -57642,7 +58308,6 @@ type UpdatePlanVariantDetailsUpsertLicenseMultipliers1 = {
|
|
|
57642
58308
|
*/
|
|
57643
58309
|
add?: number | undefined;
|
|
57644
58310
|
};
|
|
57645
|
-
|
|
57646
58311
|
declare const UpdatePlanToVariantDetailsUpsertLicenseEnum: {
|
|
57647
58312
|
readonly Inf: "inf";
|
|
57648
58313
|
};
|
|
@@ -57670,7 +58335,7 @@ type UpdatePlanCreditSchemaVariantDetailsUpsertLicense1 = {
|
|
|
57670
58335
|
* Named rates chosen by event properties. The most specific match sets the rate; with no match the item's own rate applies.
|
|
57671
58336
|
*/
|
|
57672
58337
|
dimensions?: {
|
|
57673
|
-
[k: string]:
|
|
58338
|
+
[k: string]: UpdatePlanDimensionsVariantDetailsUpsertLicense1 | UpdatePlanDimensionsVariantDetailsUpsertLicense2;
|
|
57674
58339
|
} | undefined;
|
|
57675
58340
|
/**
|
|
57676
58341
|
* Named adjustments chosen by event properties. Every match applies: factors multiply, then adds are summed.
|
|
@@ -57763,6 +58428,10 @@ type UpdatePlanUpsertLicensePlanItemResponse = {
|
|
|
57763
58428
|
* Rollover config for unused units. If set, unused included units carry over.
|
|
57764
58429
|
*/
|
|
57765
58430
|
rollover?: UpdatePlanVariantDetailsUpsertLicenseRollover | undefined;
|
|
58431
|
+
/**
|
|
58432
|
+
* Purchased units expire this long after each purchase. One-off prepaid consumable items only.
|
|
58433
|
+
*/
|
|
58434
|
+
expiry?: UpdatePlanVariantDetailsUpsertLicenseExpiry | undefined;
|
|
57766
58435
|
/**
|
|
57767
58436
|
* Overrides fields of this item's feature for customers on this plan (e.g. a credit system's credit_schema).
|
|
57768
58437
|
*/
|
|
@@ -58123,7 +58792,7 @@ declare const UpdateRewardTypeRequestBody: {
|
|
|
58123
58792
|
* The unit of time the grant lasts.
|
|
58124
58793
|
*/
|
|
58125
58794
|
type UpdateRewardTypeRequestBody = ClosedEnum<typeof UpdateRewardTypeRequestBody>;
|
|
58126
|
-
type
|
|
58795
|
+
type UpdateRewardExpiryRequestBody = {
|
|
58127
58796
|
/**
|
|
58128
58797
|
* The unit of time the grant lasts.
|
|
58129
58798
|
*/
|
|
@@ -58139,7 +58808,7 @@ type UpdateRewardGrantRequest = {
|
|
|
58139
58808
|
/**
|
|
58140
58809
|
* How long the granted amount lasts before expiring, or null for a permanent grant.
|
|
58141
58810
|
*/
|
|
58142
|
-
expiry:
|
|
58811
|
+
expiry: UpdateRewardExpiryRequestBody | null;
|
|
58143
58812
|
};
|
|
58144
58813
|
type UpdateRewardFeatureGrantPromoCodeRequest = {
|
|
58145
58814
|
code: string;
|
|
@@ -58749,6 +59418,7 @@ declare class Billing extends ClientSDK {
|
|
|
58749
59418
|
* @param redirectMode - Controls when to return a checkout URL. 'always' returns a URL even if payment succeeds, 'if_required' only when payment action is needed, 'never' disables redirects. (optional)
|
|
58750
59419
|
* @param subscriptionId - A unique ID to identify this subscription. Can be used to target specific subscriptions in update operations when a customer has multiple products with the same plan. (optional)
|
|
58751
59420
|
* @param discounts - List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code. (optional)
|
|
59421
|
+
* @param customLineItems - Custom line items that replace the auto-generated proration invoice, or bill a standalone invoice when nothing else changes. Only valid on an existing recurring subscription. (optional)
|
|
58752
59422
|
* @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)
|
|
58753
59423
|
* @param billingCycleAnchor - Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds. (optional)
|
|
58754
59424
|
* @param noBillingChanges - If true, the subscription is updated internally without applying billing changes in Stripe. (optional)
|
|
@@ -58784,6 +59454,7 @@ declare class Billing extends ClientSDK {
|
|
|
58784
59454
|
* @param redirectMode - Controls when to return a checkout URL. 'always' returns a URL even if payment succeeds, 'if_required' only when payment action is needed, 'never' disables redirects. (optional)
|
|
58785
59455
|
* @param subscriptionId - A unique ID to identify this subscription. Can be used to target specific subscriptions in update operations when a customer has multiple products with the same plan. (optional)
|
|
58786
59456
|
* @param discounts - List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code. (optional)
|
|
59457
|
+
* @param customLineItems - Custom line items that replace the auto-generated proration invoice, or bill a standalone invoice when nothing else changes. Only valid on an existing recurring subscription. (optional)
|
|
58787
59458
|
* @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)
|
|
58788
59459
|
* @param billingCycleAnchor - Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds. (optional)
|
|
58789
59460
|
* @param noBillingChanges - If true, the subscription is updated internally without applying billing changes in Stripe. (optional)
|
|
@@ -59077,7 +59748,6 @@ declare class Features extends ClientSDK {
|
|
|
59077
59748
|
* @param consumable - Whether this feature is consumable. A consumable feature is one that periodically resets and is consumed rather than allocated (like credits, API requests, etc.). Applicable only for 'metered' features. (optional)
|
|
59078
59749
|
* @param display - Singular and plural display names for the feature in your user interface. (optional)
|
|
59079
59750
|
* @param creditSchema - A schema that maps metered feature IDs to flat or graduated credit costs. For classic credit systems only — AI credit systems use model_markups instead. (optional)
|
|
59080
|
-
* @param invoiceCredit - Whether usage of this classic credit system should be itemized as invoice credits. (optional)
|
|
59081
59751
|
* @param modelMarkups - Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration. (optional)
|
|
59082
59752
|
* @param defaultMarkup - Default percentage markup for this AI credit system. Used when no model or provider markup applies. Use -100 to make usage free. (optional)
|
|
59083
59753
|
* @param providerMarkups - Per-provider default markup percentages for AI credit systems. Provider keys match the first segment of model_id. (optional)
|
|
@@ -59132,7 +59802,6 @@ declare class Features extends ClientSDK {
|
|
|
59132
59802
|
* @param consumable - Whether this feature is consumable. A consumable feature is one that periodically resets and is consumed rather than allocated (like credits, API requests, etc.). Applicable only for 'metered' features. (optional)
|
|
59133
59803
|
* @param display - Singular and plural display names for the feature in your user interface. (optional)
|
|
59134
59804
|
* @param creditSchema - A schema that maps metered feature IDs to flat or graduated credit costs. For classic credit systems only — AI credit systems use model_markups instead. (optional)
|
|
59135
|
-
* @param invoiceCredit - Whether usage of this classic credit system should be itemized as invoice credits. (optional)
|
|
59136
59805
|
* @param modelMarkups - Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration. (optional)
|
|
59137
59806
|
* @param defaultMarkup - Default percentage markup for this AI credit system. Used when no model or provider markup applies. Use -100 to make usage free. (optional)
|
|
59138
59807
|
* @param providerMarkups - Per-provider default markup percentages for AI credit systems. Provider keys match the first segment of model_id. (optional)
|
|
@@ -59170,10 +59839,6 @@ declare class Invoices extends ClientSDK {
|
|
|
59170
59839
|
* Lists invoices with cursor pagination and optional filters (customer, entity, status, processor). Pass `start_cursor: ""` (or omit) for the first page; use `next_cursor` from a prior response for subsequent pages.
|
|
59171
59840
|
*/
|
|
59172
59841
|
list(request: ListInvoicesParams, options?: RequestOptions): Promise<ListInvoicesResponse>;
|
|
59173
|
-
/**
|
|
59174
|
-
* Marks an open Stripe invoice as paid out of band. No charge is attempted; use this when payment was collected elsewhere (e.g. a marketplace). Already-paid invoices are returned unchanged.
|
|
59175
|
-
*/
|
|
59176
|
-
pay(request: PayInvoiceParams, options?: RequestOptions): Promise<PayInvoiceResponse>;
|
|
59177
59842
|
}
|
|
59178
59843
|
|
|
59179
59844
|
declare class Keys extends ClientSDK {
|