polar-sdk

SDK Installation

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install polar-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add polar-sdk

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
import dateutil.parser
import polar_sdk
from polar_sdk import Polar

with Polar() as polar:

    res = polar.endpointcheckout_created_post(request=polar_sdk.WebhookCheckoutCreatedPayload(
        data=polar_sdk.Checkout(
            created_at=dateutil.parser.isoparse("2024-11-12T14:26:42.882Z"),
            modified_at=dateutil.parser.isoparse("2023-05-28T05:08:06.235Z"),
            id="",
            status=polar_sdk.CheckoutStatus.FAILED,
            client_secret="",
            url="https://heavy-beret.com/",
            expires_at=dateutil.parser.isoparse("2022-02-25T02:26:48.460Z"),
            success_url="https://sardonic-final.info/",
            embed_origin="",
            amount=962818,
            tax_amount=6400,
            currency="Yen",
            subtotal_amount=648726,
            total_amount=210702,
            product_id="",
            product_price_id="",
            discount_id="",
            allow_discount_codes=True,
            is_discount_applicable=False,
            is_free_product_price=False,
            is_payment_required=False,
            is_payment_setup_required=False,
            is_payment_form_required=False,
            customer_id="",
            customer_name="",
            customer_email="Ryley_Erdman@hotmail.com",
            customer_ip_address="",
            customer_billing_address={
                "country": "South Africa",
            },
            customer_tax_id="",
            payment_processor_metadata={},
            metadata={
                "key": 18677,
                "key1": 95370,
            },
            product={
                "created_at": dateutil.parser.isoparse("2022-04-02T00:05:42.586Z"),
                "modified_at": dateutil.parser.isoparse("2023-12-16T03:02:38.803Z"),
                "id": "",
                "name": "",
                "description": "for embarrassment untidy long-term near honestly separate yet",
                "is_recurring": True,
                "is_archived": False,
                "organization_id": "",
                "prices": [
                    {
                        "created_at": dateutil.parser.isoparse("2024-11-19T15:59:15.588Z"),
                        "modified_at": dateutil.parser.isoparse("2022-11-17T00:11:23.972Z"),
                        "id": "",
                        "is_archived": False,
                        "product_id": "",
                        "price_currency": "",
                        "minimum_amount": 363560,
                        "maximum_amount": 75876,
                        "preset_amount": 82334,
                        "amount_type": polar_sdk.ProductPriceOneTimeCustomAmountType.CUSTOM,
                        "type": polar_sdk.ProductPriceOneTimeCustomType.ONE_TIME,
                    },
                ],
                "benefits": [
                    {
                        "created_at": dateutil.parser.isoparse("2023-08-22T00:47:02.059Z"),
                        "modified_at": dateutil.parser.isoparse("2023-06-04T10:32:44.101Z"),
                        "id": "",
                        "type": polar_sdk.BenefitType.LICENSE_KEYS,
                        "description": "within jacket unless",
                        "selectable": False,
                        "deletable": False,
                        "organization_id": "",
                    },
                ],
                "medias": [
                    {
                        "id": "",
                        "organization_id": "",
                        "name": "",
                        "path": "/private/var",
                        "mime_type": "",
                        "size": 245189,
                        "storage_version": "",
                        "checksum_etag": "",
                        "checksum_sha256_base64": "",
                        "checksum_sha256_hex": "",
                        "last_modified_at": dateutil.parser.isoparse("2022-11-03T15:00:03.276Z"),
                        "version": "",
                        "is_uploaded": False,
                        "created_at": dateutil.parser.isoparse("2024-06-07T13:47:02.365Z"),
                        "size_readable": "",
                        "public_url": "https://webbed-experience.name/",
                        "service": polar_sdk.Service.PRODUCT_MEDIA,
                    },
                ],
            },
            product_price={
                "created_at": dateutil.parser.isoparse("2024-02-15T09:22:19.644Z"),
                "modified_at": dateutil.parser.isoparse("2022-12-28T20:59:29.904Z"),
                "id": "",
                "is_archived": False,
                "product_id": "",
                "price_currency": "",
                "minimum_amount": 417896,
                "maximum_amount": 962818,
                "preset_amount": 6400,
                "recurring_interval": polar_sdk.SubscriptionRecurringInterval.MONTH,
                "amount_type": polar_sdk.ProductPriceRecurringCustomAmountType.CUSTOM,
                "type": polar_sdk.ProductPriceRecurringCustomType.RECURRING,
            },
            discount={
                "duration": polar_sdk.DiscountDuration.REPEATING,
                "type": polar_sdk.DiscountType.FIXED,
                "basis_points": 341163,
                "id": "",
                "name": "",
                "code": "",
            },
            subscription_id="",
            attached_custom_fields=[
                {
                    "custom_field_id": "",
                    "custom_field": {
                        "created_at": dateutil.parser.isoparse("2022-08-19T22:18:44.316Z"),
                        "modified_at": dateutil.parser.isoparse("2023-04-29T23:39:10.699Z"),
                        "id": "",
                        "metadata": {
                            "key": False,
                        },
                        "slug": "",
                        "name": "",
                        "organization_id": "",
                        "properties": {
                            "options": [
                                {
                                    "value": "",
                                    "label": "",
                                },
                            ],
                        },
                        "type": polar_sdk.CustomFieldSelectType.SELECT,
                    },
                    "order": 996863,
                    "required": False,
                },
                {
                    "custom_field_id": "",
                    "custom_field": {
                        "created_at": dateutil.parser.isoparse("2023-07-03T09:46:29.338Z"),
                        "modified_at": dateutil.parser.isoparse("2024-01-25T18:08:49.597Z"),
                        "id": "",
                        "metadata": {
                            "key": False,
                        },
                        "slug": "",
                        "name": "",
                        "organization_id": "",
                        "properties": {},
                        "type": polar_sdk.CustomFieldNumberType.NUMBER,
                    },
                    "order": 72589,
                    "required": True,
                },
                {
                    "custom_field_id": "",
                    "custom_field": {
                        "created_at": dateutil.parser.isoparse("2024-07-31T13:25:31.669Z"),
                        "modified_at": dateutil.parser.isoparse("2022-11-12T09:40:10.044Z"),
                        "id": "",
                        "metadata": {
                            "key": "",
                        },
                        "slug": "",
                        "name": "",
                        "organization_id": "",
                        "properties": {},
                        "type": polar_sdk.CustomFieldTextType.TEXT,
                    },
                    "order": 161325,
                    "required": True,
                },
            ],
            customer_metadata={
                "key": "",
                "key1": "",
            },
            payment_processor=polar_sdk.PaymentProcessor.STRIPE,
        ),
        type=polar_sdk.WebhookCheckoutCreatedPayloadType.CHECKOUT_CREATED,
    ))

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import dateutil.parser
import polar_sdk
from polar_sdk import Polar

