@clerk/types 4.64.0 → 4.64.1-canary.v20250711184916
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +1265 -2
- package/dist/index.d.ts +1265 -2
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -44,6 +44,17 @@ interface ClerkRuntimeError {
|
|
|
44
44
|
code: string;
|
|
45
45
|
message: string;
|
|
46
46
|
}
|
|
47
|
+
/**
|
|
48
|
+
* Interface representing a Clerk API Response Error.
|
|
49
|
+
*/
|
|
50
|
+
interface ClerkAPIResponseError extends Error {
|
|
51
|
+
clerkError: true;
|
|
52
|
+
status: number;
|
|
53
|
+
message: string;
|
|
54
|
+
clerkTraceId?: string;
|
|
55
|
+
retryAfter?: number;
|
|
56
|
+
errors: ClerkAPIError[];
|
|
57
|
+
}
|
|
47
58
|
|
|
48
59
|
type AlertId = 'danger' | 'warning' | 'info';
|
|
49
60
|
type FieldId = 'firstName' | 'lastName' | 'name' | 'slug' | 'emailAddress' | 'phoneNumber' | 'currentPassword' | 'newPassword' | 'signOutOfOtherSessions' | 'passkeyName' | 'password' | 'confirmPassword' | 'identifier' | 'username' | 'code' | 'role' | 'deleteConfirmation' | 'deleteOrganizationConfirmation' | 'enrollmentMode' | 'affiliationEmailAddress' | 'deleteExistingInvitationsSuggestions' | 'legalAccepted' | 'apiKeyDescription' | 'apiKeyExpirationDate' | 'apiKeyRevokeConfirmation';
|
|
@@ -245,50 +256,337 @@ type ClerkPaginationParams<T = object> = {
|
|
|
245
256
|
type WithOptionalOrgType<T> = T & {
|
|
246
257
|
orgId?: string;
|
|
247
258
|
};
|
|
259
|
+
/**
|
|
260
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
261
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
262
|
+
* @example
|
|
263
|
+
* ```tsx
|
|
264
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
265
|
+
* ```
|
|
266
|
+
*/
|
|
248
267
|
interface CommerceBillingNamespace {
|
|
268
|
+
/**
|
|
269
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
270
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
271
|
+
* @example
|
|
272
|
+
* ```tsx
|
|
273
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
274
|
+
* ```
|
|
275
|
+
*/
|
|
249
276
|
getPaymentAttempts: (params: GetPaymentAttemptsParams) => Promise<ClerkPaginatedResponse<CommercePaymentResource>>;
|
|
277
|
+
/**
|
|
278
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
279
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
280
|
+
* @example
|
|
281
|
+
* ```tsx
|
|
282
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
283
|
+
* ```
|
|
284
|
+
*/
|
|
250
285
|
getPlans: (params?: GetPlansParams) => Promise<CommercePlanResource[]>;
|
|
286
|
+
/**
|
|
287
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
288
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
289
|
+
* @example
|
|
290
|
+
* ```tsx
|
|
291
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
292
|
+
* ```
|
|
293
|
+
*/
|
|
251
294
|
getPlan: (params: {
|
|
252
295
|
id: string;
|
|
253
296
|
}) => Promise<CommercePlanResource>;
|
|
297
|
+
/**
|
|
298
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
299
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
300
|
+
* @example
|
|
301
|
+
* ```tsx
|
|
302
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
303
|
+
* ```
|
|
304
|
+
*/
|
|
254
305
|
getSubscriptions: (params: GetSubscriptionsParams) => Promise<ClerkPaginatedResponse<CommerceSubscriptionResource>>;
|
|
306
|
+
/**
|
|
307
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
308
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
309
|
+
* @example
|
|
310
|
+
* ```tsx
|
|
311
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
312
|
+
* ```
|
|
313
|
+
*/
|
|
255
314
|
getStatements: (params: GetStatementsParams) => Promise<ClerkPaginatedResponse<CommerceStatementResource>>;
|
|
315
|
+
/**
|
|
316
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
317
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
318
|
+
* @example
|
|
319
|
+
* ```tsx
|
|
320
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
321
|
+
* ```
|
|
322
|
+
*/
|
|
256
323
|
startCheckout: (params: CreateCheckoutParams) => Promise<CommerceCheckoutResource>;
|
|
257
324
|
}
|
|
325
|
+
/**
|
|
326
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
327
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
328
|
+
* @example
|
|
329
|
+
* ```tsx
|
|
330
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
331
|
+
* ```
|
|
332
|
+
*/
|
|
258
333
|
type CommerceSubscriberType = 'org' | 'user';
|
|
334
|
+
/**
|
|
335
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
336
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
337
|
+
* @example
|
|
338
|
+
* ```tsx
|
|
339
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
340
|
+
* ```
|
|
341
|
+
*/
|
|
259
342
|
type CommerceSubscriptionStatus = 'active' | 'ended' | 'upcoming';
|
|
343
|
+
/**
|
|
344
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
345
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
346
|
+
* @example
|
|
347
|
+
* ```tsx
|
|
348
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
349
|
+
* ```
|
|
350
|
+
*/
|
|
260
351
|
type CommerceSubscriptionPlanPeriod = 'month' | 'annual';
|
|
352
|
+
/**
|
|
353
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
354
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
355
|
+
* @example
|
|
356
|
+
* ```tsx
|
|
357
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
358
|
+
* ```
|
|
359
|
+
*/
|
|
261
360
|
interface CommercePaymentSourceMethods {
|
|
361
|
+
/**
|
|
362
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
363
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
364
|
+
* @example
|
|
365
|
+
* ```tsx
|
|
366
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
367
|
+
* ```
|
|
368
|
+
*/
|
|
262
369
|
initializePaymentSource: (params: Exclude<InitializePaymentSourceParams, 'orgId'>) => Promise<CommerceInitializedPaymentSourceResource>;
|
|
370
|
+
/**
|
|
371
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
372
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
373
|
+
* @example
|
|
374
|
+
* ```tsx
|
|
375
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
376
|
+
* ```
|
|
377
|
+
*/
|
|
263
378
|
addPaymentSource: (params: Exclude<AddPaymentSourceParams, 'orgId'>) => Promise<CommercePaymentSourceResource>;
|
|
379
|
+
/**
|
|
380
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
381
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
382
|
+
* @example
|
|
383
|
+
* ```tsx
|
|
384
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
385
|
+
* ```
|
|
386
|
+
*/
|
|
264
387
|
getPaymentSources: (params: Exclude<GetPaymentSourcesParams, 'orgId'>) => Promise<ClerkPaginatedResponse<CommercePaymentSourceResource>>;
|
|
265
388
|
}
|
|
389
|
+
/**
|
|
390
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
391
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
392
|
+
* @example
|
|
393
|
+
* ```tsx
|
|
394
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
395
|
+
* ```
|
|
396
|
+
*/
|
|
266
397
|
interface CommerceProductResource extends ClerkResource {
|
|
267
398
|
id: string;
|
|
399
|
+
/**
|
|
400
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
401
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
402
|
+
* @example
|
|
403
|
+
* ```tsx
|
|
404
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
405
|
+
* ```
|
|
406
|
+
*/
|
|
268
407
|
slug: string | null;
|
|
408
|
+
/**
|
|
409
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
410
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
411
|
+
* @example
|
|
412
|
+
* ```tsx
|
|
413
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
414
|
+
* ```
|
|
415
|
+
*/
|
|
269
416
|
currency: string;
|
|
417
|
+
/**
|
|
418
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
419
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
420
|
+
* @example
|
|
421
|
+
* ```tsx
|
|
422
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
423
|
+
* ```
|
|
424
|
+
*/
|
|
270
425
|
isDefault: boolean;
|
|
426
|
+
/**
|
|
427
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
428
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
429
|
+
* @example
|
|
430
|
+
* ```tsx
|
|
431
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
432
|
+
* ```
|
|
433
|
+
*/
|
|
271
434
|
plans: CommercePlanResource[];
|
|
272
435
|
}
|
|
436
|
+
/**
|
|
437
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
438
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
439
|
+
* @example
|
|
440
|
+
* ```tsx
|
|
441
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
442
|
+
* ```
|
|
443
|
+
*/
|
|
273
444
|
interface GetPlansParams {
|
|
445
|
+
/**
|
|
446
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
447
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
448
|
+
* @example
|
|
449
|
+
* ```tsx
|
|
450
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
451
|
+
* ```
|
|
452
|
+
*/
|
|
274
453
|
subscriberType?: CommerceSubscriberType;
|
|
275
454
|
}
|
|
455
|
+
/**
|
|
456
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
457
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
458
|
+
* @example
|
|
459
|
+
* ```tsx
|
|
460
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
461
|
+
* ```
|
|
462
|
+
*/
|
|
276
463
|
interface CommercePlanResource extends ClerkResource {
|
|
277
464
|
id: string;
|
|
465
|
+
/**
|
|
466
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
467
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
468
|
+
* @example
|
|
469
|
+
* ```tsx
|
|
470
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
471
|
+
* ```
|
|
472
|
+
*/
|
|
278
473
|
name: string;
|
|
474
|
+
/**
|
|
475
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
476
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
477
|
+
* @example
|
|
478
|
+
* ```tsx
|
|
479
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
480
|
+
* ```
|
|
481
|
+
*/
|
|
279
482
|
amount: number;
|
|
483
|
+
/**
|
|
484
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
485
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
486
|
+
* @example
|
|
487
|
+
* ```tsx
|
|
488
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
489
|
+
* ```
|
|
490
|
+
*/
|
|
280
491
|
amountFormatted: string;
|
|
492
|
+
/**
|
|
493
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
494
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
495
|
+
* @example
|
|
496
|
+
* ```tsx
|
|
497
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
498
|
+
* ```
|
|
499
|
+
*/
|
|
281
500
|
annualAmount: number;
|
|
501
|
+
/**
|
|
502
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
503
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
504
|
+
* @example
|
|
505
|
+
* ```tsx
|
|
506
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
507
|
+
* ```
|
|
508
|
+
*/
|
|
282
509
|
annualAmountFormatted: string;
|
|
510
|
+
/**
|
|
511
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
512
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
513
|
+
* @example
|
|
514
|
+
* ```tsx
|
|
515
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
516
|
+
* ```
|
|
517
|
+
*/
|
|
283
518
|
annualMonthlyAmount: number;
|
|
519
|
+
/**
|
|
520
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
521
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
522
|
+
* @example
|
|
523
|
+
* ```tsx
|
|
524
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
525
|
+
* ```
|
|
526
|
+
*/
|
|
284
527
|
annualMonthlyAmountFormatted: string;
|
|
528
|
+
/**
|
|
529
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
530
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
531
|
+
* @example
|
|
532
|
+
* ```tsx
|
|
533
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
534
|
+
* ```
|
|
535
|
+
*/
|
|
285
536
|
currencySymbol: string;
|
|
537
|
+
/**
|
|
538
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
539
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
540
|
+
* @example
|
|
541
|
+
* ```tsx
|
|
542
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
543
|
+
* ```
|
|
544
|
+
*/
|
|
286
545
|
currency: string;
|
|
546
|
+
/**
|
|
547
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
548
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
549
|
+
* @example
|
|
550
|
+
* ```tsx
|
|
551
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
552
|
+
* ```
|
|
553
|
+
*/
|
|
287
554
|
description: string;
|
|
555
|
+
/**
|
|
556
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
557
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
558
|
+
* @example
|
|
559
|
+
* ```tsx
|
|
560
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
561
|
+
* ```
|
|
562
|
+
*/
|
|
288
563
|
isDefault: boolean;
|
|
564
|
+
/**
|
|
565
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
566
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
567
|
+
* @example
|
|
568
|
+
* ```tsx
|
|
569
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
570
|
+
* ```
|
|
571
|
+
*/
|
|
289
572
|
isRecurring: boolean;
|
|
573
|
+
/**
|
|
574
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
575
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
576
|
+
* @example
|
|
577
|
+
* ```tsx
|
|
578
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
579
|
+
* ```
|
|
580
|
+
*/
|
|
290
581
|
hasBaseFee: boolean;
|
|
291
582
|
/**
|
|
583
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
584
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
585
|
+
* @example
|
|
586
|
+
* ```tsx
|
|
587
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
588
|
+
* ```
|
|
589
|
+
*
|
|
292
590
|
* Specifies the subscriber type this plan is designed for.
|
|
293
591
|
*
|
|
294
592
|
* Each plan is exclusively created for either individual users or organizations,
|
|
@@ -305,88 +603,616 @@ interface CommercePlanResource extends ClerkResource {
|
|
|
305
603
|
* ```
|
|
306
604
|
*/
|
|
307
605
|
payerType: string[];
|
|
606
|
+
/**
|
|
607
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
608
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
609
|
+
* @example
|
|
610
|
+
* ```tsx
|
|
611
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
612
|
+
* ```
|
|
613
|
+
*/
|
|
308
614
|
publiclyVisible: boolean;
|
|
615
|
+
/**
|
|
616
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
617
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
618
|
+
* @example
|
|
619
|
+
* ```tsx
|
|
620
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
621
|
+
* ```
|
|
622
|
+
*/
|
|
309
623
|
slug: string;
|
|
624
|
+
/**
|
|
625
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
626
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
627
|
+
* @example
|
|
628
|
+
* ```tsx
|
|
629
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
630
|
+
* ```
|
|
631
|
+
*/
|
|
310
632
|
avatarUrl: string;
|
|
633
|
+
/**
|
|
634
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
635
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
636
|
+
* @example
|
|
637
|
+
* ```tsx
|
|
638
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
639
|
+
* ```
|
|
640
|
+
*/
|
|
311
641
|
features: CommerceFeatureResource[];
|
|
312
642
|
__internal_toSnapshot: () => CommercePlanJSONSnapshot;
|
|
313
643
|
}
|
|
644
|
+
/**
|
|
645
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
646
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
647
|
+
* @example
|
|
648
|
+
* ```tsx
|
|
649
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
650
|
+
* ```
|
|
651
|
+
*/
|
|
314
652
|
interface CommerceFeatureResource extends ClerkResource {
|
|
315
653
|
id: string;
|
|
654
|
+
/**
|
|
655
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
656
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
657
|
+
* @example
|
|
658
|
+
* ```tsx
|
|
659
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
660
|
+
* ```
|
|
661
|
+
*/
|
|
316
662
|
name: string;
|
|
663
|
+
/**
|
|
664
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
665
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
666
|
+
* @example
|
|
667
|
+
* ```tsx
|
|
668
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
669
|
+
* ```
|
|
670
|
+
*/
|
|
317
671
|
description: string;
|
|
672
|
+
/**
|
|
673
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
674
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
675
|
+
* @example
|
|
676
|
+
* ```tsx
|
|
677
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
678
|
+
* ```
|
|
679
|
+
*/
|
|
318
680
|
slug: string;
|
|
681
|
+
/**
|
|
682
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
683
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
684
|
+
* @example
|
|
685
|
+
* ```tsx
|
|
686
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
687
|
+
* ```
|
|
688
|
+
*/
|
|
319
689
|
avatarUrl: string;
|
|
320
690
|
__internal_toSnapshot: () => CommerceFeatureJSONSnapshot;
|
|
321
691
|
}
|
|
692
|
+
/**
|
|
693
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
694
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
695
|
+
* @example
|
|
696
|
+
* ```tsx
|
|
697
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
698
|
+
* ```
|
|
699
|
+
*/
|
|
322
700
|
type CommercePaymentSourceStatus = 'active' | 'expired' | 'disconnected';
|
|
701
|
+
/**
|
|
702
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
703
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
704
|
+
* @example
|
|
705
|
+
* ```tsx
|
|
706
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
707
|
+
* ```
|
|
708
|
+
*/
|
|
323
709
|
type GetPaymentSourcesParams = WithOptionalOrgType<ClerkPaginationParams>;
|
|
710
|
+
/**
|
|
711
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
712
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
713
|
+
* @example
|
|
714
|
+
* ```tsx
|
|
715
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
716
|
+
* ```
|
|
717
|
+
*/
|
|
324
718
|
type PaymentGateway = 'stripe' | 'paypal';
|
|
719
|
+
/**
|
|
720
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
721
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
722
|
+
* @example
|
|
723
|
+
* ```tsx
|
|
724
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
725
|
+
* ```
|
|
726
|
+
*/
|
|
325
727
|
type InitializePaymentSourceParams = WithOptionalOrgType<{
|
|
728
|
+
/**
|
|
729
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
730
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
731
|
+
* @example
|
|
732
|
+
* ```tsx
|
|
733
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
734
|
+
* ```
|
|
735
|
+
*/
|
|
326
736
|
gateway: PaymentGateway;
|
|
327
737
|
}>;
|
|
738
|
+
/**
|
|
739
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
740
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
741
|
+
* @example
|
|
742
|
+
* ```tsx
|
|
743
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
744
|
+
* ```
|
|
745
|
+
*/
|
|
328
746
|
type AddPaymentSourceParams = WithOptionalOrgType<{
|
|
747
|
+
/**
|
|
748
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
749
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
750
|
+
* @example
|
|
751
|
+
* ```tsx
|
|
752
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
753
|
+
* ```
|
|
754
|
+
*/
|
|
329
755
|
gateway: PaymentGateway;
|
|
756
|
+
/**
|
|
757
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
758
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
759
|
+
* @example
|
|
760
|
+
* ```tsx
|
|
761
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
762
|
+
* ```
|
|
763
|
+
*/
|
|
330
764
|
paymentToken: string;
|
|
331
765
|
}>;
|
|
766
|
+
/**
|
|
767
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
768
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
769
|
+
* @example
|
|
770
|
+
* ```tsx
|
|
771
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
772
|
+
* ```
|
|
773
|
+
*/
|
|
332
774
|
type RemovePaymentSourceParams = WithOptionalOrgType<unknown>;
|
|
775
|
+
/**
|
|
776
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
777
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
778
|
+
* @example
|
|
779
|
+
* ```tsx
|
|
780
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
781
|
+
* ```
|
|
782
|
+
*/
|
|
333
783
|
type MakeDefaultPaymentSourceParams = WithOptionalOrgType<unknown>;
|
|
784
|
+
/**
|
|
785
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
786
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
787
|
+
* @example
|
|
788
|
+
* ```tsx
|
|
789
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
790
|
+
* ```
|
|
791
|
+
*/
|
|
334
792
|
interface CommercePaymentSourceResource extends ClerkResource {
|
|
335
793
|
id: string;
|
|
336
794
|
last4: string;
|
|
795
|
+
/**
|
|
796
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
797
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
798
|
+
* @example
|
|
799
|
+
* ```tsx
|
|
800
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
801
|
+
* ```
|
|
802
|
+
*/
|
|
337
803
|
paymentMethod: string;
|
|
804
|
+
/**
|
|
805
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
806
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
807
|
+
* @example
|
|
808
|
+
* ```tsx
|
|
809
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
810
|
+
* ```
|
|
811
|
+
*/
|
|
338
812
|
cardType: string;
|
|
813
|
+
/**
|
|
814
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
815
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
816
|
+
* @example
|
|
817
|
+
* ```tsx
|
|
818
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
819
|
+
* ```
|
|
820
|
+
*/
|
|
339
821
|
isDefault: boolean;
|
|
822
|
+
/**
|
|
823
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
824
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
825
|
+
* @example
|
|
826
|
+
* ```tsx
|
|
827
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
828
|
+
* ```
|
|
829
|
+
*/
|
|
340
830
|
isRemovable: boolean;
|
|
831
|
+
/**
|
|
832
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
833
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
834
|
+
* @example
|
|
835
|
+
* ```tsx
|
|
836
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
837
|
+
* ```
|
|
838
|
+
*/
|
|
341
839
|
status: CommercePaymentSourceStatus;
|
|
840
|
+
/**
|
|
841
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
842
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
843
|
+
* @example
|
|
844
|
+
* ```tsx
|
|
845
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
846
|
+
* ```
|
|
847
|
+
*/
|
|
342
848
|
walletType: string | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
851
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
852
|
+
* @example
|
|
853
|
+
* ```tsx
|
|
854
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
855
|
+
* ```
|
|
856
|
+
*/
|
|
343
857
|
remove: (params?: RemovePaymentSourceParams) => Promise<DeletedObjectResource>;
|
|
858
|
+
/**
|
|
859
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
860
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
861
|
+
* @example
|
|
862
|
+
* ```tsx
|
|
863
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
864
|
+
* ```
|
|
865
|
+
*/
|
|
344
866
|
makeDefault: (params?: MakeDefaultPaymentSourceParams) => Promise<null>;
|
|
345
867
|
}
|
|
868
|
+
/**
|
|
869
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
870
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
871
|
+
* @example
|
|
872
|
+
* ```tsx
|
|
873
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
874
|
+
* ```
|
|
875
|
+
*/
|
|
346
876
|
interface CommerceInitializedPaymentSourceResource extends ClerkResource {
|
|
877
|
+
/**
|
|
878
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
879
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
880
|
+
* @example
|
|
881
|
+
* ```tsx
|
|
882
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
883
|
+
* ```
|
|
884
|
+
*/
|
|
347
885
|
externalClientSecret: string;
|
|
886
|
+
/**
|
|
887
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
888
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
889
|
+
* @example
|
|
890
|
+
* ```tsx
|
|
891
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
892
|
+
* ```
|
|
893
|
+
*/
|
|
348
894
|
externalGatewayId: string;
|
|
895
|
+
/**
|
|
896
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
897
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
898
|
+
* @example
|
|
899
|
+
* ```tsx
|
|
900
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
901
|
+
* ```
|
|
902
|
+
*/
|
|
349
903
|
paymentMethodOrder: string[];
|
|
350
904
|
}
|
|
905
|
+
/**
|
|
906
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
907
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
908
|
+
* @example
|
|
909
|
+
* ```tsx
|
|
910
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
911
|
+
* ```
|
|
912
|
+
*/
|
|
351
913
|
type CommercePaymentChargeType = 'checkout' | 'recurring';
|
|
914
|
+
/**
|
|
915
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
916
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
917
|
+
* @example
|
|
918
|
+
* ```tsx
|
|
919
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
920
|
+
* ```
|
|
921
|
+
*/
|
|
352
922
|
type CommercePaymentStatus = 'pending' | 'paid' | 'failed';
|
|
923
|
+
/**
|
|
924
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
925
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
926
|
+
* @example
|
|
927
|
+
* ```tsx
|
|
928
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
929
|
+
* ```
|
|
930
|
+
*/
|
|
353
931
|
interface CommercePaymentResource extends ClerkResource {
|
|
354
932
|
id: string;
|
|
933
|
+
/**
|
|
934
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
935
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
936
|
+
* @example
|
|
937
|
+
* ```tsx
|
|
938
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
939
|
+
* ```
|
|
940
|
+
*/
|
|
355
941
|
amount: CommerceMoney;
|
|
942
|
+
/**
|
|
943
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
944
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
945
|
+
* @example
|
|
946
|
+
* ```tsx
|
|
947
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
948
|
+
* ```
|
|
949
|
+
*/
|
|
356
950
|
paidAt?: Date;
|
|
951
|
+
/**
|
|
952
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
953
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
954
|
+
* @example
|
|
955
|
+
* ```tsx
|
|
956
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
957
|
+
* ```
|
|
958
|
+
*/
|
|
357
959
|
failedAt?: Date;
|
|
960
|
+
/**
|
|
961
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
962
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
963
|
+
* @example
|
|
964
|
+
* ```tsx
|
|
965
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
966
|
+
* ```
|
|
967
|
+
*/
|
|
358
968
|
updatedAt: Date;
|
|
969
|
+
/**
|
|
970
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
971
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
972
|
+
* @example
|
|
973
|
+
* ```tsx
|
|
974
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
975
|
+
* ```
|
|
976
|
+
*/
|
|
359
977
|
paymentSource: CommercePaymentSourceResource;
|
|
978
|
+
/**
|
|
979
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
980
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
981
|
+
* @example
|
|
982
|
+
* ```tsx
|
|
983
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
984
|
+
* ```
|
|
985
|
+
*/
|
|
360
986
|
subscription: CommerceSubscriptionResource;
|
|
987
|
+
/**
|
|
988
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
989
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
990
|
+
* @example
|
|
991
|
+
* ```tsx
|
|
992
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
993
|
+
* ```
|
|
994
|
+
*/
|
|
361
995
|
subscriptionItem: CommerceSubscriptionResource;
|
|
996
|
+
/**
|
|
997
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
998
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
999
|
+
* @example
|
|
1000
|
+
* ```tsx
|
|
1001
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1002
|
+
* ```
|
|
1003
|
+
*/
|
|
362
1004
|
chargeType: CommercePaymentChargeType;
|
|
1005
|
+
/**
|
|
1006
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1007
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1008
|
+
* @example
|
|
1009
|
+
* ```tsx
|
|
1010
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1011
|
+
* ```
|
|
1012
|
+
*/
|
|
363
1013
|
status: CommercePaymentStatus;
|
|
364
1014
|
}
|
|
1015
|
+
/**
|
|
1016
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1017
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1018
|
+
* @example
|
|
1019
|
+
* ```tsx
|
|
1020
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1021
|
+
* ```
|
|
1022
|
+
*/
|
|
365
1023
|
type GetPaymentAttemptsParams = WithOptionalOrgType<ClerkPaginationParams>;
|
|
1024
|
+
/**
|
|
1025
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1026
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1027
|
+
* @example
|
|
1028
|
+
* ```tsx
|
|
1029
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1030
|
+
* ```
|
|
1031
|
+
*/
|
|
366
1032
|
type GetStatementsParams = WithOptionalOrgType<ClerkPaginationParams>;
|
|
1033
|
+
/**
|
|
1034
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1035
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1036
|
+
* @example
|
|
1037
|
+
* ```tsx
|
|
1038
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1039
|
+
* ```
|
|
1040
|
+
*/
|
|
367
1041
|
type CommerceStatementStatus = 'open' | 'closed';
|
|
1042
|
+
/**
|
|
1043
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1044
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1045
|
+
* @example
|
|
1046
|
+
* ```tsx
|
|
1047
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1048
|
+
* ```
|
|
1049
|
+
*/
|
|
368
1050
|
interface CommerceStatementResource extends ClerkResource {
|
|
369
1051
|
id: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1054
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1055
|
+
* @example
|
|
1056
|
+
* ```tsx
|
|
1057
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1058
|
+
* ```
|
|
1059
|
+
*/
|
|
370
1060
|
totals: CommerceStatementTotals;
|
|
1061
|
+
/**
|
|
1062
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1063
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1064
|
+
* @example
|
|
1065
|
+
* ```tsx
|
|
1066
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1067
|
+
* ```
|
|
1068
|
+
*/
|
|
371
1069
|
status: CommerceStatementStatus;
|
|
1070
|
+
/**
|
|
1071
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1072
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1073
|
+
* @example
|
|
1074
|
+
* ```tsx
|
|
1075
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1076
|
+
* ```
|
|
1077
|
+
*/
|
|
372
1078
|
timestamp: Date;
|
|
1079
|
+
/**
|
|
1080
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1081
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1082
|
+
* @example
|
|
1083
|
+
* ```tsx
|
|
1084
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1085
|
+
* ```
|
|
1086
|
+
*/
|
|
373
1087
|
groups: CommerceStatementGroup[];
|
|
374
1088
|
}
|
|
1089
|
+
/**
|
|
1090
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1091
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1092
|
+
* @example
|
|
1093
|
+
* ```tsx
|
|
1094
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1095
|
+
* ```
|
|
1096
|
+
*/
|
|
375
1097
|
interface CommerceStatementGroup {
|
|
1098
|
+
/**
|
|
1099
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1100
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1101
|
+
* @example
|
|
1102
|
+
* ```tsx
|
|
1103
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1104
|
+
* ```
|
|
1105
|
+
*/
|
|
376
1106
|
timestamp: Date;
|
|
1107
|
+
/**
|
|
1108
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1109
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1110
|
+
* @example
|
|
1111
|
+
* ```tsx
|
|
1112
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1113
|
+
* ```
|
|
1114
|
+
*/
|
|
377
1115
|
items: CommercePaymentResource[];
|
|
378
1116
|
}
|
|
1117
|
+
/**
|
|
1118
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1119
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1120
|
+
* @example
|
|
1121
|
+
* ```tsx
|
|
1122
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1123
|
+
* ```
|
|
1124
|
+
*/
|
|
379
1125
|
type GetSubscriptionsParams = WithOptionalOrgType<ClerkPaginationParams>;
|
|
1126
|
+
/**
|
|
1127
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1128
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1129
|
+
* @example
|
|
1130
|
+
* ```tsx
|
|
1131
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1132
|
+
* ```
|
|
1133
|
+
*/
|
|
380
1134
|
type CancelSubscriptionParams = WithOptionalOrgType<unknown>;
|
|
1135
|
+
/**
|
|
1136
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1137
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1138
|
+
* @example
|
|
1139
|
+
* ```tsx
|
|
1140
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1141
|
+
* ```
|
|
1142
|
+
*/
|
|
381
1143
|
interface CommerceSubscriptionResource extends ClerkResource {
|
|
382
1144
|
id: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1147
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1148
|
+
* @example
|
|
1149
|
+
* ```tsx
|
|
1150
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1151
|
+
* ```
|
|
1152
|
+
*/
|
|
383
1153
|
paymentSourceId: string;
|
|
1154
|
+
/**
|
|
1155
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1156
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1157
|
+
* @example
|
|
1158
|
+
* ```tsx
|
|
1159
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1160
|
+
* ```
|
|
1161
|
+
*/
|
|
384
1162
|
plan: CommercePlanResource;
|
|
1163
|
+
/**
|
|
1164
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1165
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1166
|
+
* @example
|
|
1167
|
+
* ```tsx
|
|
1168
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1169
|
+
* ```
|
|
1170
|
+
*/
|
|
385
1171
|
planPeriod: CommerceSubscriptionPlanPeriod;
|
|
1172
|
+
/**
|
|
1173
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1174
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1175
|
+
* @example
|
|
1176
|
+
* ```tsx
|
|
1177
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1178
|
+
* ```
|
|
1179
|
+
*/
|
|
386
1180
|
status: CommerceSubscriptionStatus;
|
|
1181
|
+
/**
|
|
1182
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1183
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1184
|
+
* @example
|
|
1185
|
+
* ```tsx
|
|
1186
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1187
|
+
* ```
|
|
1188
|
+
*/
|
|
387
1189
|
createdAt: Date;
|
|
1190
|
+
/**
|
|
1191
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1192
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1193
|
+
* @example
|
|
1194
|
+
* ```tsx
|
|
1195
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1196
|
+
* ```
|
|
1197
|
+
*/
|
|
388
1198
|
periodStartDate: Date;
|
|
1199
|
+
/**
|
|
1200
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1201
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1202
|
+
* @example
|
|
1203
|
+
* ```tsx
|
|
1204
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1205
|
+
* ```
|
|
1206
|
+
*/
|
|
389
1207
|
periodEndDate: Date | null;
|
|
1208
|
+
/**
|
|
1209
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1210
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1211
|
+
* @example
|
|
1212
|
+
* ```tsx
|
|
1213
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1214
|
+
* ```
|
|
1215
|
+
*/
|
|
390
1216
|
canceledAtDate: Date | null;
|
|
391
1217
|
/**
|
|
392
1218
|
* @deprecated Use `periodStartDate` instead
|
|
@@ -400,53 +1226,357 @@ interface CommerceSubscriptionResource extends ClerkResource {
|
|
|
400
1226
|
* @deprecated Use `canceledAtDate` instead
|
|
401
1227
|
*/
|
|
402
1228
|
canceledAt: number | null;
|
|
1229
|
+
/**
|
|
1230
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1231
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1232
|
+
* @example
|
|
1233
|
+
* ```tsx
|
|
1234
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1235
|
+
* ```
|
|
1236
|
+
*/
|
|
403
1237
|
amount?: CommerceMoney;
|
|
1238
|
+
/**
|
|
1239
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1240
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1241
|
+
* @example
|
|
1242
|
+
* ```tsx
|
|
1243
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1244
|
+
* ```
|
|
1245
|
+
*/
|
|
404
1246
|
credit?: {
|
|
1247
|
+
/**
|
|
1248
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1249
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1250
|
+
* @example
|
|
1251
|
+
* ```tsx
|
|
1252
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1253
|
+
* ```
|
|
1254
|
+
*/
|
|
405
1255
|
amount: CommerceMoney;
|
|
406
1256
|
};
|
|
1257
|
+
/**
|
|
1258
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1259
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1260
|
+
* @example
|
|
1261
|
+
* ```tsx
|
|
1262
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1263
|
+
* ```
|
|
1264
|
+
*/
|
|
407
1265
|
cancel: (params: CancelSubscriptionParams) => Promise<DeletedObjectResource>;
|
|
408
1266
|
}
|
|
1267
|
+
/**
|
|
1268
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1269
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1270
|
+
* @example
|
|
1271
|
+
* ```tsx
|
|
1272
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1273
|
+
* ```
|
|
1274
|
+
*/
|
|
409
1275
|
interface CommerceMoney {
|
|
1276
|
+
/**
|
|
1277
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1278
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1279
|
+
* @example
|
|
1280
|
+
* ```tsx
|
|
1281
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1282
|
+
* ```
|
|
1283
|
+
*/
|
|
410
1284
|
amount: number;
|
|
1285
|
+
/**
|
|
1286
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1287
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1288
|
+
* @example
|
|
1289
|
+
* ```tsx
|
|
1290
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1291
|
+
* ```
|
|
1292
|
+
*/
|
|
411
1293
|
amountFormatted: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1296
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1297
|
+
* @example
|
|
1298
|
+
* ```tsx
|
|
1299
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1300
|
+
* ```
|
|
1301
|
+
*/
|
|
412
1302
|
currency: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1305
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1306
|
+
* @example
|
|
1307
|
+
* ```tsx
|
|
1308
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1309
|
+
* ```
|
|
1310
|
+
*/
|
|
413
1311
|
currencySymbol: string;
|
|
414
1312
|
}
|
|
1313
|
+
/**
|
|
1314
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1315
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1316
|
+
* @example
|
|
1317
|
+
* ```tsx
|
|
1318
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1319
|
+
* ```
|
|
1320
|
+
*/
|
|
415
1321
|
interface CommerceCheckoutTotals {
|
|
1322
|
+
/**
|
|
1323
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1324
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1325
|
+
* @example
|
|
1326
|
+
* ```tsx
|
|
1327
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1328
|
+
* ```
|
|
1329
|
+
*/
|
|
416
1330
|
subtotal: CommerceMoney;
|
|
1331
|
+
/**
|
|
1332
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1333
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1334
|
+
* @example
|
|
1335
|
+
* ```tsx
|
|
1336
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1337
|
+
* ```
|
|
1338
|
+
*/
|
|
417
1339
|
grandTotal: CommerceMoney;
|
|
1340
|
+
/**
|
|
1341
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1342
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1343
|
+
* @example
|
|
1344
|
+
* ```tsx
|
|
1345
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1346
|
+
* ```
|
|
1347
|
+
*/
|
|
418
1348
|
taxTotal: CommerceMoney;
|
|
1349
|
+
/**
|
|
1350
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1351
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1352
|
+
* @example
|
|
1353
|
+
* ```tsx
|
|
1354
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1355
|
+
* ```
|
|
1356
|
+
*/
|
|
419
1357
|
totalDueNow: CommerceMoney;
|
|
1358
|
+
/**
|
|
1359
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1360
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1361
|
+
* @example
|
|
1362
|
+
* ```tsx
|
|
1363
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1364
|
+
* ```
|
|
1365
|
+
*/
|
|
420
1366
|
credit: CommerceMoney;
|
|
1367
|
+
/**
|
|
1368
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1369
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1370
|
+
* @example
|
|
1371
|
+
* ```tsx
|
|
1372
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1373
|
+
* ```
|
|
1374
|
+
*/
|
|
421
1375
|
pastDue: CommerceMoney;
|
|
422
1376
|
}
|
|
1377
|
+
/**
|
|
1378
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1379
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1380
|
+
* @example
|
|
1381
|
+
* ```tsx
|
|
1382
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1383
|
+
* ```
|
|
1384
|
+
*/
|
|
423
1385
|
interface CommerceStatementTotals extends Omit<CommerceCheckoutTotals, 'totalDueNow'> {
|
|
424
1386
|
}
|
|
1387
|
+
/**
|
|
1388
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1389
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1390
|
+
* @example
|
|
1391
|
+
* ```tsx
|
|
1392
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1393
|
+
* ```
|
|
1394
|
+
*/
|
|
425
1395
|
type CreateCheckoutParams = WithOptionalOrgType<{
|
|
1396
|
+
/**
|
|
1397
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1398
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1399
|
+
* @example
|
|
1400
|
+
* ```tsx
|
|
1401
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1402
|
+
* ```
|
|
1403
|
+
*/
|
|
426
1404
|
planId: string;
|
|
1405
|
+
/**
|
|
1406
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1407
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1408
|
+
* @example
|
|
1409
|
+
* ```tsx
|
|
1410
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1411
|
+
* ```
|
|
1412
|
+
*/
|
|
427
1413
|
planPeriod: CommerceSubscriptionPlanPeriod;
|
|
428
1414
|
}>;
|
|
1415
|
+
/**
|
|
1416
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1417
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1418
|
+
* @example
|
|
1419
|
+
* ```tsx
|
|
1420
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1421
|
+
* ```
|
|
1422
|
+
*/
|
|
429
1423
|
type ConfirmCheckoutParams = WithOptionalOrgType<{
|
|
1424
|
+
/**
|
|
1425
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1426
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1427
|
+
* @example
|
|
1428
|
+
* ```tsx
|
|
1429
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1430
|
+
* ```
|
|
1431
|
+
*/
|
|
430
1432
|
paymentSourceId?: string;
|
|
431
1433
|
} | {
|
|
1434
|
+
/**
|
|
1435
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1436
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1437
|
+
* @example
|
|
1438
|
+
* ```tsx
|
|
1439
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1440
|
+
* ```
|
|
1441
|
+
*/
|
|
432
1442
|
paymentToken?: string;
|
|
1443
|
+
/**
|
|
1444
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1445
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1446
|
+
* @example
|
|
1447
|
+
* ```tsx
|
|
1448
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1449
|
+
* ```
|
|
1450
|
+
*/
|
|
433
1451
|
gateway?: PaymentGateway;
|
|
434
1452
|
} | {
|
|
1453
|
+
/**
|
|
1454
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1455
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1456
|
+
* @example
|
|
1457
|
+
* ```tsx
|
|
1458
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1459
|
+
* ```
|
|
1460
|
+
*/
|
|
435
1461
|
gateway?: PaymentGateway;
|
|
1462
|
+
/**
|
|
1463
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1464
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1465
|
+
* @example
|
|
1466
|
+
* ```tsx
|
|
1467
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1468
|
+
* ```
|
|
1469
|
+
*/
|
|
436
1470
|
useTestCard?: boolean;
|
|
437
1471
|
}>;
|
|
1472
|
+
/**
|
|
1473
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1474
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1475
|
+
* @example
|
|
1476
|
+
* ```tsx
|
|
1477
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1478
|
+
* ```
|
|
1479
|
+
*/
|
|
438
1480
|
interface CommerceCheckoutResource extends ClerkResource {
|
|
439
1481
|
id: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1484
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1485
|
+
* @example
|
|
1486
|
+
* ```tsx
|
|
1487
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1488
|
+
* ```
|
|
1489
|
+
*/
|
|
440
1490
|
externalClientSecret: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1493
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1494
|
+
* @example
|
|
1495
|
+
* ```tsx
|
|
1496
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1497
|
+
* ```
|
|
1498
|
+
*/
|
|
441
1499
|
externalGatewayId: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1502
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1503
|
+
* @example
|
|
1504
|
+
* ```tsx
|
|
1505
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1506
|
+
* ```
|
|
1507
|
+
*/
|
|
442
1508
|
statement_id: string;
|
|
1509
|
+
/**
|
|
1510
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1511
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1512
|
+
* @example
|
|
1513
|
+
* ```tsx
|
|
1514
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1515
|
+
* ```
|
|
1516
|
+
*/
|
|
443
1517
|
paymentSource?: CommercePaymentSourceResource;
|
|
1518
|
+
/**
|
|
1519
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1520
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1521
|
+
* @example
|
|
1522
|
+
* ```tsx
|
|
1523
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1524
|
+
* ```
|
|
1525
|
+
*/
|
|
444
1526
|
plan: CommercePlanResource;
|
|
1527
|
+
/**
|
|
1528
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1529
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1530
|
+
* @example
|
|
1531
|
+
* ```tsx
|
|
1532
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1533
|
+
* ```
|
|
1534
|
+
*/
|
|
445
1535
|
planPeriod: CommerceSubscriptionPlanPeriod;
|
|
1536
|
+
/**
|
|
1537
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1538
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1539
|
+
* @example
|
|
1540
|
+
* ```tsx
|
|
1541
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1542
|
+
* ```
|
|
1543
|
+
*/
|
|
446
1544
|
planPeriodStart?: number;
|
|
1545
|
+
/**
|
|
1546
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1547
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1548
|
+
* @example
|
|
1549
|
+
* ```tsx
|
|
1550
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1551
|
+
* ```
|
|
1552
|
+
*/
|
|
447
1553
|
status: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1556
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1557
|
+
* @example
|
|
1558
|
+
* ```tsx
|
|
1559
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1560
|
+
* ```
|
|
1561
|
+
*/
|
|
448
1562
|
totals: CommerceCheckoutTotals;
|
|
1563
|
+
/**
|
|
1564
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1565
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1566
|
+
* @example
|
|
1567
|
+
* ```tsx
|
|
1568
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1569
|
+
* ```
|
|
1570
|
+
*/
|
|
449
1571
|
confirm: (params: ConfirmCheckoutParams) => Promise<CommerceCheckoutResource>;
|
|
1572
|
+
/**
|
|
1573
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
1574
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
1575
|
+
* @example
|
|
1576
|
+
* ```tsx
|
|
1577
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
1578
|
+
* ```
|
|
1579
|
+
*/
|
|
450
1580
|
isImmediatePlanChange: boolean;
|
|
451
1581
|
}
|
|
452
1582
|
|
|
@@ -3164,6 +4294,14 @@ interface WaitlistJSON extends ClerkResourceJSON {
|
|
|
3164
4294
|
created_at: number;
|
|
3165
4295
|
updated_at: number;
|
|
3166
4296
|
}
|
|
4297
|
+
/**
|
|
4298
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4299
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4300
|
+
* @example
|
|
4301
|
+
* ```tsx
|
|
4302
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4303
|
+
* ```
|
|
4304
|
+
*/
|
|
3167
4305
|
interface CommerceFeatureJSON extends ClerkResourceJSON {
|
|
3168
4306
|
object: 'commerce_feature';
|
|
3169
4307
|
id: string;
|
|
@@ -3172,6 +4310,14 @@ interface CommerceFeatureJSON extends ClerkResourceJSON {
|
|
|
3172
4310
|
slug: string;
|
|
3173
4311
|
avatar_url: string;
|
|
3174
4312
|
}
|
|
4313
|
+
/**
|
|
4314
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4315
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4316
|
+
* @example
|
|
4317
|
+
* ```tsx
|
|
4318
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4319
|
+
* ```
|
|
4320
|
+
*/
|
|
3175
4321
|
interface CommercePlanJSON extends ClerkResourceJSON {
|
|
3176
4322
|
object: 'commerce_plan';
|
|
3177
4323
|
id: string;
|
|
@@ -3210,6 +4356,14 @@ interface CommercePlanJSON extends ClerkResourceJSON {
|
|
|
3210
4356
|
avatar_url: string;
|
|
3211
4357
|
features: CommerceFeatureJSON[];
|
|
3212
4358
|
}
|
|
4359
|
+
/**
|
|
4360
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4361
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4362
|
+
* @example
|
|
4363
|
+
* ```tsx
|
|
4364
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4365
|
+
* ```
|
|
4366
|
+
*/
|
|
3213
4367
|
interface CommerceProductJSON extends ClerkResourceJSON {
|
|
3214
4368
|
object: 'commerce_product';
|
|
3215
4369
|
id: string;
|
|
@@ -3218,6 +4372,14 @@ interface CommerceProductJSON extends ClerkResourceJSON {
|
|
|
3218
4372
|
is_default: boolean;
|
|
3219
4373
|
plans: CommercePlanJSON[];
|
|
3220
4374
|
}
|
|
4375
|
+
/**
|
|
4376
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4377
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4378
|
+
* @example
|
|
4379
|
+
* ```tsx
|
|
4380
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4381
|
+
* ```
|
|
4382
|
+
*/
|
|
3221
4383
|
interface CommercePaymentSourceJSON extends ClerkResourceJSON {
|
|
3222
4384
|
object: 'commerce_payment_source';
|
|
3223
4385
|
id: string;
|
|
@@ -3229,12 +4391,28 @@ interface CommercePaymentSourceJSON extends ClerkResourceJSON {
|
|
|
3229
4391
|
status: CommercePaymentSourceStatus;
|
|
3230
4392
|
wallet_type: string | null;
|
|
3231
4393
|
}
|
|
4394
|
+
/**
|
|
4395
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4396
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4397
|
+
* @example
|
|
4398
|
+
* ```tsx
|
|
4399
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4400
|
+
* ```
|
|
4401
|
+
*/
|
|
3232
4402
|
interface CommerceInitializedPaymentSourceJSON extends ClerkResourceJSON {
|
|
3233
4403
|
object: 'commerce_payment_source_initialize';
|
|
3234
4404
|
external_client_secret: string;
|
|
3235
4405
|
external_gateway_id: string;
|
|
3236
4406
|
payment_method_order: string[];
|
|
3237
4407
|
}
|
|
4408
|
+
/**
|
|
4409
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4410
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4411
|
+
* @example
|
|
4412
|
+
* ```tsx
|
|
4413
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4414
|
+
* ```
|
|
4415
|
+
*/
|
|
3238
4416
|
interface CommerceStatementJSON extends ClerkResourceJSON {
|
|
3239
4417
|
object: 'commerce_statement';
|
|
3240
4418
|
id: string;
|
|
@@ -3243,11 +4421,27 @@ interface CommerceStatementJSON extends ClerkResourceJSON {
|
|
|
3243
4421
|
groups: CommerceStatementGroupJSON[];
|
|
3244
4422
|
totals: CommerceStatementTotalsJSON;
|
|
3245
4423
|
}
|
|
4424
|
+
/**
|
|
4425
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4426
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4427
|
+
* @example
|
|
4428
|
+
* ```tsx
|
|
4429
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4430
|
+
* ```
|
|
4431
|
+
*/
|
|
3246
4432
|
interface CommerceStatementGroupJSON extends ClerkResourceJSON {
|
|
3247
4433
|
object: 'commerce_statement_group';
|
|
3248
4434
|
timestamp: number;
|
|
3249
4435
|
items: CommercePaymentJSON[];
|
|
3250
4436
|
}
|
|
4437
|
+
/**
|
|
4438
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4439
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4440
|
+
* @example
|
|
4441
|
+
* ```tsx
|
|
4442
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4443
|
+
* ```
|
|
4444
|
+
*/
|
|
3251
4445
|
interface CommercePaymentJSON extends ClerkResourceJSON {
|
|
3252
4446
|
object: 'commerce_payment';
|
|
3253
4447
|
id: string;
|
|
@@ -3261,6 +4455,14 @@ interface CommercePaymentJSON extends ClerkResourceJSON {
|
|
|
3261
4455
|
charge_type: CommercePaymentChargeType;
|
|
3262
4456
|
status: CommercePaymentStatus;
|
|
3263
4457
|
}
|
|
4458
|
+
/**
|
|
4459
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4460
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4461
|
+
* @example
|
|
4462
|
+
* ```tsx
|
|
4463
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4464
|
+
* ```
|
|
4465
|
+
*/
|
|
3264
4466
|
interface CommerceSubscriptionJSON extends ClerkResourceJSON {
|
|
3265
4467
|
object: 'commerce_subscription';
|
|
3266
4468
|
id: string;
|
|
@@ -3277,12 +4479,28 @@ interface CommerceSubscriptionJSON extends ClerkResourceJSON {
|
|
|
3277
4479
|
period_end: number;
|
|
3278
4480
|
canceled_at: number | null;
|
|
3279
4481
|
}
|
|
4482
|
+
/**
|
|
4483
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4484
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4485
|
+
* @example
|
|
4486
|
+
* ```tsx
|
|
4487
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4488
|
+
* ```
|
|
4489
|
+
*/
|
|
3280
4490
|
interface CommerceMoneyJSON {
|
|
3281
4491
|
amount: number;
|
|
3282
4492
|
amount_formatted: string;
|
|
3283
4493
|
currency: string;
|
|
3284
4494
|
currency_symbol: string;
|
|
3285
4495
|
}
|
|
4496
|
+
/**
|
|
4497
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4498
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4499
|
+
* @example
|
|
4500
|
+
* ```tsx
|
|
4501
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4502
|
+
* ```
|
|
4503
|
+
*/
|
|
3286
4504
|
interface CommerceCheckoutTotalsJSON {
|
|
3287
4505
|
grand_total: CommerceMoneyJSON;
|
|
3288
4506
|
subtotal: CommerceMoneyJSON;
|
|
@@ -3290,8 +4508,24 @@ interface CommerceCheckoutTotalsJSON {
|
|
|
3290
4508
|
total_due_now: CommerceMoneyJSON;
|
|
3291
4509
|
credit: CommerceMoneyJSON;
|
|
3292
4510
|
}
|
|
4511
|
+
/**
|
|
4512
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4513
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4514
|
+
* @example
|
|
4515
|
+
* ```tsx
|
|
4516
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4517
|
+
* ```
|
|
4518
|
+
*/
|
|
3293
4519
|
interface CommerceStatementTotalsJSON extends Omit<CommerceCheckoutTotalsJSON, 'total_due_now'> {
|
|
3294
4520
|
}
|
|
4521
|
+
/**
|
|
4522
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
4523
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
4524
|
+
* @example
|
|
4525
|
+
* ```tsx
|
|
4526
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
4527
|
+
* ```
|
|
4528
|
+
*/
|
|
3295
4529
|
interface CommerceCheckoutJSON extends ClerkResourceJSON {
|
|
3296
4530
|
object: 'commerce_checkout';
|
|
3297
4531
|
id: string;
|
|
@@ -5792,7 +7026,16 @@ interface Clerk {
|
|
|
5792
7026
|
organization: OrganizationResource | null | undefined;
|
|
5793
7027
|
/** Current User. */
|
|
5794
7028
|
user: UserResource | null | undefined;
|
|
5795
|
-
/**
|
|
7029
|
+
/**
|
|
7030
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
7031
|
+
* @see https://clerk.com/docs/billing/overview
|
|
7032
|
+
*
|
|
7033
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
7034
|
+
* @example
|
|
7035
|
+
* ```tsx
|
|
7036
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
7037
|
+
* ```
|
|
7038
|
+
*/
|
|
5796
7039
|
billing: CommerceBillingNamespace;
|
|
5797
7040
|
telemetry: TelemetryCollector | undefined;
|
|
5798
7041
|
__internal_country?: string | null;
|
|
@@ -7107,6 +8350,16 @@ type RevokeAPIKeyParams = {
|
|
|
7107
8350
|
apiKeyID: string;
|
|
7108
8351
|
revocationReason?: string;
|
|
7109
8352
|
};
|
|
8353
|
+
/**
|
|
8354
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
8355
|
+
* @see https://clerk.com/docs/billing/overview
|
|
8356
|
+
*
|
|
8357
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
8358
|
+
* @example
|
|
8359
|
+
* ```tsx
|
|
8360
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
8361
|
+
* ```
|
|
8362
|
+
*/
|
|
7110
8363
|
type __internal_CheckoutProps = {
|
|
7111
8364
|
appearance?: CheckoutTheme;
|
|
7112
8365
|
planId?: string;
|
|
@@ -7122,6 +8375,16 @@ type __internal_CheckoutProps = {
|
|
|
7122
8375
|
newSubscriptionRedirectUrl?: string;
|
|
7123
8376
|
onClose?: () => void;
|
|
7124
8377
|
};
|
|
8378
|
+
/**
|
|
8379
|
+
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
|
|
8380
|
+
* @see https://clerk.com/docs/billing/overview
|
|
8381
|
+
*
|
|
8382
|
+
* It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.
|
|
8383
|
+
* @example
|
|
8384
|
+
* ```tsx
|
|
8385
|
+
* <ClerkProvider clerkJsVersion="x.x.x" />
|
|
8386
|
+
* ```
|
|
8387
|
+
*/
|
|
7125
8388
|
type __internal_PlanDetailsProps = {
|
|
7126
8389
|
appearance?: PlanDetailTheme;
|
|
7127
8390
|
plan?: CommercePlanResource;
|
|
@@ -7722,4 +8985,4 @@ type SharedSignedInAuthObjectProperties = {
|
|
|
7722
8985
|
factorVerificationAge: [firstFactorAge: number, secondFactorAge: number] | null;
|
|
7723
8986
|
};
|
|
7724
8987
|
|
|
7725
|
-
export { type APIKeyResource, type APIKeysNamespace, type APIKeysProps, type APIKeysSettingsJSON, type APIKeysSettingsJSONSnapshot, type APIKeysSettingsResource, type APIKeysTheme, type ActClaim, type ActJWTClaim, type Actions, type ActiveSessionResource, type AddMemberParams, type AddPaymentSourceParams, type AfterMultiSessionSingleSignOutUrl, type AfterSignOutUrl, type AlertId, type AlphaColorScale, type ApiKeyJSON, type Appearance, type AppleOauthProvider, type AtlassianOauthProvider, type AttemptAffiliationVerificationParams, type AttemptEmailAddressVerificationParams, type AttemptFirstFactorParams, type AttemptPhoneNumberVerificationParams, type AttemptSecondFactorParams, type AttemptVerificationParams, type AttemptWeb3WalletVerificationParams, type Attribute, type AttributeData, type AttributeDataJSON, type Attributes, type AttributesJSON, type AuthConfigJSON, type AuthConfigJSONSnapshot, type AuthConfigResource, type AuthenticateWithCoinbaseWalletParams, type AuthenticateWithGoogleOneTapParams, type AuthenticateWithMetamaskParams, type AuthenticateWithOKXWalletParams, type AuthenticateWithPasskeyParams, type AuthenticateWithPopupParams, type AuthenticateWithRedirectParams, type AuthenticateWithWeb3Params, type Autocomplete, type BackupCodeAttempt, type BackupCodeFactor, type BackupCodeJSON, type BackupCodeResource, type BackupCodeStrategy, type BaseTheme, type BaseThemeTaggedType, type BeforeEmitCallback, type BitbucketOauthProvider, type BoxOauthProvider, type BoxShadow, type BuiltInColors, type CamelToSnake, type CancelSubscriptionParams, type CaptchaAppearanceOptions, type CaptchaProvider, type CaptchaWidgetType, type CardActionId, type CheckAuthorization, type CheckAuthorizationFn, type CheckAuthorizationFromSessionClaims, type CheckAuthorizationParamsFromSessionClaims, type CheckAuthorizationParamsWithCustomPermissions, type CheckAuthorizationWithCustomPermissions, type CheckoutTheme, type Clerk, type ClerkAPIError, type ClerkAPIErrorJSON, type ClerkAuthenticateWithWeb3Params, type ClerkEventPayload, type ClerkHostRouter, type ClerkJWTClaims, type ClerkOptions, type ClerkPaginatedResponse, type ClerkPaginationParams, type ClerkPaginationRequest, type ClerkResource, type ClerkResourceJSON, type ClerkResourceReloadParams, type ClerkRuntimeError, type ClerkStatus, type ClerkThemeOptions, type ClientJSON, type ClientJSONSnapshot, type ClientResource, type CodeVerificationAttemptParam, type CoinbaseOauthProvider, type CoinbaseWalletWeb3Provider, type Color, type ColorScale, type ColorScaleWithRequiredBase, type ColorString, type CommerceBillingNamespace, type CommerceCheckoutJSON, type CommerceCheckoutResource, type CommerceCheckoutTotals, type CommerceCheckoutTotalsJSON, type CommerceFeatureJSON, type CommerceFeatureJSONSnapshot, type CommerceFeatureResource, type CommerceInitializedPaymentSourceJSON, type CommerceInitializedPaymentSourceResource, type CommerceMoney, type CommerceMoneyJSON, type CommercePaymentChargeType, type CommercePaymentJSON, type CommercePaymentResource, type CommercePaymentSourceJSON, type CommercePaymentSourceMethods, type CommercePaymentSourceResource, type CommercePaymentSourceStatus, type CommercePaymentStatus, type CommercePlanJSON, type CommercePlanJSONSnapshot, type CommercePlanResource, type CommerceProductJSON, type CommerceProductResource, type CommerceSettingsJSON, type CommerceSettingsJSONSnapshot, type CommerceSettingsResource, type CommerceStatementGroup, type CommerceStatementGroupJSON, type CommerceStatementJSON, type CommerceStatementResource, type CommerceStatementStatus, type CommerceStatementTotals, type CommerceStatementTotalsJSON, type CommerceSubscriberType, type CommerceSubscriptionJSON, type CommerceSubscriptionPlanPeriod, type CommerceSubscriptionResource, type CommerceSubscriptionStatus, type ComplexityErrors, type ConfirmCheckoutParams, type CreateAPIKeyParams, type CreateBulkOrganizationInvitationParams, type CreateCheckoutParams, type CreateEmailAddressParams, type CreateEmailLinkFlowReturn, type CreateEnterpriseSSOLinkFlowReturn, type CreateExternalAccountParams, type CreateOrganizationInvitationParams, type CreateOrganizationModalProps, type CreateOrganizationParams, type CreateOrganizationProps, type CreateOrganizationTheme, type CreatePhoneNumberParams, type CreateWeb3WalletParams, type CredentialReturn, type CssColorOrAlphaScale, type CssColorOrScale, type CustomMenuItem, type CustomNavigation, type CustomOAuthStrategy, type CustomOauthProvider, type CustomPage, type DeepCamelToSnake, type DeepPartial, type DeepRequired, type DeepSnakeToCamel, type DeletedObjectJSON, type DeletedObjectResource, type DiscordOauthProvider, type DisplayConfigJSON, type DisplayConfigJSONSnapshot, type DisplayConfigResource, type DisplayThemeJSON, type DomainOrProxyUrl, type DropboxOauthProvider, type ElementObjectKey, type ElementState, type Elements, type ElementsConfig, type EmUnit, type EmailAddressIdentifier, type EmailAddressJSON, type EmailAddressJSONSnapshot, type EmailAddressOrPhoneNumberIdentifier, type EmailAddressResource, type EmailCodeAttempt, type EmailCodeConfig, type EmailCodeFactor, type EmailCodeStrategy, type EmailLinkConfig, type EmailLinkFactor, type EmailLinkStrategy, type EnstallOauthProvider, type EnterpriseAccountConnectionJSON, type EnterpriseAccountConnectionJSONSnapshot, type EnterpriseAccountConnectionResource, type EnterpriseAccountJSON, type EnterpriseAccountJSONSnapshot, type EnterpriseAccountResource, type EnterpriseProtocol, type EnterpriseProvider, type EnterpriseSSOConfig, type EnterpriseSSOFactor, type EnterpriseSSOSettings, type EnterpriseSSOStrategy, type EnvironmentJSON, type EnvironmentJSONSnapshot, type EnvironmentResource, type ExternalAccountJSON, type ExternalAccountJSONSnapshot, type ExternalAccountResource, type FacebookOauthProvider, type FieldId, type FirstNameAttribute, type FontFamily, type FontWeight, type GenerateSignature, type GenerateSignatureParams, type GetAPIKeysParams, type GetDomainsParams, type GetInvitationsParams, type GetMembersParams, type GetMembershipRequestParams, type GetMemberships, type GetOrganizationMemberships, type GetPaymentAttemptsParams, type GetPaymentSourcesParams, type GetPlansParams, type GetRolesParams, type GetStatementsParams, type GetSubscriptionsParams, type GetToken, type GetTokenOptions, type GetUserOrganizationInvitationsParams, type GetUserOrganizationMembershipParams, type GetUserOrganizationSuggestionsParams, type GithubOauthProvider, type GitlabOauthProvider, type GoogleOauthProvider, type GoogleOneTapProps, type GoogleOneTapStrategy, type HandleEmailLinkVerificationParams, type HandleOAuthCallbackParams, type HandleSamlCallbackParams, type HexColor, type HexColorString, type HslaColor, type HslaColorString, type HubspotOauthProvider, type HuggingfaceOAuthProvider, type IdSelectors, type IdentificationLinkJSON, type IdentificationLinkJSONSnapshot, type IdentificationLinkResource, type ImageJSON, type ImageResource, type InitialState, type InitializePaymentSourceParams, type InstagramOauthProvider, type InstanceType, type InviteMemberParams, type InviteMembersParams, type JWT, type JWTClaims, type JWTHeader, type JoinWaitlistParams, type Jwt, type JwtHeader, type JwtPayload, type LastNameAttribute, type Layout, type LegacyRedirectProps, type LegalAcceptedAttribute, type LineOauthProvider, type LinearOauthProvider, type LinkedinOIDCOauthProvider, type LinkedinOauthProvider, type ListenerCallback, type LoadedClerk, type LocalizationResource, type LocalizationValue, type MakeDefaultPaymentSourceParams, type MenuId, type MetamaskWeb3Provider, type MicrosoftOauthProvider, type MultiDomainAndOrProxy, type MultiDomainAndOrProxyPrimitives, type NavigateOptions, type NewSubscriptionRedirectUrl, type NextTaskParams, type NotionOauthProvider, type Nullable, OAUTH_PROVIDERS, type OAuthConfig, type OAuthConsentTheme, type OAuthProvider, type OAuthProviderData, type OAuthProviderSettings, type OAuthProviders, type OAuthScope, type OAuthStrategy, type OKXWalletWeb3Provider, type OauthFactor, type OrganizationCustomPermissionKey, type OrganizationCustomRoleKey, type OrganizationDomainJSON, type OrganizationDomainResource, type OrganizationDomainVerification, type OrganizationDomainVerificationJSON, type OrganizationDomainVerificationStatus, type OrganizationEnrollmentMode, type OrganizationInvitationJSON, type OrganizationInvitationResource, type OrganizationInvitationStatus, type OrganizationJSON, type OrganizationJSONSnapshot, type OrganizationListProps, type OrganizationListTheme, type OrganizationMembershipJSON, type OrganizationMembershipJSONSnapshot, type OrganizationMembershipRequestJSON, type OrganizationMembershipRequestResource, type OrganizationMembershipResource, type OrganizationPermissionKey, type OrganizationPreviewId, type OrganizationProfileModalProps, type OrganizationProfileProps, type OrganizationProfileTheme, type OrganizationResource, type OrganizationSettingsJSON, type OrganizationSettingsJSONSnapshot, type OrganizationSettingsResource, type OrganizationSuggestionJSON, type OrganizationSuggestionResource, type OrganizationSuggestionStatus, type OrganizationSwitcherProps, type OrganizationSwitcherTheme, type OrganizationSystemPermissionKey, type OrganizationSystemPermissionPrefix, type OrganizationsJWTClaim, type Override, type PartialWithClerkResource, type PassKeyConfig, type PasskeyAttempt, type PasskeyFactor, type PasskeyJSON, type PasskeyJSONSnapshot, type PasskeyResource, type PasskeySettingsData, type PasskeyStrategy, type PasskeyVerificationResource, type PasswordAttempt, type PasswordAttribute, type PasswordFactor, type PasswordSettingsData, type PasswordStrategy, type PasswordStrength, type PasswordValidation, type PathValue, type PaymentGateway, type PendingSessionOptions, type PendingSessionResource, type PermissionJSON, type PermissionResource, type PhoneCodeAttempt, type PhoneCodeChannel, type PhoneCodeChannelData, type PhoneCodeConfig, type PhoneCodeFactor, type PhoneCodeProvider, type PhoneCodeSMSChannel, type PhoneCodeSecondFactorConfig, type PhoneCodeStrategy, type PhoneCodeWhatsAppChannel, type PhoneNumberIdentifier, type PhoneNumberJSON, type PhoneNumberJSONSnapshot, type PhoneNumberResource, type PhoneNumberVerificationStrategy, type PlanDetailTheme, type PreferredSignInStrategy, type PrepareAffiliationVerificationParams, type PrepareEmailAddressVerificationParams, type PrepareFirstFactorParams, type PreparePhoneNumberVerificationParams, type PrepareSecondFactorParams, type PrepareVerificationParams, type PrepareWeb3WalletVerificationParams, type PricingTableProps, type PricingTableTheme, type ProfilePageId, type ProfileSectionId, type ProtectProps, type PublicKeyCredentialCreationOptionsJSON, type PublicKeyCredentialCreationOptionsWithoutExtensions, type PublicKeyCredentialRequestOptionsJSON, type PublicKeyCredentialRequestOptionsWithoutExtensions, type PublicKeyCredentialWithAuthenticatorAssertionResponse, type PublicKeyCredentialWithAuthenticatorAttestationResponse, type PublicOrganizationDataJSON, type PublicUserData, type PublicUserDataJSON, type PublicUserDataJSONSnapshot, type PublishableKey, type ReauthorizeExternalAccountParams, type RecordToPath, type RedirectOptions, type RedirectUrlProp, type RemovePaymentSourceParams, type RemoveUserPasswordParams, type ResetPasswordCodeFactor, type ResetPasswordEmailCodeAttempt, type ResetPasswordEmailCodeFactor, type ResetPasswordEmailCodeFactorConfig, type ResetPasswordEmailCodeStrategy, type ResetPasswordParams, type ResetPasswordPhoneCodeAttempt, type ResetPasswordPhoneCodeFactor, type ResetPasswordPhoneCodeFactorConfig, type ResetPasswordPhoneCodeStrategy, type Resources, type ReverificationConfig, type RevokeAPIKeyParams, type RgbaColor, type RgbaColorString, type RoleJSON, type RoleResource, type RoutingMode, type RoutingOptions, type RoutingStrategy, SAML_IDPS, type SDKMetadata, type SamlAccountConnectionJSON, type SamlAccountConnectionJSONSnapshot, type SamlAccountConnectionResource, type SamlAccountJSON, type SamlAccountJSONSnapshot, type SamlAccountResource, type SamlConfig, type SamlFactor, type SamlIdp, type SamlIdpMap, type SamlIdpSlug, type SamlSettings, type SamlStrategy, type SelectId, type Serializable, type ServerGetToken, type ServerGetTokenOptions, type SessionActivity, type SessionActivityJSON, type SessionJSON, type SessionJSONSnapshot, type SessionResource, type SessionStatus, type SessionStatusClaim, type SessionTask, type SessionVerificationAfterMinutes, type SessionVerificationFirstFactor, type SessionVerificationJSON, type SessionVerificationLevel, type SessionVerificationResource, type SessionVerificationSecondFactor, type SessionVerificationStatus, type SessionVerificationTypes, type SessionVerifyAttemptFirstFactorParams, type SessionVerifyAttemptSecondFactorParams, type SessionVerifyCreateParams, type SessionVerifyPrepareFirstFactorParams, type SessionVerifyPrepareSecondFactorParams, type SessionWithActivitiesJSON, type SessionWithActivitiesResource, type SetActive, type SetActiveParams, type SetOrganizationLogoParams, type SetProfileImageParams, type SetReservedForSecondFactorParams, type SharedSignedInAuthObjectProperties, type SignInButtonProps, type SignInCreateParams, type SignInData, type SignInFactor, type SignInFallbackRedirectUrl, type SignInFirstFactor, type SignInFirstFactorJSON, type SignInForceRedirectUrl, type SignInIdentifier, type SignInInitialValues, type SignInJSON, type SignInJSONSnapshot, type SignInModalProps, type SignInProps, type SignInRedirectOptions, type SignInResource, type SignInSecondFactor, type SignInSecondFactorJSON, type SignInStartEmailLinkFlowParams, type SignInStatus, type SignInStrategy, type SignInTheme, type SignOut, type SignOutCallback, type SignOutOptions, type SignUpAttributeField, type SignUpAuthenticateWithMetamaskParams, type SignUpAuthenticateWithWeb3Params, type SignUpButtonProps, type SignUpCreateParams, type SignUpData, type SignUpFallbackRedirectUrl, type SignUpField, type SignUpForceRedirectUrl, type SignUpIdentificationField, type SignUpInitialValues, type SignUpJSON, type SignUpJSONSnapshot, type SignUpModalProps, type SignUpModes, type SignUpProps, type SignUpRedirectOptions, type SignUpResource, type SignUpStatus, type SignUpTheme, type SignUpUpdateParams, type SignUpVerifiableField, type SignUpVerificationJSON, type SignUpVerificationJSONSnapshot, type SignUpVerificationResource, type SignUpVerificationsJSON, type SignUpVerificationsJSONSnapshot, type SignUpVerificationsResource, type SignatureVerificationAttemptParam, type SignedInSessionResource, type SlackOauthProvider, type SnakeToCamel, type SpotifyOauthProvider, type StartEmailLinkFlowParams, type StartEnterpriseSSOLinkFlowParams, type StateSelectors, type TOTPAttempt, type TOTPFactor, type TOTPJSON, type TOTPResource, type TOTPStrategy, type TelemetryCollector, type TelemetryEvent, type TelemetryEventRaw, type Theme, type TicketStrategy, type TiktokOauthProvider, type TokenJSON, type TokenJSONSnapshot, type TokenResource, type TransferableOption, type TransparentColor, type TwitchOauthProvider, type TwitterOauthProvider, type UnsubscribeCallback, type UpdateEnrollmentModeParams, type UpdateMembershipParams, type UpdateOrganizationMembershipParams, type UpdateOrganizationParams, type UpdatePasskeyParams, type UpdateUserParams, type UpdateUserPasswordParams, type UseAuthReturn, type UseSessionListReturn, type UseSessionReturn, type UseSignInReturn, type UseSignUpReturn, type UseUserReturn, type UserButtonProps, type UserButtonTheme, type UserData, type UserDataJSON, type UserDataJSONSnapshot, type UserJSON, type UserJSONSnapshot, type UserOrganizationInvitationJSON, type UserOrganizationInvitationResource, type UserPreviewId, type UserProfileModalProps, type UserProfileProps, type UserProfileTheme, type UserResource, type UserSettingsJSON, type UserSettingsJSONSnapshot, type UserSettingsResource, type UserVerificationTheme, type UsernameIdentifier, type UsernameSettingsData, type ValidatePasswordCallbacks, type Variables, type VerificationAttemptParams, type VerificationJSON, type VerificationJSONSnapshot, type VerificationResource, type VerificationStatus, type VerificationStrategy, type VerifyTOTPParams, type VersionedJwtPayload, WEB3_PROVIDERS, type WaitlistJSON, type WaitlistModalProps, type WaitlistProps, type WaitlistResource, type WaitlistTheme, type Web3Attempt, type Web3Provider, type Web3ProviderData, type Web3SignatureConfig, type Web3SignatureFactor, type Web3Strategy, type Web3WalletIdentifier, type Web3WalletJSON, type Web3WalletJSONSnapshot, type Web3WalletResource, type Without, type WithoutRouting, type XOauthProvider, type XeroOauthProvider, type ZxcvbnResult, type __internal_CheckoutProps, type __internal_ComponentNavigationContext, type __internal_LocalizationResource, type __internal_OAuthConsentProps, type __internal_PlanDetailsProps, type __internal_UserVerificationModalProps, type __internal_UserVerificationProps, getOAuthProviderData, getWeb3ProviderData, sortedOAuthProviders };
|
|
8988
|
+
export { type APIKeyResource, type APIKeysNamespace, type APIKeysProps, type APIKeysSettingsJSON, type APIKeysSettingsJSONSnapshot, type APIKeysSettingsResource, type APIKeysTheme, type ActClaim, type ActJWTClaim, type Actions, type ActiveSessionResource, type AddMemberParams, type AddPaymentSourceParams, type AfterMultiSessionSingleSignOutUrl, type AfterSignOutUrl, type AlertId, type AlphaColorScale, type ApiKeyJSON, type Appearance, type AppleOauthProvider, type AtlassianOauthProvider, type AttemptAffiliationVerificationParams, type AttemptEmailAddressVerificationParams, type AttemptFirstFactorParams, type AttemptPhoneNumberVerificationParams, type AttemptSecondFactorParams, type AttemptVerificationParams, type AttemptWeb3WalletVerificationParams, type Attribute, type AttributeData, type AttributeDataJSON, type Attributes, type AttributesJSON, type AuthConfigJSON, type AuthConfigJSONSnapshot, type AuthConfigResource, type AuthenticateWithCoinbaseWalletParams, type AuthenticateWithGoogleOneTapParams, type AuthenticateWithMetamaskParams, type AuthenticateWithOKXWalletParams, type AuthenticateWithPasskeyParams, type AuthenticateWithPopupParams, type AuthenticateWithRedirectParams, type AuthenticateWithWeb3Params, type Autocomplete, type BackupCodeAttempt, type BackupCodeFactor, type BackupCodeJSON, type BackupCodeResource, type BackupCodeStrategy, type BaseTheme, type BaseThemeTaggedType, type BeforeEmitCallback, type BitbucketOauthProvider, type BoxOauthProvider, type BoxShadow, type BuiltInColors, type CamelToSnake, type CancelSubscriptionParams, type CaptchaAppearanceOptions, type CaptchaProvider, type CaptchaWidgetType, type CardActionId, type CheckAuthorization, type CheckAuthorizationFn, type CheckAuthorizationFromSessionClaims, type CheckAuthorizationParamsFromSessionClaims, type CheckAuthorizationParamsWithCustomPermissions, type CheckAuthorizationWithCustomPermissions, type CheckoutTheme, type Clerk, type ClerkAPIError, type ClerkAPIErrorJSON, type ClerkAPIResponseError, type ClerkAuthenticateWithWeb3Params, type ClerkEventPayload, type ClerkHostRouter, type ClerkJWTClaims, type ClerkOptions, type ClerkPaginatedResponse, type ClerkPaginationParams, type ClerkPaginationRequest, type ClerkResource, type ClerkResourceJSON, type ClerkResourceReloadParams, type ClerkRuntimeError, type ClerkStatus, type ClerkThemeOptions, type ClientJSON, type ClientJSONSnapshot, type ClientResource, type CodeVerificationAttemptParam, type CoinbaseOauthProvider, type CoinbaseWalletWeb3Provider, type Color, type ColorScale, type ColorScaleWithRequiredBase, type ColorString, type CommerceBillingNamespace, type CommerceCheckoutJSON, type CommerceCheckoutResource, type CommerceCheckoutTotals, type CommerceCheckoutTotalsJSON, type CommerceFeatureJSON, type CommerceFeatureJSONSnapshot, type CommerceFeatureResource, type CommerceInitializedPaymentSourceJSON, type CommerceInitializedPaymentSourceResource, type CommerceMoney, type CommerceMoneyJSON, type CommercePaymentChargeType, type CommercePaymentJSON, type CommercePaymentResource, type CommercePaymentSourceJSON, type CommercePaymentSourceMethods, type CommercePaymentSourceResource, type CommercePaymentSourceStatus, type CommercePaymentStatus, type CommercePlanJSON, type CommercePlanJSONSnapshot, type CommercePlanResource, type CommerceProductJSON, type CommerceProductResource, type CommerceSettingsJSON, type CommerceSettingsJSONSnapshot, type CommerceSettingsResource, type CommerceStatementGroup, type CommerceStatementGroupJSON, type CommerceStatementJSON, type CommerceStatementResource, type CommerceStatementStatus, type CommerceStatementTotals, type CommerceStatementTotalsJSON, type CommerceSubscriberType, type CommerceSubscriptionJSON, type CommerceSubscriptionPlanPeriod, type CommerceSubscriptionResource, type CommerceSubscriptionStatus, type ComplexityErrors, type ConfirmCheckoutParams, type CreateAPIKeyParams, type CreateBulkOrganizationInvitationParams, type CreateCheckoutParams, type CreateEmailAddressParams, type CreateEmailLinkFlowReturn, type CreateEnterpriseSSOLinkFlowReturn, type CreateExternalAccountParams, type CreateOrganizationInvitationParams, type CreateOrganizationModalProps, type CreateOrganizationParams, type CreateOrganizationProps, type CreateOrganizationTheme, type CreatePhoneNumberParams, type CreateWeb3WalletParams, type CredentialReturn, type CssColorOrAlphaScale, type CssColorOrScale, type CustomMenuItem, type CustomNavigation, type CustomOAuthStrategy, type CustomOauthProvider, type CustomPage, type DeepCamelToSnake, type DeepPartial, type DeepRequired, type DeepSnakeToCamel, type DeletedObjectJSON, type DeletedObjectResource, type DiscordOauthProvider, type DisplayConfigJSON, type DisplayConfigJSONSnapshot, type DisplayConfigResource, type DisplayThemeJSON, type DomainOrProxyUrl, type DropboxOauthProvider, type ElementObjectKey, type ElementState, type Elements, type ElementsConfig, type EmUnit, type EmailAddressIdentifier, type EmailAddressJSON, type EmailAddressJSONSnapshot, type EmailAddressOrPhoneNumberIdentifier, type EmailAddressResource, type EmailCodeAttempt, type EmailCodeConfig, type EmailCodeFactor, type EmailCodeStrategy, type EmailLinkConfig, type EmailLinkFactor, type EmailLinkStrategy, type EnstallOauthProvider, type EnterpriseAccountConnectionJSON, type EnterpriseAccountConnectionJSONSnapshot, type EnterpriseAccountConnectionResource, type EnterpriseAccountJSON, type EnterpriseAccountJSONSnapshot, type EnterpriseAccountResource, type EnterpriseProtocol, type EnterpriseProvider, type EnterpriseSSOConfig, type EnterpriseSSOFactor, type EnterpriseSSOSettings, type EnterpriseSSOStrategy, type EnvironmentJSON, type EnvironmentJSONSnapshot, type EnvironmentResource, type ExternalAccountJSON, type ExternalAccountJSONSnapshot, type ExternalAccountResource, type FacebookOauthProvider, type FieldId, type FirstNameAttribute, type FontFamily, type FontWeight, type GenerateSignature, type GenerateSignatureParams, type GetAPIKeysParams, type GetDomainsParams, type GetInvitationsParams, type GetMembersParams, type GetMembershipRequestParams, type GetMemberships, type GetOrganizationMemberships, type GetPaymentAttemptsParams, type GetPaymentSourcesParams, type GetPlansParams, type GetRolesParams, type GetStatementsParams, type GetSubscriptionsParams, type GetToken, type GetTokenOptions, type GetUserOrganizationInvitationsParams, type GetUserOrganizationMembershipParams, type GetUserOrganizationSuggestionsParams, type GithubOauthProvider, type GitlabOauthProvider, type GoogleOauthProvider, type GoogleOneTapProps, type GoogleOneTapStrategy, type HandleEmailLinkVerificationParams, type HandleOAuthCallbackParams, type HandleSamlCallbackParams, type HexColor, type HexColorString, type HslaColor, type HslaColorString, type HubspotOauthProvider, type HuggingfaceOAuthProvider, type IdSelectors, type IdentificationLinkJSON, type IdentificationLinkJSONSnapshot, type IdentificationLinkResource, type ImageJSON, type ImageResource, type InitialState, type InitializePaymentSourceParams, type InstagramOauthProvider, type InstanceType, type InviteMemberParams, type InviteMembersParams, type JWT, type JWTClaims, type JWTHeader, type JoinWaitlistParams, type Jwt, type JwtHeader, type JwtPayload, type LastNameAttribute, type Layout, type LegacyRedirectProps, type LegalAcceptedAttribute, type LineOauthProvider, type LinearOauthProvider, type LinkedinOIDCOauthProvider, type LinkedinOauthProvider, type ListenerCallback, type LoadedClerk, type LocalizationResource, type LocalizationValue, type MakeDefaultPaymentSourceParams, type MenuId, type MetamaskWeb3Provider, type MicrosoftOauthProvider, type MultiDomainAndOrProxy, type MultiDomainAndOrProxyPrimitives, type NavigateOptions, type NewSubscriptionRedirectUrl, type NextTaskParams, type NotionOauthProvider, type Nullable, OAUTH_PROVIDERS, type OAuthConfig, type OAuthConsentTheme, type OAuthProvider, type OAuthProviderData, type OAuthProviderSettings, type OAuthProviders, type OAuthScope, type OAuthStrategy, type OKXWalletWeb3Provider, type OauthFactor, type OrganizationCustomPermissionKey, type OrganizationCustomRoleKey, type OrganizationDomainJSON, type OrganizationDomainResource, type OrganizationDomainVerification, type OrganizationDomainVerificationJSON, type OrganizationDomainVerificationStatus, type OrganizationEnrollmentMode, type OrganizationInvitationJSON, type OrganizationInvitationResource, type OrganizationInvitationStatus, type OrganizationJSON, type OrganizationJSONSnapshot, type OrganizationListProps, type OrganizationListTheme, type OrganizationMembershipJSON, type OrganizationMembershipJSONSnapshot, type OrganizationMembershipRequestJSON, type OrganizationMembershipRequestResource, type OrganizationMembershipResource, type OrganizationPermissionKey, type OrganizationPreviewId, type OrganizationProfileModalProps, type OrganizationProfileProps, type OrganizationProfileTheme, type OrganizationResource, type OrganizationSettingsJSON, type OrganizationSettingsJSONSnapshot, type OrganizationSettingsResource, type OrganizationSuggestionJSON, type OrganizationSuggestionResource, type OrganizationSuggestionStatus, type OrganizationSwitcherProps, type OrganizationSwitcherTheme, type OrganizationSystemPermissionKey, type OrganizationSystemPermissionPrefix, type OrganizationsJWTClaim, type Override, type PartialWithClerkResource, type PassKeyConfig, type PasskeyAttempt, type PasskeyFactor, type PasskeyJSON, type PasskeyJSONSnapshot, type PasskeyResource, type PasskeySettingsData, type PasskeyStrategy, type PasskeyVerificationResource, type PasswordAttempt, type PasswordAttribute, type PasswordFactor, type PasswordSettingsData, type PasswordStrategy, type PasswordStrength, type PasswordValidation, type PathValue, type PaymentGateway, type PendingSessionOptions, type PendingSessionResource, type PermissionJSON, type PermissionResource, type PhoneCodeAttempt, type PhoneCodeChannel, type PhoneCodeChannelData, type PhoneCodeConfig, type PhoneCodeFactor, type PhoneCodeProvider, type PhoneCodeSMSChannel, type PhoneCodeSecondFactorConfig, type PhoneCodeStrategy, type PhoneCodeWhatsAppChannel, type PhoneNumberIdentifier, type PhoneNumberJSON, type PhoneNumberJSONSnapshot, type PhoneNumberResource, type PhoneNumberVerificationStrategy, type PlanDetailTheme, type PreferredSignInStrategy, type PrepareAffiliationVerificationParams, type PrepareEmailAddressVerificationParams, type PrepareFirstFactorParams, type PreparePhoneNumberVerificationParams, type PrepareSecondFactorParams, type PrepareVerificationParams, type PrepareWeb3WalletVerificationParams, type PricingTableProps, type PricingTableTheme, type ProfilePageId, type ProfileSectionId, type ProtectProps, type PublicKeyCredentialCreationOptionsJSON, type PublicKeyCredentialCreationOptionsWithoutExtensions, type PublicKeyCredentialRequestOptionsJSON, type PublicKeyCredentialRequestOptionsWithoutExtensions, type PublicKeyCredentialWithAuthenticatorAssertionResponse, type PublicKeyCredentialWithAuthenticatorAttestationResponse, type PublicOrganizationDataJSON, type PublicUserData, type PublicUserDataJSON, type PublicUserDataJSONSnapshot, type PublishableKey, type ReauthorizeExternalAccountParams, type RecordToPath, type RedirectOptions, type RedirectUrlProp, type RemovePaymentSourceParams, type RemoveUserPasswordParams, type ResetPasswordCodeFactor, type ResetPasswordEmailCodeAttempt, type ResetPasswordEmailCodeFactor, type ResetPasswordEmailCodeFactorConfig, type ResetPasswordEmailCodeStrategy, type ResetPasswordParams, type ResetPasswordPhoneCodeAttempt, type ResetPasswordPhoneCodeFactor, type ResetPasswordPhoneCodeFactorConfig, type ResetPasswordPhoneCodeStrategy, type Resources, type ReverificationConfig, type RevokeAPIKeyParams, type RgbaColor, type RgbaColorString, type RoleJSON, type RoleResource, type RoutingMode, type RoutingOptions, type RoutingStrategy, SAML_IDPS, type SDKMetadata, type SamlAccountConnectionJSON, type SamlAccountConnectionJSONSnapshot, type SamlAccountConnectionResource, type SamlAccountJSON, type SamlAccountJSONSnapshot, type SamlAccountResource, type SamlConfig, type SamlFactor, type SamlIdp, type SamlIdpMap, type SamlIdpSlug, type SamlSettings, type SamlStrategy, type SelectId, type Serializable, type ServerGetToken, type ServerGetTokenOptions, type SessionActivity, type SessionActivityJSON, type SessionJSON, type SessionJSONSnapshot, type SessionResource, type SessionStatus, type SessionStatusClaim, type SessionTask, type SessionVerificationAfterMinutes, type SessionVerificationFirstFactor, type SessionVerificationJSON, type SessionVerificationLevel, type SessionVerificationResource, type SessionVerificationSecondFactor, type SessionVerificationStatus, type SessionVerificationTypes, type SessionVerifyAttemptFirstFactorParams, type SessionVerifyAttemptSecondFactorParams, type SessionVerifyCreateParams, type SessionVerifyPrepareFirstFactorParams, type SessionVerifyPrepareSecondFactorParams, type SessionWithActivitiesJSON, type SessionWithActivitiesResource, type SetActive, type SetActiveParams, type SetOrganizationLogoParams, type SetProfileImageParams, type SetReservedForSecondFactorParams, type SharedSignedInAuthObjectProperties, type SignInButtonProps, type SignInCreateParams, type SignInData, type SignInFactor, type SignInFallbackRedirectUrl, type SignInFirstFactor, type SignInFirstFactorJSON, type SignInForceRedirectUrl, type SignInIdentifier, type SignInInitialValues, type SignInJSON, type SignInJSONSnapshot, type SignInModalProps, type SignInProps, type SignInRedirectOptions, type SignInResource, type SignInSecondFactor, type SignInSecondFactorJSON, type SignInStartEmailLinkFlowParams, type SignInStatus, type SignInStrategy, type SignInTheme, type SignOut, type SignOutCallback, type SignOutOptions, type SignUpAttributeField, type SignUpAuthenticateWithMetamaskParams, type SignUpAuthenticateWithWeb3Params, type SignUpButtonProps, type SignUpCreateParams, type SignUpData, type SignUpFallbackRedirectUrl, type SignUpField, type SignUpForceRedirectUrl, type SignUpIdentificationField, type SignUpInitialValues, type SignUpJSON, type SignUpJSONSnapshot, type SignUpModalProps, type SignUpModes, type SignUpProps, type SignUpRedirectOptions, type SignUpResource, type SignUpStatus, type SignUpTheme, type SignUpUpdateParams, type SignUpVerifiableField, type SignUpVerificationJSON, type SignUpVerificationJSONSnapshot, type SignUpVerificationResource, type SignUpVerificationsJSON, type SignUpVerificationsJSONSnapshot, type SignUpVerificationsResource, type SignatureVerificationAttemptParam, type SignedInSessionResource, type SlackOauthProvider, type SnakeToCamel, type SpotifyOauthProvider, type StartEmailLinkFlowParams, type StartEnterpriseSSOLinkFlowParams, type StateSelectors, type TOTPAttempt, type TOTPFactor, type TOTPJSON, type TOTPResource, type TOTPStrategy, type TelemetryCollector, type TelemetryEvent, type TelemetryEventRaw, type Theme, type TicketStrategy, type TiktokOauthProvider, type TokenJSON, type TokenJSONSnapshot, type TokenResource, type TransferableOption, type TransparentColor, type TwitchOauthProvider, type TwitterOauthProvider, type UnsubscribeCallback, type UpdateEnrollmentModeParams, type UpdateMembershipParams, type UpdateOrganizationMembershipParams, type UpdateOrganizationParams, type UpdatePasskeyParams, type UpdateUserParams, type UpdateUserPasswordParams, type UseAuthReturn, type UseSessionListReturn, type UseSessionReturn, type UseSignInReturn, type UseSignUpReturn, type UseUserReturn, type UserButtonProps, type UserButtonTheme, type UserData, type UserDataJSON, type UserDataJSONSnapshot, type UserJSON, type UserJSONSnapshot, type UserOrganizationInvitationJSON, type UserOrganizationInvitationResource, type UserPreviewId, type UserProfileModalProps, type UserProfileProps, type UserProfileTheme, type UserResource, type UserSettingsJSON, type UserSettingsJSONSnapshot, type UserSettingsResource, type UserVerificationTheme, type UsernameIdentifier, type UsernameSettingsData, type ValidatePasswordCallbacks, type Variables, type VerificationAttemptParams, type VerificationJSON, type VerificationJSONSnapshot, type VerificationResource, type VerificationStatus, type VerificationStrategy, type VerifyTOTPParams, type VersionedJwtPayload, WEB3_PROVIDERS, type WaitlistJSON, type WaitlistModalProps, type WaitlistProps, type WaitlistResource, type WaitlistTheme, type Web3Attempt, type Web3Provider, type Web3ProviderData, type Web3SignatureConfig, type Web3SignatureFactor, type Web3Strategy, type Web3WalletIdentifier, type Web3WalletJSON, type Web3WalletJSONSnapshot, type Web3WalletResource, type Without, type WithoutRouting, type XOauthProvider, type XeroOauthProvider, type ZxcvbnResult, type __internal_CheckoutProps, type __internal_ComponentNavigationContext, type __internal_LocalizationResource, type __internal_OAuthConsentProps, type __internal_PlanDetailsProps, type __internal_UserVerificationModalProps, type __internal_UserVerificationProps, getOAuthProviderData, getWeb3ProviderData, sortedOAuthProviders };
|