License Keys

​

ライセンスキーとは？

• Software licensing：desktop apps、plugins、CLI。
• Per-seat controls：user または device ごとのアクティベーション数の制限。
• Digital goods：downloads、updates、premium features へのアクセス制御。

​

License Key Entitlementを作成する

1

Open Entitlements

dashboard の Entitlements に移動し、+ をクリックして entitlement を作成します。

2

Choose License Key

License Keys を選択して Name を入力し、発行する各キーの動作を設定します。

• Fulfillment Mode：Automatic（デフォルト）では各キーを生成してメールで送信します。Manual ではキーを自分で指定できます。Manual Fulfillment を参照してください。
• Activations Limit：キーごとのアクティブなアクティベーションの最大数です。たとえば、単一 user には 1、team license には 5 を指定します。制限しない場合は Unlimited を選択します。
• License Length：発行後にキーが有効である期間です。30 days や 1 year、または No expiration を指定できます。subscription products では No expiration を選択してください。subscription 用に発行されたキーには有効期限がなく、subscription status に従って有効性が決まります。
• Activation Message：任意の customer-facing instructions です。最大2,500文字で、キーを届けるメールに含められます。例：Paste the key in Settings → License または Run: mycli activate <key>。

3

Save the Entitlement

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

​

Productsに紐付ける

​

Keysの発行方法

​

Quantity Behavior

• Subscription products は seat ごとに1つのキー（subscriptions.quantity）を発行します。
• One-time products は cart line item の unit ごとに1つのキー（product_cart.quantity）を発行します。
• Manual API grants は必ず1つのキーを発行します。

​

Fulfillment Mode

• auto（デフォルト。dashboard では Automatic）：Dodo Payments が payment または subscription の発生時にキーを生成してメールで送信します。これは上の表に示した動作で、fulfillment_mode を省略した場合に適用されます。
• manual（dashboard では Manual）：購入された各 unit に対して、キーのない Pending grant が作成され、各キーの値を自分で指定します。Manual Fulfillment を参照してください。

​

Manual Fulfillment

​

When to Use It

• Bring your own keys：application、desktop product、または独自の license server がキーを生成する場合。
• Third-party vendors：game key、API credential、partner platform license など、upstream provider が発行したキーを再販売する場合。
• Finite inventory：事前に割り当てた pool からコードを1つずつ配布する場合。
• Human review：アクセスを提供する前に購入を確認したい場合。

​

Enable Manual Fulfillment

// `client` is a DodoPayments instance created with your API key.
const entitlement = await client.entitlements.create({
  name: 'Pro License (Manual)',
  integration_type: 'license_key',
  integration_config: {
    fulfillment_mode: 'manual',
    activations_limit: 5,
    duration_count: 1,
    duration_interval: 'Year',
  },
});

curl -X POST https://test.dodopayments.com/entitlements \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pro License (Manual)",
    "integration_type": "license_key",
    "integration_config": {
      "fulfillment_mode": "manual",
      "activations_limit": 5,
      "duration_count": 1,
      "duration_interval": "Year"
    }
  }'

​

Find Grants Awaiting Fulfillment

const pending = await client.customers.listEntitlementGrants('cus_abc123', {
  integration_type: 'license_key',
  status: 'Pending',
});

​

Deliver the Key

curl -X POST https://test.dodopayments.com/grants/entg_8VbC6JDZ/license-key \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "PRO-AAAA-BBBB-CCCC-DDDD",
    "activations_limit": 5,
    "expires_at": "2027-05-01T00:00:00Z"
  }'

​

Activation, Validation, Deactivation

​

Activate a License

import DodoPayments from 'dodopayments';

// The license endpoints don't check the token, but the SDK requires a value.
// Never ship your secret API key in client software.
const client = new DodoPayments({ bearerToken: 'public', environment: 'test_mode' });

const response = await client.licenses.activate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
  name: 'Device Name',
});

console.log(response.id);

from dodopayments import DodoPayments

# The license endpoints don't check the token, but the SDK requires a value.
client = DodoPayments(bearer_token="public", environment="test_mode")

response = client.licenses.activate(
    license_key="PRO-AAAA-BBBB-CCCC-DDDD",
    name="Device Name",
)
print(response.id)

curl -X POST https://test.dodopayments.com/licenses/activate \
  -H "Content-Type: application/json" \
  -d '{
    "license_key": "PRO-AAAA-BBBB-CCCC-DDDD",
    "name": "Device Name"
  }'

​

Validate a License

// Uses the client from the activation example.
const response = await client.licenses.validate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
});

console.log(response.valid);

curl -X POST https://test.dodopayments.com/licenses/validate \
  -H "Content-Type: application/json" \
  -d '{ "license_key": "PRO-AAAA-BBBB-CCCC-DDDD" }'

​

Deactivate an Activation Instance

await client.licenses.deactivate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
  license_key_instance_id: 'lki_abc123',
});

​

Manage Keys

const grants = await client.entitlements.grants.list('ent_license_key_id', {
  status: 'Delivered',
});

for (const grant of grants.items) {
  console.log(grant.license_key?.key, grant.license_key?.activations_used);
}

​

Import Existing License Keys via API

const licenseKey = await client.licenseKeys.create({
  customer_id: 'cus_abc123',
  product_id: 'pdt_456',
  key: 'YOUR-EXISTING-LICENSE-KEY',
  activations_limit: 5,
  expires_at: '2026-12-31T23:59:59Z',
});

​

How Keys Differ by Source

​

License Keys in Return URL

https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001&email=customer%40example.com

https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001%2CLK-002&email=customer%40example.com

https://yoursite.com/return?subscription_id=sub_xxx&status=active&license_key=LK-001&email=customer%40example.com

​

API Management

​

Webhooks

​

Legacy License Keys

​

Best Practices

• 明確な activation limits を選択する：single-user apps には1、team licenses には3〜5などの default を選び、customer 向けに説明してください。
• 正確な activation messages を記述する：customer は license key email からコピーするため、正確な paths と commands を記載すると support tickets を防げます。
• API に対してキーを validate する：network-connected products では、local に cached された activation に依存せず /licenses/validate を呼び出してください。
• revoke には webhooks を使用する：customer が cancel または refund を受けたときに、entitlement_grant.revoked を処理して in-app features を無効化してください。
• subscriptions と one-time purchases をテストする：両者では license key の動作が異なります。たとえば subscription keys には有効期限がありません。本番稼働前に両方をテストしてください。