Get License Key Instances

Retrieve a list of instances for a specific license key.

GET /license_key_instances

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 licenseKeyInstance of client.licenseKeyInstances.list()) {
  console.log(licenseKeyInstance.id);
}

200

{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2024-01-01T00:00:00Z",
      "id": "lki_123",
      "license_key_id": "lic_123",
      "name": "Production Server 1"
    }
  ]
}

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> | null

Page size default is 10 max is 100

Required range: x >= 0

page_number · integer<int32> | null

Page number default is 0

Required range: x >= 0

license_key_id · string | null

Filter by license key ID

grant_id · string | null

Filter instances by entitlement grant ID

Response

200

application/json

items · object[] · required

Show child attributes