Passer au contenu principal

Introduction

Les métadonnées vous permettent de stocker des informations supplémentaires et structurées sur vos objets dans Dodo Payments. Vous pouvez attacher des métadonnées à la plupart des objets Dodo Payments, y compris les paiements, les abonnements, et plus encore.

Aperçu

  • Les clés de métadonnées peuvent comporter jusqu’à 40 caractères
  • Les valeurs de métadonnées peuvent être une chaîne, un nombre ou un booléen ; les chaînes peuvent comporter jusqu’à 500 caractères
  • Les objets, les tableaux et null ne sont pas acceptés comme valeurs de métadonnées
  • Vous pouvez avoir jusqu’à 50 paires clé-valeur de métadonnées par objet
  • Les clés ne doivent contenir que des caractères alphanumériques, des tirets et des underscores
  • Les métadonnées ne sont pas recherchables via notre API mais sont renvoyées dans les réponses de l’API et les webhooks

Cas d’utilisation

Les métadonnées sont utiles pour :
  • Stocker des identifiants ou références externes
  • Ajouter des annotations internes
  • Lier des objets Dodo Payments à votre système
  • Catégoriser les transactions
  • Ajouter des attributs personnalisés pour les rapports

Ajout de métadonnées

Vous pouvez ajouter des métadonnées lors de la création ou de la mise à jour d’objets via l’API. Pour les produits, vous avez également la possibilité d’ajouter des métadonnées directement depuis l’interface du tableau de bord.

Via l’API

Via l’interface du tableau de bord (Produits uniquement)

Pour les produits, vous pouvez également ajouter des métadonnées directement depuis le tableau de bord Dodo Payments lors de la création ou de l’édition d’un produit. La section des métadonnées vous permet d’ajouter facilement des paires clé-valeur personnalisées sans écrire de code.
Product metadata interface in Dodo Payments dashboard
L’utilisation de l’interface du tableau de bord pour les métadonnées produit est particulièrement utile pour les membres de l’équipe non techniques qui doivent gérer les informations produit et les catégories.

Récupération des métadonnées

Les métadonnées sont incluses dans les réponses API lors de la récupération d’objets :

Recherche et filtrage

Bien que les métadonnées ne soient pas directement recherchables via notre API, vous pouvez :
  1. Stocker des identifiants importants dans les métadonnées
  2. Récupérer des objets en utilisant leurs identifiants principaux
  3. Filtrer les résultats dans votre code d’application

Meilleures pratiques

À faire :

  • Utilisez des conventions de nommage cohérentes pour les clés de métadonnées
  • Documentez votre schéma de métadonnées en interne
  • Gardez les valeurs concises et significatives
  • Utilisez les métadonnées uniquement pour des données statiques
  • Envisagez d’utiliser des préfixes pour différents systèmes (par exemple, crm_id, inventory_sku)

À ne pas faire :

  • Stocker des données sensibles dans les métadonnées
  • Utiliser les métadonnées pour des valeurs changeantes fréquemment
  • Compter sur les métadonnées pour une logique commerciale critique
  • Stocker des informations en double qui sont disponibles ailleurs dans l’objet
  • Utiliser des caractères spéciaux dans les clés de métadonnées

Objets pris en charge

Les métadonnées sont prises en charge sur les objets suivants :

Webhooks et métadonnées

Les métadonnées sont incluses dans les événements de webhook, ce qui facilite la gestion des notifications avec vos données personnalisées :
Dernière modification le 9 juillet 2026