List Entitlements

List all entitlements for your business with optional filtering by integration type.

GET /entitlements

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

200

{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "integration_config": {
        "target_id": "<string>"
      },
      "is_active": true,
      "metadata": {},
      "name": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<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 10, max 100)

Required range: x >= 0

page_number · integer<int32>

Page number (default 0)

Required range: x >= 0

integration_type · enum<string>

Filter by integration type

Available options: discord, telegram, github, figma, framer, notion, digital_files, license_key

Response

200

application/json

items · object[] · required

Show child attributes