Chuyển đến nội dung chính
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>"
}
Các khóa giấy phép được tạo hoặc cập nhật thông qua API không kích hoạt thông báo email tới khách hàng. Nếu bạn cần thông báo cho khách hàng về khóa giấy phép của họ, bạn phải xử lý điều đó riêng biệt trong ứng dụng của mình.

Ủy quyền

​
Authorization
string
header
bắt buộc

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

Nội dung

application/json
​
customer_id
string
bắt buộc

The customer this license key belongs to.

​
key
string
bắt buộc

The license key string to import.

​
product_id
string
bắt buộc

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.

Phản hồi

License key created

​
business_id
string
bắt buộc

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

​
created_at
string<date-time>
bắt buộc

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

Ví dụ:

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

​
customer_id
string
bắt buộc

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

Ví dụ:

"cus_123"

​
id
string
bắt buộc

The unique identifier of the license key.

Ví dụ:

"lic_123"

​
instances_count
integer<int32>
bắt buộc

The current number of instances activated for this license key.

​
key
string
bắt buộc

The license key string.

​
product_id
string
bắt buộc

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

​
source
enum<string>
bắt buộc

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

Tùy chọn có sẵn:
auto,
import
​
status
enum<string>
bắt buộc

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

Tùy chọn có sẵn:
active,
expired,
disabled
​
activations_limit
integer<int32> | null

The maximum number of activations allowed for this license key.

Ví dụ:

5

​
expires_at
string<date-time> | null

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

Ví dụ:

"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