Skip to main content
POST
JavaScript
This endpoint imports a key you already have — key, customer_id, and product_id are all required. It does not generate a key value for you. Importing a key that already exists returns 409 Conflict.
License keys created or updated through the API do not trigger email notifications to customers. If you need to notify customers about their license key, you must handle that separately in your application.

Authorizations

Authorization
string
header
required

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

Body

application/json
customer_id
string
required

The customer this license key belongs to.

key
string
required

The license key string to import.

product_id
string
required

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.

Response

License key created

brand_id
string
required

Brand id this license key belongs to

business_id
string
required

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

created_at
string<date-time>
required

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

Example:

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

customer_id
string
required

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

Example:

"cus_123"

id
string
required

The unique identifier of the license key.

Example:

"lic_123"

instances_count
integer<int32>
required

The current number of instances activated for this license key.

key
string
required

The license key string.

product_id
string
required

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

source
enum<string>
required

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

Available options:
auto,
import,
manual
status
enum<string>
required

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

Available options:
active,
expired,
disabled
activations_limit
integer<int32> | null

The maximum number of activations allowed for this license key.

Example:

5

expires_at
string<date-time> | null

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

Example:

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

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 July 29, 2026