seatschart 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf500c95050180ca08ecccc9dc9660ffa6b1646d816bf90d52bef6753f64ba7
-  data.tar.gz: ed22fd40429b7b321fea64c13b8ecedf9d7eaf9bb932fc63334c68cbad5c990c
+  metadata.gz: 590c96bfa128894d11dd556141fd811e137e0465115e0d29aecac3a5eeb4c190
+  data.tar.gz: '0289a7df24571425b5aa5ad678c88b4f357e4fa53251a8c9a435774d99016936'
 SHA512:
-  metadata.gz: 996547fffc7b78bee7346e9a39aba7a04a21e66cd8ad6751ae3c592a622d5f928f37567b73723ffcc92f1b627ef2eafe003be6a0f3198b3044e9a1f9a93bf967
-  data.tar.gz: a1d73694b0dd53588af105c2b701656aa1e2e0c62ff63cdbe064e3266ad639f6dbc8cc40582fe65e29f989b8f9b30418088cb6c15e409cc3a232f5523b4d2dbc
+  metadata.gz: 3fc2f7be846627bbef83a72c58ea55479bd62a668af9adb878298222e954105815b8ffd38ac1988cdf735c33bf41780fc29013770e90c3071c9ce663e08a2168
+  data.tar.gz: 2c149651a3cb6789590b3ee99e8e8a760ced17201f00b93020fa4881f145cf1a219a47f38b59f5b65848d6ef6a1c467a93ff5878239c18bc6db2b6c79e6f4d86

data/README.md

@@ -72,6 +72,21 @@ rescue SeatsChart::Retry::TimeoutError => e # e.error_code == 'timeout', e.attem
 end
 ```
 
+## One workspace per organizer
+
+Ticketing platforms give each organizer its own workspace and operate all of them with one workspace admin key. `forWorkspace` scopes a client to one workspace (its id or external id) with `X-Workspace-Key`; the `Workspaces` helper provisions an organizer (`externalId`, `templateWorkspaceId`, `issueKey`, always with an `Idempotency-Key`) and covers `getByExternalId`, keys, members, invitations and the consolidated overview. The generated `WorkspaceApi` methods stay available.
+
+```ruby
+workspaces = SeatsChart::Workspaces.new(platform) # platform: a SeatsChart::ApiClient with the workspace admin key
+created = workspaces.create({ displayName: 'Teatro Aurora', externalId: 'org-1042', templateWorkspaceId: 'org-template',
+                              issueKey: { name: 'Server key' } }, idempotency_key: 'provision-org-1042')
+org = SeatsChart.for_workspace('org-1042', platform) # every call through org sends X-Workspace-Key
+events = SeatsChart::EventsApi.new(org)
+workspaces.keys.rotate('org-1042', created.api_key.id)
+workspaces.invitations.create('org-1042', { email: 'box-office@teatro-aurora.example', role: 'viewer' })
+workspaces.list_all_overview(created_by_api: true).each { |row| puts "#{row.external_id} #{row.seats.sold}" }
+```
+
 <!-- seatschart:intro -->
 
 # seatschart
@@ -83,7 +98,7 @@ Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 0.4.0
+- Package version: 0.5.0
 - Generator version: 7.11.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -96,7 +111,7 @@ gem install seatschart
 or add it to the Gemfile:
 
 ```ruby
