@schematichq/schematic-components 2.25.2 → 2.26.0

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;
@@ -4456,6 +4577,18 @@ declare interface CompanyPlanCreditGrantView {
4456
4577
  * @memberof CompanyPlanCreditGrantView
4457
4578
  */
4458
4579
  billingCreditPostpaidRatePerUnitDecimal?: string | null;
4580
+ /**
4581
+ *
4582
+ * @type {BillingPlanCreditGrantBillingMode}
4583
+ * @memberof CompanyPlanCreditGrantView
4584
+ */
4585
+ billingMode: BillingPlanCreditGrantBillingMode;
4586
+ /**
4587
+ *
4588
+ * @type {string}
4589
+ * @memberof CompanyPlanCreditGrantView
4590
+ */
4591
+ billingProductPriceId?: string | null;
4459
4592
  /**
4460
4593
  *
4461
4594
  * @type {number}
@@ -4580,6 +4713,12 @@ declare interface CompanyPlanCreditGrantView {
4580
4713
  * @deprecated
4581
4714
  */
4582
4715
  pluralName?: string | null;
4716
+ /**
4717
+ *
4718
+ * @type {BillingPriceView}
4719
+ * @memberof CompanyPlanCreditGrantView
4720
+ */
4721
+ price?: BillingPriceView;
4583
4722
  /**
4584
4723
  *
4585
4724
  * @type {BillingPlanCreditGrantResetCadence}
@@ -7113,7 +7252,7 @@ export declare interface EmbedProps {
7113
7252
  accessToken?: string;
7114
7253
  }
7115
7254
 
7116
- export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, warningThresholdConfig, checkoutPrefill, ...options }: EmbedProviderProps) => JSX.Element;
7255
+ export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, warningThresholdConfig, checkoutPrefill, i18n, translations, locale, ...options }: EmbedProviderProps) => JSX.Element;
7117
7256
 
7118
7257
  export declare interface EmbedProviderProps {
7119
7258
  children: React.ReactNode;
@@ -7134,6 +7273,22 @@ export declare interface EmbedProviderProps {
7134
7273
  */
7135
7274
  warningThresholdConfig?: WarningThresholdConfig;
7136
7275
  checkoutPrefill?: CheckoutPrefill;
7276
+ /**
7277
+ * The host's own i18next instance (v21 or later). The components read from
7278
+ * its `schematic` namespace in its current language, and fall back to
7279
+ * `translations`, then English, for any key it lacks.
7280
+ */
7281
+ i18n?: SchematicI18nInstance;
7282
+ /**
7283
+ * Translation bundles keyed by language (e.g. `{ it: {...} }`), for a host
7284
+ * without its own i18next instance. Any key left out falls back to English.
7285
+ */
7286
+ translations?: Record<string, SchematicTranslations>;
7287
+ /**
7288
+ * BCP 47 tag for the components' language and for number, currency, and
7289
+ * date formatting. Defaults to the `i18n` instance's language, else `en-US`.
7290
+ */
7291
+ locale?: string;
7137
7292
  }
7138
7293
 
