List License Keys

GET

customer-portal

license-keys

package main

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

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

    s := polargo.New()

    res, err := s.CustomerPortal.LicenseKeys.List(ctx, operations.CustomerPortalLicenseKeysListSecurity{
        CustomerSession: os.Getenv("POLAR_CUSTOMER_SESSION"),
    }, polargo.Pointer(operations.CreateCustomerPortalLicenseKeysListQueryParamOrganizationIDFilterArrayOfStr(
        []string{
            "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        },
    )), nil, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceLicenseKeyRead != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "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"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

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.

Query Parameters

organization_id

Filter by organization ID.

Example:

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

benefit_id

string | null

Filter by a specific benefit

page

integer

default:1

Page number, defaults to 1.

Required range: x > 0

limit

integer

default:10

Size of a page, defaults to 10. Maximum is 100.

Required range: x > 0

Response

200

application/json

Successful Response

items

object[]

required

items.id

string

required

items.organization_id

string

required

items.user_id

string

requireddeprecated

items.customer_id

string

required

items.user

object

required

items.customer

object

required

items.customer.id

string

required

The ID of the customer.

Example:

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

items.customer.created_at

string

required

Creation timestamp of the object.

items.customer.modified_at

string | null

required

Last modification timestamp of the object.

items.customer.metadata

object

required

items.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"

items.customer.email

string

required

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

Example:

"customer@example.com"

items.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

items.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

items.customer.billing_address

object | null

required

items.customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

items.customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

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

items.customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

items.customer.avatar_url

string

required

Example:

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

items.benefit_id

string

required

The benefit ID.

items.key

string

required

items.display_key

string

required

items.status

enum<string>

required

Available options:

granted,

revoked,

disabled

items.limit_activations

integer | null

required

items.usage

integer

required

items.limit_usage

integer | null

required

items.validations

integer

required

items.last_validated_at

string | null

required

items.expires_at

string | null

required

pagination

object

required

Was this page helpful?

Get License Key

Get Downloadable

package main

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

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

    s := polargo.New()

    res, err := s.CustomerPortal.LicenseKeys.List(ctx, operations.CustomerPortalLicenseKeysListSecurity{
        CustomerSession: os.Getenv("POLAR_CUSTOMER_SESSION"),
    }, polargo.Pointer(operations.CreateCustomerPortalLicenseKeysListQueryParamOrganizationIDFilterArrayOfStr(
        []string{
            "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        },
    )), nil, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceLicenseKeyRead != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "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"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

List License Keys

Authorizations

Query Parameters

Response