跳转到主要内容

介绍

元数据允许您在 Dodo Payments 中存储有关对象的附加结构化信息。您可以将元数据附加到大多数 Dodo Payments 对象,包括支付、订阅等。

概述

  • 元数据键最多可达 40 个字符长
  • 元数据值可以是字符串、数字或布尔值;字符串最长可达 500 个字符
  • 对象、数组和 null 不被接受作为元数据值
  • 每个对象最多可以有 50 对元数据键值对
  • 键只能包含字母数字字符、短划线和下划线
  • 元数据无法通过我们的 API 搜索,但会在 API 响应和 Webhook 中返回

用例

元数据对于以下情况非常有用:
  • 存储外部 ID 或引用
  • 添加内部注释
  • 将 Dodo Payments 对象链接到您的系统
  • 对交易进行分类
  • 为报告添加自定义属性

添加元数据

您可以在通过 API 创建或更新对象时添加元数据。对于产品,您还可以选择直接从仪表板 UI 添加元数据。

通过 API

通过仪表板 UI(仅限产品)

对于产品,您还可以在创建或编辑产品时直接从 Dodo Payments 仪表板添加元数据。元数据部分允许您轻松添加自定义键值对,而无需编写代码。
Product metadata interface in Dodo Payments dashboard
对于需要管理产品信息和类别的非技术团队成员而言,使用仪表盘 UI 管理产品元数据特别有用。

检索元数据

在检索对象时,元数据包含在 API 响应中:

搜索和过滤

虽然元数据无法通过我们的 API 直接搜索,但您可以:
  1. 在元数据中存储重要标识符
  2. 使用其主 ID 检索对象
  3. 在您的应用程序代码中过滤结果

最佳实践

应该做:

  • 为元数据键使用一致的命名约定
  • 在内部记录你的元数据架构
  • 保持值简短且有意义
  • 仅为静态数据使用元数据
  • 考虑为不同系统使用前缀(例如 crm_id, inventory_sku

不要:

  • 在元数据中存储敏感数据
  • 将元数据用于频繁更改的值
  • 依赖元数据进行关键业务逻辑
  • 存储在对象中其他地方可用的重复信息
  • 在元数据键中使用特殊字符

支持的对象

元数据支持以下对象:

Webhook 和元数据

元数据包含在 webhook 事件中,使您能够轻松处理带有自定义数据的通知:
最后修改于 2026年7月9日