GET/v2/usermembership/list/invoice

Rechnungslink einer Mitgliedschaft erzeugen

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. Auf /list wird diese Aktion nur mit id als direktem Query oder filter-Eintrag ausgeführt; sonst folgt die gewöhnliche Mitgliedschaftsliste (einschließlich Zahlungsabgleich).

Operation-ID get_v2_usermembership_list_invoice

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

business-mutation

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing 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."
}

accountContextapiKey

Selected 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

sessionCookieapiKey

Existing 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."
}

accountContextapiKey

Selected 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."
}

Berechtigungen

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.

Ressource: usermembership · usme
Levels: 1, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Query-Parameter

filteroptional

property/value-Filter: id liest Details; user und plan filtern über öffentliche v2-IDs; status (pending_payment/scheduled/active/expired/exhausted/cancelled/payment_failed), active (FILTER_VALIDATE_BOOL), source (purchase/admin/public_purchase/admin_purchase/admin_grant/renewal/migration) und search (Vorname/Nachname/E-Mail). purchase umfasst beide Kaufkanäle, admin administrative Käufe und Vergaben. expression und unbekannte Eigenschaften werden ignoriert.

`application/json`

array

Array-Elemente

object

property string erforderlich

value Typ nicht eingeschränkt erforderlich

expression string

Ignoriert; Auswahl über property/value.

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {},
      "expression": {
        "type": "string",
        "description": "Ignoriert; Auswahl über property/value."
      }
    },
    "additionalProperties": true,
    "required": [
      "property",
      "value"
    ]
  }
}

Beispiel

[
  {
    "property": "user",
    "value": "user_012345abcdef_123456"
  }
]

limitoptional

JSON-Objekt start/reply oder Zahl als reply. Standard 0/100, reply auf 1–500 begrenzt, start mindestens 0.

`application/json`

Typ nicht eingeschränkt

oneOf · Genau eine Variante muss passen

Variante 1 object

start integer

minimum: 0

Standardwert: 0

reply integer

minimum: 1
maximum: 500

Standardwert: 100

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 integer

minimum: 1
maximum: 500

Vollständiges Schema als JSON

{
  "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
    }
  ]
}

Beispiel

{
  "start": 0,
  "reply": 25
}

languageoptional

Sprache des Rechnungslinks; Fallback Kontosprache.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

periodoptional

Erforderliche Periodenauswahl für den Rechnungslink, alternativ filter-Eintrag period.

string

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID des aktuellen Kontos."
}

idoptional

Einzelmitgliedschaft auswählen, alternativ filter-Eintrag id.

string

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^usermembership_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"usermembership_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID des aktuellen Kontos.",
  "examples": [
    "usermembership_012345abcdef_123456"
  ]
}

useroptional

Mitgliedschaften eines Benutzers auswählen, alternativ filter-Eintrag user.

string

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^user_[a-f0-9]{12}_-?[0-9]+$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID des aktuellen Kontos."
}

planoptional

Mitgliedschaften eines Plans auswählen, alternativ filter-Eintrag plan.

string

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^membershipplan_[a-f0-9]{12}_-?[0-9]+$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID des aktuellen Kontos."
}

Header

X-Edoobox-If-Revisionoptional

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.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data enthält das dokumentierte Ergebnis; error=false und success=true. Listen liefern zusätzlich total (Gesamtzahl vor Pagination).

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data Typ nicht eingeschränkt

oneOf · Genau eine Variante muss passen

Variante 1 object

period string erforderlich

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$"

invoice string | null erforderlich

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^invoice_[a-f0-9]{12}_-?[0-9]+$"

url string erforderlich

format: "uri"

expires_at integer erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array

Array-Elemente

object

id string erforderlich

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^usermembership_[a-f0-9]{12}_-?[0-9]+$"

version integer erforderlich

user string erforderlich

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^user_[a-f0-9]{12}_-?[0-9]+$"

user_information object erforderlich

name string erforderlich

email string erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

plan string erforderlich

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^membershipplan_[a-f0-9]{12}_-?[0-9]+$"

plan_version integer erforderlich

name string erforderlich

status string erforderlich

Erlaubte Werte

"pending_payment""scheduled""active""expired""exhausted""cancelled""payment_failed"

active boolean erforderlich

valid_from integer | null erforderlich

valid_until integer | null erforderlich

granted_uses integer | null erforderlich

remaining_uses integer | null erforderlich

membership_promo_code string | null erforderlich

source string erforderlich

renewal object erforderlich

auto_renew boolean

cancel_at_period_end boolean

cancel_requested_at integer | null

cancel_effective_at integer | null

next_renewal_at integer | null

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

current_period string | null erforderlich

Öffentliche v2-ID des aktuellen Kontos.

pattern: "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$"

created_at integer erforderlich

