@schematichq/schematic-components 2.25.2 → 2.27.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.
@@ -80,6 +80,7 @@ declare type BillingArrearsAnchor_2 = (typeof BillingArrearsAnchor_2)[keyof type
80
80
  declare const BillingArrearsCadence: {
81
81
  readonly EndOfBillingPeriod: "end_of_billing_period";
82
82
  readonly Monthly: "monthly";
83
+ readonly Quarterly: "quarterly";
83
84
  };
84
85
 
85
86
  declare type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof BillingArrearsCadence];
@@ -91,6 +92,7 @@ declare type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof
91
92
  declare const BillingArrearsCadence_2: {
92
93
  readonly EndOfBillingPeriod: "end_of_billing_period";
93
94
  readonly Monthly: "monthly";
95
+ readonly Quarterly: "quarterly";
94
96
  };
95
97
 
96
98
  declare type BillingArrearsCadence_2 = (typeof BillingArrearsCadence_2)[keyof typeof BillingArrearsCadence_2];
@@ -370,6 +372,9 @@ declare const BillingCreditGrantReason: {
370
372
  readonly BillingCreditAutoTopup: "billing_credit_auto_topup";
371
373
  readonly Free: "free";
372
374
  readonly Plan: "plan";
375
+ readonly PostpaidForgiven: "postpaid_forgiven";
376
+ readonly PostpaidOverdraft: "postpaid_overdraft";
377
+ readonly PostpaidSettlement: "postpaid_settlement";
373
378
  readonly Purchased: "purchased";
374
379
  readonly Rollover: "rollover";
375
380
  };
