Skip to content

Commit 7d0c880

Browse files
committed
Merge branch 'main' into ss/DOCS-10983
2 parents 8994eb7 + 779f5be commit 7d0c880

File tree

54 files changed

+1047
-962
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1047
-962
lines changed

docs/manifest.json

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1631,52 +1631,52 @@
16311631
"href": "/docs/reference/javascript/types/clerk-paginated-response"
16321632
},
16331633
{
1634-
"title": "`CommerceCheckoutResource`",
1635-
"href": "/docs/reference/javascript/types/commerce-checkout-resource"
1634+
"title": "`BillingCheckoutResource`",
1635+
"href": "/docs/reference/javascript/types/billing-checkout-resource"
16361636
},
16371637
{
1638-
"title": "`CommerceCheckoutTotals`",
1639-
"href": "/docs/reference/javascript/types/commerce-checkout-totals"
1638+
"title": "`BillingCheckoutTotals`",
1639+
"href": "/docs/reference/javascript/types/billing-checkout-totals"
16401640
},
16411641
{
1642-
"title": "`CommerceFeatureResource`",
1643-
"href": "/docs/reference/javascript/types/commerce-feature-resource"
1642+
"title": "`BillingMoneyAmount`",
1643+
"href": "/docs/reference/javascript/types/billing-money-amount"
16441644
},
16451645
{
1646-
"title": "`CommerceMoneyAmount`",
1647-
"href": "/docs/reference/javascript/types/commerce-money-amount"
1646+
"title": "`BillingPayerResource`",
1647+
"href": "/docs/reference/javascript/types/billing-payer-resource"
16481648
},
16491649
{
1650-
"title": "`CommercePaymentSourceResource`",
1651-
"href": "/docs/reference/javascript/types/commerce-payment-source-resource"
1650+
"title": "`BillingPaymentResource`",
1651+
"href": "/docs/reference/javascript/types/billing-payment-resource"
16521652
},
16531653
{
1654-
"title": "`CommercePlanResource`",
1655-
"href": "/docs/reference/javascript/types/commerce-plan-resource"
1654+
"title": "`BillingPaymentSourceResource`",
1655+
"href": "/docs/reference/javascript/types/billing-payment-source-resource"
16561656
},
16571657
{
1658-
"title": "`CommerceSubscriptionItemResource`",
1659-
"href": "/docs/reference/javascript/types/commerce-subscription-item-resource"
1658+
"title": "`BillingPlanResource`",
1659+
"href": "/docs/reference/javascript/types/billing-plan-resource"
16601660
},
16611661
{
1662-
"title": "`CommerceSubscriptionResource`",
1663-
"href": "/docs/reference/javascript/types/commerce-subscription-resource"
1662+
"title": "`BillingStatementGroup`",
1663+
"href": "/docs/reference/javascript/types/billing-statement-group"
16641664
},
16651665
{
1666-
"title": "`CommerceStatementResource`",
1667-
"href": "/docs/reference/javascript/types/commerce-statement-resource"
1666+
"title": "`BillingStatementResource`",
1667+
"href": "/docs/reference/javascript/types/billing-statement-resource"
16681668
},
16691669
{
1670-
"title": "`CommerceStatementTotals`",
1671-
"href": "/docs/reference/javascript/types/commerce-statement-totals"
1670+
"title": "`BillingStatementTotals`",
1671+
"href": "/docs/reference/javascript/types/billing-statement-totals"
16721672
},
16731673
{
1674-
"title": "`CommerceStatementGroup`",
1675-
"href": "/docs/reference/javascript/types/commerce-statement-group"
1674+
"title": "`BillingSubscriptionResource`",
1675+
"href": "/docs/reference/javascript/types/billing-subscription-resource"
16761676
},
16771677
{
1678-
"title": "`CommercePaymentResource`",
1679-
"href": "/docs/reference/javascript/types/commerce-payment-resource"
1678+
"title": "`BillingSubscriptionItemResource`",
1679+
"href": "/docs/reference/javascript/types/billing-subscription-item-resource"
16801680
},
16811681
{
16821682
"title": "`CustomMenuItem`",
@@ -1687,8 +1687,8 @@
16871687
"href": "/docs/reference/javascript/types/custom-page"
16881688
},
16891689
{
1690-
"title": "`DeletedObject`",
1691-
"href": "/docs/reference/javascript/types/deleted-object"
1690+
"title": "`DeletedObjectResource`",
1691+
"href": "/docs/reference/javascript/types/deleted-object-resource"
16921692
},
16931693
{
16941694
"title": "`EmailAddress`",
@@ -1710,6 +1710,10 @@
17101710
"title": "`ExternalAccount`",
17111711
"href": "/docs/reference/javascript/types/external-account"
17121712
},
1713+
{
1714+
"title": "`FeatureResource`",
1715+
"href": "/docs/reference/javascript/types/feature-resource"
1716+
},
17131717
{
17141718
"title": "Metadata types",
17151719
"href": "/docs/reference/javascript/types/metadata"

docs/reference/backend/domains/delete-domain.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ description: Use Clerk's JS Backend SDK to delete a satellite domain for the ins
44
sdk: js-backend
55
---
66

7-
Deletes a satellite domain for the instance. It is currently not possible to delete the instance's primary domain. Returns a [`DeletedObject`](/docs/reference/javascript/types/deleted-object).
7+
Deletes a satellite domain for the instance. It is currently not possible to delete the instance's primary domain. Returns a [`DeletedObjectResource`](/docs/reference/javascript/types/deleted-object-resource).
88

99
```ts
10-
function deleteDomain(id: string): Promise<DeletedObject>
10+
function deleteDomain(id: string): Promise<DeletedObjectResource>
1111
```
1212

1313
## Parameters

docs/reference/backend/oauth-applications/delete.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ description: Use Clerk's JS Backend SDK to delete an OAuth application.
44
sdk: js-backend
55
---
66

7-
Deletes an [`OAuthApplication`](/docs/reference/backend/types/backend-oauth-application) by its ID. Returns a [`DeletedObject`](/docs/reference/javascript/types/deleted-object) object.
7+
Deletes an [`OAuthApplication`](/docs/reference/backend/types/backend-oauth-application) by its ID. Returns a [`DeletedObjectResource`](/docs/reference/javascript/types/deleted-object-resource) object.
88

99
```ts {{ prettier: false }}
10-
function delete(oauthApplicationId: string): Promise<DeletedObject>
10+
function delete(oauthApplicationId: string): Promise<DeletedObjectResource>
1111
```
1212

1313
## Parameters

docs/reference/backend/organization/delete-organization.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ sdk: js-backend
66

77
{/* clerk/javascript file: https://github.com/clerk/javascript/blob/main/packages/backend/src/api/endpoints/OrganizationApi.ts#L169 */}
88

9-
Deletes an [`Organization`](/docs/reference/backend/types/backend-organization). Returns a [`DeletedObject`](/docs/reference/javascript/types/deleted-object) object.
9+
Deletes an [`Organization`](/docs/reference/backend/types/backend-organization). Returns a [`DeletedObjectResource`](/docs/reference/javascript/types/deleted-object-resource) object.
1010

1111
```ts
12-
function deleteOrganization(organizationId: string): Promise<DeletedObject>
12+
function deleteOrganization(organizationId: string): Promise<DeletedObjectResource>
1313
```
1414

1515
## Parameters

docs/reference/backend/saml-connections/delete-saml-connection.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ description: Use Clerk's JS Backend SDK to delete a SAML connection.
44
sdk: js-backend
55
---
66

7-
Deletes a [`SamlConnection`](/docs/reference/backend/types/backend-saml-connection) by its ID. Returns a [`DeletedObject`](/docs/reference/javascript/types/deleted-object) object.
7+
Deletes a [`SamlConnection`](/docs/reference/backend/types/backend-saml-connection) by its ID. Returns a [`DeletedObjectResource`](/docs/reference/javascript/types/deleted-object-resource) object.
88

99
```ts
10-
function deleteSamlConnection(samlConnectionId: string): Promise<DeletedObject>
10+
function deleteSamlConnection(samlConnectionId: string): Promise<DeletedObjectResource>
1111
```
1212

1313
## Parameters

docs/reference/backend/types/commerce-plan.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sdk: js-backend
66

77
<Include src="_partials/billing/billing-experimental" />
88

9-
The `CommercePlan` object is similar to the [`CommercePlan`](/docs/reference/javascript/types/commerce-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/model/commerceplan){{ target: '_blank' }} and is not directly accessible from the Frontend API.
9+
The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/model/commerceplan){{ target: '_blank' }} and is not directly accessible from the Frontend API.
1010

