@schematichq/schematic-components 2.20.0 → 2.21.1-rc.1

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.
@@ -321,6 +321,7 @@ declare const BillingCreditGrantZeroedOutReason: {
321
321
  readonly CustomerArchived: "customer_archived";
322
322
  readonly Expired: "expired";
323
323
  readonly IntegrationUninstalled: "integration_uninstalled";
324
+ readonly LicenseRetired: "license_retired";
324
325
  readonly Manual: "manual";
325
326
  readonly PlanChange: "plan_change";
326
327
  readonly PlanPeriodReset: "plan_period_reset";
@@ -701,10 +702,10 @@ declare interface BillingCreditView {
701
702
  pricePerUnitDecimal?: string | null;
702
703
  /**
703
704
  *
704
- * @type {BillingProductResponseData}
705
+ * @type {BillingProductRecordResponseData}
705
706
  * @memberof BillingCreditView
706
707
  */
707
- product?: BillingProductResponseData;
708
+ product?: BillingProductRecordResponseData;
708
709
  /**
709
710
  *
710
711
  * @type {string}
@@ -835,10 +836,10 @@ declare interface BillingCreditView_2 {
835
836
  pricePerUnitDecimal?: string | null;
836
837
  /**
837
838
  *
838
- * @type {BillingProductResponseData}
839
+ * @type {BillingProductRecordResponseData}
839
840
  * @memberof BillingCreditView
840
841
  */
841
- product?: BillingProductResponseData_2;
842
+ product?: BillingProductRecordResponseData_2;
842
843
  /**
843
844
  *
844
845
  * @type {string}
@@ -1053,6 +1054,12 @@ declare interface BillingPlanCreditGrantResponseData {
1053
1054
  * @memberof BillingPlanCreditGrantResponseData
1054
1055
  */
1055
1056
  canBuyBundles: boolean;
1057
+ /**
1058
+ * Credits granted once per company on top of the per-license amount. Always 0 when scaling is fixed.
1059
+ * @type {number}
1060
+ * @memberof BillingPlanCreditGrantResponseData
1061
+ */
1062
+ companyCreditAmount: number;
1056
1063
  /**
1057
1064
  *
1058
1065
  * @type {Date}
@@ -1122,6 +1129,12 @@ declare interface BillingPlanCreditGrantResponseData {
1122
1129
  * @memberof BillingPlanCreditGrantResponseData
1123
1130
  */
1124
1131
  id: string;
1132
+ /**
1133
+ * The license whose quantity scales this grant. Set only when scaling is per_license.
1134
+ * @type {string}
1135
+ * @memberof BillingPlanCreditGrantResponseData
1136
+ */
1137
+ licenseId?: string | null;
1125
1138
  /**
1126
1139
  *
1127
1140
  * @type {PreviewObjectResponseData}
@@ -1171,6 +1184,12 @@ declare interface BillingPlanCreditGrantResponseData {
1171
1184
  * @memberof BillingPlanCreditGrantResponseData
1172
1185
  */
1173
1186
  rolloverPercentage: number;
1187
+ /**
1188
+ * Whether the grant is a fixed amount per company, or issued once per license the company holds.
1189
+ * @type {PlanCreditGrantScaling}
1190
+ * @memberof BillingPlanCreditGrantResponseData
1191
+ */
1192
+ scaling: PlanCreditGrantScaling;
1174
1193
  /**
1175
1194
  *
1176
1195
  * @type {Date}
@@ -2235,6 +2254,130 @@ declare interface BillingProductPriceTierResponseData_2 {
2235
2254
  upTo?: number | null;
2236
2255
  }
2237
2256
 
2257
+ /**
2258
+ *
2259
+ * @export
2260
+ * @interface BillingProductRecordResponseData
2261
+ */
2262
+ declare interface BillingProductRecordResponseData {
2263
+ /**
2264
+ *
2265
+ * @type {string}
2266
+ * @memberof BillingProductRecordResponseData
2267
+ */
2268
+ accountId: string;
2269
+ /**
2270
+ *
2271
+ * @type {Date}
2272
+ * @memberof BillingProductRecordResponseData
2273
+ */
2274
+ createdAt: Date;
2275
+ /**
2276
+ *
2277
+ * @type {string}
2278
+ * @memberof BillingProductRecordResponseData
2279
+ */
2280
+ environmentId: string;
2281
+ /**
2282
+ *
2283
+ * @type {string}
2284
+ * @memberof BillingProductRecordResponseData
2285
+ */
2286
+ externalId: string;
2287
+ /**
2288
+ *
2289
+ * @type {string}
2290
+ * @memberof BillingProductRecordResponseData
2291
+ */
2292
+ id: string;
2293
+ /**
2294
+ *
2295
+ * @type {boolean}
2296
+ * @memberof BillingProductRecordResponseData
2297
+ */
2298
+ isActive: boolean;
2299
+ /**
2300
+ *
2301
+ * @type {string}
2302
+ * @memberof BillingProductRecordResponseData
2303
+ */
2304
+ name: string;
2305
+ /**
2306
+ *
2307
+ * @type {BillingProviderType}
2308
+ * @memberof BillingProductRecordResponseData
2309
+ */
2310
+ providerType: BillingProviderType;
2311
+ /**
2312
+ *
2313
+ * @type {Date}
2314
+ * @memberof BillingProductRecordResponseData
2315
+ */
2316
+ updatedAt: Date;
2317
+ }
2318
+
2319
+ /**
2320
+ *
2321
+ * @export
2322
+ * @interface BillingProductRecordResponseData
2323
+ */
2324
+ declare interface BillingProductRecordResponseData_2 {
2325
+ /**
2326
+ *
2327
+ * @type {string}
2328
+ * @memberof BillingProductRecordResponseData
2329
+ */
2330
+ accountId: string;
2331
+ /**
2332
+ *
2333
+ * @type {Date}
2334
+ * @memberof BillingProductRecordResponseData
2335
+ */
2336
+ createdAt: Date;
2337
+ /**
2338
+ *
2339
+ * @type {string}
2340
+ * @memberof BillingProductRecordResponseData
2341
+ */
2342
+ environmentId: string;
2343
+ /**
2344
+ *
2345
+ * @type {string}
2346
+ * @memberof BillingProductRecordResponseData
2347
+ */
2348
+ externalId: string;
2349
+ /**
2350
+ *
2351
+ * @type {string}
2352
+ * @memberof BillingProductRecordResponseData
2353
+ */
2354
+ id: string;
2355
+ /**
2356
+ *
2357
+ * @type {boolean}
2358
+ * @memberof BillingProductRecordResponseData
2359
+ */
2360
+ isActive: boolean;
2361
+ /**
2362
+ *
2363
+ * @type {string}
2364
+ * @memberof BillingProductRecordResponseData
2365
+ */
2366
+ name: string;
2367
+ /**
2368
+ *
2369
+ * @type {BillingProviderType}
2370
+ * @memberof BillingProductRecordResponseData
2371
+ */
2372
+ providerType: BillingProviderType_2;
2373
+ /**
2374
+ *
2375
+ * @type {Date}
2376
+ * @memberof BillingProductRecordResponseData
2377
+ */
2378
+ updatedAt: Date;
2379
+ }
2380
+
2238
2381
  /**
2239
2382
  *
2240
2383
  * @export
@@ -3098,7 +3241,7 @@ declare type ChargeType_2 = (typeof ChargeType_2)[keyof typeof ChargeType_2];
3098
3241
 
3099
3242
  export declare const Checkbox: IStyledComponentBase<"web", FastOmit<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type"> & Partial<Pick<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type">>> & string;
3100
3243
 
3101
- export declare const Checkout: ({ customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, promoCode, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
3244
+ export declare const Checkout: ({ collectTaxId, customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, taxIdValues, onTaxIdChange, onTaxIdBlur, taxIdError, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, promoCode, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
3102
3245
 
3103
3246
  /**
3104
3247
  * Host-provided initial values used to pre-populate the checkout payment form.
@@ -3225,10 +3368,15 @@ export declare interface CheckoutPrefill {
3225
3368
  }
3226
3369
 
3227
3370
  declare interface CheckoutProps {
3371
+ collectTaxId?: boolean;
3228
3372
  customCheckoutFields?: CheckoutFieldWithValue[];
3229
3373
  customFieldValues: Record<string, string>;
3230
3374
  isPaymentMethodRequired: boolean;
3231
3375
  onCustomFieldChange: (fieldId: string, value: string) => void;
3376
+ taxIdValues?: TaxIdValues;
3377
+ onTaxIdChange?: (value: TaxIdValues) => void;
3378
+ onTaxIdBlur?: () => void;
3379
+ taxIdError?: string;
3232
3380
  optInRequired: boolean;
3233
3381
  optInTitle?: string | null;
3234
3382
  optInText?: string | null;
@@ -4056,6 +4204,12 @@ declare interface CompanyPlanCreditGrantView {
4056
4204
  * @memberof CompanyPlanCreditGrantView
4057
4205
  */
4058
4206
  companyAutoTopupThresholdCredits?: number | null;
4207
+ /**
4208
+ *
4209
+ * @type {number}
4210
+ * @memberof CompanyPlanCreditGrantView
4211
+ */
4212
+ companyCreditAmount: number;
4059
4213
  /**
4060
4214
  *
4061
4215
  * @type {Date}
@@ -4125,6 +4279,12 @@ declare interface CompanyPlanCreditGrantView {
4125
4279
  * @memberof CompanyPlanCreditGrantView
4126
4280
  */
4127
4281
  id: string;
4282
+ /**
4283
+ *
4284
+ * @type {string}
4285
+ * @memberof CompanyPlanCreditGrantView
4286
+ */
4287
+ licenseId?: string | null;
4128
4288
  /**
4129
4289
  *
4130
4290
  * @type {GenericPreviewObject}
@@ -4174,6 +4334,12 @@ declare interface CompanyPlanCreditGrantView {
4174
4334
  * @memberof CompanyPlanCreditGrantView
4175
4335
  */
4176
4336
  rolloverPercentage: number;
4337
+ /**
4338
+ *
4339
+ * @type {PlanCreditGrantScaling}
4340
+ * @memberof CompanyPlanCreditGrantView
4341
+ */
4342
+ scaling: PlanCreditGrantScaling;
4177
4343
  /**
4178
4344
  * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
4179
4345
  * @type {string}
@@ -4232,6 +4398,12 @@ declare interface CompanyPlanDetailResponseData {
4232
4398
  * @memberof CompanyPlanDetailResponseData
4233
4399
  */
4234
4400
  billingStrategy: BillingStrategy;
4401
+ /**
4402
+ *
4403
+ * @type {Array<PlanCatalogMembershipResponseData>}
4404
+ * @memberof CompanyPlanDetailResponseData
4405
+ */
4406
+ catalogs?: Array<PlanCatalogMembershipResponseData>;
4235
4407
  /**
4236
4408
  *
4237
4409
  * @type {ChargeType}
@@ -4384,12 +4556,12 @@ declare interface CompanyPlanDetailResponseData {
4384
4556
  */
4385
4557
  isDefault: boolean;
4386
4558
  /**
4387
- * Deprecated: Use BillingStrategy instead
4559
+ * Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed.
4388
4560
  * @type {boolean}
4389
4561
  * @memberof CompanyPlanDetailResponseData
4390
4562
  * @deprecated
4391
4563
  */
4392
- isFree: boolean;
4564
+ isFree?: boolean | null;
4393
4565
  /**
4394
4566
  *
4395
4567
  * @type {boolean}
@@ -4653,6 +4825,55 @@ declare interface CompanySubscriptionResponseData {
4653
4825
  trialEnd?: Date | null;
4654
4826
  }
4655
4827
 
4828
+ /**
4829
+ * Schematic API
4830
+ * Schematic API
4831
+ *
4832
+ * The version of the OpenAPI document: 0.1
4833
+ *
4834
+ *
4835
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4836
+ * https://openapi-generator.tech
4837
+ * Do not edit the class manually.
4838
+ */
4839
+ /**
4840
+ *
4841
+ * @export
4842
+ * @interface CompanyTaxIDView
4843
+ */
4844
+ declare interface CompanyTaxIDView {
4845
+ /**
4846
+ *
4847
+ * @type {string}
4848
+ * @memberof CompanyTaxIDView
4849
+ */
4850
+ country: string;
4851
+ /**
4852
+ *
4853
+ * @type {string}
4854
+ * @memberof CompanyTaxIDView
4855
+ */
4856
+ id: string;
4857
+ /**
4858
+ *
4859
+ * @type {string}
4860
+ * @memberof CompanyTaxIDView
4861
+ */
4862
+ type: string;
4863
+ /**
4864
+ *
4865
+ * @type {string}
4866
+ * @memberof CompanyTaxIDView
4867
+ */
4868
+ value: string;
4869
+ /**
4870
+ *
4871
+ * @type {string}
4872
+ * @memberof CompanyTaxIDView
4873
+ */
4874
+ verificationStatus?: string | null;
4875
+ }
4876
+
4656
4877
  /**
4657
4878
  *
4658
4879
  * @export
@@ -4811,17 +5032,6 @@ declare interface ComponentCapabilities_2 {
4811
5032
  checkout: boolean;
4812
5033
  }
4813
5034
 
4814
- /**
4815
- * Schematic API
4816
- * Schematic API
4817
- *
4818
- * The version of the OpenAPI document: 0.1
4819
- *
4820
- *
4821
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4822
- * https://openapi-generator.tech
4823
- * Do not edit the class manually.
4824
- */
4825
5035
  /**
4826
5036
  *
4827
5037
  * @export
@@ -4846,6 +5056,18 @@ declare interface ComponentCheckoutSettings {
4846
5056
  * @memberof ComponentCheckoutSettings
4847
5057
  */
4848
5058
  collectPhone: boolean;
5059
+ /**
5060
+ *
5061
+ * @type {boolean}
5062
+ * @memberof ComponentCheckoutSettings
5063
+ */
5064
+ collectTaxId: boolean;
5065
+ /**
5066
+ *
5067
+ * @type {ProrationBehavior}
5068
+ * @memberof ComponentCheckoutSettings
5069
+ */
5070
+ prorationBehavior: ProrationBehavior;
4849
5071
  /**
4850
5072
  *
4851
5073
  * @type {boolean}
@@ -5167,6 +5389,12 @@ declare interface ComponentResponseData {
5167
5389
  ast?: {
5168
5390
  [key: string]: number;
5169
5391
  };
5392
+ /**
5393
+ *
5394
+ * @type {string}
5395
+ * @memberof ComponentResponseData
5396
+ */
5397
+ catalogId?: string | null;
5170
5398
  /**
5171
5399
  *
5172
5400
  * @type {Date}
@@ -5447,6 +5675,12 @@ declare interface CreditCompanyGrantView {
5447
5675
  * @memberof CreditCompanyGrantView
5448
5676
  */
5449
5677
  companyId: string;
5678
+ /**
5679
+ *
5680
+ * @type {string}
5681
+ * @memberof CreditCompanyGrantView
5682
+ */
5683
+ companyLicenseId?: string | null;
5450
5684
  /**
5451
5685
  *
5452
5686
  * @type {string}
@@ -5525,6 +5759,12 @@ declare interface CreditCompanyGrantView {
5525
5759
  * @memberof CreditCompanyGrantView
5526
5760
  */
5527
5761
  id: string;
5762
+ /**
5763
+ *
5764
+ * @type {string}
5765
+ * @memberof CreditCompanyGrantView
5766
+ */
5767
+ licenseName?: string | null;
5528
5768
  /**
5529
5769
  *
5530
5770
  * @type {string}
@@ -5984,6 +6224,12 @@ declare interface CustomPlanBillingResponseData {
5984
6224
  * @memberof CustomPlanBillingResponseData
5985
6225
  */
5986
6226
  publishedAt?: Date | null;
6227
+ /**
6228
+ *
6229
+ * @type {boolean}
6230
+ * @memberof CustomPlanBillingResponseData
6231
+ */
6232
+ sendInvoice: boolean;
5987
6233
  /**
5988
6234
  *
5989
6235
  * @type {CustomPlanBillingStatus}
@@ -6457,6 +6703,8 @@ export declare interface EmbedContextProps extends EmbedState {
6457
6703
  finishCheckout: (changeSubscriptionRequestBody: CheckoutResponseData) => void;
6458
6704
  unsubscribe: () => DebouncedApiPromise<CheckoutUnsubscribeResponse>;
6459
6705
  updateCustomFieldValues: (values: Record<string, string>) => Promise<void> | undefined;
6706
+ updateTaxId: (taxId: TaxIDInput) => Promise<UpdateCheckoutTaxIDResponse | undefined>;
6707
+ getTaxId: () => Promise<GetCheckoutTaxIDResponse | undefined>;
6460
6708
  setAccessToken: (token: string) => void;
6461
6709
  setError: (error: Error) => void;
6462
6710
  setLayout: (layout: EmbedLayout) => void;
@@ -6480,7 +6728,7 @@ export declare interface EmbedProps {
6480
6728
  accessToken?: string;
6481
6729
  }
6482
6730
 
6483
- export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, checkoutPrefill, ...options }: EmbedProviderProps) => JSX.Element;
6731
+ export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, warningThresholdConfig, checkoutPrefill, ...options }: EmbedProviderProps) => JSX.Element;
6484
6732
 
6485
6733
  export declare interface EmbedProviderProps {
6486
6734
  children: React.ReactNode;
@@ -6494,6 +6742,12 @@ export declare interface EmbedProviderProps {
6494
6742
  * ISO-4217 codes; case-insensitive. Omit to disable filtering.
6495
6743
  */
6496
6744
  currencyFilter?: string[];
6745
+ /**
6746
+ * Controls how entitlement warning thresholds are displayed across components.
6747
+ * Set `{ showAsLimit: true }` to display the configured warning threshold in
6748
+ * place of an entitlement's hard limit. Omit to keep the default behavior.
6749
+ */
6750
+ warningThresholdConfig?: WarningThresholdConfig;
6497
6751
  checkoutPrefill?: CheckoutPrefill;
6498
6752
  }
6499
6753
 
@@ -6516,6 +6770,7 @@ export declare interface EmbedState {
6516
6770
  layout: EmbedLayout;
6517
6771
  checkoutState?: CheckoutState;
6518
6772
  currencyFilter?: string[];
6773
+ warningThresholdConfig?: WarningThresholdConfig;
6519
6774
  checkoutPrefill?: CheckoutPrefill;
6520
6775
  }
6521
6776
 
@@ -7173,6 +7428,12 @@ declare interface FeatureEntitlement {
7173
7428
  * @memberof FeatureEntitlement
7174
7429
  */
7175
7430
  valueType: EntitlementValueType;
7431
+ /**
7432
+ * Customer-defined usage warning thresholds configured on this entitlement
7433
+ * @type {Array<WarningTier>}
7434
+ * @memberof FeatureEntitlement
7435
+ */
7436
+ warningTiers?: Array<WarningTier>;
7176
7437
  }
7177
7438
 
7178
7439
  /**
@@ -7235,6 +7496,12 @@ declare interface FeatureInPlanResponseData {
7235
7496
  * @memberof FeatureInPlanResponseData
7236
7497
  */
7237
7498
  id: string;
7499
+ /**
7500
+ * The license sold through this feature. Set only on features of type license, and created automatically with them.
7501
+ * @type {string}
7502
+ * @memberof FeatureInPlanResponseData
7503
+ */
7504
+ licenseId?: string | null;
7238
7505
  /**
7239
7506
  *
7240
7507
  * @type {FeatureLifecyclePhase}
@@ -7289,6 +7556,12 @@ declare interface FeatureInPlanResponseData {
7289
7556
  * @memberof FeatureInPlanResponseData
7290
7557
  */
7291
7558
  updatedAt: Date;
7559
+ /**
7560
+ * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
7561
+ * @type {string}
7562
+ * @memberof FeatureInPlanResponseData
7563
+ */
7564
+ usageLimitTraitId?: string | null;
7292
7565
  }
