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. The customer completes checkout.
2. Dodo Payments creates a grant in Pending status. Dodo Payments tries to create a Discord authorization URL right away and stores it in oauth_url. If that fails, oauth_url stays null until the customer starts the accept flow.
3. The payment confirmation email lists the entitlement as Action Required and links to the Customer Portal. In the portal, the customer clicks Connect on the entitlement.
4. The customer authorizes Dodo Payments on Discord. The bot adds them to the server and assigns the configured role, and the grant moves to Delivered.
5. When the grant is revoked (the subscription is cancelled, paused, put on hold, or expires, the one-time payment is refunded, or you revoke the grant), the bot removes the role and removes the customer from the server. The grant moves to 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 fires with status: "Pending". oauth_url may already hold the authorization URL. If it is null, it is populated once the customer starts the accept flow from the Customer Portal.
• entitlement_grant.delivered fires once the customer joins the server and the role is assigned.
• entitlement_grant.revoked fires when the role is removed and the customer is removed from the server.

​

Troubleshooting