Pular para o conteúdo principal
GET
JavaScript
API Descontinuada: As chaves de licença agora são gerenciadas através do sistema de Direitos. Use Listar Concessões de Cliente (filtrar com integration_type=license_key) para recuperar a concessão de uma chave e seus detalhes de license_key. Este endpoint será removido em uma versão futura.

Autorizações

Authorization
string
header
obrigatório

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.

Parâmetros de caminho

id
string
obrigatório

License key ID

Resposta

License key found

brand_id
string
obrigatório

Brand id this license key belongs to

business_id
string
obrigatório

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

created_at
string<date-time>
obrigatório

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

Exemplo:

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

customer_id
string
obrigatório

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

Exemplo:

"cus_123"

id
string
obrigatório

The unique identifier of the license key.

Exemplo:

"lic_123"

instances_count
integer<int32>
obrigatório

The current number of instances activated for this license key.

key
string
obrigatório

The license key string.

product_id
string
obrigatório

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

source
enum<string>
obrigatório

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

Opções disponíveis:
auto,
import,
manual
status
enum<string>
obrigatório

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

Opções disponíveis:
active,
expired,
disabled
activations_limit
integer<int32> | null

The maximum number of activations allowed for this license key.

Exemplo:

5

expires_at
string<date-time> | null

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

Exemplo:

"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.

Última modificação em 9 de julho de 2026