{"_id":"@iflow-mcp/paddle-mcp-server-20251216","name":"@iflow-mcp/paddle-mcp-server-20251216","dist-tags":{"latest":"0.1.3"},"versions":{"0.1.3":{"name":"@iflow-mcp/paddle-mcp-server-20251216","version":"0.1.3","description":"MCP Server for Paddle Billing","license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/PaddleHQ/paddle-mcp-server.git"},"main":"build/index.js","type":"module","bin":{"paddle":"build/index.js"},"scripts":{"build":"tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"","dev":"tsc --watch","inspector":"npx @modelcontextprotocol/inspector build/index.js","lint":"eslint src","lint:fix":"eslint src --fix","format":"prettier --write src"},"keywords":["mcp","modelcontextprotocol","paddle","billing"],"dependencies":{"@modelcontextprotocol/sdk":"^1.18.1","@paddle/paddle-node-sdk":"^3.0.0","ts-node":"^10.9.2","typescript":"^5.8.2","zod":"~3.25.76"},"devDependencies":{"@eslint/js":"^9.23.0","@types/node":"^24.0.2","eslint":"^9.23.0","globals":"^16.0.0","prettier":"^3.5.3","typescript-eslint":"^8.27.0"},"_id":"@iflow-mcp/paddle-mcp-server-20251216@0.1.3","gitHead":"2a007da57b8508dbfa7d96f553fa32e8b18caf73","bugs":{"url":"https://github.com/PaddleHQ/paddle-mcp-server/issues"},"homepage":"https://github.com/PaddleHQ/paddle-mcp-server#readme","_nodeVersion":"20.8.1","_npmVersion":"10.1.0","dist":{"integrity":"sha512-6PBmvFfIlpFdF8QZbY2HO4BoeYwLZzfbxElZt1jrS4HlsJ4dO6J+EdqglpuzR9IvF17vgGwmXVTmPpRI+ddx7Q==","shasum":"a257cdba14c5f878d3b0eb46a2bdf2e452893f3a","tarball":"https://registry.npmjs.org/@iflow-mcp/paddle-mcp-server-20251216/-/paddle-mcp-server-20251216-0.1.3.tgz","fileCount":11,"unpackedSize":345915,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDkmCg8dljFncDf3hufWTq9UtgPtJjlr800elZuvn51FwIhAMZx+OZymUqqqLK5RmLbgJZLtZqG17eiBuGq/oGrcmfv"}]},"_npmUser":{"name":"chatflowdev","email":"chatflowdev@gmail.com"},"directories":{},"maintainers":[{"name":"chatflowdev","email":"chatflowdev@gmail.com"},{"name":"qystart","email":"987472953@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/paddle-mcp-server-20251216_0.1.3_1765850712289_0.25600075751432394"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-16T02:05:12.202Z","0.1.3":"2025-12-16T02:05:12.446Z","modified":"2025-12-16T02:05:12.756Z"},"maintainers":[{"name":"chatflowdev","email":"chatflowdev@gmail.com"},{"name":"qystart","email":"987472953@qq.com"}],"description":"MCP Server for Paddle Billing","homepage":"https://github.com/PaddleHQ/paddle-mcp-server#readme","keywords":["mcp","modelcontextprotocol","paddle","billing"],"repository":{"type":"git","url":"git+https://github.com/PaddleHQ/paddle-mcp-server.git"},"bugs":{"url":"https://github.com/PaddleHQ/paddle-mcp-server/issues"},"license":"Apache-2.0","readme":"# MCP Server for Paddle Billing\n\n[Paddle Billing](https://www.paddle.com/billing?utm_source=dx&utm_medium=paddle-mcp-server) is the developer-first merchant of record. We take care of payments, tax, subscriptions, and metrics with one unified API that does it all.\n\nThis is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides LLMs and AI agents with tools for interacting with the Paddle API.\n\n> **Important:** This MCP server works with Paddle Billing. It does not support Paddle Classic. To work with Paddle Classic, see: [Paddle Classic API reference](https://developer.paddle.com/classic/api-reference/1384a288aca7a-api-reference?utm_source=dx&utm_medium=paddle-mcp-server)\n\n[![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=paddle&config=eyJlbnYiOnsiUEFERExFX0FQSV9LRVkiOiJ5b3VyX2FwaV9rZXkiLCJQQURETEVfRU5WSVJPTk1FTlQiOiJzYW5kYm94IiwiUEFERExFX01DUF9UT09MUyI6Im5vbi1kZXN0cnVjdGl2ZSJ9LCJjb21tYW5kIjoibnB4IC15IEBwYWRkbGUvcGFkZGxlLW1jcCJ9)\n\n<a href=\"vscode:mcp/install?%7B%22name%22%3A%22paddle%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40paddle%2Fpaddle-mcp%22%5D%2C%22env%22%3A%7B%22PADDLE_API_KEY%22%3A%22your-api-key%22%2C%22PADDLE_ENVIRONMENT%22%3A%22sandbox%22%2C%22PADDLE_MCP_TOOLS%22%3A%22non-destructive%22%7D%7D\">\n  <img src=\"https://img.shields.io/badge/VS_Code-Add_Paddle_MCP-0098FF?style=flat-square&logo=visualstudiocode&logoColor=ffffff\">\n</a>\n\n## Features\n\nThe MCP server has near parity with the Paddle API, allowing AI assistants and agents to:\n\n* Manage your full Paddle catalog\n* View customer, purchase, and provisioning information\n* Handle subscription, payment, and refund workflows\n* Debug billing and order management issues\n* Create and adjust transactions directly in conversation\n* Generate financial reports for financial and operational insights\n* Implement and test Paddle integrations faster\n\n## Available tools\n\nThe MCP server can use the following tools to take actions with your Paddle account:\n\n<details>\n<summary>Products</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List products | `list_products` | ✅ | ✅ |\n| Create a product | `create_product` | ✅ | ❌ |\n| Get a product | `get_product` | ✅ | ✅ |\n| Update a product | `update_product` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Prices</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List prices | `list_prices` | ✅ | ✅ |\n| Create a price | `create_price` | ✅ | ❌ |\n| Get a price | `get_price` | ✅ | ✅ |\n| Update a price | `update_price` | ❌ | ❌ |\n| Preview prices | `preview_prices` | ✅ | ❌ |\n\n</details>\n\n<details>\n<summary>Discounts</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List discounts | `list_discounts` | ✅ | ✅ |\n| Create a discount | `create_discount` | ✅ | ❌ |\n| Get a discount | `get_discount` | ✅ | ✅ |\n| Update a discount | `update_discount` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Discount Groups</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List discount groups | `list_discount_groups` | ✅ | ✅ |\n| Create a discount group | `create_discount_group` | ✅ | ❌ |\n| Get a discount group | `get_discount_group` | ✅ | ✅ |\n| Update a discount group | `update_discount_group` | ❌ | ❌ |\n| Archive a discount group | `archive_discount_group` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Customers</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List customers | `list_customers` | ✅ | ✅ |\n| Create a customer | `create_customer` | ✅ | ❌ |\n| Get a customer | `get_customer` | ✅ | ✅ |\n| Update a customer | `update_customer` | ❌ | ❌ |\n| List credit balances for a customer | `list_credit_balances` | ✅ | ✅ |\n\n</details>\n\n<details>\n<summary>Addresses</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List addresses for a customer | `list_addresses` | ✅ | ✅ |\n| Create an address for a customer | `create_address` | ✅ | ❌ |\n| Get an address for a customer | `get_address` | ✅ | ✅ |\n| Update an address for a customer | `update_address` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Businesses</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List businesses for a customer | `list_businesses` | ✅ | ✅ |\n| Create a business for a customer | `create_business` | ✅ | ❌ |\n| Get a business for a customer | `get_business` | ✅ | ✅ |\n| Update a business for a customer | `update_business` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Transactions</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List transactions | `list_transactions` | ✅ | ✅ |\n| Create a transaction | `create_transaction` | ✅ | ❌ |\n| Get a transaction | `get_transaction` | ✅ | ✅ |\n| Update a transaction | `update_transaction` | ❌ | ❌ |\n| Preview a transaction | `preview_transaction_create` | ✅ | ❌ |\n| Revise customer information on a billed or completed transaction | `revise_transaction` | ❌ | ❌ |\n| Get a PDF invoice for a transaction | `get_transaction_invoice` | ✅ | ✅ |\n\n</details>\n\n<details>\n<summary>Adjustments</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List adjustments | `list_adjustments` | ✅ | ✅ |\n| Create an adjustment | `create_adjustment` | ✅ | ❌ |\n| Get a PDF credit note for an adjustment | `get_adjustment_credit_note` | ✅ | ✅ |\n\n</details>\n\n<details>\n<summary>Subscriptions</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List subscriptions | `list_subscriptions` | ✅ | ✅ |\n| Get a subscription | `get_subscription` | ✅ | ✅ |\n| Update a subscription | `update_subscription` | ❌ | ❌ |\n| Cancel a subscription | `cancel_subscription` | ❌ | ❌ |\n| Pause a subscription | `pause_subscription` | ❌ | ❌ |\n| Resume a paused subscription | `resume_subscription` | ❌ | ❌ |\n| Activate a trialing subscription | `activate_subscription` | ❌ | ❌ |\n| Preview an update to a subscription | `preview_subscription_update` | ✅ | ❌ |\n| Create a one-time charge for a subscription | `create_subscription_charge` | ✅ | ❌ |\n| Preview a one-time charge for a subscription | `preview_subscription_charge` | ✅ | ❌ |\n\n</details>\n\n<details>\n<summary>Saved Payment Methods</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List payment methods saved for a customer | `list_saved_payment_methods` | ✅ | ✅ |\n| Get a payment method saved for a customer | `get_saved_payment_method` | ✅ | ✅ |\n| Delete a payment method saved for a customer | `delete_saved_payment_method` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Customer Portal Sessions</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| Create a customer portal session | `create_customer_portal_session` | ✅ | ❌ |\n\n</details>\n\n<details>\n<summary>Notification Settings</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List notification settings | `list_notification_settings` | ✅ | ✅ |\n| Create a notification setting | `create_notification_setting` | ✅ | ❌ |\n| Get a notification setting | `get_notification_setting` | ✅ | ✅ |\n| Update a notification setting | `update_notification_setting` | ❌ | ❌ |\n| Delete a notification setting | `delete_notification_setting` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Events</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List events | `list_events` | ✅ | ✅ |\n\n</details>\n\n<details>\n<summary>Notifications</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List notifications | `list_notifications` | ✅ | ✅ |\n| Get a notification | `get_notification` | ✅ | ✅ |\n| Replay a notification | `replay_notification` | ✅ | ❌ |\n\n</details>\n\n<details>\n<summary>Notification Logs</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List logs for a notification | `list_notification_logs` | ✅ | ✅ |\n\n</details>\n\n<details>\n<summary>Simulations</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List simulations | `list_simulations` | ✅ | ✅ |\n| Create a simulation | `create_simulation` | ✅ | ❌ |\n| Get a simulation | `get_simulation` | ✅ | ✅ |\n| Update a simulation | `update_simulation` | ❌ | ❌ |\n\n</details>\n\n<details>\n<summary>Simulation Runs</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List runs for a simulation | `list_simulation_runs` | ✅ | ✅ |\n| Create a run for a simulation | `create_simulation_run` | ✅ | ❌ |\n| Get a run for a simulation | `get_simulation_run` | ✅ | ✅ |\n\n</details>\n\n<details>\n<summary>Simulation Run Events</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List events for a simulation run | `list_simulation_run_events` | ✅ | ✅ |\n| Get an event for a simulation run | `get_simulation_run_event` | ✅ | ✅ |\n| Replay an event for a simulation run | `replay_simulation_run_event` | ✅ | ❌ |\n\n</details>\n\n<details>\n<summary>Reports</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List reports | `list_reports` | ✅ | ✅ |\n| Create a report | `create_report` | ✅ | ❌ |\n| Get a report | `get_report` | ✅ | ✅ |\n| Get a CSV file for a report | `get_report_csv` | ✅ | ✅ |\n\n</details>\n\n<details>\n<summary>Client-Side Tokens</summary>\n\n| Operation | Tool | Non-destructive | Read only |\n|-----------|------|-----------------|-----------|\n| List client-side tokens | `list_client_side_tokens` | ✅ | ✅ |\n| Create a client-side token | `create_client_side_token` | ✅ | ❌ |\n| Get a client-side token | `get_client_side_token` | ✅ | ✅ |\n| Revoke a client-side token | `revoke_client_side_token` | ❌ | ❌ |\n\n</details>\n\n## Installation\n\nTo use the MCP server, you'll need an API key. You can create and manage API keys in **Paddle > Developer tools > Authentication**:\n\n* Sandbox: <https://sandbox-vendors.paddle.com/authentication-v2>\n* Live: <https://vendors.paddle.com/authentication-v2>\n\nAdding the following to your MCP settings file will configure and run the Paddle MCP server in a client like Claude Desktop, Cursor or Windsurf:\n\n### Method 1: One-click installation in Cursor or VS Code\n\nYou can install the Paddle MCP server with a single click in Cursor or VS Code.\n\n[![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=paddle&config=eyJlbnYiOnsiUEFERExFX0FQSV9LRVkiOiJ5b3VyX2FwaV9rZXkiLCJQQURETEVfRU5WSVJPTk1FTlQiOiJzYW5kYm94IiwiUEFERExFX01DUF9UT09MUyI6Im5vbi1kZXN0cnVjdGl2ZSJ9LCJjb21tYW5kIjoibnB4IC15IEBwYWRkbGUvcGFkZGxlLW1jcCJ9)\n\n<a href=\"vscode:mcp/install?%7B%22name%22%3A%22paddle%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40paddle%2Fpaddle-mcp%22%5D%2C%22env%22%3A%7B%22PADDLE_API_KEY%22%3A%22your-api-key%22%2C%22PADDLE_ENVIRONMENT%22%3A%22sandbox%22%2C%22PADDLE_MCP_TOOLS%22%3A%22non-destructive%22%7D%7D\">\n  <img src=\"https://img.shields.io/badge/VS_Code-Add_Paddle_MCP-0098FF?style=flat-square&logo=visualstudiocode&logoColor=ffffff\">\n</a>\n\nAfter installation, you'll need to update the configuration in your MCP settings file to replace `your_api_key` with your actual Paddle API key and adjust the environment and tools values as needed.\n\n### Method 2: Using command-line arguments (Recommended for `npx`)\n\nAdd the following to the MCP settings or configuration file in the client you're using:\n\n```json\n{\n  \"mcpServers\": {\n    \"paddle\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"-y\",\n        \"@paddle/paddle-mcp\",\n        \"--api-key=your_api_key\",\n        \"--environment=sandbox\",\n        \"--tools=non-destructive\"\n      ]\n    }\n  }\n}\n```\n\nReplace `your_api_key` with your actual Paddle API key, set `--environment` to either `sandbox` or `production`, and set `--tools` to the tools which you want to be loaded and available to the MCP client.\n\n### Method 3: Using environment variables\n\nAdd the following to the MCP settings or configuration file in the client you're using:\n\n```json\n{\n  \"mcpServers\": {\n    \"paddle\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@paddle/paddle-mcp\"],\n      \"env\": {\n        \"PADDLE_API_KEY\": \"your_api_key\",\n        \"PADDLE_ENVIRONMENT\": \"sandbox\",\n        \"PADDLE_MCP_TOOLS\": \"non-destructive\"\n      }\n    }\n  }\n}\n```\n\nReplace `your_api_key` with your actual Paddle API key, set `PADDLE_ENVIRONMENT` to either `sandbox` or `production`, and set `PADDLE_MCP_TOOLS` to the tools which you want to be loaded and available to the MCP client.\n\n### Filtering tools\n\nYou can filter which [tools](#available-tools) are loaded and available to the MCP client by passing the `--tools` argument (Method 2) or setting the `PADDLE_MCP_TOOLS` environment variable (Method 1 or 3). Accepted values are:\n\n* `all` - All tools are available\n* `read-only` - Only read operations are available\n* `non-destructive` - Read operations and safe write operations are available (default)\n* A comma-separated list of specific tool names (e.g., `list_products,get_product,create_product`)\n\nFor detailed setup guides, see:\n\n* [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)\n* [Cursor](https://docs.cursor.com/context/model-context-protocol)\n* [Windsurf](https://docs.codeium.com/windsurf/mcp)\n\n## Development\n\n1. Install dependencies:\n\n   ```bash\n   pnpm install\n   ```\n\n2. Build the server:\n\n   ```bash\n   pnpm build\n   ```\n\n3. Update client to use the local build:\n\n   ```json\n   {\n     \"mcpServers\": {\n       \"paddle\": {\n         \"command\": \"node\",\n         \"args\": [\"path/to/paddle-mcp-server/build/index.js\"],\n         \"env\": {\n           \"PADDLE_API_KEY\": \"your_api_key\",\n           \"PADDLE_ENVIRONMENT\": \"sandbox\",\n           \"PADDLE_MCP_TOOLS\": \"all\"\n         }\n       }\n     }\n   }\n   ```\n\n   The `PADDLE_MCP_TOOLS` environment variable accepts the same values as the `--tools` argument: `all`, `read-only`, `non-destructive`, or a comma-separated list of tool names. If not set, defaults to `non-destructive`.\n\n## Debugging\n\nTo debug the MCP server, you can use the MCP Inspector tool:\n\n1. Run the server with the inspector:\n\n   ```bash\n   pnpm inspector\n   ```\n\n2. Open the provided URL in your browser to view and debug the MCP requests and responses.\n\n3. Include the `--api-key` and `--environment` arguments.\n\n## Learn more\n\n* [Paddle developer docs](https://developer.paddle.com?utm_source=dx&utm_medium=paddle-mcp-server)\n* [Paddle API reference](https://developer.paddle.com/api-reference/overview?utm_source=dx&utm_medium=paddle-mcp-server)\n* [Sign up for Paddle Billing](https://login.paddle.com/signup?utm_source=dx&utm_medium=paddle-mcp-server)\n","readmeFilename":"README.md","_rev":"1-1cbdeba630a0842eb051f374fce55d06"}