PATCH
/
license_keys
/
{id}
import DodoPayments from 'dodopayments';

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

async function main() {
  const licenseKey = await client.licenseKeys.update('lic_123');

  console.log(licenseKey.id);
}

main();
{
  "activations_limit": 5,
  "business_id": "<string>",
  "created_at": "2024-01-01T00:00:00Z",
  "customer_id": "cus_123",
  "expires_at": "2024-12-31T23:59:59Z",
  "id": "lic_123",
  "instances_count": 123,
  "key": "<string>",
  "payment_id": "<string>",
  "product_id": "<string>",
  "status": "active",
  "subscription_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

License key ID

Body

application/json
​
activations_limit
integer | null

The updated activation limit for the license key. Use null to remove the limit, or omit this field to leave it unchanged.

​
disabled
boolean | null

Indicates whether the license key should be disabled. A value of true disables the key, while false enables it. Omit this field to leave it unchanged.

​
expires_at
string | null

The updated expiration timestamp for the license key in UTC. Use null to remove the expiration date, or omit this field to leave it unchanged.

Response

200
application/json
License key updated successfully
​
business_id
string
required

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

​
created_at
string
required

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

Example:

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

​
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
required

The current number of instances activated for this license key.

​
key
string
required

The license key string.

​
payment_id
string
required

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

​
product_id
string
required

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

​
status
enum<string>
required
Available options:
active,
expired,
disabled
​
activations_limit
integer | null

The maximum number of activations allowed for this license key.

Example:

5

​
expires_at
string | null

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

Example:

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

​
subscription_id
string | null

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