@@ -483,6 +488,12 @@ declare interface BillingCreditResponseData {
483
488
  * @memberof BillingCreditResponseData
484
489
  */
485
490
  id: string;
491
+ /**
492
+ *
493
+ * @type {BillingCreditLedgerAuthority}
494
+ * @memberof BillingCreditResponseData
495
+ */
496
+ ledgerAuthority: BillingCreditLedgerAuthority;
486
497
  /**
487
498
  *
488
499
  * @type {string}
@@ -587,6 +598,12 @@ declare interface BillingCreditResponseData_2 {
587
598
  * @memberof BillingCreditResponseData
588
599
  */
589
600
  id: string;
601
+ /**
602
+ *
603
+ * @type {BillingCreditLedgerAuthority}
604
+ * @memberof BillingCreditResponseData
605
+ */
606
+ ledgerAuthority: BillingCreditLedgerAuthority_2;
590
607
  /**
591
608
  *
592
609
  * @type {string}
@@ -969,6 +986,71 @@ declare interface BillingLinkedResourceResponseData_2 {
969
986
  originator: BillingProviderType_2;
970
987
  }
971
988
 
989
+ /**
990
+ *
991
+ * @export
992
+ */
993
+ declare const BillingPlanCreditGrantBillingMode: {
994
+ readonly Granted: "granted";
995
+ readonly Billed: "billed";
996
+ };
997
+
998
+ declare type BillingPlanCreditGrantBillingMode = (typeof BillingPlanCreditGrantBillingMode)[keyof typeof BillingPlanCreditGrantBillingMode];
999
+
1000
+ /**
1001
+ *
1002
+ * @export
1003
+ */
1004
+ declare const BillingPlanCreditGrantBillingMode_2: {
1005
+ readonly Granted: "granted";
1006
+ readonly Billed: "billed";
1007
+ };
1008
+
1009
+ declare type BillingPlanCreditGrantBillingMode_2 = (typeof BillingPlanCreditGrantBillingMode_2)[keyof typeof BillingPlanCreditGrantBillingMode_2];
1010
+
1011
+ /**
1012
+ * Schematic API
1013
+ * Schematic API
1014
+ *
1015
+ * The version of the OpenAPI document: 0.1
1016
+ *
1017
+ *
1018
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1019
+ * https://openapi-generator.tech
1020
+ * Do not edit the class manually.
1021
+ */
1022
+ /**
1023
+ *
1024
+ * @export
1025
+ * @interface BillingPlanCreditGrantPriceTierResponseData
1026
+ */
1027
+ declare interface BillingPlanCreditGrantPriceTierResponseData {
1028
+ /**
1029
+ * Lower bound of the tier, in credits per invoice (inclusive).
1030
+ * @type {number}
1031
+ * @memberof BillingPlanCreditGrantPriceTierResponseData
1032
+ */
1033
+ from: number;
1034
+ /**
1035
+ * Price per credit in this tier, in the plan currency's smallest unit.
1036
+ * @type {number}
1037
+ * @memberof BillingPlanCreditGrantPriceTierResponseData
1038
+ */
1039
+ perUnitPrice?: number | null;
1040
+ /**
1041
+ * Price per credit in this tier as a decimal, for rates below one cent.
1042
+ * @type {string}
1043
+ * @memberof BillingPlanCreditGrantPriceTierResponseData
1044
+ */
1045
+ perUnitPriceDecimal?: string | null;
1046
+ /**
1047
+ * Upper bound of the tier, in credits per invoice (inclusive). Null marks the final, unbounded tier.
1048
+ * @type {number}
1049
+ * @memberof BillingPlanCreditGrantPriceTierResponseData
1050
+ */
1051
+ to?: number | null;
1052
+ }
1053
+
972
1054
  /**
973
1055
  *
974
1056
  * @export
@@ -1123,6 +1205,12 @@ declare interface BillingPlanCreditGrantResponseData {
1123
1205
  * @memberof BillingPlanCreditGrantResponseData
1124
1206
  */
1125
1207
  autoTopupThresholdPercent?: number | null;
1208
+ /**
1209
+ * Whether the credits are included in the plan price (granted) or billed as their own subscription line at a price per credit (billed).
1210
+ * @type {BillingPlanCreditGrantBillingMode}
1211
+ * @memberof BillingPlanCreditGrantResponseData
1212
+ */
1213
+ billingMode: BillingPlanCreditGrantBillingMode;
1126
1214
  /**
1127
1215
  * Deprecated: bundle availability is a per-bundle plan compatibility set now; use compatible_plan_ids on credit bundles instead.
1128
1216
  * @type {boolean}
@@ -1260,6 +1348,18 @@ declare interface BillingPlanCreditGrantResponseData {
1260
1348
  * @memberof BillingPlanCreditGrantResponseData
1261
1349
  */
1262
1350
  postpaidRatePerUnitDecimal?: string | null;
1351
+ /**
1352
+ * The Stripe price a billed grant bills through. Minted when the plan version is published.
1353
+ * @type {BillingPriceResponseData}
1354
+ * @memberof BillingPlanCreditGrantResponseData
1355
+ */
1356
+ price?: BillingPriceResponseData;
1357
+ /**
1358
+ * Tier table pricing the credits, cheapest bound first. Empty unless billing_mode is billed and the credits are priced on tiers.
1359
+ * @type {Array<BillingPlanCreditGrantPriceTierResponseData>}
1360
+ * @memberof BillingPlanCreditGrantResponseData
1361
+ */
1362
+ priceTiers: Array<BillingPlanCreditGrantPriceTierResponseData>;
1263
1363
  /**
1264
1364
  *
1265
1365
  * @type {BillingPlanCreditGrantResetCadence}
@@ -1290,6 +1390,24 @@ declare interface BillingPlanCreditGrantResponseData {
1290
1390
  * @memberof BillingPlanCreditGrantResponseData
1291
1391
  */
1292
1392
  scaling: PlanCreditGrantScaling;
1393
+ /**
1394
+ * How price_tiers apply: volume prices every credit at the rate of the tier the total lands in, graduated prices each tier's own credits at its own rate. Set only when price_tiers is non-empty.
1395
+ * @type {BillingTiersMode}
1396
+ * @memberof BillingPlanCreditGrantResponseData
1397
+ */
1398
+ tierMode?: BillingTiersMode | null;
1399
+ /**
1400
+ * Price per credit in the plan currency's smallest unit. Set only when billing_mode is billed and the credits are priced at one rate.
1401
+ * @type {number}
1402
+ * @memberof BillingPlanCreditGrantResponseData
1403
+ */
1404
+ unitPrice?: number | null;
1405
+ /**
1406
+ * Price per credit as a decimal in the plan currency's smallest unit. Set only when billing_mode is billed and the rate is below one cent.
1407
+ * @type {string}
1408
+ * @memberof BillingPlanCreditGrantResponseData
1409
+ */
1410
+ unitPriceDecimal?: string | null;
1293
1411
  /**
1294
1412
  *
1295
1413
  * @type {Date}
@@ -3005,6 +3123,9 @@ export declare type BoxProps = ComponentProps & {
3005
3123
  };
3006
3124
  };
3007
3125
 
3126
+ /** Every key in the English bundle, plural forms included. */
3127
+ declare type BundleKey = keyof typeof en;
3128
+
3008
3129
  export declare const Button: IStyledComponentBase<"web", Merged<Omit<DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "style"> & {
3009
3130
  style?: CSSProperties | CSSPropertiesWithVars | undefined;
3010
3131
  }, ButtonProps>> & string;
@@ -3259,6 +3380,12 @@ declare interface ChangeSubscriptionRequestBody {
3259
3380
  * @memberof ChangeSubscriptionRequestBody
3260
3381
  */
3261
3382
  creditBundles: Array<UpdateCreditBundleRequestBody>;
3383
+ /**
3384
+ * ISO 4217 currency this cart is being built in. Prices are still selected by id; this records the intent, and a cart that prices in another currency is reported as a problem.
3385
+ * @type {string}
3386
+ * @memberof ChangeSubscriptionRequestBody
3387
+ */
3388
+ currency?: string | null;
3262
3389
  /**
3263
3390
  *
3264
3391
  * @type {Array<CheckoutFieldValue>}
@@ -4456,6 +4583,18 @@ declare interface CompanyPlanCreditGrantView {
4456
4583
  * @memberof CompanyPlanCreditGrantView
4457
4584
  */
4458
4585
  billingCreditPostpaidRatePerUnitDecimal?: string | null;
4586
+ /**
4587
+ *
4588
+ * @type {BillingPlanCreditGrantBillingMode}
4589
+ * @memberof CompanyPlanCreditGrantView
4590
+ */
4591
+ billingMode: BillingPlanCreditGrantBillingMode;
4592
+ /**
4593
+ *
4594
+ * @type {string}
4595
+ * @memberof CompanyPlanCreditGrantView
4596
+ */
4597
+ billingProductPriceId?: string | null;
4459
4598
  /**
4460
4599
  *
4461
4600
  * @type {number}
@@ -4580,6 +4719,12 @@ declare interface CompanyPlanCreditGrantView {
4580
4719
  * @deprecated
4581
4720
  */
4582
4721
  pluralName?: string | null;
4722
+ /**
4723
+ *
4724
+ * @type {BillingPriceView}
4725
+ * @memberof CompanyPlanCreditGrantView
4726
+ */
4727
+ price?: BillingPriceView;
4583
4728
  /**
4584
4729
  *
4585
4730
  * @type {BillingPlanCreditGrantResetCadence}
@@ -7113,7 +7258,7 @@ export declare interface EmbedProps {
7113
7258
  accessToken?: string;
7114
7259
  }
7115
7260
 
7116
- export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, warningThresholdConfig, checkoutPrefill, ...options }: EmbedProviderProps) => JSX.Element;
7261
+ export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, warningThresholdConfig, checkoutPrefill, i18n, translations, locale, ...options }: EmbedProviderProps) => JSX.Element;
7117
7262
 
7118
7263
  export declare interface EmbedProviderProps {
7119
7264
  children: React.ReactNode;
@@ -7134,6 +7279,22 @@ export declare interface EmbedProviderProps {
7134
7279
  */
7135
7280
  warningThresholdConfig?: WarningThresholdConfig;
7136
7281
  checkoutPrefill?: CheckoutPrefill;
7282
+ /**
7283
+ * The host's own i18next instance (v21 or later). The components read from
7284
+ * its `schematic` namespace in its current language, and fall back to
7285
+ * `translations`, then English, for any key it lacks.
7286
+ */
7287
+ i18n?: SchematicI18nInstance;
7288
+ /**
7289
+ * Translation bundles keyed by language (e.g. `{ it: {...} }`), for a host
7290
+ * without its own i18next instance. Any key left out falls back to English.
7291
+ */
7292
+ translations?: Record<string, SchematicTranslations>;
7293
+ /**
7294
+ * BCP 47 tag for the components' language and for number, currency, and
7295
+ * date formatting. Defaults to the `i18n` instance's language, else `en-US`.
7296
+ */
7297
+ locale?: string;
7137
7298
  }
7138
7299
 
7139
7300
  export declare type EmbedSettings = {
@@ -7169,6 +7330,302 @@ export declare interface EmbedState {
7169
7330
  checkoutPrefill?: CheckoutPrefill;
7170
7331
  }
7171
7332
 
7333
+ /**
7334
+ * The English bundle: the keys the components translate, and the fallback
7335
+ * for any key a translation leaves out.
7336
+ */
7337
+ declare const en: {
7338
+ "A problem occurred while saving your payment method.": string;
7339
+ "Access to plan will end.": string;
7340
+ Active: string;
7341
+ Add: string;
7342
+ "Add new payment method": string;
7343
+ "Add More": string;
7344
+ "Additional information": string;
7345
+ "Add-ons": string;
7346
+ "Add-ons Quantity": string;
7347
+ Additional: string;
7348
+ "Adds X tokens when Y remaining in balance": string;
7349
+ "After the trial, cancel no default": string;
7350
+ "After the trial, cancel": string;
7351
+ "After the trial, subscribe": string;
7352
+ Agreement: string;
7353
+ "Applied balance towards next invoice": string;
7354
+ "Discount for months_one": string;
7355
+ "Discount for months_other": string;
7356
+ "Auto Top-up": string;
7357
+ "Auto top-up enabled": string;
7358
+ "Auto top-up disabled": string;
7359
+ "Auto top-up disabled for token": string;
7360
+ "Automatically purchase more credits when your balance is low": string;
7361
+ at: string;
7362
+ "When balance reaches X remaining, an auto top-up of Y credits will be processed.": string;
7363
+ "An invoice is created when charges reach $X; the rest is billed monthly.": string;
7364
+ "An unknown error occurred.": string;
7365
+ Billed: string;
7366
+ "Bundle selected": string;
7367
+ "Buy credits": string;
7368
+ Cancel: string;
7369
+ Country: string;
7370
+ "Cancel subscription": string;
7371
+ "Cannot change to this plan.": string;
7372
+ "Cannot downgrade entitlement": string;
7373
+ "Card ending in": string;
7374
+ "Change add-on": string;
7375
+ "Change payment method": string;
7376
+ "Change plan": string;
7377
+ Checkout: string;
7378
+ "Choose add-on": string;
7379
+ "Choose bundle": string;
7380
+ "Choose plan": string;
7381
+ "Choose your base plan": string;
7382
+ "Credit Auto Top-up": string;
7383
+ "Credit bundles": string;
7384
+ Credits: string;
7385
+ "Credits in plan": string;
7386
+ "Credits to be applied to future invoices": string;
7387
+ "Current plan": string;
7388
+ "Current usage exceeds the limit of this plan.": string;
7389
+ "Currently using": string;
7390
+ "Custom plan awaiting payment": string;
7391
+ "Custom plan awaiting payment description": string;
7392
+ "Custom plan payment due": string;
7393
+ "Custom plan payment due description": string;
7394
+ "Custom price": string;
7395
+ Discount: string;
7396
+ "Downgrade to plan scheduled": string;
7397
+ "Due today": string;
7398
+ "Edit payment details": string;
7399
+ Edit: string;
7400
+ "Ends on": string;
7401
+ "Enter discount code": string;
7402
+ "Error initializing payment method change. Please try again.": string;
7403
+ "Error processing payment. Please try a different payment method.": string;
7404
+ "Error retrieving plan details. Please try again in a moment.": string;
7405
+ "Error updating payment method. Please try again.": string;
7406
+ "Estimated bill": string;
7407
+ "Everything in": string;
7408
+ Expired: string;
7409
+ "Expires in X months": string;
7410
+ Expires: string;
7411
+ Free: string;
7412
+ "Hide all": string;
7413
+ "Hide balance details": string;
7414
+ "Hide details": string;
7415
+ "ID type": string;
7416
+ "Ineligible for this discount.": string;
7417
+ "Invalid access token; your temporary access token will start with `token_`.": string;
7418
+ "Invalid discount code.": string;
7419
+ "Invoice credit tooltip": string;
7420
+ "Invoice charge tooltip": string;
7421
+ Invoices: string;
7422
+ "Limit of": string;
7423
+ Loading: string;
7424
+ "Manage plan": string;
7425
+ "Monthly total": string;
7426
+ "Quarterly total": string;
7427
+ Next: string;
7428
+ "No invoices created yet": string;
7429
+ "No limit": string;
7430
+ "No payment method added yet": string;
7431
+ "Not provided": string;
7432
+ "No upcoming invoice": string;
7433
+ "Not ready to cancel?": string;
7434
+ "On demand": string;
7435
+ "One time": string;
7436
+ "One-time charges": string;
7437
+ "Optionally add features to your subscription": string;
7438
+ "Other existing payment method": string;
7439
+ "Over plan limit": string;
7440
+ "Pay-in-advance features require a quantity.": string;
7441
+ "Error saving custom field values. Please try again.": string;
7442
+ "Pay now": string;
7443
+ "Payment Details": string;
7444
+ "Plan selected": string;
7445
+ "Please accept the agreement to continue.": string;
7446
+ Plan: string;
7447
+ Plans: string;
7448
+ "Please provide an access token.": string;
7449
+ "Powered by": string;
7450
+ "Price by unit based on final tier reached.": string;
7451
+ "Promotional credits": string;
7452
+ Proration: string;
7453
+ Quantity: string;
7454
+ "Quantity to pay for in advance": string;
7455
+ "Remaining balance after next invoice": string;
7456
+ Remove: string;
7457
+ "Remove add-on": string;
7458
+ Resets: string;
7459
+ "Save changes": string;
7460
+ "Save payment method": string;
7461
+ "Save with yearly billing": string;
7462
+ "Saving with yearly billing": string;
7463
+ "Save with quarterly billing": string;
7464
+ "Saving with quarterly billing": string;
7465
+ "See all": string;
7466
+ "See all X": string;
7467
+ "Select ID type": string;
7468
+ "Select country": string;
7469
+ "See balance details": string;
7470
+ "See less": string;
7471
+ "See more": string;
7472
+ "Select add-ons": string;
7473
+ "Select existing payment method": string;
7474
+ "Select payment method": string;
7475
+ "Select plan": string;
7476
+ "Select quantity": string;
7477
+ "Select quantities for add-ons": string;
7478
+ Selected: string;
7479
+ "Selected plan or associated price is missing.": string;
7480
+ "Downgrade not permitted.": string;
7481
+ "Downgrade pending.": string;
7482
+ "Session expired. Please refresh and try again.": string;
7483
+ "Show details": string;
7484
+ "Start trial": string;
7485
+ "Start X day trial": string;
7486
+ "Subscribe and close": string;
7487
+ "Subscription canceled": string;
7488
+ Subscription: string;
7489
+ "Talk to support": string;
7490
+ "Tax (description):": string;
7491
+ "Tax ID": string;
7492
+ "Tax ID format hint": string;
7493
+ "Tax ID save error": string;
7494
+ "There was a problem retrieving your upcoming invoice.": string;
7495
+ "There was a problem retrieving your invoices.": string;
7496
+ "Tier-based": string;
7497
+ "Tiers apply progressively as quantity increases.": string;
7498
+ "Top up balance with:": string;
7499
+ "Top-ups": string;
7500
+ Total: string;
7501
+ "Trial ends in": string;
7502
+ "Trial in progress": string;
7503
+ "Trial selected": string;
7504
+ Trial: string;
7505
+ "Try again": string;
7506
+ Unlimited: string;
7507
+ "Unlimited in this tier": string;
7508
+ "Unable to load payment form.": string;
7509
+ "Unsubscribe failed": string;
7510
+ Unsubscribe: string;
7511
+ "Unused time": string;
7512
+ "Up to X units": string;
7513
+ "Up to X units per period": string;
7514
+ "Up to a limit of": string;
7515
+ "Up to X units at $Y/unit": string;
7516
+ "Up to X units at $Y/unit + $Z/period": string;
7517
+ "Up to X units for $Y/period": string;
7518
+ "Up to X units for free": string;
7519
+ "Up to X units in this tier": string;
7520
+ "Usage-based": string;
7521
+ "Use existing payment method": string;
7522
+ "When balance reaches:": string;
7523
+ "X additional": string;
7524
+ "X included": string;
7525
+ "X item auto-topup": string;
7526
+ "X item bundle": string;
7527
+ "X item grant": string;
7528
+ "X items included in plan": string;
7529
+ "X off": string;
7530
+ "X% off": string;
7531
+ "X units": string;
7532
+ "X units remaining": string;
7533
+ "X units used": string;
7534
+ "X units per use": string;
7535
+ "X credits per license": string;
7536
+ "X credits per license per period": string;
7537
+ "Plus X credits per period": string;
7538
+ "Plus X credits per period for your company": string;
7539
+ "Includes X credits per license": string;
7540
+ "X licenses times Y credits": string;
7541
+ "X licenses times Y credits plus company": string;
7542
+ "Credits included": string;
7543
+ "Your plan includes credits": string;
7544
+ "credit composition per license": string;
7545
+ "credit composition company grant": string;
7546
+ "Renews on the day": string;
7547
+ "Adding licenses grants more credits today": string;
7548
+ "Your full credits renew on the day": string;
7549
+ "Your credit grant increases on the day": string;
7550
+ "Includes X credits per period": string;
7551
+ "Plus X credits today": string;
7552
+ "Plus X credits on the day": string;
7553
+ "X time left in trial": string;
7554
+ "Yearly total": string;
7555
+ "You will be billed": string;
7556
+ "You will be billed with discount window": string;
7557
+ "You will be billed next bill discount": string;
7558
+ "plus usage based costs": string;
7559
+ "on the day": string;
7560
+ "of month": string;
7561
+ "for the next months_one": string;
7562
+ "for the next months_other": string;
7563
+ "You will be downgraded at the end of your billing period.": string;
7564
+ "You will retain access to your plan until the end of the billing period, on": string;
7565
+ "$X per unit": string;
7566
+ "$X per Y units": string;
7567
+ "$X/unit/period": string;
7568
+ "$X/Y units/period": string;
7569
+ day: string;
7570
+ month: string;
7571
+ quarter: string;
7572
+ year: string;
7573
+ mo: string;
7574
+ qtr: string;
7575
+ yr: string;
7576
+ "one time": string;
7577
+ "billing period": string;
7578
+ "expires after purchase": string;
7579
+ "expires at the end of the billing period": string;
7580
+ "expires at the end of the next billing period": string;
7581
+ "expires at the end of the trial": string;
7582
+ Ordinal_ordinal_one: string;
7583
+ Ordinal_ordinal_two: string;
7584
+ Ordinal_ordinal_few: string;
7585
+ Ordinal_ordinal_other: string;
7586
+ per: string;
7587
+ then: string;
7588
+ use: string;
7589
+ used: string;
7590
+ license: string;
7591
+ "month, billed yearly": string;
7592
+ "month, billed quarterly": string;
7593
+ purchased: string;
7594
+ "Usage by user": string;
7595
+ "X used by your team this period": string;
7596
+ "Show all X users_one": string;
7597
+ "Show all X users_other": string;
7598
+ "Show top X users_one": string;
7599
+ "Show top X users_other": string;
7600
+ "Show all": string;
7601
+ "Show fewer": string;
7602
+ Unattributed: string;
7603
+ "There was a problem retrieving usage by user.": string;
7604
+ "plus X more_one": string;
7605
+ "plus X more_other": string;
7606
+ "usage.limited": string;
7607
+ "usage.unlimited": string;
7608
+ "Apply discount": string;
7609
+ "Buy More": string;
7610
+ "Choose different payment method": string;
7611
+ "Downgrade pending. Cancel the scheduled downgrade before making another change.": string;
7612
+ "Error deleting payment method. Please try again.": string;
7613
+ "for cost": string;
7614
+ "Invalid currency filter: {{entries}}": string;
7615
+ "No supported currencies are available.": string;
7616
+ "No {{currency}} price for the {{period}} billing period.": string;
7617
+ "Optionally add credit bundles to your subscription": string;
7618
+ "Quantity is required.": string;
7619
+ "Schedule downgrade": string;
7620
+ "Select credits": string;
7621
+ "Set default": string;
7622
+ "This plan is not available in the selected currency and period.": string;
7623
+ Tier: string;
7624
+ "your plan": string;
7625
+ "Included features": string;
7626
+ "Next bill due": string;
7627
+ };
7628
+
7172
7629
  export declare const Entitlement: ({ portal, entitlement, period, credits, currency: selectedCurrency, }: EntitlementProps) => JSX.Element;
7173
7630
 
7174
7631
  /**
@@ -8866,7 +9323,7 @@ declare interface FormatInvoiceOptions {
8866
9323
  hideUpcoming?: boolean;
8867
9324
  }
8868
9325
 
8869
- export declare function formatInvoices(invoices?: InvoiceResponseData[], options?: FormatInvoiceOptions): {
9326
+ export declare function formatInvoices(invoices: InvoiceResponseData[] | undefined, locale: string, options?: FormatInvoiceOptions): {
8870
9327
  amount: string;
8871
9328
  amountDue: number;
8872
9329
  date: string;
@@ -9345,6 +9802,12 @@ declare interface InvoiceResponseData {
9345
9802
  * @memberof InvoiceResponseData
9346
9803
  */
9347
9804
  subtotal: number;
9805
+ /**
9806
+ * Amount after discounts and tax, before applying the customer balance. Null when the provider has not reported it: rows synced before the column existed, or pushed without one.
9807
+ * @type {number}
9808
+ * @memberof InvoiceResponseData
9809
+ */
9810
+ total?: number | null;
9348
9811
  /**
9349
9812
  *
9350
9813
  * @type {Date}
@@ -9394,6 +9857,9 @@ export declare enum LeadingName {
9394
9857
 
9395
9858
  export declare type LeadingNameType = `${LeadingName}`;
9396
9859
 
9860
+ /** Matches i18next's own listener type, so its `on` overloads line up. */
9861
+ declare type Listener = (...args: any[]) => void;
9862
+
9397
9863
  /**
9398
9864
  * Schematic API
9399
9865
  * Schematic API
@@ -9958,6 +10424,18 @@ declare interface PlanCreditGrantView {
9958
10424
  * @memberof PlanCreditGrantView
9959
10425
  */
9960
10426
  billingCreditPostpaidRatePerUnitDecimal?: string | null;
10427
+ /**
10428
+ *
10429
+ * @type {BillingPlanCreditGrantBillingMode}
10430
+ * @memberof PlanCreditGrantView
10431
+ */
10432
+ billingMode: BillingPlanCreditGrantBillingMode;
10433
+ /**
10434
+ *
10435
+ * @type {string}
10436
+ * @memberof PlanCreditGrantView
10437
+ */
10438
+ billingProductPriceId?: string | null;
9961
10439
  /**
9962
10440
  *
9963
10441
  * @type {number}
@@ -10064,6 +10542,12 @@ declare interface PlanCreditGrantView {
10064
10542
  * @deprecated
10065
10543
  */
10066
10544
  pluralName?: string | null;
10545
+ /**
10546
+ *
10547
+ * @type {BillingPriceView}
10548
+ * @memberof PlanCreditGrantView
10549
+ */
10550
+ price?: BillingPriceView;
10067
10551
  /**
10068
10552
  *
10069
10553
  * @type {BillingPlanCreditGrantResetCadence}
@@ -10217,6 +10701,18 @@ declare interface PlanCreditGrantView_2 {
10217
10701
  * @memberof PlanCreditGrantView
10218
10702
  */
10219
10703
  billingCreditPostpaidRatePerUnitDecimal?: string | null;
10704
+ /**
10705
+ *
10706
+ * @type {BillingPlanCreditGrantBillingMode}
10707
+ * @memberof PlanCreditGrantView
10708
+ */
10709
+ billingMode: BillingPlanCreditGrantBillingMode_2;
10710
+ /**
10711
+ *
10712
+ * @type {string}
10713
+ * @memberof PlanCreditGrantView
10714
+ */
10715
+ billingProductPriceId?: string | null;
10220
10716
  /**
10221
10717
  *
10222
10718
  * @type {number}
@@ -10323,6 +10819,12 @@ declare interface PlanCreditGrantView_2 {
10323
10819
  * @deprecated
10324
10820
  */
10325
10821
  pluralName?: string | null;
10822
+ /**
10823
+ *
10824
+ * @type {BillingPriceView}
10825
+ * @memberof PlanCreditGrantView
10826
+ */
10827
+ price?: BillingPriceView_2;
10326
10828
  /**
10327
10829
  *
10328
10830
  * @type {BillingPlanCreditGrantResetCadence}
@@ -10755,6 +11257,18 @@ declare interface PlanEntitlementResponseData {
10755
11257
  * @memberof PlanEntitlementResponseData
10756
11258
  */
10757
11259
  metricPeriodMonthReset?: MetricPeriodMonthReset | null;
11260
+ /**
11261
+ * How often overage charges are assessed and invoiced. Null or end_of_billing_period means the billing provider aggregates usage over the subscription's own period and bills it at period end. Monthly and quarterly mean Schematic assesses the overage each month or quarter and bills it on its own invoice. Only applies to overage price behavior.
11262
+ * @type {BillingArrearsCadence}
11263
+ * @memberof PlanEntitlementResponseData
11264
+ */
11265
+ overageBillingCadence?: BillingArrearsCadence | null;
11266
+ /**
11267
+ * Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end), which for a quarterly window means calendar quarters. Only meaningful when overage_billing_cadence is monthly or quarterly.
11268
+ * @type {BillingArrearsAnchor}
11269
+ * @memberof PlanEntitlementResponseData
11270
+ */
11271
+ overageInvoiceAnchor?: BillingArrearsAnchor | null;
10758
11272
  /**
10759
11273
  *
10760
11274
  * @type {PlanResponseData}
@@ -10804,7 +11318,7 @@ declare interface PlanEntitlementResponseData {
10804
11318
  */
10805
11319
  usageBasedProduct?: BillingProductResponseData;
10806
11320
  /**
10807
- * The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
11321
+ * The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements.
10808
11322
  * @type {number}
10809
11323
  * @memberof PlanEntitlementResponseData
10810
11324
  */
@@ -10943,6 +11457,18 @@ declare interface PlanEntitlementResponseData_2 {
10943
11457
  * @memberof PlanEntitlementResponseData
10944
11458
  */
10945
11459
  metricPeriodMonthReset?: MetricPeriodMonthReset_2 | null;
11460
+ /**
11461
+ * How often overage charges are assessed and invoiced. Null or end_of_billing_period means the billing provider aggregates usage over the subscription's own period and bills it at period end. Monthly and quarterly mean Schematic assesses the overage each month or quarter and bills it on its own invoice. Only applies to overage price behavior.
11462
+ * @type {BillingArrearsCadence}
11463
+ * @memberof PlanEntitlementResponseData
11464
+ */
11465
+ overageBillingCadence?: BillingArrearsCadence_2 | null;
11466
+ /**
11467
+ * Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end), which for a quarterly window means calendar quarters. Only meaningful when overage_billing_cadence is monthly or quarterly.
11468
+ * @type {BillingArrearsAnchor}
11469
+ * @memberof PlanEntitlementResponseData
11470
+ */
11471
+ overageInvoiceAnchor?: BillingArrearsAnchor_2 | null;
10946
11472
  /**
10947
11473
  *
10948
11474
  * @type {PlanResponseData}
@@ -10992,7 +11518,7 @@ declare interface PlanEntitlementResponseData_2 {
10992
11518
  */
10993
11519
  usageBasedProduct?: BillingProductResponseData_2;
10994
11520
  /**
10995
- * The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
11521
+ * The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements.
10996
11522
  * @type {number}
10997
11523
  * @memberof PlanEntitlementResponseData
10998
11524
  */
@@ -11737,6 +12263,9 @@ declare interface PlanViewPublicResponseData {
11737
12263
  yearlyPrice?: BillingPriceResponseData_2;
11738
12264
  }
11739
12265
 
12266
+ /** The i18next plural suffixes, cardinal and ordinal. */
12267
+ declare type PluralSuffix = `_${"ordinal_" | ""}${"zero" | "one" | "two" | "few" | "many" | "other"}`;
12268
+
11740
12269
  export declare type Position = "top" | "right" | "bottom" | "left";
11741
12270
 
11742
12271
  /**
@@ -12140,6 +12669,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
12140
12669
  * @memberof PreviewSubscriptionFinanceResponseData
12141
12670
  */
12142
12671
  amountOff: number;
12672
+ /**
12673
+ * ISO 4217 currency every amount in this block is denominated in.
12674
+ * @type {string}
12675
+ * @memberof PreviewSubscriptionFinanceResponseData
12676
+ */
12677
+ currency: string;
12143
12678
  /**
12144
12679
  *
12145
12680
  * @type {number}
@@ -13219,8 +13754,49 @@ declare interface ScheduledDowngradeResponseData {
13219
13754
  toPlanName: string;
13220
13755
  }
13221
13756
 
13757
+ /**
13758
+ * The namespace the components read from. A host passing its own i18next
13759
+ * instance puts its translations of the components here, so our keys never
13760
+ * collide with its own.
13761
+ */
13762
+ export declare const SCHEMATIC_NAMESPACE = "schematic";
13763
+
13222
13764
  export declare const SchematicEmbed: ({ id, accessToken }: EmbedProps) => JSX.Element;
13223
13765
 
13766
+ /**
13767
+ * The parts of an i18next instance the components use, so a host on any
13768
+ * i18next from v21 on can pass its own without a type clash against the
13769
+ * version bundled here.
13770
+ */
13771
+ export declare interface SchematicI18nInstance {
13772
+ language: string;
13773
+ resolvedLanguage?: string;
13774
+ t(key: string, options?: Record<string, unknown>): string;
13775
+ exists(key: string, options?: Record<string, unknown>): boolean;
13776
+ on(event: string, listener: Listener): void;
13777
+ off(event: string, listener: Listener): void;
13778
+ store?: {
13779
+ on(event: string, listener: Listener): void;
13780
+ off(event: string, listener: Listener): void;
13781
+ };
13782
+ }
13783
+
13784
+ /**
13785
+ * A key the components translate. Plural keys appear once, without their
13786
+ * suffix, since the components look them up by the bare key and a `count`.
13787
+ */
13788
+ export declare type SchematicTranslationKey = StripPlural<BundleKey>;
13789
+
13790
+ /**
13791
+ * A translation bundle for the components, keyed by the English bundle's
13792
+ * keys. Plural keys take i18next's suffixes (`_one`, `_other`, and so on), and
13793
+ * any key left out falls back to English.
13794
+ */
13795
+ export declare type SchematicTranslations = Partial<Record<BundleKey | `${SchematicTranslationKey}${PluralSuffix}`, string>>;
13796
+
13797
+ /** The English bundle, for a host to translate from. */
13798
+ export declare const schematicTranslationsEn: Readonly<SchematicTranslations>;
13799
+
13224
13800
  export declare const Selected: ({ isCurrent, isTrial, }: SelectedProps) => JSX.Element;
13225
13801
 
13226
13802
  declare type SelectedPlan = Plan_2 & {
@@ -13354,6 +13930,8 @@ declare interface StripeEmbedInfo {
13354
13930
  setupIntentClientSecret?: string | null;
13355
13931
  }
13356
13932
 
13933
+ declare type StripPlural<K> = K extends `${infer Base}${PluralSuffix}` ? Base : K;
13934
+
13357
13935
  export declare const stub: () => never;
13358
13936
 
13359
13937
  export declare const StyledCard: IStyledComponentBase<"web", Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "style"> & {
@@ -13746,6 +14324,12 @@ declare interface UpcomingInvoiceResponseData {
13746
14324
  * @memberof UpcomingInvoiceResponseData
13747
14325
  */
13748
14326
  subtotal: number;
14327
+ /**
14328
+ * Amount after discounts and tax, before applying the customer balance. Null when the provider has not reported it.
14329
+ * @type {number}
14330
+ * @memberof UpcomingInvoiceResponseData
14331
+ */
14332
+ total?: number | null;
13749
14333
  /**
13750
14334
  *
13751
14335
  * @type {Date}
@@ -14013,7 +14597,7 @@ declare interface UsageBasedEntitlementResponseData {
14013
14597
  */
14014
14598
  quarterlyUsageBasedPrice?: BillingPriceView;
14015
14599
  /**
14016
- * The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
14600
+ * The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements.
14017
14601
  * @type {number}
14018
14602
  * @memberof UsageBasedEntitlementResponseData
14019
14603
  */