data
Paddle CLI for AI Agents
Use the Paddle CLI from KosmoKrator to call Paddle tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Paddle CLI Setup
Paddle can be configured headlessly with `kosmokrator integrations:configure paddle`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure paddle --set access_token="$PADDLE_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor paddle --json
kosmokrator integrations:status --json Credentials
Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
access_token | PADDLE_ACCESS_TOKEN | Secret secret | yes | Access Token |
url | PADDLE_URL | URL url | no | Paddle API URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call paddle.paddle_list_transactions '{"limit":1,"after":"example_after","status":"example_status","customer_id":"example_customer_id"}' --json kosmo integrations:paddle paddle_list_transactions '{"limit":1,"after":"example_after","status":"example_status","customer_id":"example_customer_id"}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs paddle --json
kosmo integrations:docs paddle.paddle_list_transactions --json
kosmo integrations:schema paddle.paddle_list_transactions --json
kosmo integrations:search "Paddle" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
paddle.paddle_list_transactions
List Paddle transactions. Supports filtering by status and customer ID, with cursor-based pagination.
read - Parameters
- limit, after, status, customer_id
kosmo integrations:call paddle.paddle_list_transactions '{"limit":1,"after":"example_after","status":"example_status","customer_id":"example_customer_id"}' --json kosmo integrations:paddle paddle_list_transactions '{"limit":1,"after":"example_after","status":"example_status","customer_id":"example_customer_id"}' --json paddle.paddle_get_transaction
Get detailed information about a specific Paddle transaction by its ID.
read - Parameters
- id
kosmo integrations:call paddle.paddle_get_transaction '{"id":"example_id"}' --json kosmo integrations:paddle paddle_get_transaction '{"id":"example_id"}' --json paddle.paddle_list_customers
List Paddle customers. Supports filtering by email and name, with cursor-based pagination.
read - Parameters
- limit, after, email, name
kosmo integrations:call paddle.paddle_list_customers '{"limit":1,"after":"example_after","email":"example_email","name":"example_name"}' --json kosmo integrations:paddle paddle_list_customers '{"limit":1,"after":"example_after","email":"example_email","name":"example_name"}' --json paddle.paddle_get_customer
Get detailed information about a specific Paddle customer by their ID.
read - Parameters
- id
kosmo integrations:call paddle.paddle_get_customer '{"id":"example_id"}' --json kosmo integrations:paddle paddle_get_customer '{"id":"example_id"}' --json paddle.paddle_create_customer
Create a new customer in Paddle. An email address is required.
write - Parameters
- email, name
kosmo integrations:call paddle.paddle_create_customer '{"email":"example_email","name":"example_name"}' --json kosmo integrations:paddle paddle_create_customer '{"email":"example_email","name":"example_name"}' --json paddle.paddle_list_products
List Paddle products. Supports filtering by status with cursor-based pagination.
read - Parameters
- limit, after, status
kosmo integrations:call paddle.paddle_list_products '{"limit":1,"after":"example_after","status":"example_status"}' --json kosmo integrations:paddle paddle_list_products '{"limit":1,"after":"example_after","status":"example_status"}' --json paddle.paddle_get_current_user
Verify Paddle API connectivity by performing a health check request. Returns connection status and API response.
read - Parameters
- none
kosmo integrations:call paddle.paddle_get_current_user '{}' --json kosmo integrations:paddle paddle_get_current_user '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
paddle.paddle_list_transactions 4 parameters
kosmo integrations:schema paddle.paddle_list_transactions --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of transactions to return per page (default: 50). |
after | string | no | Cursor for pagination — pass the value from a previous response to get the next page. |
status | string | no | Filter by transaction status: "completed", "pending", "billed", "paid", "canceled", "past_due". |
customer_id | string | no | Filter transactions by customer ID. |
paddle.paddle_get_transaction 1 parameters
kosmo integrations:schema paddle.paddle_get_transaction --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The Paddle transaction ID (e.g., "txn_01abc123"). |
paddle.paddle_list_customers 4 parameters
kosmo integrations:schema paddle.paddle_list_customers --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of customers to return per page (default: 50). |
after | string | no | Cursor for pagination — pass the value from a previous response to get the next page. |
email | string | no | Filter customers by email address. |
name | string | no | Filter customers by name. |
paddle.paddle_get_customer 1 parameters
kosmo integrations:schema paddle.paddle_get_customer --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The Paddle customer ID (e.g., "ctm_01abc123"). |
paddle.paddle_create_customer 2 parameters
kosmo integrations:schema paddle.paddle_create_customer --json | Parameter | Type | Required | Description |
|---|---|---|---|
email | string | yes | Customer email address. |
name | string | no | Customer display name. |
paddle.paddle_list_products 3 parameters
kosmo integrations:schema paddle.paddle_list_products --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of products to return per page (default: 50). |
after | string | no | Cursor for pagination — pass the value from a previous response to get the next page. |
status | string | no | Filter by product status: "active", "archived". |
paddle.paddle_get_current_user 0 parameters
kosmo integrations:schema paddle.paddle_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.