Activate License

This endpoint allows you to activate a license for the user.

POST /licenses/activate

JavaScript

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 response = await client.licenses.activate({ license_key: 'license_key', name: 'name' });

console.log(response.id);

201

{
  "business_id": "<string>",
  "created_at": "2024-01-01T00:00:00Z",
  "customer": {
    "customer_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "metadata": {},
    "phone_number": "<string>"
  },
  "id": "lki_123",
  "license_key_id": "lic_123",
  "name": "Production Server 1",
  "product": {
    "product_id": "<string>",
    "name": "<string>"
  }
}

No API Key Required: This is a public endpoint that does not require authentication. You can call it directly from client applications, desktop software, or CLIs to activate license keys without exposing your API credentials.

Body

application/json

license_key · string · required

name · string · required

Response

201

application/json

License key instance created

business_id · string · required

Business ID

created_at · string<date-time> · required

Creation timestamp

Example:

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

customer · object · required

Limited customer details associated with the license key.

Show child attributes

id · string · required

License key instance ID

Example:

"lki_123"

license_key_id · string · required

Associated license key ID

Example:

"lic_123"

name · string · required

Instance name

Example:

"Production Server 1"

product · object · required

Related product info. Present if the license key is tied to a product.

Show child attributes