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.

​

Mode de réalisation

• auto (par défaut) : Dodo Payments génère et envoie automatiquement la clé par e-mail lors du paiement ou de l’abonnement. C’est le comportement décrit ci-dessus et s’applique lorsque fulfillment_mode est omis.
• manual : L’achat crée une subvention pending sans clé, et vous fournissez vous-même chaque valeur de clé. Voir Réalisation manuelle ci-dessous.

​

Réalisation manuelle

​

Quand l’utiliser

• Utilisation de vos propres clés : La clé est générée par votre application, un produit de bureau ou votre propre serveur de licences.
• Fournisseurs tiers : Vous revendez des clés émises par un fournisseur en amont (une clé de jeu, une crédentielle API, une plateforme partenaire).
• Inventaire fini : Vous distribuez des codes à partir d’un pool pré-allocé et souhaitez les attribuer un par un.
• Examen humain : Vous souhaitez vérifier un achat avant de libérer l’accès.

​

Activer la réalisation manuelle

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

​

Trouver les subventions en attente de réalisation

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

​

Livrer la clé

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, Désactivation

​

Activer une licence

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

​

Valider une licence

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

console.log(response.valid);

​

Désactiver une instance d’activation

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

​

Gérer les clés

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

​

Importer des clés de licence existantes via l’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',
});

​

Comment les clés diffèrent selon la source

​

Clés de licence dans l’URL de retour

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

​

Gestion API

​

Webhooks

​

Clés de Licence Héritées

​

Meilleures Pratiques

• Gardez les limites d’activation claires : Choisissez des valeurs par défaut sensées (1 pour les applications à utilisateur unique, 3-5 pour les licences d’équipe) et documentez-les.
• Fournissez des instructions d’activation précises : Les clients copient ces informations depuis leur e-mail, donc des chemins et des commandes exacts réduisent les demandes d’assistance.
• Validez les clés côté serveur : Pour les produits connectés au réseau, validez via /licenses/validate plutôt qu’en mettant en cache l’activation localement.
• Utilisez les webhooks pour la révocation : Écoutez entitlement_grant.revoked pour désactiver les fonctionnalités de l’application immédiatement lorsqu’un client annule ou demande un remboursement.
• Testez avec des abonnements et des achats uniques : Le comportement des clés de licence diffère subtilement entre les deux, alors testez les deux avant de lancer.