POpolar
customer_portal
license_keys
public

Activate License Key

Changed on

Activate a license key instance.

This endpoint doesn't require authentication and can be safely used on a public client, like a desktop application or a mobile app. If you plan to validate a license key on a server, use the /v1/license-keys/activate endpoint instead.

post/v1/customer-portal/license-keys/activate

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customer-portal/license-keys/activate
  • Auth
    none declared

Request body

keystring required
organization_idstring uuid4 required
labelstring required
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.

metaobject

Key-value object allowing you to store additional information about the activation

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

idstring uuid4 required
license_key_idstring uuid4 required
labelstring required
metaobject required
created_atstring date-time required
modified_atstring date-time nullable required
license_keyLicenseKeyRead required(unresolved $ref)

Changes

  • f9688fd328d6Revision changes
    • info

      added the required property // to the response with the status