List Licenses

Retrieve a list of license keys associated with your account.

GET /license_keys

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
});

// Automatically fetches more pages as needed.
for await (const licenseKey of client.licenseKeys.list()) {
  console.log(licenseKey.id);
}

200

{
  "items": [
    {
      "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>",
      "activations_limit": 5,
      "expires_at": "2024-12-31T23:59:59Z",
      "payment_id": "<string>",
      "subscription_id": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

page_size · integer<int32>

Page size default is 10 max is 100

Required range: x >= 0

page_number · integer<int32>

Page number default is 0

Required range: x >= 0

customer_id · string

Filter by customer ID

status · enum<string>

Filter by license key status

Available options: active, expired, disabled

product_id · string

Filter by product ID

created_at_gte · string<date-time>

Filter license keys created on or after this timestamp

created_at_lte · string<date-time>

Filter license keys created on or before this timestamp

source · enum<string>

Filter by license key source

Available options: auto, import

Response

200

application/json

items · object[] · required

Show child attributes