Verify license

Verifies a license key against a product and returns its activation status. Intended for first-party software activation flows. Requires the LICENSES_READ scope.

Authorization

AuthorizationBearer <token>

Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.

In: header

Path Parameters

storeId*string

Length12 <= length <= 48

Header Parameters

idempotency-key?string

Length8 <= length <= 32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

key*string

Length1 <= length <= 512

productId?string

Length12 <= length <= 48

Response Body

`application/json`

curl -X POST "https://example.com/stores/stringstring/licenses/verify" \  -H "Content-Type: application/json" \  -d '{    "key": "string"  }'

{  "ok": true,  "data": {    "valid": true,    "status": "CLAIMED",    "productId": "prd_8h4t6sqzy3x9w5n2k1m0vqbf",    "customerId": "cus_j8h0r1n4tzcbfp2v8q1mzwx5",    "expiresAt": null  }}

Verify license

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`