stripe.json•12.6 kB
{
"nodeType": "n8n-nodes-base.stripe",
"displayName": "Stripe",
"description": "Consume the Stripe API",
"version": 1,
"properties": [
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "get",
"description": "Get a balance",
"options": [
{
"name": "Get",
"value": "get",
"description": "Get a balance"
}
],
"displayOptions": {
"show": {
"resource": [
"balance"
]
}
}
},
{
"name": "customerId",
"displayName": "Customer ID",
"type": "string",
"default": "",
"description": "ID of the customer to be associated with this charge",
"required": true,
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"create"
]
}
}
},
{
"name": "amount",
"displayName": "Amount",
"type": "number",
"default": 0,
"description": "Amount in cents to be collected for this charge, e.g. enter <code>100</code> for $1.00",
"required": true,
"typeOptions": {
"minValue": 0,
"maxValue": 99999999
},
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"create"
]
}
}
},
{
"name": "currency",
"displayName": "Currency Name or ID",
"type": "options",
"default": "",
"description": "Three-letter ISO currency code, e.g. <code>USD</code> or <code>EUR</code>. It must be a <a href=\"https://stripe.com/docs/currencies\">Stripe-supported currency</a>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"create"
]
}
}
},
{
"name": "source",
"displayName": "Source ID",
"type": "string",
"default": "",
"description": "ID of the customer's payment source to be charged",
"required": true,
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Arbitrary text to describe the charge to create",
"placeholder": "Add Field",
"options": [
{
"name": "description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "Arbitrary text to describe the charge to create"
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"create"
]
}
}
},
{
"name": "chargeId",
"displayName": "Charge ID",
"type": "string",
"default": "",
"description": "ID of the charge to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"get"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 50,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 1000
},
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "Arbitrary text to describe the charge to update",
"placeholder": "Add Field",
"options": [
{
"name": "description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "Arbitrary text to describe the charge to update"
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"charge"
],
"operation": [
"update"
]
}
}
},
{
"name": "duration",
"displayName": "Apply",
"type": "options",
"default": "once",
"description": "How long the discount will be in effect",
"required": true,
"options": [
{
"name": "Forever",
"value": "forever"
},
{
"name": "Once",
"value": "once"
}
],
"displayOptions": {
"show": {
"resource": [
"coupon"
],
"operation": [
"create"
]
}
}
},
{
"name": "type",
"displayName": "Discount Type",
"type": "options",
"default": "percent",
"description": "Whether the coupon discount is a percentage or a fixed amount",
"required": true,
"options": [
{
"name": "Fixed Amount (in Cents)",
"value": "fixedAmount"
},
{
"name": "Percent",
"value": "percent"
}
],
"displayOptions": {
"show": {
"resource": [
"coupon"
],
"operation": [
"create"
]
}
}
},
{
"name": "amountOff",
"displayName": "Amount Off",
"type": "number",
"default": 0,
"description": "Amount in cents to subtract from an invoice total, e.g. enter <code>100</code> for $1.00",
"required": true,
"typeOptions": {
"minValue": 0,
"maxValue": 99999999
},
"displayOptions": {
"show": {
"resource": [
"coupon"
],
"operation": [
"create"
],
"type": [
"fixedAmount"
]
}
}
},
{
"name": "percentOff",
"displayName": "Percent Off",
"type": "number",
"default": 1,
"description": "Percentage to apply with the coupon",
"required": true,
"typeOptions": {
"minValue": 1,
"maxValue": 100
},
"displayOptions": {
"show": {
"resource": [
"coupon"
],
"operation": [
"create"
],
"type": [
"percent"
]
}
}
},
{
"name": "token",
"displayName": "Card Token",
"type": "string",
"default": "",
"description": "Token representing sensitive card information",
"placeholder": "tok_1IMfKdJhRTnqS5TKQVG1LI9o",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customerCard"
],
"operation": [
"add"
]
}
}
},
{
"name": "cardId",
"displayName": "Card ID",
"type": "string",
"default": "",
"description": "ID of the card to remove",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customerCard"
],
"operation": [
"remove"
]
}
}
},
{
"name": "sourceId",
"displayName": "Source ID",
"type": "string",
"default": "",
"description": "ID of the source to retrieve",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customerCard"
],
"operation": [
"get"
]
}
}
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Full name or business name of the customer to create",
"required": true,
"displayOptions": {
"show": {
"resource": [
"customer"
],
"operation": [
"create"
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "Customer's email to filter by",
"placeholder": "Add Filter",
"options": [
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "Customer's email to filter by",
"placeholder": "name@email.com"
}
],
"displayOptions": {
"show": {
"resource": [
"customer"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "number",
"displayName": "Card Number",
"type": "string",
"default": "",
"placeholder": "4242424242424242",
"displayOptions": {
"show": {
"resource": [
"token"
],
"operation": [
"create"
],
"type": [
"cardToken"
]
}
}
},
{
"name": "cvc",
"displayName": "CVC",
"type": "string",
"default": "",
"description": "Security code printed on the back of the card",
"placeholder": "314",
"displayOptions": {
"show": {
"resource": [
"token"
],
"operation": [
"create"
],
"type": [
"cardToken"
]
}
}
},
{
"name": "expirationMonth",
"displayName": "Expiration Month",
"type": "string",
"default": "",
"description": "Number of the month when the card will expire",
"placeholder": "10",
"displayOptions": {
"show": {
"resource": [
"token"
],
"operation": [
"create"
],
"type": [
"cardToken"
]
}
}
},
{
"name": "expirationYear",
"displayName": "Expiration Year",
"type": "string",
"default": "",
"description": "Year when the card will expire",
"placeholder": "2022",
"displayOptions": {
"show": {
"resource": [
"token"
],
"operation": [
"create"
],
"type": [
"cardToken"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "balance",
"options": [
{
"name": "Balance",
"value": "balance"
},
{
"name": "Charge",
"value": "charge"
},
{
"name": "Coupon",
"value": "coupon"
},
{
"name": "Customer",
"value": "customer"
},
{
"name": "Customer Card",
"value": "customerCard"
},
{
"name": "Source",
"value": "source"
},
{
"name": "Token",
"value": "token"
}
]
}
],
"credentialsConfig": [
{
"name": "stripeApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}