License Keys

​

License Keysとは？

• ソフトウェアライセンス: Desktop apps、plugins、CLIs
• seat単位の制御: userまたはdeviceごとのactivationを制限
• デジタル商品: downloads、updates、premium featuresへのアクセスを制御

​

License Key Entitlementを作成する

1

Open Entitlements

Dodo Payments dashboardでEntitlementsに移動し、**+**をクリックして新しいentitlementを作成します。

2

Choose License Key

integrationとしてLicense Keyを選択します。発行される各keyの動作を設定します。

• Activations Limit: keyごとの同時activationの最大数（例: 1ユーザーの場合は1、team licensesの場合は5、無制限の場合は空欄）。
• Duration: 発行後にkeyが有効である期間（例: 30日、1年）。subscription-issued keysでは空欄にします。subscriptionがactiveである限り、keysは有効です。
• Activation Instructions: keyとともにemailで送信される、customer向けの手順。例: Paste the key in Settings → LicenseまたはRun: mycli activate <key>。

3

Save the entitlement

保存します。entitlementを任意のproductに紐付けられるようになりました。

​

Productsに紐付ける

​

Keysの発行方法

​

Quantityの動作

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

​

Fulfillment mode

• auto（デフォルト）：Dodo Payments は、支払いまたはサブスクリプションの時点でキーを自動的に生成し、メールで送信します。これは上記で説明した動作であり、fulfillment_mode が省略された場合に適用されます。
• manual：購入によってキーなしの Pending grant が作成され、各キーの値は自分で指定します。詳しくは、以下の Manual Fulfillment を参照してください。

​

Manual Fulfillment

​

使用するタイミング

• Bring-your-own-keys: keyはapplication、desktop product、または自社のlicense serverによって生成されます。
• Third-party vendors: upstream providerが発行したkeys（game key、API credential、partner platform）を再販売します。
• Finite inventory: 事前に割り当てたpoolからcodeを1つずつ配布します。
• Human review: accessを提供する前に購入を審査します。

​

Manual fulfillmentを有効にする

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"
    }
  }'

​

Fulfillment待ちのgrantsを見つける

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

​

Keyを配信する

curl -X POST https://test.dodopayments.com/grants/grant_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

​

Licenseをactivateする

import DodoPayments from 'dodopayments';

// No API key needed for public license endpoints
const client = new DodoPayments();

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

console.log(response.id);

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

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"
  }'

​

Licenseをvalidateする

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" }'

​

Activation instanceをdeactivateする

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

​

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);
}

​

API経由で既存のLicense Keysをimportする

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',
});

​

Sourceによるkeysの違い

​

Return URLのLicense Keys

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,LK-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 limit を明確にする: 適切なデフォルト値（single-user app では 1、team license では 3～5）を選択し、文書化してください。
• 正確な activation instructions を提供する: 顧客はメールからこれらを貼り付けるため、正確な path と command によって support ticket を減らせます。
• server-side でキーを validate する: network-connected product では、activation をローカルに cache するのではなく、/licenses/validate を使用して validate してください。
• revoke には webhooks を使用する: 顧客が cancel または refund したときに in-app feature を直ちに無効化できるよう、entitlement_grant.revoked を listen してください。
• subscription と one-time でテストする: License Key の動作はこの 2 つで微妙に異なるため、live にする前に両方をテストしてください。