@schematichq/schematic-react 1.16.1 → 1.18.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.
@@ -57,6 +57,8 @@ export declare interface BillingActions {
57
57
  removePaymentMethod(id: string): Promise<void>;
58
58
  /** Mints a new setup intent every call; nothing is cached. */
59
59
  createSetupIntent(): Promise<SetupIntent>;
60
+ /** The current hosted URL for invoice `id`; nothing is cached. */
61
+ fetchInvoiceLink(id: string): Promise<string>;
60
62
  /** Cancels the subscription at period end and reloads what that changes. */
61
63
  unsubscribe(): Promise<void>;
62
64
  /** Sets the company's tax ID and takes the list it answers with. */
@@ -138,6 +140,12 @@ declare namespace billingApi {
138
140
  BillingStrategyToJSON,
139
141
  BillingStrategyToJSONTyped,
140
142
  BillingStrategy,
143
+ instanceOfBillingSubscriptionPauseBehavior,
144
+ BillingSubscriptionPauseBehaviorFromJSON,
145
+ BillingSubscriptionPauseBehaviorFromJSONTyped,
146
+ BillingSubscriptionPauseBehaviorToJSON,
147
+ BillingSubscriptionPauseBehaviorToJSONTyped,
148
+ BillingSubscriptionPauseBehavior,
141
149
  instanceOfBillingSubscriptionTrialEndSetting,
142
150
  BillingSubscriptionTrialEndSettingFromJSON,
143
151
  BillingSubscriptionTrialEndSettingFromJSONTyped,
@@ -666,6 +674,12 @@ declare namespace billingApi {
666
674
  GetCompanyUpcomingInvoiceResponseToJSON,
667
675
  GetCompanyUpcomingInvoiceResponseToJSONTyped,
668
676
  GetCompanyUpcomingInvoiceResponse,
677
+ instanceOfGetInvoiceLinkResponse,
678
+ GetInvoiceLinkResponseFromJSON,
679
+ GetInvoiceLinkResponseFromJSONTyped,
680
+ GetInvoiceLinkResponseToJSON,
681
+ GetInvoiceLinkResponseToJSONTyped,
682
+ GetInvoiceLinkResponse,
669
683
  instanceOfGetPublicCatalogByIDResponse,
670
684
  GetPublicCatalogByIDResponseFromJSON,
671
685
  GetPublicCatalogByIDResponseFromJSONTyped,
@@ -678,6 +692,12 @@ declare namespace billingApi {
678
692
  GetPublicCatalogResponseToJSON,
679
693
  GetPublicCatalogResponseToJSONTyped,
680
694
  GetPublicCatalogResponse,
695
+ instanceOfInvoiceLink,
696
+ InvoiceLinkFromJSON,
697
+ InvoiceLinkFromJSONTyped,
698
+ InvoiceLinkToJSON,
699
+ InvoiceLinkToJSONTyped,
700
+ InvoiceLink,
681
701
  instanceOfInvoiceStatus,
682
702
  InvoiceStatusFromJSON,
683
703
  InvoiceStatusFromJSONTyped,
@@ -869,6 +889,12 @@ declare interface BillingClient {
869
889
  sessionId?: string;
870
890
  }): Promise<CheckoutResult>;
871
891
  fetchInvoices(params: InvoicesRequest): Promise<InvoicesResult>;
892
+ /**
893
+ * The current hosted URL for invoice `id`. The `url` on a listed invoice
894
+ * can expire; this asks the provider again. Rejects with a 404 when the
895
+ * invoice is not the company's or has no link.
896
+ */
897
+ fetchInvoiceLink(id: string): Promise<string>;
872
898
  /** `null` when the company has no next bill. */
873
899
  fetchUpcomingInvoice(): Promise<UpcomingInvoice | null>;
874
900
  /** Empty when the company has no method on file. */
@@ -1136,7 +1162,7 @@ export declare function BillingProvider({ billingClient, children, initialData,
1136
1162
  * much. Named apart from schematic-js's `BillingClient`, which is the whole
1137
1163
  * interface; this is the part the hooks here call.
1138
1164
  */
1139
- export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchCatalog" | "createCheckout" | "getCheckout" | "updateCheckout" | "finalizeCheckout" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage" | "fetchCreditBalances" | "fetchCreditUserUsage" | "fetchCompany" | "cancelSubscription" | "fetchTaxIds" | "updateTaxId"> & Partial<Pick<BillingClient, "fetchPublicCatalog" | "hasPublishableKey">>;
1165
+ export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchCatalog" | "createCheckout" | "getCheckout" | "updateCheckout" | "finalizeCheckout" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage" | "fetchCreditBalances" | "fetchCreditUserUsage" | "fetchCompany" | "cancelSubscription" | "fetchTaxIds" | "updateTaxId"> & Partial<Pick<BillingClient, "fetchPublicCatalog" | "hasPublishableKey" | "fetchInvoiceLink">>;
1140
1166
 
1141
1167
  declare interface BillingProviderDataProps {
1142
1168
  /**
@@ -1274,6 +1300,18 @@ declare const BillingStrategy: {
1274
1300
 
1275
1301
  declare type BillingStrategy = (typeof BillingStrategy)[keyof typeof BillingStrategy];
1276
1302
 
1303
+ /**
1304
+ *
1305
+ * @export
1306
+ */
1307
+ declare const BillingSubscriptionPauseBehavior: {
1308
+ readonly KeepAsDraft: "keep_as_draft";
1309
+ readonly MarkUncollectible: "mark_uncollectible";
1310
+ readonly Void: "void";
1311
+ };
1312
+
1313
+ declare type BillingSubscriptionPauseBehavior = (typeof BillingSubscriptionPauseBehavior)[keyof typeof BillingSubscriptionPauseBehavior];
1314
+
1277
1315
  /**
1278
1316
  *
1279
1317
  * @export
@@ -1384,7 +1422,7 @@ declare interface CatalogAutoTopupResponseData {
1384
1422
  * @type {CatalogPriceResponseData}
1385
1423
  * @memberof CatalogAutoTopupResponseData
1386
1424
  */
1387
- unitPrice?: CatalogPriceResponseData;
1425
+ unitPrice?: CatalogPriceResponseData | null;
1388
1426
  }
1389
1427
 
1390
1428
  /**
@@ -1414,8 +1452,8 @@ declare interface CatalogBundleCurrencyPriceResponseData {
1414
1452
  }
1415
1453
 
1416
1454
  /**
1417
- * Schematic API
1418
- * Schematic API
1455
+ * Components API
1456
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
1419
1457
  *
1420
1458
  * The version of the OpenAPI document: 0.1
1421
1459
  *
@@ -1447,8 +1485,8 @@ declare interface CatalogCapabilitiesResponseData {
1447
1485
  export declare type CatalogCheckoutField = CatalogCheckoutFieldResponseData;
1448
1486
 
1449
1487
  /**
1450
- * Schematic API
1451
- * Schematic API
1488
+ * Components API
1489
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
1452
1490
  *
1453
1491
  * The version of the OpenAPI document: 0.1
1454
1492
  *
@@ -1605,6 +1643,18 @@ declare interface CatalogCompanyPlanResponseData {
1605
1643
  * @memberof CatalogCompanyPlanResponseData
1606
1644
  */
1607
1645
  current: boolean;
1646
+ /**
1647
+ * True for the catalog's custom plan, the one sold by quote: show custom_plan_cta in place of its price and action.
1648
+ * @type {boolean}
1649
+ * @memberof CatalogCompanyPlanResponseData
1650
+ */
1651
+ custom: boolean;
1652
+ /**
1653
+ * The custom plan's price text and call to action; set only where custom is true.
1654
+ * @type {CatalogCustomPlanCTAResponseData}
1655
+ * @memberof CatalogCompanyPlanResponseData
1656
+ */
1657
+ customPlanCta?: CatalogCustomPlanCTAResponseData | null;
1608
1658
  /**
1609
1659
  *
1610
1660
  * @type {string}
@@ -1922,8 +1972,8 @@ declare interface CatalogCurrencyPricesResponseData {
1922
1972
  }
1923
1973
 
1924
1974
  /**
1925
- * Schematic API
1926
- * Schematic API
1975
+ * Components API
1976
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
1927
1977
  *
1928
1978
  * The version of the OpenAPI document: 0.1
1929
1979
  *
@@ -2139,8 +2189,8 @@ declare interface CatalogPlanEntitlementResponseData {
2139
2189
  }
2140
2190
 
2141
2191
  /**
2142
- * Schematic API
2143
- * Schematic API
2192
+ * Components API
2193
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
2144
2194
  *
2145
2195
  * The version of the OpenAPI document: 0.1
2146
2196
  *
@@ -2205,6 +2255,18 @@ declare interface CatalogPlanResponseData {
2205
2255
  * @memberof CatalogPlanResponseData
2206
2256
  */
2207
2257
  currencyPrices: Array<CatalogCurrencyPricesResponseData>;
2258
+ /**
2259
+ * True for the catalog's custom plan, the one sold by quote: show custom_plan_cta in place of its price and action.
2260
+ * @type {boolean}
2261
+ * @memberof CatalogPlanResponseData
2262
+ */
2263
+ custom: boolean;
2264
+ /**
2265
+ * The custom plan's price text and call to action; set only where custom is true.
2266
+ * @type {CatalogCustomPlanCTAResponseData}
2267
+ * @memberof CatalogPlanResponseData
2268
+ */
2269
+ customPlanCta?: CatalogCustomPlanCTAResponseData | null;
2208
2270
  /**
2209
2271
  *
2210
2272
  * @type {string}
@@ -2354,8 +2416,8 @@ declare interface CatalogPriceResponseData {
2354
2416
  }
2355
2417
 
2356
2418
  /**
2357
- * Schematic API
2358
- * Schematic API
2419
+ * Components API
2420
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
2359
2421
  *
2360
2422
  * The version of the OpenAPI document: 0.1
2361
2423
  *
@@ -2411,8 +2473,8 @@ export declare interface CatalogQuery {
2411
2473
  export declare type CatalogSource = CatalogView["source"];
2412
2474
 
2413
2475
  /**
2414
- * Schematic API
2415
- * Schematic API
2476
+ * Components API
2477
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
2416
2478
  *
2417
2479
  * The version of the OpenAPI document: 0.1
2418
2480
  *
@@ -2516,7 +2578,7 @@ declare interface CheckFlagResponseData {
2516
2578
  * @type {FeatureEntitlement}
2517
2579
  * @memberof CheckFlagResponseData
2518
2580
  */
2519
- entitlement?: FeatureEntitlement;
2581
+ entitlement?: FeatureEntitlement | null;
2520
2582
  /**
2521
2583
  * If an error occurred while checking the flag, the error message
2522
2584
  * @type {string}
@@ -2934,8 +2996,8 @@ export declare interface CheckoutDraftState {
2934
2996
  }
2935
2997
 
2936
2998
  /**
2937
- * Schematic API
2938
- * Schematic API
2999
+ * Components API
3000
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
2939
3001
  *
2940
3002
  * The version of the OpenAPI document: 0.1
2941
3003
  *
@@ -3465,6 +3527,12 @@ declare type CheckoutProblemSource = (typeof CheckoutProblemSource)[keyof typeof
3465
3527
  * @interface CheckoutResponseData
3466
3528
  */
3467
3529
  declare interface CheckoutResponseData {
3530
+ /**
3531
+ *
3532
+ * @type {Date}
3533
+ * @memberof CheckoutResponseData
3534
+ */
3535
+ accessRevokedAt?: Date | null;
3468
3536
  /**
3469
3537
  *
3470
3538
  * @type {string}
@@ -3549,6 +3617,24 @@ declare interface CheckoutResponseData {
3549
3617
  * @memberof CheckoutResponseData
3550
3618
  */
3551
3619
  metadata?: object;
3620
+ /**
3621
+ *
3622
+ * @type {BillingSubscriptionPauseBehavior}
3623
+ * @memberof CheckoutResponseData
3624
+ */
3625
+ pauseBehavior?: BillingSubscriptionPauseBehavior | null;
3626
+ /**
3627
+ *
3628
+ * @type {number}
3629
+ * @memberof CheckoutResponseData
3630
+ */
3631
+ pauseResumesAt?: number | null;
3632
+ /**
3633
+ *
3634
+ * @type {Date}
3635
+ * @memberof CheckoutResponseData
3636
+ */
3637
+ pausedAt?: Date | null;
3552
3638
  /**
3553
3639
  *
3554
3640
  * @type {number}
@@ -3822,7 +3908,7 @@ declare interface CompanyCatalogResponseData {
3822
3908
  * @type {CatalogCustomPlanCTAResponseData}
3823
3909
  * @memberof CompanyCatalogResponseData
3824
3910
  */
3825
- customPlanCta?: CatalogCustomPlanCTAResponseData;
3911
+ customPlanCta?: CatalogCustomPlanCTAResponseData | null;
3826
3912
  /**
3827
3913
  * ISO 4217 currency of every top-level price slot; currency_prices carries the others.
3828
3914
  * @type {Currency}
@@ -3888,7 +3974,7 @@ declare interface CompanyCatalogResponseData {
3888
3974
  * @type {CatalogPlanRefResponseData}
3889
3975
  * @memberof CompanyCatalogResponseData
3890
3976
  */
3891
- trialExpiryPlan?: CatalogPlanRefResponseData;
3977
+ trialExpiryPlan?: CatalogPlanRefResponseData | null;
3892
3978
  /**
3893
3979
  * Whether starting a trial requires a payment method; a null value means required.
3894
3980
  * @type {boolean}
@@ -3936,8 +4022,8 @@ declare interface CompanyContextCustomPlanBillingResponseData {
3936
4022
  }
3937
4023
 
3938
4024
  /**
3939
- * Schematic API
3940
- * Schematic API
4025
+ * Components API
4026
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
3941
4027
  *
3942
4028
  * The version of the OpenAPI document: 0.1
3943
4029
  *
@@ -4007,7 +4093,7 @@ declare interface CompanyContextResponseData {
4007
4093
  * @type {CompanyContextCustomPlanBillingResponseData}
4008
4094
  * @memberof CompanyContextResponseData
4009
4095
  */
4010
- customPlanBilling?: CompanyContextCustomPlanBillingResponseData;
4096
+ customPlanBilling?: CompanyContextCustomPlanBillingResponseData | null;
4011
4097
  /**
4012
4098
  *
4013
4099
  * @type {string}
@@ -4025,24 +4111,24 @@ declare interface CompanyContextResponseData {
4025
4111
  * @type {CompanyContextPlanResponseData}
4026
4112
  * @memberof CompanyContextResponseData
4027
4113
  */
4028
- plan?: CompanyContextPlanResponseData;
4114
+ plan?: CompanyContextPlanResponseData | null;
4029
4115
  /**
4030
4116
  * A plan change scheduled for the end of the billing period; null when none is.
4031
4117
  * @type {CompanyContextScheduledDowngradeResponseData}
4032
4118
  * @memberof CompanyContextResponseData
4033
4119
  */
4034
- scheduledDowngrade?: CompanyContextScheduledDowngradeResponseData;
4120
+ scheduledDowngrade?: CompanyContextScheduledDowngradeResponseData | null;
4035
4121
  /**
4036
4122
  * The company's subscription; null when it has none, or several.
4037
4123
  * @type {CompanyContextSubscriptionResponseData}
4038
4124
  * @memberof CompanyContextResponseData
4039
4125
  */
4040
- subscription?: CompanyContextSubscriptionResponseData;
4126
+ subscription?: CompanyContextSubscriptionResponseData | null;
4041
4127
  }
4042
4128
 
4043
4129
  /**
4044
- * Schematic API
4045
- * Schematic API
4130
+ * Components API
4131
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
4046
4132
  *
4047
4133
  * The version of the OpenAPI document: 0.1
4048
4134
  *
@@ -4140,8 +4226,8 @@ declare interface CompanyContextSubscriptionResponseData {
4140
4226
  }
4141
4227
 
4142
4228
  /**
4143
- * Schematic API
4144
- * Schematic API
4229
+ * Components API
4230
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
4145
4231
  *
4146
4232
  * The version of the OpenAPI document: 0.1
4147
4233
  *
@@ -4242,13 +4328,13 @@ declare interface CompanyCreditBalanceResponseData {
4242
4328
  * @type {CompanyCreditAutoTopupResponseData}
4243
4329
  * @memberof CompanyCreditBalanceResponseData
4244
4330
  */
4245
- autoTopup?: CompanyCreditAutoTopupResponseData;
4331
+ autoTopup?: CompanyCreditAutoTopupResponseData | null;
4246
4332
  /**
4247
4333
  * How the plan's grants of this credit add up per period; null unless the plan grants it per license and the license count is known.
4248
4334
  * @type {CompanyCreditCompositionResponseData}
4249
4335
  * @memberof CompanyCreditBalanceResponseData
4250
4336
  */
4251
- composition?: CompanyCreditCompositionResponseData;
4337
+ composition?: CompanyCreditCompositionResponseData | null;
4252
4338
  /**
4253
4339
  *
4254
4340
  * @type {string}
@@ -4330,8 +4416,8 @@ declare interface CompanyCreditBalanceResponseData {
4330
4416
  }
4331
4417
 
4332
4418
  /**
4333
- * Schematic API
4334
- * Schematic API
4419
+ * Components API
4420
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
4335
4421
  *
4336
4422
  * The version of the OpenAPI document: 0.1
4337
4423
  *
@@ -4545,8 +4631,8 @@ declare interface CompanyCreditUserUsageResponseData {
4545
4631
  }
4546
4632
 
4547
4633
  /**
4548
- * Schematic API
4549
- * Schematic API
4634
+ * Components API
4635
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
4550
4636
  *
4551
4637
  * The version of the OpenAPI document: 0.1
4552
4638
  *
@@ -4792,7 +4878,7 @@ declare interface CompanyFeatureUsageResponseData {
4792
4878
  * @type {CatalogPriceResponseData}
4793
4879
  * @memberof CompanyFeatureUsageResponseData
4794
4880
  */
4795
- price?: CatalogPriceResponseData;
4881
+ price?: CatalogPriceResponseData | null;
4796
4882
  /**
4797
4883
  *
4798
4884
  * @type {EntitlementPriceBehavior}
@@ -4938,8 +5024,8 @@ declare interface CompanyInvoiceResponseData {
4938
5024
  }
4939
5025
 
4940
5026
  /**
4941
- * Schematic API
4942
- * Schematic API
5027
+ * Components API
5028
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
4943
5029
  *
4944
5030
  * The version of the OpenAPI document: 0.1
4945
5031
  *
@@ -5057,8 +5143,8 @@ declare type CompanyPlanInvalidReason = (typeof CompanyPlanInvalidReason)[keyof
5057
5143
  export declare type CompanySubscription = CompanyContextSubscriptionResponseData;
5058
5144
 
5059
5145
  /**
5060
- * Schematic API
5061
- * Schematic API
5146
+ * Components API
5147
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
5062
5148
  *
5063
5149
  * The version of the OpenAPI document: 0.1
5064
5150
  *
@@ -5156,8 +5242,8 @@ declare interface CompanyUpcomingInvoiceResponseData {
5156
5242
  }
5157
5243
 
5158
5244
  /**
5159
- * Schematic API
5160
- * Schematic API
5245
+ * Components API
5246
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
5161
5247
  *
5162
5248
  * The version of the OpenAPI document: 0.1
5163
5249
  *
@@ -5209,18 +5295,18 @@ declare interface CompanyUserUsageResponseData {
5209
5295
  * signature (`iat.exp.sig`) for the given context.
5210
5296
  *
5211
5297
  * Because a publishable key is public, the signature must be produced by the
5212
- * customer's backend, which holds the matching secret API key. A typical
5213
- * implementation forwards the context to that backend and returns the
5298
+ * customer's backend, which holds the matching secret API key. The backend
5299
+ * signs only the company and user of the logged-in user, read from its own
5300
+ * session. A typical implementation calls an authenticated endpoint with no
5301
+ * body and returns the
5214
5302
  * `X-Schematic-Context-Sig` value it computes:
5215
5303
  *
5216
5304
  * ```ts
5217
5305
  * const schematic = new Schematic(pubKey, {
5218
- * getContextSignature: async (context) => {
5306
+ * getContextSignature: async () => {
5219
5307
  * const res = await fetch("/api/schematic/sign", {
5220
5308
  * method: "POST",
5221
5309
  * credentials: "include",
5222
- * headers: { "Content-Type": "application/json" },
5223
- * body: JSON.stringify(context),
5224
5310
  * });
5225
5311
  * const { signature } = await res.json();
5226
5312
  * return signature; // "iat.exp.sig"
@@ -5367,7 +5453,7 @@ declare interface CreditSpendPolicy_2 {
5367
5453
  * @type {CreditSpendWindow}
5368
5454
  * @memberof CreditSpendPolicy
5369
5455
  */
5370
- window?: CreditSpendWindow_2;
5456
+ window?: CreditSpendWindow_2 | null;
5371
5457
  }
5372
5458
 
5373
5459
  /** How a spend policy applies its limit. Unknown kinds are carried, not dropped:
@@ -6040,6 +6126,12 @@ export declare interface InvoicesHandle extends ResourceHandle<InvoicePage> {
6040
6126
  * never rejects.
6041
6127
  */
6042
6128
  loadMore: () => Promise<void>;
6129
+ /**
6130
+ * The current hosted URL for invoice `id`. The listed `url` can expire, so
6131
+ * a link asks for this when clicked. Rejects with the failure, which
6132
+ * leaves the list as it is.
6133
+ */
6134
+ fetchLink: (id: string) => Promise<string>;
6043
6135
  }
6044
6136
 
6045
6137
  declare interface InvoicesRequest extends InvoiceQuery {
@@ -6261,7 +6353,7 @@ declare interface PublicCatalogResponseData {
6261
6353
  * @type {CatalogCustomPlanCTAResponseData}
6262
6354
  * @memberof PublicCatalogResponseData
6263
6355
  */
6264
- customPlanCta?: CatalogCustomPlanCTAResponseData;
6356
+ customPlanCta?: CatalogCustomPlanCTAResponseData | null;
6265
6357
  /**
6266
6358
  * ISO 4217 currency of every top-level price slot; currency_prices carries the others.
6267
6359
  * @type {Currency}
@@ -6702,6 +6794,7 @@ declare class SchematicBillingClient implements BillingClient {
6702
6794
  }): Promise<CheckoutResult>;
6703
6795
  private checkoutWrite;
6704
6796
  fetchInvoices(params: InvoicesRequest): Promise<InvoicesResult>;
6797
+ fetchInvoiceLink(id: string): Promise<string>;
6705
6798
  fetchUpcomingInvoice(): Promise<UpcomingInvoice | null>;
6706
6799
  fetchPaymentMethods(): Promise<PaymentMethod[]>;
6707
6800
  createSetupIntent(): Promise<SetupIntent>;
@@ -6968,8 +7061,9 @@ export declare type SchematicOptions = {
6968
7061
  * (`iat.exp.sig`) for a given context. Required only when the Schematic
6969
7062
  * environment has context-signature verification enabled. Because a
6970
7063
  * publishable key is public, the signature must be produced by your backend
6971
- * (which holds the matching secret API key); this function typically forwards
6972
- * the context to that backend and returns the value it computes. The SDK
7064
+ * (which holds the matching secret API key), and it signs only the company
7065
+ * and user of the logged-in user; this function typically calls that
7066
+ * backend and returns the value it computes. The SDK
6973
7067
  * caches the signature per context, derives its expiry from the returned
6974
7068
  * string, and attaches it as the `X-Schematic-Context-Sig` header on flag
6975
7069
  * checks, the WebSocket bootstrap, and events. */
@@ -7164,8 +7258,8 @@ export declare interface SetupIntentHandle {
7164
7258
  }
7165
7259
 
7166
7260
  /**
7167
- * Schematic API
7168
- * Schematic API
7261
+ * Components API
7262
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
7169
7263
  *
7170
7264
  * The version of the OpenAPI document: 0.1
7171
7265
  *
@@ -7365,8 +7459,8 @@ export declare interface UnsubscribeHandle {
7365
7459
  export declare type UpcomingInvoice = CompanyUpcomingInvoiceResponseData;
7366
7460
 
7367
7461
  /**
7368
- * Schematic API
7369
- * Schematic API
7462
+ * Components API
7463
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
7370
7464
  *
7371
7465
  * The version of the OpenAPI document: 0.1
7372
7466
  *
@@ -7396,8 +7490,8 @@ declare interface UpdateAddOnRequestBody {
7396
7490
  }
7397
7491
 
7398
7492
  /**
7399
- * Schematic API
7400
- * Schematic API
7493
+ * Components API
7494
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
7401
7495
  *
7402
7496
  * The version of the OpenAPI document: 0.1
7403
7497
  *
@@ -7439,8 +7533,8 @@ declare interface UpdateAutoTopupOverrideRequestBody {
7439
7533
  }
7440
7534
 
7441
7535
  /**
7442
- * Schematic API
7443
- * Schematic API
7536
+ * Components API
7537
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
7444
7538
  *
7445
7539
  * The version of the OpenAPI document: 0.1
7446
7540
  *
@@ -7470,8 +7564,8 @@ declare interface UpdateCreditBundleRequestBody {
7470
7564
  }
7471
7565
 
7472
7566
  /**
7473
- * Schematic API
7474
- * Schematic API
7567
+ * Components API
7568
+ * The browser-facing billing API behind the drop-in components and the schematic-react hooks. A temporary access token scopes every call to one company.
7475
7569
  *
7476
7570
  * The version of the OpenAPI document: 0.1
7477
7571
  *