license_manager 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bcf4262163e03a08877a9fcd90c3ca632ed44a53507b49fd7ec1791aeb9f09a
-  data.tar.gz: d139d65dc28028b48968c2445fe26a2002d9a648cf786c07d4e74dcde28c4dbd
+  metadata.gz: 1d2fad9e16d3194d5a682104cbf199cbadf37b8960a262943d61355963bbf5bc
+  data.tar.gz: 423f1d92ca5ce3b5f3f47368437131f53b47bb12811e54709902ade88e691c28
 SHA512:
-  metadata.gz: 328ad38f8a2d30478b298c05c9adfcd98202fade7632455005bef6f535a7ca8a1e48bff28405963b2957f4ef40f5b12cf79e92dcfdac3bda13ecfb76fded9382
-  data.tar.gz: b1366be4e6662bb272b916a1ac1f2bc72b7182a97bc0fa1824a01a05b4a27c4e216bff5af55426a6ccd0ffac466dedabb4f084b472c3cdd9f2d169e5e7f0d6b0
+  metadata.gz: ead20ee997f6de97969a0fe24d9e3e26d4f9e665e7f15ef1776e5f71227cc1805f7078f3c6bf0ebf1f56e3054642912e8cc2aa27e7db5dd715cafc0a91bfe25d
+  data.tar.gz: 46838fa3d3d6777363fb88e38372d21234ea1a837201c88f1942fcbf7f07076f28d28023fac6d33d95e1aa45a7942beac19500683a902a8036590df10f01227e

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## 0.3.0 (2026-10-27)
+
+### Breaking changes
+
+- `POST /v1/customers/{id}/tokens`: added the new `customer:billing` enum value to the `scope/items/` response property for the response status `201`
+- `GET /v1/licenses/{id}/events`: added the new `license.payment_failed` enum value to the `data/items/type` response property for the response status `200`
+- `GET /v1/licenses/{id}/events`: added the new `license.payment_succeeded` enum value to the `data/items/type` response property for the response status `200`
+- `GET /v1/licenses/{id}/events`: added the new `license.subscription_ended` enum value to the `data/items/type` response property for the response status `200`
+- `POST /v1/licenses/{id}/tokens`: added the new `customer:billing` enum value to the `scope/items/` response property for the response status `201`
+- `POST /v1/machines/{id}/tokens`: added the new `customer:billing` enum value to the `scope/items/` response property for the response status `201`
+- `GET /v1/policies/{id}/events`: added the new `license.payment_failed` enum value to the `data/items/type` response property for the response status `200`
+- `GET /v1/policies/{id}/events`: added the new `license.payment_succeeded` enum value to the `data/items/type` response property for the response status `200`
+- `GET /v1/policies/{id}/events`: added the new `license.subscription_ended` enum value to the `data/items/type` response property for the response status `200`
+
+### Changes
+
+- `GET /v1/customers/{customerId}/licenses`: added the required property `data/items/subscription` to the response with the `200` status
+- `POST /v1/customers/{id}/billing-portal-sessions`: endpoint added
+- `POST /v1/customers/{id}/tokens`: added the new `customer:billing` enum value to the request property `scope/items/`
+- `PATCH /v1/integration-mappings/{id}`: added the required property `recurring` to the response with the `200` status
+- `PATCH /v1/integrations/{id}`: added the new optional request property `subscriptionGraceDays`
+- `PATCH /v1/integrations/{id}`: added the required property `canBillingPortal` to the response with the `200` status
+- `PATCH /v1/integrations/{id}`: added the required property `canManageSubscriptions` to the response with the `200` status
+- `PATCH /v1/integrations/{id}`: added the required property `subscriptionGraceDays` to the response with the `200` status
+- `POST /v1/integrations/{id}/check`: added the required property `canBillingPortal` to the response with the `200` status
+- `POST /v1/integrations/{id}/check`: added the required property `canManageSubscriptions` to the response with the `200` status
+- `POST /v1/integrations/{id}/check`: added the required property `subscriptionGraceDays` to the response with the `200` status
+- `GET /v1/integrations/{id}/stripe/prices`: added the required property `data/items/recurring` to the response with the `200` status
+- `GET /v1/licenses/{id}`: added the required property `subscription` to the response with the `200` status
+- `PATCH /v1/licenses/{id}`: added the non-success response with the status `409`
+- `PATCH /v1/licenses/{id}`: added the required property `subscription` to the response with the `200` status
+- `POST /v1/licenses/{id}/cancel`: added the required property `subscription` to the response with the `200` status
+- `GET /v1/licenses/{id}/events`: added the enum value `license.payment_failed` to the property `anyOf[#/components/schemas/EventType]/` of the `query` request parameter `type` (shared schema: `EventType`, also at `anyOf[#/components/schemas/EventType]`, `anyOf[subschema #2]/items`)
+- `GET /v1/licenses/{id}/events`: added the enum value `license.payment_succeeded` to the property `anyOf[#/components/schemas/EventType]/` of the `query` request parameter `type` (shared schema: `EventType`, also at `anyOf[#/components/schemas/EventType]`, `anyOf[subschema #2]/items`)
+- `GET /v1/licenses/{id}/events`: added the enum value `license.subscription_ended` to the property `anyOf[#/components/schemas/EventType]/` of the `query` request parameter `type` (shared schema: `EventType`, also at `anyOf[#/components/schemas/EventType]`, `anyOf[subschema #2]/items`)
+- `POST /v1/licenses/{id}/tokens`: added the new `customer:billing` enum value to the request property `scope/items/`
+- `POST /v1/machines/{id}/tokens`: added the new `customer:billing` enum value to the request property `scope/items/`
+- `GET /v1/policies/{id}/events`: added the enum value `license.payment_failed` to the property `anyOf[#/components/schemas/EventType]/` of the `query` request parameter `type` (shared schema: `EventType`, also at `anyOf[#/components/schemas/EventType]`, `anyOf[subschema #2]/items`)
+- `GET /v1/policies/{id}/events`: added the enum value `license.payment_succeeded` to the property `anyOf[#/components/schemas/EventType]/` of the `query` request parameter `type` (shared schema: `EventType`, also at `anyOf[#/components/schemas/EventType]`, `anyOf[subschema #2]/items`)
+- `GET /v1/policies/{id}/events`: added the enum value `license.subscription_ended` to the property `anyOf[#/components/schemas/EventType]/` of the `query` request parameter `type` (shared schema: `EventType`, also at `anyOf[#/components/schemas/EventType]`, `anyOf[subschema #2]/items`)
+- `GET /v1/products/{id}/stats`: added the required property `revenue/items/paymentCount` to the response with the `200` status
+- `GET /v1/products/{id}/stats`: added the required property `revenue/items/subscriptionTotal` to the response with the `200` status
+- `GET /v1/products/{id}/stats`: added the required property `subscriptions` to the response with the `200` status
+- `GET /v1/products/{productId}/integrations/stripe`: added the required property `integration/anyOf[#/components/schemas/Integration]/canBillingPortal` to the response with the `200` status
+- `GET /v1/products/{productId}/integrations/stripe`: added the required property `integration/anyOf[#/components/schemas/Integration]/canManageSubscriptions` to the response with the `200` status
+- `GET /v1/products/{productId}/integrations/stripe`: added the required property `integration/anyOf[#/components/schemas/Integration]/subscriptionGraceDays` to the response with the `200` status
+- `GET /v1/products/{productId}/integrations/stripe`: added the required property `mappings/items/recurring` to the response with the `200` status
+- `GET /v1/products/{productId}/integrations/stripe`: added the required property `requiredPermissions/items/subscriptions` to the response with the `200` status
+- `PUT /v1/products/{productId}/integrations/stripe`: added the required property `integration/anyOf[#/components/schemas/Integration]/canBillingPortal` to the response with the `200` status
+- `PUT /v1/products/{productId}/integrations/stripe`: added the required property `integration/anyOf[#/components/schemas/Integration]/canManageSubscriptions` to the response with the `200` status
+- `PUT /v1/products/{productId}/integrations/stripe`: added the required property `integration/anyOf[#/components/schemas/Integration]/subscriptionGraceDays` to the response with the `200` status
+- `PUT /v1/products/{productId}/integrations/stripe`: added the required property `mappings/items/recurring` to the response with the `200` status
+- `PUT /v1/products/{productId}/integrations/stripe`: added the required property `requiredPermissions/items/subscriptions` to the response with the `200` status
+- `POST /v1/products/{productId}/integrations/stripe/mappings`: added the required property `recurring` to the response with the `201` status
+- `GET /v1/products/{productId}/licenses`: added the required property `data/items/subscription` to the response with the `200` status
+- `POST /v1/products/{productId}/licenses`: added the required property `subscription` to the response with the `201` status
+
 ## 0.2.0 (2026-10-27)
 
 ### Breaking changes

