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
{{ message }}
This repository was archived by the owner on Jan 30, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: .generated/docs/BetaFeaturesApi.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.clerk.com/v1*
15
15
16
16
Update production instance domain
17
17
18
-
Change the domain of a production instance. Changing the domain requires updating the [DNS records](https://clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](https://clerk.com/docs/deployments/overview#deploy), updating your Social Connection's redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.
18
+
Change the domain of a production instance. Changing the domain requires updating the [DNS records](https://clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](https://clerk.com/docs/deployments/overview#deploy-certificates), updating your Social Connection's redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.
19
19
20
20
### Examples
21
21
@@ -154,7 +154,7 @@ end
154
154
155
155
Update production instance domain
156
156
157
-
Change the domain of a production instance. Changing the domain requires updating the [DNS records](https://clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](https://clerk.com/docs/deployments/overview#deploy), updating your Social Connection's redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.
157
+
Change the domain of a production instance. Changing the domain requires updating the [DNS records](https://clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](https://clerk.com/docs/deployments/overview#deploy-certificates), updating your Social Connection's redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.
Copy file name to clipboardExpand all lines: .generated/docs/CommerceApi.md
+85Lines changed: 85 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.clerk.com/v1*
5
5
| Method | HTTP request | Description |
6
6
| ------ | ------------ | ----------- |
7
7
|[**get_commerce_plan_list**](CommerceApi.md#get_commerce_plan_list)|**GET** /commerce/plans | List all commerce plans |
8
+
|[**get_commerce_subscription_item_list**](CommerceApi.md#get_commerce_subscription_item_list)|**GET** /commerce/subscription_items | List all subscription items |
Returns a list of all subscription items for the instance. The subscription items are returned sorted by creation date, with the newest appearing first. This includes subscriptions for both users and organizations. Pagination is supported.
94
+
95
+
### Examples
96
+
97
+
```ruby
98
+
require'time'
99
+
require'clerk'
100
+
101
+
## Setup
102
+
Clerk.configure do |config|
103
+
config.secret_key ='sk_test_xxxxxxxxx'
104
+
end
105
+
106
+
opts = {
107
+
paginated:true, # Boolean | Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
108
+
limit:56, # Integer | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
109
+
offset:56, # Integer | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
110
+
status:'active', # String | Filter subscription items by status
111
+
payer_type:'user', # String | Filter subscription items by payer type
112
+
plan_id:'plan_id_example', # String | Filter subscription items by plan ID
113
+
include_free:true, # Boolean | Whether to include free plan subscription items
114
+
query:'query_example'# String | Search query to filter subscription items
115
+
}
116
+
117
+
begin
118
+
# List all subscription items
119
+
result =Clerk::SDK.commerce.get_commerce_subscription_item_list(opts)
120
+
p result
121
+
rescueClerkHttpClient::ApiError => e
122
+
puts"Error when calling Clerk::SDK.commerce->get_commerce_subscription_item_list: #{e}"
123
+
end
124
+
```
125
+
126
+
#### Using the `get_commerce_subscription_item_list_with_http_info variant
127
+
128
+
This returns an Array which contains the response data, status code and headers.
p data # => <PaginatedCommerceSubscriptionItemResponse>
139
+
rescueClerkHttpClient::ApiError => e
140
+
puts"Error when calling Clerk::SDK.commerce->get_commerce_subscription_item_list_with_http_info: #{e}"
141
+
end
142
+
```
143
+
144
+
### Parameters
145
+
146
+
| Name | Type | Description | Notes |
147
+
| ---- | ---- | ----------- | ----- |
148
+
|**paginated**|**Boolean**| Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated. |[optional]|
149
+
|**limit**|**Integer**| Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`. |[optional][default to 10]|
150
+
|**offset**|**Integer**| Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. |[optional][default to 0]|
151
+
|**status**|**String**| Filter subscription items by status |[optional]|
152
+
|**payer_type**|**String**| Filter subscription items by payer type |[optional]|
153
+
|**plan_id**|**String**| Filter subscription items by plan ID |[optional]|
154
+
|**include_free**|**Boolean**| Whether to include free plan subscription items |[optional][default to false]|
155
+
|**query**|**String**| Search query to filter subscription items |[optional]|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments