GitHub Entitlement

​

What Gets Delivered

• The customer connects their GitHub account from the Customer Portal. This links their GitHub account to the purchase.
• Dodo Payments invites that account to your repository at the configured permission level. The customer gets access after they accept the invitation on GitHub. If the customer owns the repository, no invitation is needed.
• Cancellation, refund, or a manual revoke removes the collaborator and cancels any pending invitation.

​

Connect GitHub

1

Open Entitlements

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

2

Pick GitHub

Choose GitHub Access as the integration. If GitHub isn’t connected yet, click Connect GitHub.

GitHub opens 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 the app access to All repositories or Only select repositories. If you select repositories, include every repository you intend to gate.

When GitHub redirects back, a confirmation page shows that the account is connected.

3

Pick a Repository and Permission

Back in the dashboard, select the Repository the entitlement grants access to, then select the Permission level. The repository picker lists only repositories the GitHub App can access. Enter a Name for the entitlement and click Create Entitlement.

4

Attach It to a Product

Attach the entitlement to any product. Customers who buy that product receive a GitHub invitation after they connect their GitHub account.

​

Permission Levels

​

Customer Flow

1. 顧客がチェックアウトを完了します。
2. Dodo Payments は Pending ステータスで grant を作成します。Dodo Payments は直ちに GitHub authorization URL の作成を試み、oauth_url に保存します。失敗した場合、顧客が accept flow を開始するまで oauth_url は null のままです。
3. payment confirmation email には entitlement が Action Required として表示され、Customer Portal へのリンクが含まれます。ポータルで顧客が Connect をクリックし、GitHub で認証します。authorization link の有効期限は 30 分で、顧客が戻ってくると Customer Portal が新しいリンクを生成します。
4. Dodo Payments は、設定された permission で顧客の GitHub アカウントを repository に招待します。invitation が作成されると、grant は Delivered に移行します。GitHub が invitation を拒否した場合、grant は提供されません。
5. subscription がキャンセルされた場合、payment が返金された場合、または grant が取り消された場合、Dodo Payments は顧客を collaborator から削除し、保留中の invitation をキャンセルします。

​

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: 'Code Share Repository',
  integration_type: 'github',
  integration_config: {
    target_id: 'acme/private-sdk',
    permission: 'pull',
  },
});

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="Code Share Repository",
    integration_type="github",
    integration_config={
        "target_id": "acme/private-sdk",
        "permission": "pull",
    },
)

// 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("Code Share Repository"),
  IntegrationType: dodopayments.F(dodopayments.EntitlementIntegrationTypeGitHub),
  IntegrationConfig: dodopayments.F[dodopayments.IntegrationConfigUnionParam](
    dodopayments.IntegrationConfigGitHubConfigParam{
      TargetID:   dodopayments.F("acme/private-sdk"),
      Permission: dodopayments.F(dodopayments.GitHubPermissionPull),
    },
  ),
})

​

Webhooks

• entitlement_grant.created は status: "Pending" とともに発火します。oauth_url には、すでに GitHub authorization URL が格納されている場合があります。null の場合、顧客が Customer Portal から accept flow を開始すると値が設定されます。
• entitlement_grant.delivered は、collaborator invitation が作成されると発火します。
• entitlement_grant.revoked は、access が取り消されたときに発火します。GitHub App をアンインストールすると、Dodo Payments は revocation_reason: platform_external を使用して、その installation に関連する保留中および提供済みの grant を取り消します。
• Dodo Payments が顧客を repository に追加できない場合（たとえば、GitHub App が repository への access を失った場合）、entitlement_grant.failed は error_code: "GRANT_ACCESS_FAILED" とともに発火します。

​

Troubleshooting