7293
7566
 
7294
7567
  /**
@@ -7351,6 +7624,12 @@ declare interface FeatureInPlanResponseData_2 {
7351
7624
  * @memberof FeatureInPlanResponseData
7352
7625
  */
7353
7626
  id: string;
7627
+ /**
7628
+ * The license sold through this feature. Set only on features of type license, and created automatically with them.
7629
+ * @type {string}
7630
+ * @memberof FeatureInPlanResponseData
7631
+ */
7632
+ licenseId?: string | null;
7354
7633
  /**
7355
7634
  *
7356
7635
  * @type {FeatureLifecyclePhase}
@@ -7405,6 +7684,12 @@ declare interface FeatureInPlanResponseData_2 {
7405
7684
  * @memberof FeatureInPlanResponseData
7406
7685
  */
7407
7686
  updatedAt: Date;
7687
+ /**
7688
+ * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
7689
+ * @type {string}
7690
+ * @memberof FeatureInPlanResponseData
7691
+ */
7692
+ usageLimitTraitId?: string | null;
7408
7693
  }
7409
7694
 
7410
7695
  /**
@@ -7485,6 +7770,12 @@ declare interface FeatureResponseData {
7485
7770
  * @memberof FeatureResponseData
7486
7771
  */
7487
7772
  id: string;
