Skip to main content

Introduzione

I metadati ti permettono di archiviare i tuoi dati chiave-valore sugli oggetti di Dodo Payments, come l’ID di un ordine del tuo sistema o un riferimento CRM. Puoi associare metadati alla maggior parte degli oggetti, inclusi pagamenti, abbonamenti, clienti e prodotti. Consulta Oggetti supportati per l’elenco completo.

Panoramica

I metadati seguono queste regole:
  • Le chiavi dei metadati possono contenere fino a 40 caratteri (fino a 100 caratteri per gli eventi di utilizzo acquisiti tramite POST /events/ingest).
  • I valori dei metadati possono essere stringhe, interi, numeri o booleani. I valori stringa possono contenere fino a 500 caratteri.
  • Oggetti, array e null non sono accettati come valori dei metadati.
  • Puoi aggiungere fino a 50 coppie chiave-valore dei metadati per oggetto. Una richiesta che ne contiene di più restituisce MAXIMUM_KEYS_REACHED codice errore.
  • L’API non può cercare o filtrare in base ai metadati, ma li restituisce nelle risposte dell’API e nei webhook.

Casi d’uso

Usa i metadati per:
  • Archiviare ID o riferimenti esterni.
  • Aggiungere note interne.
  • Collegare gli oggetti di Dodo Payments ai record del tuo sistema.
  • Categorizzare le transazioni.
  • Aggiungere attributi personalizzati per la reportistica.

Aggiunta dei metadati

Aggiungi i metadati quando crei o aggiorni un oggetto tramite l’API. Per i prodotti, puoi anche aggiungere i metadati nella dashboard.

Tramite API

Passa un oggetto metadata nel corpo della richiesta. Gli esempi seguenti usano l’SDK TypeScript e presuppongono un client inizializzato:

Tramite l’interfaccia della dashboard (solo prodotti)

Per aggiungere metadati a un prodotto senza scrivere codice, apri il prodotto in Prodotti e aggiungi le coppie chiave-valore nella sezione dei metadati. Puoi farlo quando crei o modifichi il prodotto.
Sezione dei metadati del prodotto nella dashboard di Dodo Payments
I membri del team che non lavorano con l’API possono usare la dashboard per gestire i metadati dei prodotti, come le categorie dei prodotti.

Recupero dei metadati

Le risposte API includono i metadati quando recuperi un oggetto:
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. Per leggere i metadati che hai associato quando hai creato la sessione, recupera il pagamento risultante con l’payment_id restituito.

Ricerca e filtraggio

L’API non può cercare in base ai metadati. Per trovare un oggetto in base a un valore dei metadati:
  1. Archivia i tuoi identificatori importanti nei metadati.
  2. Elenca o recupera gli oggetti tramite l’API.
  3. Filtra i risultati nel codice della tua applicazione.

Best practice

Segui queste linee guida per mantenere utili i metadati.

Da fare:

  • Usa convenzioni di denominazione coerenti per le chiavi dei metadati.
  • Documenta internamente il tuo schema dei metadati.
  • Mantieni i valori brevi e significativi.
  • Usa i metadati solo per dati statici.
  • Valuta l’uso di prefissi che indicano il sistema di origine, ad esempio crm_id o inventory_sku.

Da non fare:

  • Archiviare dati sensibili nei metadati.
  • Usare i metadati per valori che cambiano frequentemente.
  • Fare affidamento sui metadati per la logica aziendale critica.
  • Duplicare informazioni già contenute nell’oggetto.
  • Usare caratteri speciali nelle chiavi dei metadati.

Oggetti supportati

Questi oggetti supportano i metadati:

Webhook e metadati

I payload dei webhook includono i metadati dell’oggetto, così il tuo gestore dei webhook può associare un evento ai tuoi record:
Ultima modifica il 26 settembre 2026