You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| <aid="approvedscopes"></a> `approvedScopes`|`string`| The scopes that the user has granted access to. |
10
10
| <aid="emailaddress"></a> `emailAddress`|`string`| The user's email address. |
11
-
| <aid="externalid"></a> `externalId`|`string`|The unique ID of the user in the provider. |
11
+
| <aid="externalid"></a> ~~`externalId`~~|`string`|**Deprecated.** Use `providerUserId` instead.|
12
12
| <aid="firstname"></a> `firstName`|`string`| The user's first name. |
13
13
| <aid="id"></a> `id`|`string`| The unique identifier for this external account. |
14
14
| <aid="identificationid"></a> `identificationId`|`string`| The identification with which this external account is associated. |
@@ -17,6 +17,7 @@ External account must be verified, so that you can make sure they can be assigne
17
17
| <aid="lastname"></a> `lastName`|`string`| The user's last name. |
18
18
| <aid="phonenumber"></a> `phoneNumber`| <code>null \| string</code> | The phone number related to this specific external account. |
19
19
| <aid="provider"></a> `provider`|`string`| The provider name (e.g., `google`). |
20
+
| <aid="provideruserid"></a> `providerUserId`|`string`| The unique ID of the user in the provider. |
20
21
| <aid="publicmetadata"></a> `publicMetadata`| <code>null \| Record\<string, unknown\></code> | Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API. |
| <aid="verification"></a> `verification`| <code>null \|[Verification](/docs/reference/backend/types/backend-verification)</code> | An object holding information on the verification of this external account. |
| <aid="createdat"></a> `createdAt`|`number`| The date when the waitlist entry was first created. |
8
+
| <aid="emailaddress"></a> `emailAddress`|`string`| The email address to add to the waitlist. |
9
+
| <aid="id"></a> `id`|`string`| The unique identifier for this waitlist entry. |
10
+
| <aid="invitation"></a> `invitation`| <code>null \|[Invitation](/docs/reference/backend/types/backend-invitation)</code> | The invitation associated with this waitlist entry. |
11
+
| <aid="islocked"></a> `isLocked?`|`boolean`| Whether the waitlist entry is locked or not. |
12
+
| <aid="status"></a> `status`| <code>"pending" \| "invited" \| "completed" \| "rejected"</code> | The status of the waitlist entry. |
13
+
| <aid="updatedat"></a> `updatedAt`|`number`| The date when the waitlist entry was last updated. |
Copy file name to clipboardExpand all lines: contributing/CONTRIBUTING.md
+68Lines changed: 68 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,6 +43,7 @@ If you're contributing specifically to our hooks and components documentation, p
43
43
-[`<TutorialHero />`](#tutorialhero-)
44
44
-[`<Cards>`](#cards)
45
45
-[`<Properties>`](#properties-1)
46
+
-[`<ComparisonTable>`](#comparisontable)
46
47
-[`<Include />`](#include-)
47
48
-[`<Typedoc />`](#typedoc-)
48
49
-[`<If />`](#if-)
@@ -1256,6 +1257,73 @@ Fallback markup to render while Clerk is loading. Default: `null`
1256
1257
1257
1258
</details>
1258
1259
1260
+
### `<ComparisonTable>`
1261
+
1262
+
The `<ComparisonTable>` component is used to create feature comparison tables with styled checkmarks, X marks, and section headers. The table header stays sticky when scrolling the page.
The `<Include/>` component can be used to inject the contents of another MDX file. We like to use this component to include partial files that are used in multiple pages. This way, you write the content once and only have to maintain it in one place.
> You can perform up to **5 user impersonations per month for free**. To increase this limit, refer to the [pricing page](/pricing){{ target: _blank }}.
A **Monthly Retained User (MRU)** is a user who visits your app in a given month at least **one day after signing up**. This free day avoids unwelcome fees from users who don't activate.
Copy file name to clipboardExpand all lines: docs/guides/billing/free-trials.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ To enable free trials for your Plans:
19
19
20
20
### Starting a trial
21
21
22
-
Only users who have never paid for a subscription and have never used a free trial can start a free trial.
22
+
Only users who have never paid for a Subscription and have never used a free trial can start a free trial.
23
23
24
24
A credit card is required to start a free trial. This helps prevent abuse and ensures a smooth transition to paid service when the trial ends.
25
25
@@ -29,9 +29,9 @@ Users get access to the Plan's paid Features for the configured number of days.
29
29
30
30
### When the trial ends
31
31
32
-
If the user didn't cancel their subscription during the trial, they are charged using their default payment method on file. This may be a different payment method than the one used during checkout when the trial started.
32
+
If the user didn't cancel their Subscription during the trial, they are charged using their default payment method on file. This may be a different payment method than the one used during checkout when the trial started.
33
33
34
-
If the user cancels their subscription during the trial, they lose access at the end of the trial and are moved back to the free plan. They are not charged.
34
+
If the user cancels their Subscription during the trial, they lose access at the end of the trial and are moved back to the free Plan. They are not charged.
35
35
36
36
Both you and your users will receive notifications when a trial is about to expire:
37
37
@@ -50,8 +50,8 @@ You can manually change the duration of a user's trial:
50
50
51
51
You can only manage the trial of a user while the trial is active. Once a trial ends, you can no longer extend or cancel it.
52
52
53
-
To manage a trial for a subscription:
53
+
To manage a trial for a Subscription:
54
54
55
-
1. Navigate to the [**Subscriptions**](https://dashboard.clerk.com/~/billing/subscriptions) page in the Clerk Dashboard.
56
-
1. Select the subscription with the trial you want to manage.
55
+
1. Navigate to the [**Billing**](https://dashboard.clerk.com/~/billing) page in the Clerk Dashboard.
56
+
1. Select the user whose trial you want to manage.
57
57
1. Under **Subscriptions**, select the **...** menu to see the available actions for managing the trial.
Clerk Billing allows your customers to purchase recurring subscriptions to your application. To get started, **choose one or combine both of the following** business models depending on your application's needs.
8
+
Clerk Billing allows your customers to purchase recurring Subscriptions to your application. To get started, **choose one or combine both of the following** business models depending on your application's needs.
9
9
10
10
<Cards>
11
11
-[Billing for B2C SaaS](/docs/guides/billing/for-b2c)
@@ -19,7 +19,7 @@ Clerk Billing allows your customers to purchase recurring subscriptions to your
- To track subscription lifecycles and monitor payment attempts
22
+
- To track Subscription lifecycles and monitor payment attempts
23
23
24
24
---
25
25
@@ -33,9 +33,9 @@ Clerk Billing allows your customers to purchase recurring subscriptions to your
33
33
34
34
Yes, you can. However, it must not already be linked to another platform.
35
35
36
-
### Can I see subscriptions in my Stripe account?
36
+
### Can I see Subscriptions in my Stripe account?
37
37
38
-
Clerk Billing only uses Stripe for payment processing. You can see payment and customer information in Stripe. However, Clerk Billing is a separate product from Stripe Billing; plans and subscriptions made in Clerk are not synced to Stripe.
38
+
Clerk Billing only uses Stripe for payment processing. You can see payment and customer information in Stripe. However, Clerk Billing is a separate product from Stripe Billing; Plans and Subscriptions made in Clerk are not synced to Stripe.
39
39
40
40
### Can I use the same Stripe account for both dev and prod environments?
41
41
@@ -61,15 +61,15 @@ Clerk Billing does not currently support custom pricing plans, though we plan to
61
61
62
62
Yes. Plan upgrades will take effect immediately, while downgrades take effect at the end of the current billing cycle.
63
63
64
-
### Does Clerk Billing support annual subscriptions?
64
+
### Does Clerk Billing support annual Subscriptions?
65
65
66
66
Yes, you can offer subscribers the option to pay annually, at a discounted monthly price. Annual pricing for your plans can be configured from the [**Subscription plans**](https://dashboard.clerk.com/~/billing/plans) page in the Clerk Dashboard. Customers can choose between monthly or annual billing when subscribing.
67
67
68
68
### How does Clerk handle taxes and VAT for international billing?
69
69
70
70
Clerk Billing does not currently support tax or VAT, but these are planned for future releases.
71
71
72
-
### How can I test failure scenarios like expired cards or canceled subscriptions?
72
+
### How can I test failure scenarios like expired cards or canceled Subscriptions?
73
73
74
74
You can simulate failures in Stripe test mode using test cards that trigger specific behaviors. See [Stripe Testing](https://docs.stripe.com/testing){{ rel: 'noopener noreferrer' }} for a list of test cards and behaviors.
0 commit comments