# GET /v2/membershipplan/list/publish-preflight Veröffentlichungsreife eines Mitgliedschaftsplans prüfen Prüft Konfiguration, Standardsprache/weitere Kontosprachen, Steuer, Geltungsbereiche, Checkout-Design, Formular, Rechtstexte und Teilnehmerkonto-Widget. ready=false mit issues ist ein erfolgreicher Prüflauf. Die Prüfung selbst ändert keine Pläne oder Designs und benötigt canConfigure. Auf der /list-Variante muss id als Query oder filter-Auswahl vorhanden sein; andernfalls wird die gewöhnliche Planliste mit total ausgegeben. Beim Listenfallback gelten dieselben Filter und order-Felder wie bei /v2/membershipplan/list. - Operation-ID: get_v2_membershipplan_list_publish_preflight - Dokumentation: /docs/api/v2/operations/get-v2-membershipplan-list-publish-preflight-b3284d70e117/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: nein, gemäss Annotation - 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 | | --- | --- | --- | --- | | filter | query | nein | id muss einen einzelnen Plan auswählen. Ohne id-Selector wird trotz Aktionssuffix die normale Planliste ausgegeben. | | limit | query | nein | JSON-Objekt start/reply oder Zahl als reply. Standard 0/100, reply auf 1–500 begrenzt, start mindestens 0. | | language | query | nein | Gewünschte Textsprache; Fallback Kontosprache, danach vorhandene Sprache. | | id | query | nein | Plan für diese Aktion auswählen; alternativ filter-Eintrag id. | | order | query | nein | Sortierung nach updated_at, created_at, status, validity_type, sale_price, discount_value, sort_order, name oder active_customer_count; value/direction ASC/DESC. Ungültige Klauseln werden ignoriert. Standard sort_order ASC, danach stabile ID-Reihenfolge. | | 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": "filter", "in": "query", "required": false, "description": "id muss einen einzelnen Plan auswählen. Ohne id-Selector wird trotz Aktionssuffix die normale Planliste ausgegeben.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": {}, "expression": { "type": "string", "description": "Ignoriert; Auswahl über property/value." } }, "additionalProperties": true, "required": [ "property", "value" ] } }, "example": [ { "property": "id", "value": "membershipplan_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-Objekt start/reply oder Zahl als reply. Standard 0/100, reply auf 1–500 begrenzt, start mindestens 0.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 } }, "additionalProperties": true }, { "type": "integer", "minimum": 1, "maximum": 500 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "language", "in": "query", "required": false, "description": "Gewünschte Textsprache; Fallback Kontosprache, danach vorhandene Sprache.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos.", "examples": [ "membershipplan_012345abcdef_123456" ] }, "description": "Plan für diese Aktion auswählen; alternativ filter-Eintrag id." }, { "name": "order", "in": "query", "required": false, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "field": { "type": "string" }, "value": { "type": "string" }, "direction": { "type": "string" } }, "additionalProperties": true } }, "example": [ { "property": "name", "value": "ASC" } ] } }, "description": "Sortierung nach updated_at, created_at, status, validity_type, sale_price, discount_value, sort_order, name oder active_customer_count; value/direction ASC/DESC. Ungültige Klauseln werden ignoriert. Standard sort_order ASC, danach stabile ID-Reihenfolge." }, { "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 Kein Request Body deklariert. ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "data enthält bei Planauswahl das Preflight-Objekt (ready, issues, design, settings, languages). Auf /list ohne id-Auswahl stattdessen normale Planliste mit total. error=false und success=true.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "membershipplan_012345abcdef_123456", "version": 1, "ready": false, "issues": [ { "key": "design", "code": "membership_design_not_found", "severity": "error" } ], "design": { "id": null, "resolved": null, "customer": null, "form_configured": false, "legal_texts_active": false, "customer_widget_present": false, "can_add_customer_widget": false }, "settings": [], "languages": { "configured": [ "de" ], "default": "de", "missing": [], "required": [ "de" ] } } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "version": { "type": "integer" }, "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "error", "warning" ] } }, "additionalProperties": true, "required": [ "key", "code", "severity" ] } }, "design": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "resolved": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "customer": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "form_configured": { "type": "boolean" }, "legal_texts_active": { "type": "boolean" }, "customer_widget_present": { "type": "boolean" }, "can_add_customer_widget": { "type": "boolean" } }, "additionalProperties": true }, "settings": { "oneOf": [ { "type": "object", "properties": { "form": { "type": "object", "properties": { "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "template": { "type": "string" }, "widget": { "type": "string" } }, "additionalProperties": true }, "legal": { "type": "object", "properties": { "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "template": { "type": "string" }, "widget": { "type": "string" } }, "additionalProperties": true }, "customer_widget": { "type": [ "object", "null" ], "properties": { "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "template": { "type": "string" }, "widget": { "type": "string" } }, "additionalProperties": true } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ] }, "languages": { "type": "object", "properties": { "configured": { "type": "array", "items": { "type": "string" } }, "default": { "type": "string" }, "missing": { "type": "array", "items": { "type": "string" } }, "required": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } }, "additionalProperties": true, "required": [ "id", "version", "ready", "issues", "design", "settings", "languages" ] }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID." }, "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "draft", "internal", "published", "archived" ] }, "name": { "type": "string" }, "description_html": { "type": "string" }, "language": { "type": "string" }, "validity": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "fixed_range", "relative_duration", "usage_count" ] }, "from": { "type": [ "integer", "null" ] }, "until": { "type": [ "integer", "null" ] }, "value": { "type": [ "integer", "null" ] }, "unit": { "type": [ "string", "null" ] }, "uses": { "type": [ "integer", "null" ] }, "promo_code_redemption": { "type": "boolean" } }, "additionalProperties": true }, "discount": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "percent", "fixed" ] }, "value": { "type": "string", "pattern": "^-?[0-9]+\\.[0-9]{2}$", "description": "Dezimalbetrag als String mit zwei Nachkommastellen." }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "sale": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^-?[0-9]+\\.[0-9]{2}$", "description": "Dezimalbetrag als String mit zwei Nachkommastellen." }, "currency": { "type": "string" }, "vat": { "type": [ "string", "null" ], "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID." } }, "additionalProperties": true }, "publication": { "type": "object", "properties": { "design": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID." } }, "additionalProperties": true }, "renewal": { "type": "object", "properties": { "allowed": { "type": "boolean" }, "default": { "type": "boolean" }, "reminder_days": { "type": "integer" }, "duration_value": { "type": [ "integer", "null" ] }, "duration_unit": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "allow_parallel_instances": { "type": "boolean" }, "active_customer_count": { "type": "integer" }, "sort_order": { "type": "integer" }, "internal_reference": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "root", "category", "offer" ] }, "resource": { "type": [ "string", "null" ], "description": "v2 category-/offer-ID; bei root null." }, "id": { "type": "string", "description": "Eingabealias für resource." } }, "additionalProperties": true, "required": [ "type" ] } }, "published_at": { "type": [ "integer", "null" ] }, "archived_at": { "type": [ "integer", "null" ] }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } }, "additionalProperties": true, "required": [ "id", "version", "status", "name", "description_html", "language", "validity", "discount", "sale", "publication", "renewal", "allow_parallel_instances", "active_customer_count", "sort_order", "internal_reference", "scopes", "published_at", "archived_at", "created_at", "updated_at" ] } } ] }, "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. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" curl --request 'GET' \ --url "${API_ORIGIN%/}"'/v2/membershipplan/list/publish-preflight' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/membershipplan/list/publish-preflight"; 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"); const response = await fetch(url, { method: "GET", headers, 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. import os import urllib.parse import urllib.request import urllib.error path = "/v2/membershipplan/list/publish-preflight" url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] # 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="GET") 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": "get_v2_membershipplan_list_publish_preflight", "summary": "Veröffentlichungsreife eines Mitgliedschaftsplans prüfen", "description": "Prüft Konfiguration, Standardsprache/weitere Kontosprachen, Steuer, Geltungsbereiche, Checkout-Design, Formular, Rechtstexte und Teilnehmerkonto-Widget. ready=false mit issues ist ein erfolgreicher Prüflauf. Die Prüfung selbst ändert keine Pläne oder Designs und benötigt canConfigure. Auf der /list-Variante muss id als Query oder filter-Auswahl vorhanden sein; andernfalls wird die gewöhnliche Planliste mit total ausgegeben. Beim Listenfallback gelten dieselben Filter und order-Felder wie bei /v2/membershipplan/list.", "tags": [ "membershipplan" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "filter", "in": "query", "required": false, "description": "id muss einen einzelnen Plan auswählen. Ohne id-Selector wird trotz Aktionssuffix die normale Planliste ausgegeben.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": {}, "expression": { "type": "string", "description": "Ignoriert; Auswahl über property/value." } }, "additionalProperties": true, "required": [ "property", "value" ] } }, "example": [ { "property": "id", "value": "membershipplan_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-Objekt start/reply oder Zahl als reply. Standard 0/100, reply auf 1–500 begrenzt, start mindestens 0.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 } }, "additionalProperties": true }, { "type": "integer", "minimum": 1, "maximum": 500 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "language", "in": "query", "required": false, "description": "Gewünschte Textsprache; Fallback Kontosprache, danach vorhandene Sprache.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos.", "examples": [ "membershipplan_012345abcdef_123456" ] }, "description": "Plan für diese Aktion auswählen; alternativ filter-Eintrag id." }, { "name": "order", "in": "query", "required": false, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "field": { "type": "string" }, "value": { "type": "string" }, "direction": { "type": "string" } }, "additionalProperties": true } }, "example": [ { "property": "name", "value": "ASC" } ] } }, "description": "Sortierung nach updated_at, created_at, status, validity_type, sale_price, discount_value, sort_order, name oder active_customer_count; value/direction ASC/DESC. Ungültige Klauseln werden ignoriert. Standard sort_order ASC, danach stabile ID-Reihenfolge." }, { "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": "data enthält bei Planauswahl das Preflight-Objekt (ready, issues, design, settings, languages). Auf /list ohne id-Auswahl stattdessen normale Planliste mit total. error=false und success=true.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "membershipplan_012345abcdef_123456", "version": 1, "ready": false, "issues": [ { "key": "design", "code": "membership_design_not_found", "severity": "error" } ], "design": { "id": null, "resolved": null, "customer": null, "form_configured": false, "legal_texts_active": false, "customer_widget_present": false, "can_add_customer_widget": false }, "settings": [], "languages": { "configured": [ "de" ], "default": "de", "missing": [], "required": [ "de" ] } } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "version": { "type": "integer" }, "ready": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "error", "warning" ] } }, "additionalProperties": true, "required": [ "key", "code", "severity" ] } }, "design": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "resolved": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "customer": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "form_configured": { "type": "boolean" }, "legal_texts_active": { "type": "boolean" }, "customer_widget_present": { "type": "boolean" }, "can_add_customer_widget": { "type": "boolean" } }, "additionalProperties": true }, "settings": { "oneOf": [ { "type": "object", "properties": { "form": { "type": "object", "properties": { "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "template": { "type": "string" }, "widget": { "type": "string" } }, "additionalProperties": true }, "legal": { "type": "object", "properties": { "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "template": { "type": "string" }, "widget": { "type": "string" } }, "additionalProperties": true }, "customer_widget": { "type": [ "object", "null" ], "properties": { "design": { "type": "string", "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID des aktuellen Kontos." }, "template": { "type": "string" }, "widget": { "type": "string" } }, "additionalProperties": true } }, "additionalProperties": true }, { "type": "array", "maxItems": 0 } ] }, "languages": { "type": "object", "properties": { "configured": { "type": "array", "items": { "type": "string" } }, "default": { "type": "string" }, "missing": { "type": "array", "items": { "type": "string" } }, "required": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } }, "additionalProperties": true, "required": [ "id", "version", "ready", "issues", "design", "settings", "languages" ] }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID." }, "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "draft", "internal", "published", "archived" ] }, "name": { "type": "string" }, "description_html": { "type": "string" }, "language": { "type": "string" }, "validity": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "fixed_range", "relative_duration", "usage_count" ] }, "from": { "type": [ "integer", "null" ] }, "until": { "type": [ "integer", "null" ] }, "value": { "type": [ "integer", "null" ] }, "unit": { "type": [ "string", "null" ] }, "uses": { "type": [ "integer", "null" ] }, "promo_code_redemption": { "type": "boolean" } }, "additionalProperties": true }, "discount": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "percent", "fixed" ] }, "value": { "type": "string", "pattern": "^-?[0-9]+\\.[0-9]{2}$", "description": "Dezimalbetrag als String mit zwei Nachkommastellen." }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "sale": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^-?[0-9]+\\.[0-9]{2}$", "description": "Dezimalbetrag als String mit zwei Nachkommastellen." }, "currency": { "type": "string" }, "vat": { "type": [ "string", "null" ], "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID." } }, "additionalProperties": true }, "publication": { "type": "object", "properties": { "design": { "type": [ "string", "null" ], "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID." } }, "additionalProperties": true }, "renewal": { "type": "object", "properties": { "allowed": { "type": "boolean" }, "default": { "type": "boolean" }, "reminder_days": { "type": "integer" }, "duration_value": { "type": [ "integer", "null" ] }, "duration_unit": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "allow_parallel_instances": { "type": "boolean" }, "active_customer_count": { "type": "integer" }, "sort_order": { "type": "integer" }, "internal_reference": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "root", "category", "offer" ] }, "resource": { "type": [ "string", "null" ], "description": "v2 category-/offer-ID; bei root null." }, "id": { "type": "string", "description": "Eingabealias für resource." } }, "additionalProperties": true, "required": [ "type" ] } }, "published_at": { "type": [ "integer", "null" ] }, "archived_at": { "type": [ "integer", "null" ] }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } }, "additionalProperties": true, "required": [ "id", "version", "status", "name", "description_html", "language", "validity", "discount", "sale", "publication", "renewal", "allow_parallel_instances", "active_customer_count", "sort_order", "internal_reference", "scopes", "published_at", "archived_at", "created_at", "updated_at" ] } } ] }, "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": false, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-get-effect": "read", "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/01-membership.json", "notes": [] }, "x-edoobox-parameterAlternatives": [ { "query": [ "id" ], "effect": "selected action" }, { "query": [ "filter" ], "containsProperty": [ "id" ], "effect": "selected action" }, { "query": [], "effect": "ordinary collection" } ], "x-edoobox-source": { "file": "application/models/v2/Membershipplan.php", "method": "getMembershipplan", "line": 23, "branch": { "file": "application/models/v2/Membershipplan.php", "line": 33 } }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": true, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "membershipplan", "short": "mepl", "checkedByDispatcher": true, "levels": [ 1, 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." } } ```