Skip to content
This repository was archived by the owner on Jan 30, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .generated/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,12 @@ docs/ClientsApi.md
docs/CnameTarget.md
docs/CommerceApi.md
docs/CommerceMoneyResponse.md
docs/CommercePayerResponse.md
docs/CommercePaymentSourceResponse.md
docs/CommercePlan.md
docs/CommerceSubscriptionCreditResponse.md
docs/CommerceSubscriptionItem.md
docs/CommerceSubscriptionItemNextPaymentResponse.md
docs/Cookies.md
docs/CreateActorTokenRequest.md
docs/CreateActorTokenRequestActor.md
Expand Down Expand Up @@ -131,6 +136,7 @@ docs/OrganizationWithLogo.md
docs/Organizations.md
docs/OrganizationsApi.md
docs/PaginatedCommercePlanResponse.md
docs/PaginatedCommerceSubscriptionItemResponse.md
docs/Passkey.md
docs/PasskeyVerification.md
docs/PhoneNumber.md
Expand Down Expand Up @@ -197,6 +203,7 @@ docs/UsersApi.md
docs/UsersBanRequest.md
docs/UsersUnbanRequest.md
docs/VerificationAdmin.md
docs/VerificationEmailLink.md
docs/VerificationFromOauth.md
docs/VerificationFromOauthError.md
docs/VerificationGoogleOneTap.md
Expand Down Expand Up @@ -273,7 +280,12 @@ lib/clerk-http-client/models/clerk_errors.rb
lib/clerk-http-client/models/client.rb
lib/clerk-http-client/models/cname_target.rb
lib/clerk-http-client/models/commerce_money_response.rb
lib/clerk-http-client/models/commerce_payer_response.rb
lib/clerk-http-client/models/commerce_payment_source_response.rb
lib/clerk-http-client/models/commerce_plan.rb
lib/clerk-http-client/models/commerce_subscription_credit_response.rb
lib/clerk-http-client/models/commerce_subscription_item.rb
lib/clerk-http-client/models/commerce_subscription_item_next_payment_response.rb
lib/clerk-http-client/models/cookies.rb
lib/clerk-http-client/models/create_actor_token_request.rb
lib/clerk-http-client/models/create_actor_token_request_actor.rb
Expand Down Expand Up @@ -363,6 +375,7 @@ lib/clerk-http-client/models/organization_settings.rb
lib/clerk-http-client/models/organization_with_logo.rb
lib/clerk-http-client/models/organizations.rb
lib/clerk-http-client/models/paginated_commerce_plan_response.rb
lib/clerk-http-client/models/paginated_commerce_subscription_item_response.rb
lib/clerk-http-client/models/passkey.rb
lib/clerk-http-client/models/passkey_verification.rb
lib/clerk-http-client/models/phone_number.rb
Expand Down Expand Up @@ -420,6 +433,7 @@ lib/clerk-http-client/models/user.rb
lib/clerk-http-client/models/users_ban_request.rb
lib/clerk-http-client/models/users_unban_request.rb
lib/clerk-http-client/models/verification_admin.rb
lib/clerk-http-client/models/verification_email_link.rb
lib/clerk-http-client/models/verification_from_oauth.rb
lib/clerk-http-client/models/verification_from_oauth_error.rb
lib/clerk-http-client/models/verification_google_one_tap.rb
Expand All @@ -442,4 +456,11 @@ lib/clerk-http-client/models/verify_totp_request.rb
lib/clerk-http-client/models/waitlist_entry.rb
lib/clerk-http-client/models/web3_wallet.rb
lib/clerk-http-client/models/web3_wallet_verification.rb
spec/models/commerce_payer_response_spec.rb
spec/models/commerce_payment_source_response_spec.rb
spec/models/commerce_subscription_credit_response_spec.rb
spec/models/commerce_subscription_item_next_payment_response_spec.rb
spec/models/commerce_subscription_item_spec.rb
spec/models/paginated_commerce_subscription_item_response_spec.rb
spec/models/verification_email_link_spec.rb
spec/spec_helper.rb
8 changes: 8 additions & 0 deletions .generated/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Class | Method | HTTP request | Description
*Clerk::SDK.clients* | [**get_client_list**](docs/ClientsApi.md#get_client_list) | **GET** /clients | List all clients
*Clerk::SDK.clients* | [**verify_client**](docs/ClientsApi.md#verify_client) | **POST** /clients/verify | Verify a client
*Clerk::SDK.commerce* | [**get_commerce_plan_list**](docs/CommerceApi.md#get_commerce_plan_list) | **GET** /commerce/plans | List all commerce plans
*Clerk::SDK.commerce* | [**get_commerce_subscription_item_list**](docs/CommerceApi.md#get_commerce_subscription_item_list) | **GET** /commerce/subscription_items | List all subscription items
*Clerk::SDK.domains* | [**add_domain**](docs/DomainsApi.md#add_domain) | **POST** /domains | Add a domain
*Clerk::SDK.domains* | [**delete_domain**](docs/DomainsApi.md#delete_domain) | **DELETE** /domains/{domain_id} | Delete a satellite domain
*Clerk::SDK.domains* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /domains | List all instance domains
Expand Down Expand Up @@ -212,7 +213,12 @@ Class | Method | HTTP request | Description
- [ClerkHttpClient::ClerkErrors](docs/ClerkErrors.md)
- [ClerkHttpClient::Client](docs/Client.md)
- [ClerkHttpClient::CommerceMoneyResponse](docs/CommerceMoneyResponse.md)
- [ClerkHttpClient::CommercePayerResponse](docs/CommercePayerResponse.md)
- [ClerkHttpClient::CommercePaymentSourceResponse](docs/CommercePaymentSourceResponse.md)
- [ClerkHttpClient::CommercePlan](docs/CommercePlan.md)
- [ClerkHttpClient::CommerceSubscriptionCreditResponse](docs/CommerceSubscriptionCreditResponse.md)
- [ClerkHttpClient::CommerceSubscriptionItem](docs/CommerceSubscriptionItem.md)
- [ClerkHttpClient::CommerceSubscriptionItemNextPaymentResponse](docs/CommerceSubscriptionItemNextPaymentResponse.md)
- [ClerkHttpClient::Cookies](docs/Cookies.md)
- [ClerkHttpClient::CreateActorTokenRequest](docs/CreateActorTokenRequest.md)
- [ClerkHttpClient::CreateActorTokenRequestActor](docs/CreateActorTokenRequestActor.md)
Expand Down Expand Up @@ -302,6 +308,7 @@ Class | Method | HTTP request | Description
- [ClerkHttpClient::OrganizationWithLogo](docs/OrganizationWithLogo.md)
- [ClerkHttpClient::Organizations](docs/Organizations.md)
- [ClerkHttpClient::PaginatedCommercePlanResponse](docs/PaginatedCommercePlanResponse.md)
- [ClerkHttpClient::PaginatedCommerceSubscriptionItemResponse](docs/PaginatedCommerceSubscriptionItemResponse.md)
- [ClerkHttpClient::Passkey](docs/Passkey.md)
- [ClerkHttpClient::PasskeyVerification](docs/PasskeyVerification.md)
- [ClerkHttpClient::PhoneNumber](docs/PhoneNumber.md)
Expand Down Expand Up @@ -359,6 +366,7 @@ Class | Method | HTTP request | Description
- [ClerkHttpClient::UsersBanRequest](docs/UsersBanRequest.md)
- [ClerkHttpClient::UsersUnbanRequest](docs/UsersUnbanRequest.md)
- [ClerkHttpClient::VerificationAdmin](docs/VerificationAdmin.md)
- [ClerkHttpClient::VerificationEmailLink](docs/VerificationEmailLink.md)
- [ClerkHttpClient::VerificationFromOauth](docs/VerificationFromOauth.md)
- [ClerkHttpClient::VerificationFromOauthError](docs/VerificationFromOauthError.md)
- [ClerkHttpClient::VerificationGoogleOneTap](docs/VerificationGoogleOneTap.md)
Expand Down
4 changes: 2 additions & 2 deletions .generated/docs/BetaFeaturesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All URIs are relative to *https://api.clerk.com/v1*

Update production instance domain

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.
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.

### Examples

Expand Down Expand Up @@ -154,7 +154,7 @@ end

Update production instance domain

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.
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.

### Examples

Expand Down
85 changes: 85 additions & 0 deletions .generated/docs/CommerceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ All URIs are relative to *https://api.clerk.com/v1*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**get_commerce_plan_list**](CommerceApi.md#get_commerce_plan_list) | **GET** /commerce/plans | List all commerce plans |
| [**get_commerce_subscription_item_list**](CommerceApi.md#get_commerce_subscription_item_list) | **GET** /commerce/subscription_items | List all subscription items |


## get_commerce_plan_list
Expand Down Expand Up @@ -82,3 +83,87 @@ end
- **Content-Type**: Not defined
- **Accept**: application/json


## get_commerce_subscription_item_list

> <PaginatedCommerceSubscriptionItemResponse> get_commerce_subscription_item_list(opts)

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.

### Examples

```ruby
require 'time'
require 'clerk'

## Setup
Clerk.configure do |config|
config.secret_key = 'sk_test_xxxxxxxxx'
end

opts = {
paginated: true, # Boolean | Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
limit: 56, # Integer | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
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`.
status: 'active', # String | Filter subscription items by status
payer_type: 'user', # String | Filter subscription items by payer type
plan_id: 'plan_id_example', # String | Filter subscription items by plan ID
include_free: true, # Boolean | Whether to include free plan subscription items
query: 'query_example' # String | Search query to filter subscription items
}

begin
# List all subscription items
result = Clerk::SDK.commerce.get_commerce_subscription_item_list(opts)
p result
rescue ClerkHttpClient::ApiError => e
puts "Error when calling Clerk::SDK.commerce->get_commerce_subscription_item_list: #{e}"
end
```

#### Using the `get_commerce_subscription_item_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<PaginatedCommerceSubscriptionItemResponse>, Integer, Hash)> get_commerce_subscription_item_list_with_http_info(opts)

```ruby
begin
# List all subscription items
data, status_code, headers = Clerk::SDK.commerce.get_commerce_subscription_item_list_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <PaginatedCommerceSubscriptionItemResponse>
rescue ClerkHttpClient::ApiError => e
puts "Error when calling Clerk::SDK.commerce->get_commerce_subscription_item_list_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **paginated** | **Boolean** | Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated. | [optional] |
| **limit** | **Integer** | Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. | [optional][default to 10] |
| **offset** | **Integer** | Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. | [optional][default to 0] |
| **status** | **String** | Filter subscription items by status | [optional] |
| **payer_type** | **String** | Filter subscription items by payer type | [optional] |
| **plan_id** | **String** | Filter subscription items by plan ID | [optional] |
| **include_free** | **Boolean** | Whether to include free plan subscription items | [optional][default to false] |
| **query** | **String** | Search query to filter subscription items | [optional] |

### Return type

[**PaginatedCommerceSubscriptionItemResponse**](PaginatedCommerceSubscriptionItemResponse.md)

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

40 changes: 40 additions & 0 deletions .generated/docs/CommercePayerResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# ClerkHttpClient::CommercePayerResponse

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **object** | **String** | String representing the object&#39;s type. Objects of the same type share the same value. | |
| **id** | **String** | Unique identifier for the payer. | |
| **instance_id** | **String** | Unique identifier for the Clerk instance. | |
| **user_id** | **String** | User ID for user-type payers. | [optional] |
| **first_name** | **String** | First name of the payer. | |
| **last_name** | **String** | Last name of the payer. | |
| **email** | **String** | Email address of the payer. | |
| **organization_id** | **String** | Organization ID for org-type payers. | [optional] |
| **organization_name** | **String** | Organization name for org-type payers. | [optional] |
| **image_url** | **String** | URL of the payer&#39;s image/avatar. | |
| **created_at** | **Integer** | Unix timestamp (in milliseconds) when the payer was created. | |
| **updated_at** | **Integer** | Unix timestamp (in milliseconds) when the payer was last updated. | |

## Example

```ruby
require 'clerk-http-client'

instance = ClerkHttpClient::CommercePayerResponse.new(
object: null,
id: null,
instance_id: null,
user_id: null,
first_name: null,
last_name: null,
email: null,
organization_id: null,
organization_name: null,
image_url: null,
created_at: null,
updated_at: null
)
```

50 changes: 50 additions & 0 deletions .generated/docs/CommercePaymentSourceResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# ClerkHttpClient::CommercePaymentSourceResponse

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **object** | **String** | String representing the object&#39;s type. Objects of the same type share the same value. | |
| **id** | **String** | Unique identifier for the payment source. | |
| **payer_id** | **String** | Unique identifier for the payer. | |
| **payment_method** | **String** | The payment method type. | |
| **is_default** | **Boolean** | Whether this is the default payment source for the payer. | [optional] |
| **gateway** | **String** | The payment gateway. | |
| **gateway_external_id** | **String** | External ID in the payment gateway. | |
| **gateway_external_account_id** | **String** | External account ID in the payment gateway. | [optional] |
| **last4** | **String** | Last 4 digits of the card (for card payment sources). | |
| **status** | **String** | Status of the payment source. | |
| **wallet_type** | **String** | Type of wallet (if applicable). | |
| **card_type** | **String** | Type of card (if applicable). | |
| **expiry_year** | **Integer** | Card expiration year (for card payment sources). | [optional] |
| **expiry_month** | **Integer** | Card expiration month (for card payment sources). | [optional] |
| **created_at** | **Integer** | Unix timestamp (in milliseconds) when the payment source was created. | |
| **updated_at** | **Integer** | Unix timestamp (in milliseconds) when the payment source was last updated. | |
| **is_removable** | **Boolean** | Whether this payment source can be removed. | [optional] |

## Example

```ruby
require 'clerk-http-client'

instance = ClerkHttpClient::CommercePaymentSourceResponse.new(
object: null,
id: null,
payer_id: null,
payment_method: null,
is_default: null,
gateway: null,
gateway_external_id: null,
gateway_external_account_id: null,
last4: null,
status: null,
wallet_type: null,
card_type: null,
expiry_year: null,
expiry_month: null,
created_at: null,
updated_at: null,
is_removable: null
)
```

6 changes: 5 additions & 1 deletion .generated/docs/CommercePlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
| **period** | **String** | The billing period for the plan. | [optional] |
| **interval** | **Integer** | The billing interval. | [optional] |
| **features** | [**Array&lt;FeatureResponse&gt;**](FeatureResponse.md) | The features included in this plan. | |
| **free_trial_enabled** | **Boolean** | Whether free trial is enabled for this plan. | [optional] |
| **free_trial_days** | **Integer** | Number of free trial days for this plan. | [optional] |

## Example

Expand Down Expand Up @@ -64,7 +66,9 @@ instance = ClerkHttpClient::CommercePlan.new(
avatar_url: null,
period: null,
interval: null,
features: null
features: null,
free_trial_enabled: null,
free_trial_days: null
)
```

20 changes: 20 additions & 0 deletions .generated/docs/CommerceSubscriptionCreditResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# ClerkHttpClient::CommerceSubscriptionCreditResponse

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **amount** | [**CommerceMoneyResponse**](CommerceMoneyResponse.md) | Credit amount. | [optional] |
| **cycle_remaining_percent** | **Float** | Percentage of the billing cycle remaining. | [optional] |

## Example

```ruby
require 'clerk-http-client'

instance = ClerkHttpClient::CommerceSubscriptionCreditResponse.new(
amount: null,
cycle_remaining_percent: null
)
```

Loading