GitHub Entitlement

​

What gets delivered

• The customer is invited to your GitHub repository through an OAuth flow that links their GitHub account to the purchase.
• Once they accept, GitHub grants them collaborator access at the configured permission level.
• Cancellation, refund, or manual revoke removes the collaborator.

​

Connect GitHub

1

Open Entitlements

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

2

Pick GitHub

Choose GitHub Access as the integration. If GitHub is not yet connected, you’ll be prompted to Connect GitHub.

Clicking through opens GitHub in a new tab. Sign in, then install the Dodo Payments GitHub App on the organization or user account that owns the repository. You can grant access to all repositories or only the ones you intend to gate.

When GitHub redirects back, you’ll see a confirmation that the account is connected.

3

Pick a repository and permission

Back in the dashboard, choose the repository the entitlement should grant access to and pick the permission level. The repository picker only shows repositories the GitHub App has access to. Give the entitlement a name and click Create Entitlement.

4

Save the entitlement

Save and attach the entitlement to any product. Customers who buy that product receive a GitHub invite on delivery.

​

Permission levels

​

Customer flow

1. The customer completes checkout.
2. Dodo Payments creates a grant in pending status with an oauth_url for the customer to link their GitHub account.
3. The customer authorizes through the link in their email or customer portal.
4. Dodo Payments invites the customer’s GitHub account to the repository at the configured permission. The grant moves to delivered once the invitation is created.
5. If the subscription is cancelled, refunded, or revoked, the customer is removed as a collaborator.

​

Required configuration

​

Create via API

const entitlement = await client.entitlements.create({
  name: 'Code Share Repository',
  integration_type: 'github',
  integration_config: {
    target_id: 'acme/private-sdk',
    permission: 'pull',
  },
});

client.entitlements.create(
    name="Code Share Repository",
    integration_type="github",
    integration_config={
        "target_id": "acme/private-sdk",
        "permission": "pull",
    },
)

client.Entitlements.New(ctx, dodopayments.EntitlementNewParams{
  Name:            dodopayments.F("Code Share Repository"),
  IntegrationType: dodopayments.F(dodopayments.EntitlementIntegrationTypeGithub),
  IntegrationConfig: dodopayments.F[dodopayments.IntegrationConfigUnionParam](
    dodopayments.IntegrationConfigGitHubConfigParam{
      TargetID:   dodopayments.F("acme/private-sdk"),
      Permission: dodopayments.F("pull"),
    },
  ),
})

​

Webhooks

• entitlement_grant.created includes the oauth_url for GitHub authorization.
• entitlement_grant.delivered fires once the collaborator invitation is created.
• entitlement_grant.failed fires with error_code: "github_permission_denied" (or similar) if the GitHub App lost access to the repository.

​

Troubleshooting