Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Send your API key as a bearer token: Authorization: Bearer <api_key>. A test mode key starts with dodo_test_, for example dodo_test_AbCd1234EfGh5678.<secret>. A live mode key starts with dodo_live_. Use a test mode key on test.dodopayments.com and a live mode key on live.dodopayments.com. Keys from before these tags have no tag and operate as before.

Body

application/json
integration_config
Feature Flag Config · object
required

Platform-specific configuration (validated per integration_type)

integration_type
enum<string>
required

Which platform integration this entitlement uses

Available options:
discord,
telegram,
github,
figma,
framer,
notion,
digital_files,
license_key,
feature_flag
name
string
required

Display name for this entitlement

description
string | null

Optional description

metadata
Metadata · object

Additional metadata for the entitlement

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
Feature Flag 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,
feature_flag
is_active
boolean
required

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

metadata
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 August 5, 2026