Skip to main content
GET
/
entitlements
/
{id}
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 entitlement = await client.entitlements.retrieve('id');

console.log(entitlement.id);
{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "integration_config": {
    "permission": "pull",
    "target_id": "<string>"
  },
  "integration_type": "discord",
  "is_active": true,
  "metadata": {},
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Entitlement ID

Response

Detailed view of a single entitlement: identity, integration type, integration-specific configuration, and metadata.

business_id
string
required

Identifier of the business that owns this entitlement.

created_at
string<date-time>
required

Timestamp when the entitlement was created.

id
string
required

Unique identifier of the entitlement.

integration_config
Github Config · object
required

Integration-specific configuration. For digital_files entitlements this includes presigned download URLs for each attached file.

integration_type
enum<string>
required

Platform integration this entitlement uses.

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

Always true for entitlements returned by the public API; soft-deleted entitlements are not returned.

metadata
object
required

Arbitrary key-value metadata supplied at creation or via PATCH.

name
string
required

Display name supplied at creation.

updated_at
string<date-time>
required

Timestamp when the entitlement was last modified.

description
string | null

Optional description supplied at creation.

Last modified on May 6, 2026