Passer au contenu principal
GET
JavaScript
API obsolète : Les clés de licence sont désormais gérées via le système Entitlements. Utilisez List Customer Grants (filtrez avec integration_type=license_key) pour récupérer l’octroi d’une clé et ses détails license_key. Ce point de terminaison sera supprimé dans une future version.

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

License key ID

Réponse

License key found

brand_id
string
requis

Brand id this license key belongs to

business_id
string
requis

The unique identifier of the business associated with the license key.

created_at
string<date-time>
requis

The timestamp indicating when the license key was created, in UTC.

Exemple:

"2024-01-01T00:00:00.000Z"

customer_id
string
requis

The unique identifier of the customer associated with the license key.

Exemple:

"cus_123"

id
string
requis

The unique identifier of the license key.

Exemple:

"lic_123"

instances_count
integer<int32>
requis

The current number of instances activated for this license key.

key
string
requis

The license key string.

product_id
string
requis

The unique identifier of the product associated with the license key.

source
enum<string>
requis

The source of the license key - 'auto' for keys generated by payment/subscription flows, 'import' for merchant-imported keys.

Options disponibles:
auto,
import,
manual
status
enum<string>
requis

The current status of the license key (e.g., active, inactive, expired).

Options disponibles:
active,
expired,
disabled
activations_limit
integer<int32> | null

The maximum number of activations allowed for this license key.

Exemple:

5

expires_at
string<date-time> | null

The timestamp indicating when the license key expires, in UTC.

Exemple:

"2024-12-31T23:59:59.000Z"

payment_id
string | null

The unique identifier of the payment associated with the license key, if any.

subscription_id
string | null

The unique identifier of the subscription associated with the license key, if any.

Dernière modification le 9 juillet 2026