integrateledger 0.1.0__tar.gz

integrateledger-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ledger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

integrateledger-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include ledger_sdk *.py
+recursive-include integrateledger *.py
+prune tests
+prune build
+prune dist
+global-exclude *.pyc __pycache__ .DS_Store

integrateledger-0.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: integrateledger
+Version: 0.1.0
+Summary: Python client for the Ledger billing and usage API
+License-Expression: MIT
+Project-URL: Documentation, https://docs.integrateledger.com/python-sdk
+Project-URL: Homepage, https://docs.integrateledger.com
+Keywords: ledger,billing,usage,credits,sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# integrateledger
+
+The server-side Python SDK for Ledger's billing and usage API. Install it with
+`python3 -m pip install integrateledger`, then use
+`from integrateledger import ledger`. The capitalized `Ledger` class and
+`ledger_sdk` import remain available for existing source users. See the
+[Ledger docs](https://docs.integrateledger.com/python-sdk) for examples.
+
+From a repository checkout, run the SDK tests with:
+
+```bash
+python3 -m pip install ./packages/sdk-python
+python3 -m unittest discover -s packages/sdk-python/tests -v
+```
+
+```python
+import os
+from integrateledger import ledger
+
+client = ledger(api_key=os.environ["LEDGER_API_KEY"])
+client.create_feature(id="api_call", name="API call", credit_cost=1)
+client.create_plan(id="starter", name="Starter", monthly_credits=100, monthly_price_cents=1900)
+client.create_add_on(id="extra_credits", name="Extra credits", credit_amount=50, price_cents=500)
+client.create_or_get_customer(customer_id="buyer_123")
+customer = client.get_customer(customer_id="buyer_123")
+subscriptions = client.list_customer_subscriptions(customer_id="buyer_123")
+purchases = client.list_customer_purchases(customer_id="buyer_123")
+# Use an active paid subscription ID from the subscriptions list.
+client.set_subscription_cancellation(customer_id="buyer_123", subscription_id=42, cancel_at_period_end=True)
+```
+
+Methods return response dictionaries and use Python `snake_case` arguments. The client maps them to Ledger's JSON contract and sends the organization key in the `Authorization` header. Pass `base_url="http://127.0.0.1:3001"` for a local API.
+
+Use a `ledger_test_` key for Sandbox or a `ledger_live_` key for Live. The key chooses the environment; the client methods and API URL stay the same. Store these keys in separate server-side variables, and complete sandbox validation before enabling live payments.

integrateledger-0.1.0/README.md

@@ -0,0 +1,34 @@
+# integrateledger
+
+The server-side Python SDK for Ledger's billing and usage API. Install it with
+`python3 -m pip install integrateledger`, then use
+`from integrateledger import ledger`. The capitalized `Ledger` class and
+`ledger_sdk` import remain available for existing source users. See the
+[Ledger docs](https://docs.integrateledger.com/python-sdk) for examples.
+
+From a repository checkout, run the SDK tests with:
+
+```bash
+python3 -m pip install ./packages/sdk-python
+python3 -m unittest discover -s packages/sdk-python/tests -v
+```
+
+```python
+import os
+from integrateledger import ledger
+
+client = ledger(api_key=os.environ["LEDGER_API_KEY"])
+client.create_feature(id="api_call", name="API call", credit_cost=1)
+client.create_plan(id="starter", name="Starter", monthly_credits=100, monthly_price_cents=1900)
+client.create_add_on(id="extra_credits", name="Extra credits", credit_amount=50, price_cents=500)
+client.create_or_get_customer(customer_id="buyer_123")
+customer = client.get_customer(customer_id="buyer_123")
+subscriptions = client.list_customer_subscriptions(customer_id="buyer_123")
+purchases = client.list_customer_purchases(customer_id="buyer_123")
+# Use an active paid subscription ID from the subscriptions list.
+client.set_subscription_cancellation(customer_id="buyer_123", subscription_id=42, cancel_at_period_end=True)
+```
+
+Methods return response dictionaries and use Python `snake_case` arguments. The client maps them to Ledger's JSON contract and sends the organization key in the `Authorization` header. Pass `base_url="http://127.0.0.1:3001"` for a local API.
+
+Use a `ledger_test_` key for Sandbox or a `ledger_live_` key for Live. The key chooses the environment; the client methods and API URL stay the same. Store these keys in separate server-side variables, and complete sandbox validation before enabling live payments.

integrateledger-0.1.0/integrateledger/__init__.py

@@ -0,0 +1,9 @@
+"""Public Python import for the Ledger client."""
+
+from ledger_sdk import Ledger, LedgerAPIError, LedgerConnectionError
+
+# Keep the requested short constructor spelling while retaining the existing
+# capitalized class and ledger_sdk imports for existing source consumers.
+ledger = Ledger
+
+__all__ = ["ledger", "Ledger", "LedgerAPIError", "LedgerConnectionError"]

integrateledger-0.1.0/integrateledger.egg-info/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: integrateledger
+Version: 0.1.0
+Summary: Python client for the Ledger billing and usage API
+License-Expression: MIT
+Project-URL: Documentation, https://docs.integrateledger.com/python-sdk
+Project-URL: Homepage, https://docs.integrateledger.com
+Keywords: ledger,billing,usage,credits,sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# integrateledger
+
+The server-side Python SDK for Ledger's billing and usage API. Install it with
+`python3 -m pip install integrateledger`, then use
+`from integrateledger import ledger`. The capitalized `Ledger` class and
+`ledger_sdk` import remain available for existing source users. See the
+[Ledger docs](https://docs.integrateledger.com/python-sdk) for examples.
+
+From a repository checkout, run the SDK tests with:
+
+```bash
+python3 -m pip install ./packages/sdk-python
+python3 -m unittest discover -s packages/sdk-python/tests -v
+```
+
+```python
+import os
+from integrateledger import ledger
+
+client = ledger(api_key=os.environ["LEDGER_API_KEY"])
+client.create_feature(id="api_call", name="API call", credit_cost=1)
+client.create_plan(id="starter", name="Starter", monthly_credits=100, monthly_price_cents=1900)
+client.create_add_on(id="extra_credits", name="Extra credits", credit_amount=50, price_cents=500)
+client.create_or_get_customer(customer_id="buyer_123")
+customer = client.get_customer(customer_id="buyer_123")
+subscriptions = client.list_customer_subscriptions(customer_id="buyer_123")
+purchases = client.list_customer_purchases(customer_id="buyer_123")
+# Use an active paid subscription ID from the subscriptions list.
+client.set_subscription_cancellation(customer_id="buyer_123", subscription_id=42, cancel_at_period_end=True)
+```
+
+Methods return response dictionaries and use Python `snake_case` arguments. The client maps them to Ledger's JSON contract and sends the organization key in the `Authorization` header. Pass `base_url="http://127.0.0.1:3001"` for a local API.
+
+Use a `ledger_test_` key for Sandbox or a `ledger_live_` key for Live. The key chooses the environment; the client methods and API URL stay the same. Store these keys in separate server-side variables, and complete sandbox validation before enabling live payments.

integrateledger-0.1.0/integrateledger.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.py
+integrateledger/__init__.py
+integrateledger.egg-info/PKG-INFO
+integrateledger.egg-info/SOURCES.txt
+integrateledger.egg-info/dependency_links.txt
+integrateledger.egg-info/top_level.txt
+ledger_sdk/__init__.py
+ledger_sdk/client.py

integrateledger-0.1.0/integrateledger.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

integrateledger-0.1.0/integrateledger.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+integrateledger
+ledger_sdk

integrateledger-0.1.0/ledger_sdk/__init__.py

@@ -0,0 +1,5 @@
+"""Python client for Ledger's sandbox API."""
+
+from .client import Ledger, LedgerAPIError, LedgerConnectionError
+
+__all__ = ["Ledger", "LedgerAPIError", "LedgerConnectionError"]

integrateledger-0.1.0/ledger_sdk/client.py

@@ -0,0 +1,216 @@
+"""Small, dependency-free client for Ledger's public HTTP API.
+
+All method arguments use Python snake_case; JSON sent to Ledger uses the API's
+documented camelCase fields (and request_id for usage tracking).
+"""
+
+from __future__ import annotations
+
+import json
+from typing import Any, Dict, Mapping, Optional
+from urllib.error import HTTPError, URLError
+from urllib.parse import quote
+from urllib.request import Request, urlopen
+
+
+class LedgerAPIError(Exception):
+    """An HTTP error returned by Ledger."""
+
+    def __init__(self, status: int, code: str, body: Any):
+        self.status = status
+        self.code = code
+        self.body = body
+        super().__init__(f"Ledger API returned {status}: {code}")
+
+
+class LedgerConnectionError(Exception):
+    """Ledger could not be reached before a response was received."""
+
+
+class Ledger:
+    """Organization-scoped client. Keep ``api_key`` on your server."""
+
+    def __init__(
+        self,
+        *,
+        api_key: str,
+        base_url: str = "https://api.integrateledger.com",
+        timeout: float = 30.0,
+    ):
+        if not api_key:
+            raise ValueError("api_key is required")
+        if not base_url.startswith(("https://", "http://")):
+            raise ValueError("base_url must be an HTTP URL")
+        if timeout <= 0:
+            raise ValueError("timeout must be positive")
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        body: Optional[Mapping[str, Any]] = None,
+        *,
+        idempotency_key: Optional[str] = None,
+    ) -> Dict[str, Any]:
+        headers = {
+            "Accept": "application/json",
+            "Authorization": f"Bearer {self.api_key}",
+        }
+        data = None
+        if body is not None:
+            headers["Content-Type"] = "application/json"
+            data = json.dumps(body, separators=(",", ":")).encode("utf-8")
+        if idempotency_key is not None:
+            headers["Idempotency-Key"] = idempotency_key
+        request = Request(self.base_url + path, data=data, headers=headers, method=method)
+        try:
+            with urlopen(request, timeout=self.timeout) as response:
+                payload = response.read()
+                return json.loads(payload) if payload else {}
+        except HTTPError as error:
+            payload = error.read()
+            try:
+                details = json.loads(payload) if payload else {}
+            except (ValueError, TypeError):
+                details = {"error": payload.decode("utf-8", "replace")}
+            code = details.get("error", "http_error") if isinstance(details, dict) else "http_error"
+            raise LedgerAPIError(error.code, code, details) from error
+        except URLError as error:
+            raise LedgerConnectionError(str(error.reason)) from error
+
+    @staticmethod
+    def _item_path(kind: str, item_id: str) -> str:
+        return f"/v1/{kind}/{quote(item_id, safe='')}"
+
+    # Catalog
+    def publish_catalog(self, catalog: Mapping[str, Any]) -> Dict[str, Any]:
+        return self._request("PUT", "/v1/catalog", catalog)
+
+    def list_plans(self) -> Dict[str, Any]:
+        return self._request("GET", "/v1/plans")
+
+    def create_plan(self, *, id: str, name: str, monthly_credits: int, monthly_price_cents: int) -> Dict[str, Any]:
+        return self._request("POST", "/v1/plans", {
+            "id": id, "name": name, "monthlyCredits": monthly_credits,
+            "monthlyPriceCents": monthly_price_cents,
+        })
+
+    def get_plan(self, id: str) -> Dict[str, Any]:
+        return self._request("GET", self._item_path("plans", id))
+
+    def update_plan(self, id: str, *, name: str, monthly_credits: int, monthly_price_cents: int) -> Dict[str, Any]:
+        return self._request("PUT", self._item_path("plans", id), {
+            "name": name, "monthlyCredits": monthly_credits,
+            "monthlyPriceCents": monthly_price_cents,
+        })
+
+    def archive_plan(self, id: str) -> Dict[str, Any]:
+        return self._request("DELETE", self._item_path("plans", id))
+
+    def list_features(self) -> Dict[str, Any]:
+        return self._request("GET", "/v1/features")
+
+    def create_feature(self, *, id: str, name: str, credit_cost: int) -> Dict[str, Any]:
+        return self._request("POST", "/v1/features", {"id": id, "name": name, "creditCost": credit_cost})
+
+    def get_feature(self, id: str) -> Dict[str, Any]:
+        return self._request("GET", self._item_path("features", id))
+
+    def update_feature(self, id: str, *, name: str, credit_cost: int) -> Dict[str, Any]:
+        return self._request("PUT", self._item_path("features", id), {"name": name, "creditCost": credit_cost})
+
+    def archive_feature(self, id: str) -> Dict[str, Any]:
+        return self._request("DELETE", self._item_path("features", id))
+
+    def list_add_ons(self) -> Dict[str, Any]:
+        return self._request("GET", "/v1/add-ons")
+
+    def create_add_on(self, *, id: str, name: str, credit_amount: int, price_cents: int) -> Dict[str, Any]:
+        return self._request("POST", "/v1/add-ons", {
+            "id": id, "name": name, "type": "credit_pack",
+            "creditAmount": credit_amount, "priceCents": price_cents,
+        })
+
+    def get_add_on(self, id: str) -> Dict[str, Any]:
+        return self._request("GET", self._item_path("add-ons", id))
+
+    def update_add_on(self, id: str, *, name: str, credit_amount: int, price_cents: int) -> Dict[str, Any]:
+        return self._request("PUT", self._item_path("add-ons", id), {
+            "name": name, "type": "credit_pack", "creditAmount": credit_amount,
+            "priceCents": price_cents,
+        })
+
+    def archive_add_on(self, id: str) -> Dict[str, Any]:
+        return self._request("DELETE", self._item_path("add-ons", id))
+
+    # Customers, usage, and billing
+    def create_or_get_customer(self, *, customer_id: str) -> Dict[str, Any]:
+        return self._request("POST", "/v1/customers", {"customerId": customer_id})
+
+    def get_customer(self, *, customer_id: str) -> Dict[str, Any]:
+        return self._request("GET", f"/v1/customers?customerId={quote(customer_id, safe='')}")
+
+    def list_customer_subscriptions(
+        self, *, customer_id: str, limit: Optional[int] = None, cursor: Optional[int] = None
+    ) -> Dict[str, Any]:
+        return self._request("GET", self._customer_history_path("subscriptions", customer_id, limit, cursor))
+
+    def list_customer_purchases(
+        self, *, customer_id: str, limit: Optional[int] = None, cursor: Optional[int] = None
+    ) -> Dict[str, Any]:
+        return self._request("GET", self._customer_history_path("purchases", customer_id, limit, cursor))
+
+    @staticmethod
+    def _customer_history_path(kind: str, customer_id: str, limit: Optional[int], cursor: Optional[int]) -> str:
+        if limit is not None and (not isinstance(limit, int) or isinstance(limit, bool) or not 1 <= limit <= 100):
+            raise ValueError("limit must be an integer from 1 to 100")
+        if cursor is not None and (not isinstance(cursor, int) or isinstance(cursor, bool) or cursor < 1):
+            raise ValueError("cursor must be a positive integer")
+        path = f"/v1/customers/{kind}?customerId={quote(customer_id, safe='')}"
+        if limit is not None:
+            path += f"&limit={limit}"
+        if cursor is not None:
+            path += f"&cursor={cursor}"
+        return path
+
+    def set_subscription_cancellation(
+        self, *, customer_id: str, subscription_id: int, cancel_at_period_end: bool
+    ) -> Dict[str, Any]:
+        if not isinstance(subscription_id, int) or isinstance(subscription_id, bool) or subscription_id < 1:
+            raise ValueError("subscription_id must be a positive integer")
+        if not isinstance(cancel_at_period_end, bool):
+            raise ValueError("cancel_at_period_end must be a boolean")
+        return self._request(
+            "PUT",
+            f"/v1/customers/subscriptions/{subscription_id}/cancellation"
+            f"?customerId={quote(customer_id, safe='')}",
+            {"cancelAtPeriodEnd": cancel_at_period_end},
+        )
+
+    def check_credits(self, *, customer_id: str, feature_id: str) -> Dict[str, Any]:
+        return self._request("POST", "/v1/check", {"customerId": customer_id, "featureId": feature_id})
+
+    def track_usage(self, *, customer_id: str, feature_id: str, request_id: str) -> Dict[str, Any]:
+        return self._request("POST", "/v1/track", {
+            "customerId": customer_id, "featureId": feature_id, "request_id": request_id,
+        })
+
+    def attach(self, *, customer_id: str, plan_id: Optional[str] = None, add_on_id: Optional[str] = None) -> Dict[str, Any]:
+        if (plan_id is None) == (add_on_id is None):
+            raise ValueError("provide exactly one of plan_id or add_on_id")
+        body = {"customerId": customer_id}
+        if plan_id is not None:
+            body["planId"] = plan_id
+        else:
+            body["addOnId"] = add_on_id
+        return self._request("POST", "/v1/billing/attach", body)
+
+    def upgrade_paid_plan(self, *, customer_id: str, plan_id: str, idempotency_key: str) -> Dict[str, Any]:
+        if not idempotency_key:
+            raise ValueError("idempotency_key is required")
+        return self._request("POST", "/v1/billing/upgrade", {
+            "customerId": customer_id, "planId": plan_id,
+        }, idempotency_key=idempotency_key)

integrateledger-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "integrateledger"
+version = "0.1.0"
+description = "Python client for the Ledger billing and usage API"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+readme = "README.md"
+keywords = ["ledger", "billing", "usage", "credits", "sdk"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+Documentation = "https://docs.integrateledger.com/python-sdk"
+Homepage = "https://docs.integrateledger.com"
+
+[tool.setuptools]
+packages = ["ledger_sdk", "integrateledger"]

integrateledger-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

integrateledger-0.1.0/setup.py

@@ -0,0 +1,5 @@
+"""Setuptools entry point; package metadata lives in pyproject.toml."""
+
+from setuptools import setup
+
+setup()