pluginAPI-Referenz
GET
/v2/plugin/{id}/preflightPlugin-Deaktivierung prüfen
Liest Katalogangebot, Vertragsstand, Testphase, Fähigkeiten und aktuelle activation.quote. Ein id-Filter bzw. Pfadschlüssel wählt ein Plugin; ohne Selektor wird die Katalogliste geliefert. preflight ergänzt beim gewählten Plugin die blockierenden Mitgliedschaften, Zahlungsperioden, Verlängerungen und Preisbedingungen. Ohne Selektor liefert auch diese Route nur die Liste. Alternativ zum id-Filter wird ein direkter Query-Parameter id unterstützt.
Operation-ID get_v2_plugin_id_preflight
01
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Nein
- Als readOnly markiert
- Ja
- Für Automation markiert
- Ja
GET-Verhalten laut Spezifikation
read
02
Authentifizierung
Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).
Alternative 1
bearerAuthhttp · bearerExisting edoobox v2 access token. Never substitute API key/secret headers.
Format: JWT
Security-Schema als JSON
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"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."
}Alternative 2
sessionCookieapiKeyExisting browser login session, with the same permission checks as Bearer authentication.
cookie: _edlogin
Security-Schema als JSON
{
"type": "apiKey",
"in": "cookie",
"name": "_edlogin",
"description": "Existing browser login session, with the same permission checks as Bearer authentication."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"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."
}03
Parameter
Query-Parameter
filteroptionalJSON-kodierte Filterliste. Diese Ressource wertet nur die genannten Eigenschaften aus.
application/json
array
Array-Elemente
object
property string erforderlich Erlaubte Werte
"id"expression string Hier wird Gleichheit verwendet; expression wird ignoriert.
value Typ nicht eingeschränkt erforderlich Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"enum": [
"id"
]
},
"expression": {
"type": "string",
"description": "Hier wird Gleichheit verwendet; expression wird ignoriert."
},
"value": {}
},
"additionalProperties": true,
"required": [
"property",
"value"
]
}
}Beispiel
[
{
"property": "id",
"value": "memberships"
}
]idoptionalOptionaler direkter Selektor; hat vor einem id-Filter Vorrang. Plugin-Katalogschlüssel, keine kodierte DB-ID.
string
- pattern
"^[a-z][a-z0-9_-]{1,63}$"
Schema-Beispiel
"memberships"Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{1,63}$",
"examples": [
"memberships"
]
}Header
languageoptionalAccount language code, where the resource supports setLanguage().
string
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}Pfadparameter
iderforderlichKatalogschlüssel, zum Beispiel memberships.
string
Plugin-Katalogschlüssel, keine kodierte DB-ID.
- pattern
"^[a-z][a-z0-9_-]{1,63}$"
Schema-Beispiel
"memberships"Vollständiges Schema als JSON
{
"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"
}Feld-Metadaten aus der Spezifikation
{
"x-edoobox-id-kind": "plugin-key"
}04
Request Body
Kein Request Body in der Spezifikation beschrieben.
05
Antworten
9HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
Ein Katalogobjekt beim Selektor, sonst Array. preflight wird nur beim Einzelobjekt ergänzt.
application/json
object
success boolean error boolean | string error_code string data Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 object id string Plugin-Katalogschlüssel, keine kodierte DB-ID.
- pattern
"^[a-z][a-z0-9_-]{1,63}$"
Schema-Beispiel
"memberships"key string Plugin-Katalogschlüssel, keine kodierte DB-ID.
- pattern
"^[a-z][a-z0-9_-]{1,63}$"
Schema-Beispiel
"memberships"status string trial object days integer started_at integer ends_at integer ended_at integer available boolean active boolean used boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
billing object model string free boolean amount string | null currency string setup_amount string setup_free boolean minimum_term_months integer trial_days integer Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
activation object resumes_subscription boolean billing object model string free boolean amount string | null currency string setup_amount string setup_free boolean minimum_term_months integer trial_days integer Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
quote string - pattern
"^[a-f0-9]{64}$"
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
manufacturer string image_url string name_text_code string description_text_code string feature_text_codes array Array-Elemente
string
capabilities object plugin_key string status string version integer isVisible boolean canConfigure boolean canPurchase boolean canRedeem boolean canRunRenewal boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
catalog_capabilities object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
subscription object billing Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 object model string free boolean amount string | null currency string setup_amount string setup_free boolean minimum_term_months integer trial_days integer Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 null current_period_start integer current_period_end integer next_billing_at integer cancel_requested_at integer deactivate_at integer setup_billed_at integer cancel_at_period_end boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
actions object activate boolean deactivate boolean cancel_deactivation boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
preflight object published_plans integer blocking_memberships integer usage_passes_without_end integer pending_payments integer open_payment_periods integer active_auto_renewals integer active_pricecategory_conditions integer last_valid_until integer can_deactivate_now boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
id string Plugin-Katalogschlüssel, keine kodierte DB-ID.
- pattern
"^[a-z][a-z0-9_-]{1,63}$"
Schema-Beispiel
"memberships"key string Plugin-Katalogschlüssel, keine kodierte DB-ID.
- pattern
"^[a-z][a-z0-9_-]{1,63}$"
Schema-Beispiel
"memberships"status string trial object days integer started_at integer ends_at integer ended_at integer available boolean active boolean used boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
billing object model string free boolean amount string | null currency string setup_amount string setup_free boolean minimum_term_months integer trial_days integer Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
activation object resumes_subscription boolean billing object model string free boolean amount string | null currency string setup_amount string setup_free boolean minimum_term_months integer trial_days integer Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
quote string - pattern
"^[a-f0-9]{64}$"
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
manufacturer string image_url string name_text_code string description_text_code string feature_text_codes array Array-Elemente
string
capabilities object plugin_key string status string version integer isVisible boolean canConfigure boolean canPurchase boolean canRedeem boolean canRunRenewal boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
catalog_capabilities object Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
subscription object billing Typ nicht eingeschränkt anyOf · Mindestens eine Variante muss passen
Variante 1 object model string free boolean amount string | null currency string setup_amount string setup_free boolean minimum_term_months integer trial_days integer Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 null current_period_start integer current_period_end integer next_billing_at integer cancel_requested_at integer deactivate_at integer setup_billed_at integer cancel_at_period_end boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
actions object activate boolean deactivate boolean cancel_deactivation boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
preflight object published_plans integer blocking_memberships integer usage_passes_without_end integer pending_payments integer open_payment_periods integer active_auto_renewals integer active_pricecategory_conditions integer last_valid_until integer can_deactivate_now boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
type string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"anyOf": [
{
"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": "array",
"items": {
"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
}Beispiel
{
"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
}
}
}400application/json
Invalid request.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40006"
}401application/json
Missing/expired token, missing account context, account paused or model-specific authorization failure.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40103"
}402application/json
Missing/invalid action data or subscription/operation restriction.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80100"
}403application/json
Permission denied. Browser CORS rejection may have an empty body.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40340"
}404application/json
Unknown resource/action or unsupported method.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80019"
}422application/json
Validation failed.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80020"
}429application/json
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.
Response Header
Retry-After
Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.
string
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED42902"
}502application/json
Server-side operation failed.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED50201"
}06
Quelle & Metadaten
Quelle laut Spezifikation
application/models/v2/Plugin.php:17getPlugin()Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.
x-edoobox-mutates-state
falsex-edoobox-routeAliasEvidence
{
"file": "application/models/v2/Plugin.php",
"line": 36,
"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-mutationReview
{
"source": {
"file": "application/models/v2/Plugin.php",
"line": 17
},
"reason": "getPlugin calls catalog and optional preflight. Complete reviewed call graph consists of tenant SELECT/counts, in-memory capability cache and pure billing/trial normalization. activationQuote computes an HMAC consent quote and does not persist it; catalogCurrency fallback only SELECTs. Activation/deactivation and their writes are separate PUT branches.",
"relatedSources": [
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 21
},
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 422
},
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 674
},
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 758
},
{
"file": "application/libraries/edoobox/Membership/AccountPluginGate.php",
"line": 17
},
{
"file": "application/libraries/edoobox/Membership/PluginTrialPolicy.php",
"line": 46
}
]
}x-edoobox-runtimeMutationGuard
falsex-edoobox-get-effect
"read"x-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/08-subscriptions.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Plugin.php",
"method": "getPlugin",
"line": 17,
"branch": {
"file": "application/models/v2/Plugin.php",
"line": 36
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
truex-edoobox-permission
{
"resource": "plugin",
"short": "plug",
"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."
}Vollständige Operation als JSON
{
"operationId": "get_v2_plugin_id_preflight",
"summary": "Plugin-Deaktivierung prüfen",
"description": "Liest Katalogangebot, Vertragsstand, Testphase, Fähigkeiten und aktuelle activation.quote. Ein id-Filter bzw. Pfadschlüssel wählt ein Plugin; ohne Selektor wird die Katalogliste geliefert. preflight ergänzt beim gewählten Plugin die blockierenden Mitgliedschaften, Zahlungsperioden, Verlängerungen und Preisbedingungen. Ohne Selektor liefert auch diese Route nur die Liste. Alternativ zum id-Filter wird ein direkter Query-Parameter id unterstützt.",
"tags": [
"plugin"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"description": "JSON-kodierte Filterliste. Diese Ressource wertet nur die genannten Eigenschaften aus.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"enum": [
"id"
]
},
"expression": {
"type": "string",
"description": "Hier wird Gleichheit verwendet; expression wird ignoriert."
},
"value": {}
},
"additionalProperties": true,
"required": [
"property",
"value"
]
}
},
"example": [
{
"property": "id",
"value": "memberships"
}
]
}
}
},
{
"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": "Katalogschlüssel, zum Beispiel memberships."
},
{
"name": "id",
"in": "query",
"required": false,
"schema": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{1,63}$",
"examples": [
"memberships"
]
},
"description": "Optionaler direkter Selektor; hat vor einem id-Filter Vorrang. Plugin-Katalogschlüssel, keine kodierte DB-ID."
}
],
"responses": {
"200": {
"description": "Ein Katalogobjekt beim Selektor, sonst Array. preflight wird nur beim Einzelobjekt ergänzt.",
"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": {
"anyOf": [
{
"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": "array",
"items": {
"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
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
}
},
"x-edoobox-mutates-state": false,
"x-edoobox-routeAliasEvidence": {
"file": "application/models/v2/Plugin.php",
"line": 36,
"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-mutationReview": {
"source": {
"file": "application/models/v2/Plugin.php",
"line": 17
},
"reason": "getPlugin calls catalog and optional preflight. Complete reviewed call graph consists of tenant SELECT/counts, in-memory capability cache and pure billing/trial normalization. activationQuote computes an HMAC consent quote and does not persist it; catalogCurrency fallback only SELECTs. Activation/deactivation and their writes are separate PUT branches.",
"relatedSources": [
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 21
},
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 422
},
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 674
},
{
"file": "application/libraries/edoobox/Membership/PluginCatalogService.php",
"line": 758
},
{
"file": "application/libraries/edoobox/Membership/AccountPluginGate.php",
"line": 17
},
{
"file": "application/libraries/edoobox/Membership/PluginTrialPolicy.php",
"line": 46
}
]
},
"x-edoobox-runtimeMutationGuard": false,
"x-edoobox-get-effect": "read",
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/08-subscriptions.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Plugin.php",
"method": "getPlugin",
"line": 17,
"branch": {
"file": "application/models/v2/Plugin.php",
"line": 36
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": true,
"x-edoobox-permission": {
"resource": "plugin",
"short": "plug",
"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."
}
}