license_manager 0.1.1 → 0.3.0

data/docs/LicenseSubscription.md

@@ -0,0 +1,34 @@
+# LicenseManager::LicenseSubscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **stripe_subscription_id** | **String** |  |  |
+| **status** | **String** | Status of the subscription in Stripe: `active`, `trialing`, `past_due` while a failed payment is retried, `canceled`, `unpaid`, `paused`, `incomplete` or `incomplete_expired`. |  |
+| **interval** | **String** |  |  |
+| **interval_count** | **Integer** | Number of intervals between payments. |  |
+| **quantity** | **Integer** | Units subscribed, multiplying the policy's machines. |  |
+| **price** | [**Price**](Price.md) | Price of one unit for one period, before taxes. |  |
+| **current_period_end** | **Time** | End of the paid period, when the subscription renews or ends. |  |
+| **cancel_at_period_end** | **Boolean** | Whether the subscription ends at the end of the period. |  |
+| **ended_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::LicenseSubscription.new(
+  stripe_subscription_id: sub_1MowQVLkdIwHu7ix,
+  status: active,
+  interval: null,
+  interval_count: 1,
+  quantity: 1,
+  price: null,
+  current_period_end: null,
+  cancel_at_period_end: null,
+  ended_at: null
+)
+```
+

data/docs/LicensesApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.licensemanager.dev*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**cancel_license**](LicensesApi.md#cancel_license) | **POST** /v1/licenses/{id}/cancel | Cancel a license |
 | [**create_license**](LicensesApi.md#create_license) | **POST** /v1/products/{productId}/licenses | Create a license |
 | [**delete_license**](LicensesApi.md#delete_license) | **DELETE** /v1/licenses/{id} | Delete a license |
 | [**get_license**](LicensesApi.md#get_license) | **GET** /v1/licenses/{id} | Get a license |
@@ -16,13 +17,89 @@ All URIs are relative to *https://api.licensemanager.dev*
 | [**validate_key**](LicensesApi.md#validate_key) | **POST** /v1/products/{productId}/validate-key | Validate a license key |
 
 
+## cancel_license
+
+> <License> cancel_license(id, cancel_license)
+
+Cancel a license
+
+Cancels the license right away: validating its key then fails with `license_expired`, like an expired license, and its status is `canceled`. A cancellation can't be undone.  Customers can cancel their licenses until their `cancellableUntil`, the end of their money back guarantee: tokens can't cancel a license past it, or without one. API keys and sessions can cancel any license.  When the license was bought through the Stripe integration, its payment is refunded in the background, unless the integration disables `autoRefund`, its API key lacks the optional Refunds: Write permission (`canRefund`), or `refund` is `false`: the refund is its price paid, taxes included, and its id is set as `stripeRefundId`. The customer is emailed a confirmation, and the owners and admins of the organization are told about the cancellation and its refund. In test products, the customer is only emailed when their email is a member's of the organization.  A subscription license isn't refunded: its Stripe subscription is canceled at once, without proration, which needs the integration's `canManageSubscriptions`.  Records a `license.canceled` event, then a `license.refunded` or `license.refund_failed` one once the refund is done.  **Token access**: customer, license tokens with the `license:cancel` permission (or the matching write one). A token reaches the license it's scoped to, or the licenses of its customer.  **Required role permission**: `license:cancel` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): token
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LicenseManager::LicensesApi.new
+id = 'l3Nv8KwB' # String | 
+cancel_license = LicenseManager::CancelLicense.new({reason: LicenseManager::CancellationReason::TOO_EXPENSIVE}) # CancelLicense | 
+
+begin
+  # Cancel a license
+  result = api_instance.cancel_license(id, cancel_license)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling LicensesApi->cancel_license: #{e}"
+end
+```
+
+#### Using the cancel_license_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<License>, Integer, Hash)> cancel_license_with_http_info(id, cancel_license)
+
+```ruby
+begin
+  # Cancel a license
+  data, status_code, headers = api_instance.cancel_license_with_http_info(id, cancel_license)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <License>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling LicensesApi->cancel_license_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **cancel_license** | [**CancelLicense**](CancelLicense.md) |  |  |
+
+### Return type
+
+[**License**](License.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_license
 
 > <License> create_license(product_id, create_license)
 
 Create a license
 
-Without a `key`, the license gets a random one, like `7KQ2M-X9ZPA-H4TRC-WN6EY-B3JDF`: 5 groups of 5 characters separated by dashes, each character an upper case letter or a digit other than `O`, `0`, `I` and `1`. That's 32 possible characters encoding 5 bits each, for 125 random bits.  Without a `policyId`, the license follows the product's default policy.  Without an `expiresAt`, the license expires after the duration of its policy, or never when the policy has none. `expiresAt: null` makes it never expire.  Without a `price`, the price paid for the license is unknown: it's left out of the revenue stats.  The values of `maxVersion` left out are taken from the max version of the policy: its hard-coded version, or the times after the creation of the license its versions lock.  The license belongs to the product's customer with the given `email`, which is created when there's none.  With `sendKey: true`, the key is emailed to the customer once the license is created.  The license copies the settings of its policy when it's created: later changes to the policy don't affect it. Its key, policy and customer can't be changed afterwards.  **Required role permission**: `license:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+Without a `key`, the license gets a random one, like `7KQ2M-X9ZPA-H4TRC-WN6EY-B3JDF`: 5 groups of 5 characters separated by dashes, each character an upper case letter or a digit other than `O`, `0`, `I` and `1`. That's 32 possible characters encoding 5 bits each, for 125 random bits.  Without a `policyId`, the license follows the product's default policy.  Without an `expiresAt`, the license expires after the duration of its policy, or never when the policy has none. `expiresAt: null` makes it never expire.  Without a `price`, the price paid for the license is unknown: it's left out of the revenue stats.  Without a `cancellableUntil`, the customer can cancel the license during the policy's `moneyBackGuaranteeDays` after its creation, or never when the policy has none.  The values of `maxVersion` left out are taken from the max version of the policy: its hard-coded version, or the times after the creation of the license its versions lock.  The license belongs to the product's customer with the given `email`, which is created when there's none.  With `sendKey: true`, the key is emailed to the customer once the license is created.  The license copies the settings of its policy when it's created: later changes to the policy don't affect it. Its key, policy and customer can't be changed afterwards.  **Required role permission**: `license:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
 
 ### Examples
 
