介绍

​

什么是权益？

​

可用集成

​

授予的工作原理

​

授予生命周期

​

按事件划分的授予记录行为

​

创建你的第一项权益

1

Open Entitlements

在控制面板中进入 Entitlements，然后点击 + 创建权益。

2

Pick an Integration

选择集成类型：License Key、Digital Files、Feature Flag、Discord、GitHub、Telegram、Figma、Framer 或 Notion。如果使用平台集成，请先连接你的账户（如果尚未连接）。

3

Configure Delivery

填写集成所需的字段。例如，GitHub 会要求填写仓库和权限级别，Discord 会要求填写服务器和可选角色，License Key 会要求填写激活次数限制和 License 时长。

4

Save

点击 Create Entitlement。现在你可以将该权益附加到任意产品。

​

将权益附加到产品

​

客户体验

​

Email 和 Customer Portal

​

基于 OAuth 的交付

​

撤销

​

管理授予记录

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'],
});

// List grants for an entitlement
const grants = await client.entitlements.grants.list('ent_abc123', {
  status: 'Delivered',
});

// Revoke a single grant
await client.entitlements.grants.revoke('entg_xyz789', {
  id: 'ent_abc123',
});

# Assumes client = DodoPayments(bearer_token=os.environ["DODO_PAYMENTS_API_KEY"])
grants = client.entitlements.grants.list(
    "ent_abc123",
    status="Delivered",
)

client.entitlements.grants.revoke(
    "entg_xyz789",
    id="ent_abc123",
)

// Assumes client := dodopayments.NewClient() and ctx := context.Background().
grants, err := client.Entitlements.Grants.List(
  ctx, "ent_abc123",
  dodopayments.EntitlementGrantListParams{
    Status: dodopayments.F(dodopayments.EntitlementGrantListParamsStatusDelivered),
  },
)
if err != nil {
  panic(err.Error())
}
fmt.Println(len(grants.Items))

_, err = client.Entitlements.Grants.Revoke(ctx, "ent_abc123", "entg_xyz789")

​

API 管理

​

Webhooks

​

最佳实践

• 每个交付渠道使用一项权益。 不要在具有不同角色意图的多个产品之间共享同一项 Discord 权益。请为每个角色创建一项权益，以便干净地撤销访问权限。
• 先在测试模式中进行测试。 创建权益，将其附加到测试产品，完成一次结账，并观察授予记录从 Pending 变为 Delivered。然后取消测试订阅，并确认授予记录已被撤销。
• 监听 entitlement_grant.delivered，而不是 payment.succeeded。 付款可能在履行完成前成功，尤其是在 OAuth 流程中。请等待授予记录达到 Delivered 后，再在自己的系统中解锁依赖功能。创建时即完成交付的授予记录，例如自动履行的 License Key 或 Feature Flag，会以 entitlement_grant.created 事件和 status: "Delivered" 状态到达。
• 将 entitlement_grant.failed 视为需要采取行动的事件。 授予记录失败意味着客户已经付款，但尚未获得访问权限。请将这些授予记录展示给支持团队，或触发重新签发。
• 将 revocation_reason 映射到你的留存流程。 subscription_on_hold 撤销是可恢复的，因为客户可能会更新其银行卡。manual 撤销则是有意执行的。在客户消息中应区别处理这两种情况。
• 不要在 subscription.past_due 时撤销访问权限。 该事件会开启宽限期，客户会一直保留访问权限，直到窗口结束。请等待 subscription.on_hold 或 subscription.cancelled。