Passer au contenu principal
PATCH
JavaScript

Autorisations

Authorization
string
header
requis

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.

Paramètres de chemin

id
string
requis

Entitlement ID

Corps

application/json
description
string | null
integration_config
Feature Flag Config · object

Integration-specific configuration supplied when creating or updating an entitlement. The shape required matches the entitlement's integration_type.

Untagged enum: variants are matched in order. FeatureFlag must precede LicenseKey, whose fields are all optional and would otherwise match a feature_flag config.

metadata
null | Metadata · object

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

name
string | null

Réponse

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

business_id
string
requis

Identifier of the business that owns this entitlement.

created_at
string<date-time>
requis

Timestamp when the entitlement was created.

id
string
requis

Unique identifier of the entitlement.

integration_config
Feature Flag Config · object
requis

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

integration_type
enum<string>
requis

Platform integration this entitlement uses.

Options disponibles:
discord,
telegram,
github,
figma,
framer,
notion,
digital_files,
license_key,
feature_flag
is_active
boolean
requis

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

metadata
Metadata · object
requis

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

name
string
requis

Display name supplied at creation.

updated_at
string<date-time>
requis

Timestamp when the entitlement was last modified.

description
string | null

Optional description supplied at creation.

Dernière modification le 13 mai 2026