ライセンスキー

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

​

ライセンスキーとは？

• ソフトウェアライセンス: デスクトップアプリ、プラグイン、CLI
• ユーザーごとの制御: ユーザーまたはデバイスごとのアクティベーションを制限
• デジタル商品: ダウンロード、アップデート、またはプレミアム機能へのゲート

​

ライセンスキー エンタイトルメントを作成する

• アクティベーション制限: 各キーの同時アクティベーションの最大数（例：インライン コード プレースホルダー_34017f417f799e97_ENDはシングルユーザー用、インライン コード プレースホルダー_d076e478fa8eeef5_ENDはチームライセンス用、無制限の場合は空白のままにします）。
• 有効期間: 発行後のキーの有効期間（例：30日間、1年間）。サブスクリプション発行のキーに対しては空白のままにします。サブスクリプションがアクティブな限りキーは有効です。
• アクティベーション指示: キーと共にメールで送信される顧客向け指示。例：インライン コード プレースホルダー_048b2931a6c30548_END または インライン コード プレースホルダー_2e1db75dd5d7aead_END。

​

商品に添付する

​

キーの発行方法

​

数量の動作

• サブスクリプション製品は、シートごとに1つのキーを発行します（インライン コード プレースホルダー_5dfde1e8c9098256_END）。
• 一回限りの製品は、カートのラインアイテムごとに1つのキーを発行します（インライン コード プレースホルダー_8efb560aef2090a3_END）。
• 手動API付与は正確に1つのキーを発行します。

​

アクティベーション、検証、非アクティブ化

​

ライセンスをアクティベートする

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

​

ライセンスを検証する

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

​

アクティベーションインスタンスを非アクティブ化する

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

​

キーを管理する

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経由でインポートする

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

​

インポートされたキーと自動生成されたキーの違い

​

リターン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,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管理

​

ウェブフック

​

レガシーライセンスキー

​

ベストプラクティス

• アクティベーション制限を明確に保つ: 合理的なデフォルトを選択（シングルユーザーアプリの場合は1、チームライセンスの場合は3～5）し、文書化します。
• 正確なアクティベーション指示を提供する: 顧客はこれをメールから貼り付けるため、正確なパスとコマンドがサポートチケットを節約します。
• サーバー側でキーを検証する: ネットワーク接続された製品に対しては、ローカルにアクティベーションをキャッシュするのではなく、インライン コード プレースホルダー_973c5559763fa09a_END を使用して検証します。
• ウェブフックを無効化に使用する: インライン コード プレースホルダー_87ada0578aa4a993_ENDをリッスンし、顧客がキャンセルまたは返金されるときにアプリ内機能を即座に無効化します。
• サブスクリプションと一回限りの試験を行う: ライセンスキーの動作は両者で微妙に異なるため、本稼働前に両方を試験します。
• Keep activation limits clear: Choose sensible defaults (1 for single-user apps, 3–5 for team licenses) and document them.
• Provide precise activation instructions: Customers paste these from their email, so exact paths and commands save support tickets.
• Validate keys server-side: For network-connected products, validate via /licenses/validate rather than caching activation locally.
• Use webhooks for revocation: Listen to entitlement_grant.revoked to disable in-app features immediately when a customer cancels or refunds.
• Test with subscriptions and one-times: License key behavior differs subtly between the two, so test both before going live.