GET
/
v1
/
customer-portal
/
license-keys
/
{id}
import { Polar } from "@polar-sh/sdk";

const polar = new Polar();

async function run() {
  const result = await polar.customerPortal.licenseKeys.get({
    customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
  }, {
    id: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "customer_id": "<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",
  "activations": [
    {
      "id": "<string>",
      "license_key_id": "<string>",
      "label": "<string>",
      "meta": {},
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.

Path Parameters

​
id
string
required

Response

200
application/json

Successful Response

​
id
string
required

The ID of the object.

​
created_at
string
required

Creation timestamp of the object.

​
modified_at
string | null
required

Last modification timestamp of the object.

​
organization_id
string
required
​
customer_id
string
required
​
customer
object
required
​
benefit_id
string
required

The benefit ID.

​
key
string
required
​
display_key
string
required
​
status
enum<string>
required
Available options:
granted,
revoked,
disabled
​
limit_activations
integer | null
required
​
usage
integer
required
​
limit_usage
integer | null
required
​
validations
integer
required
​
last_validated_at
string | null
required
​
expires_at
string | null
required
​
activations
LicenseKeyActivationBase · object[]
required