产品是 Dodo Payments 的基础。无论您是销售一次性下载、定期订阅还是基于使用的访问,您都可以通过创建产品开始。每个产品定义了其定价、在结账时的展示方式以及购买后的履行方式。
创建产品
您可以通过仪表板或 API 创建产品。提前选择定价模型:一次性、订阅或基于使用,然后配置详细信息。定价模型无法更改;如果需要不同的模型,请创建新产品。定价模型和价格
选择定价模型:
- 一次性:一次性支付的固定价格。
- 订阅:按周期和可选试用的重复价格。
- 基于使用:价格基于计量事件得出。
- 价格:基本金额和货币。
- 折扣 (%):在结账和发票中显示的可选内联折扣。
- 对于订阅,设置 每次重复(例如,1 个月或 1 年)和 试用天数(如有需要)。
变体和定价选项
与其在一个产品下创建变体,不如为每个定价选项创建单独的产品(例如,按月和按年)。您可以在同一结账中并排展示多个产品,并让客户在它们之间切换。这使得 API 可预测并简化报告。每个产品都有单一的定价模型。
管理产品
您可以通过仪表板或通过 API 以编程方式管理产品。API 提供对产品创建、更新、检索、图像上传和归档的完全控制。仪表板管理
- 更新:随时编辑名称、描述、图像、价格、字段和权益(定价模型不可变)。
- 归档:在不干扰现有客户的情况下,隐藏产品以防止新购买。您可以稍后取消归档。
API 管理
以下说明允许您创建、更新、管理和检索产品,包括上传图像。创建产品
创建产品
产品可以是一次性商品或基于订阅的服务。要创建新产品,请向
POST 发送请求到 /products 端点,提供名称、描述、价格、货币以及是否为重复产品等详细信息。对于重复产品,请设置 recurring: true 并指定一个 billing_cycle (daily、weekly、monthly、yearly)。创建产品 API
查看创建产品 API 文档中的详细请求和响应结构。
更新产品
更新产品
要修改现有产品,请向
PATCH 发送请求到 /products/{product_id} 端点。您可以更新名称、价格和描述等属性,同时保持其他详细信息不变。确保端点中的 product_id 与现有产品匹配。更新产品 API
查看更新产品 API 文档中的详细请求和响应结构。
检索产品
检索产品
您可以使用
GET 请求从您的帐户中获取存储的产品列表,发送到 /products 端点。这允许您检索产品详细信息,包括活动和归档的产品。检索产品 API
查看检索产品 API 文档中的详细请求和响应结构。
上传产品图片
上传产品图片
您可以通过使用 API 提供的预签名 URL 将图像上传到 AWS S3 来将图像与产品关联。首先,从
/products/{product_id}/images 端点请求图像上传 URL,然后使用提供的 URL 在 60 秒内上传图像。一旦从 API 收到预签名 URL,请使用 PUT 方法上传图像。这确保了对 AWS S3 的安全和临时访问,以便上传图像。支持的上传到 S3 的库:- Node.js:
axios、node-fetch - Python:
requests、boto3 - Go:
net/http - PHP:
GuzzleHttp - Ruby:
rest-client
200 OK 状态,指示图像已成功存储。上传产品图像 API
查看上传产品图像 API 文档中的详细请求和响应结构。
归档产品
归档产品
如果您不再希望显示或使用某个产品,可以通过向
POST 发送请求到 /products/{product_id}/archive 端点来归档它。此操作会隐藏产品,但不会永久删除它。归档产品 API
查看归档产品 API 文档中的详细请求和响应结构。
取消归档产品
取消归档产品
如果您需要恢复已归档的产品,请向
POST 发送请求到 /products/{product_id}/unarchive 端点。这将重新激活该产品并使其再次可用。取消归档产品 API
查看取消归档产品 API 文档中的详细请求和响应结构。
结账和履行
结账和履行
从产品创建支付或订阅流程,并通过权益和 Webhook 自动履行。
最佳实践
- 从清晰开始:为每个定价选项(按月与按年)分开产品
- 明智地使用试用:将试用与入职配对以推动激活
- 自动化履行:使用权益和 Webhook 进行即时交付
- 使用元数据标记:存储您的系统 ID 以便对账
您已准备好创建产品并开始销售 - 一次性、定期或按使用。