7773
+ /**
7774
+ * The license sold through this feature. Set only on features of type license, and created automatically with them.
7775
+ * @type {string}
7776
+ * @memberof FeatureResponseData
7777
+ */
7778
+ licenseId?: string | null;
7488
7779
  /**
7489
7780
  *
7490
7781
  * @type {FeatureLifecyclePhase}
@@ -7527,6 +7818,12 @@ declare interface FeatureResponseData {
7527
7818
  * @memberof FeatureResponseData
7528
7819
  */
7529
7820
  updatedAt: Date;
7821
+ /**
7822
+ * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
7823
+ * @type {string}
7824
+ * @memberof FeatureResponseData
7825
+ */
7826
+ usageLimitTraitId?: string | null;
7530
7827
  }
7531
7828
 
7532
7829
  /**
@@ -7571,6 +7868,12 @@ declare interface FeatureResponseData_2 {
7571
7868
  * @memberof FeatureResponseData
7572
7869
  */
7573
7870
  id: string;
7871
+ /**
7872
+ * The license sold through this feature. Set only on features of type license, and created automatically with them.
7873
+ * @type {string}
7874
+ * @memberof FeatureResponseData
7875
+ */
7876
+ licenseId?: string | null;
7574
7877
  /**
7575
7878
  *
7576
7879
  * @type {FeatureLifecyclePhase}
@@ -7613,6 +7916,12 @@ declare interface FeatureResponseData_2 {
7613
7916
  * @memberof FeatureResponseData
7614
7917
  */
