README.md

LicenseKeys

(license_keys)

Overview

Available Operations

• list - List License Keys
• get - Get License Key
• update - Update License Key
• get_activation - Get Activation
• validate - Validate License Key
• activate - Activate License Key
• deactivate - Deactivate License Key

list

Get license keys connected to the given organization & filters.

Scopes: license_keys:read license_keys:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.license_keys.list(organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737", page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
organization_id	OptionalNullable[models.LicenseKeysListQueryParamOrganizationIDFilter]	➖	Filter by organization ID.
benefit_id	OptionalNullable[models.QueryParamBenefitIDFilter]	➖	Filter by benefit ID.
page	Optional[int]	➖	Page number, defaults to 1.
limit	Optional[int]	➖	Size of a page, defaults to 10. Maximum is 100.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LicenseKeysListResponse

Errors

Error Type	Status Code	Content Type
models.Unauthorized	401	application/json
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

get

Get a license key.

Scopes: license_keys:read license_keys:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.license_keys.get(id="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LicenseKeyWithActivations

Errors

Error Type	Status Code	Content Type
models.Unauthorized	401	application/json
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

update

Update a license key.

Scopes: license_keys:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.license_keys.update(id="<value>", license_key_update={})

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
id	str	✔️	N/A
license_key_update	models.LicenseKeyUpdate	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LicenseKeyRead

Errors

Error Type	Status Code	Content Type
models.Unauthorized	401	application/json
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

get_activation

Get a license key activation.

Scopes: license_keys:read license_keys:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.license_keys.get_activation(id="<value>", activation_id="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
id	str	✔️	N/A
activation_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LicenseKeyActivationRead

Errors

Error Type	Status Code	Content Type
models.Unauthorized	401	application/json
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

validate

Validate a license key.

Scopes: license_keys:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.license_keys.validate(request={
        "key": "<key>",
        "organization_id": "<value>",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	models.LicenseKeyValidate	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ValidatedLicenseKey

Errors

Error Type	Status Code	Content Type
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

activate

Activate a license key instance.

Scopes: license_keys:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.license_keys.activate(request={
        "key": "<key>",
        "organization_id": "<value>",
        "label": "<value>",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	models.LicenseKeyActivate	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.LicenseKeyActivationRead

Errors

Error Type	Status Code	Content Type
models.NotPermitted	403	application/json
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*

deactivate

Deactivate a license key instance.

Scopes: license_keys:write

Example Usage

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    polar.license_keys.deactivate(request={
        "key": "<key>",
        "organization_id": "<value>",
        "activation_id": "<value>",
    })

    # Use the SDK ...

Parameters

Parameter	Type	Required	Description
request	models.LicenseKeyDeactivate	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Errors

Error Type	Status Code	Content Type
models.ResourceNotFound	404	application/json
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	*/*