# PUT /v2/plugin/{id}/deactivate Plugin kündigen oder deaktivieren Beendet das Plugin sofort oder merkt die Deaktivierung nach laufenden Verträgen/Mitgliedschaften vor. schedule=true erlaubt die spätere Deaktivierung; monatliche Verträge werden bis zum Periodenende vorgemerkt. Aktive Preisbedingungen können blockieren. Vorgemerkte Kündigung bzw. Testkündigung deaktiviert automatische Mitgliedschaftsverlängerungen. reason und request_id sind optionale Auditangaben. - Operation-ID: put_v2_plugin_id_deactivate - Dokumentation: /docs/api/v2/operations/put-v2-plugin-id-deactivate-396fda63c311/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: ja - Für Automation freigegeben: nein ## Server Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden. ```json [ { "url": "https://app2.edoobox.com", "description": "edoobox API" } ] ``` ## Authentifizierung Eine der folgenden Alternativen genügt (ODER). Innerhalb einer Alternative müssen alle Verfahren gemeinsam erfüllt sein (UND). 1. **bearerAuth** (HTTP bearer) — Existing edoobox v2 access token. Never substitute API key/secret headers. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. 2. **sessionCookie** (cookie: _edlogin) — Existing browser login session, with the same permission checks as Bearer authentication. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. ### Wirksame Security Requirements und vollständige Verfahren ```json { "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Existing edoobox v2 access token. Never substitute API key/secret headers." }, "accountContext": { "type": "apiKey", "in": "header", "name": "edid", "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account." }, "sessionCookie": { "type": "apiKey", "in": "cookie", "name": "_edlogin", "description": "Existing browser login session, with the same permission checks as Bearer authentication." } } } ``` ## Parameter | Name | Ort | Pflicht | Beschreibung | | --- | --- | --- | --- | | language | header | nein | Account language code, where the resource supports setLanguage(). | | id | path | ja | Plugin-Katalogschlüssel. | | X-Edoobox-If-Revision | header | nein | Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review. | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID.", "x-edoobox-id-kind": "plugin-key" }, "description": "Plugin-Katalogschlüssel." }, { "name": "X-Edoobox-If-Revision", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "examples": [ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] }, "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review." } ] ``` ## Anfrage ```json { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schedule": { "type": [ "boolean", "number", "string", "null" ], "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false." }, "reason": { "type": "string" }, "request_id": { "type": "string" } }, "additionalProperties": true }, "id": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID." } }, "additionalProperties": true }, "examples": { "request": { "summary": "Plugin kündigen oder deaktivieren", "value": { "data": { "schedule": true, "reason": "Zum Periodenende beenden" } } } } } } } ``` ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "Aktualisierter Katalogeintrag mit preflight; status kann deactivation_pending sein.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "memberships", "key": "memberships", "status": "inactive", "trial": { "days": 14, "available": true, "active": false, "used": false, "started_at": 0, "ends_at": 0, "ended_at": 0 }, "billing": { "model": "monthly", "free": false, "amount": "20.00", "currency": "CHF", "setup_amount": "0.00", "setup_free": true, "minimum_term_months": 1 }, "activation": { "resumes_subscription": false, "billing": { "model": "monthly", "free": false, "amount": "20.00", "currency": "CHF", "setup_amount": "0.00", "setup_free": true, "minimum_term_months": 1, "trial_days": 14 }, "quote": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "manufacturer": "edoobox", "image_url": "", "name_text_code": "N12345", "description_text_code": "N12346", "feature_text_codes": [], "capabilities": { "plugin_key": "memberships", "status": "inactive", "version": 0, "isVisible": false, "canConfigure": false, "canPurchase": false, "canRedeem": false, "canRunRenewal": false }, "catalog_capabilities": {}, "subscription": { "billing": null, "current_period_start": 0, "current_period_end": 0, "next_billing_at": 0, "cancel_requested_at": 0, "cancel_at_period_end": false, "deactivate_at": 0, "setup_billed_at": 0 }, "actions": { "activate": true, "deactivate": false, "cancel_deactivation": false }, "preflight": { "published_plans": 0, "blocking_memberships": 0, "usage_passes_without_end": 0, "pending_payments": 0, "open_payment_periods": 0, "active_auto_renewals": 0, "active_pricecategory_conditions": 0, "last_valid_until": 0, "can_deactivate_now": true } } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID." }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID." }, "status": { "type": "string" }, "trial": { "type": "object", "properties": { "days": { "type": "integer" }, "started_at": { "type": "integer" }, "ends_at": { "type": "integer" }, "ended_at": { "type": "integer" }, "available": { "type": "boolean" }, "active": { "type": "boolean" }, "used": { "type": "boolean" } }, "additionalProperties": true }, "billing": { "type": "object", "properties": { "model": { "type": "string" }, "free": { "type": "boolean" }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "setup_amount": { "type": "string" }, "setup_free": { "type": "boolean" }, "minimum_term_months": { "type": "integer" }, "trial_days": { "type": "integer" } }, "additionalProperties": true }, "activation": { "type": "object", "properties": { "resumes_subscription": { "type": "boolean" }, "billing": { "type": "object", "properties": { "model": { "type": "string" }, "free": { "type": "boolean" }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "setup_amount": { "type": "string" }, "setup_free": { "type": "boolean" }, "minimum_term_months": { "type": "integer" }, "trial_days": { "type": "integer" } }, "additionalProperties": true }, "quote": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "additionalProperties": true }, "manufacturer": { "type": "string" }, "image_url": { "type": "string" }, "name_text_code": { "type": "string" }, "description_text_code": { "type": "string" }, "feature_text_codes": { "type": "array", "items": { "type": "string" } }, "capabilities": { "type": "object", "properties": { "plugin_key": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "integer" }, "isVisible": { "type": "boolean" }, "canConfigure": { "type": "boolean" }, "canPurchase": { "type": "boolean" }, "canRedeem": { "type": "boolean" }, "canRunRenewal": { "type": "boolean" } }, "additionalProperties": true }, "catalog_capabilities": { "type": "object", "properties": {}, "additionalProperties": true }, "subscription": { "type": "object", "properties": { "billing": { "anyOf": [ { "type": "object", "properties": { "model": { "type": "string" }, "free": { "type": "boolean" }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "setup_amount": { "type": "string" }, "setup_free": { "type": "boolean" }, "minimum_term_months": { "type": "integer" }, "trial_days": { "type": "integer" } }, "additionalProperties": true }, { "type": "null" } ] }, "current_period_start": { "type": "integer" }, "current_period_end": { "type": "integer" }, "next_billing_at": { "type": "integer" }, "cancel_requested_at": { "type": "integer" }, "deactivate_at": { "type": "integer" }, "setup_billed_at": { "type": "integer" }, "cancel_at_period_end": { "type": "boolean" } }, "additionalProperties": true }, "actions": { "type": "object", "properties": { "activate": { "type": "boolean" }, "deactivate": { "type": "boolean" }, "cancel_deactivation": { "type": "boolean" } }, "additionalProperties": true }, "preflight": { "type": "object", "properties": { "published_plans": { "type": "integer" }, "blocking_memberships": { "type": "integer" }, "usage_passes_without_end": { "type": "integer" }, "pending_payments": { "type": "integer" }, "open_payment_periods": { "type": "integer" }, "active_auto_renewals": { "type": "integer" }, "active_pricecategory_conditions": { "type": "integer" }, "last_valid_until": { "type": "integer" }, "can_deactivate_now": { "type": "boolean" } }, "additionalProperties": true } }, "additionalProperties": true }, "type": { "type": "string" } }, "additionalProperties": true } } }, "headers": { "X-Edoobox-Revision": { "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "description": "Rotated account revision supplied for the next action in one reviewed sequence." } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "409": { "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED40901", "error_code": "mutation_revision_conflict" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } }, "503": { "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.", "headers": { "Retry-After": { "schema": { "type": "integer", "const": 1 } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED50301", "error_code": "mutation_revision_busy" } } } } } ``` ## Aufrufbeispiele Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder. ### cURL ```sh # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. # cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" : "${PATH_ID:?PATH_ID setzen}" cat > payload.json <<'EDOOBOX_JSON_EXAMPLE' { "data": { "schedule": true, "reason": "Zum Periodenende beenden" } } EDOOBOX_JSON_EXAMPLE curl --request 'PUT' \ --url "${API_ORIGIN%/}"'/v2/plugin/'"${PATH_ID}"'/deactivate' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \ --header 'Content-Type: application/json' \ --data-binary '@payload.json' ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. // Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/plugin/{id}/deactivate"; path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID"))); const origin = required('API_ORIGIN'); const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path); const headers = {}; headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH"); headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT"); headers['Content-Type'] = "application/json"; const body = JSON.stringify({ "data": { "schedule": true, "reason": "Zum Periodenende beenden" } }); const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' }); const text = await response.text(); console.log(response.status, text); // HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ### Python ```python # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. import os import urllib.parse import urllib.request import urllib.error path = "/v2/plugin/{id}/deactivate" path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe="")) url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] headers["Content-Type"] = "application/json" body = "{\"data\":{\"schedule\":true,\"reason\":\"Zum Periodenende beenden\"}}".encode("utf-8") # Redirects nicht automatisch verfolgen. class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return None request = urllib.request.Request(url, headers=headers, method="PUT", data=body) try: response = urllib.request.build_opener(NoRedirect).open(request, timeout=30) except urllib.error.HTTPError as error: response = error print(response.status, response.read().decode("utf-8", errors="replace")) # HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ## Vollständige Operationsdefinition und edoobox-Hinweise Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag. ```json { "operationId": "put_v2_plugin_id_deactivate", "summary": "Plugin kündigen oder deaktivieren", "description": "Beendet das Plugin sofort oder merkt die Deaktivierung nach laufenden Verträgen/Mitgliedschaften vor. schedule=true erlaubt die spätere Deaktivierung; monatliche Verträge werden bis zum Periodenende vorgemerkt. Aktive Preisbedingungen können blockieren. Vorgemerkte Kündigung bzw. Testkündigung deaktiviert automatische Mitgliedschaftsverlängerungen. reason und request_id sind optionale Auditangaben.", "tags": [ "plugin" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID.", "x-edoobox-id-kind": "plugin-key" }, "description": "Plugin-Katalogschlüssel." }, { "name": "X-Edoobox-If-Revision", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "examples": [ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] }, "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review." } ], "responses": { "200": { "description": "Aktualisierter Katalogeintrag mit preflight; status kann deactivation_pending sein.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "memberships", "key": "memberships", "status": "inactive", "trial": { "days": 14, "available": true, "active": false, "used": false, "started_at": 0, "ends_at": 0, "ended_at": 0 }, "billing": { "model": "monthly", "free": false, "amount": "20.00", "currency": "CHF", "setup_amount": "0.00", "setup_free": true, "minimum_term_months": 1 }, "activation": { "resumes_subscription": false, "billing": { "model": "monthly", "free": false, "amount": "20.00", "currency": "CHF", "setup_amount": "0.00", "setup_free": true, "minimum_term_months": 1, "trial_days": 14 }, "quote": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "manufacturer": "edoobox", "image_url": "", "name_text_code": "N12345", "description_text_code": "N12346", "feature_text_codes": [], "capabilities": { "plugin_key": "memberships", "status": "inactive", "version": 0, "isVisible": false, "canConfigure": false, "canPurchase": false, "canRedeem": false, "canRunRenewal": false }, "catalog_capabilities": {}, "subscription": { "billing": null, "current_period_start": 0, "current_period_end": 0, "next_billing_at": 0, "cancel_requested_at": 0, "cancel_at_period_end": false, "deactivate_at": 0, "setup_billed_at": 0 }, "actions": { "activate": true, "deactivate": false, "cancel_deactivation": false }, "preflight": { "published_plans": 0, "blocking_memberships": 0, "usage_passes_without_end": 0, "pending_payments": 0, "open_payment_periods": 0, "active_auto_renewals": 0, "active_pricecategory_conditions": 0, "last_valid_until": 0, "can_deactivate_now": true } } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID." }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID." }, "status": { "type": "string" }, "trial": { "type": "object", "properties": { "days": { "type": "integer" }, "started_at": { "type": "integer" }, "ends_at": { "type": "integer" }, "ended_at": { "type": "integer" }, "available": { "type": "boolean" }, "active": { "type": "boolean" }, "used": { "type": "boolean" } }, "additionalProperties": true }, "billing": { "type": "object", "properties": { "model": { "type": "string" }, "free": { "type": "boolean" }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "setup_amount": { "type": "string" }, "setup_free": { "type": "boolean" }, "minimum_term_months": { "type": "integer" }, "trial_days": { "type": "integer" } }, "additionalProperties": true }, "activation": { "type": "object", "properties": { "resumes_subscription": { "type": "boolean" }, "billing": { "type": "object", "properties": { "model": { "type": "string" }, "free": { "type": "boolean" }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "setup_amount": { "type": "string" }, "setup_free": { "type": "boolean" }, "minimum_term_months": { "type": "integer" }, "trial_days": { "type": "integer" } }, "additionalProperties": true }, "quote": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "additionalProperties": true }, "manufacturer": { "type": "string" }, "image_url": { "type": "string" }, "name_text_code": { "type": "string" }, "description_text_code": { "type": "string" }, "feature_text_codes": { "type": "array", "items": { "type": "string" } }, "capabilities": { "type": "object", "properties": { "plugin_key": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "integer" }, "isVisible": { "type": "boolean" }, "canConfigure": { "type": "boolean" }, "canPurchase": { "type": "boolean" }, "canRedeem": { "type": "boolean" }, "canRunRenewal": { "type": "boolean" } }, "additionalProperties": true }, "catalog_capabilities": { "type": "object", "properties": {}, "additionalProperties": true }, "subscription": { "type": "object", "properties": { "billing": { "anyOf": [ { "type": "object", "properties": { "model": { "type": "string" }, "free": { "type": "boolean" }, "amount": { "type": [ "string", "null" ] }, "currency": { "type": "string" }, "setup_amount": { "type": "string" }, "setup_free": { "type": "boolean" }, "minimum_term_months": { "type": "integer" }, "trial_days": { "type": "integer" } }, "additionalProperties": true }, { "type": "null" } ] }, "current_period_start": { "type": "integer" }, "current_period_end": { "type": "integer" }, "next_billing_at": { "type": "integer" }, "cancel_requested_at": { "type": "integer" }, "deactivate_at": { "type": "integer" }, "setup_billed_at": { "type": "integer" }, "cancel_at_period_end": { "type": "boolean" } }, "additionalProperties": true }, "actions": { "type": "object", "properties": { "activate": { "type": "boolean" }, "deactivate": { "type": "boolean" }, "cancel_deactivation": { "type": "boolean" } }, "additionalProperties": true }, "preflight": { "type": "object", "properties": { "published_plans": { "type": "integer" }, "blocking_memberships": { "type": "integer" }, "usage_passes_without_end": { "type": "integer" }, "pending_payments": { "type": "integer" }, "open_payment_periods": { "type": "integer" }, "active_auto_renewals": { "type": "integer" }, "active_pricecategory_conditions": { "type": "integer" }, "last_valid_until": { "type": "integer" }, "can_deactivate_now": { "type": "boolean" } }, "additionalProperties": true } }, "additionalProperties": true }, "type": { "type": "string" } }, "additionalProperties": true } } }, "headers": { "X-Edoobox-Revision": { "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "description": "Rotated account revision supplied for the next action in one reviewed sequence." } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "409": { "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED40901", "error_code": "mutation_revision_conflict" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } }, "503": { "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.", "headers": { "Retry-After": { "schema": { "type": "integer", "const": 1 } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED50301", "error_code": "mutation_revision_busy" } } } } }, "x-edoobox-mutates-state": true, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schedule": { "type": [ "boolean", "number", "string", "null" ], "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false." }, "reason": { "type": "string" }, "request_id": { "type": "string" } }, "additionalProperties": true }, "id": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{1,63}$", "examples": [ "memberships" ], "description": "Plugin-Katalogschlüssel, keine kodierte DB-ID." } }, "additionalProperties": true }, "examples": { "request": { "summary": "Plugin kündigen oder deaktivieren", "value": { "data": { "schedule": true, "reason": "Zum Periodenende beenden" } } } } } } }, "x-edoobox-routeAliasEvidence": { "file": "application/models/v2/Plugin.php", "line": 79, "reason": "Plugin::resourceIdentity107–124 consumes the symbolic public plugin_key with this exact regex; PluginCatalogService::catalog64–65 exposes that same key as public id/key.", "relatedSources": [ { "file": "application/libraries/edoobox/Membership/PluginCatalogService.php", "line": 64, "reason": "Public id/key are the plugin_key, not an internal edoobox_plugin_id." } ] }, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/08-subscriptions.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Plugin.php", "method": "updatePlugin", "line": 46, "branch": { "file": "application/models/v2/Plugin.php", "line": 79 } }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "plugin", "short": "plug", "checkedByDispatcher": true, "levels": [ 3, 4 ], "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope." } } ```