Skip to navigation

Redeem license

Redeems an eligible unused license from the same application for the signed-in app user. The server applies plan and expiry rules and links the license. A device or license-only session cannot redeem on behalf of another user.

Authentication

AuthorizationBearer
Opaque v3 session token returned by login, bound to its identity and installation.

Headers

X-AuthlyX-NoncestringRequiredformat: "^[a-f0-9]{32,128}$"
Fresh random hexadecimal nonce. Do not reuse.
X-AuthlyX-TimestampstringRequired

Server-aligned Unix time in milliseconds.

X-AuthlyX-SignaturestringRequired

Base64 Ed25519 installation signature over the exact request-proof payload.

Request

This endpoint expects an object.
licenseKeystringRequired

License key belonging to this app. Required for license sign-in and registration.

Response

Successful
successboolean
codestring
messagestring
dataobject or null
requestIdstringformat: "uuid"
verificationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
415
Unsupported Media Type Error
429
Too Many Requests Error
503
Service Unavailable Error