Integrates Stripe into the workflow. Manage payment intents, customers, subscriptions, invoices, charges, products, prices, and events. Can be used in trigger mode to trigger a workflow when a Stripe event occurs.
Create a new Payment Intent to process a payment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
amount | number | Yes | Amount in cents (e.g., 2000 for $20.00) |
currency | string | Yes | Three-letter ISO currency code (e.g., usd, eur) |
customer | string | No | Customer ID to associate with this payment |
payment_method | string | No | Payment method ID |
description | string | No | Description of the payment |
receipt_email | string | No | Email address to send receipt to |
metadata | json | No | Set of key-value pairs for storing additional information |
automatic_payment_methods | json | No | Enable automatic payment methods (e.g., {"enabled": true}) |
| Parameter | Type | Description |
|---|
payment_intent | json | The created Payment Intent object |
metadata | json | Payment Intent metadata including ID, status, amount, and currency |
Retrieve an existing Payment Intent by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Payment Intent ID (e.g., pi_1234567890) |
| Parameter | Type | Description |
|---|
payment_intent | json | The retrieved Payment Intent object |
metadata | json | Payment Intent metadata including ID, status, amount, and currency |
Update an existing Payment Intent
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Payment Intent ID (e.g., pi_1234567890) |
amount | number | No | Updated amount in cents |
currency | string | No | Three-letter ISO currency code |
customer | string | No | Customer ID |
description | string | No | Updated description |
metadata | json | No | Updated metadata |
| Parameter | Type | Description |
|---|
payment_intent | json | The updated Payment Intent object |
metadata | json | Payment Intent metadata including ID, status, amount, and currency |
Confirm a Payment Intent to complete the payment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Payment Intent ID (e.g., pi_1234567890) |
payment_method | string | No | Payment method ID to confirm with |
| Parameter | Type | Description |
|---|
payment_intent | json | The confirmed Payment Intent object |
metadata | json | Payment Intent metadata including ID, status, amount, and currency |
Capture an authorized Payment Intent
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Payment Intent ID (e.g., pi_1234567890) |
amount_to_capture | number | No | Amount to capture in cents (defaults to full amount) |
| Parameter | Type | Description |
|---|
payment_intent | json | The captured Payment Intent object |
metadata | json | Payment Intent metadata including ID, status, amount, and currency |
Cancel a Payment Intent
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Payment Intent ID (e.g., pi_1234567890) |
cancellation_reason | string | No | Reason for cancellation (duplicate, fraudulent, requested_by_customer, abandoned) |
| Parameter | Type | Description |
|---|
payment_intent | json | The canceled Payment Intent object |
metadata | json | Payment Intent metadata including ID, status, amount, and currency |
List all Payment Intents
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
customer | string | No | Filter by customer ID |
created | json | No | Filter by creation date (e.g., {"gt": 1633024800}) |
| Parameter | Type | Description |
|---|
payment_intents | json | Array of Payment Intent objects |
metadata | json | List metadata including count and has_more |
Search for Payment Intents using query syntax
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
query | string | Yes | Search query (e.g., "status:'succeeded' AND currency:'usd'") |
limit | number | No | Number of results to return (default 10, max 100) |
| Parameter | Type | Description |
|---|
payment_intents | json | Array of matching Payment Intent objects |
metadata | json | Search metadata including count and has_more |
Create a new customer object
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
email | string | No | Customer email address |
name | string | No | Customer full name |
phone | string | No | Customer phone number |
description | string | No | Description of the customer |
address | json | No | Customer address object |
metadata | json | No | Set of key-value pairs |
payment_method | string | No | Payment method ID to attach |
| Parameter | Type | Description |
|---|
customer | json | The created customer object |
metadata | json | Customer metadata |
Retrieve an existing customer by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Customer ID (e.g., cus_1234567890) |
| Parameter | Type | Description |
|---|
customer | json | The retrieved customer object |
metadata | json | Customer metadata |
Update an existing customer
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Customer ID (e.g., cus_1234567890) |
email | string | No | Updated email address |
name | string | No | Updated name |
phone | string | No | Updated phone number |
description | string | No | Updated description |
address | json | No | Updated address object |
metadata | json | No | Updated metadata |
| Parameter | Type | Description |
|---|
customer | json | The updated customer object |
metadata | json | Customer metadata |
Permanently delete a customer
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Customer ID (e.g., cus_1234567890) |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the customer was deleted |
id | string | The ID of the deleted customer |
metadata | json | Deletion metadata |
List all customers
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
email | string | No | Filter by email address |
created | json | No | Filter by creation date |
| Parameter | Type | Description |
|---|
customers | json | Array of customer objects |
metadata | json | List metadata |
Search for customers using query syntax
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
query | string | Yes | Search query (e.g., "email:'customer@example.com'") |
limit | number | No | Number of results to return (default 10, max 100) |
| Parameter | Type | Description |
|---|
customers | json | Array of matching customer objects |
metadata | json | Search metadata |
Create a new subscription for a customer
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
customer | string | Yes | Customer ID to subscribe |
items | json | Yes | Array of items with price IDs (e.g., [{"price": "price_xxx", "quantity": 1}]) |
trial_period_days | number | No | Number of trial days |
default_payment_method | string | No | Payment method ID |
cancel_at_period_end | boolean | No | Cancel subscription at period end |
metadata | json | No | Set of key-value pairs for storing additional information |
| Parameter | Type | Description |
|---|
subscription | json | The created subscription object |
metadata | json | Subscription metadata including ID, status, and customer |
Retrieve an existing subscription by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Subscription ID (e.g., sub_1234567890) |
| Parameter | Type | Description |
|---|
subscription | json | The retrieved subscription object |
metadata | json | Subscription metadata including ID, status, and customer |
Update an existing subscription
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Subscription ID (e.g., sub_1234567890) |
items | json | No | Updated array of items with price IDs |
cancel_at_period_end | boolean | No | Cancel subscription at period end |
metadata | json | No | Updated metadata |
| Parameter | Type | Description |
|---|
subscription | json | The updated subscription object |
metadata | json | Subscription metadata including ID, status, and customer |
Cancel a subscription
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Subscription ID (e.g., sub_1234567890) |
prorate | boolean | No | Whether to prorate the cancellation |
invoice_now | boolean | No | Whether to invoice immediately |
| Parameter | Type | Description |
|---|
subscription | json | The canceled subscription object |
metadata | json | Subscription metadata including ID, status, and customer |
Resume a subscription that was scheduled for cancellation
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Subscription ID (e.g., sub_1234567890) |
| Parameter | Type | Description |
|---|
subscription | json | The resumed subscription object |
metadata | json | Subscription metadata including ID, status, and customer |
List all subscriptions
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
customer | string | No | Filter by customer ID |
status | string | No | Filter by status (active, past_due, unpaid, canceled, incomplete, incomplete_expired, trialing, all) |
price | string | No | Filter by price ID |
| Parameter | Type | Description |
|---|
subscriptions | json | Array of subscription objects |
metadata | json | List metadata |
Search for subscriptions using query syntax
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
query | string | Yes | Search query (e.g., "status:'active' AND customer:'cus_xxx'") |
limit | number | No | Number of results to return (default 10, max 100) |
| Parameter | Type | Description |
|---|
subscriptions | json | Array of matching subscription objects |
metadata | json | Search metadata |
Create a new invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
customer | string | Yes | Customer ID (e.g., cus_1234567890) |
description | string | No | Description of the invoice |
metadata | json | No | Set of key-value pairs |
auto_advance | boolean | No | Auto-finalize the invoice |
collection_method | string | No | Collection method: charge_automatically or send_invoice |
| Parameter | Type | Description |
|---|
invoice | json | The created invoice object |
metadata | json | Invoice metadata |
Retrieve an existing invoice by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Invoice ID (e.g., in_1234567890) |
| Parameter | Type | Description |
|---|
invoice | json | The retrieved invoice object |
metadata | json | Invoice metadata |
Update an existing invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Invoice ID (e.g., in_1234567890) |
description | string | No | Description of the invoice |
metadata | json | No | Set of key-value pairs |
auto_advance | boolean | No | Auto-finalize the invoice |
| Parameter | Type | Description |
|---|
invoice | json | The updated invoice object |
metadata | json | Invoice metadata |
Permanently delete a draft invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Invoice ID (e.g., in_1234567890) |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the invoice was deleted |
id | string | The ID of the deleted invoice |
metadata | json | Deletion metadata |
Finalize a draft invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Invoice ID (e.g., in_1234567890) |
auto_advance | boolean | No | Auto-advance the invoice |
| Parameter | Type | Description |
|---|
invoice | json | The finalized invoice object |
metadata | json | Invoice metadata |
Pay an invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Invoice ID (e.g., in_1234567890) |
paid_out_of_band | boolean | No | Mark invoice as paid out of band |
| Parameter | Type | Description |
|---|
invoice | json | The paid invoice object |
metadata | json | Invoice metadata |
Void an invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Invoice ID (e.g., in_1234567890) |
| Parameter | Type | Description |
|---|
invoice | json | The voided invoice object |
metadata | json | Invoice metadata |
Send an invoice to the customer
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Invoice ID (e.g., in_1234567890) |
| Parameter | Type | Description |
|---|
invoice | json | The sent invoice object |
metadata | json | Invoice metadata |
List all invoices
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
customer | string | No | Filter by customer ID |
status | string | No | Filter by invoice status |
| Parameter | Type | Description |
|---|
invoices | json | Array of invoice objects |
metadata | json | List metadata |
Search for invoices using query syntax
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
query | string | Yes | Search query (e.g., "customer:'cus_1234567890'") |
limit | number | No | Number of results to return (default 10, max 100) |
| Parameter | Type | Description |
|---|
invoices | json | Array of matching invoice objects |
metadata | json | Search metadata |
Create a new charge to process a payment
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
amount | number | Yes | Amount in cents (e.g., 2000 for $20.00) |
currency | string | Yes | Three-letter ISO currency code (e.g., usd, eur) |
customer | string | No | Customer ID to associate with this charge |
source | string | No | Payment source ID (e.g., card token or saved card ID) |
description | string | No | Description of the charge |
metadata | json | No | Set of key-value pairs for storing additional information |
capture | boolean | No | Whether to immediately capture the charge (defaults to true) |
| Parameter | Type | Description |
|---|
charge | json | The created Charge object |
metadata | json | Charge metadata including ID, status, amount, currency, and paid status |
Retrieve an existing charge by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Charge ID (e.g., ch_1234567890) |
| Parameter | Type | Description |
|---|
charge | json | The retrieved Charge object |
metadata | json | Charge metadata including ID, status, amount, currency, and paid status |
Update an existing charge
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Charge ID (e.g., ch_1234567890) |
description | string | No | Updated description |
metadata | json | No | Updated metadata |
| Parameter | Type | Description |
|---|
charge | json | The updated Charge object |
metadata | json | Charge metadata including ID, status, amount, currency, and paid status |
Capture an uncaptured charge
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Charge ID (e.g., ch_1234567890) |
amount | number | No | Amount to capture in cents (defaults to full amount) |
| Parameter | Type | Description |
|---|
charge | json | The captured Charge object |
metadata | json | Charge metadata including ID, status, amount, currency, and paid status |
List all charges
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
customer | string | No | Filter by customer ID |
created | json | No | Filter by creation date (e.g., {"gt": 1633024800}) |
| Parameter | Type | Description |
|---|
charges | json | Array of Charge objects |
metadata | json | List metadata including count and has_more |
Search for charges using query syntax
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
query | string | Yes | Search query (e.g., "status:'succeeded' AND currency:'usd'") |
limit | number | No | Number of results to return (default 10, max 100) |
| Parameter | Type | Description |
|---|
charges | json | Array of matching Charge objects |
metadata | json | Search metadata including count and has_more |
Create a new product object
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
name | string | Yes | Product name |
description | string | No | Product description |
active | boolean | No | Whether the product is active |
images | json | No | Array of image URLs for the product |
metadata | json | No | Set of key-value pairs |
| Parameter | Type | Description |
|---|
product | json | The created product object |
metadata | json | Product metadata |
Retrieve an existing product by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Product ID (e.g., prod_1234567890) |
| Parameter | Type | Description |
|---|
product | json | The retrieved product object |
metadata | json | Product metadata |
Update an existing product
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Product ID (e.g., prod_1234567890) |
name | string | No | Updated product name |
description | string | No | Updated product description |
active | boolean | No | Updated active status |
images | json | No | Updated array of image URLs |
metadata | json | No | Updated metadata |
| Parameter | Type | Description |
|---|
product | json | The updated product object |
metadata | json | Product metadata |
Permanently delete a product
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Product ID (e.g., prod_1234567890) |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the product was deleted |
id | string | The ID of the deleted product |
metadata | json | Deletion metadata |
List all products
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
active | boolean | No | Filter by active status |
| Parameter | Type | Description |
|---|
products | json | Array of product objects |
metadata | json | List metadata |
Search for products using query syntax
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
query | string | Yes | Search query (e.g., "name:'shirt'") |
limit | number | No | Number of results to return (default 10, max 100) |
| Parameter | Type | Description |
|---|
products | json | Array of matching product objects |
metadata | json | Search metadata |
Create a new price for a product
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
product | string | Yes | Product ID (e.g., prod_1234567890) |
currency | string | Yes | Three-letter ISO currency code (e.g., usd, eur) |
unit_amount | number | No | Amount in cents (e.g., 1000 for $10.00) |
recurring | json | No | Recurring billing configuration (interval: day/week/month/year) |
metadata | json | No | Set of key-value pairs |
billing_scheme | string | No | Billing scheme (per_unit or tiered) |
| Parameter | Type | Description |
|---|
price | json | The created price object |
metadata | json | Price metadata |
Retrieve an existing price by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Price ID (e.g., price_1234567890) |
| Parameter | Type | Description |
|---|
price | json | The retrieved price object |
metadata | json | Price metadata |
Update an existing price
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Price ID (e.g., price_1234567890) |
active | boolean | No | Whether the price is active |
metadata | json | No | Updated metadata |
| Parameter | Type | Description |
|---|
price | json | The updated price object |
metadata | json | Price metadata |
List all prices
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
product | string | No | Filter by product ID |
active | boolean | No | Filter by active status |
| Parameter | Type | Description |
|---|
prices | json | Array of price objects |
metadata | json | List metadata |
Search for prices using query syntax
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
query | string | Yes | Search query (e.g., "active:'true' AND currency:'usd'") |
limit | number | No | Number of results to return (default 10, max 100) |
| Parameter | Type | Description |
|---|
prices | json | Array of matching price objects |
metadata | json | Search metadata |
Retrieve an existing Event by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
id | string | Yes | Event ID (e.g., evt_1234567890) |
| Parameter | Type | Description |
|---|
event | json | The retrieved Event object |
metadata | json | Event metadata including ID, type, and created timestamp |
List all Events
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Stripe API key (secret key) |
limit | number | No | Number of results to return (default 10, max 100) |
type | string | No | Filter by event type (e.g., payment_intent.created) |
created | json | No | Filter by creation date (e.g., {"gt": 1633024800}) |
| Parameter | Type | Description |
|---|
events | json | Array of Event objects |
metadata | json | List metadata including count and has_more |
Triggers when Stripe events occur (payments, subscriptions, invoices, etc.)
| Parameter | Type | Description |
|---|
id | string | Unique identifier for the event |
type | string | Event type (e.g., payment_intent.succeeded, customer.created, invoice.paid) |
object | string | Always "event" |
api_version | string | Stripe API version used to render the event |
created | number | Unix timestamp when the event was created |
data | json | Event data containing the affected Stripe object |
livemode | boolean | Whether this event occurred in live mode (true) or test mode (false) |
pending_webhooks | number | Number of webhooks yet to be delivered for this event |
request | json | Information about the request that triggered this event |
- Category:
tools
- Type:
stripe