data/README.md

@@ -77,7 +77,7 @@ Every method is documented, with its parameters and responses, in the [`docs`](d
 | Class | Methods |
 | --- | --- |
 | [`LicensesApi`](docs/LicensesApi.md) | `validate_key`, `list_licenses`, `create_license`, `list_customer_licenses`, `get_license`, `delete_license`, `update_license`, `get_license_stats`, `cancel_license`, `send_license_keys`, `get_signing_key` |
-| [`PortalApi`](docs/PortalApi.md) | `get_portal`, `request_portal_link`, `create_portal_link`, `send_portal_link` |
+| [`PortalApi`](docs/PortalApi.md) | `get_portal`, `request_portal_link`, `create_portal_link`, `create_billing_portal_session`, `send_portal_link` |
 | [`ProductsApi`](docs/ProductsApi.md) | `list_products`, `create_product`, `get_product`, `delete_product`, `update_product`, `reset_product`, `upload_product_logo`, `delete_product_logo`, `get_product_stats` |
 | [`PoliciesApi`](docs/PoliciesApi.md) | `list_policies`, `create_policy`, `get_policy`, `delete_policy`, `update_policy` |
 | [`CustomersApi`](docs/CustomersApi.md) | `list_customers`, `create_customer`, `get_customer`, `delete_customer`, `update_customer` |

data/docs/BillingPortalSession.md

@@ -0,0 +1,18 @@
+# LicenseManager::BillingPortalSession
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Link to the Stripe customer portal, to open right away: it expires shortly. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::BillingPortalSession.new(
+  url: https://billing.stripe.com/p/session/test_YWNjdF8x
+)
+```
+

data/docs/CreateBillingPortalSession.md

@@ -0,0 +1,18 @@
+# LicenseManager::CreateBillingPortalSession
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **return_url** | **String** | Where the Stripe customer portal links back to: a page of the customer portal, or of one of the product's `returnDomains`. The customer portal of the product by default. | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::CreateBillingPortalSession.new(
+  return_url: https://example.com/account
+)
+```
+

data/docs/CreateIntegrationMapping.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **stripe_price_id** | **String** | Active one-time price of the Stripe account. |  |
+| **stripe_price_id** | **String** | Active one-time or licensed recurring price of the Stripe account. |  |
 | **policy_id** | **String** |  |  |
 
 ## Example

data/docs/Integration.md

@@ -16,6 +16,9 @@
 | **last_event_at** | **Time** | Last time it received an event from the provider. |  |
 | **auto_refund** | **Boolean** | Whether canceling a license bought through Stripe refunds its payment. On by default, always off when `canRefund` is false. |  |
 | **can_refund** | **Boolean** | Whether the API key has the optional Refunds: Write permission, checked when connecting and every day. Without it, canceled licenses aren't refunded: refund their payments from Stripe. |  |
+| **can_manage_subscriptions** | **Boolean** | Whether the API key has the optional Subscriptions: Write permission, checked when connecting and every day. Without it, subscription licenses can't be canceled from the app: cancel their subscriptions from Stripe. |  |
+| **can_billing_portal** | **Boolean** | Whether the API key has the optional Customer portal: Write permission, checked when connecting and every day. Without it, the license portal doesn't link to the Stripe customer portal. |  |
+| **subscription_grace_days** | **Integer** | Days a subscription license stays valid after its period ends while its renewal is unpaid, as Stripe retries the payment. 7 by default. |  |
 | **created_at** | **Time** |  |  |
 
 ## Example
@@ -36,6 +39,9 @@ instance = LicenseManager::Integration.new(
   last_event_at: null,
   auto_refund: true,
   can_refund: true,
+  can_manage_subscriptions: true,
+  can_billing_portal: true,
+  subscription_grace_days: 7,
   created_at: null
 )
 ```

data/docs/IntegrationMapping.md

@@ -12,6 +12,7 @@
 | **stripe_price_id** | **String** |  |  |
 | **product_name** | **String** | Name of the Stripe product when it was mapped. |  |
 | **price** | [**Price**](Price.md) |  |  |
+| **recurring** | [**IntegrationMappingRecurring**](IntegrationMappingRecurring.md) |  |  |
 | **status** | **String** | `error` when the price can no longer be paid, explained by `statusReason`. |  |
 | **status_reason** | **String** |  |  |
 | **created_at** | **Time** |  |  |
@@ -30,6 +31,7 @@ instance = LicenseManager::IntegrationMapping.new(
   stripe_price_id: price_1MoBy5LkdIwHu7ix,
   product_name: Acme Pro,
   price: null,
+  recurring: null,
   status: null,
   status_reason: The price is archived in Stripe,
   created_at: null

data/docs/IntegrationMappingRecurring.md

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

data/docs/License.md

@@ -23,6 +23,7 @@
 | **cancellable_until** | **Time** | End of the money back guarantee: until then, the customer can cancel the license from the customer portal, or with a token. Set from the policy's `moneyBackGuaranteeDays` when the license is created. `null` when the customer can't cancel it. |  |
 | **canceled_at** | **Time** | When the license was canceled: validating its key fails since. `null` when it wasn't. |  |
 | **cancellation_reason** | [**CancellationReason**](CancellationReason.md) |  |  |
+| **subscription** | [**LicenseSubscription**](LicenseSubscription.md) |  |  |
 | **cancellation_comment** | **String** | Comment given when the license was canceled. `null` when there's none. |  |
 | **stripe_refund_id** | **String** | Id of the Stripe refund of the license's payment once it was canceled, through the Stripe integration. `null` otherwise. |  |
 | **updated_at** | **Time** | Last time the license's settings were edited, not when its key was validated. |  |
@@ -52,6 +53,7 @@ instance = LicenseManager::License.new(
   cancellable_until: 2026-02-14T09:30:00.000Z,
   canceled_at: 2026-01-20T16:12:00.000Z,
   cancellation_reason: null,
+  subscription: null,
   cancellation_comment: I only needed it for one project.,
   stripe_refund_id: re_3MtwBwLkdIwHu7ix0Bs5rA2b,
   updated_at: 2026-01-15T09:30:00.000Z

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

@@ -23,7 +23,7 @@ All URIs are relative to *https://api.licensemanager.dev*
 
 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.  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.
+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
 

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/PortalApi.md

@@ -4,12 +4,91 @@ 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)

data/docs/ProductStats.md

@@ -20,6 +20,7 @@
 | **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. |  |
@@ -47,6 +48,7 @@ instance = LicenseManager::ProductStats.new(
   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/Revenue.md

@@ -5,10 +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, canceled ones left out. |  |
-| **total** | **Float** | Sum of the prices of the licenses sold in the currency, in major units, canceled ones left out. |  |
-| **canceled_license_count** | **Integer** | Number of canceled licenses sold in the currency. |  |
-| **canceled_total** | **Float** | Sum of the prices of the canceled licenses sold in the currency, in major units: revenue lost to cancellations. |  |
+| **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. |  |
@@ -25,6 +27,8 @@ 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,

data/docs/StripePermission.md

@@ -8,6 +8,7 @@
 | **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
 
@@ -18,7 +19,8 @@ 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.,
-  optional: false
+  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
+)
+```
+

data/docs/UpdateIntegration.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **auto_refund** | **Boolean** | Whether canceling a license bought through Stripe refunds its payment. Can only be turned on when the integration's `canRefund` is true: the API key has the Refunds: Write permission. | [optional] |
+| **subscription_grace_days** | **Integer** | Days a subscription license stays valid after its period ends while its renewal is unpaid, as Stripe retries the payment. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'license_manager'
 
 instance = LicenseManager::UpdateIntegration.new(
-  auto_refund: false
+  auto_refund: false,
+  subscription_grace_days: 7
 )
 ```
 

data/lib/license_manager/api/licenses_api.rb

@@ -20,7 +20,7 @@ module LicenseManager
       @api_client = api_client
     end
     # 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.  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.
+    # 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.
     # @param id [String] 
     # @param cancel_license [CancelLicense] 
     # @param [Hash] opts the optional parameters
@@ -31,7 +31,7 @@ module LicenseManager
     end
 
     # 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.  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.
+    # 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.
     # @param id [String] 
     # @param cancel_license [CancelLicense] 
     # @param [Hash] opts the optional parameters