Skip to main content

Introduzione

I metadati ti consentono di memorizzare informazioni aggiuntive e strutturate sui tuoi oggetti in Dodo Payments. Puoi allegare metadati alla maggior parte degli oggetti di Dodo Payments, inclusi pagamenti, abbonamenti e altro.

Panoramica

  • Le chiavi dei metadati possono contenere fino a 40 caratteri
  • I valori dei metadati possono essere stringhe, numeri interi, numeri o valori booleani; le stringhe possono contenere fino a 500 caratteri
  • Oggetti, array e null non sono accettati come valori dei metadati
  • È possibile avere fino a 50 coppie chiave-valore di metadati per oggetto
  • Le chiavi devono contenere solo caratteri alfanumerici, trattini e underscore
  • I metadati non sono ricercabili tramite la nostra API, ma vengono restituiti nelle risposte API e nei webhook

Casi d’uso

I metadati sono utili per:
  • Memorizzare ID o riferimenti esterni
  • Aggiungere annotazioni interne
  • Collegare oggetti di Dodo Payments al tuo sistema
  • Categorizzare le transazioni
  • Aggiungere attributi personalizzati per la reportistica

Aggiungere Metadati

Puoi aggiungere metadati durante la creazione o l’aggiornamento degli oggetti tramite l’API. Per i prodotti, hai anche l’opzione di aggiungere metadati direttamente dall’interfaccia del dashboard.

Tramite API

Tramite Interfaccia Dashboard (Solo Prodotti)

Per i prodotti, puoi anche aggiungere metadati direttamente dal dashboard di Dodo Payments durante la creazione o la modifica di un prodotto. La sezione metadati ti consente di aggiungere facilmente coppie chiave-valore personalizzate senza scrivere codice.
Interfaccia dei metadati del prodotto nella dashboard Dodo Payments
L’uso dell’interfaccia della dashboard per i metadati del prodotto è particolarmente utile per i membri del team non tecnici che devono gestire le informazioni sui prodotti e le categorie.

Recuperare Metadati

I metadati sono inclusi nelle risposte API quando si recuperano oggetti:
Il recupero di una sessione di checkout (GET /checkouts/{id}) non restituisce metadata. La risposta sullo stato della sessione contiene solo id, created_at, payment_id, payment_status, customer_email e customer_name. Leggi invece i metadati allegati al momento della creazione della sessione dal pagamento risultante, utilizzando payment_id restituito da quell’endpoint.

Ricerca e filtri

Sebbene i metadati non siano direttamente ricercabili tramite la nostra API, puoi:
  1. Memorizzare gli identificatori importanti nei metadati
  2. Recuperare gli oggetti utilizzando i relativi ID principali
  3. Filtrare i risultati nel codice della tua applicazione

Best practice

Da fare:

  • Utilizza convenzioni di denominazione coerenti per le chiavi dei metadati
  • Documenta internamente lo schema dei metadati
  • Mantieni i valori brevi e significativi
  • Utilizza i metadati solo per dati statici
  • Valuta l’utilizzo di prefissi per sistemi diversi (ad es., crm_id, inventory_sku)

Da non fare:

  • Non memorizzare dati sensibili nei metadati
  • Non utilizzare i metadati per valori che cambiano frequentemente
  • Non fare affidamento sui metadati per la logica aziendale critica
  • Non memorizzare informazioni duplicate già disponibili altrove nell’oggetto
  • Non utilizzare caratteri speciali nelle chiavi dei metadati

Oggetti supportati

I metadati sono supportati sui seguenti oggetti:

Webhook e metadati

I metadati sono inclusi negli eventi webhook, rendendo semplice gestire le notifiche con i tuoi dati personalizzati:
Ultima modifica il 8 agosto 2026