7139
7294
  export declare type EmbedSettings = {
@@ -7169,6 +7324,302 @@ export declare interface EmbedState {
7169
7324
  checkoutPrefill?: CheckoutPrefill;
7170
7325
  }
7171
7326
 
7327
+ /**
7328
+ * The English bundle: the keys the components translate, and the fallback
7329
+ * for any key a translation leaves out.
7330
+ */
7331
+ declare const en: {
7332
+ "A problem occurred while saving your payment method.": string;
7333
+ "Access to plan will end.": string;
7334
+ Active: string;
7335
+ Add: string;
7336
+ "Add new payment method": string;
7337
+ "Add More": string;
7338
+ "Additional information": string;
7339
+ "Add-ons": string;
7340
+ "Add-ons Quantity": string;
7341
+ Additional: string;
7342
+ "Adds X tokens when Y remaining in balance": string;
7343
+ "After the trial, cancel no default": string;
7344
+ "After the trial, cancel": string;
7345
+ "After the trial, subscribe": string;
7346
+ Agreement: string;
7347
+ "Applied balance towards next invoice": string;
7348
+ "Discount for months_one": string;
7349
+ "Discount for months_other": string;
7350
+ "Auto Top-up": string;
7351
+ "Auto top-up enabled": string;
7352
+ "Auto top-up disabled": string;
7353
+ "Auto top-up disabled for token": string;
7354
+ "Automatically purchase more credits when your balance is low": string;
7355
+ at: string;
7356
+ "When balance reaches X remaining, an auto top-up of Y credits will be processed.": string;
7357
+ "An invoice is created when charges reach $X; the rest is billed monthly.": string;
7358
+ "An unknown error occurred.": string;
7359
+ Billed: string;
7360
+ "Bundle selected": string;
7361
+ "Buy credits": string;
7362
+ Cancel: string;
7363
+ Country: string;
7364
+ "Cancel subscription": string;
7365
+ "Cannot change to this plan.": string;
7366
+ "Cannot downgrade entitlement": string;
7367
+ "Card ending in": string;
7368
+ "Change add-on": string;
7369
+ "Change payment method": string;
7370
+ "Change plan": string;
7371
+ Checkout: string;
7372
+ "Choose add-on": string;
7373
+ "Choose bundle": string;
7374
+ "Choose plan": string;
7375
+ "Choose your base plan": string;
7376
+ "Credit Auto Top-up": string;
7377
+ "Credit bundles": string;
7378
+ Credits: string;
7379
+ "Credits in plan": string;
7380
+ "Credits to be applied to future invoices": string;
7381
+ "Current plan": string;
7382
+ "Current usage exceeds the limit of this plan.": string;
7383
+ "Currently using": string;
7384
+ "Custom plan awaiting payment": string;
7385
+ "Custom plan awaiting payment description": string;
7386
+ "Custom plan payment due": string;
7387
+ "Custom plan payment due description": string;
7388
+ "Custom price": string;
7389
+ Discount: string;
7390
+ "Downgrade to plan scheduled": string;
7391
+ "Due today": string;
7392
+ "Edit payment details": string;
7393
+ Edit: string;
7394
+ "Ends on": string;
7395
+ "Enter discount code": string;
7396
+ "Error initializing payment method change. Please try again.": string;
7397
+ "Error processing payment. Please try a different payment method.": string;
7398
+ "Error retrieving plan details. Please try again in a moment.": string;
7399
+ "Error updating payment method. Please try again.": string;
7400
+ "Estimated bill": string;
7401
+ "Everything in": string;
7402
+ Expired: string;
7403
+ "Expires in X months": string;
7404
+ Expires: string;
7405
+ Free: string;
7406
+ "Hide all": string;
7407
+ "Hide balance details": string;
7408
+ "Hide details": string;
7409
+ "ID type": string;
7410
+ "Ineligible for this discount.": string;
7411
+ "Invalid access token; your temporary access token will start with `token_`.": string;
7412
+ "Invalid discount code.": string;
7413
+ "Invoice credit tooltip": string;
7414
+ "Invoice charge tooltip": string;
7415
+ Invoices: string;
7416
+ "Limit of": string;
7417
+ Loading: string;
7418
+ "Manage plan": string;
7419
+ "Monthly total": string;
7420
+ "Quarterly total": string;
7421
+ Next: string;
7422
+ "No invoices created yet": string;
7423
+ "No limit": string;
7424
+ "No payment method added yet": string;
7425
+ "Not provided": string;
7426
+ "No upcoming invoice": string;
7427
+ "Not ready to cancel?": string;
7428
+ "On demand": string;
7429
+ "One time": string;
7430
+ "One-time charges": string;
7431
+ "Optionally add features to your subscription": string;
7432
+ "Other existing payment method": string;
7433
+ "Over plan limit": string;
7434
+ "Pay-in-advance features require a quantity.": string;
7435
+ "Error saving custom field values. Please try again.": string;
7436
+ "Pay now": string;
7437
+ "Payment Details": string;
7438
+ "Plan selected": string;
7439
+ "Please accept the agreement to continue.": string;
7440
+ Plan: string;
7441
+ Plans: string;
7442
+ "Please provide an access token.": string;
7443
+ "Powered by": string;
7444
+ "Price by unit based on final tier reached.": string;
7445
+ "Promotional credits": string;
7446
+ Proration: string;
7447
+ Quantity: string;
7448
+ "Quantity to pay for in advance": string;
7449
+ "Remaining balance after next invoice": string;
7450
+ Remove: string;
7451
+ "Remove add-on": string;
7452
+ Resets: string;
7453
+ "Save changes": string;
7454
+ "Save payment method": string;
7455
+ "Save with yearly billing": string;
7456
+ "Saving with yearly billing": string;
7457
+ "Save with quarterly billing": string;
7458
+ "Saving with quarterly billing": string;
7459
+ "See all": string;
7460
+ "See all X": string;
7461
+ "Select ID type": string;
7462
+ "Select country": string;
7463
+ "See balance details": string;
7464
+ "See less": string;
7465
+ "See more": string;
7466
+ "Select add-ons": string;
7467
+ "Select existing payment method": string;
7468
+ "Select payment method": string;
7469
+ "Select plan": string;
7470
+ "Select quantity": string;
7471
+ "Select quantities for add-ons": string;
7472
+ Selected: string;
7473
+ "Selected plan or associated price is missing.": string;
7474
+ "Downgrade not permitted.": string;
7475
+ "Downgrade pending.": string;
7476
+ "Session expired. Please refresh and try again.": string;
7477
+ "Show details": string;
7478
+ "Start trial": string;
7479
+ "Start X day trial": string;
7480
+ "Subscribe and close": string;
7481
+ "Subscription canceled": string;
7482
+ Subscription: string;
7483
+ "Talk to support": string;
7484
+ "Tax (description):": string;
7485
+ "Tax ID": string;
7486
+ "Tax ID format hint": string;
7487
+ "Tax ID save error": string;
7488
+ "There was a problem retrieving your upcoming invoice.": string;
7489
+ "There was a problem retrieving your invoices.": string;
7490
+ "Tier-based": string;
7491
+ "Tiers apply progressively as quantity increases.": string;
7492
+ "Top up balance with:": string;
7493
+ "Top-ups": string;
7494
+ Total: string;
7495
+ "Trial ends in": string;
7496
+ "Trial in progress": string;
7497
+ "Trial selected": string;
7498
+ Trial: string;
7499
+ "Try again": string;
7500
+ Unlimited: string;
7501
+ "Unlimited in this tier": string;
7502
+ "Unable to load payment form.": string;
7503
+ "Unsubscribe failed": string;
7504
+ Unsubscribe: string;
7505
+ "Unused time": string;
7506
+ "Up to X units": string;
7507
+ "Up to X units per period": string;
7508
+ "Up to a limit of": string;
7509
+ "Up to X units at $Y/unit": string;
7510
+ "Up to X units at $Y/unit + $Z/period": string;
7511
+ "Up to X units for $Y/period": string;
7512
+ "Up to X units for free": string;
7513
+ "Up to X units in this tier": string;
7514
+ "Usage-based": string;
7515
+ "Use existing payment method": string;
7516
+ "When balance reaches:": string;
7517
+ "X additional": string;
7518
+ "X included": string;
7519
+ "X item auto-topup": string;
7520
+ "X item bundle": string;
7521
+ "X item grant": string;
7522
+ "X items included in plan": string;
7523
+ "X off": string;
7524
+ "X% off": string;
7525
+ "X units": string;
7526
+ "X units remaining": string;
7527
+ "X units used": string;
7528
+ "X units per use": string;
7529
+ "X credits per license": string;
7530
+ "X credits per license per period": string;
7531
+ "Plus X credits per period": string;
7532
+ "Plus X credits per period for your company": string;
7533
+ "Includes X credits per license": string;
7534
+ "X licenses times Y credits": string;
7535
+ "X licenses times Y credits plus company": string;
7536
+ "Credits included": string;
7537
+ "Your plan includes credits": string;
7538
+ "credit composition per license": string;
7539
+ "credit composition company grant": string;
7540
+ "Renews on the day": string;
7541
+ "Adding licenses grants more credits today": string;
7542
+ "Your full credits renew on the day": string;
7543
+ "Your credit grant increases on the day": string;
7544
+ "Includes X credits per period": string;
7545
+ "Plus X credits today": string;
7546
+ "Plus X credits on the day": string;
7547
+ "X time left in trial": string;
7548
+ "Yearly total": string;
7549
+ "You will be billed": string;
7550
+ "You will be billed with discount window": string;
7551
+ "You will be billed next bill discount": string;
7552
+ "plus usage based costs": string;
7553
+ "on the day": string;
7554
+ "of month": string;
7555
+ "for the next months_one": string;
7556
+ "for the next months_other": string;
7557
+ "You will be downgraded at the end of your billing period.": string;
7558
+ "You will retain access to your plan until the end of the billing period, on": string;
7559
+ "$X per unit": string;
7560
+ "$X per Y units": string;
7561
+ "$X/unit/period": string;
7562
+ "$X/Y units/period": string;
7563
+ day: string;
7564
+ month: string;
7565
+ quarter: string;
7566
+ year: string;
7567
+ mo: string;
7568
+ qtr: string;
7569
+ yr: string;
7570
+ "one time": string;
7571
+ "billing period": string;
7572
+ "expires after purchase": string;
7573
+ "expires at the end of the billing period": string;
7574
+ "expires at the end of the next billing period": string;
7575
+ "expires at the end of the trial": string;
7576
+ Ordinal_ordinal_one: string;
7577
+ Ordinal_ordinal_two: string;
7578
+ Ordinal_ordinal_few: string;
7579
+ Ordinal_ordinal_other: string;
7580
+ per: string;
7581
+ then: string;
7582
+ use: string;
7583
+ used: string;
7584
+ license: string;
7585
+ "month, billed yearly": string;
7586
+ "month, billed quarterly": string;
7587
+ purchased: string;
7588
+ "Usage by user": string;
7589
+ "X used by your team this period": string;
7590
+ "Show all X users_one": string;
7591
+ "Show all X users_other": string;
7592
+ "Show top X users_one": string;
7593
+ "Show top X users_other": string;
7594
+ "Show all": string;
7595
+ "Show fewer": string;
7596
+ Unattributed: string;
7597
+ "There was a problem retrieving usage by user.": string;
7598
+ "plus X more_one": string;
7599
+ "plus X more_other": string;
7600
+ "usage.limited": string;
7601
+ "usage.unlimited": string;
7602
+ "Apply discount": string;
7603
+ "Buy More": string;
7604
+ "Choose different payment method": string;
7605
+ "Downgrade pending. Cancel the scheduled downgrade before making another change.": string;
7606
+ "Error deleting payment method. Please try again.": string;
7607
+ "for cost": string;
7608
+ "Invalid currency filter: {{entries}}": string;
7609
+ "No supported currencies are available.": string;
7610
+ "No {{currency}} price for the {{period}} billing period.": string;
7611
+ "Optionally add credit bundles to your subscription": string;
7612
+ "Quantity is required.": string;
7613
+ "Schedule downgrade": string;
7614
+ "Select credits": string;
7615
+ "Set default": string;
7616
+ "This plan is not available in the selected currency and period.": string;
7617
+ Tier: string;
7618
+ "your plan": string;
7619
+ "Included features": string;
7620
+ "Next bill due": string;
7621
+ };
7622
+
7172
7623
  export declare const Entitlement: ({ portal, entitlement, period, credits, currency: selectedCurrency, }: EntitlementProps) => JSX.Element;
7173
7624
 
7174
7625
  /**
@@ -8866,7 +9317,7 @@ declare interface FormatInvoiceOptions {
8866
9317
  hideUpcoming?: boolean;
8867
9318
  }
8868
9319
 
8869
- export declare function formatInvoices(invoices?: InvoiceResponseData[], options?: FormatInvoiceOptions): {
9320
+ export declare function formatInvoices(invoices: InvoiceResponseData[] | undefined, locale: string, options?: FormatInvoiceOptions): {
8870
9321
  amount: string;
8871
9322
  amountDue: number;
8872
9323
  date: string;
@@ -9345,6 +9796,12 @@ declare interface InvoiceResponseData {
9345
9796
  * @memberof InvoiceResponseData
9346
9797
  */
9347
9798
  subtotal: number;
9799
+ /**
9800
+ * 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.
9801
+ * @type {number}
9802
+ * @memberof InvoiceResponseData
9803
+ */
9804
+ total?: number | null;
9348
9805
  /**
9349
9806
  *
9350
9807
  * @type {Date}
@@ -9394,6 +9851,9 @@ export declare enum LeadingName {
9394
9851
 
9395
9852
  export declare type LeadingNameType = `${LeadingName}`;
9396
9853
 
9854
+ /** Matches i18next's own listener type, so its `on` overloads line up. */
9855
+ declare type Listener = (...args: any[]) => void;
9856
+
9397
9857
  /**
9398
9858
  * Schematic API
9399
9859
  * Schematic API
@@ -9958,6 +10418,18 @@ declare interface PlanCreditGrantView {
9958
10418
  * @memberof PlanCreditGrantView
9959
10419
  */
9960
10420
  billingCreditPostpaidRatePerUnitDecimal?: string | null;
10421
+ /**
10422
+ *
10423
+ * @type {BillingPlanCreditGrantBillingMode}
10424
+ * @memberof PlanCreditGrantView
10425
+ */
10426
+ billingMode: BillingPlanCreditGrantBillingMode;
10427
+ /**
10428
+ *
10429
+ * @type {string}
10430
+ * @memberof PlanCreditGrantView
10431
+ */
10432
+ billingProductPriceId?: string | null;
9961
10433
  /**
9962
10434
  *
9963
10435
  * @type {number}
@@ -10064,6 +10536,12 @@ declare interface PlanCreditGrantView {
10064
10536
  * @deprecated
10065
10537
  */
10066
10538
  pluralName?: string | null;
10539
+ /**
10540
+ *
10541
+ * @type {BillingPriceView}
10542
+ * @memberof PlanCreditGrantView
10543
+ */
10544
+ price?: BillingPriceView;
10067
10545
  /**
10068
10546
  *
10069
10547
  * @type {BillingPlanCreditGrantResetCadence}
@@ -10217,6 +10695,18 @@ declare interface PlanCreditGrantView_2 {
10217
10695
  * @memberof PlanCreditGrantView
10218
10696
  */
10219
10697
  billingCreditPostpaidRatePerUnitDecimal?: string | null;
10698
+ /**
10699
+ *
10700
+ * @type {BillingPlanCreditGrantBillingMode}
10701
+ * @memberof PlanCreditGrantView
10702
+ */
10703
+ billingMode: BillingPlanCreditGrantBillingMode_2;
10704
+ /**
10705
+ *
10706
+ * @type {string}
10707
+ * @memberof PlanCreditGrantView
10708
+ */
10709
+ billingProductPriceId?: string | null;
10220
10710
  /**
10221
10711
  *
10222
10712
  * @type {number}
@@ -10323,6 +10813,12 @@ declare interface PlanCreditGrantView_2 {
10323
10813
  * @deprecated
10324
10814
  */
10325
10815
  pluralName?: string | null;
10816
+ /**
10817
+ *
10818
+ * @type {BillingPriceView}
10819
+ * @memberof PlanCreditGrantView
10820
+ */
10821
+ price?: BillingPriceView_2;
10326
10822
  /**
10327
10823
  *
10328
10824
  * @type {BillingPlanCreditGrantResetCadence}
@@ -10755,6 +11251,18 @@ declare interface PlanEntitlementResponseData {
10755
11251
  * @memberof PlanEntitlementResponseData
10756
11252
  */
10757
11253
  metricPeriodMonthReset?: MetricPeriodMonthReset | null;
11254
+ /**
11255
+ * 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.
11256
+ * @type {BillingArrearsCadence}
11257
+ * @memberof PlanEntitlementResponseData
11258
+ */
11259
+ overageBillingCadence?: BillingArrearsCadence | null;
11260
+ /**
11261
+ * 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.
11262
+ * @type {BillingArrearsAnchor}
11263
+ * @memberof PlanEntitlementResponseData
11264
+ */
11265
+ overageInvoiceAnchor?: BillingArrearsAnchor | null;
10758
11266
  /**
10759
11267
  *
10760
11268
  * @type {PlanResponseData}
@@ -10804,7 +11312,7 @@ declare interface PlanEntitlementResponseData {
10804
11312
  */
10805
11313
  usageBasedProduct?: BillingProductResponseData;
10806
11314
  /**
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.
11315
+ * 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
11316
  * @type {number}
10809
11317
  * @memberof PlanEntitlementResponseData
10810
11318
  */
@@ -10943,6 +11451,18 @@ declare interface PlanEntitlementResponseData_2 {
10943
11451
  * @memberof PlanEntitlementResponseData
10944
11452
  */
10945
11453
  metricPeriodMonthReset?: MetricPeriodMonthReset_2 | null;
11454
+ /**
11455
+ * 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.
11456
+ * @type {BillingArrearsCadence}
11457
+ * @memberof PlanEntitlementResponseData
11458
+ */
11459
+ overageBillingCadence?: BillingArrearsCadence_2 | null;
11460
+ /**
11461
+ * 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.
11462
+ * @type {BillingArrearsAnchor}
11463
+ * @memberof PlanEntitlementResponseData
11464
+ */
11465
+ overageInvoiceAnchor?: BillingArrearsAnchor_2 | null;
10946
11466
  /**
10947
11467
  *
10948
11468
  * @type {PlanResponseData}
@@ -10992,7 +11512,7 @@ declare interface PlanEntitlementResponseData_2 {
10992
11512
  */
10993
11513
  usageBasedProduct?: BillingProductResponseData_2;
10994
11514
  /**
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.
11515
+ * 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
11516
  * @type {number}
10997
11517
  * @memberof PlanEntitlementResponseData
10998
11518
  */
@@ -11737,6 +12257,9 @@ declare interface PlanViewPublicResponseData {
11737
12257
  yearlyPrice?: BillingPriceResponseData_2;
11738
12258
  }
11739
12259
 
12260
+ /** The i18next plural suffixes, cardinal and ordinal. */
12261
+ declare type PluralSuffix = `_${"ordinal_" | ""}${"zero" | "one" | "two" | "few" | "many" | "other"}`;
12262
+
11740
12263
  export declare type Position = "top" | "right" | "bottom" | "left";
11741
12264
 
11742
12265
  /**
@@ -13219,8 +13742,49 @@ declare interface ScheduledDowngradeResponseData {
13219
13742
  toPlanName: string;
13220
13743
  }
13221
13744
 
13745
+ /**
13746
+ * The namespace the components read from. A host passing its own i18next
13747
+ * instance puts its translations of the components here, so our keys never
13748
+ * collide with its own.
13749
+ */
13750
+ export declare const SCHEMATIC_NAMESPACE = "schematic";
13751
+
13222
13752
  export declare const SchematicEmbed: ({ id, accessToken }: EmbedProps) => JSX.Element;
13223
13753
 
13754
+ /**
13755
+ * The parts of an i18next instance the components use, so a host on any
13756
+ * i18next from v21 on can pass its own without a type clash against the
13757
+ * version bundled here.
13758
+ */
13759
+ export declare interface SchematicI18nInstance {
13760
+ language: string;
13761
+ resolvedLanguage?: string;
13762
+ t(key: string, options?: Record<string, unknown>): string;
13763
+ exists(key: string, options?: Record<string, unknown>): boolean;
13764
+ on(event: string, listener: Listener): void;
13765
+ off(event: string, listener: Listener): void;
13766
+ store?: {
13767
+ on(event: string, listener: Listener): void;
13768
+ off(event: string, listener: Listener): void;
13769
+ };
13770
+ }
13771
+
13772
+ /**
13773
+ * A key the components translate. Plural keys appear once, without their
13774
+ * suffix, since the components look them up by the bare key and a `count`.
13775
+ */
13776
+ export declare type SchematicTranslationKey = StripPlural<BundleKey>;
13777
+
13778
+ /**
13779
+ * A translation bundle for the components, keyed by the English bundle's
13780
+ * keys. Plural keys take i18next's suffixes (`_one`, `_other`, and so on), and
13781
+ * any key left out falls back to English.
13782
+ */
13783
+ export declare type SchematicTranslations = Partial<Record<BundleKey | `${SchematicTranslationKey}${PluralSuffix}`, string>>;
13784
+
13785
+ /** The English bundle, for a host to translate from. */
13786
+ export declare const schematicTranslationsEn: Readonly<SchematicTranslations>;
13787
+
13224
13788
  export declare const Selected: ({ isCurrent, isTrial, }: SelectedProps) => JSX.Element;
13225
13789
 
13226
13790
  declare type SelectedPlan = Plan_2 & {
@@ -13354,6 +13918,8 @@ declare interface StripeEmbedInfo {
13354
13918
  setupIntentClientSecret?: string | null;
13355
13919
  }
13356
13920
 
13921
+ declare type StripPlural<K> = K extends `${infer Base}${PluralSuffix}` ? Base : K;
13922
+
13357
13923
  export declare const stub: () => never;
13358
13924
 
13359
13925
  export declare const StyledCard: IStyledComponentBase<"web", Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "style"> & {
@@ -13746,6 +14312,12 @@ declare interface UpcomingInvoiceResponseData {
13746
14312
  * @memberof UpcomingInvoiceResponseData
13747
14313
  */
13748
14314
  subtotal: number;
14315
+ /**
14316
+ * Amount after discounts and tax, before applying the customer balance. Null when the provider has not reported it.
14317
+ * @type {number}
14318
+ * @memberof UpcomingInvoiceResponseData
14319
+ */
14320
+ total?: number | null;
13749
14321
  /**
13750
14322
  *
13751
14323
  * @type {Date}
@@ -14013,7 +14585,7 @@ declare interface UsageBasedEntitlementResponseData {
14013
14585
  */
14014
14586
  quarterlyUsageBasedPrice?: BillingPriceView;
14015
14587
  /**
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.
14588
+ * 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
14589
  * @type {number}
14018
14590
  * @memberof UsageBasedEntitlementResponseData
14019
14591
  */