@@ -683,7 +760,7 @@ nil (empty response body)
 
 Update a license
 
-The key, policy and customer of a license can't be changed: sending them does nothing.  The changes apply to the next validations of the key, not to the license tokens `validateKey` already returned, which stay valid until they expire. Lowering `maxMachines` doesn't deactivate machines: the ones already active keep validating, and new ones are refused until enough are deactivated.  **Required role permission**: `license:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
+The key, policy and customer of a license can't be changed: sending them does nothing.  The changes apply to the next validations of the key, not to the license tokens `validateKey` already returned, which stay valid until they expire. Lowering `maxMachines` doesn't deactivate machines: the ones already active keep validating, and new ones replace them one at a time when the product has `autoMachineChange`, or are refused until enough are deactivated.  **Required role permission**: `license:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
 
 ### Examples
 
@@ -756,7 +833,7 @@ end
 
 Validate a license key
 
-Checks the license key of the product on a machine and returns a token the application can verify offline with the organization's public key. Doesn't need authentication.  The license must allow the `version`: up to its `maxVersion.version` when it has one, like `\"2.3\"` for every 2.3.z version and older. Its `maxVersion.lockMajorAt` and `maxVersion.lockMinorAt` are enforced once they hard-code `maxVersion.version`, within the hour they're reached. When it doesn't, the error's `latestAllowedVersion` is the latest release of the product the license allows, so the application can offer to install it.  The machine with the `fingerprint` is created when the license has none, and activated when it's deactivated, unless the license is already active on its maximum number of machines. A machine that's already active is never refused for the maximum number of machines, even when it was lowered below the number of active machines. Its `version`, and its `name` and `platform` when given, are updated: they can't be cleared.  The checks run in this order, and the first one failing answers: the license has expired, then it doesn't allow the version, then it's on its maximum number of machines. Each failure is recorded as a `license.validation_failed` event, except for keys that don't exist.  Changes to the license, like deactivating the machine or shortening its expiration, don't revoke the tokens already returned: the application only sees them when it validates its key again, at the latest when its token expires.
+Checks the license key of the product on a machine and returns a token the application can verify offline with the organization's public key. Doesn't need authentication.  The license must allow the `version`: up to its `maxVersion.version` when it has one, like `\"2.3\"` for every 2.3.z version and older. Its `maxVersion.lockMajorAt` and `maxVersion.lockMinorAt` are enforced once they hard-code `maxVersion.version`, within the hour they're reached. When it doesn't, the error's `latestAllowedVersion` is the latest release of the product the license allows, so the application can offer to install it.  The machine with the `fingerprint` is created when the license has none, and activated when it's deactivated, unless the license is already active on its maximum number of machines. A machine that's already active is never refused for the maximum number of machines, even when it was lowered below the number of active machines. Its `version`, and its `name` and `platform` when given, are updated: they can't be cleared.  Unless the product disables `autoMachineChange`, a new machine isn't refused when the license is on its maximum number of machines: it takes the place of the active machine validated the longest ago, which is deactivated with its `overriddenByMachineId` set to the new machine, and recorded as a `machine.deactivated` event. When a machine deactivated this way is validated again, it takes its place back: the machine that overrode it, and the ones that overrode that one in turn, are locked, with their `overriddenByMachineId` set to the machine coming back. A locked machine is always refused, so two machines can't take turns on one place.  The checks run in this order, and the first one failing answers: the license has expired or was canceled, then it doesn't allow the version, then the machine is locked, then it's on its maximum number of machines. Each failure is recorded as a `license.validation_failed` event, except for keys that don't exist.  Changes to the license, like deactivating the machine or shortening its expiration, don't revoke the tokens already returned: the application only sees them when it validates its key again, at the latest when its token expires.
 
 ### Examples
 

