opensettle 0.5.1

Official Python SDK for the OpenSettle API. Stablecoin billing on Base, Ethereum, Polygon, Arbitrum, Solana, and Tron.

opensettle

Official Python SDK for the OpenSettle API.

Non-custodial stablecoin billing on Base, Ethereum, Polygon, Arbitrum, Solana and Tron. Typed end-to-end, sync and async, signed-webhook verifier included, idempotent writes by default.

Install

pip install opensettle

Requires Python 3.9+.

Conventions

• Method names are snake_case (Python idiom): os.customers.create(...).
• Body fields and response keys are camelCase, matching the API's wire format exactly. Pass customerEmail=... not customer_email=.... Read result["createdAt"] not result["created_at"]. Zero translation, no surprises.

Quickstart

import os
from opensettle import OpenSettle

client = OpenSettle(
    api_key=os.environ["OPENSETTLE_KEY"],
    workspace_id=os.environ["OPENSETTLE_WORKSPACE"],
)

# 1. Create a customer.
customer = client.customers.create(
    email="[e-mail]",
    name="Ada Lovelace",
    country="GB",
)
print(customer["id"])           # cus_…
print(customer["createdAt"])    # ISO-8601

# 2. Create a product + price.
product = client.products.create(name="Pro plan")
price = client.products.create_price(
    product["id"],
    amount=19_900,              # minor units
    currency="USD",
    interval="month",
)

# 3. Start a hosted-checkout subscription.
checkout = client.checkouts.create(
    mode="subscription",
    customerId=customer["id"],
    priceId=price["id"],
    chain="base",
    token="USDC",
    successUrl="https://merchant.com/ok",
    cancelUrl="https://merchant.com/cancel",
)
print(checkout["hostedUrl"])    # link to send the customer

Hosted checkout is EVM-only

The API accepts chain="solana" and chain="tron" on a checkout, and the chain reader will detect inbound SPL / TRC-20 deposits to verified wallets. However, the customer-facing hosted checkout page is currently EVM-only — Base, Ethereum, Polygon, and Arbitrum. Until Solana and Tron land in the hosted UI, drive those flows directly against /wallets + the chain reader rather than checkouts.create.

Async

import asyncio
from opensettle import AsyncOpenSettle

async def main() -> None:
    async with AsyncOpenSettle(api_key="sk_test_…", workspace_id="ws_…") as client:
        customer = await client.customers.create(email="[e-mail]")
        print(customer["id"])

asyncio.run(main())

Webhooks

import os
from opensettle import verify_webhook, WebhookVerificationError

@app.post("/webhooks/opensettle")
async def handler(request):
    raw = await request.body()
    try:
        event = verify_webhook(
            raw_body=raw,
            signature_header=request.headers.get("x-opensettle-signature"),
            secret=os.environ["WHSEC"],
        )
    except WebhookVerificationError as e:
        return Response(status=400, content=f"bad signature: {e.reason}")
    # event.data is the decoded JSON; event.timestamp is the signed epoch
    return Response(status=200)

Error handling

import time
from opensettle import RateLimitError, SettlementError

try:
    client.payments.refund("pay_…", amountMinor=500)
except RateLimitError as e:
    time.sleep(e.retry_after or 1)
    retry()
except SettlementError as e:
    if e.code == "insufficient_confirmations":
        wait_and_retry()

The full error hierarchy:

OpenSettleError
├── InvalidRequestError
├── InvalidStateTransitionError
├── AuthenticationError
├── ForbiddenError
├── NotFoundError
├── ConflictError
├── RateLimitError              # carries `retry_after: float | None`
├── SettlementError             # chain_reverted | insufficient_confirmations | signing_required
├── StepUpRequiredError         # aal_required
├── APIError                    # internal_error or forward-compat unknown codes
└── NetworkError                # transport-layer / timeout

Every error carries code, status, request_id, and param so you can quote the request ID in support tickets.

Configuration

os = OpenSettle(
    api_key="sk_test_…",
    workspace_id="ws_…",
    base_url="https://api.opensettle.io",   # default; override for self-host
    test_mode=None,                          # None | True | False env-assertion gate
    timeout=30.0,                            # seconds; default 30s
    max_network_retries=3,                   # 0 to disable retries
)

test_mode=True refuses sk_live_… keys; test_mode=False refuses sk_test_…. Leave None to accept either and let the API decide.

Resources

Resource	Methods
customers	list, retrieve, create, update, delete
products	list, retrieve, create, update, list_prices, create_price, update_price, delete, delete_price
invoices	list, retrieve, create, send, remind, void
payments	list, retrieve, refund, refund_broadcast
subscriptions	list, retrieve, create, pause, resume, cancel, change_plan
checkouts	create, retrieve
webhook_endpoints	list, retrieve, create, update, delete, rotate_secret, test

License

MIT — see LICENSE.