Paddle

Usage Instructions

Integrates Paddle into your workflow. List and create customers, manage subscriptions (including cancellations and pauses), query transactions, and browse products and prices. Supports both production and sandbox environments.

Tools

`paddle_list_customers`

List customers in your Paddle account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Paddle API key
`sandbox`	boolean	No	Use Paddle sandbox environment
`perPage`	number	No	Number of results per page (max 200)
`email`	string	No	Filter customers by email address
`status`	string	No	Filter by status: active, archived

Output

Parameter	Type	Description
`customers`	json	Array of Paddle customer objects
`metadata`	json	Pagination metadata: total, has_more

`paddle_create_customer`

Create a new customer in Paddle

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Paddle API key
`sandbox`	boolean	No	Use Paddle sandbox environment
`email`	string	Yes	Customer email address
`name`	string	No	Customer full name
`locale`	string	No	Customer locale (e.g. en, de, fr)

Output

Parameter	Type	Description
`customer`	json	The created Paddle customer object
`metadata`	json	Customer metadata: id, email, status

`paddle_list_subscriptions`

List subscriptions in your Paddle account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Paddle API key
`sandbox`	boolean	No	Use Paddle sandbox environment
`perPage`	number	No	Number of results per page (max 200)
`customerId`	string	No	Filter by customer ID
`status`	string	No	Filter by status: active, canceled, past_due, paused, trialing

Output

Parameter	Type	Description
`subscriptions`	json	Array of Paddle subscription objects
`metadata`	json	Pagination metadata: total, has_more

`paddle_cancel_subscription`

Cancel a Paddle subscription

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Paddle API key
`sandbox`	boolean	No	Use Paddle sandbox environment
`subscriptionId`	string	Yes	The Paddle subscription ID to cancel
`effectiveFrom`	string	No	When to cancel: immediately or next_billing_period

Output

Parameter	Type	Description
`subscription`	json	The cancelled Paddle subscription object
`metadata`	json	Subscription metadata: id, status

`paddle_list_transactions`

List transactions in your Paddle account

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Paddle API key
`sandbox`	boolean	No	Use Paddle sandbox environment
`perPage`	number	No	Number of results per page (max 200)
`customerId`	string	No	Filter by customer ID
`subscriptionId`	string	No	Filter by subscription ID
`status`	string	No	Filter by status: billed, canceled, completed, draft, past_due, ready

Output

Parameter	Type	Description
`transactions`	json	Array of Paddle transaction objects
`metadata`	json	Pagination metadata: total, has_more

`paddle_list_products`

List products in your Paddle catalog

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Paddle API key
`sandbox`	boolean	No	Use Paddle sandbox environment
`perPage`	number	No	Number of results per page (max 200)
`status`	string	No	Filter by status: active, archived

Output

Parameter	Type	Description
`products`	json	Array of Paddle product objects
`metadata`	json	Metadata: total count

Paddle

Sur cette page