Rechnungslink einer Mitgliedschaft erzeugen

{
  "operationId": "get_v2_usermembership_id_invoice",
  "summary": "Rechnungslink einer Mitgliedschaft erzeugen",
  "description": "Erzeugt einen signierten, sieben Tage gültigen Rechnungslink für genau eine eigene Periode. period ist als Query oder gleichnamiger filter-Eintrag erforderlich. Unterstützt pending/paid/failed/refunded/partially_refunded bei vorhandener Rechnung/Transaktion. Zahlungsabgleich vor der Erzeugung kann Mitgliedschafts- und Periodenzustände, Audit/Outbox aktualisieren. Der Link lädt kein PDF in dieser Antwort.",
  "tags": [
    "usermembership"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "Alternative zum Query-Parameter period: Periodenauswahl über property=period.",
      "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": "period",
              "value": "membershipperiod_012345abcdef_123456"
            }
          ]
        }
      }
    },
    {
      "name": "language",
      "in": "query",
      "required": false,
      "description": "Sprache des Rechnungslinks; Fallback Kontosprache.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
        "examples": [
          "usermembership_012345abcdef_123456"
        ]
      },
      "description": "Source-reviewed path context; normal dispatcher ownership and permission checks still apply."
    },
    {
      "name": "period",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID des aktuellen Kontos."
      },
      "description": "Erforderliche Periodenauswahl für den Rechnungslink, alternativ filter-Eintrag period."
    },
    {
      "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 das dokumentierte Ergebnis; error=false und success=true. Listen liefern zusätzlich total (Gesamtzahl vor Pagination).",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "period": "membershipperiod_012345abcdef_123456",
              "invoice": "invoice_012345abcdef_123456",
              "url": "https://app.edoobox.com/my/memberships/usermembership_012345abcdef_123456/invoice?expires=1790604800&sig=synthetic-signature",
              "expires_at": 1790604800
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "period": {
                    "type": "string",
                    "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID des aktuellen Kontos."
                  },
                  "invoice": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID des aktuellen Kontos."
                  },
                  "url": {
                    "type": "string",
                    "format": "uri"
                  },
                  "expires_at": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "period",
                  "invoice",
                  "url",
                  "expires_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": true,
  "x-edoobox-routeAliasEvidence": {
    "file": "application/models/v2/Usermembership.php",
    "line": 49,
    "reason": "Reviewed dispatcher alias: the same literal action/constructor Structure is selected; the third segment supplies ID/filter context or an ignored collection spelling. Domain ownership, required data and model validation remain unchanged."
  },
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/23",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Usermembership.php",
      "line": 49,
      "reason": "Exact invoice branch supplies fixed action=invoice; item/list branches invoke their specific entitlement read service. Tenant public IDs are decoded before dispatch."
    },
    "reason": "Read a link to an already-existing period invoice, after automatic existing-ledger reconciliation.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-03.json",
      "pointer": "/operations/23",
      "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
      "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
    }
  },
  "x-edoobox-readonly-maintenance": true,
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-parameterAlternatives": [
    {
      "query": [
        "period"
      ]
    },
    {
      "query": [
        "filter"
      ],
      "containsProperty": [
        "period"
      ]
    }
  ],
  "x-edoobox-source": {
    "file": "application/models/v2/Usermembership.php",
    "method": "getUsermembership",
    "line": 24,
    "branch": {
      "file": "application/models/v2/Usermembership.php",
      "line": 49
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "usermembership",
    "short": "usme",
    "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."
  }
}