導入

​

Entitlementsとは？

​

利用可能な統合

​

権利のしくみ

​

権利のライフサイクル

​

イベントごとのGrantの動作

​

最初のEntitlementを作成する

1

Open Entitlements

ダッシュボードでEntitlementsに移動し、**+**をクリックしてentitlementを作成します。

2

Pick an Integration

integrationの種類として、License Key、Digital Files、Feature Flag、Discord、GitHub、Telegram、Figma、Framer、またはNotionを選択します。プラットフォームintegrationの場合、まだ接続していなければ、先にアカウントを接続してください。

3

Configure Delivery

integrationのフィールドに入力します。たとえばGitHubではリポジトリと権限レベル、Discordではサーバーと任意のロール、License Keyではアクティベーション数の上限とライセンス期間を指定します。

4

Save

Create Entitlementをクリックします。これで、任意の商品にentitlementを紐付けられます。

​

Entitlementsを商品に紐付ける

​

顧客体験

​

EmailとCustomer Portal

​

OAuthベースの提供

​

取り消し

​

Grantを管理する

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

​

ベストプラクティス

• 提供チャネルごとに1つのentitlementを使用する。 異なるロール目的を持つ商品間で、1つのDiscord entitlementを共有しないでください。取り消しを適切に行えるよう、ロールごとに1つのentitlementを作成します。
• まずtest modeでテストする。 Entitlementを作成し、テスト商品に紐付け、checkoutを実行して、grantがPendingからDeliveredへ移行することを確認します。その後、テストサブスクリプションをキャンセルし、grantが取り消されることを確認します。
• payment.succeededではなくentitlement_grant.deliveredをリッスンする。 特にOAuthフローでは、fulfillmentが完了する前に支払いが成功することがあります。独自システムで依存するfeatureのロックを解除する前に、grantがDeliveredになるまで待ってください。自動fulfillされたライセンスキーやfeature flagなど、作成時に提供されるgrantは、代わりにentitlement_grant.createdとstatus: "Delivered"として届きます。
• entitlement_grant.failedを対応が必要なイベントとして扱う。 Grantの失敗は、顧客が支払ったにもかかわらずアクセスできていないことを意味します。これらのgrantをサポートチームに通知するか、再発行をトリガーしてください。
• revocation_reasonをretentionフローにマッピングする。 subscription_on_holdによるrevokeは、顧客がカードを更新できるため復旧可能です。manualによるrevokeは意図的なものです。顧客へのメッセージでは、これらを区別して扱ってください。
• subscription.past_dueでアクセスを取り消さない。 このイベントはgrace periodを開始し、期間が終了するまで顧客はアクセスを維持します。subscription.on_holdまたはsubscription.cancelledを待ってください。