跳转到主要内容
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>"
}
通过API创建或更新的许可证密钥不会触发向客户发送电子邮件通知。如果需要通知客户他们的许可证密钥，必须在应用程序中单独处理。

授权

​
Authorization
string
header
必填

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

请求体

application/json
​
customer_id
string
必填

The customer this license key belongs to.

​
key
string
必填

The license key string to import.

​
product_id
string
必填

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.

响应

License key created

​
business_id
string
必填

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

​
created_at
string<date-time>
必填

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

示例:

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

​
customer_id
string
必填

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

示例:

"cus_123"

​
id
string
必填

The unique identifier of the license key.

示例:

"lic_123"

​
instances_count
integer<int32>
必填

The current number of instances activated for this license key.

​
key
string
必填

The license key string.

​
product_id
string
必填

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

​
source
enum<string>
必填

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

可用选项:
auto,
import
​
status
enum<string>
必填

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

可用选项:
active,
expired,
disabled
​
activations_limit
integer<int32> | null

The maximum number of activations allowed for this license key.

示例:

5

​
expires_at
string<date-time> | null

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

示例:

"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