Activate License Key

POST

customer-portal

license-keys

activate

Go (SDK)

package main

import(
	"context"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New()

    res, err := s.CustomerPortal.LicenseKeys.Activate(ctx, components.LicenseKeyActivate{
        Key: "<key>",
        OrganizationID: "<value>",
        Label: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.LicenseKeyActivationRead != nil {
        // handle response
    }
}

{
  "id": "<string>",
  "license_key_id": "<string>",
  "label": "<string>",
  "meta": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "license_key": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "organization_id": "<string>",
    "customer_id": "<string>",
    "customer": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "external_id": "usr_1337",
      "email": "<string>",
      "email_verified": true,
      "name": "John Doe",
      "billing_address": {
        "country": "AD",
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "tax_id": [
        "911144442",
        "us_ein"
      ],
      "organization_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "avatar_url": "<string>"
    },
    "benefit_id": "<string>",
    "key": "<string>",
    "display_key": "<string>",
    "status": "granted",
    "limit_activations": 123,
    "usage": 123,
    "limit_usage": 123,
    "validations": 123,
    "last_validated_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

You only need to use this endpoint if you have device activations enabled on the license key benefit. You then use this endpoint to reserve an allocation for a specific device. Storing the unique activation ID from the response on the device and using it as extra validation in the /validate endpoint.Not using activations? Just use the /validate endpoint directly instead.

Body

application/json

key

string

required

organization_id

string<uuid4>

required

label

string

required

conditions

Conditions · object

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.

Show child attributes

conditions.{key}

Required string length: 1 - 500

Response

Successful Response

string<uuid4>

required

license_key_id

string<uuid4>

required

label

string

required

meta

Meta · object

required

Show child attributes

meta.{key}

created_at

string<date-time>

required

modified_at

string<date-time> | null

required

license_key

LicenseKeyRead · object

required

Show child attributes

license_key.id

string<uuid4>

required

The ID of the object.

license_key.created_at

string<date-time>

required

Creation timestamp of the object.

license_key.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

license_key.organization_id

string<uuid4>

required

license_key.customer_id

string<uuid4>

required

license_key.customer

LicenseKeyCustomer · object

required

Show child attributes

license_key.customer.id

string<uuid4>

required

The ID of the customer.

license_key.customer.created_at

string<date-time>

required

Creation timestamp of the object.

license_key.customer.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

license_key.customer.metadata

Metadata · object

required

Show child attributes

license_key.customer.metadata.{key}

license_key.customer.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

license_key.customer.email

string

required

The email address of the customer. This must be unique within the organization.

license_key.customer.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

license_key.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

license_key.customer.billing_address

Address · object

required

Show child attributes

license_key.customer.billing_address.country

enum<string>

required

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

license_key.customer.billing_address.line1

string | null

license_key.customer.billing_address.line2

string | null

license_key.customer.billing_address.postal_code

string | null

license_key.customer.billing_address.city

string | null

license_key.customer.billing_address.state

string | null

license_key.customer.tax_id

any[] | null

required

Required array length: 2 elements

Example:

["911144442", "us_ein"]

license_key.customer.organization_id

string<uuid4>

required

The ID of the organization owning the customer.

license_key.customer.deleted_at

string<date-time> | null

required

Timestamp for when the customer was soft deleted.

license_key.customer.avatar_url

string

required

license_key.benefit_id

string<uuid4>

required

The benefit ID.

license_key.key

string

required

license_key.display_key

string

required

license_key.status

enum<string>

required

Available options:

granted,

revoked,

disabled

license_key.limit_activations

integer | null

required

license_key.usage

integer

required

license_key.limit_usage

integer | null

required

license_key.validations

integer

required

license_key.last_validated_at

string<date-time> | null

required

license_key.expires_at

string<date-time> | null

required

Deactivate License KeyDeactivate 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/deactivate` > endpoint instead.

⌘I

Go (SDK)

package main

import(
	"context"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New()

    res, err := s.CustomerPortal.LicenseKeys.Activate(ctx, components.LicenseKeyActivate{
        Key: "<key>",
        OrganizationID: "<value>",
        Label: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.LicenseKeyActivationRead != nil {
        // handle response
    }
}

{
  "id": "<string>",
  "license_key_id": "<string>",
  "label": "<string>",
  "meta": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "license_key": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "organization_id": "<string>",
    "customer_id": "<string>",
    "customer": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "external_id": "usr_1337",
      "email": "<string>",
      "email_verified": true,
      "name": "John Doe",
      "billing_address": {
        "country": "AD",
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "tax_id": [
        "911144442",
        "us_ein"
      ],
      "organization_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "avatar_url": "<string>"
    },
    "benefit_id": "<string>",
    "key": "<string>",
    "display_key": "<string>",
    "status": "granted",
    "limit_activations": 123,
    "usage": 123,
    "limit_usage": 123,
    "validations": 123,
    "last_validated_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Activate License Key

Body

Response