1111
## Properties
1212

@@ -75,21 +75,21 @@ The `CommercePlan` object is similar to the [`CommercePlan`](/docs/reference/jav
7575
---
7676

7777
- `fee`
78-
- <code>[CommerceMoneyAmount](/docs/reference/javascript/types/commerce-money-amount)</code>
78+
- <code>[BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount)</code>
7979

8080
The monthly fee of the plan.
8181

8282
---
8383

8484
- `annualFee`
85-
- <code>[CommerceMoneyAmount](/docs/reference/javascript/types/commerce-money-amount)</code>
85+
- <code>[BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount)</code>
8686

8787
The annual fee of the plan.
8888

8989
---
9090

9191
- `annualMonthlyFee`
92-
- <code>[CommerceMoneyAmount](/docs/reference/javascript/types/commerce-money-amount)</code>
92+
- <code>[BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount)</code>
9393

9494
The annual fee of the plan on a monthly basis.
9595

docs/reference/backend/types/commerce-subscription-item.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sdk: js-backend
66

77
<Include src="_partials/billing/billing-experimental" />
88

9-
The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionItem`](/docs/reference/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/model/commercesubscriptionitem){{ target: '_blank' }} and is not directly accessible from the Frontend API.
9+
The `CommerceSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/reference/javascript/types/billing-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `CommerceSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/model/commercesubscriptionitem){{ target: '_blank' }} and is not directly accessible from the Frontend API.
1010

1111
## Properties
1212

@@ -54,7 +54,7 @@ The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionIt
5454
---
5555

5656
- `amount`
57-
- <code>undefined | null | [CommerceMoneyAmount](/docs/reference/javascript/types/commerce-money-amount)</code>
57+
- <code>undefined | null | [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount)</code>
5858

5959
The current amount for the subscription item.
6060

@@ -124,7 +124,7 @@ The `CommerceSubscriptionItem` object is similar to the [`CommerceSubscriptionIt
124124
---
125125

126126
- `lifetimePaid?`
127-
- <code>null | [CommerceMoneyAmount](/docs/reference/javascript/types/commerce-money-amount)</code>
127+
- <code>null | [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount)</code>
128128

129129
The lifetime amount paid for this subscription item.
130130
</Properties>

docs/reference/backend/types/commerce-subscription.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sdk: js-backend
66

77
<Include src="_partials/billing/billing-experimental" />
88

9-
The `CommerceSubscription` object is similar to the [`CommerceSubscription`](/docs/reference/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription){{ target: '_blank' }} and is not directly accessible from the Frontend API.
9+
The `CommerceSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/reference/javascript/types/billing-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `CommerceSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription){{ target: '_blank' }} and is not directly accessible from the Frontend API.
1010

