Paddle

Paddle integration (Finance). Imported from open-connector.

API key12 toolshttps://api.paddle.com

GET

paddle_list_products

List Paddle products with optional filtering, pagination, and price inclusion.

/products

9 parameters

Param	Type	Required	Description
after	string	optional	Paddle ID cursor returned in a previous list response.
perPage	integer	optional	Maximum number of entities to request from Paddle.
orderBy	string	optional	Paddle order_by expression such as `id[DESC]`.
skipCount	boolean	optional	Whether to send Skip-Count: true to speed up list responses.
ids	array	optional	Product IDs to return.
include	array	optional	Related entities to include in each product.
status	array	optional	Product statuses to return.
taxCategory	array	optional	Product tax categories to return.
type	string	optional	Paddle entity type.

GET

paddle_get_product

Get one Paddle product by ID.

/products/{id}

1 parameter

Param	Type	Required	Description
id	string	required	Paddle product ID, prefixed with `pro_`.

POST

paddle_create_product

Create a Paddle product in the catalog.

/products

6 parameters

Param	Type	Required	Description
name	string	required	Name of the product.
description	string	optional	Short description for the product.
tax_category	string	optional	Paddle product tax category.
type	string	optional	Paddle entity type.
image_url	string	optional	Image URL for this product.
custom_data	object	optional	—

PATCH

paddle_update_product

Update a Paddle product, including archiving or reactivating it through status.

/products/{id}

8 parameters

Param	Type	Required	Description
id	string	required	Paddle product ID, prefixed with `pro_`.
name	string	optional	Name of the product.
description	string	optional	Short description for the product.
tax_category	string	optional	Paddle product tax category.
type	string	optional	Paddle entity type.
image_url	string	optional	Image URL for this product.
custom_data	object	optional	—
status	string	optional	Paddle entity status.

GET

paddle_list_prices

List Paddle prices with optional product, status, recurring, and billing filters.

/prices

12 parameters

Param	Type	Required	Description
after	string	optional	Paddle ID cursor returned in a previous list response.
perPage	integer	optional	Maximum number of entities to request from Paddle.
orderBy	string	optional	Paddle order_by expression such as `id[DESC]`.
skipCount	boolean	optional	Whether to send Skip-Count: true to speed up list responses.
ids	array	optional	Price IDs to return.
include	array	optional	Related entities to include in each price.
productIds	array	optional	Product IDs whose prices should be returned.
status	array	optional	Price statuses to return.
recurring	boolean	optional	Whether to return recurring prices.
billingCycleInterval	string	optional	Billing interval unit.
billingCycleFrequency	integer	optional	Billing cycle frequency to filter by.
type	string	optional	Paddle entity type.

GET

paddle_get_price

Get one Paddle price by ID.

/prices/{id}

1 parameter

Param	Type	Required	Description
id	string	required	Paddle price ID, prefixed with `pri_`.

POST

paddle_create_price

Create a Paddle price for a product.

/prices

10 parameters

Param	Type	Required	Description
product_id	string	required	Paddle product ID, prefixed with `pro_`.
description	string	required	Internal description for this price.
unit_price	object	required	Money amount in Paddle's lowest currency denomination.
type	string	optional	Paddle entity type.
name	string	optional	Name of this price.
billing_cycle	object	optional	—
trial_period	object	optional	—
tax_mode	string	optional	How Paddle should calculate tax for this price.
quantity	object	optional	Quantity limits for the related product at this price.
custom_data	object	optional	—

PATCH

paddle_update_price

Update a Paddle price, including archiving or reactivating it through status.

/prices/{id}

12 parameters

Param	Type	Required	Description
id	string	required	Paddle price ID, prefixed with `pri_`.
product_id	string	optional	Paddle product ID, prefixed with `pro_`.
description	string	optional	Internal description for this price.
unit_price	object	optional	Money amount in Paddle's lowest currency denomination.
type	string	optional	Paddle entity type.
name	string	optional	Name of this price.
billing_cycle	object	optional	—
trial_period	object	optional	—
tax_mode	string	optional	How Paddle should calculate tax for this price.
quantity	object	optional	Quantity limits for the related product at this price.
custom_data	object	optional	—
status	string	optional	Paddle entity status.

GET

paddle_list_customers

List Paddle customers with optional email, status, search, and pagination filters.

/customers

8 parameters

Param	Type	Required	Description
after	string	optional	Paddle ID cursor returned in a previous list response.
perPage	integer	optional	Maximum number of entities to request from Paddle.
orderBy	string	optional	Paddle order_by expression such as `id[DESC]`.
skipCount	boolean	optional	Whether to send Skip-Count: true to speed up list responses.
ids	array	optional	Customer IDs to return.
emails	array	optional	Email addresses to match exactly.
status	array	optional	Customer statuses to return.
search	string	optional	Search query matched against customer ID, name, and email.

GET

paddle_get_customer

Get one Paddle customer by ID.

/customers/{id}

1 parameter

Param	Type	Required	Description
id	string	required	Paddle customer ID, prefixed with `ctm_`.

POST

paddle_create_customer

Create a Paddle customer.

/customers

4 parameters

Param	Type	Required	Description
name	string	optional	Full name for this customer.
email	string	required	Email address for this customer.
locale	string	optional	IETF BCP 47 locale tag for this customer.
custom_data	object	optional	—

PATCH

paddle_update_customer

Update a Paddle customer, including archiving or reactivating it through status.

/customers/{id}

6 parameters

Param	Type	Required	Description
id	string	required	Paddle customer ID, prefixed with `ctm_`.
name	string	optional	Full name for this customer.
email	string	optional	Email address for this customer.
locale	string	optional	IETF BCP 47 locale tag for this customer.
custom_data	object	optional	—
status	string	optional	Paddle entity status.