The SDK can be installed with either pip or poetry package managers.
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install polar-sdkPoetry 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-sdkGenerally, 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.
# Synchronous Example
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
breakThe same SDK client can also be used to make asychronous 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 s:
res = await s.users.benefits.list_async()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
break
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, 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 as e:
return "", 403Available methods
- list - List Articles
- create - Create Article
- export - Export Articles
- get - Get Article
- update - Update Article
- delete - Delete Article
- receivers - Get Article Receivers Count
- preview - Send Article Preview
- send - Send Article
- 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 Discounts
- create - Create Discount
- get - Get Discount
- update - Update Discount
- delete - Delete Discount
- list - List External Organizations
- 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
- authorize - Authorize
- token - Request Token
- revoke - Revoke Token
- introspect - Introspect Token
- userinfo - Get User Info
- list - List Clients
- create - Create Client
- get - Get Client
- update - Update Client
- delete - Delete Client
- list - List Organizations
- create - Create Organization
- get - Get Organization
- update - Update Organization
- list - List Products
- create - Create Product
- get - Get Product
- update - Update Product
- update_benefits - Update Product Benefits
- list - List Advertisements
- create - Create Advertisement
- get - Get Advertisement
- update - Update Advertisement
- delete - Delete Advertisement
- enable - Enable Advertisement
- list - List License Keys
- get - Get License Key
- validate - Validate License Key
- activate - Activate License Key
- deactivate - Deactivate License Key
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.utils import BackoffStrategy, RetryConfig
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.users.benefits.list(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
breakIf 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.utils import BackoffStrategy, RetryConfig
from polar_sdk import Polar
with Polar(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
breakHandling 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:
| Property | Type | Description |
|---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
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:
| Error Type | Status Code | Content Type |
|---|---|---|
| models.HTTPValidationError | 422 | application/json |
| models.SDKError | 4XX, 5XX | */* |
from polar_sdk import Polar, models
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = None
try:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
break
except models.HTTPValidationError as e:
# handle e.data: models.HTTPValidationErrorData
raise(e)
except models.SDKError as e:
# handle exception
raise(e)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:
| Name | Server |
|---|---|
production |
https://api.polar.sh |
sandbox |
https://sandbox-api.polar.sh |
from polar_sdk import Polar
with Polar(
server="sandbox",
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
breakThe 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 s:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
breakThe 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:
| Name | Type | Scheme |
|---|---|---|
access_token |
http | HTTP Bearer |
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 s:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
breakYou 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 s:
res = s.users.benefits.list()
if res is not None:
while True:
# handle items
res = res.next()
if res is None:
breakPolar API: Polar HTTP and Webhooks API
Read the docs at https://docs.polar.sh/api
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.