async def main():
    async with Polar() as polar:

        res = await polar.endpointcheckout_created_post_async(request=polar_sdk.WebhookCheckoutCreatedPayload(
            data=polar_sdk.Checkout(
                created_at=dateutil.parser.isoparse("2024-11-12T14:26:42.882Z"),
                modified_at=dateutil.parser.isoparse("2023-05-28T05:08:06.235Z"),
                id="",
                status=polar_sdk.CheckoutStatus.FAILED,
                client_secret="",
                url="https://heavy-beret.com/",
                expires_at=dateutil.parser.isoparse("2022-02-25T02:26:48.460Z"),
                success_url="https://sardonic-final.info/",
                embed_origin="",
                amount=962818,
                tax_amount=6400,
                currency="Yen",
                subtotal_amount=648726,
                total_amount=210702,
                product_id="",
                product_price_id="",
                discount_id="",
                allow_discount_codes=True,
                is_discount_applicable=False,
                is_free_product_price=False,
                is_payment_required=False,
                is_payment_setup_required=False,
                is_payment_form_required=False,
                customer_id="",
                customer_name="",
                customer_email="Ryley_Erdman@hotmail.com",
                customer_ip_address="",
                customer_billing_address={
                    "country": "South Africa",
                },
                customer_tax_id="",
                payment_processor_metadata={},
                metadata={
                    "key": 18677,
                    "key1": 95370,
                },
                product={
                    "created_at": dateutil.parser.isoparse("2022-04-02T00:05:42.586Z"),
                    "modified_at": dateutil.parser.isoparse("2023-12-16T03:02:38.803Z"),
                    "id": "",
                    "name": "",
                    "description": "for embarrassment untidy long-term near honestly separate yet",
                    "is_recurring": True,
                    "is_archived": False,
                    "organization_id": "",
                    "prices": [
                        {
                            "created_at": dateutil.parser.isoparse("2023-02-07T04:30:48.802Z"),
                            "modified_at": dateutil.parser.isoparse("2024-06-25T22:47:14.264Z"),
                            "id": "",
                            "is_archived": False,
                            "product_id": "",
                            "price_currency": "",
                            "minimum_amount": 691423,
                            "maximum_amount": 499526,
                            "preset_amount": 18677,
                            "amount_type": polar_sdk.ProductPriceOneTimeCustomAmountType.CUSTOM,
                            "type": polar_sdk.ProductPriceOneTimeCustomType.ONE_TIME,
                        },
                    ],
                    "benefits": [
                        {
                            "created_at": dateutil.parser.isoparse("2023-08-22T00:47:02.059Z"),
                            "modified_at": dateutil.parser.isoparse("2023-06-04T10:32:44.101Z"),
                            "id": "",
                            "type": polar_sdk.BenefitType.LICENSE_KEYS,
                            "description": "within jacket unless",
                            "selectable": False,
                            "deletable": False,
                            "organization_id": "",
                        },
                    ],
                    "medias": [
                        {
                            "id": "",
                            "organization_id": "",
                            "name": "",
                            "path": "/private/var",
                            "mime_type": "",
                            "size": 245189,
                            "storage_version": "",
                            "checksum_etag": "",
                            "checksum_sha256_base64": "",
                            "checksum_sha256_hex": "",
                            "last_modified_at": dateutil.parser.isoparse("2022-11-03T15:00:03.276Z"),
                            "version": "",
                            "is_uploaded": False,
                            "created_at": dateutil.parser.isoparse("2024-06-07T13:47:02.365Z"),
                            "size_readable": "",
                            "public_url": "https://webbed-experience.name/",
                            "service": polar_sdk.Service.PRODUCT_MEDIA,
                        },
                    ],
                },
                product_price={
                    "created_at": dateutil.parser.isoparse("2022-04-02T00:05:42.586Z"),
                    "modified_at": dateutil.parser.isoparse("2023-12-16T03:02:38.803Z"),
                    "id": "",
                    "is_archived": False,
                    "product_id": "",
                    "price_currency": "",
                    "price_amount": 740296,
                    "amount_type": polar_sdk.ProductPriceOneTimeFixedAmountType.FIXED,
                    "type": polar_sdk.ProductPriceOneTimeFixedType.ONE_TIME,
                },
                discount={
                    "duration": polar_sdk.DiscountDuration.REPEATING,
                    "type": polar_sdk.DiscountType.FIXED,
                    "basis_points": 341163,
                    "id": "",
                    "name": "",
                    "code": "",
                },
                subscription_id="",
                attached_custom_fields=[
                    {
                        "custom_field_id": "",
                        "custom_field": {
                            "created_at": dateutil.parser.isoparse("2024-06-23T16:57:50.081Z"),
                            "modified_at": dateutil.parser.isoparse("2023-12-14T18:25:33.693Z"),
                            "id": "",
                            "metadata": {
                                "key": "",
                            },
                            "slug": "",
                            "name": "",
                            "organization_id": "",
                            "properties": {},
                            "type": polar_sdk.CustomFieldNumberType.NUMBER,
                        },
                        "order": 996863,
                        "required": False,
                    },
                    {
                        "custom_field_id": "",
                        "custom_field": {
                            "created_at": dateutil.parser.isoparse("2022-04-26T22:34:57.487Z"),
                            "modified_at": dateutil.parser.isoparse("2022-08-07T19:57:51.694Z"),
                            "id": "",
                            "metadata": {
                                "key": 856200,
                            },
                            "slug": "",
                            "name": "",
                            "organization_id": "",
                            "properties": {
                                "options": [
                                    {
                                        "value": "",
                                        "label": "",
                                    },
                                ],
                            },
                            "type": polar_sdk.CustomFieldSelectType.SELECT,
                        },
                        "order": 72589,
                        "required": True,
                    },
                    {
                        "custom_field_id": "",
                        "custom_field": {
                            "created_at": dateutil.parser.isoparse("2024-05-25T15:20:50.694Z"),
                            "modified_at": dateutil.parser.isoparse("2023-11-28T14:29:40.329Z"),
                            "id": "",
                            "metadata": {
                                "key": False,
                            },
                            "slug": "",
                            "name": "",
                            "organization_id": "",
                            "properties": {},
                            "type": polar_sdk.CustomFieldCheckboxType.CHECKBOX,
                        },
                        "order": 161325,
                        "required": True,
                    },
                ],
                customer_metadata={
                    "key": "",
                    "key1": "",
                },
                payment_processor=polar_sdk.PaymentProcessor.STRIPE,
            ),
            type=polar_sdk.WebhookCheckoutCreatedPayloadType.CHECKOUT_CREATED,
        ))

        # Handle response
        print(res)

