Get Activation

GET

license-keys

{id}

activations

{activation_id}

package main

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

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

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.LicenseKeys.GetActivation(ctx, "<value>", "<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>",
    "organization_id": "<string>",
    "user_id": "<string>",
    "customer_id": "<string>",
    "user": {
      "id": "<string>",
      "email": "<string>",
      "public_name": "<string>",
      "avatar_url": "<string>"
    },
    "customer": {
      "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "external_id": "usr_1337",
      "email": "customer@example.com",
      "email_verified": true,
      "name": "John Doe",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "tax_id": [
        "911144442",
        "us_ein"
      ],
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "deleted_at": "2023-11-07T05:31:56Z",
      "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
    },
    "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"
  }
}

Authorizations

Authorization

string

header

required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

string

required

activation_id

string

required

Response

200

application/json

Successful Response

string

required

license_key_id

string

required

label

string

required

meta

object

required

created_at

string

required

modified_at

string | null

required

license_key

object

required

license_key.id

string

required

license_key.organization_id

string

required

license_key.user_id

string

requireddeprecated

license_key.customer_id

string

required

license_key.user

object

required

license_key.customer

object

required

license_key.customer.id

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

license_key.customer.created_at

string

required

Creation timestamp of the object.

license_key.customer.modified_at

string | null

required

Last modification timestamp of the object.

license_key.customer.metadata

object

required

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.

Example:

"customer@example.com"

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.

Example:

true

license_key.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

license_key.customer.billing_address

object | null

required

license_key.customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

license_key.customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

license_key.customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

license_key.customer.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

license_key.benefit_id

string

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 | null

required

license_key.expires_at

string | null

required

Was this page helpful?

Update License Key

Create File

package main

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

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

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.LicenseKeys.GetActivation(ctx, "<value>", "<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>",
    "organization_id": "<string>",
    "user_id": "<string>",
    "customer_id": "<string>",
    "user": {
      "id": "<string>",
      "email": "<string>",
      "public_name": "<string>",
      "avatar_url": "<string>"
    },
    "customer": {
      "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "external_id": "usr_1337",
      "email": "customer@example.com",
      "email_verified": true,
      "name": "John Doe",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "tax_id": [
        "911144442",
        "us_ein"
      ],
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "deleted_at": "2023-11-07T05:31:56Z",
      "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
    },
    "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"
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

Get Activation

Authorizations

Path Parameters

Response