Note
Python version upgrade policy
Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
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-sdkYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from polar-sdk pythonIt'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.
# Synchronous Example
import polar_sdk
from polar_sdk import Polar
from polar_sdk.utils import parse_datetime
with Polar() as polar:
res = polar.endpointcheckout_created_post(request=polar_sdk.WebhookCheckoutCreatedPayload(
data=polar_sdk.Checkout(
created_at=parse_datetime("2023-02-15T15:44:21.478Z"),
modified_at=parse_datetime("2023-09-13T08:36:46.434Z"),
id="<value>",
payment_processor=polar_sdk.PaymentProcessor.STRIPE,
status=polar_sdk.CheckoutStatus.EXPIRED,
client_secret="<value>",
url="https://whole-aftermath.net/",
expires_at=parse_datetime("2023-12-28T10:30:56.042Z"),
success_url="https://moral-premier.name/",
embed_origin="<value>",
amount=929514,
discount_amount=323773,
net_amount=115799,
tax_amount=97012,
total_amount=859980,
currency="Fiji Dollar",
product_id="<value>",
product_price_id="<value>",
discount_id=None,
allow_discount_codes=True,
require_billing_address=True,
is_discount_applicable=True,
is_free_product_price=True,
is_payment_required=True,
is_payment_setup_required=True,
is_payment_form_required=True,
customer_id="<value>",
is_business_customer=False,
customer_name="<value>",
customer_email=None,
customer_ip_address=None,
customer_billing_name="<value>",
customer_billing_address=polar_sdk.Address(
country="US",
),
customer_tax_id="<id>",
payment_processor_metadata={
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
billing_address_fields=polar_sdk.CheckoutBillingAddressFields(
country=polar_sdk.BillingAddressFieldMode.REQUIRED,
state=polar_sdk.BillingAddressFieldMode.DISABLED,
city=polar_sdk.BillingAddressFieldMode.REQUIRED,
postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,
line1=polar_sdk.BillingAddressFieldMode.REQUIRED,
line2=polar_sdk.BillingAddressFieldMode.DISABLED,
),
metadata={
"key": False,
"key1": False,
},
external_customer_id=None,
customer_external_id="<id>",
products=[
polar_sdk.CheckoutProduct(
created_at=parse_datetime("2025-07-23T17:21:51.405Z"),
modified_at=parse_datetime("2024-01-17T03:32:08.030Z"),
id="<value>",
name="<value>",
description="funny abscond fairly except slight",
recurring_interval=None,
is_recurring=True,
is_archived=True,
organization_id="<value>",
prices=[
polar_sdk.LegacyRecurringProductPriceFree(
created_at=parse_datetime("2023-09-13T08:36:46.434Z"),
modified_at=parse_datetime("2023-10-05T12:55:46.428Z"),
id="<value>",
is_archived=False,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
),
],
benefits=[],
medias=[
polar_sdk.ProductMediaFileRead(
id="<value>",
organization_id="<value>",
name="<value>",
path="/var/log",
mime_type="<value>",
size=982910,
storage_version="<value>",
checksum_etag="<value>",
checksum_sha256_base64="<value>",
checksum_sha256_hex="<value>",
last_modified_at=parse_datetime("2024-09-13T03:57:17.676Z"),
version="<value>",
is_uploaded=False,
created_at=parse_datetime("2023-03-23T06:47:50.944Z"),
size_readable="<value>",
public_url="https://yummy-ocelot.biz/",
),
polar_sdk.ProductMediaFileRead(
id="<value>",
organization_id="<value>",
name="<value>",
path="/var/log",
mime_type="<value>",
size=982910,
storage_version="<value>",
checksum_etag="<value>",
checksum_sha256_base64="<value>",
checksum_sha256_hex="<value>",
last_modified_at=parse_datetime("2024-09-13T03:57:17.676Z"),
version="<value>",
is_uploaded=False,
created_at=parse_datetime("2023-03-23T06:47:50.944Z"),
size_readable="<value>",
public_url="https://yummy-ocelot.biz/",
),
polar_sdk.ProductMediaFileRead(
id="<value>",
organization_id="<value>",
name="<value>",
path="/var/log",
mime_type="<value>",
size=982910,
storage_version="<value>",
checksum_etag="<value>",
checksum_sha256_base64="<value>",
checksum_sha256_hex="<value>",
last_modified_at=parse_datetime("2024-09-13T03:57:17.676Z"),
version="<value>",
is_uploaded=False,
created_at=parse_datetime("2023-03-23T06:47:50.944Z"),
size_readable="<value>",
public_url="https://yummy-ocelot.biz/",
),
],
),
],
product=polar_sdk.CheckoutProduct(
created_at=parse_datetime("2023-03-01T03:35:30.257Z"),
modified_at=parse_datetime("2024-12-19T15:40:11.887Z"),
id="<value>",
name="<value>",
description="until joyful how",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
is_recurring=True,
is_archived=False,
organization_id="<value>",
prices=[
polar_sdk.LegacyRecurringProductPriceFixed(
created_at=parse_datetime("2024-05-02T18:25:33.974Z"),
modified_at=parse_datetime("2025-02-06T12:55:07.640Z"),
id="<value>",
is_archived=False,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
price_currency="<value>",
price_amount=115799,
),
polar_sdk.LegacyRecurringProductPriceCustom(
created_at=parse_datetime("2025-07-31T12:54:47.590Z"),
modified_at=parse_datetime("2023-01-11T22:31:47.320Z"),
id="<value>",
is_archived=True,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
price_currency="<value>",
minimum_amount=203013,
maximum_amount=None,
preset_amount=119260,
),
polar_sdk.LegacyRecurringProductPriceFree(
created_at=parse_datetime("2024-04-06T18:48:21.449Z"),
modified_at=None,
id="<value>",
is_archived=True,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,
),
],
benefits=[
polar_sdk.BenefitPublic(
id="<value>",
created_at=parse_datetime("2023-11-22T11:07:53.319Z"),
modified_at=parse_datetime("2025-09-17T18:38:51.288Z"),
type=polar_sdk.BenefitType.DISCORD,
description="brr now psst",
selectable=True,
deletable=True,
organization_id="<value>",
),
polar_sdk.BenefitPublic(
id="<value>",
created_at=parse_datetime("2023-11-22T11:07:53.319Z"),
modified_at=parse_datetime("2025-09-17T18:38:51.288Z"),
type=polar_sdk.BenefitType.DISCORD,
description="brr now psst",
selectable=True,
deletable=True,
organization_id="<value>",
),
],
medias=[],
),
product_price=polar_sdk.LegacyRecurringProductPriceFixed(
created_at=parse_datetime("2024-08-14T23:26:30.929Z"),
modified_at=parse_datetime("2025-01-15T11:59:21.523Z"),
id="<value>",
is_archived=False,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,
price_currency="<value>",
price_amount=499786,
),
discount=polar_sdk.CheckoutDiscountPercentageRepeatDuration(
duration=polar_sdk.DiscountDuration.REPEATING,
duration_in_months=470604,
type=polar_sdk.DiscountType.FIXED,
basis_points=567071,
id="<value>",
name="<value>",
code="<value>",
),
subscription_id="<value>",
attached_custom_fields=[
polar_sdk.AttachedCustomField(
custom_field_id="<value>",
custom_field=polar_sdk.CustomFieldNumber(
created_at=parse_datetime("2024-01-27T12:44:05.844Z"),
modified_at=parse_datetime("2023-11-12T13:10:44.040Z"),
id="<value>",
metadata={
"key": 833527,
"key1": False,
},
slug="<value>",
name="<value>",
organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737",
properties=polar_sdk.CustomFieldNumberProperties(),
),
order=786803,
required=False,
),
polar_sdk.AttachedCustomField(
custom_field_id="<value>",
custom_field=polar_sdk.CustomFieldNumber(
created_at=parse_datetime("2024-01-27T12:44:05.844Z"),
modified_at=parse_datetime("2023-11-12T13:10:44.040Z"),
id="<value>",
metadata={
"key": 833527,
"key1": False,
},
slug="<value>",
name="<value>",
organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737",
properties=polar_sdk.CustomFieldNumberProperties(),
),
order=786803,
required=False,
),
],
customer_metadata={
},
),
))
# Handle response
print(res)The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
import polar_sdk
from polar_sdk import Polar
from polar_sdk.utils import parse_datetime
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=parse_datetime("2023-02-15T15:44:21.478Z"),
modified_at=parse_datetime("2023-09-13T08:36:46.434Z"),
id="<value>",
payment_processor=polar_sdk.PaymentProcessor.STRIPE,
status=polar_sdk.CheckoutStatus.EXPIRED,
client_secret="<value>",
url="https://whole-aftermath.net/",
expires_at=parse_datetime("2023-12-28T10:30:56.042Z"),
success_url="https://moral-premier.name/",
embed_origin="<value>",
amount=929514,
discount_amount=323773,
net_amount=115799,
tax_amount=97012,
total_amount=859980,
currency="Fiji Dollar",
product_id="<value>",
product_price_id="<value>",
discount_id=None,
allow_discount_codes=True,
require_billing_address=True,
is_discount_applicable=True,
is_free_product_price=True,
is_payment_required=True,
is_payment_setup_required=True,
is_payment_form_required=True,
customer_id="<value>",
is_business_customer=False,
customer_name="<value>",
customer_email=None,
customer_ip_address=None,
customer_billing_name="<value>",
customer_billing_address=polar_sdk.Address(
country="US",
),
customer_tax_id="<id>",
payment_processor_metadata={
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
billing_address_fields=polar_sdk.CheckoutBillingAddressFields(
country=polar_sdk.BillingAddressFieldMode.REQUIRED,
state=polar_sdk.BillingAddressFieldMode.DISABLED,
city=polar_sdk.BillingAddressFieldMode.REQUIRED,
postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,
line1=polar_sdk.BillingAddressFieldMode.REQUIRED,
line2=polar_sdk.BillingAddressFieldMode.DISABLED,
),
metadata={
"key": False,
"key1": False,
},
external_customer_id=None,
customer_external_id="<id>",
products=[
polar_sdk.CheckoutProduct(
created_at=parse_datetime("2025-07-23T17:21:51.405Z"),
modified_at=parse_datetime("2024-01-17T03:32:08.030Z"),
id="<value>",
name="<value>",
description="funny abscond fairly except slight",
recurring_interval=None,
is_recurring=True,
is_archived=True,
organization_id="<value>",
prices=[
polar_sdk.LegacyRecurringProductPriceFree(
created_at=parse_datetime("2023-09-13T08:36:46.434Z"),
modified_at=parse_datetime("2023-10-05T12:55:46.428Z"),
id="<value>",
is_archived=False,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
),
],
benefits=[],
medias=[
polar_sdk.ProductMediaFileRead(
id="<value>",
organization_id="<value>",
name="<value>",
path="/var/log",
mime_type="<value>",
size=982910,
storage_version="<value>",
checksum_etag="<value>",
checksum_sha256_base64="<value>",
checksum_sha256_hex="<value>",
last_modified_at=parse_datetime("2024-09-13T03:57:17.676Z"),
version="<value>",
is_uploaded=False,
created_at=parse_datetime("2023-03-23T06:47:50.944Z"),
size_readable="<value>",
public_url="https://yummy-ocelot.biz/",
),
polar_sdk.ProductMediaFileRead(
id="<value>",
organization_id="<value>",
name="<value>",
path="/var/log",
mime_type="<value>",
size=982910,
storage_version="<value>",
checksum_etag="<value>",
checksum_sha256_base64="<value>",
checksum_sha256_hex="<value>",
last_modified_at=parse_datetime("2024-09-13T03:57:17.676Z"),
version="<value>",
is_uploaded=False,
created_at=parse_datetime("2023-03-23T06:47:50.944Z"),
size_readable="<value>",
public_url="https://yummy-ocelot.biz/",
),
polar_sdk.ProductMediaFileRead(
id="<value>",
organization_id="<value>",
name="<value>",
path="/var/log",
mime_type="<value>",
size=982910,
storage_version="<value>",
checksum_etag="<value>",
checksum_sha256_base64="<value>",
checksum_sha256_hex="<value>",
last_modified_at=parse_datetime("2024-09-13T03:57:17.676Z"),
version="<value>",
is_uploaded=False,
created_at=parse_datetime("2023-03-23T06:47:50.944Z"),
size_readable="<value>",
public_url="https://yummy-ocelot.biz/",
),
],
),
],
product=polar_sdk.CheckoutProduct(
created_at=parse_datetime("2023-03-01T03:35:30.257Z"),
modified_at=parse_datetime("2024-12-19T15:40:11.887Z"),
id="<value>",
name="<value>",
description="until joyful how",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
is_recurring=True,
is_archived=False,
organization_id="<value>",
prices=[
polar_sdk.LegacyRecurringProductPriceFixed(
created_at=parse_datetime("2024-05-02T18:25:33.974Z"),
modified_at=parse_datetime("2025-02-06T12:55:07.640Z"),
id="<value>",
is_archived=False,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
price_currency="<value>",
price_amount=115799,
),
polar_sdk.LegacyRecurringProductPriceCustom(
created_at=parse_datetime("2025-07-31T12:54:47.590Z"),
modified_at=parse_datetime("2023-01-11T22:31:47.320Z"),
id="<value>",
is_archived=True,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,
price_currency="<value>",
minimum_amount=203013,
maximum_amount=None,
preset_amount=119260,
),
polar_sdk.LegacyRecurringProductPriceFree(
created_at=parse_datetime("2024-04-06T18:48:21.449Z"),
modified_at=None,
id="<value>",
is_archived=True,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,
),
],
benefits=[
polar_sdk.BenefitPublic(
id="<value>",
created_at=parse_datetime("2023-11-22T11:07:53.319Z"),
modified_at=parse_datetime("2025-09-17T18:38:51.288Z"),
type=polar_sdk.BenefitType.DISCORD,
description="brr now psst",
selectable=True,
deletable=True,
organization_id="<value>",
),
polar_sdk.BenefitPublic(
id="<value>",
created_at=parse_datetime("2023-11-22T11:07:53.319Z"),
modified_at=parse_datetime("2025-09-17T18:38:51.288Z"),
type=polar_sdk.BenefitType.DISCORD,
description="brr now psst",
selectable=True,
deletable=True,
organization_id="<value>",
),
],
medias=[],
),
product_price=polar_sdk.LegacyRecurringProductPriceFixed(
created_at=parse_datetime("2024-08-14T23:26:30.929Z"),
modified_at=parse_datetime("2025-01-15T11:59:21.523Z"),
id="<value>",
is_archived=False,
product_id="<value>",
recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,
price_currency="<value>",
price_amount=499786,
),
discount=polar_sdk.CheckoutDiscountPercentageRepeatDuration(
duration=polar_sdk.DiscountDuration.REPEATING,
duration_in_months=470604,
type=polar_sdk.DiscountType.FIXED,
basis_points=567071,
id="<value>",
name="<value>",
code="<value>",
),
subscription_id="<value>",
attached_custom_fields=[
polar_sdk.AttachedCustomField(
custom_field_id="<value>",
custom_field=polar_sdk.CustomFieldNumber(
created_at=parse_datetime("2024-01-27T12:44:05.844Z"),
modified_at=parse_datetime("2023-11-12T13:10:44.040Z"),
id="<value>",
metadata={
"key": 833527,
"key1": False,
},
slug="<value>",
name="<value>",
organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737",
properties=polar_sdk.CustomFieldNumberProperties(),
),
order=786803,
required=False,
),
polar_sdk.AttachedCustomField(
custom_field_id="<value>",
custom_field=polar_sdk.CustomFieldNumber(
created_at=parse_datetime("2024-01-27T12:44:05.844Z"),
modified_at=parse_datetime("2023-11-12T13:10:44.040Z"),
id="<value>",
metadata={
"key": 833527,
"key1": False,
},
slug="<value>",
name="<value>",
organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737",
properties=polar_sdk.CustomFieldNumberProperties(),
),
order=786803,
required=False,
),
],
customer_metadata={
},
),
))
# Handle response
print(res)
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 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
- get - Get Customer
- update - Update Customer
- list_payment_methods - List Customer Payment Methods
- add_payment_method - Add Customer Payment Method
- delete_payment_method - Delete Customer Payment Method
- list - List Downloadables
- list - List License Keys
- get - Get License Key
- validate - Validate License Key
- activate - Activate License Key
- deactivate - Deactivate License Key
- list - List Orders
- get - Get Order
- update - Update Order
- generate_invoice - Generate Order Invoice
- invoice - Get Order Invoice
- get - Get Organization
- list - List Subscriptions
- get - Get Subscription
- update - Update Subscription
- cancel - Cancel Subscription
- create - Create Customer Session
- list - List Customers
- create - Create Customer
- 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 - List Discounts
- create - Create Discount
- get - Get Discount
- update - Update Discount
- delete - Delete Discount
- 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
- list - List Meters
- create - Create Meter
- get - Get Meter
- update - Update Meter
- quantities - Get Meter Quantities
- authorize - Authorize
- token - Request Token
- revoke - Revoke Token
- introspect - Introspect Token
- userinfo - Get User Info
- list - List Orders
- get - Get Order
- update - Update Order
- generate_invoice - Generate Order Invoice
- invoice - Get Order Invoice
- 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 Subscriptions
- 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
- 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(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(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:
| Property | Type | Description |
|---|---|---|
err.message |
str |
Error message |
err.status_code |
int |
HTTP response status code eg 404 |
err.headers |
httpx.Headers |
HTTP response headers |
err.body |
str |
HTTP body. Can be empty string if no body is returned. |
err.raw_response |
httpx.Response |
Raw HTTP response |
err.data |
Optional. Some errors may contain structured data. See Error Classes. |
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(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 code422. *
Less common errors (18)
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 code404. Applicable to 70 of 122 methods.*NotPermitted: Status code403. Applicable to 9 of 122 methods.*Unauthorized: Not authorized to manage license key. Status code401. Applicable to 5 of 122 methods.*AlreadyCanceledSubscription: Status code403. Applicable to 4 of 122 methods.*AlreadyActiveSubscriptionError: The checkout is expired or the customer already has an active subscription. Status code403. Applicable to 3 of 122 methods.*NotOpenCheckout: The checkout is expired or the customer already has an active subscription. Status code403. Applicable to 3 of 122 methods.*ExpiredCheckoutError: The checkout session is expired. Status code410. Applicable to 3 of 122 methods.*InvoiceAlreadyExists: Order already has an invoice. Status code409. Applicable to 2 of 122 methods.*MissingInvoiceBillingDetails: Order is not paid or is missing billing name or address. Status code422. Applicable to 2 of 122 methods.*NotPaidOrder: Order is not paid or is missing billing name or address. Status code422. Applicable to 2 of 122 methods.*RefundAmountTooHigh: Refund amount exceeds remaining order balance. Status code400. Applicable to 1 of 122 methods.*PaymentError: The payment failed. Status code400. Applicable to 1 of 122 methods.*RefundedAlready: Order is already fully refunded. Status code403. Applicable to 1 of 122 methods.*ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecauseattribute.
* 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:
| Name | Server | Description |
|---|---|---|
production |
https://api.polar.sh |
Production environment |
sandbox |
https://sandbox-api.polar.sh |
Sandbox environment |
from polar_sdk import Polar
with Polar(
server="sandbox",
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.organizations.list(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(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:
| 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 polar:
res = polar.organizations.list(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(
customer_session="<YOUR_BEARER_TOKEN_HERE>",
), organization_id=None, 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(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://docs.polar.sh/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.