-gem 'seatschart', '~> 0.4.0'
+gem 'seatschart', '~> 0.5.0'
 ```
 
 ## Getting Started
@@ -160,10 +175,11 @@ Class | Method | HTTP request | Description
 *SeatsChart::AuthApi* | [**post_api_auth_refresh**](docs/AuthApi.md#post_api_auth_refresh) | **POST** /api/auth/refresh | Rotate refresh token and issue new access JWT
 *SeatsChart::AuthApi* | [**post_api_auth_signup**](docs/AuthApi.md#post_api_auth_signup) | **POST** /api/auth/signup | Create account and workspace
 *SeatsChart::AuthApi* | [**post_api_auth_switch_workspace**](docs/AuthApi.md#post_api_auth_switch_workspace) | **POST** /api/auth/switch-workspace | Switch active workspace
-*SeatsChart::BillingApi* | [**get_api_billing**](docs/BillingApi.md#get_api_billing) | **GET** /api/billing | Get billing status and plan usage
-*SeatsChart::BillingApi* | [**post_api_billing_checkout_session**](docs/BillingApi.md#post_api_billing_checkout_session) | **POST** /api/billing/checkout-session | Create Stripe Checkout session for a paid plan
-*SeatsChart::BillingApi* | [**post_api_billing_confirm_checkout**](docs/BillingApi.md#post_api_billing_confirm_checkout) | **POST** /api/billing/confirm-checkout | Confirm checkout session and sync plan
-*SeatsChart::BillingApi* | [**post_api_billing_portal_session**](docs/BillingApi.md#post_api_billing_portal_session) | **POST** /api/billing/portal-session | Create Stripe Customer Portal session
+*SeatsChart::BillingApi* | [**get_api_billing**](docs/BillingApi.md#get_api_billing) | **GET** /api/billing | Get the billing account, its plan and usage
+*SeatsChart::BillingApi* | [**post_api_billing_actions_change_plan**](docs/BillingApi.md#post_api_billing_actions_change_plan) | **POST** /api/billing/actions/change-plan | Leave Ultra On-Demand for the Free plan (the whole account)
+*SeatsChart::BillingApi* | [**post_api_billing_checkout_session**](docs/BillingApi.md#post_api_billing_checkout_session) | **POST** /api/billing/checkout-session | Create Stripe Checkout session for a paid plan (the whole account)
+*SeatsChart::BillingApi* | [**post_api_billing_confirm_checkout**](docs/BillingApi.md#post_api_billing_confirm_checkout) | **POST** /api/billing/confirm-checkout | Confirm checkout session and sync the account plan
+*SeatsChart::BillingApi* | [**post_api_billing_portal_session**](docs/BillingApi.md#post_api_billing_portal_session) | **POST** /api/billing/portal-session | Create Stripe Customer Portal session (the account subscription)
 *SeatsChart::BillingApi* | [**post_api_billing_webhook**](docs/BillingApi.md#post_api_billing_webhook) | **POST** /api/billing/webhook | Stripe webhook
 *SeatsChart::ChartsApi* | [**delete_api_charts_by_chart_id**](docs/ChartsApi.md#delete_api_charts_by_chart_id) | **DELETE** /api/charts/{chartId} | Delete chart permanently
 *SeatsChart::ChartsApi* | [**delete_api_charts_by_chart_id_categories_by_category_id**](docs/ChartsApi.md#delete_api_charts_by_chart_id_categories_by_category_id) | **DELETE** /api/charts/{chartId}/categories/{categoryId} | Delete a category from the chart draft
@@ -522,11 +538,12 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
- - [SeatsChart::ApiError](docs/ApiError.md)
+ - [SeatsChart::ApiErrorBody](docs/ApiErrorBody.md)
  - [SeatsChart::ApiErrorParamsValue](docs/ApiErrorParamsValue.md)
  - [SeatsChart::DeleteApiSandboxesBySandboxId200Response](docs/DeleteApiSandboxesBySandboxId200Response.md)
  - [SeatsChart::DeleteApiWorkspacesByWorkspaceId200Response](docs/DeleteApiWorkspacesByWorkspaceId200Response.md)
  - [SeatsChart::DeleteApiWorkspacesByWorkspaceIdKeysByKeyId200Response](docs/DeleteApiWorkspacesByWorkspaceIdKeysByKeyId200Response.md)
+ - [SeatsChart::DeleteApiWorkspacesByWorkspaceIdMembersByUserId200Response](docs/DeleteApiWorkspacesByWorkspaceIdMembersByUserId200Response.md)
  - [SeatsChart::GetApiChartsByChartIdVersions200Response](docs/GetApiChartsByChartIdVersions200Response.md)
  - [SeatsChart::GetApiChartsByChartIdVersions200ResponseItemsInner](docs/GetApiChartsByChartIdVersions200ResponseItemsInner.md)
  - [SeatsChart::GetApiChartsByChartIdVersions200ResponseItemsInnerPublishedBy](docs/GetApiChartsByChartIdVersions200ResponseItemsInnerPublishedBy.md)
@@ -564,10 +581,25 @@ Class | Method | HTTP request | Description
  - [SeatsChart::GetApiWorkspaceSettings200ResponseSources](docs/GetApiWorkspaceSettings200ResponseSources.md)
  - [SeatsChart::GetApiWorkspaces200Response](docs/GetApiWorkspaces200Response.md)
  - [SeatsChart::GetApiWorkspaces200ResponseItemsInner](docs/GetApiWorkspaces200ResponseItemsInner.md)
+ - [SeatsChart::GetApiWorkspacesByWorkspaceIdInvitations200Response](docs/GetApiWorkspacesByWorkspaceIdInvitations200Response.md)
+ - [SeatsChart::GetApiWorkspacesByWorkspaceIdInvitations200ResponseInvitationsInner](docs/GetApiWorkspacesByWorkspaceIdInvitations200ResponseInvitationsInner.md)
  - [SeatsChart::GetApiWorkspacesByWorkspaceIdKeys200Response](docs/GetApiWorkspacesByWorkspaceIdKeys200Response.md)
  - [SeatsChart::GetApiWorkspacesByWorkspaceIdKeys200ResponseApiKeysInner](docs/GetApiWorkspacesByWorkspaceIdKeys200ResponseApiKeysInner.md)
- - [SeatsChart::GetApiWorkspacesCreatedByApiParameter](docs/GetApiWorkspacesCreatedByApiParameter.md)
- - [SeatsChart::GetApiWorkspacesOverviewCreatedByApiParameter](docs/GetApiWorkspacesOverviewCreatedByApiParameter.md)
+ - [SeatsChart::GetApiWorkspacesByWorkspaceIdMembers200Response](docs/GetApiWorkspacesByWorkspaceIdMembers200Response.md)
+ - [SeatsChart::GetApiWorkspacesByWorkspaceIdMembers200ResponseMembersInner](docs/GetApiWorkspacesByWorkspaceIdMembers200ResponseMembersInner.md)
+ - [SeatsChart::GetApiWorkspacesOverview200Response](docs/GetApiWorkspacesOverview200Response.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseAccount](docs/GetApiWorkspacesOverview200ResponseAccount.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseAccountCharts](docs/GetApiWorkspacesOverview200ResponseAccountCharts.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseAccountPlan](docs/GetApiWorkspacesOverview200ResponseAccountPlan.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseItemsInner](docs/GetApiWorkspacesOverview200ResponseItemsInner.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseItemsInnerRevenue](docs/GetApiWorkspacesOverview200ResponseItemsInnerRevenue.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseItemsInnerUsage](docs/GetApiWorkspacesOverview200ResponseItemsInnerUsage.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseSeats](docs/GetApiWorkspacesOverview200ResponseSeats.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseSeatsOverage](docs/GetApiWorkspacesOverview200ResponseSeatsOverage.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseSeatsProjected](docs/GetApiWorkspacesOverview200ResponseSeatsProjected.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseTotals](docs/GetApiWorkspacesOverview200ResponseTotals.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseTotalsRevenue](docs/GetApiWorkspacesOverview200ResponseTotalsRevenue.md)
+ - [SeatsChart::GetApiWorkspacesOverview200ResponseTotalsSeats](docs/GetApiWorkspacesOverview200ResponseTotalsSeats.md)
  - [SeatsChart::PatchApiChartsByChartIdCategoriesByCategoryIdRequest](docs/PatchApiChartsByChartIdCategoriesByCategoryIdRequest.md)
  - [SeatsChart::PatchApiChartsByChartIdRequest](docs/PatchApiChartsByChartIdRequest.md)
  - [SeatsChart::PatchApiEventsByEventIdInventoryChannelsByChannelKeyIdRequest](docs/PatchApiEventsByEventIdInventoryChannelsByChannelKeyIdRequest.md)
@@ -603,6 +635,7 @@ Class | Method | HTTP request | Description
  - [SeatsChart::PostApiAuthRefreshRequest](docs/PostApiAuthRefreshRequest.md)
  - [SeatsChart::PostApiAuthSignupRequest](docs/PostApiAuthSignupRequest.md)
  - [SeatsChart::PostApiAuthSwitchWorkspaceRequest](docs/PostApiAuthSwitchWorkspaceRequest.md)
+ - [SeatsChart::PostApiBillingActionsChangePlanRequest](docs/PostApiBillingActionsChangePlanRequest.md)
  - [SeatsChart::PostApiBillingCheckoutSessionRequest](docs/PostApiBillingCheckoutSessionRequest.md)
  - [SeatsChart::PostApiBillingConfirmCheckoutRequest](docs/PostApiBillingConfirmCheckoutRequest.md)
  - [SeatsChart::PostApiChartsByChartIdActionsArchive200Response](docs/PostApiChartsByChartIdActionsArchive200Response.md)
@@ -717,6 +750,8 @@ Class | Method | HTTP request | Description
  - [SeatsChart::PostApiWorkspaces200ResponseTemplateWebhooksInner](docs/PostApiWorkspaces200ResponseTemplateWebhooksInner.md)
  - [SeatsChart::PostApiWorkspacesByWorkspaceIdActionsDelete200Response](docs/PostApiWorkspacesByWorkspaceIdActionsDelete200Response.md)
  - [SeatsChart::PostApiWorkspacesByWorkspaceIdActionsDeleteRequest](docs/PostApiWorkspacesByWorkspaceIdActionsDeleteRequest.md)
+ - [SeatsChart::PostApiWorkspacesByWorkspaceIdInvitations201Response](docs/PostApiWorkspacesByWorkspaceIdInvitations201Response.md)
+ - [SeatsChart::PostApiWorkspacesByWorkspaceIdInvitations201ResponseInvitation](docs/PostApiWorkspacesByWorkspaceIdInvitations201ResponseInvitation.md)
  - [SeatsChart::PostApiWorkspacesByWorkspaceIdInvitationsRequest](docs/PostApiWorkspacesByWorkspaceIdInvitationsRequest.md)
  - [SeatsChart::PostApiWorkspacesByWorkspaceIdKeys201Response](docs/PostApiWorkspacesByWorkspaceIdKeys201Response.md)
  - [SeatsChart::PostApiWorkspacesByWorkspaceIdKeys201ResponseApiKey](docs/PostApiWorkspacesByWorkspaceIdKeys201ResponseApiKey.md)

data/lib/seatschart/api/audit_api.rb

@@ -20,7 +20,7 @@ module SeatsChart
       @api_client = api_client
     end
     # List recent workspace audit log entries
-    # Append-only config change history for the JWT tenant. Requires `workspace_admin`. Each entry carries where the change came from when known: `ip` (client IP truncated to /24 for IPv4 or /48 for IPv6), `userAgent` and `requestId` (the `x-request-id` of the request that made it); these are never part of the public event log or its webhooks.
+    # Append-only config change history for the JWT tenant. Requires `workspace_admin`. Each entry carries where the change came from when known: `ip` (client IP truncated to /24 for IPv4 or /48 for IPv6), `userAgent` and `requestId` (the `x-request-id` of the request that made it); these are never part of the public event log or its webhooks. `summary` is an English sentence; `data` holds the details of the change (the audit metadata without those private fields, as in the event log), from which clients can render the entry in another language.
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :limit  (default to 50)
     # @return [nil]
@@ -30,7 +30,7 @@ module SeatsChart
     end
 
     # List recent workspace audit log entries
-    # Append-only config change history for the JWT tenant. Requires `workspace_admin`. Each entry carries where the change came from when known: `ip` (client IP truncated to /24 for IPv4 or /48 for IPv6), `userAgent` and `requestId` (the `x-request-id` of the request that made it); these are never part of the public event log or its webhooks.
+    # Append-only config change history for the JWT tenant. Requires `workspace_admin`. Each entry carries where the change came from when known: `ip` (client IP truncated to /24 for IPv4 or /48 for IPv6), `userAgent` and `requestId` (the `x-request-id` of the request that made it); these are never part of the public event log or its webhooks. `summary` is an English sentence; `data` holds the details of the change (the audit metadata without those private fields, as in the event log), from which clients can render the entry in another language.
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :limit  (default to 50)
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

data/lib/seatschart/api/auth_api.rb

@@ -142,7 +142,7 @@ module SeatsChart
     end
 
     # Current dashboard user
-    # Returns the authenticated user when the Bearer token was issued by `/auth/login` or `/auth/signup`.
+    # Returns the authenticated user when the Bearer token was issued by `/auth/login` or `/auth/signup`. `user.seatAllowance` is set when the workspace is on Free and used at least 80% of its seats of the month: `state` `near`, or `reached` when its events accept no new holds until `resumesAt` (the next UTC month) or an upgrade (holds already taken can still be confirmed); null otherwise. The seats are counted over every workspace of the billing account; `managedBy` is the e-mail of the account owner when the caller is not the owner (only the owner upgrades).
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def get_api_auth_me(opts = {})
@@ -151,7 +151,7 @@ module SeatsChart
     end
 
     # Current dashboard user
-    # Returns the authenticated user when the Bearer token was issued by `/auth/login` or `/auth/signup`.
+    # Returns the authenticated user when the Bearer token was issued by `/auth/login` or `/auth/signup`. `user.seatAllowance` is set when the workspace is on Free and used at least 80% of its seats of the month: `state` `near`, or `reached` when its events accept no new holds until `resumesAt` (the next UTC month) or an upgrade (holds already taken can still be confirmed); null otherwise. The seats are counted over every workspace of the billing account; `managedBy` is the e-mail of the account owner when the caller is not the owner (only the owner upgrades).
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def get_api_auth_me_with_http_info(opts = {})
@@ -1108,7 +1108,7 @@ module SeatsChart
     end
 
     # Create account and workspace
-    # Registers a new user, provisions a tenant workspace, and returns an HS256 dashboard JWT (`tenant_id`, `sub`, `email`, `role`).
+    # Registers a new user, provisions a tenant workspace, and returns an HS256 dashboard JWT (`tenant_id`, `sub`, `email`, `role`, `is_test`).
     # @param post_api_auth_signup_request [PostApiAuthSignupRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -1119,7 +1119,7 @@ module SeatsChart
     end
 
     # Create account and workspace
-    # Registers a new user, provisions a tenant workspace, and returns an HS256 dashboard JWT (&#x60;tenant_id&#x60;, &#x60;sub&#x60;, &#x60;email&#x60;, &#x60;role&#x60;).
+    # Registers a new user, provisions a tenant workspace, and returns an HS256 dashboard JWT (&#x60;tenant_id&#x60;, &#x60;sub&#x60;, &#x60;email&#x60;, &#x60;role&#x60;, &#x60;is_test&#x60;).
     # @param post_api_auth_signup_request [PostApiAuthSignupRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.

data/lib/seatschart/api/billing_api.rb

@@ -19,8 +19,8 @@ module SeatsChart
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get billing status and plan usage
-    # Plan, subscription, usage against the limits and the plan catalogue. `managedByPlatform` is true for a workspace a ticketing platform provisioned with its workspace admin key: it is billed to the platform account, so only that platform admin may open checkout or the billing portal (`canManageBilling`); everyone else gets 403 `billing_managed_by_platform` there, and plan-limit refusals carry `billingManagedByPlatform: true` instead of an upgrade prompt.
+    # Get the billing account, its plan and usage
+    # One plan per account: the plan, its limits and the Stripe subscription belong to the billing account that owns the workspace, and apply to every workspace of the account. `account` names the owner (who alone may change the plan, from a dashboard session: `canManageBilling`), the workspaces it covers (listed to the owner) and the account's chart and event counts, which the caps count together. `usage` holds this workspace's counts (charts, events, embed domains and used objects this month); embed domains stay limited per workspace. `seats` is the used seats of the month over every production workspace of the account against the included seats, the overage so far and projected, and its cost. On Ultra On-Demand (`isSalesManaged`) the owner may switch to a paid plan through checkout (the account stays on Ultra until the checkout is confirmed) or to Free with `POST /billing/actions/change-plan`. `managedByPlatform` is true for a workspace a ticketing platform provisioned with its workspace admin key: it belongs to the platform admin's account, and plan-limit refusals carry `billingManagedByPlatform: true` instead of an upgrade prompt.
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def get_api_billing(opts = {})
@@ -28,8 +28,8 @@ module SeatsChart
       nil
     end
 
-    # Get billing status and plan usage
-    # Plan, subscription, usage against the limits and the plan catalogue. `managedByPlatform` is true for a workspace a ticketing platform provisioned with its workspace admin key: it is billed to the platform account, so only that platform admin may open checkout or the billing portal (`canManageBilling`); everyone else gets 403 `billing_managed_by_platform` there, and plan-limit refusals carry `billingManagedByPlatform: true` instead of an upgrade prompt.
+    # Get the billing account, its plan and usage
+    # One plan per account: the plan, its limits and the Stripe subscription belong to the billing account that owns the workspace, and apply to every workspace of the account. `account` names the owner (who alone may change the plan, from a dashboard session: `canManageBilling`), the workspaces it covers (listed to the owner) and the account's chart and event counts, which the caps count together. `usage` holds this workspace's counts (charts, events, embed domains and used objects this month); embed domains stay limited per workspace. `seats` is the used seats of the month over every production workspace of the account against the included seats, the overage so far and projected, and its cost. On Ultra On-Demand (`isSalesManaged`) the owner may switch to a paid plan through checkout (the account stays on Ultra until the checkout is confirmed) or to Free with `POST /billing/actions/change-plan`. `managedByPlatform` is true for a workspace a ticketing platform provisioned with its workspace admin key: it belongs to the platform admin's account, and plan-limit refusals carry `billingManagedByPlatform: true` instead of an upgrade prompt.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def get_api_billing_with_http_info(opts = {})
@@ -74,8 +74,85 @@ module SeatsChart
       return data, status_code, headers
     end
 
-    # Create Stripe Checkout session for a paid plan
-    # Returns `{ url }` of a Stripe Checkout for `planId` (`starter` | `pro`). 409 `ERR_SUBSCRIPTION_EXISTS` when the workspace already has a live subscription (change plans in the billing portal: `POST /billing/portal-session`), 409 `test_workspace_not_billable` in a test workspace, 400 `plan_requires_sales` for `ultra` (Ultra On-Demand is arranged with the SeatsChart team), 409 `plan_managed_by_sales` on an Ultra On-Demand workspace,503 `stripe_not_configured` when billing is not set up.
+    # Leave Ultra On-Demand for the Free plan (the whole account)
+    # Moves an Ultra On-Demand billing account to Free right away, with no payment: every workspace of the account moves at once, the Ultra limits end now and the Free limits apply (the agreed custom limits are cleared). Charts, events and embed domains above the Free limits are kept and keep working; new ones are refused (402 `plan_limit_exceeded`) until the account is back within the limits or upgrades. Returns `{ changed, previousPlanId, planId, limits, usage, withinLimits, workspaces }` (`usage`: the account's charts and events, this workspace's embed domains; `workspaces`: the workspaces that moved); an account already on Free answers 200 with `changed: false`. Audited once on the account and once on this workspace as `billing.plan_changed`. Account owner only, from a dashboard session: the other admins get 403 `billing_managed_by_owner` (with `managedBy`), the members of a workspace a ticketing platform manages 403 `billing_managed_by_platform`, API keys 403 `forbidden` (`ERR_PARTNER_SCOPE`). Send an `Idempotency-Key` to make retries safe (the first result is replayed for 24 hours; another body with the same key: 422 `idempotency_key_reused`). 400 `checkout_required` for a paid plan (use `POST /billing/checkout-session`), 400 `plan_requires_sales` for `ultra`, 409 `ERR_SUBSCRIPTION_EXISTS` with a paid subscription (change it in the billing portal), 409 `test_workspace_not_billable` in a test workspace.
+    # @param post_api_billing_actions_change_plan_request [PostApiBillingActionsChangePlanRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [nil]
+    def post_api_billing_actions_change_plan(post_api_billing_actions_change_plan_request, opts = {})
+      post_api_billing_actions_change_plan_with_http_info(post_api_billing_actions_change_plan_request, opts)
+      nil
+    end
+
+    # Leave Ultra On-Demand for the Free plan (the whole account)
+    # Moves an Ultra On-Demand billing account to Free right away, with no payment: every workspace of the account moves at once, the Ultra limits end now and the Free limits apply (the agreed custom limits are cleared). Charts, events and embed domains above the Free limits are kept and keep working; new ones are refused (402 &#x60;plan_limit_exceeded&#x60;) until the account is back within the limits or upgrades. Returns &#x60;{ changed, previousPlanId, planId, limits, usage, withinLimits, workspaces }&#x60; (&#x60;usage&#x60;: the account&#39;s charts and events, this workspace&#39;s embed domains; &#x60;workspaces&#x60;: the workspaces that moved); an account already on Free answers 200 with &#x60;changed: false&#x60;. Audited once on the account and once on this workspace as &#x60;billing.plan_changed&#x60;. Account owner only, from a dashboard session: the other admins get 403 &#x60;billing_managed_by_owner&#x60; (with &#x60;managedBy&#x60;), the members of a workspace a ticketing platform manages 403 &#x60;billing_managed_by_platform&#x60;, API keys 403 &#x60;forbidden&#x60; (&#x60;ERR_PARTNER_SCOPE&#x60;). Send an &#x60;Idempotency-Key&#x60; to make retries safe (the first result is replayed for 24 hours; another body with the same key: 422 &#x60;idempotency_key_reused&#x60;). 400 &#x60;checkout_required&#x60; for a paid plan (use &#x60;POST /billing/checkout-session&#x60;), 400 &#x60;plan_requires_sales&#x60; for &#x60;ultra&#x60;, 409 &#x60;ERR_SUBSCRIPTION_EXISTS&#x60; with a paid subscription (change it in the billing portal), 409 &#x60;test_workspace_not_billable&#x60; in a test workspace.
+    # @param post_api_billing_actions_change_plan_request [PostApiBillingActionsChangePlanRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_api_billing_actions_change_plan_with_http_info(post_api_billing_actions_change_plan_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BillingApi.post_api_billing_actions_change_plan ...'
+      end
+      # verify the required parameter 'post_api_billing_actions_change_plan_request' is set
+      if @api_client.config.client_side_validation && post_api_billing_actions_change_plan_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_api_billing_actions_change_plan_request' when calling BillingApi.post_api_billing_actions_change_plan"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling BillingApi.post_api_billing_actions_change_plan, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling BillingApi.post_api_billing_actions_change_plan, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/billing/actions/change-plan'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_billing_actions_change_plan_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"BillingApi.post_api_billing_actions_change_plan",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BillingApi#post_api_billing_actions_change_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create Stripe Checkout session for a paid plan (the whole account)
+    # Returns `{ url }` of a Stripe Checkout for `planId` (`starter` | `pro` | `business` | `scale`), with the metered seat overage line of the plan when configured. The subscription is the billing account's: once confirmed, every workspace of the account moves to the plan. Only the account owner, from a dashboard session: other admins get 403 `billing_managed_by_owner` (with `managedBy`, the owner's e-mail), the members of a workspace a ticketing platform manages 403 `billing_managed_by_platform`, API keys 403. 409 `ERR_SUBSCRIPTION_EXISTS` when the account already has a live subscription (change plans in the billing portal: `POST /billing/portal-session`), 409 `test_workspace_not_billable` in a test workspace, 400 `plan_requires_sales` for `ultra` (Ultra On-Demand is arranged with the SeatsChart team), 503 `stripe_not_configured` when billing is not set up. On an Ultra On-Demand account the checkout is how the owner moves to a paid plan: the account stays on Ultra until the checkout is confirmed (`POST /billing/confirm-checkout` or the Stripe webhook); the confirmed subscription then replaces Ultra (plan, limits of the plan, agreed custom limits cleared).
     # @param post_api_billing_checkout_session_request [PostApiBillingCheckoutSessionRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -85,8 +162,8 @@ module SeatsChart
       nil
     end
 
-    # Create Stripe Checkout session for a paid plan
-    # Returns &#x60;{ url }&#x60; of a Stripe Checkout for &#x60;planId&#x60; (&#x60;starter&#x60; | &#x60;pro&#x60;). 409 &#x60;ERR_SUBSCRIPTION_EXISTS&#x60; when the workspace already has a live subscription (change plans in the billing portal: &#x60;POST /billing/portal-session&#x60;), 409 &#x60;test_workspace_not_billable&#x60; in a test workspace, 400 &#x60;plan_requires_sales&#x60; for &#x60;ultra&#x60; (Ultra On-Demand is arranged with the SeatsChart team), 409 &#x60;plan_managed_by_sales&#x60; on an Ultra On-Demand workspace,503 &#x60;stripe_not_configured&#x60; when billing is not set up.
+    # Create Stripe Checkout session for a paid plan (the whole account)
+    # Returns &#x60;{ url }&#x60; of a Stripe Checkout for &#x60;planId&#x60; (&#x60;starter&#x60; | &#x60;pro&#x60; | &#x60;business&#x60; | &#x60;scale&#x60;), with the metered seat overage line of the plan when configured. The subscription is the billing account&#39;s: once confirmed, every workspace of the account moves to the plan. Only the account owner, from a dashboard session: other admins get 403 &#x60;billing_managed_by_owner&#x60; (with &#x60;managedBy&#x60;, the owner&#39;s e-mail), the members of a workspace a ticketing platform manages 403 &#x60;billing_managed_by_platform&#x60;, API keys 403. 409 &#x60;ERR_SUBSCRIPTION_EXISTS&#x60; when the account already has a live subscription (change plans in the billing portal: &#x60;POST /billing/portal-session&#x60;), 409 &#x60;test_workspace_not_billable&#x60; in a test workspace, 400 &#x60;plan_requires_sales&#x60; for &#x60;ultra&#x60; (Ultra On-Demand is arranged with the SeatsChart team), 503 &#x60;stripe_not_configured&#x60; when billing is not set up. On an Ultra On-Demand account the checkout is how the owner moves to a paid plan: the account stays on Ultra until the checkout is confirmed (&#x60;POST /billing/confirm-checkout&#x60; or the Stripe webhook); the confirmed subscription then replaces Ultra (plan, limits of the plan, agreed custom limits cleared).
     # @param post_api_billing_checkout_session_request [PostApiBillingCheckoutSessionRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -151,7 +228,8 @@ module SeatsChart
       return data, status_code, headers
     end
 
-    # Confirm checkout session and sync plan
+    # Confirm checkout session and sync the account plan
+    # Reads the completed Stripe Checkout session of this workspace's billing account and applies its subscription to the account: every workspace of the account moves to the plan at once (audited once on the account and once on the workspace as `billing.plan_changed`). A checkout started on an Ultra On-Demand account replaces Ultra once paid; any other Stripe subscription never changes an Ultra account. Account owner only (dashboard session).
     # @param post_api_billing_confirm_checkout_request [PostApiBillingConfirmCheckoutRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -161,7 +239,8 @@ module SeatsChart
       nil
     end
 
-    # Confirm checkout session and sync plan
+    # Confirm checkout session and sync the account plan
+    # Reads the completed Stripe Checkout session of this workspace&#39;s billing account and applies its subscription to the account: every workspace of the account moves to the plan at once (audited once on the account and once on the workspace as &#x60;billing.plan_changed&#x60;). A checkout started on an Ultra On-Demand account replaces Ultra once paid; any other Stripe subscription never changes an Ultra account. Account owner only (dashboard session).
     # @param post_api_billing_confirm_checkout_request [PostApiBillingConfirmCheckoutRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -226,7 +305,8 @@ module SeatsChart
       return data, status_code, headers
     end
 
-    # Create Stripe Customer Portal session
+    # Create Stripe Customer Portal session (the account subscription)
+    # Returns `{ url }` of the Stripe billing portal of the billing account (change or cancel the subscription; the change applies to every workspace of the account). Account owner only, from a dashboard session (403 `billing_managed_by_owner` with `managedBy` for the other admins, 403 `billing_managed_by_platform` for the members of a workspace a ticketing platform manages). 409 `plan_managed_by_sales` on Ultra On-Demand (no Stripe subscription: switch plan with checkout or `POST /billing/actions/change-plan`), 409 `test_workspace_not_billable` in a test workspace.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
     # @return [nil]
@@ -235,7 +315,8 @@ module SeatsChart
       nil
     end
 
-    # Create Stripe Customer Portal session
+    # Create Stripe Customer Portal session (the account subscription)
+    # Returns &#x60;{ url }&#x60; of the Stripe billing portal of the billing account (change or cancel the subscription; the change applies to every workspace of the account). Account owner only, from a dashboard session (403 &#x60;billing_managed_by_owner&#x60; with &#x60;managedBy&#x60; for the other admins, 403 &#x60;billing_managed_by_platform&#x60; for the members of a workspace a ticketing platform manages). 409 &#x60;plan_managed_by_sales&#x60; on Ultra On-Demand (no Stripe subscription: switch plan with checkout or &#x60;POST /billing/actions/change-plan&#x60;), 409 &#x60;test_workspace_not_billable&#x60; in a test workspace.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers