{"id":42659915,"url":"https://github.com/websideproject/paddle-billing-client","last_synced_at":"2026-01-29T09:41:46.085Z","repository":{"id":195312241,"uuid":"678043083","full_name":"websideproject/paddle-billing-client","owner":"websideproject","description":"Python wrapper around the new Paddle Billing API","archived":false,"fork":false,"pushed_at":"2025-11-22T02:21:44.000Z","size":2337,"stargazers_count":17,"open_issues_count":52,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-22T04:18:22.765Z","etag":null,"topics":["api-client","paddle","subscription"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/websideproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-08-13T13:54:28.000Z","updated_at":"2025-10-06T09:20:42.000Z","dependencies_parsed_at":"2023-09-29T12:39:26.534Z","dependency_job_id":"30e33ed1-3ab1-499f-944f-d2e14583a927","html_url":"https://github.com/websideproject/paddle-billing-client","commit_stats":null,"previous_names":["webstormitdev/paddle-billing-client","websideproject/paddle-billing-client"],"tags_count":39,"template":false,"template_full_name":null,"purl":"pkg:github/websideproject/paddle-billing-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websideproject%2Fpaddle-billing-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websideproject%2Fpaddle-billing-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websideproject%2Fpaddle-billing-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websideproject%2Fpaddle-billing-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/websideproject","download_url":"https://codeload.github.com/websideproject/paddle-billing-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websideproject%2Fpaddle-billing-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28874261,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T07:35:32.468Z","status":"ssl_error","status_checked_at":"2026-01-29T07:33:31.463Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","paddle","subscription"],"created_at":"2026-01-29T09:41:45.475Z","updated_at":"2026-01-29T09:41:46.072Z","avatar_url":"https://github.com/websideproject.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# paddle-billing-client\n\n\u003cdiv align=\"center\"\u003e\n\n[![Build status](https://github.com/websideproject/paddle-billing-client/workflows/build/badge.svg?branch=main\u0026event=push)](https://github.com/websideproject/paddle-billing-client/actions?query=workflow%3Abuild)\n[![Python Version](https://img.shields.io/pypi/pyversions/paddle-billing-client.svg)](https://pypi.org/project/paddle-billing-client/)\n[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/websideproject/paddle-billing-client/pulls?utf8=%E2%9C%93\u0026q=is%3Apr%20author%3Aapp%2Fdependabot)\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)\n[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/websideproject/paddle-billing-client/blob/main/.pre-commit-config.yaml)\n[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/websideproject/paddle-billing-client/releases)\n[![License](https://img.shields.io/github/license/websideproject/paddle-billing-client)](https://github.com/websideproject/paddle-billing-client/blob/main/LICENSE)\n![Coverage Report](assets/images/coverage.svg)\n![HitCount](https://img.shields.io/endpoint?url=https%3A%2F%2Fhits.dwyl.com%2Fwebsideproject%2Fpaddle-billing-client.json\u0026label=Visitors\u0026color=%23FF7F50\u0026link=http%3A%2F%2Fhits.dwyl.com%2Fwebsideproject%2Fpaddle-billing-client)\n![UniqueHitCount](https://img.shields.io/endpoint?url=https%3A%2F%2Fhits.dwyl.com%2Fwebsideproject%2Fpaddle-billing-client.json%3Fshow%3Dunique\u0026label=Unique%20visitors\u0026color=%23DC143C\u0026link=http%3A%2F%2Fhits.dwyl.com%2Fwebsideproject%2Fpaddle-billing-client)\n![Downloads](https://img.shields.io/pypi/dm/paddle-billing-client.svg)\n\nPython wrapper around the new Paddle Billing API\n\n\u003c/div\u003e\n\n## Paddle Classic vs Paddle Billing\n\n- Paddle Classic is the original Paddle API, which is still in use by many merchants. More info can be found [here](https://developer.paddle.com/classic/api-reference/1384a288aca7a-api-reference)\n  - If you are looking for the Paddle Classic API wrapper, please see [`paddle-client`](https://github.com/paddle-python/paddle-client)\n- Paddle Billing is the new API, which is just launched at 2023, August. Paddle Billing is a complete rewrite of the Paddle Classic API, and is designed to be more flexible and easier to use. More info can be found [here](https://developer.paddle.com/api-reference/overview)\n\n### Django Integration\n- For Paddle Classic, there is a Django integration available at [`dj-paddle`](https://github.com/paddle-python/dj-paddle) and [`django-paddle`](https://github.com/kennell/django-paddle)\n- For Paddle Billing, there is a Work In Progress Django integration available at [`django-paddle-billing`](https://github.com/websideproject/django-paddle-billing)\n---\n## 📦 Features\n\n- Pydantic models for all API requests and responses\n- Tests with [`pytest`](https://docs.pytest.org/en/latest/) and [`VCR.py`](https://vcrpy.readthedocs.io/en/latest/) for mocking HTTP requests\n- [`Website stalker`](https://github.com/EdJoPaTo/website-stalker) Github Action to monitor any API changes\n- Pagination support with generator to process pages one by one\n- Helper function for signature validation for webhooks\n\n### Tests\n\n- [x] Products\n- [x] Prices\n- [x] Discounts\n- [x] Customers\n   - [ ] Customer Credit balances\n- [x] Addresses\n- [x] Businesses\n- [x] Transactions\n- [x] Subscriptions (except activate)\n   - [x] Subscription Resume\n   - [ ] Subscription Activate Trialing\n- [x] Adjustments\n- [x] Pricing Previews\n- [ ] Reports\n- [x] Event types\n- [x] Events\n- [x] Notification Settings\n- [x] Notifications\n- [ ] Notification logs\n\n## Installation\n\n```bash\npip install -U paddle-billing-client\n```\n\nor install with `Poetry`\n\n```bash\npoetry add paddle-billing-client\n```\n\n## Usage\n\n```python\nfrom paddle_billing_client.client import PaddleApiClient\nfrom apiclient.authentication_methods import HeaderAuthentication\n\n\nclient = PaddleApiClient(\n    base_url=\"https://sandbox-api.paddle.com\", \n    authentication_method=HeaderAuthentication(token=\"your-paddle-token\")\n)\n\n# Create a product\nproduct = client.create_product(\n            ProductRequest(\n                name=\"Test Product New\",\n                tax_category=\"standard\",\n                description=\"Test Product Description\",\n                image_url=\"https://example.com/image.png\",\n                custom_data=dict(foo=\"bar\"),\n            )\n        )\n                         \n# Get all products\nproducts = client.list_products()\n\n# Get all prices\nplans = client.list_prices()\n\n# Pagination\nfrom paddle_billing_client.pagination import paginate\nfrom paddle_billing_client.models.notification import NotificationQueryParams\n\nfor notification in paginate(client.list_notifications, query_params=NotificationQueryParams(\n        status=\"delivered\",\n        after='ntf_01hb1n6nw8yx1wwts2cyh632s9',\n        per_page=10\n    )):\n        # Process notifications page by page\n        print(\"Notification:\")\n        print(len(notification.data))\n        print(notification.data[-1].id)\n```\n\n### Debugging\n\nTo print the raw exception response, you can use the `VerboseErrorHandler`:\n\n  ```python\n  from paddle_billing_client.client import PaddleApiClient\n  from apiclient.authentication_methods import HeaderAuthentication\n  from paddle_billing_client.errors import VerboseErrorHandler\n  \n  client = PaddleApiClient(\n      base_url=\"https://sandbox-api.paddle.com\", \n      authentication_method=HeaderAuthentication(token=\"your-paddle-token\"),\n      error_handler=VerboseErrorHandler\n  )\n  ```\n\n- Sandbox API url: `https://sandbox-api.paddle.com/`\n- Live API url: `https://api.paddle.com/`\n\nMore usage examples can be found in **tests**.\n\n### Helper functions\n\n```python\nfrom paddle_billing_client.helpers import validate_webhook_signature\n\n# Validate webhook signature\nis_valid = validate_webhook_signature(\n    signature_header=request.headers.get(\"HTTP_PADDLE_SIGNATURE\"),\n    raw_body=request.data,\n    secret_key=\"your-paddle-secret-key\",\n)\n```\n\n### Makefile usage\n\n[`Makefile`](https://github.com/websideproject/paddle-billing-client/blob/main/Makefile) contains a lot of functions for faster development.\n\n\u003cdetails\u003e\n\u003csummary\u003e1. Download and remove Poetry\u003c/summary\u003e\n\u003cp\u003e\n\nTo download and install Poetry run:\n\n```bash\nmake poetry-download\n```\n\nTo uninstall\n\n```bash\nmake poetry-remove\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e2. Install all dependencies and pre-commit hooks\u003c/summary\u003e\n\u003cp\u003e\n\nInstall requirements:\n\n```bash\nmake install\n```\n\nPre-commit hooks coulb be installed after `git init` via\n\n```bash\nmake pre-commit-install\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e3. Codestyle\u003c/summary\u003e\n\u003cp\u003e\n\nAutomatic formatting uses `pyupgrade`, `isort` and `black`.\n\n```bash\nmake codestyle\n\n# or use synonym\nmake formatting\n```\n\nCodestyle checks only, without rewriting files:\n\n```bash\nmake check-codestyle\n```\n\n\u003e Note: `check-codestyle` uses `isort`, `black` and `darglint` library\n\nUpdate all dev libraries to the latest version using one comand\n\n```bash\nmake update-dev-deps\n```\n\n\u003cdetails\u003e\n\u003csummary\u003e4. Code security\u003c/summary\u003e\n\u003cp\u003e\n\n```bash\nmake check-safety\n```\n\nThis command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.\n\n```bash\nmake check-safety\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e5. Type checks\u003c/summary\u003e\n\u003cp\u003e\n\nRun `mypy` static type checker\n\n```bash\nmake mypy\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e6. Tests with coverage badges\u003c/summary\u003e\n\u003cp\u003e\n\nRun `pytest`\n\n```bash\nmake test\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e7. All linters\u003c/summary\u003e\n\u003cp\u003e\n\nOf course there is a command to ~~rule~~ run all linters in one:\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake test \u0026\u0026 make check-codestyle \u0026\u0026 make mypy \u0026\u0026 make check-safety\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e8. Docker\u003c/summary\u003e\n\u003cp\u003e\n\n```bash\nmake docker-build\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker-build VERSION=latest\n```\n\nRemove docker image with\n\n```bash\nmake docker-remove\n```\n\nMore information [about docker](https://github.com/websideproject/paddle-billing-client/tree/main/docker).\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e9. Cleanup\u003c/summary\u003e\n\u003cp\u003e\nDelete pycache files\n\n```bash\nmake pycache-remove\n```\n\nRemove package build\n\n```bash\nmake build-remove\n```\n\nDelete .DS_STORE files\n\n```bash\nmake dsstore-remove\n```\n\nRemove .mypycache\n\n```bash\nmake mypycache-remove\n```\n\nOr to remove all above run:\n\n```bash\nmake cleanup\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n## 📈 Releases\n\nYou can see the list of available releases on the [GitHub Releases](https://github.com/websideproject/paddle-billing-client/releases) page.\n\nWe follow [Semantic Versions](https://semver.org/) specification.\n\nWe use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.\n\n### List of labels and corresponding titles\n\n|               **Label**               |  **Title in Releases**  |\n| :-----------------------------------: | :---------------------: |\n|       `enhancement`, `feature`        |       🚀 Features       |\n| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes \u0026 Refactoring  |\n|       `build`, `ci`, `testing`        | 📦 Build System \u0026 CI/CD |\n|              `breaking`               |   💥 Breaking Changes   |\n|            `documentation`            |    📝 Documentation     |\n|            `dependencies`             | ⬆️ Dependencies updates |\n\nYou can update it in [`release-drafter.yml`](https://github.com/websideproject/paddle-billing-client/blob/main/.github/release-drafter.yml).\n\nGitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.\n\n### Building and releasing your package\n\nBuilding a new version of the application contains steps:\n\n- Bump the version of your package `poetry version \u003cversion\u003e`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.\n- Make a commit to `GitHub`.\n- Create a `GitHub release`.\n- And... publish 🙂 `poetry publish --build`\n\n## 🚀 Package Template Features\n\n### Development features\n\n- Supports for `Python 3.10` and higher.\n- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/websideproject/paddle-billing-client/blob/main/pyproject.toml) and [`setup.cfg`](https://github.com/websideproject/paddle-billing-client/blob/main/setup.cfg).\n- Automatic codestyle with [`black`](https://github.com/psf/black), [`isort`](https://github.com/timothycrosley/isort) and [`pyupgrade`](https://github.com/asottile/pyupgrade).\n- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.\n- Type checks with [`mypy`](https://mypy.readthedocs.io); docstring checks with [`darglint`](https://github.com/terrencepreilly/darglint); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)\n- Testing with [`pytest`](https://docs.pytest.org/en/latest/).\n- Ready-to-use [`.editorconfig`](https://github.com/websideproject/paddle-billing-client/blob/main/.editorconfig), [`.dockerignore`](https://github.com/websideproject/paddle-billing-client/blob/main/.dockerignore), and [`.gitignore`](https://github.com/websideproject/paddle-billing-client/blob/main/.gitignore). You don't have to worry about those things.\n\n### Deployment features\n\n- `GitHub` integration: issue and pr templates.\n- `Github Actions` with predefined [build workflow](https://github.com/websideproject/paddle-billing-client/blob/main/.github/workflows/build.yml) as the default CI/CD.\n- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/websideproject/paddle-billing-client/blob/main/Makefile#L89). More details in [makefile-usage](#makefile-usage).\n- [Dockerfile](https://github.com/websideproject/paddle-billing-client/blob/main/docker/Dockerfile) for your package.\n- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).\n- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/websideproject/paddle-billing-client/blob/main/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.\n\n### Open source community features\n\n- Ready-to-use [Pull Requests templates](https://github.com/websideproject/paddle-billing-client/blob/main/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/websideproject/paddle-billing-client/tree/main/.github/ISSUE_TEMPLATE).\n- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.\n- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/websideproject/paddle-billing-client/blob/main/.github/.stale.yml).\n- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).\n\n## 🛡 License\n\n[![License](https://img.shields.io/github/license/websideproject/paddle-billing-client)](https://github.com/websideproject/paddle-billing-client/blob/main/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/websideproject/paddle-billing-client/blob/main/LICENSE) for more details.\n\n## 📃 Citation\n\n```bibtex\n@misc{paddle-billing-client,\n  author = {Benjamin Gervan},\n  title = {Python wrapper around the new Paddle Billing API},\n  year = {2023},\n  publisher = {GitHub},\n  journal = {GitHub repository},\n  howpublished = {\\url{https://github.com/websideproject/paddle-billing-client}}\n}\n```\n\n## Credits [![🚀 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/TezRomacH/python-package-template)\n\nThis project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebsideproject%2Fpaddle-billing-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebsideproject%2Fpaddle-billing-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebsideproject%2Fpaddle-billing-client/lists"}