Skip to content

Commit 271ad88

Browse files
github-actions[bot]github-actions[bot]
authored
[ci] Update Typedoc (5720787) (#2639)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a318c72 commit 271ad88

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

‎clerk-typedoc/shared/clerk-runtime-error.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ throw new ClerkRuntimeError("An error occurred", { code: "password_invalid" });
1212

1313
| Property | Type | Description |
1414
| ------------------------------ | -------- | ------------------------------------------------------------------------------ |
15+
| <a id="cause"></a> `cause?` | `Error` | The original error that was caught to throw an instance of ClerkRuntimeError. |
1516
| <a id="code"></a> `code` | `string` | A unique code identifying the error, can be used for localization. |
1617
| <a id="message"></a> `message` | `string` | The error message in english, it contains a detailed description of the error. |

‎clerk-typedoc/types/billing-checkout-resource.mdx‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@ The `BillingCheckoutResource` type represents information about a checkout sessi
22

33
## Properties
44

5-
| Property | Type | Description |
6-
| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
7-
| <a id="confirm"></a> `confirm` | <code>(params: [ConfirmCheckoutParams](confirm-checkout-params.mdx)) => Promise\<BillingCheckoutResource\></code> | A function to confirm and finalize the checkout process, usually after payment information has been provided and validated. [Learn more.](#confirm) |
8-
| <a id="externalclientsecret"></a> `externalClientSecret` | `string` | A client secret from an external payment provider (such as Stripe) used to complete the payment on the client-side. |
9-
| <a id="externalgatewayid"></a> `externalGatewayId` | `string` | The identifier for the external payment gateway used for this checkout session. |
10-
| <a id="freetrialendsat"></a> `freeTrialEndsAt` | <code>null \| Date</code> | Unix timestamp (milliseconds) of when the free trial ends. |
11-
| <a id="id"></a> `id` | `string` | The unique identifier for the checkout session. |
12-
| <a id="isimmediateplanchange"></a> `isImmediatePlanChange` | `boolean` | Whether the plan change will take effect immediately after checkout. |
13-
| <a id="pathroot"></a> `pathRoot` | `string` | The root path of the resource. |
14-
| <a id="payer"></a> `payer` | [`BillingPayerResource`](billing-payer-resource.mdx) | The payer associated with the checkout. |
15-
| <a id="paymentsource"></a> `paymentSource?` | [`BillingPaymentSourceResource`](billing-payment-source-resource.mdx) | The payment source being used for the checkout, such as a credit card or bank account. |
16-
| <a id="plan"></a> `plan` | [`BillingPlanResource`](billing-plan-resource.mdx) | The subscription plan details for the checkout. |
17-
| <a id="planperiod"></a> `planPeriod` | <code>"month" \| "annual"</code> | The billing period for the plan. |
18-
| <a id="planperiodstart"></a> `planPeriodStart?` | `number` | Unix timestamp (milliseconds) of when the current period starts. |
19-
| <a id="status"></a> `status` | <code>"completed" \| "needs_confirmation"</code> | The current status of the checkout session. |
20-
| <a id="totals"></a> `totals` | [`BillingCheckoutTotals`](billing-checkout-totals.mdx) | The total costs, taxes, and other pricing details for the checkout. |
5+
| Property | Type | Description |
6+
| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| <a id="confirm"></a> `confirm` | <code>(params: [ConfirmCheckoutParams](/docs/reference/javascript/types/billing-checkout-resource#parameters)) => Promise\<BillingCheckoutResource\></code> | A function to confirm and finalize the checkout process, usually after payment information has been provided and validated. [Learn more.](#confirm) |
8+
| <a id="externalclientsecret"></a> `externalClientSecret` | `string` | A client secret from an external payment provider (such as Stripe) used to complete the payment on the client-side. |
9+
| <a id="externalgatewayid"></a> `externalGatewayId` | `string` | The identifier for the external payment gateway used for this checkout session. |
10+
| <a id="freetrialendsat"></a> `freeTrialEndsAt` | <code>null \| Date</code> | Unix timestamp (milliseconds) of when the free trial ends. |
11+
| <a id="id"></a> `id` | `string` | The unique identifier for the checkout session. |
12+
| <a id="isimmediateplanchange"></a> `isImmediatePlanChange` | `boolean` | Whether the plan change will take effect immediately after checkout. |
13+
| <a id="pathroot"></a> `pathRoot` | `string` | The root path of the resource. |
14+
| <a id="payer"></a> `payer` | [`BillingPayerResource`](billing-payer-resource.mdx) | The payer associated with the checkout. |
15+
| <a id="paymentsource"></a> `paymentSource?` | [`BillingPaymentSourceResource`](billing-payment-source-resource.mdx) | The payment source being used for the checkout, such as a credit card or bank account. |
16+
| <a id="plan"></a> `plan` | [`BillingPlanResource`](billing-plan-resource.mdx) | The subscription plan details for the checkout. |
17+
| <a id="planperiod"></a> `planPeriod` | <code>"month" \| "annual"</code> | The billing period for the plan. |
18+
| <a id="planperiodstart"></a> `planPeriodStart?` | `number` | Unix timestamp (milliseconds) of when the current period starts. |
19+
| <a id="status"></a> `status` | <code>"completed" \| "needs_confirmation"</code> | The current status of the checkout session. |
20+
| <a id="totals"></a> `totals` | [`BillingCheckoutTotals`](billing-checkout-totals.mdx) | The total costs, taxes, and other pricing details for the checkout. |

0 commit comments

Comments
 (0)