Discord Entitlement

What Gets Delivered

• The customer connects their Discord account from the Customer Portal. The payment confirmation email marks the entitlement Action Required and links to the portal.
• After they authorize, the Dodo Payments bot adds them to your server, or finds their existing membership, and assigns the role you configured.
• If you don’t pick a role, the customer gets server membership only.

Connect Discord

1

Open Entitlements

In the Dodo Payments dashboard, go to Entitlements and click + to start a new entitlement.

2

Pick Discord

Choose Discord Access as the integration. If Discord isn’t connected for your business yet, click Connect Discord.

Discord opens in a new tab. Sign in, pick the server you want to gate, and approve the bot’s permissions on that server: Manage Roles, Kick Members, and Create Invite.

When Discord redirects back, a confirmation page shows that the server is connected.

3

Pick a Server and Role

Back in the dashboard, select the Server you connected. To assign a role on delivery, select it under Role. To grant server membership only, leave Role set to No specific role. Enter a Name for the entitlement and click Create Entitlement.

4

Attach It to a Product

The entitlement is saved and available to attach to any product. See Attach Entitlements to Products.

Customer Flow

1. 顧客がチェックアウトを完了します。
2. Dodo Payments が Pending ステータスの grant を作成します。Dodo Payments はすぐに Discord authorization URL の作成を試み、それを oauth_url に保存します。失敗した場合、顧客が accept flow を開始するまで、oauth_url は null のままです。
3. 支払い確認メールには entitlement が Action Required として記載され、Customer Portal へのリンクが含まれます。ポータルで、顧客は entitlement の Connect をクリックします。
4. 顧客が Discord 上で Dodo Payments を認証します。bot が顧客を server に追加して設定済みの role を割り当て、grant が Delivered に移行します。
5. grant が取り消されると（subscription がキャンセル、一時停止、保留、または期限切れになった場合、one-time payment が返金された場合、またはお客様が grant を取り消した場合）、bot は role を削除し、顧客を server から削除します。grant は Revoked に移行します。

Required Configuration

Create via API

import DodoPayments from 'dodopayments';

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

const entitlement = await client.entitlements.create({
  name: 'Patrons Discord Role',
  integration_type: 'discord',
  integration_config: {
    guild_id: '123456789012345678',
    role_id: '987654321098765432',
  },
});

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",
)

entitlement = client.entitlements.create(
    name="Patrons Discord Role",
    integration_type="discord",
    integration_config={
        "guild_id": "123456789012345678",
        "role_id": "987654321098765432",
    },
)

// client is a *dodopayments.Client, for example from
// dodopayments.NewClient(option.WithEnvironmentTestMode()); ctx is a context.Context.
client.Entitlements.New(ctx, dodopayments.EntitlementNewParams{
  Name:            dodopayments.F("Patrons Discord Role"),
  IntegrationType: dodopayments.F(dodopayments.EntitlementIntegrationTypeDiscord),
  IntegrationConfig: dodopayments.F[dodopayments.IntegrationConfigUnionParam](
    dodopayments.IntegrationConfigDiscordConfigParam{
      GuildID: dodopayments.F("123456789012345678"),
      RoleID:  dodopayments.F("987654321098765432"),
    },
  ),
})

Webhooks

• entitlement_grant.created が status: "Pending" とともに発火します。oauth_url には、すでに authorization URL が含まれている場合があります。null の場合、顧客が Customer Portal から accept flow を開始すると値が設定されます。
• 顧客が server に参加し、role が割り当てられると、entitlement_grant.delivered が発火します。
• role が削除され、顧客が server から削除されると、entitlement_grant.revoked が発火します。

Troubleshooting