POpolar
license_keys
public

Validate License Key

Changed on

Validate a license key.

Scopes: license_keys:write

post/v1/license-keys/validate

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/license-keys/validate
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: license_keys:write)
    • or HTTP bearer
    • or HTTP bearer

Request body

keystring required
organization_idstring uuid4 required
activation_idstring uuid4 nullable
benefit_idstring uuid4 nullable

The benefit ID.

customer_idstring uuid4 nullable
increment_usageinteger nullable
conditionsobject

Key-value object allowing you to set conditions that must match when validating the license key.

The key must be a string with a maximum length of 40 characters. The value must be either:

  • A string with a maximum length of 500 characters
  • An integer
  • A floating-point number
  • A boolean

You can store up to 50 key-value pairs.

Response

Successful Response

ValidatedLicenseKey required(unresolved $ref)

Changes