Stripe

Actions in the category "Stripe".

Get customer

Reads a Stripe customer by ID.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Customer ID	ID	Yes	The customer ID, starting with cus_. Maximum length: 255 characters.

Outputs

Name	Type	Details
Found	Yes/No	Whether the customer exists and is not deleted. When not, everything else is empty.
Email	Text	The email address. May be empty.
Name	Text	The name. May be empty.
Description	Text	The description. May be empty.
Currency	Text	The currency the customer pays in. May be empty.
Balance	Whole number	The customer balance in the smallest unit; below 0 is credit. May be empty.
Payment overdue	Yes/No	Whether the last invoice payment failed. May be empty.
Created at	Date and time	When the customer was created. May be empty.

Get charges

Lists charges, newest first, of all customers or one.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Customer ID	ID	No	Only for this customer (cus_...). Empty: all customers. Maximum length: 255 characters.
How many	Whole number	No	How many to get, 1 to 100. Empty: 10. Value: 1 to 100. Default: 10.
After ID	ID	No	Continue after this ID, the last one of the previous page. Empty: the newest first. Maximum length: 255 characters.

Outputs

Name	Type	Details
Charges	List of Stripe charge	The charges, newest first.
Has more	Yes/No	Whether there are more after this page.

Get payments

Lists payment intents, newest first, of all customers or one.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Customer ID	ID	No	Only for this customer (cus_...). Empty: all customers. Maximum length: 255 characters.
How many	Whole number	No	How many to get, 1 to 100. Empty: 10. Value: 1 to 100. Default: 10.
After ID	ID	No	Continue after this ID, the last one of the previous page. Empty: the newest first. Maximum length: 255 characters.

Outputs

Name	Type	Details
Payments	List of Stripe payment	The payments, newest first.
Has more	Yes/No	Whether there are more after this page.

Get balance

Reads the balance of your Stripe account, per currency.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.

Outputs

Name	Type	Details
Available	List of Stripe amount	Money you can pay out now.
Pending	List of Stripe amount	Money that is not available yet.

Create Checkout session

Creates a Stripe page where one customer pays for one item. Sending the same inputs again returns the same session.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Product name	Text	Yes	What the customer pays for, shown on the Stripe page. For several products, send one total with a descriptive name. Maximum length: 250 characters.
Price	Whole number	Yes	The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. Value: 0 to 99999999.
Quantity	Whole number	No	How many of it, 1 to 999. Empty: 1. Value: 1 to 999. Default: 1.
Currency	Text	Yes	The three-letter currency code, for example eur. Length: 3 to 3 characters.
Success link	Text	Yes	Where the customer lands after paying. Maximum length: 2048 characters.
Cancel link	Text	No	Where the customer lands when they go back. Empty: no back button. Maximum length: 2048 characters.
Reference	Text	Yes	Your own ID for this order, for example an order number. Use it to find the order again. Maximum length: 200 characters.
Customer email	Text	No	Fills in the email on the Stripe page. Empty: the customer types it. Maximum length: 800 characters.
Metadata	Lookup table of Text to Text	No	Notes Stripe stores with it, as name and value pairs, for example an order number. Empty: none.
Expires at	Date and time	No	When the page stops working. Stripe needs a time between 30 minutes and 24 hours from now. Work it out once and keep it with the order. Empty: 24 hours.

Outputs

Name	Type	Details
ID	ID	The ID, starting with cs_.
Payment page	URL	The Stripe page where the customer pays. Empty once the session expired. May be empty.
Status	Text	open, complete or expired.
Payment status	Text	paid, unpaid or no_payment_required.
Expires at	Date and time	When the session expires.
Total	Whole number	The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty.
Currency	Text	The currency, for example eur. May be empty.
Reference	Text	The reference you gave when creating the session. May be empty.
Payment ID	ID	The payment (pi_...), once the customer started paying. May be empty.

Get Checkout session

Reads a Checkout session by ID.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Session ID	ID	Yes	The Checkout session ID, starting with cs_. Maximum length: 255 characters.

Outputs

Name	Type	Details
Found	Yes/No	Whether the session exists. When not, everything else is empty.
ID	ID	The ID, starting with cs_. May be empty.
Payment page	URL	The Stripe page where the customer pays. Empty once the session expired. May be empty.
Status	Text	open, complete or expired. May be empty.
Payment status	Text	paid, unpaid or no_payment_required. May be empty.
Expires at	Date and time	When the session expires. May be empty.
Total	Whole number	The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty.
Currency	Text	The currency, for example eur. May be empty.
Reference	Text	The reference you gave when creating the session. May be empty.
Payment ID	ID	The payment (pi_...), once the customer started paying. May be empty.

Expire Checkout session

Closes an open Checkout session so nobody can pay with it anymore.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Session ID	ID	Yes	The Checkout session ID, starting with cs_. Maximum length: 255 characters.

Outputs

Name	Type	Details
ID	ID	The ID, starting with cs_.
Payment page	URL	The Stripe page where the customer pays. Empty once the session expired. May be empty.
Status	Text	open, complete or expired.
Payment status	Text	paid, unpaid or no_payment_required.
Expires at	Date and time	When the session expires.
Total	Whole number	The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty.
Currency	Text	The currency, for example eur. May be empty.
Reference	Text	The reference you gave when creating the session. May be empty.
Payment ID	ID	The payment (pi_...), once the customer started paying. May be empty.

Create payment link

Creates a link where anyone can pay for one item. Stripe shows its own confirmation page afterwards. Payments through this link also fire the Checkout completed trigger.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Product name	Text	Yes	What the customer pays for, shown on the Stripe page. For several products, send one total with a descriptive name. Maximum length: 250 characters.
Price	Whole number	Yes	The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. Value: 0 to 99999999.
Quantity	Whole number	No	How many of it, 1 to 999. Empty: 1. Value: 1 to 999. Default: 1.
Currency	Text	Yes	The three-letter currency code, for example eur. Length: 3 to 3 characters.
Metadata	Lookup table of Text to Text	No	Notes Stripe stores with it, as name and value pairs, for example an order number. Empty: none.

Outputs

Name	Type	Details
ID	ID	The ID, starting with plink_.
Link	URL	The link to pay.
Active	Yes/No	Whether the link can be used.

Create refund

Refunds a payment, in full or in part. Give the payment ID or the charge ID. Sending the same refund again right away returns the first refund and refunds nothing more. To refund the same amount twice on purpose, change an input.

Inputs

Name	Type	Required	Details
Connection	Text	No	The Stripe connection from the Integrations page that this action uses. Maximum length: 64 characters.
Payment ID	ID	No	The payment to refund (pi_...). Give this or the charge ID. Maximum length: 255 characters.
Charge ID	ID	No	The charge to refund (ch_...). Give this or the payment ID. Maximum length: 255 characters.
Amount	Whole number	No	How much to refund, in the smallest unit of the currency, for example cents. Empty: everything that is left. Value: 1 to 99999999.
Reason	Text	No	duplicate, fraudulent or requested_by_customer. Empty: none. Allowed values: duplicate, fraudulent, requested_by_customer.
Metadata	Lookup table of Text to Text	No	Notes Stripe stores with it, as name and value pairs, for example an order number. Empty: none.

Outputs

Name	Type	Details
ID	ID	The ID, starting with re_.
Status	Text	succeeded, pending, requires_action, failed or canceled.
Amount	Whole number	The amount in the smallest unit of the currency, for example cents: 1000 is 10.00.
Currency	Text	The currency, for example eur.
Charge ID	ID	The charge that was refunded. May be empty.
Payment ID	ID	The payment that was refunded. May be empty.