asyncio.run(main())

Webhook support

The SDK has built-in support to validate webhook events. Here is an example with Flask:

from flask import Flask, request
from polar_sdk.webhooks import validate_event, WebhookVerificationError

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def webhook():
    try:
        event = validate_event(
            payload=request.data,
            headers=request.headers,
            secret='',
        )

        # Process the event

        return "", 202
    except WebhookVerificationError as e:
        return "", 403

Available Resources and Operations

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from polar_sdk import Polar
from polar_sdk.utils import BackoffStrategy, RetryConfig

with Polar(
    access_token="",
) as polar:

    res = polar.external_organizations.list(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    while res is not None:
        # Handle items

        res = res.next()

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from polar_sdk import Polar
from polar_sdk.utils import BackoffStrategy, RetryConfig

with Polar(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    access_token="",
) as polar:

    res = polar.external_organizations.list()

    while res is not None:
        # Handle items

        res = res.next()

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a models.SDKError exception, which has the following properties:

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the list_async method may raise the following exceptions:

Example

from polar_sdk import Polar, models

with Polar(
    access_token="",
) as polar:
    res = None
    try:

        res = polar.external_organizations.list()

        while res is not None:
            # Handle items

            res = res.next()

    except models.HTTPValidationError as e:
        # handle e.data: models.HTTPValidationErrorData
        raise(e)
    except models.SDKError as e:
        # handle exception
        raise(e)

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: str optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Example

from polar_sdk import Polar

with Polar(
    server="sandbox",
    access_token="",
) as polar:

    res = polar.external_organizations.list()

    while res is not None:
        # Handle items

        res = res.next()

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from polar_sdk import Polar

with Polar(
    server_url="https://api.polar.sh",
    access_token="",
) as polar:

    res = polar.external_organizations.list()

    while res is not None:
        # Handle items

        res = res.next()

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from polar_sdk import Polar
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Polar(client=http_client)

or you could wrap the client with your own custom logic:

from polar_sdk import Polar
from polar_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Polar(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

To authenticate with the API the access_token parameter must be set when initializing the SDK client instance. For example:

from polar_sdk import Polar

with Polar(
    access_token="",
) as polar:

    res = polar.external_organizations.list()

    while res is not None:
        # Handle items

        res = res.next()

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from polar_sdk import Polar
import logging

logging.basicConfig(level=logging.DEBUG)
s = Polar(debug_logger=logging.getLogger("polar_sdk"))

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

from polar_sdk import Polar

with Polar(
    access_token="",
) as polar:

    res = polar.external_organizations.list()

    while res is not None:
        # Handle items

        res = res.next()

Summary

Polar API: Polar HTTP and Webhooks API

Read the docs at https://docs.polar.sh/api

Table of Contents

• polar-sdk
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Webhook support
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Debugging
  • Pagination
• Development
  • Maturity
  • Contributions

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy