Use cases für Metadaten
Verwenden Sie diese Beispiele, um Ihre Daten zu Stripe-Objekten zu speichern.
Verwenden Sie Metadaten, um Ihre wichtigen Metadaten für Stripe-Objekte für diesen allgemeinen Beispielen zu speichern. Die folgenden Use cases sind nicht vollständig. Wie Sie Metadaten verwenden, hängt von Ihren spezifischen Use cases ab.
Sicherheitshinweis
Nehmen Sie keine sensiblen Daten in die metadata auf, wie z. B. personenbezogene Daten, Bankkontodaten oder Kundenkartendaten.
IDs für Objekte oder Datensätze speichern
Sie können Metadaten in Stripe-Objekten verwenden, um IDs zu speichern, die zu Objekten oder Datensätzen aus Ihren anderen Systemen gehören. So können Sie Referenzen zwischen Stripe-Objekten und den zugehörigen Ressourcen aus Ihren anderen Systemen erstellen.
Bestell- oder Warenkorb-ID
Wenn Sie IDs erstellen, um die Warenkörbe Ihrer Kundinnen/Kunden zu verfolgen, können Sie diese IDs in den Checkout-Sitzungen als Metadaten speichern. So können Sie das zugehörige Stripe-Objekt verwenden, um den zugehörigen Warenkorb in Ihrem System zu finden, nachdem der Bezahlvorgang abgeschlossen ist.
Speichern Sie die Warenkorb-ID in den Metadaten der Checkout-Sitzung, nachdem Sie sie erstellt haben:
Anschließend können Sie die ID des Checkout Session-Objekts anzeigen, aktualisieren oder löschen. Sie wird auch in den an Ihren Webhook-Endpoint gesendeten Ereignissen angezeigt, die diese Checkout-Sitzung enthalten (einschließlich des Ereignisses checkout.).
{ "id": "evt_1PYCL6CzbZon1zn9VivIehz7", "object": "event", "api_version": "2024-06-20", "created": 1719948368, "data": { "object": { "id": "cs_test_a1Znb7gdtlLEPzSi8qMIJzvsSPpIBMKFWovXx0h0O43WS411PpICgCqKjw", "object": "checkout.session", ... "metadata": { "cart_id": "cart_6943" }, ... } }, ... "type": "checkout.session.completed", }
Kunden- oder CMS-ID
Sie können die Kundinnen/Kunden, die Sie in Stripe erstellen, mit den Datensätzen Ihres Kundenverwaltungssystems (CMS) verknüpfen, um Ihre Kunden/Kundinnen zu verfolgen und zu verwalten.
Speichern Sie die ID des Kundendatensatzes aus Ihrem CMS in den Metadaten des Kunden/der Kundin, die Sie in Stripe erstellen.
Stripe fügt diese Informationen in die Ereignisse ein, die an Ihren Webhook-Endpoint gesendet werden und dieses Kundenobjekt enthalten. Wenn Sie beispielsweise customer.-Ereignisse erhalten, können Sie die gespeicherte ID verwenden, um den Datensatz zu ermitteln, den Sie in Ihrem CMS aktualisieren müssen.
{ "id": "evt_1PajAGCzbZon1zn9FUsn7IoG", "object": "event", "api_version": "2024-06-20", "created": 1720551204, "data": { "object": { "id": "cus_QRcNyZh9aZHXnI", "object": "customer", ... "metadata": { "cms_id": "cust_6573" }, ... } }, ... "type": "customer.updated" }
Verfolgen Sie die Abwicklung der Bestellung
Verwenden Sie Metadaten, um Daten zu speichern, die Ihre Bestellausführungsprozesse erleichtern oder verfolgen.
Preis- oder Produkt-ID für einen Payment Intent
Wenn Sie Payment Intents direkt erstellen, können Sie sie mithilfe von Metadaten ihren Produkten oder Preisen zuordnen. Auf diese Weise können Sie die ID der zugehörigen Objekte für den Payment Intent speichern, in dem es kein Feld gibt, das diese mit einem Preis oder Produkt verknüpft.
Sie können die ID des verknüpften Objekts in Ereignissen finden, die diesen Payment Intent enthalten, zum Beispiel payment_-Ereignisse. Anschließend übergeben Sie die Metadaten des Ereignisses an Ihre nachgelagerten Prozesse (z. B. Bestellausführung oder Bestandsverwaltung).
{ "id": "evt_3PajIyCzbZon1zn90b9Wvsqf", "object": "event", "api_version": "2024-06-20", "created": 1720551759, "data": { "object": { "id": "pi_3PajIyCzbZon1zn901xQeOdi", "object": "payment_intent", ... "metadata": { "price_id": "price_1MoBy5LkdIwHu7ixZhnattbh", "product_id": "prod_NWjs8kKbJWmuuc" }, ... } }, ... "type": "payment_intent.succeeded", }
Ausführungsstatus und Tracking
Nachdem Sie mit der Bestellausführung begonnen haben, können Sie Metadaten verwenden, um den aktuellen Ausführungsstatus für das zugehörige Stripe-Objekt aufzuzeichnen. So können Sie ein Objekt von Stripe abrufen und erhalten gleichzeitig den Zahlungsstatus und den Ausführungsstatus.
So aktualisieren Sie den aktuellen Ausführungsstatus:
Partner-Links nachverfolgen
In einigen Fällen kopiert Stripe metadata vom ursprünglichen Objekt in ein verwandtes Objekt. Wenn Sie Partner haben, die Payment Links auf ihren Websites hosten und Anreize für Verkäufe über diese Links anbieten, können Sie dieses Verhalten in Ihrem Partner-Tracking nutzen.
Wenn Sie Zahlungslinks erstellen, können Sie metadata eingeben, um Ihren Partner zu verfolgen:
Jedes Mal, wenn ein Kunde/eine Kundin diesen Link verwendet, um einen Kauf abzuschließen, erstellt Stripe eine Checkout-Sitzung, die die Metadaten übernimmt, die Sie für den Zahlungslink angegeben haben. Sie können die checkout.-Ereignisse überwachen, um Benachrichtigungen von Stripe zu erhalten, wenn ein Kunde/eine Kundin einen Kauf abschließt. Anschließend können Sie Ihre Partner-Tracking-Details aus den Metadaten der Checkout-Sitzung abrufen, um den Verkauf genau zuzuordnen.
{ "id": "evt_1PajfeCzbZon1zn9S7pNlQkU", "object": "event", "api_version": "2024-06-20", "created": 1720553150, "data": { "object": { "id": "cs_test_a1zgRtgzjvamTgTnqMqIaqP6zehBIkaM03iYzxNjZiJ7FMDRRhibd5w3gL", "object": "checkout.session", ... "metadata": { "affiliate": "afl_7920" }, ... } }, ... "type": "checkout.session.completed", }
Shop-Notizen
Sie können Metadaten verwenden, um Notizen zu Objekten zu speichern. Um beispielsweise eine Notiz über die bevorzugte Anrufzeit eines Kunden/einer Kundin zu erstellen, fügen Sie dem Kundenobjekt Metadaten hinzu:
Um einen Hinweis zu speichern, der angibt, warum eine Rechnung storniert wurde, können Sie die metadata für das Invoice-Objekt verwenden:
Metadaten indirekt festlegen
Die Platzierung Ihrer Metadaten bestimmt, welche Ereignistypen die von Ihnen bereitgestellten Informationen enthalten. Wenn Sie bestimmte Ereignistypen in Ihrer Integration verfolgen, wird dadurch auch bestimmt, wo Sie Ihre Metadaten platzieren.
Bestimmte Endpoints für die Objekterstellung enthalten mehrere Felder für Ihre Metadaten: eines zum Speichern von Metadaten direkt für das Objekt, das erstellt wird, und andere zum Festlegen von Metadaten für nachgelagerte, erstellte Objekte. Erfahren Sie mehr über die indirekten Metadatenfelder.
Im folgenden Beispiel wird eine Checkout-Sitzung erstellt, die nach Abschuss ein Abonnement erzeugt. Dabei werden das Top-Level-Feld metadata und das Feld subscription_ verwendet:
Sie können Metadaten für das von Ihnen erstellte Objekt festlegen (in diesem Fall die Checkout-Sitzung). Nachdem Ihr Kunde/Ihre Kundin den Bezahlvorgang abgeschlossen hat, werden die zuvor in subscription_ angegebenen Metadaten für das neu erstellte Abonnement-Objekt festgelegt. Dadurch wird festgelegt, welche Ereignisse die Metadaten enthalten. Beispielsweise enthalten Ereignisse, die eine Checkout-Sitzung enthalten, zum Beispiel checkout., Werte, die über den Top-Level-Parameter metadata bereitgestellt werden.
{ "id": "evt_1PakshCzbZon1zn9PlQwJYn0", "object": "event", "api_version": "2024-06-20", "created": 1720557803, "data": { "object": { "id": "cs_test_a1lsYmNYnEqQAxHT9knVy8v7u7m5ChjKtyB3M68ovMCjUQgCADsCkUviUU", "object": "checkout.session", ... "metadata": { "checkout_metadata": "Checkout Session metadata goes here" }, ... } }, ... "type": "checkout.session.completed", }
Ereignisse, die ein Subscription-Objekt enthalten, wie beispielsweise customer., enthalten Werte, die über subscription_ bereitgestellt werden. Da dieses Ereignis jedoch ein Abonnementobjekt enthält, stellt Stripe die Werte im obersten metadata-Feld des Abonnementsobjekts bereit.
{ "id": "evt_1PaksgCzbZon1zn9x9u3MTSC", "object": "event", "api_version": "2024-06-20", "created": 1720557800, "data": { "object": { "id": "sub_1PaksdCzbZon1zn9D6DQjr9L", "object": "subscription", ... "metadata": { "subscription_metadata": "Subscription metadata goes here" }, ... } }, ... "type": "customer.subscription.created", }
Sie können auf die Metadaten, die Sie in subscription_ bereitstellen, in den Rechnungsereignissen zugreifen. Dies geschieht, weil die Metadaten des Abonnements in die subscription_ der durch das Abonnement erstellten Invoice-Objekte übertragen werden.
{ "id": "evt_1PaksgCzbZon1zn9wD24BlvY", "object": "event", "api_version": "2024-06-20", "created": 1720557800, "data": { "object": { "id": "in_1PaksdCzbZon1zn9Z4bl0z7k", "object": "invoice", ... "subscription_details": { "metadata": { "subscription_metadata": "Subscription metadata goes here" } ... }, } }, ... "type": "invoice.finalized", }
Speichern Sie große Mengen an Metadaten
Verwenden Sie Metadatenfelder in Stripe, um Daten direkt zu speichern, oder speichern Sie einen externen Suchschlüssel, um auf zusätzliche Daten aus Ihrer eigenen Datenbank zuzugreifen, wodurch die abzurufenden Informationen minimiert werden.
Strukturierte Daten speichern
Metadaten können beliebige Zeichenfolgen, einschließlich solcher, die strukturierte Daten wie JSON darstellen, mit bis zu 500 Zeichen akzeptieren. Sie können damit mehr Daten in Ihren Metadatenfeldern speichern und so die Anzahl der Schlüssel reduzieren, auf die Sie zugreifen müssen, um alle Informationen abzurufen.
Metadaten extern speichern
Wenn Sie einem Objekt mehr Daten zuordnen möchten, als die 500 Zeichen der bereitgestellten Metadatenfelder zulassen, speichern Sie die überzähligen Daten in Ihrer eigenen Datenbank. Sie können dann Metadaten verwenden, um die ID oder den Suchschlüssel für den Zugriff auf diese Informationen zu speichern. Dieses Verfahren ähnelt dem Speichern der ID eines beliebigen anderen Datensatzes in Ihrem System.
Metadaten anderen Stripe-APIs und -Produkten verwenden
Sie können Metadaten mit anderen Stripe-APIs und -Produkten verwenden, um deren Flexibilität und Erweiterbarkeit zu verbessern.
Radar
Sie können Radar-Regeln in Werte für Referenz-Metadaten schreiben und damit bestimmen, ob eine Regel die zugehörige Aktion für eine Transaktion auslöst.
Erste Überprüfung der Kundentransaktionen durchführen
Sie können einen Ablauf einrichten, um die erste Transaktion eines/einer Kunden/Kundin zur Überprüfung zu markieren, und dann die Kundendaten zu aktualisieren, um nachfolgende Transaktionen von der Überprüfung auszuschließen.
Überprüfen, wenn != 'true'
Stripe löst diese Regel nur für Zahlungen aus, wenn verified_ für den Kunden/die Kundin auf false festgelegt ist. Kunden/Kundinnen, für die diese Einstellung auf true gesetzt ist, sind nicht betroffen.
A/B-Testregeln
Sie können Metadaten mit Radar verwenden, um A/B-Testszenarien für neue Regeln zu erstellen, sodass Sie die Wirksamkeit einer neuen Regel bewerten können, bevor Sie sie in Ihrem gesamten Kundenstamm implementieren.
Blockieren, wenn = 'treatment' and :card_funding: = 'prepaid'
Stripe löst diese Regel nur für Zahlungen aus, die Sie als Teil der Behandlungsgruppe kennzeichnen. Dies wirkt sich nicht auf Zahlungen aus, die als ihre experiment_ auf control festgelegt sind.
Die Search API
Verwenden Sie die Search API, um Ergebnisse basierend auf den Metadaten abzufragen und zu filtern, die Sie für die unterstützten Objekte festgelegt haben, nach denen Sie suchen.
Sie können beispielsweise Ihre „Premium“ -Kundinnen/Kunden verfolgen, indem Sie dem Kundenobjekt Metadaten hinzufügen. Damit Sie ihnen exklusive Werbeaktionen anbieten können, verwenden Sie die Search API, um als premium gekennzeichnete Kundinnen/Kunden zu ermitteln, und wenden Sie sich dann mit der Werbeaktion an sie.
Objekte müssen indiziert werden, bevor sie in den Ergebnissen der Search API angezeigt werden. Die Objekte werden erst in den Suchergebnissen angezeigt, wenn diese Indizierung abgeschlossen ist.