License Keys

​

What are License Keys?

• Software licensing: Desktop apps, plugins, and CLIs
• Per-seat controls: Limit activations per user or device
• Digital goods: Gate downloads, updates, or premium features

​

Create a License Key Entitlement

1

Open Entitlements

Go to Entitlements in your Dodo Payments dashboard and click + to create a new entitlement.

2

Choose License Key

Select License Key as the integration. Configure how each issued key behaves:

• Activations Limit: Maximum concurrent activations per key (e.g., 1 for single-user, 5 for team licenses, leave blank for unlimited).
• Duration: How long the key stays valid after issuance (e.g., 30 days, 1 year). For subscription-issued keys, leave blank; keys remain valid as long as the subscription is active.
• Activation Instructions: Customer-facing instructions emailed with the key. Examples: Paste the key in Settings → License or Run: mycli activate <key>.

3

Save the entitlement

Save. The entitlement is now available to attach to any product.

​

Attach to Products

​

How Keys Are Issued

​

Quantity behavior

• Subscription products issue one key per seat (subscriptions.quantity).
• One-time products issue one key per cart line item (product_cart.quantity).
• Manual API grants issue exactly one key.

​

Fulfillment mode

• auto (default): Dodo Payments generates and emails the key automatically on payment or subscription. This is the behavior described above and applies when fulfillment_mode is omitted.
• manual: The purchase creates a Pending grant with no key, and you supply each key value yourself. See Manual Fulfillment below.

​

Manual Fulfillment

​

When to use it

• Bring-your-own-keys: The key is generated by your application, a desktop product, or your own license server.
• Third-party vendors: You resell keys issued by an upstream provider (a game key, an API credential, a partner platform).
• Finite inventory: You hand out codes from a pre-allocated pool and want to assign them one at a time.
• Human review: You want to vet a purchase before releasing access.

​

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

​

Find grants awaiting fulfillment

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

​

Deliver the 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

​

Activate a license

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

​

Validate a license

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: 'instance_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,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

​

License Key Lama

​

Praktik Terbaik

• Tetapkan batas aktivasi dengan jelas: Pilih default yang wajar (1 untuk aplikasi satu pengguna, 3–5 untuk lisensi tim) dan dokumentasikan.
• Berikan instruksi aktivasi yang tepat: Pelanggan menyalin instruksi ini dari email mereka, sehingga path dan command yang tepat dapat mengurangi tiket dukungan.
• Validasi key di sisi server: Untuk produk yang terhubung ke jaringan, lakukan validasi melalui /licenses/validate, bukan dengan menyimpan aktivasi secara lokal.
• Gunakan webhook untuk pencabutan: Dengarkan entitlement_grant.revoked untuk segera menonaktifkan fitur dalam aplikasi saat pelanggan membatalkan atau meminta refund.
• Uji dengan langganan dan pembelian one-time: Perilaku license key sedikit berbeda di antara keduanya, jadi uji keduanya sebelum ditayangkan.