{ "openapi": "3.0.1", "info": { "title": "Mainely Code Licensing API", "description": "Versioned public and admin API for Mainely Code licensing, entitlements, activations, billing synchronization, and support operations.", "version": "v1" }, "servers": [ { "url": "https://hiking.projectsasquatch.com/" } ], "paths": { "/": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/login": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/auth/google/start": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/health": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/healthz": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/ready": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/readyz": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/me": { "get": { "tags": [ "MainelyCode.Licensing.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/installations/register": { "post": { "tags": [ "Activations" ], "summary": "Register or refresh an installation", "description": "Creates or refreshes an installation record and captures a privacy-safe machine fingerprint hash for device troubleshooting.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterInstallationRequest" }, "example": { "customerId": "11111111-1111-1111-1111-111111111111", "productCode": "orb-weaver", "friendlyName": "Alice Workstation", "rawMachineFingerprint": "cpu=AMD;board=ABC123;volume=VOL-001", "installationKey": "", "metadataJson": "{\"channel\":\"stable\",\"os\":\"windows\"}" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterInstallationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterInstallationRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/activations": { "post": { "tags": [ "Activations" ], "summary": "Activate an entitlement", "description": "Activates a license handle for a registered installation and returns a signed entitlement document ready for client verification.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateEntitlementRequest" }, "example": { "licenseHandle": "LIC-ORBWEAVER-TRIAL", "installationKey": "INST-6A0D1E7B9C2", "rawMachineFingerprint": "cpu=AMD;board=ABC123;volume=VOL-001", "clientVersion": "orb-weaver/1.2.0" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivateEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivateEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/activations/deactivate": { "post": { "tags": [ "Activations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeactivateEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/activations/refresh": { "post": { "tags": [ "Activations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefreshEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/admin/dashboard": { "get": { "tags": [ "Administration" ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/admin/runtime": { "get": { "tags": [ "Administration" ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/admin/search": { "get": { "tags": [ "Administration" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/admin/support-cases": { "get": { "tags": [ "Administration" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/admin/offline-requests": { "get": { "tags": [ "Administration" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/admin/signing-keys": { "get": { "tags": [ "Administration" ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/admin/signing-keys/rotate": { "post": { "tags": [ "Administration" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateSigningKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RotateSigningKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RotateSigningKeyRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/audit": { "get": { "tags": [ "Audit" ], "parameters": [ { "name": "entityType", "in": "query", "schema": { "type": "string" } }, { "name": "entityId", "in": "query", "schema": { "type": "string" } }, { "name": "actor", "in": "query", "schema": { "type": "string" } }, { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "fromUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/billing/webhooks/{provider}": { "post": { "tags": [ "Billing" ], "summary": "Process a billing webhook", "description": "Verifies provider signatures, de-duplicates repeated deliveries, and synchronizes billing state without directly mutating entitlement state.", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/billing/adjustments": { "post": { "tags": [ "Billing" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualFinancialAdjustmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ManualFinancialAdjustmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ManualFinancialAdjustmentRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/billing/accounts": { "post": { "tags": [ "Billing" ], "summary": "Create or link a billing account", "description": "Links a customer to a commercial billing provider and can provision a Stripe customer record when credentials are available.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBillingAccountRequest" }, "example": { "customerId": "11111111-1111-1111-1111-111111111111", "provider": "Stripe", "currency": "USD", "providerCustomerId": "", "autoProvisionProviderCustomer": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateBillingAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateBillingAccountRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/billing/checkout-sessions": { "post": { "tags": [ "Billing" ], "summary": "Create a hosted checkout session", "description": "Creates a provider checkout handoff for a commercial plan tied to a linked billing account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCheckoutSessionRequest" }, "example": { "billingAccountId": "88888888-8888-8888-8888-888888888888", "planId": "66666666-6666-6666-6666-666666666666", "successUrl": "https://admin.mainelycode.com/customers/11111111-1111-1111-1111-111111111111?checkout=success", "cancelUrl": "https://admin.mainelycode.com/customers/11111111-1111-1111-1111-111111111111?checkout=cancel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCheckoutSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCheckoutSessionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/billing/portal-sessions": { "post": { "tags": [ "Billing" ], "summary": "Create a billing portal session", "description": "Creates a provider-managed customer portal handoff for subscription and payment-method management.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionRequest" }, "example": { "billingAccountId": "88888888-8888-8888-8888-888888888888", "returnUrl": "https://admin.mainelycode.com/customers/11111111-1111-1111-1111-111111111111" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog": { "get": { "tags": [ "Catalog" ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/products": { "post": { "tags": [ "Catalog" ], "summary": "Create a product catalog entry", "description": "Creates a staff-managed product record with explicit product-family identity, positioning, posture, and routing metadata for activation, billing, and entitlement workflows.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertProductRequest" }, "example": { "code": "orb-weaver", "name": "Orb-Weaver by Mainely Code", "shortName": "Orb-Weaver", "description": "Local-first visual UI/UX design loom that turns rough visual direction into reviewable interface foundations.", "familyRole": "The designer / UI/UX design loom.", "corePromise": "Draw the experience. Weave the interface.", "category": "Local-first visual UI/UX design-to-interface app.", "primaryCustomerJob": "Turn rough visual and UX direction into clean, editable interface foundations.", "primaryOutput": "Reviewable screen maps, flow maps, component maps, design tokens, and front-end starter artifacts.", "primaryPosture": "Local-first, visual-first, review-before-generate, lighter-model-first, approachable.", "routingSummary": "Use Orb-Weaver for UI/UX design intake, screens, flows, components, wireframes, style systems, prototypes, and interface scaffolds.", "isActive": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertProductRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/products/{productId}": { "put": { "tags": [ "Catalog" ], "summary": "Update a product catalog entry", "description": "Updates staff-managed product-family metadata used by licensing, activation, support, and Stripe-mapped catalog workflows.", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertProductRequest" }, "example": { "code": "project-sasquatch", "name": "Mainely Code AI — Project Sasquatch", "shortName": "Project Sasquatch", "description": "Cloud-based Mainely Code AI command-center platform for broad-spectrum generative capability and orchestration.", "familyRole": "The broad-spectrum generative AI system.", "corePromise": "Frontier generative AI for broad capability work.", "category": "Cloud-based Mainely Code AI platform.", "primaryCustomerJob": "Provide broad-spectrum generative capability across planning, reasoning, writing, research support, operations support, and creative work.", "primaryOutput": "Cloud-served conversations, generation, routing, synthesis, command-center experiences, and capability surfaces beyond UI/UX or coding alone.", "primaryPosture": "Cloud-based, frontier-capability-oriented, broad-spectrum, product-family aware.", "routingSummary": "Use Project Sasquatch for broad generative AI capability, multimodal help, command-center experiences, cloud routing, and cross-product intelligence.", "isActive": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertProductRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/products/{productId}/versions": { "post": { "tags": [ "Catalog" ], "summary": "Create a product version", "description": "Adds or updates staff-managed product version metadata, including the minimum supported release used by entitlement and support workflows.", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductVersionRequest" }, "example": { "versionLabel": "1.2.0", "isMinimumSupported": true, "releaseNotes": "Stabilizes activation refresh and adds offline challenge hardening." } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductVersionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductVersionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/products/{productId}/versions/{productVersionId}": { "put": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductVersionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductVersionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductVersionRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/plans": { "post": { "tags": [ "Catalog" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertPlanRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/plans/{planId}": { "put": { "tags": [ "Catalog" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertPlanRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/features": { "post": { "tags": [ "Catalog" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertFeatureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertFeatureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertFeatureRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/catalog/features/{featureId}": { "put": { "tags": [ "Catalog" ], "parameters": [ { "name": "featureId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertFeatureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertFeatureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertFeatureRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/organizations": { "post": { "tags": [ "Customers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/customers": { "get": { "tags": [ "Customers" ], "parameters": [ { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Customers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/customers/{customerId}": { "get": { "tags": [ "Customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/customers/{customerId}/notes": { "post": { "tags": [ "Customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSupportNoteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddSupportNoteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddSupportNoteRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/entitlements": { "post": { "tags": [ "Entitlements" ], "summary": "Issue an entitlement", "description": "Issues a purchase, trial, complimentary, gift, or support-adjusted entitlement while preserving provider-agnostic core state.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueEntitlementRequest" }, "example": { "customerId": "11111111-1111-1111-1111-111111111111", "organizationId": "44444444-4444-4444-4444-444444444444", "productId": "55555555-5555-5555-5555-555555555555", "planId": "66666666-6666-6666-6666-666666666666", "sourceOfEntitlement": "complimentary", "reasonCode": "SupportCourtesy", "seatLimit": 5, "activationLimit": 5, "activationPolicy": "named-devices", "validFromUtc": "2026-06-15T00:00:00Z", "validToUtc": "2027-06-15T00:00:00Z", "graceUntilUtc": "2027-06-22T00:00:00Z", "appVersionConstraint": ">=1.0.0", "featureClaims": [ { "featureCode": "thread-map", "value": "true" } ], "notes": "Issued for launch-partner onboarding." } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/entitlements/gifts": { "post": { "tags": [ "Entitlements" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GiftEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GiftEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GiftEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/entitlements/{entitlementId}/suspend": { "post": { "tags": [ "Entitlements" ], "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuspendEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SuspendEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SuspendEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/entitlements/{entitlementId}/reinstate": { "post": { "tags": [ "Entitlements" ], "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReinstateEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReinstateEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReinstateEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/entitlements/{entitlementId}/revoke": { "post": { "tags": [ "Entitlements" ], "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeEntitlementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeEntitlementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeEntitlementRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/entitlements/{entitlementId}/extend-grace": { "post": { "tags": [ "Entitlements" ], "parameters": [ { "name": "entitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendGracePeriodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtendGracePeriodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExtendGracePeriodRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/offline/challenges": { "post": { "tags": [ "OfflineLicensing" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfflineChallengeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OfflineChallengeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OfflineChallengeRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/offline/requests/{offlineRequestId}/issue": { "post": { "tags": [ "OfflineLicensing" ], "parameters": [ { "name": "offlineRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/service-access/users/resolve": { "post": { "tags": [ "ServiceAccess" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccessResolveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceAccessResolveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceAccessResolveRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccessResolveResponse" } } } } } } }, "/api/v1/service-access/owner-licenses/ensure": { "post": { "tags": [ "ServiceAccess" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnsureOwnerLicenseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnsureOwnerLicenseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnsureOwnerLicenseRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnsureOwnerLicenseResponse" } } } } } } }, "/api/v1/support-cases": { "post": { "tags": [ "SupportCases" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSupportCaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSupportCaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSupportCaseRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/support-cases/{supportCaseId}": { "put": { "tags": [ "SupportCases" ], "parameters": [ { "name": "supportCaseId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSupportCaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSupportCaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSupportCaseRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "ActivateEntitlementRequest": { "required": [ "licenseHandle", "installationKey", "rawMachineFingerprint", "clientVersion" ], "type": "object", "properties": { "licenseHandle": { "type": "string" }, "installationKey": { "type": "string" }, "rawMachineFingerprint": { "type": "string" }, "clientVersion": { "type": "string" } } }, "AddSupportNoteRequest": { "required": [ "supportCaseId", "noteType", "body", "isInternal" ], "type": "object", "properties": { "supportCaseId": { "type": "string", "format": "uuid", "nullable": true }, "noteType": { "type": "string" }, "body": { "type": "string" }, "isInternal": { "type": "boolean" } } }, "CreateBillingAccountRequest": { "required": [ "customerId", "provider", "currency", "providerCustomerId", "autoProvisionProviderCustomer" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "provider": { "type": "string" }, "currency": { "type": "string" }, "providerCustomerId": { "type": "string", "nullable": true }, "autoProvisionProviderCustomer": { "type": "boolean" } } }, "CreateCheckoutSessionRequest": { "required": [ "billingAccountId", "planId", "successUrl", "cancelUrl" ], "type": "object", "properties": { "billingAccountId": { "type": "string", "format": "uuid" }, "planId": { "type": "string", "format": "uuid" }, "successUrl": { "type": "string" }, "cancelUrl": { "type": "string" } } }, "CreateCustomerRequest": { "required": [ "email", "fullName", "phoneNumber", "organizationId", "externalReference" ], "type": "object", "properties": { "email": { "type": "string" }, "fullName": { "type": "string" }, "phoneNumber": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "externalReference": { "type": "string", "nullable": true } } }, "CreateOrganizationRequest": { "required": [ "name", "externalReference", "billingEmail", "countryCode" ], "type": "object", "properties": { "name": { "type": "string" }, "externalReference": { "type": "string" }, "billingEmail": { "type": "string" }, "countryCode": { "type": "string" } } }, "CreatePortalSessionRequest": { "required": [ "billingAccountId", "returnUrl" ], "type": "object", "properties": { "billingAccountId": { "type": "string", "format": "uuid" }, "returnUrl": { "type": "string" } } }, "CreateSupportCaseRequest": { "required": [ "customerId", "organizationId", "subject", "summary", "priority" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "subject": { "type": "string" }, "summary": { "type": "string" }, "priority": { "type": "string" } } }, "DeactivateEntitlementRequest": { "required": [ "activationCode", "reasonCode", "notes" ], "type": "object", "properties": { "activationCode": { "type": "string" }, "reasonCode": { "type": "string" }, "notes": { "type": "string" } } }, "EnsureOwnerLicenseRequest": { "required": [ "email", "fullName", "organizationExternalReference" ], "type": "object", "properties": { "email": { "type": "string" }, "fullName": { "type": "string" }, "organizationExternalReference": { "type": "string", "nullable": true } } }, "EnsureOwnerLicenseResponse": { "required": [ "runtimeLabel", "licensed", "tier", "seatRole", "authorizedApps", "customer", "entitlement" ], "type": "object", "properties": { "runtimeLabel": { "type": "string" }, "licensed": { "type": "boolean" }, "tier": { "type": "string" }, "seatRole": { "type": "string" }, "authorizedApps": { "type": "array", "items": { "type": "string" } }, "customer": { "$ref": "#/components/schemas/ServiceAccessCustomerResponse2" }, "entitlement": { "$ref": "#/components/schemas/ServiceAccessEntitlementResponse" } } }, "EntitlementClaim": { "required": [ "featureCode", "value" ], "type": "object", "properties": { "featureCode": { "type": "string" }, "value": { "type": "string" } } }, "ExtendGracePeriodRequest": { "required": [ "graceUntilUtc", "reasonCode", "notes" ], "type": "object", "properties": { "graceUntilUtc": { "type": "string", "format": "date-time" }, "reasonCode": { "type": "string" }, "notes": { "type": "string" } } }, "GiftEntitlementRequest": { "required": [ "customerId", "organizationId", "productId", "planId", "reasonCode", "seatLimit", "activationLimit", "activationPolicy", "validFromUtc", "validToUtc", "graceUntilUtc", "appVersionConstraint", "featureClaims", "giftRecipientEmail", "notes" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "productId": { "type": "string", "format": "uuid" }, "planId": { "type": "string", "format": "uuid" }, "reasonCode": { "type": "string" }, "seatLimit": { "type": "integer", "format": "int32", "nullable": true }, "activationLimit": { "type": "integer", "format": "int32", "nullable": true }, "activationPolicy": { "type": "string" }, "validFromUtc": { "type": "string", "format": "date-time" }, "validToUtc": { "type": "string", "format": "date-time", "nullable": true }, "graceUntilUtc": { "type": "string", "format": "date-time", "nullable": true }, "appVersionConstraint": { "type": "string" }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementClaim" } }, "giftRecipientEmail": { "type": "string" }, "notes": { "type": "string" } } }, "IssueEntitlementRequest": { "required": [ "customerId", "organizationId", "productId", "planId", "sourceOfEntitlement", "reasonCode", "seatLimit", "activationLimit", "activationPolicy", "validFromUtc", "validToUtc", "graceUntilUtc", "appVersionConstraint", "featureClaims", "notes" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "productId": { "type": "string", "format": "uuid" }, "planId": { "type": "string", "format": "uuid" }, "sourceOfEntitlement": { "type": "string" }, "reasonCode": { "type": "string" }, "seatLimit": { "type": "integer", "format": "int32", "nullable": true }, "activationLimit": { "type": "integer", "format": "int32", "nullable": true }, "activationPolicy": { "type": "string" }, "validFromUtc": { "type": "string", "format": "date-time" }, "validToUtc": { "type": "string", "format": "date-time", "nullable": true }, "graceUntilUtc": { "type": "string", "format": "date-time", "nullable": true }, "appVersionConstraint": { "type": "string" }, "featureClaims": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementClaim" } }, "notes": { "type": "string" } } }, "ManualFinancialAdjustmentRequest": { "required": [ "billingAccountId", "invoiceId", "action", "amount", "currency", "reasonCode", "notes" ], "type": "object", "properties": { "billingAccountId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid", "nullable": true }, "action": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "reasonCode": { "type": "string" }, "notes": { "type": "string" } } }, "OfflineChallengeRequest": { "required": [ "licenseHandle", "installationKey", "rawMachineFingerprint", "challengePayloadJson", "expiresUtc" ], "type": "object", "properties": { "licenseHandle": { "type": "string" }, "installationKey": { "type": "string" }, "rawMachineFingerprint": { "type": "string" }, "challengePayloadJson": { "type": "string" }, "expiresUtc": { "type": "string", "format": "date-time", "nullable": true } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "ProductVersionRequest": { "required": [ "versionLabel", "isMinimumSupported", "releaseNotes" ], "type": "object", "properties": { "versionLabel": { "type": "string" }, "isMinimumSupported": { "type": "boolean" }, "releaseNotes": { "type": "string" } } }, "RefreshEntitlementRequest": { "required": [ "activationCode", "rawMachineFingerprint", "clientVersion" ], "type": "object", "properties": { "activationCode": { "type": "string" }, "rawMachineFingerprint": { "type": "string" }, "clientVersion": { "type": "string" } } }, "RegisterInstallationRequest": { "required": [ "customerId", "productCode", "friendlyName", "rawMachineFingerprint", "installationKey", "metadataJson" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "productCode": { "type": "string" }, "friendlyName": { "type": "string" }, "rawMachineFingerprint": { "type": "string" }, "installationKey": { "type": "string", "nullable": true }, "metadataJson": { "type": "string", "nullable": true } } }, "ReinstateEntitlementRequest": { "required": [ "reasonCode", "notes" ], "type": "object", "properties": { "reasonCode": { "type": "string" }, "notes": { "type": "string" } } }, "RevokeEntitlementRequest": { "required": [ "reasonCode", "notes" ], "type": "object", "properties": { "reasonCode": { "type": "string" }, "notes": { "type": "string" } } }, "RotateSigningKeyRequest": { "required": [ "generateLocalDevelopmentKey", "retirePriorKeyAfterUtc" ], "type": "object", "properties": { "generateLocalDevelopmentKey": { "type": "boolean" }, "retirePriorKeyAfterUtc": { "type": "string", "format": "date-time", "nullable": true } } }, "ServiceAccessCustomerResponse": { "required": [ "id", "customerNumber", "email", "fullName", "isActive" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerNumber": { "type": "string" }, "email": { "type": "string" }, "fullName": { "type": "string" }, "isActive": { "type": "boolean" } }, "nullable": true }, "ServiceAccessCustomerResponse2": { "required": [ "id", "customerNumber", "email", "fullName", "isActive" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerNumber": { "type": "string" }, "email": { "type": "string" }, "fullName": { "type": "string" }, "isActive": { "type": "boolean" } } }, "ServiceAccessEntitlementResponse": { "required": [ "id", "entitlementNumber", "productCode", "planCode", "status", "licenseHandle", "validFromUtc", "validToUtc", "graceUntilUtc", "featureClaims" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entitlementNumber": { "type": "string" }, "productCode": { "type": "string" }, "planCode": { "type": "string" }, "status": { "type": "string" }, "licenseHandle": { "type": "string" }, "validFromUtc": { "type": "string", "format": "date-time" }, "validToUtc": { "type": "string", "format": "date-time", "nullable": true }, "graceUntilUtc": { "type": "string", "format": "date-time", "nullable": true }, "featureClaims": { "type": "array", "items": { } } } }, "ServiceAccessResolveRequest": { "required": [ "email", "requestedAppId", "userId", "displayName" ], "type": "object", "properties": { "email": { "type": "string" }, "requestedAppId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } } }, "ServiceAccessResolveResponse": { "required": [ "runtimeLabel", "licensed", "status", "tier", "seatRole", "licensedEmail", "authorizedApps", "claims", "customer", "entitlements" ], "type": "object", "properties": { "runtimeLabel": { "type": "string" }, "licensed": { "type": "boolean" }, "status": { "type": "string" }, "tier": { "type": "string", "nullable": true }, "seatRole": { "type": "string" }, "licensedEmail": { "type": "string", "nullable": true }, "authorizedApps": { "type": "array", "items": { "type": "string" } }, "claims": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementClaim" } }, "customer": { "$ref": "#/components/schemas/ServiceAccessCustomerResponse" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceAccessEntitlementResponse" } } } }, "SuspendEntitlementRequest": { "required": [ "reasonCode", "notes" ], "type": "object", "properties": { "reasonCode": { "type": "string" }, "notes": { "type": "string" } } }, "UpdateCustomerRequest": { "required": [ "email", "fullName", "phoneNumber", "organizationId", "externalReference", "isActive" ], "type": "object", "properties": { "email": { "type": "string" }, "fullName": { "type": "string" }, "phoneNumber": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "externalReference": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } } }, "UpdateSupportCaseRequest": { "required": [ "status", "summary", "priority", "assignedToUserId" ], "type": "object", "properties": { "status": { "type": "string" }, "summary": { "type": "string" }, "priority": { "type": "string" }, "assignedToUserId": { "type": "string", "format": "uuid", "nullable": true } } }, "UpsertFeatureRequest": { "required": [ "code", "name", "description", "claimValue", "isActive", "planIds" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "claimValue": { "type": "string" }, "isActive": { "type": "boolean" }, "planIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "UpsertPlanRequest": { "required": [ "productId", "code", "name", "billingCadence", "seatLimit", "trialDays", "graceDays", "priceAmount", "currency", "billingPriceReference", "appVersionConstraint", "isActive" ], "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "name": { "type": "string" }, "billingCadence": { "type": "string" }, "seatLimit": { "type": "integer", "format": "int32" }, "trialDays": { "type": "integer", "format": "int32" }, "graceDays": { "type": "integer", "format": "int32" }, "priceAmount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "billingPriceReference": { "type": "string" }, "appVersionConstraint": { "type": "string" }, "isActive": { "type": "boolean" } } }, "UpsertProductRequest": { "required": [ "code", "name", "shortName", "description", "familyRole", "corePromise", "category", "primaryCustomerJob", "primaryOutput", "primaryPosture", "routingSummary", "isActive" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "description": { "type": "string" }, "familyRole": { "type": "string" }, "corePromise": { "type": "string" }, "category": { "type": "string" }, "primaryCustomerJob": { "type": "string" }, "primaryOutput": { "type": "string" }, "primaryPosture": { "type": "string" }, "routingSummary": { "type": "string" }, "isActive": { "type": "boolean" } } } } }, "tags": [ { "name": "MainelyCode.Licensing.Api" }, { "name": "Activations" }, { "name": "Administration" }, { "name": "Audit" }, { "name": "Billing" }, { "name": "Catalog" }, { "name": "Customers" }, { "name": "Entitlements" }, { "name": "OfflineLicensing" }, { "name": "ServiceAccess" }, { "name": "SupportCases" } ] }