Zum Hauptinhalt springen

Einführung

Metadaten ermöglichen es Ihnen, zusätzliche, strukturierte Informationen über Ihre Objekte in Dodo Payments zu speichern. Sie können Metadaten an den meisten Dodo Payments-Objekten anhängen, einschließlich Zahlungen, Abonnements und mehr.

Übersicht

  • Metadaten-Schlüssel können bis zu 40 Zeichen lang sein
  • Metadaten-Werte können eine Zeichenkette, eine Zahl oder ein boolean sein; Zeichenketten können bis zu 500 Zeichen lang sein
  • Objekte, Arrays und null werden nicht als Metadaten-Werte akzeptiert
  • Sie können bis zu 50 Metadaten-Schlüssel-Wert-Paare pro Objekt haben
  • Schlüssel sollten nur alphanumerische Zeichen, Bindestriche und Unterstriche enthalten
  • Metadaten sind nicht durch unsere API durchsuchbar, werden jedoch in API-Antworten und Webhooks zurückgegeben

Anwendungsfälle

Metadaten sind nützlich für:
  • Speichern externer IDs oder Referenzen
  • Hinzufügen interner Anmerkungen
  • Verknüpfen von Dodo Payments-Objekten mit Ihrem System
  • Kategorisieren von Transaktionen
  • Hinzufügen benutzerdefinierter Attribute für Berichte

Hinzufügen von Metadaten

Sie können Metadaten beim Erstellen oder Aktualisieren von Objekten über die API hinzufügen. Für Produkte haben Sie auch die Möglichkeit, Metadaten direkt über die Dashboard-Benutzeroberfläche hinzuzufügen.

Über die API

Über die Dashboard-Benutzeroberfläche (nur Produkte)

Für Produkte können Sie Metadaten auch direkt über das Dodo Payments-Dashboard hinzufügen, wenn Sie ein Produkt erstellen oder bearbeiten. Der Metadatenbereich ermöglicht es Ihnen, benutzerdefinierte Schlüssel-Wert-Paare einfach hinzuzufügen, ohne Code schreiben zu müssen.
Produktmetadaten-Oberfläche im Dodo Payments Dashboard
Die Verwendung der Dashboard-Benutzeroberfläche für Produktmetadaten ist besonders nützlich für nicht-technische Teammitglieder, die Produktinformationen und Kategorien verwalten müssen.

Abrufen von Metadaten

Metadaten sind in API-Antworten enthalten, wenn Objekte abgerufen werden:

Suchen und Filtern

Während Metadaten über unsere API nicht direkt durchsuchbar sind, können Sie:
  1. Wichtige Identifikatoren in Metadaten speichern
  2. Objekte anhand ihrer primären IDs abrufen
  3. Die Ergebnisse in Ihrem Anwendungscode filtern

Best Practices

Do:

  • Verwenden Sie konsistente Namenskonventionen für Metadaten-Schlüssel
  • Dokumentieren Sie Ihr Metadatenschema intern
  • Halten Sie Werte kurz und aussagekräftig
  • Verwenden Sie Metadaten nur für statische Daten
  • Erwägen Sie die Verwendung von Präfixen für verschiedene Systeme (z. B. crm_id, inventory_sku)

Nicht tun:

  • Sensible Daten in Metadaten speichern
  • Metadaten für häufig wechselnde Werte verwenden
  • Sich auf Metadaten für kritische Geschäftslogik verlassen
  • Duplizierte Informationen speichern, die anderswo im Objekt verfügbar sind
  • Sonderzeichen in Metadaten-Schlüsseln verwenden

Unterstützte Objekte

Metadaten werden für die folgenden Objekte unterstützt:

Webhooks und Metadaten

Metadaten sind in Webhook-Ereignissen enthalten, was es einfach macht, Benachrichtigungen mit Ihren benutzerdefinierten Daten zu verarbeiten:
Zuletzt geändert am 9. Juli 2026