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

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

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add polar-sdk

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

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from polar-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "polar-sdk",
# ]
# ///

from polar_sdk import Polar

sdk = Polar(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

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

# Synchronous Example
from polar_sdk import Polar


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

    res = polar.organizations.list_organizations(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

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

# Asynchronous Example
import asyncio
from polar_sdk import Polar

async def main():

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

        res = await polar.organizations.list_organizations_async(page=1, limit=10)

        while res is not None:
            # Handle items

            res = res.next()

asyncio.run(main())

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,
    WebhookUnknownTypeError,
    WebhookVerificationError,
)

app = Flask(__name__)

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

        # Process the event

        return "", 202
    except WebhookVerificationError:
        return "", 403
    except WebhookUnknownTypeError:
        # The signature was valid, but the event `type` is not known to this
        # SDK version (e.g. the API has shipped a new event type and you
        # haven't upgraded yet). Safe to ignore for forward compatibility,
        # or log and acknowledge so the webhook isn't retried.
        return "", 202

WebhookUnknownTypeError is raised after signature verification but before payload parsing, so a stale SDK can still acknowledge unknown events instead of crashing on a pydantic.ValidationError.

• list - List Benefit Grants

• list - List Benefits
• create - Create Benefit
• get - Get Benefit
• update - Update Benefit
• delete - Delete Benefit
• grants - List Benefit Grants

• list - List Checkout Links
• create - Create Checkout Link
• get - Get Checkout Link
• update - Update Checkout Link
• delete - Delete Checkout Link

• list - List Checkout Sessions
• create - Create Checkout Session
• get - Get Checkout Session
• update - Update Checkout Session
• client_get - Get Checkout Session from Client
• client_update - Update Checkout Session from Client
• client_confirm - Confirm Checkout Session from Client

• list - List Custom Fields
• create - Create Custom Field
• get - Get Custom Field
• update - Update Custom Field
• delete - Delete Custom Field

• list - List Customer Meters
• get - Get Customer Meter

• list - List Benefit Grants
• get - Get Benefit Grant
• update - Update Benefit Grant

• list - List Meters
• get - Get Customer Meter

• introspect - Introspect Customer Session
• get_authenticated_user - Get Authenticated Portal User

• get - Get Customer
• update - Update Customer
• list_payment_methods - List Customer Payment Methods
• add_payment_method - Add Customer Payment Method
• confirm_payment_method - Confirm Customer Payment Method
• delete_payment_method - Delete Customer Payment Method
• request_email_update - Request Email Change
• check_email_update - Check Email Change Token
• verify_email_update - Verify Email Change

• list - List Downloadables

• list - List License Keys
• get - Get License Key
• validate - Validate License Key
• activate - Activate License Key
• deactivate - Deactivate License Key

• list_members - List Members
• add_member - Add Member
• update_member - Update Member
• remove_member - Remove Member

• list - List Orders
• get - Get Order
• update - Update Order
• generate_invoice - Generate Order Invoice
• invoice - Get Order Invoice
• receipt - Get Order Receipt
• get_payment_status - Get Order Payment Status
• confirm_retry_payment - Confirm Retry Payment

• get - Get Organization

• list_seats - List Seats
• assign_seat - Assign Seat
• revoke_seat - Revoke Seat
• resend_invitation - Resend Invitation
• list_claimed_subscriptions - List Claimed Subscriptions

• list - List Subscriptions
• get - Get Subscription
• update - Update Subscription
• cancel - Cancel Subscription

• list - List Wallets
• get - Get Wallet

• assign_seat - Assign Seat
• list_seats - List Seats
• revoke_seat - Revoke Seat
• resend_invitation - Resend Invitation
• get_claim_info - Get Claim Info
• claim_seat - Claim Seat

• create - Create Customer Session

• list - List Customers
• create - Create Customer
• export - Export Customers
• get - Get Customer
• update - Update Customer
• delete - Delete Customer
• get_external - Get Customer by External ID
• update_external - Update Customer by External ID
• delete_external - Delete Customer by External ID
• get_state - Get Customer State
• get_state_external - Get Customer State by External ID
• list_payment_methods - List Customer Payment Methods
• list_payment_methods_external - List Customer Payment Methods by External ID

• create - Create Member
• create_external - Create Member by Customer External ID
• get - Get Member
• update - Update Member
• delete - Delete Member
• get_external - Get Member by External ID
• update_external - Update Member by External ID
• delete_external - Delete Member by External ID

• list - List Discounts
• create - Create Discount
• get - Get Discount
• update - Update Discount
• delete - Delete Discount

• list - List Disputes
• get - Get Dispute
• accept - Accept Dispute

• list - List Event Types
• update - Update Event Type

• list - List Events
• list_names - List Event Names
• get - Get Event
• ingest - Ingest Events

• list - List Files
• create - Create File
• uploaded - Complete File Upload
• update - Update File
• delete - Delete File

• 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_members - List Members

• list - List Meters
• create - Create Meter
• get - Get Meter
• update - Update Meter
• quantities - Get Meter Quantities

• get - Get Metrics
• export - Export Metrics
• limits - Get Metrics Limits
• list_dashboards - List Metric Dashboards
• create_dashboard - Create Metric Dashboard
• get_dashboard - Get Metric Dashboard
• update_dashboard - Update Metric Dashboard
• delete_dashboard - Delete Metric Dashboard

• authorize - Authorize
• token - Request Token
• revoke - Revoke Token
• introspect - Introspect Token
• userinfo - Get User Info

• create - Create Client
• get - Get Client
• update - Update Client
• delete - Delete Client

• list - List Orders
• create - Create Order
• export - Export Orders
• get - Get Order
• update - Update Order
• finalize - Finalize Order
• generate_invoice - Generate Order Invoice
• invoice - Get Order Invoice
• receipt - Get Order Receipt

• list_organizations - List Organizations
• create - Create Organization
• get - Get Organization
• update - Update Organization

• list - List Payments
• get - Get Payment

• list - List Products
• create - Create Product
• get - Get Product
• update - Update Product
• update_benefits - Update Product Benefits

• list - List Refunds
• create - Create Refund

• list - List Subscriptions
• create - Create Subscription
• export - Export Subscriptions
• get - Get Subscription
• update - Update Subscription
• revoke - Revoke Subscription

• list_webhook_endpoints - List Webhook Endpoints
• create_webhook_endpoint - Create Webhook Endpoint
• get_webhook_endpoint - Get Webhook Endpoint
• update_webhook_endpoint - Update Webhook Endpoint
• delete_webhook_endpoint - Delete Webhook Endpoint
• reset_webhook_endpoint_secret - Reset Webhook Endpoint Secret
• list_webhook_deliveries - List Webhook Deliveries
• redeliver_webhook_event - Redeliver Webhook Event

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="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.organizations.list_organizations(page=1, limit=10,
        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="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.organizations.list_organizations(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

PolarError is the base class for all HTTP error responses. It has the following properties:

import polar_sdk
from polar_sdk import Polar, models


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

        res = polar.organizations.list_organizations(page=1, limit=10)

        while res is not None:
            # Handle items

            res = res.next()


    except models.PolarError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, models.HTTPValidationError):
            print(e.data.detail)  # Optional[List[polar_sdk.ValidationError]]