1111
## Properties
1212

@@ -68,7 +68,7 @@ The `CommerceSubscription` object is similar to the [`CommerceSubscription`](/do
6868
---
6969

7070
- `nextPayment`
71-
- <code>null | \{ amount: [CommerceMoneyAmount](/docs/reference/javascript/types/commerce-money-amount); date: number; }</code>
71+
- <code>null | \{ amount: [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount); date: number; }</code>
7272

7373
Information about the next scheduled payment.
7474

docs/reference/backend/user/delete-user-external-account.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ sdk: js-backend
66

77
{/* clerk/javascript file: https://github.com/clerk/javascript/blob/main/packages/backend/src/api/endpoints/UserApi.ts#L421 */}
88

9-
Deletes a user's external account by ID. Returns a [`DeletedObject`](/docs/reference/javascript/types/deleted-object).
9+
Deletes a user's external account by ID. Returns a [`DeletedObjectResource`](/docs/reference/javascript/types/deleted-object-resource).
1010

1111
```ts
12-
function deleteUserExternalAccount(params: DeleteUserExternalAccountParams): Promise<DeletedObject>
12+
function deleteUserExternalAccount(
13+
params: DeleteUserExternalAccountParams,
14+
): Promise<DeletedObjectResource>
1315
```
1416

1517
## `DeleteUserExternalAccountParams`

docs/reference/backend/user/delete-user-passkey.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ sdk: js-backend
66

77
{/* clerk/javascript file: https://github.com/clerk/javascript/blob/main/packages/backend/src/api/endpoints/UserApi.ts#L403 */}
88

9-
Deletes the passkey identification for a given user and notifies them through email. Returns a [`DeletedObject`](/docs/reference/javascript/types/deleted-object).
9+
Deletes the passkey identification for a given user and notifies them through email. Returns a [`DeletedObjectResource`](/docs/reference/javascript/types/deleted-object-resource).
1010

1111
```ts
12-
function deleteUserPasskey(params: DeleteUserPasskeyParams): Promise<DeletedObject>
12+
function deleteUserPasskey(params: DeleteUserPasskeyParams): Promise<DeletedObjectResource>
1313
```
1414

1515
## `DeleteUserPasskeyParams`

0 commit comments

Comments
 (0)