updated_at integer erforderlich

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": {
      "oneOf": [
        {
          "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": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID des aktuellen Kontos."
              },
              "version": {
                "type": "integer"
              },
              "user": {
                "type": "string",
                "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID des aktuellen Kontos."
              },
              "user_information": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "name",
                  "email"
                ]
              },
              "plan": {
                "type": "string",
                "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID des aktuellen Kontos."
              },
              "plan_version": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending_payment",
                  "scheduled",
                  "active",
                  "expired",
                  "exhausted",
                  "cancelled",
                  "payment_failed"
                ]
              },
              "active": {
                "type": "boolean"
              },
              "valid_from": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "valid_until": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "granted_uses": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "remaining_uses": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "membership_promo_code": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "source": {
                "type": "string"
              },
              "renewal": {
                "type": "object",
                "properties": {
                  "auto_renew": {
                    "type": "boolean"
                  },
                  "cancel_at_period_end": {
                    "type": "boolean"
                  },
                  "cancel_requested_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "cancel_effective_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "next_renewal_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  }
                },
                "additionalProperties": true
              },
              "current_period": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID des aktuellen Kontos."
              },
              "created_at": {
                "type": "integer"
              },
              "updated_at": {
                "type": "integer"
              }
            },
            "additionalProperties": true,
            "required": [
              "id",
              "version",
              "user",
              "user_information",
              "plan",
              "plan_version",
              "name",
              "status",
              "active",
              "valid_from",
              "valid_until",
              "granted_uses",
              "remaining_uses",
              "membership_promo_code",
              "source",
              "renewal",
              "current_period",
              "created_at",
              "updated_at"
            ]
          }
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "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
  }
}

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"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

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"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Usermembership.php:24getUsermembership()

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

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-get-effect

"business-mutation"

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."
}

Vollständige Operation als JSON

{
  "operationId": "get_v2_usermembership_list_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. Auf /list wird diese Aktion nur mit id als direktem Query oder filter-Eintrag ausgeführt; sonst folgt die gewöhnliche Mitgliedschaftsliste (einschließlich Zahlungsabgleich).",
  "tags": [
    "usermembership"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "property/value-Filter: id liest Details; user und plan filtern über öffentliche v2-IDs; status (pending_payment/scheduled/active/expired/exhausted/cancelled/payment_failed), active (FILTER_VALIDATE_BOOL), source (purchase/admin/public_purchase/admin_purchase/admin_grant/renewal/migration) und search (Vorname/Nachname/E-Mail). purchase umfasst beide Kaufkanäle, admin administrative Käufe und Vergaben. expression und unbekannte Eigenschaften werden ignoriert.",
      "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": "user",
              "value": "user_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": "Sprache des Rechnungslinks; Fallback Kontosprache.",
      "schema": {
        "type": "string"
      }
    },
    {
      "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": "id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID des aktuellen Kontos.",
        "examples": [
          "usermembership_012345abcdef_123456"
        ]
      },
      "description": "Einzelmitgliedschaft auswählen, alternativ filter-Eintrag id."
    },
    {
      "name": "user",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID des aktuellen Kontos."
      },
      "description": "Mitgliedschaften eines Benutzers auswählen, alternativ filter-Eintrag user."
    },
    {
      "name": "plan",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID des aktuellen Kontos."
      },
      "description": "Mitgliedschaften eines Plans auswählen, alternativ filter-Eintrag plan."
    },
    {
      "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": {
                "oneOf": [
                  {
                    "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": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID des aktuellen Kontos."
                        },
                        "version": {
                          "type": "integer"
                        },
                        "user": {
                          "type": "string",
                          "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID des aktuellen Kontos."
                        },
                        "user_information": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "email": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "name",
                            "email"
                          ]
                        },
                        "plan": {
                          "type": "string",
                          "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID des aktuellen Kontos."
                        },
                        "plan_version": {
                          "type": "integer"
                        },
                        "name": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string",
                          "enum": [
                            "pending_payment",
                            "scheduled",
                            "active",
                            "expired",
                            "exhausted",
                            "cancelled",
                            "payment_failed"
                          ]
                        },
                        "active": {
                          "type": "boolean"
                        },
                        "valid_from": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "valid_until": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "granted_uses": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "remaining_uses": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "membership_promo_code": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "source": {
                          "type": "string"
                        },
                        "renewal": {
                          "type": "object",
                          "properties": {
                            "auto_renew": {
                              "type": "boolean"
                            },
                            "cancel_at_period_end": {
                              "type": "boolean"
                            },
                            "cancel_requested_at": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "cancel_effective_at": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "next_renewal_at": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            }
                          },
                          "additionalProperties": true
                        },
                        "current_period": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "pattern": "^membershipperiod_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID des aktuellen Kontos."
                        },
                        "created_at": {
                          "type": "integer"
                        },
                        "updated_at": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "id",
                        "version",
                        "user",
                        "user_information",
                        "plan",
                        "plan_version",
                        "name",
                        "status",
                        "active",
                        "valid_from",
                        "valid_until",
                        "granted_uses",
                        "remaining_uses",
                        "membership_promo_code",
                        "source",
                        "renewal",
                        "current_period",
                        "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": true,
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "business-mutation",
  "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."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# 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/usermembership/list/invoice' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

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/usermembership/list/invoice";
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

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/usermembership/list/invoice"
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.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

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/usermembership/list/invoice";
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

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/usermembership/list/invoice"
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.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.