Paddle

Node: paddle · Full type: n8n-nodes-base.paddle · Version: 1

Credentials

paddleApi (alias: @paddle)

CREDENTIAL @paddle = paddleApi "My Paddle"

Operations

Resource: coupon

create

Parameter	Type	Default	Details
couponType	options	"checkout"	checkout, product
productIds	multiOptions	[]	required
discountType	options	"flat"	flat, percentage
discountAmount	number	1
discountAmount	number	1
currency	options	"EUR"	ARS, AUD, BRL, CAD, CHF, CNY, CZK, DKK, ... (26 total)
jsonParameters	boolean	false
additionalFieldsJson	json	""
additionalFields	collection	{}	keys: allowedUses, couponCode, couponPrefix, description, expires, group, ...

getAll

Parameter	Type	Default	Details
productId	string	""	required
returnAll	boolean	false
limit	number	100

update

Parameter	Type	Default	Details
updateBy	options	"couponCode"	couponCode, group
couponCode	string	""
group	string	""
jsonParameters	boolean	false
additionalFieldsJson	json	""
additionalFields	collection	{}	keys: allowedUses, discount, expires, newCouponCode, newGroup, productIds, ...

Resource: payment

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
jsonParameters	boolean	false
additionalFieldsJson	json	""
additionalFields	collection	{}	keys: from, to, isPaid, plan, subscriptionId, state, ...

reschedule

Parameter	Type	Default	Details
paymentId	options	""	required
date	dateTime	""

Resource: plan

get

Parameter	Type	Default	Details
planId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100

Resource: product

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100

Resource: user

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100	required
jsonParameters	boolean	false
additionalFieldsJson	json	""
additionalFields	collection	{}	keys: planId, subscriptionId, state

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
allowedUses	number	1
couponCode	string	""
couponPrefix	string	""
description	string	""
expires	dateTime	""
group	string	""
numberOfCoupons	number	1
recurring	boolean	false

Example

NODE "paddle" @paddle AS "Paddle" {
  resource: "coupon",
  operation: "get",
  productId: {{ $json.productId }},
  planId: {{ $json.planId }}
}