7615
7918
  updatedAt: Date;
7919
+ /**
7920
+ * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
7921
+ * @type {string}
7922
+ * @memberof FeatureResponseData
7923
+ */
7924
+ usageLimitTraitId?: string | null;
7616
7925
  }
7617
7926
 
7618
7927
  /**
@@ -7622,6 +7931,7 @@ declare interface FeatureResponseData_2 {
7622
7931
  declare const FeatureType: {
7623
7932
  readonly Boolean: "boolean";
7624
7933
  readonly Event: "event";
7934
+ readonly License: "license";
7625
7935
  readonly Trait: "trait";
7626
7936
  };
7627
7937
 
@@ -7634,6 +7944,7 @@ declare type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
7634
7944
  declare const FeatureType_2: {
7635
7945
  readonly Boolean: "boolean";
7636
7946
  readonly Event: "event";
7947
+ readonly License: "license";
7637
7948
  readonly Trait: "trait";
7638
7949
  };
7639
7950
 
@@ -8331,15 +8642,35 @@ declare interface GenericPreviewObject_2 {
8331
8642
  /**
8332
8643
  *
8333
8644
  * @export
8334
- * @interface GetSetupIntentResponse
8645
+ * @interface GetCheckoutTaxIDResponse
8335
8646
  */
8336
- declare interface GetSetupIntentResponse {
8647
+ declare interface GetCheckoutTaxIDResponse {
8337
8648
  /**
8338
8649
  *
8339
- * @type {SetupIntentResponseData}
8340
- * @memberof GetSetupIntentResponse
8650
+ * @type {UpdateCheckoutTaxIDResponseData}
8651
+ * @memberof GetCheckoutTaxIDResponse
8341
8652
  */
8342
- data: SetupIntentResponseData;
8653
+ data: UpdateCheckoutTaxIDResponseData;
8654
+ /**
8655
+ * Input parameters
8656
+ * @type {object}
8657
+ * @memberof GetCheckoutTaxIDResponse
8658
+ */
8659
+ params: object;
8660
+ }
8661
+
8662
+ /**
8663
+ *
8664
+ * @export
8665
+ * @interface GetSetupIntentResponse
8666
+ */
8667
+ declare interface GetSetupIntentResponse {
8668
+ /**
8669
+ *
8670
+ * @type {SetupIntentResponseData}
8671
+ * @memberof GetSetupIntentResponse
8672
+ */
8673
+ data: SetupIntentResponseData;
8343
8674
  /**
8344
8675
  * Input parameters
8345
8676
  * @type {object}
@@ -8412,6 +8743,8 @@ export declare const initialContext: {
8412
8743
  checkout: () => never;
8413
8744
  unsubscribe: () => never;
8414
8745
  updateCustomFieldValues: () => never;
8746
+ updateTaxId: () => never;
8747
+ getTaxId: () => never;
8415
8748
  setError: () => never;
8416
8749
  setAccessToken: () => never;
8417
8750
  setLayout: () => never;
@@ -8432,6 +8765,7 @@ export declare const initialContext: {
8432
8765
  layout: EmbedLayout;
8433
8766
  checkoutState?: CheckoutState;
8434
8767
  currencyFilter?: string[];
8768
+ warningThresholdConfig?: WarningThresholdConfig;
8435
8769
  checkoutPrefill?: CheckoutPrefill;
8436
8770
  };
8437
8771
 
@@ -9016,6 +9350,90 @@ export declare const Plan: ({ portal, isLoading, plans, selectedPlan, period, se
9016
9350
 
9017
9351
  declare type Plan_2 = CompanyPlanDetailResponseData;
9018
9352
 
9353
+ /**
9354
+ * Schematic API
9355
+ * Schematic API
9356
+ *
9357
+ * The version of the OpenAPI document: 0.1
9358
+ *
9359
+ *
9360
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9361
+ * https://openapi-generator.tech
9362
+ * Do not edit the class manually.
9363
+ */
9364
+ /**
9365
+ *
9366
+ * @export
9367
+ * @interface PlanCatalogMembershipResponseData
9368
+ */
9369
+ declare interface PlanCatalogMembershipResponseData {
9370
+ /**
9371
+ *
9372
+ * @type {string}
9373
+ * @memberof PlanCatalogMembershipResponseData
9374
+ */
9375
+ id: string;
9376
+ /**
9377
+ *
9378
+ * @type {string}
9379
+ * @memberof PlanCatalogMembershipResponseData
9380
+ */
9381
+ name: string;
9382
+ }
9383
+
9384
+ /**
9385
+ * Schematic API
9386
+ * Schematic API
9387
+ *
9388
+ * The version of the OpenAPI document: 0.1
9389
+ *
9390
+ *
9391
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9392
+ * https://openapi-generator.tech
9393
+ * Do not edit the class manually.
9394
+ */
9395
+ /**
9396
+ *
9397
+ * @export
9398
+ * @interface PlanCatalogMembershipResponseData
9399
+ */
9400
+ declare interface PlanCatalogMembershipResponseData_2 {
9401
+ /**
9402
+ *
9403
+ * @type {string}
9404
+ * @memberof PlanCatalogMembershipResponseData
9405
+ */
9406
+ id: string;
9407
+ /**
9408
+ *
9409
+ * @type {string}
9410
+ * @memberof PlanCatalogMembershipResponseData
9411
+ */
9412
+ name: string;
9413
+ }
9414
+
9415
+ /**
9416
+ *
9417
+ * @export
9418
+ */
9419
+ declare const PlanCreditGrantScaling: {
9420
+ readonly Fixed: "fixed";
9421
+ readonly PerLicense: "per_license";
9422
+ };
9423
+
9424
+ declare type PlanCreditGrantScaling = (typeof PlanCreditGrantScaling)[keyof typeof PlanCreditGrantScaling];
9425
+
9426
+ /**
9427
+ *
9428
+ * @export
9429
+ */
9430
+ declare const PlanCreditGrantScaling_2: {
9431
+ readonly Fixed: "fixed";
9432
+ readonly PerLicense: "per_license";
9433
+ };
9434
+
9435
+ declare type PlanCreditGrantScaling_2 = (typeof PlanCreditGrantScaling_2)[keyof typeof PlanCreditGrantScaling_2];
9436
+
9019
9437
  /**
9020
9438
  *
9021
9439
  * @export
@@ -9088,6 +9506,12 @@ declare interface PlanCreditGrantView {
9088
9506
  * @memberof PlanCreditGrantView
9089
9507
  */
9090
9508
  billingCreditCanBuyBundles: boolean;
9509
+ /**
9510
+ *
9511
+ * @type {number}
9512
+ * @memberof PlanCreditGrantView
9513
+ */
9514
+ companyCreditAmount: number;
9091
9515
  /**
9092
9516
  *
9093
9517
  * @type {Date}
@@ -9157,6 +9581,12 @@ declare interface PlanCreditGrantView {
9157
9581
  * @memberof PlanCreditGrantView
9158
9582
  */
9159
9583
  id: string;
9584
+ /**
9585
+ *
9586
+ * @type {string}
9587
+ * @memberof PlanCreditGrantView
9588
+ */
9589
+ licenseId?: string | null;
9160
9590
  /**
9161
9591
  *
9162
9592
  * @type {GenericPreviewObject}
@@ -9206,6 +9636,12 @@ declare interface PlanCreditGrantView {
9206
9636
  * @memberof PlanCreditGrantView
9207
9637
  */
9208
9638
  rolloverPercentage: number;
9639
+ /**
9640
+ *
9641
+ * @type {PlanCreditGrantScaling}
9642
+ * @memberof PlanCreditGrantView
9643
+ */
9644
+ scaling: PlanCreditGrantScaling;
9209
9645
  /**
9210
9646
  * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
9211
9647
  * @type {string}
@@ -9293,6 +9729,12 @@ declare interface PlanCreditGrantView_2 {
9293
9729
  * @memberof PlanCreditGrantView
9294
9730
  */
9295
9731
  billingCreditCanBuyBundles: boolean;
9732
+ /**
9733
+ *
9734
+ * @type {number}
9735
+ * @memberof PlanCreditGrantView
9736
+ */
9737
+ companyCreditAmount: number;
9296
9738
  /**
9297
9739
  *
9298
9740
  * @type {Date}
@@ -9362,6 +9804,12 @@ declare interface PlanCreditGrantView_2 {
9362
9804
  * @memberof PlanCreditGrantView
9363
9805
  */
9364
9806
  id: string;
9807
+ /**
9808
+ *
9809
+ * @type {string}
9810
+ * @memberof PlanCreditGrantView
9811
+ */
9812
+ licenseId?: string | null;
9365
9813
  /**
9366
9814
  *
9367
9815
  * @type {GenericPreviewObject}
@@ -9411,6 +9859,12 @@ declare interface PlanCreditGrantView_2 {
9411
9859
  * @memberof PlanCreditGrantView
9412
9860
  */
9413
9861
  rolloverPercentage: number;
9862
+ /**
9863
+ *
9864
+ * @type {PlanCreditGrantScaling}
9865
+ * @memberof PlanCreditGrantView
9866
+ */
9867
+ scaling: PlanCreditGrantScaling_2;
9414
9868
  /**
9415
9869
  * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
9416
9870
  * @type {string}
@@ -9539,6 +9993,12 @@ declare interface PlanDetailResponseData {
9539
9993
  * @memberof PlanDetailResponseData
9540
9994
  */
9541
9995
  billingStrategy: BillingStrategy;
9996
+ /**
9997
+ *
9998
+ * @type {Array<PlanCatalogMembershipResponseData>}
9999
+ * @memberof PlanDetailResponseData
10000
+ */
10001
+ catalogs?: Array<PlanCatalogMembershipResponseData>;
9542
10002
  /**
9543
10003
  *
9544
10004
  * @type {ChargeType}
@@ -9649,12 +10109,12 @@ declare interface PlanDetailResponseData {
9649
10109
  */
9650
10110
  isDefault: boolean;
9651
10111
  /**
9652
- * Deprecated: Use BillingStrategy instead
10112
+ * Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed.
9653
10113
  * @type {boolean}
9654
10114
  * @memberof PlanDetailResponseData
9655
10115
  * @deprecated
9656
10116
  */
9657
- isFree: boolean;
10117
+ isFree?: boolean | null;
9658
10118
  /**
9659
10119
  *
9660
10120
  * @type {boolean}
@@ -10581,6 +11041,12 @@ declare interface PlanViewPublicResponseData {
10581
11041
  * @memberof PlanViewPublicResponseData
10582
11042
  */
10583
11043
  billingStrategy: BillingStrategy_2;
11044
+ /**
11045
+ *
11046
+ * @type {Array<PlanCatalogMembershipResponseData>}
11047
+ * @memberof PlanViewPublicResponseData
11048
+ */
11049
+ catalogs?: Array<PlanCatalogMembershipResponseData_2>;
10584
11050
  /**
10585
11051
  *
10586
11052
  * @type {ChargeType}
@@ -10715,12 +11181,12 @@ declare interface PlanViewPublicResponseData {
10715
11181
  */
10716
11182
  isDefault: boolean;
10717
11183
  /**
10718
- * Deprecated: Use BillingStrategy instead
11184
+ * Deprecated: reports the plan's charge type, not its price. Read the plan's prices to tell whether it costs anything, or billing_strategy to tell how it is billed.
10719
11185
  * @type {boolean}
10720
11186
  * @memberof PlanViewPublicResponseData
10721
11187
  * @deprecated
10722
11188
  */
10723
- isFree: boolean;
11189
+ isFree?: boolean | null;
10724
11190
  /**
10725
11191
  *
10726
11192
  * @type {boolean}
@@ -11089,6 +11555,91 @@ declare interface PreviewSubscriptionChangeResponseData {
11089
11555
  usageViolations: Array<FeatureUsageResponseData>;
11090
11556
  }
11091
11557
 
11558
+ /**
11559
+ * Schematic API
11560
+ * Schematic API
11561
+ *
11562
+ * The version of the OpenAPI document: 0.1
11563
+ *
11564
+ *
11565
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11566
+ * https://openapi-generator.tech
11567
+ * Do not edit the class manually.
11568
+ */
11569
+ /**
11570
+ *
11571
+ * @export
11572
+ * @interface PreviewSubscriptionDiscountResponseData
11573
+ */
11574
+ declare interface PreviewSubscriptionDiscountResponseData {
11575
+ /**
11576
+ *
11577
+ * @type {number}
11578
+ * @memberof PreviewSubscriptionDiscountResponseData
11579
+ */
11580
+ amountOff?: number | null;
11581
+ /**
11582
+ *
11583
+ * @type {string}
11584
+ * @memberof PreviewSubscriptionDiscountResponseData
11585
+ */
11586
+ couponName: string;
11587
+ /**
11588
+ *
11589
+ * @type {string}
11590
+ * @memberof PreviewSubscriptionDiscountResponseData
11591
+ */
11592
+ currency?: string | null;
11593
+ /**
11594
+ *
11595
+ * @type {string}
11596
+ * @memberof PreviewSubscriptionDiscountResponseData
11597
+ */
11598
+ customerFacingCode?: string | null;
11599
+ /**
11600
+ *
11601
+ * @type {string}
11602
+ * @memberof PreviewSubscriptionDiscountResponseData
11603
+ */
11604
+ duration: string;
11605
+ /**
11606
+ *
11607
+ * @type {number}
11608
+ * @memberof PreviewSubscriptionDiscountResponseData
11609
+ */
11610
+ durationInMonths?: number | null;
11611
+ /**
11612
+ *
11613
+ * @type {Date}
11614
+ * @memberof PreviewSubscriptionDiscountResponseData
11615
+ */
11616
+ endedAt?: Date | null;
11617
+ /**
11618
+ *
11619
+ * @type {boolean}
11620
+ * @memberof PreviewSubscriptionDiscountResponseData
11621
+ */
11622
+ isActive: boolean;
11623
+ /**
11624
+ *
11625
+ * @type {number}
11626
+ * @memberof PreviewSubscriptionDiscountResponseData
11627
+ */
11628
+ percentOff?: number | null;
11629
+ /**
11630
+ *
11631
+ * @type {string}
11632
+ * @memberof PreviewSubscriptionDiscountResponseData
11633
+ */
11634
+ promoCodeExternalId?: string | null;
11635
+ /**
11636
+ *
11637
+ * @type {Date}
11638
+ * @memberof PreviewSubscriptionDiscountResponseData
11639
+ */
11640
+ startedAt: Date;
11641
+ }
11642
+
11092
11643
  /**
11093
11644
  *
11094
11645
  * @export
@@ -11101,6 +11652,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
11101
11652
  * @memberof PreviewSubscriptionFinanceResponseData
11102
11653
  */
11103
11654
  amountOff: number;
11655
+ /**
11656
+ *
11657
+ * @type {Array<PreviewSubscriptionDiscountResponseData>}
11658
+ * @memberof PreviewSubscriptionFinanceResponseData
11659
+ */
11660
+ discounts: Array<PreviewSubscriptionDiscountResponseData>;
11104
11661
  /**
11105
11662
  *
11106
11663
  * @type {number}
@@ -11254,6 +11811,17 @@ export declare interface ProgressBarProps extends React.ComponentPropsWithoutRef
11254
11811
 
11255
11812
  export declare const progressColorMap: ("blue" | "red" | "yellow")[];
11256
11813
 
11814
+ /**
11815
+ *
11816
+ * @export
11817
+ */
11818
+ declare const ProrationBehavior: {
11819
+ readonly CreateProrations: "create_prorations";
11820
+ readonly InvoiceImmediately: "invoice_immediately";
11821
+ };
11822
+
11823
+ declare type ProrationBehavior = (typeof ProrationBehavior)[keyof typeof ProrationBehavior];
11824
+
11257
11825
  /**
11258
11826
  *
11259
11827
  * @export
@@ -12183,6 +12751,84 @@ export declare const stub: () => never;
12183
12751
 
12184
12752
  export declare const StyledCard: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
12185
12753
 
12754
+ /**
12755
+ *
12756
+ * @export
12757
+ * @interface TaxIDInput
12758
+ */
12759
+ declare interface TaxIDInput {
12760
+ /**
12761
+ *
12762
+ * @type {TaxIdType}
12763
+ * @memberof TaxIDInput
12764
+ */
12765
+ type: TaxIdType;
12766
+ /**
12767
+ *
12768
+ * @type {string}
12769
+ * @memberof TaxIDInput
12770
+ */
12771
+ value: string;
12772
+ }
12773
+
12774
+ /**
12775
+ *
12776
+ * @export
12777
+ */
12778
+ declare const TaxIdType: {
12779
+ readonly AeTrn: "ae_trn";
12780
+ readonly AuAbn: "au_abn";
12781
+ readonly AuArn: "au_arn";
12782
+ readonly BrCnpj: "br_cnpj";
12783
+ readonly BrCpf: "br_cpf";
12784
+ readonly CaBn: "ca_bn";
12785
+ readonly CaGstHst: "ca_gst_hst";
12786
+ readonly CaPstBc: "ca_pst_bc";
12787
+ readonly CaPstMb: "ca_pst_mb";
12788
+ readonly CaPstSk: "ca_pst_sk";
12789
+ readonly CaQst: "ca_qst";
12790
+ readonly ChUid: "ch_uid";
12791
+ readonly ChVat: "ch_vat";
12792
+ readonly EuVat: "eu_vat";
12793
+ readonly GbVat: "gb_vat";
12794
+ readonly HkBr: "hk_br";
12795
+ readonly IdNpwp: "id_npwp";
12796
+ readonly IlVat: "il_vat";
12797
+ readonly InGst: "in_gst";
12798
+ readonly JpCn: "jp_cn";
12799
+ readonly JpRn: "jp_rn";
12800
+ readonly JpTrn: "jp_trn";
12801
+ readonly KrBrn: "kr_brn";
12802
+ readonly MxRfc: "mx_rfc";
12803
+ readonly MyFrp: "my_frp";
12804
+ readonly MyItn: "my_itn";
12805
+ readonly MySst: "my_sst";
12806
+ readonly NoVat: "no_vat";
12807
+ readonly NzGst: "nz_gst";
12808
+ readonly PhTin: "ph_tin";
12809
+ readonly SaVat: "sa_vat";
12810
+ readonly SgGst: "sg_gst";
12811
+ readonly SgUen: "sg_uen";
12812
+ readonly ThVat: "th_vat";
12813
+ readonly TrTin: "tr_tin";
12814
+ readonly TwVat: "tw_vat";
12815
+ readonly UsEin: "us_ein";
12816
+ readonly ZaVat: "za_vat";
12817
+ };
12818
+
12819
+ declare type TaxIdType = (typeof TaxIdType)[keyof typeof TaxIdType];
12820
+
12821
+ /**
12822
+ * TaxIdValues is the form-state shape the tax-ID field group reads and writes.
12823
+ * `country` narrows the picker; `type` is the Stripe tax-ID type actually
12824
+ * submitted; `value` is the ID itself.
12825
+ */
12826
+ declare type TaxIdValues = {
12827
+ country: string;
12828
+ type: string;
12829
+ value: string;
12830
+ };
12831
+
12186
12832
  declare const Text_2: IStyledComponentBase<"web", FastOmit<FastOmit<FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, keyof ClassAttributes<HTMLSpanElement> | keyof HTMLAttributes<HTMLSpanElement>> & ClassAttributes<HTMLSpanElement> & HTMLAttributes<HTMLSpanElement>, keyof TextProps> & TextProps, "tabIndex"> & Partial<Pick<FastOmit<FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, keyof ClassAttributes<HTMLSpanElement> | keyof HTMLAttributes<HTMLSpanElement>> & ClassAttributes<HTMLSpanElement> & HTMLAttributes<HTMLSpanElement>, keyof TextProps> & TextProps, "tabIndex">>> & string;
12187
12833
  export { Text_2 as Text }
12188
12834
 
@@ -12461,6 +13107,40 @@ declare interface UpdateAutoTopupOverrideRequestBody {
12461
13107
  planCreditGrantId: string;
12462
13108
  }
12463
13109
 
13110
+ /**
13111
+ *
13112
+ * @export
13113
+ * @interface UpdateCheckoutTaxIDResponse
13114
+ */
13115
+ declare interface UpdateCheckoutTaxIDResponse {
13116
+ /**
13117
+ *
13118
+ * @type {UpdateCheckoutTaxIDResponseData}
13119
+ * @memberof UpdateCheckoutTaxIDResponse
13120
+ */
13121
+ data: UpdateCheckoutTaxIDResponseData;
13122
+ /**
13123
+ * Input parameters
13124
+ * @type {object}
13125
+ * @memberof UpdateCheckoutTaxIDResponse
13126
+ */
13127
+ params: object;
13128
+ }
13129
+
13130
+ /**
13131
+ *
13132
+ * @export
13133
+ * @interface UpdateCheckoutTaxIDResponseData
13134
+ */
13135
+ declare interface UpdateCheckoutTaxIDResponseData {
13136
+ /**
13137
+ *
13138
+ * @type {Array<CompanyTaxIDView>}
13139
+ * @memberof UpdateCheckoutTaxIDResponseData
13140
+ */
13141
+ taxIds: Array<CompanyTaxIDView>;
13142
+ }
13143
+
12464
13144
  /**
12465
13145
  * Schematic API
12466
13146
  * Schematic API
@@ -12709,6 +13389,52 @@ export declare interface ViewportProps extends React.HTMLProps<HTMLDivElement> {
12709
13389
  portal?: HTMLElement | null;
12710
13390
  }
12711
13391
 
13392
+ /**
13393
+ * Consumer-level configuration for how entitlement warning thresholds are
13394
+ * displayed. Set once at the EmbedProvider (`<EmbedProvider
13395
+ * warningThresholdConfig={{ showAsLimit: true }} />`) and read by any element
13396
+ * that renders an entitlement limit.
13397
+ */
13398
+ export declare interface WarningThresholdConfig {
13399
+ /**
13400
+ * When true, display an entitlement's configured warning threshold in place of
13401
+ * its hard limit (the advertised number in a fair-use setup). Falls back to the
13402
+ * hard limit for entitlements without a threshold. Defaults to false.
13403
+ */
13404
+ showAsLimit?: boolean;
13405
+ }
13406
+
13407
+ /**
13408
+ * Schematic API
13409
+ * Schematic API
13410
+ *
13411
+ * The version of the OpenAPI document: 0.1
13412
+ *
13413
+ *
13414
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
13415
+ * https://openapi-generator.tech
13416
+ * Do not edit the class manually.
13417
+ */
13418
+ /**
13419
+ *
13420
+ * @export
13421
+ * @interface WarningTier
13422
+ */
13423
+ declare interface WarningTier {
13424
+ /**
13425
+ * A customer-defined identifier for the warning tier
13426
+ * @type {string}
13427
+ * @memberof WarningTier
13428
+ */
13429
+ key: string;
13430
+ /**
13431
+ * The warning threshold, in the entitlement's usage units
13432
+ * @type {number}
13433
+ * @memberof WarningTier
13434
+ */
13435
+ value: number;
13436
+ }
13437
+
12712
13438
  /**
12713
13439
  * Schematic API
12714
13440
  * Schematic API