Passer au contenu principal
POST
/
license_keys
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const licenseKey = await client.licenseKeys.create({
  customer_id: 'customer_id',
  key: 'key',
  product_id: 'product_id',
});

console.log(licenseKey.id);
{
  "business_id": "<string>",
  "created_at": "2024-01-01T00:00:00Z",
  "customer_id": "cus_123",
  "id": "lic_123",
  "instances_count": 123,
  "key": "<string>",
  "product_id": "<string>",
  "source": "auto",
  "status": "active",
  "activations_limit": 5,
  "expires_at": "2024-12-31T23:59:59Z",
  "payment_id": "<string>",
  "subscription_id": "<string>"
}
Les clés de licence créées ou mises à jour via l’API ne déclenchent pas de notifications par email aux clients. Si vous devez informer les clients de leur clé de licence, vous devez le gérer séparément dans votre application.

Autorisations

​
Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corps

application/json
​
customer_id
string
requis

The customer this license key belongs to.

​
key
string
requis

The license key string to import.

​
product_id
string
requis

The product this license key is for.

​
activations_limit
integer<int32> | null

Maximum number of activations allowed. Null means unlimited.

​
expires_at
string<date-time> | null

Expiration timestamp. Null means the key never expires.

Réponse

License key created

​
business_id
string
requis

The unique identifier of the business associated with the license key.

​
created_at
string<date-time>
requis

The timestamp indicating when the license key was created, in UTC.

Exemple:

"2024-01-01T00:00:00Z"

​
customer_id
string
requis

The unique identifier of the customer associated with the license key.

Exemple:

"cus_123"

​
id
string
requis

The unique identifier of the license key.

Exemple:

"lic_123"

​
instances_count
integer<int32>
requis

The current number of instances activated for this license key.

​
key
string
requis

The license key string.

​
product_id
string
requis

The unique identifier of the product associated with the license key.

​
source
enum<string>
requis

The source of the license key - 'auto' for keys generated by payment/subscription flows, 'import' for merchant-imported keys.

Options disponibles:
auto,
import
​
status
enum<string>
requis

The current status of the license key (e.g., active, inactive, expired).

Options disponibles:
active,
expired,
disabled
​
activations_limit
integer<int32> | null

The maximum number of activations allowed for this license key.

Exemple:

5

​
expires_at
string<date-time> | null

The timestamp indicating when the license key expires, in UTC.

Exemple:

"2024-12-31T23:59:59Z"

​
payment_id
string | null

The unique identifier of the payment associated with the license key, if any.

​
subscription_id
string | null

The unique identifier of the subscription associated with the license key, if any.

Last modified on April 20, 2026