data/docs/Machine.md

@@ -9,8 +9,9 @@
 | **fingerprint** | **String** | Identifies the machine. Unique within the license. |  |
 | **platform** | **String** |  |  |
 | **name** | **String** |  |  |
-| **status** | **String** | Whether the machine counts as using the license. |  |
+| **status** | **String** | Whether the machine counts as using the license. A `locked` machine doesn't, and its validations are refused with `machine_locked`: it overrode a machine that came back. See `validateKey`. |  |
 | **version** | **String** | Version of the application last validated on the machine. |  |
+| **overridden_by_machine_id** | **String** | For a machine deactivated or locked by automatic machine changes, the machine that took its place. Validating the key on a deactivated machine that has one takes its place back. `null` otherwise. |  |
 | **last_validated_at** | **Time** | When the license was last validated on the machine. |  |
 | **created_at** | **Time** |  |  |
 | **updated_at** | **Time** |  |  |
@@ -28,6 +29,7 @@ instance = LicenseManager::Machine.new(
   name: Jane's MacBook,
   status: active,
   version: 1.4.2,
+  overridden_by_machine_id: null,
   last_validated_at: 2026-01-15T09:30:00.000Z,
   created_at: 2026-01-15T09:30:00.000Z,
   updated_at: 2026-01-15T09:30:00.000Z

data/docs/MachinesApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://api.licensemanager.dev*
 
 Deactivate a machine
 
-The machine no longer counts as using the license, freeing its place when the license has a maximum number of machines. Validating the license key on the machine activates it again, unless the license is on its maximum number of machines by then. Deactivating a deactivated machine does nothing.  The license token `validateKey` returned to the machine isn't revoked: the application can keep running offline until it expires. Machines can't be deleted: they're deleted with their license.  **Token access**: customer, license, machine tokens with the `machine:write` permission (or the matching write one). A token reaches the machine it's scoped to, or the machines of its license or customer.  **Required role permission**: `machine:deactivate` when called with a session, granted by the member's role. API keys aren't limited by roles.
+The machine no longer counts as using the license, freeing its place when the license has a maximum number of machines. Validating the license key on the machine activates it again, unless the license is on its maximum number of machines by then. Deactivating a deactivated or locked machine does nothing.  The license token `validateKey` returned to the machine isn't revoked: the application can keep running offline until it expires. Machines can't be deleted: they're deleted with their license.  **Token access**: customer, license, machine tokens with the `machine:write` permission (or the matching write one). A token reaches the machine it's scoped to, or the machines of its license or customer.  **Required role permission**: `machine:deactivate` when called with a session, granted by the member's role. API keys aren't limited by roles.
 
 ### Examples
 

data/docs/Mrr.md

@@ -0,0 +1,26 @@
+# LicenseManager::Mrr
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** |  |  |
+| **mrr** | **Float** | Monthly recurring revenue: the price of every ongoing subscription in the currency, times its quantity, brought to one month (a year counts for a twelfth), before taxes and discounts. |  |
+| **by_interval** | [**Array<MrrByIntervalInner>**](MrrByIntervalInner.md) | Ongoing subscriptions and MRR of each billing period, like monthly and yearly, from the highest MRR. |  |
+| **by_policy** | [**Array<MrrByPolicyInner>**](MrrByPolicyInner.md) | MRR of each policy, from the highest. |  |
+| **by_month** | **Array<Float>** | MRR at the end of each month, aligned on `months`, today for this month, at the current prices of the subscriptions. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::Mrr.new(
+  currency: USD,
+  mrr: 1240,
+  by_interval: null,
+  by_policy: null,
+  by_month: [900, 1100, 1240]
+)
+```
+

data/docs/MrrByIntervalInner.md

@@ -0,0 +1,24 @@
+# LicenseManager::MrrByIntervalInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval** | **String** |  |  |
+| **interval_count** | **Integer** |  |  |
+| **subscription_count** | **Integer** |  |  |
+| **mrr** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::MrrByIntervalInner.new(
+  interval: null,
+  interval_count: 1,
+  subscription_count: 80,
+  mrr: 800
+)
+```
+

data/docs/MrrByPolicyInner.md

@@ -0,0 +1,22 @@
+# LicenseManager::MrrByPolicyInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+| **subscription_count** | **Integer** |  |  |
+| **mrr** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::MrrByPolicyInner.new(
+  policy_id: p4Rt8LmQ,
+  subscription_count: 80,
+  mrr: 800
+)
+```
+

data/docs/Policy.md

@@ -13,6 +13,7 @@
 | **max_machines** | **Integer** | Maximum number of active machines of the licenses created with this policy. `null` when there's no limit. |  |
 | **max_offline_duration_seconds** | **Integer** | Longest the applications can run offline with the licenses created with this policy, in seconds. |  |
 | **max_version** | [**PolicyMaxVersion**](PolicyMaxVersion.md) |  |  |
+| **money_back_guarantee_days** | **Integer** | Number of days after their creation during which customers can cancel the licenses created with this policy, from the customer portal or with `cancelLicense`. `null` when they can't. |  |
 | **license_count** | **Integer** | Number of licenses following this policy. |  |
 | **created_at** | **Time** |  |  |
 | **updated_at** | **Time** |  |  |
@@ -32,6 +33,7 @@ instance = LicenseManager::Policy.new(
   max_machines: 3,
   max_offline_duration_seconds: 604800,
   max_version: null,
+  money_back_guarantee_days: 30,
   license_count: 12,
   created_at: 2026-01-15T09:30:00.000Z,
   updated_at: 2026-01-15T09:30:00.000Z

data/docs/PolicySettings.md

@@ -8,6 +8,7 @@
 | **max_machines** | **Integer** | Maximum number of active machines of the licenses created with this policy, copied to each of them. `null` for no limit. Defaults to `null`. | [optional] |
 | **max_offline_duration_seconds** | **Integer** | Longest the applications can run offline with the licenses created with this policy, in seconds, copied to each of them. At least one hour (`3600`). Defaults to one week. | [optional] |
 | **max_version** | [**PolicySettingsMaxVersion**](PolicySettingsMaxVersion.md) |  | [optional] |
+| **money_back_guarantee_days** | **Integer** | Number of days after their creation during which customers can cancel the licenses created with this policy, from the customer portal or with `cancelLicense`, which refunds their Stripe payment. Each license keeps the end of its own period as `cancellableUntil`. `null` for no money back guarantee. Defaults to `null`. | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = LicenseManager::PolicySettings.new(
   duration: null,
   max_machines: 3,
   max_offline_duration_seconds: 604800,
-  max_version: null
+  max_version: null,
+  money_back_guarantee_days: 30
 )
 ```
 

data/docs/PortalApi.md

@@ -4,19 +4,98 @@ All URIs are relative to *https://api.licensemanager.dev*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_billing_portal_session**](PortalApi.md#create_billing_portal_session) | **POST** /v1/customers/{id}/billing-portal-sessions | Open the Stripe customer portal of a customer |
 | [**create_portal_link**](PortalApi.md#create_portal_link) | **POST** /v1/customers/{id}/portal-links | Create a link to the customer portal |
 | [**get_portal**](PortalApi.md#get_portal) | **GET** /v1/portal/{productId} | Get the customer portal of a product |
 | [**request_portal_link**](PortalApi.md#request_portal_link) | **POST** /v1/portal/{productId}/request-link | Email a link to the customer portal |
 | [**send_portal_link**](PortalApi.md#send_portal_link) | **POST** /v1/customers/{id}/portal-links/send | Email a link to the customer portal to the customer |
 
 
+## create_billing_portal_session
+
+> <BillingPortalSession> create_billing_portal_session(id, opts)
+
+Open the Stripe customer portal of a customer
+
+Link to the Stripe customer portal of the customer's Stripe customer, where they manage their subscriptions: change their plan or payment method, see their invoices, cancel. Needs the Stripe integration's `canBillingPortal`, and the customer portal configured in the Stripe account's settings. The changes come back through the integration's webhook, keeping the subscription licenses in line.  **Token access**: customer tokens with the `customer:billing` permission (or the matching write one). A customer token reaches its own customer.  **Required role permission**: `portalLink:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): token
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LicenseManager::PortalApi.new
+id = 'c9Wd3RtE' # String | 
+opts = {
+  create_billing_portal_session: LicenseManager::CreateBillingPortalSession.new # CreateBillingPortalSession | 
+}
+
+begin
+  # Open the Stripe customer portal of a customer
+  result = api_instance.create_billing_portal_session(id, opts)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->create_billing_portal_session: #{e}"
+end
+```
+
+#### Using the create_billing_portal_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BillingPortalSession>, Integer, Hash)> create_billing_portal_session_with_http_info(id, opts)
+
+```ruby
+begin
+  # Open the Stripe customer portal of a customer
+  data, status_code, headers = api_instance.create_billing_portal_session_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BillingPortalSession>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->create_billing_portal_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **create_billing_portal_session** | [**CreateBillingPortalSession**](CreateBillingPortalSession.md) |  | [optional] |
+
+### Return type
+
+[**BillingPortalSession**](BillingPortalSession.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_portal_link
 
 > <PortalLink> create_portal_link(id, create_portal_link)
 
 Create a link to the customer portal
 
-Link letting the customer see their licenses and deactivate their machines in the customer portal, without signing in. Anyone with the link can, until it expires or the customer is deleted: it can't be revoked otherwise. The token also works with the API endpoints that accept customer tokens.  Links can be created while the product's customer portal is disabled, but the portal answers `404` until it's enabled, and `sendPortalLink` refuses to email them.  **Required role permission**: `portalLink:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+Link letting the customer see their licenses, cancel them during their money back guarantee, and deactivate their machines in the customer portal, without signing in. Anyone with the link can, until it expires or the customer is deleted: it can't be revoked otherwise. The token also works with the API endpoints that accept customer tokens.  Links can be created while the product's customer portal is disabled, but the portal answers `404` until it's enabled, and `sendPortalLink` refuses to email them.  **Required role permission**: `portalLink:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
 
 ### Examples
 

data/docs/PortalLink.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **url** | **String** | Link to the customer portal, holding the token. |  |
-| **token** | **String** | Customer token in the link, with the `customer:read`, `license:read` and `machine:write` permissions. |  |
+| **token** | **String** | Customer token in the link, with the `customer:read`, `license:read`, `license:cancel` and `machine:write` permissions. |  |
 | **expires_at** | **Time** | When the link stops working. |  |
 
 ## Example
@@ -14,7 +14,7 @@
 require 'license_manager'
 
 instance = LicenseManager::PortalLink.new(
-  url: https://app.example.com/portal/x7Kp2QaZ?token=eyJhbGciOi…,
+  url: https://app.licensemanager.dev/portal/x7Kp2QaZ?token=eyJhbGciOi…,
   token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…,
   expires_at: 2026-01-22T09:30:00.000Z
 )

data/docs/Product.md

@@ -10,6 +10,7 @@
 | **is_test_from_product_id** | **String** | For test products, id of the live product they're a sandbox of. `null` for live products. |  |
 | **logo_url** | **String** | Public URL of the product's logo, shown in the web app and the customer portal. `null` without a logo. |  |
 | **portal** | [**PortalSettings**](PortalSettings.md) |  |  |
+| **auto_machine_change** | **Boolean** | Whether a new machine validating a license already on its max machines takes the place of the license's machine validated the longest ago, rather than being refused with `machine_limit_reached`. When the replaced machine is validated again, it takes its place back and the machine that replaced it is locked. See `validateKey`. |  |
 | **created_at** | **Time** |  |  |
 | **updated_at** | **Time** |  |  |
 
@@ -25,6 +26,7 @@ instance = LicenseManager::Product.new(
   is_test_from_product_id: null,
   logo_url: https://cdn.example.com/logos/x7Kp2QaZ/k3f9a2LpQ7xw.webp,
   portal: null,
+  auto_machine_change: true,
   created_at: 2026-01-15T09:30:00.000Z,
   updated_at: 2026-01-15T09:30:00.000Z
 )

data/docs/ProductStats.md

@@ -5,13 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **license_count** | **Integer** | Number of licenses of the product. |  |
-| **active_license_count** | **Integer** | Number of licenses that haven't expired, and that a machine validated in the last 90 days. |  |
+| **active_license_count** | **Integer** | Number of licenses that haven't expired nor were canceled, and that a machine validated in the last 90 days. |  |
 | **new_license_count** | **Integer** | Number of licenses created in the last 30 days, today included, in UTC. |  |
-| **expiring_license_count** | **Integer** | Number of licenses expiring in the next 30 days. |  |
-| **expired_license_count** | **Integer** | Number of licenses that expired in the last 30 days. |  |
+| **expiring_license_count** | **Integer** | Number of licenses expiring in the next 30 days, canceled ones left out. |  |
+| **expired_license_count** | **Integer** | Number of licenses that expired in the last 30 days, canceled ones left out. |  |
 | **active_machine_count** | **Integer** | Number of active machines of the licenses of the product. |  |
 | **in_use_license_count** | **Integer** | Number of licenses with at least one active machine. |  |
-| **seat_count** | **Integer** | Sum of the maximum numbers of machines of the licenses that haven't expired. Licenses without a maximum are left out. |  |
+| **seat_count** | **Integer** | Sum of the maximum numbers of machines of the licenses that haven't expired nor were canceled. Licenses without a maximum are left out. |  |
 | **used_seat_count** | **Integer** | Number of active machines of the licenses counted in `seatCount`, at most their maximum number of machines each. |  |
 | **full_license_count** | **Integer** | Number of licenses counted in `seatCount` active on their maximum number of machines. |  |
 | **days** | **Array<Date>** | The 30 days covered by the daily stats, from the oldest one, in UTC. |  |
@@ -19,6 +19,8 @@
 | **new_licenses_by_day** | **Array<Integer>** | Number of licenses created each day, aligned on `days`. |  |
 | **new_licenses_by_month** | **Array<Integer>** | Number of licenses created each month, aligned on `months`. |  |
 | **new_licenses_by_policy** | [**Array<ProductStatsNewLicensesByPolicyInner>**](ProductStatsNewLicensesByPolicyInner.md) | Number of licenses of each policy created each day and each month, for the policies with licenses created over the covered months. |  |
+| **cancellation** | [**CancellationStats**](CancellationStats.md) | Cancellations of the licenses with a money back guarantee. `null` when no license of the product has one. |  |
+| **subscriptions** | [**SubscriptionStats**](SubscriptionStats.md) | Subscriptions of the product. `null` when it has never had one. |  |
 | **revenue** | [**Array<Revenue>**](Revenue.md) | Revenue in each currency licenses were sold in, from the one with the most licenses sold. Amounts aren't converted between currencies. |  |
 | **activations_by_version** | [**Array<ProductStatsActivationsByVersionInner>**](ProductStatsActivationsByVersionInner.md) | Successful activations of the licenses of the product each day, per version of the application, from the most recent one. |  |
 | **active_machines_by_version** | [**Array<ProductStatsActiveMachinesByVersionInner>**](ProductStatsActiveMachinesByVersionInner.md) | Number of active machines running each version of the application, from the most recent one. |  |
@@ -45,6 +47,8 @@ instance = LicenseManager::ProductStats.new(
   new_licenses_by_day: [0, 2, 1],
   new_licenses_by_month: [4, 9, 12],
   new_licenses_by_policy: null,
+  cancellation: null,
+  subscriptions: null,
   revenue: null,
   activations_by_version: null,
   active_machines_by_version: null,

data/docs/ProductsApi.md

@@ -21,7 +21,7 @@ All URIs are relative to *https://api.licensemanager.dev*
 
 Create a product
 
-Without a `slug`, the product gets one derived from its name: lower cased, without accents and special characters (`Élan Pro 2!` becomes `elan-pro-2`). When another product of the organization already uses it, a dash and 3 random lowercase letters or digits are appended (`elan-pro-2-k3f`), until the slug is free.  An explicit `slug` is used as is: the request fails with a `409` when it's taken, it's never changed.  Slug uniqueness is enforced by the database, so when concurrent requests end up with the same slug, only one succeeds and the others get a `409`, even without an explicit `slug`. Retrying such a request without a `slug` derives a new one.  The product is created with its default policy, named `Default policy` with the `default` slug, whose settings are given by `defaultPolicy`. Omitted settings default to licenses that never expire, on a single machine, offline for one week, for every version of the product. Unlike `createPolicy`, where `maxMachines` defaults to no limit.  With `isTestFromProductId`, the product is a test product: its id, its slug, and the ids, slugs and license keys of its resources start with `test_` (`TEST-` for license keys), and only test API keys reach it. It starts with copies of the policies, releases and portal settings of the live product, `defaultPolicy` is ignored. Later changes to the live product aren't copied: reset the test product to copy them again. Test API keys can only create test products, live API keys only live ones.  **Required role permission**: `product:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+Without a `slug`, the product gets one derived from its name: lower cased, without accents and special characters (`Élan Pro 2!` becomes `elan-pro-2`). When another product of the organization already uses it, a dash and 3 random lowercase letters or digits are appended (`elan-pro-2-k3f`), until the slug is free.  An explicit `slug` is used as is: the request fails with a `409` when it's taken, it's never changed.  Slug uniqueness is enforced by the database, so when concurrent requests end up with the same slug, only one succeeds and the others get a `409`, even without an explicit `slug`. Retrying such a request without a `slug` derives a new one.  The product is created with its default policy, named `Default policy` with the `default` slug, whose settings are given by `defaultPolicy`. Omitted settings default to licenses that never expire, on a single machine, offline for one week, for every version of the product. Unlike `createPolicy`, where `maxMachines` defaults to no limit.  With `isTestFromProductId`, the product is a test product: its id, its slug, and the ids, slugs and license keys of its resources start with `test_` (`TEST-` for license keys), and only test API keys reach it. It starts with copies of the policies, releases, portal settings and `autoMachineChange` of the live product, `defaultPolicy` is ignored. Later changes to the live product aren't copied: reset the test product to copy them again. Test API keys can only create test products, live API keys only live ones.  **Required role permission**: `product:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
 
 ### Examples
 
@@ -454,7 +454,7 @@ end
 
 Reset a test product
 
-Deletes the customers, licenses, machines, policies and releases of the test product, with their events, then copies the policies, releases and portal settings of its live product again. Its id, name and slug are kept, but the copied policies get new ids. The tokens of its customers, licenses and machines stop working.  **Required role permission**: `product:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
+Deletes the customers, licenses, machines, policies and releases of the test product, with their events, then copies the policies, releases, portal settings and `autoMachineChange` of its live product again. Its id, name and slug are kept, but the copied policies get new ids. The tokens of its customers, licenses and machines stop working.  **Required role permission**: `product:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
 
 ### Examples
 

data/docs/Revenue.md

@@ -5,8 +5,12 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **currency** | **String** | ISO 4217 code of the currency of the revenue. |  |
-| **license_count** | **Integer** | Number of licenses sold in the currency, free ones included. |  |
-| **total** | **Float** | Sum of the prices of the licenses sold in the currency, in major units. |  |
+| **license_count** | **Integer** | Number of licenses sold once in the currency, free ones included, canceled ones and subscription licenses left out. |  |
+| **total** | **Float** | Revenue in the currency, in major units: the prices of the licenses sold once, canceled ones left out, plus the payments of the subscriptions, `subscriptionTotal`. |  |
+| **subscription_total** | **Float** | Sum of the payments of the subscription licenses in the currency, before taxes, in major units. |  |
+| **payment_count** | **Integer** | Number of payments of the subscription licenses in the currency. |  |
+| **canceled_license_count** | **Integer** | Number of canceled licenses sold once in the currency. |  |
+| **canceled_total** | **Float** | Sum of the prices of the canceled licenses sold once in the currency, in major units: revenue lost to cancellations. |  |
 | **this_month** | **Float** | Revenue of the current month, in UTC. |  |
 | **last_month** | **Float** | Revenue of the previous month, in UTC. |  |
 | **last30_days** | **Float** | Revenue of the last 30 days, today included, in UTC. |  |
@@ -23,6 +27,10 @@ instance = LicenseManager::Revenue.new(
   currency: USD,
   license_count: 42,
   total: 2099.58,
+  subscription_total: 480,
+  payment_count: 48,
+  canceled_license_count: 2,
+  canceled_total: 99.98,
   this_month: 349.93,
   last_month: 299.94,
   last30_days: 399.92,

data/docs/StripeIntegration.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **livemode** | **Boolean** | Mode of the Stripe connection the product uses: live for live products, test for test products. |  |
 | **webhook_url_reachable** | **Boolean** | Whether Stripe can reach the API's webhook URL. A local URL can't be: set `WEBHOOK_URL` on the server, like to a tunnel in development. |  |
-| **required_permissions** | [**Array<StripePermission>**](StripePermission.md) | Permissions the restricted API key needs, and why. Every other permission can stay `None`. |  |
+| **required_permissions** | [**Array<StripePermission>**](StripePermission.md) | Permissions the restricted API key needs, and why, the `optional` ones included. Every other permission can stay `None`. |  |
 | **integration** | [**Integration**](Integration.md) | The organization's Stripe connection in this mode, `null` when there's none. |  |
 | **mappings** | [**Array<IntegrationMapping>**](IntegrationMapping.md) | Stripe prices creating licenses of the product. |  |
 

data/docs/StripePermission.md

@@ -7,6 +7,8 @@
 | **resource** | **String** |  |  |
 | **access** | **String** |  |  |
 | **reason** | **String** |  |  |
+| **optional** | **Boolean** | Whether the key can connect without it, losing what it's for, explained by `reason`. |  |
+| **subscriptions** | **Boolean** | Whether it's only needed to sell subscriptions: checked once a recurring price is mapped. |  |
 
 ## Example
 
@@ -16,7 +18,9 @@ require 'license_manager'
 instance = LicenseManager::StripePermission.new(
   resource: Prices,
   access: null,
-  reason: Lists your prices so you can choose which ones create licenses, and checks they can still be paid.
+  reason: Lists your prices so you can choose which ones create licenses, and checks they can still be paid.,
+  optional: false,
+  subscriptions: false
 )
 ```
 

data/docs/StripePrice.md

@@ -9,6 +9,7 @@
 | **product_name** | **String** |  |  |
 | **nickname** | **String** |  |  |
 | **price** | [**Price**](Price.md) |  |  |
+| **recurring** | [**StripePriceRecurring**](StripePriceRecurring.md) |  |  |
 | **mapped** | **Boolean** | Whether the price already creates licenses of a product. |  |
 
 ## Example
@@ -22,6 +23,7 @@ instance = LicenseManager::StripePrice.new(
   product_name: Acme Pro,
   nickname: Launch price,
   price: null,
+  recurring: null,
   mapped: null
 )
 ```

data/docs/StripePriceRecurring.md

@@ -0,0 +1,20 @@
+# LicenseManager::StripePriceRecurring
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval** | **String** |  |  |
+| **interval_count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::StripePriceRecurring.new(
+  interval: null,
+  interval_count: 1
+)
+```
+

data/docs/SubscriptionStats.md

@@ -0,0 +1,38 @@
+# LicenseManager::SubscriptionStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_count** | **Integer** | Number of ongoing subscriptions: `active`, `trialing` or `past_due`. |  |
+| **trialing_count** | **Integer** |  |  |
+| **past_due_count** | **Integer** | Number of them whose renewal failed, as Stripe retries it: their licenses stay valid for the integration's grace days. |  |
+| **canceling_count** | **Integer** | Number of them set to end at the end of their period. |  |
+| **new_count** | **Integer** | Number of subscriptions started in the last 30 days. |  |
+| **ended_count** | **Integer** | Number of subscriptions that ended in the last 30 days. |  |
+| **churn_rate** | **Float** | Share of the subscriptions ongoing 30 days ago that ended since, from 0 to 1. |  |
+| **new_by_month** | **Array<Integer>** | Number of subscriptions started each month, aligned on `months`. |  |
+| **ended_by_month** | **Array<Integer>** | Number of subscriptions that ended each month, aligned on `months`. |  |
+| **active_by_month** | **Array<Integer>** | Number of ongoing subscriptions at the end of each month, aligned on `months`, today for this month. |  |
+| **mrr** | [**Array<Mrr>**](Mrr.md) | MRR in each currency, from the highest number of subscriptions. Amounts aren't converted between currencies. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::SubscriptionStats.new(
+  active_count: 120,
+  trialing_count: 4,
+  past_due_count: 3,
+  canceling_count: 5,
+  new_count: 14,
+  ended_count: 3,
+  churn_rate: 0.025,
+  new_by_month: [3, 5, 8],
+  ended_by_month: [0, 1, 2],
+  active_by_month: [90, 104, 120],
+  mrr: null
+)
+```
+