Primary errors:

• PolarError: The base class for HTTP error responses.
  • HTTPValidationError: Validation Error. Status code 422. *

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from PolarError:

• ResourceNotFound: Status code 404. Applicable to 94 of 185 methods.*
• NotPermitted: Status code 403. Applicable to 12 of 185 methods.*
• Unauthorized: Not authorized to manage license key. Status code 401. Applicable to 5 of 185 methods.*
• AlreadyCanceledSubscription: Status code 403. Applicable to 4 of 185 methods.*
• AmbiguousExternalCustomerID: The external customer ID matches customers in several accessible organizations. Status code 409. Applicable to 4 of 185 methods.*
• PaymentFailed: Status code 402. Applicable to 3 of 185 methods.*
• AlreadyActiveSubscriptionError: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 185 methods.*
• NotOpenCheckout: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 185 methods.*
• PaymentNotReady: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 185 methods.*
• TrialAlreadyRedeemed: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 185 methods.*
• ExpiredCheckoutError: The checkout session is expired. Status code 410. Applicable to 3 of 185 methods.*
• SubscriptionLocked: Subscription is pending an update. Status code 409. Applicable to 2 of 185 methods.*
• OrderNotEligibleForInvoice: Order is not eligible for invoice generation (invalid status). Status code 409. Applicable to 2 of 185 methods.*
• MissingInvoiceBillingDetails: Order is missing billing name or address. Status code 422. Applicable to 2 of 185 methods.*
• PaymentError: The payment failed. Status code 400. Applicable to 1 of 185 methods.*
• PaymentMethodSetupFailed: The card was declined while setting up the payment method. Status code 400. Applicable to 1 of 185 methods.*
• CustomerNotReady: Customer is not ready to confirm a payment method. Status code 400. Applicable to 1 of 185 methods.*
• PaymentMethodInUseByActiveSubscription: Payment method is used by active subscription(s). Status code 400. Applicable to 1 of 185 methods.*
• PaymentActionRequired: The charge failed, or requires customer authentication (e.g. a 3DS challenge) that can't be completed off-session. Status code 402. Applicable to 1 of 185 methods.*
• CannotCreateOrganizationError: Forbidden. Status code 403. Applicable to 1 of 185 methods.*
• OffSessionChargesNotEnabled: Off-session charges are not enabled for this organization, or its account can't currently accept payments. Status code 403. Applicable to 1 of 185 methods.*
• OrganizationNotReadyForPayments: Off-session charges are not enabled for this organization, or its account can't currently accept payments. Status code 403. Applicable to 1 of 185 methods.*
• RefundedAlready: Order is already fully refunded. Status code 403. Applicable to 1 of 185 methods.*
• PauseResumeNotAllowed: Customer subscription is already canceled or will be at the end of the period, the user lacks billing permissions, or pausing/resuming is not enabled for the organization. Status code 403. Applicable to 1 of 185 methods.*
• SSOEnforcementRequiresConnection: Cannot enforce SSO without an enabled connection. Status code 409. Applicable to 1 of 185 methods.*
• DisputeNotOpenError: Conflict. Status code 409. Applicable to 1 of 185 methods.*
• PaymentAlreadyInProgress: Payment already in progress. Status code 409. Applicable to 1 of 185 methods.*
• OrderNotDraft: The order is not in draft status. Status code 412. Applicable to 1 of 185 methods.*
• OrderNotEligibleForRetry: Order not eligible for retry or payment confirmation failed. Status code 422. Applicable to 1 of 185 methods.*
• ManualRetryLimitExceeded: Manual retry limit exceeded. Status code 429. Applicable to 1 of 185 methods.*
• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

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:

from polar_sdk import Polar


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

    res = polar.organizations.list_organizations(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

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="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.organizations.list_organizations(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

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()))

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="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.organizations.list_organizations(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import polar_sdk
from polar_sdk import Polar


with Polar() as polar:

    res = polar.customer_portal.benefit_grants.list(security=polar_sdk.CustomerPortalBenefitGrantsListSecurity(

    ), page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

The Polar class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from polar_sdk import Polar
def main():

    with Polar(
        access_token="<YOUR_BEARER_TOKEN_HERE>",
    ) as polar:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Polar(
        access_token="<YOUR_BEARER_TOKEN_HERE>",
    ) as polar:
        # Rest of application here...

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"))

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="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.organizations.list_organizations(page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Polar API: Polar HTTP and Webhooks API

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

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.

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.