Stripe

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

Credentials

stripeApi (alias: @stripe)

CREDENTIAL @stripe = stripeApi "My Stripe"

Operations

Resource: balance

get

No additional parameters.

Resource: charge

create

Parameter	Type	Default	Details
customerId	string	""	required
amount	number	0	required
currency	options	""	required
source	string	""	required
additionalFields	collection	{}	keys: description, metadata, receipt_email, shipping

get

Parameter	Type	Default	Details
chargeId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50

update

Parameter	Type	Default	Details
chargeId	string	""	required
updateFields	collection	{}	keys: description, metadata, receipt_email, shipping

Resource: coupon

create

Parameter	Type	Default	Details
duration	options	"once"	required; forever, once
type	options	"percent"	required; fixedAmount, percent
amountOff	number	0	required
currency	options	""	required
percentOff	number	1	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50

Resource: customer

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: address, description, email, metadata, phone, shipping

delete

Parameter	Type	Default	Details
customerId	string	""	required

get

Parameter	Type	Default	Details
customerId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	50
filters	collection	{}	keys: email

update

Parameter	Type	Default	Details
customerId	string	""	required
updateFields	collection	{}	keys: address, description, email, metadata, name, phone, ...

Resource: customerCard

add

Parameter	Type	Default	Details
customerId	string	""	required
token	string	""	required

get

Parameter	Type	Default	Details
customerId	string	""	required
sourceId	string	""	required

remove

Parameter	Type	Default	Details
customerId	string	""	required
cardId	string	""	required

Resource: meterEvent

create

Parameter	Type	Default	Details
eventName	string	""	required
customerId	string	""	required
value	number	1	required
additionalFields	collection	{}	keys: identifier, timestamp, customPayload

Resource: source

create

Parameter	Type	Default	Details
customerId	string	""	required
type	options	"wechat"	required; wechat
amount	number	0
currency	options	""
additionalFields	collection	{}	keys: metadata, statement_descriptor

delete

Parameter	Type	Default	Details
customerId	string	""	required
sourceId	string	""	required

get

Parameter	Type	Default	Details
sourceId	string	""	required

Resource: token

create

Parameter	Type	Default	Details
type	options	"cardToken"	required; cardToken
number	string	""
cvc	string	""
expirationMonth	string	""
expirationYear	string	""

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
description	string	""
metadata	fixedCollection	[]	groups: metadataProperties
receipt_email	string	""
shipping	fixedCollection	[]	groups: shippingProperties

updateFields children:

Parameter	Type	Default	Details
description	string	""
metadata	fixedCollection	{}	groups: metadataProperties
receipt_email	string	""
shipping	fixedCollection	{}	groups: shippingProperties

filters children:

Parameter	Type	Default	Details
email	string	""

Example

NODE "stripe" @stripe AS "Stripe" {
  resource: "balance",
  operation: "get",
  customerId: {{ $json.customerId }},
  token: {{ $json.token }},
  cardId: {{ $json.cardId }}
}