Stripe Connector
Description
Stripe is a payment processing platform for online businesses. The Stripe component provides functionality for interacting with the Stripe API, including managing customers, payment intents, charges, invoices, products, prices, subscriptions, checkout sessions, disputes, and webhooks.
API Documentation
This component was built using the Stripe REST API Reference.
Connections
API Key
key: apiKeyTo authenticate requests with Stripe, an API key is required. API keys are managed in the Stripe Dashboard. For background, refer to the Stripe authentication documentation.
Prerequisites
- A Stripe account with access to the API keys dashboard
Setup Steps
- Sign in to the Stripe Dashboard and navigate to Developers > API keys
- Locate the desired secret key:
- Use a test mode key (prefix
sk_test_) for development and testing - Use a live mode key (prefix
sk_live_) for production traffic
- Use a test mode key (prefix
- Click Reveal test key (or create a new restricted key as needed) and copy the key value
Secret API keys grant full access to the Stripe account. Store them securely and never expose them in client-side code or version control.
Configure the Connection
- Enter the secret key value into the API Key field
Verify Connection
Save the integration and run any Stripe action (such as List Customers) to confirm that the API key is valid.
| Input | Notes | Example |
|---|---|---|
| API Key | The Stripe API Key from the Stripe Dashboard. Use a test key (sk_test_...) for development and a live key (sk_live_...) for production. Find the API key in the Stripe API keys dashboard. | sk_live_51JaOXaDtJQgcyrdS |
Triggers
New and Updated Records
Checks for new and updated records in Stripe on a configured schedule. Events with a type ending in .created are partitioned into the created bucket; all other event types (such as .updated, .deleted, or .succeeded) are partitioned into the updated bucket. | key: pollChangesTrigger
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Event Types | Stripe event types to poll for (e.g., | customer.created |
| Show New Records | When enabled, events with type ending in | true |
| Show Updated Records | When enabled, all other change events (e.g., | true |
This trigger polls the Stripe Events API for new and updated records in the connected Stripe account on a configured schedule. Events are partitioned by their type suffix: event types ending in .created are placed in the created bucket, and all other event types (such as .updated, .deleted, .succeeded, .failed, .paid) are placed in the updated bucket.
How It Works
- The trigger runs on the configured schedule (e.g., every 5 minutes)
- It calls
GET /v1/eventswith acreated[gte]filter set to the timestamp of the last successful poll. Optional event-type filters narrow the result set when configured - Each returned event is classified by inspecting its
typefield:- Event types ending in
.createdare appended to thecreatedarray - All other event types are appended to the
updatedarray
- Event types ending in
- The polling cursor is advanced based on the result:
- Normal case: The cursor advances to the current poll start time (
now), so the next poll resumes from there - Truncated case: When the result set exceeds the page cap, the cursor is not advanced. Stripe returns events newest-first, so a truncated result holds the newest events of the window and the ones left behind are the oldest. Raising
created[gte]would exclude exactly the range that was not read, so the cursor is held and the next poll re-queries the same window. This yields at-least-once semantics: events already emitted are re-emitted, but none are silently skipped
- Normal case: The cursor advances to the current poll start time (
- A warning is logged whenever truncation occurs, including the cursor value being held
Event Types
Stripe event types are named in the form <resource>.<action>. Partitioning is performed solely by inspecting the .action suffix:
| Suffix Pattern | Bucket | Examples |
|---|---|---|
.created | created | customer.created, invoice.created, payment_intent.created |
| Any other suffix | updated | customer.updated, invoice.paid, payment_intent.succeeded, charge.refunded, subscription.deleted |
Refer to the Stripe event types reference for the full catalog of event names.
Returned Data
The trigger returns an object with two arrays: created for events whose type ends in .created, and updated for all other event types.
Example Response
{
"data": {
"created": [
{
"id": "evt_1Ozr8j2eZvKYlo2C9X1zHnGw",
"object": "event",
"api_version": "2025-04-30.basil",
"created": 1716397800,
"type": "customer.created",
"data": {
"object": {
"id": "cus_OzrFakeCustomer01",
"object": "customer",
"email": "jane@example.com",
"name": "Jane Doe",
"created": 1716397800
}
},
"livemode": false,
"pending_webhooks": 1
}
],
"updated": [
{
"id": "evt_1Ozr8k2eZvKYlo2C9X1zHnHx",
"object": "event",
"api_version": "2025-04-30.basil",
"created": 1716397900,
"type": "invoice.paid",
"data": {
"object": {
"id": "in_1Ozr8k2eZvKYlo2C9X1zHnHx",
"object": "invoice",
"amount_paid": 5000,
"currency": "usd",
"customer": "cus_OzrFakeCustomer01",
"status": "paid",
"created": 1716397800
}
},
"livemode": false,
"pending_webhooks": 1
}
]
}
}
Fields shown are representative. The full response object includes additional properties.
Notes
- At-least-once semantics: When truncation occurs at the page cap, the cursor is held rather than advanced, so the next poll re-queries the same window. This guarantees no events are silently skipped, but events already emitted are re-emitted. Downstream flows should be idempotent on Stripe event
id - Clearing a truncation backlog: while the window stays above the page cap the oldest events do not drain and the already-emitted ones are re-delivered on every poll. New events still come through, since they are among the newest the cap returns. Shorten the polling interval or narrow the Event Types filter so each window fits under the cap
- Event retention: Stripe retains events for 30 days (and 7 days in some accounts). Polling intervals must remain well below that retention window to avoid losing changes
- Polling Frequency: 5-15 minute intervals balance freshness against Stripe rate limits. Very frequent polling combined with high event volumes increases the risk of hitting per-account read limits
- Event-type filtering: Supplying explicit event types in the Event Types input narrows the request at the API level, reducing payload size and the chance of truncation
- Comparison with the Webhook Events trigger: For real-time delivery with no polling delay, prefer the Webhook Events lifecycle trigger. The polling trigger is useful when webhook delivery is not viable (for example, when the destination is not publicly reachable)
Example Payload for New and Updated Records⤓
Webhook (Deprecated)
Receive and validate webhook requests from Stripe for configured webhooks. | key: webhook
Webhook Events
Receive event notifications from Stripe. Automatically creates and manages a webhook subscription for the selected events when the instance is deployed, and removes the subscription when the instance is deleted. Incoming webhook signatures are validated by default. | key: instanceDeployWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Disable Webhook Validation | When true, webhook signature validation will be skipped. This is useful for manually testing the trigger without needing a signed request. | false |
| Webhook Events | For each item, provide a string value representing the event type to track. For more information, see Stripe event types. | payment_intent.created |
| Webhook Secret | The signing secret used to verify incoming signatures. Leave empty to use the secret of the endpoint created when the instance was deployed. Supply it only when the deployment reused a pre-existing endpoint, since Stripe returns a signing secret only when an endpoint is created. The secret is available on the endpoint's page in the Stripe dashboard. | whsec_XXXXXXXXXXXXXXXXXXXXXXXX |
The Webhook Events trigger automatically manages the Stripe webhook subscription for the instance. Unlike manual webhook setups that require configuration in the Stripe dashboard, this trigger handles the entire webhook lifecycle.
Incoming webhook signatures are validated automatically using the secret returned when the subscription is created. Stripe returns a signing secret only at creation, so a deployment that reuses a pre-existing endpoint has no secret to store and needs one supplied through the Webhook Secret input.
How It Works
When this trigger is used in a flow:
- On Instance Deploy: The trigger automatically creates a webhook endpoint in the connected Stripe account pointing to the instance's unique webhook URL. If a webhook with the same URL and event set already exists, the existing webhook is reused to prevent duplication. A reused endpoint provides no signing secret, so one must be supplied through the Webhook Secret input for validation to succeed.
- On Instance Deletion: The trigger automatically removes the webhook endpoint from the connected Stripe account.
- On Event Receipt: The trigger validates the
Stripe-Signatureheader against the stored webhook secret before passing the payload to the flow. Validation can be disabled for manual testing.
Configuration
Configure the following inputs:
- Webhook Events: One or more Stripe event types to subscribe to (e.g.,
customer.created,invoice.paid,payment_intent.succeeded). Refer to Stripe event types for the complete list. - Connection: The Stripe connection used to create and manage the webhook subscription.
- Disable Webhook Validation: When enabled, signature validation is skipped. This is useful for manually testing the trigger without a signed request. Defaults to
false. - Webhook Secret: The signing secret used to verify incoming signatures. Leave empty to use the secret of the endpoint created at deployment. Supply it only when the deployment reused a pre-existing endpoint; the value is available on the endpoint's page in the Stripe dashboard.
Event Types
Stripe supports a large number of event types organized by resource (customers, invoices, payment intents, charges, subscriptions, disputes, etc.). Each event has a name in the form <resource>.<action> (for example, customer.created, invoice.payment_failed, payment_intent.succeeded).
Refer to the Stripe event types reference for the complete and up-to-date list.
Returned Data
The trigger returns the verified Stripe event payload as received from the webhook request.
Example Payload
{
"payload": {
"headers": {
"stripe-signature": "t=1716397800,v1=..."
},
"body": {
"data": {
"id": "evt_1Ozr8j2eZvKYlo2C9X1zHnGw",
"object": "event",
"api_version": "2025-04-30.basil",
"created": 1716397800,
"type": "customer.created",
"data": {
"object": {
"id": "cus_OzrFakeCustomer01",
"object": "customer",
"email": "jane@example.com",
"name": "Jane Doe",
"created": 1716397800
}
},
"livemode": false,
"pending_webhooks": 1
}
}
}
}
Notes
- Signature validation uses Stripe's standard scheme as described in the webhook documentation. The signing secret is stored automatically when the subscription is created. When no secret is available, the trigger fails with an explanatory error rather than accepting an unverified request.
- The webhook endpoint URL is unique to each instance, so multiple instances can subscribe to the same Stripe account without colliding.
Data Sources
Select Balance Transaction
Select a balance transaction from a list of transactions in the connected Stripe account. | key: selectBalanceTransaction | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Example Payload for Select Balance Transaction⤓
Select Card
Select a card payment method for the selected customer in the connected Stripe account. | key: selectCard | type: picklist
| Input | Notes | Example |
|---|---|---|
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Connection | The Stripe connection to use. |
Example Payload for Select Card⤓
Select Charge
Select a charge from a list of charges in the connected Stripe account. | key: selectCharge | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Example Payload for Select Charge⤓
Select Checkout Session
Select a checkout session from a list of sessions in the connected Stripe account. | key: selectCheckoutSession | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Example Payload for Select Checkout Session⤓
Select Customer
A picklist of customers in the connected Stripe account. | key: selectCustomer | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Select Dispute
Select a dispute from a list of disputes in the connected Stripe account. | key: selectDispute | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Example Payload for Select Dispute⤓
Select Invoice
A picklist of invoices in the connected Stripe account. | key: selectInvoice | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Select Payment Intent
A picklist of payment intents in the connected Stripe account. | key: selectPaymentIntent | type: picklist
| Input | Notes | Example |
|---|---|---|
| Customer ID | Only return PaymentIntents for the customer specified by this customer ID. | cus_1234567890abcdef |
| Ending Before | A cursor for use in pagination. | cus_1234567890abcdef |
| Starting After | A cursor for use in pagination. | cus_1234567890abcdef |
| Connection | The Stripe connection to use. |
Select Price
A picklist of prices in the connected Stripe account. | key: selectPrice | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Select Product
A picklist of products in the connected Stripe account. | key: selectProduct | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Select Subscription
A picklist of subscriptions in the connected Stripe account. | key: selectSubscription | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. |
Actions
Attach Card
Attach a card to a customer. | key: attachCard
| Input | Notes | Example |
|---|---|---|
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Attach Card⤓
Cancel Payment Intent
Cancel a payment intent. A payment intent can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or, in rare cases, processing. | key: cancelPaymentIntent
| Input | Notes | Example |
|---|---|---|
| Cancellation Reason | The reason for cancelling the Payment Intent. | |
| Payment Intent ID | The unique identifier for the Payment Intent. | pi_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Cancel Payment Intent⤓
Capture Payment Intent
Capture the funds of an existing uncaptured payment intent when its status is requires_capture. | key: capturePaymentIntent
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional optional fields: includes Application Fee Amount, Statement Descriptor, Statement Descriptor Suffix, and Transfer Data. | |
| Amount to Capture | The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Enter a whole number in the currency's smallest unit (1000 is $10.00 in USD, ¥1000 in JPY). | 1000 |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Intent ID | The unique identifier for the Payment Intent. | pi_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Capture Payment Intent⤓
Close Dispute
Close a dispute for a charge. Closing a dispute indicates that no evidence will be submitted and acknowledges the dispute as lost. | key: closeDispute
| Input | Notes | Example |
|---|---|---|
| Dispute ID | The unique identifier for the dispute. | dp_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Close Dispute⤓
Confirm Payment Intent
Confirm that the customer intends to pay with the current or provided payment method. | key: confirmPaymentIntent
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional optional fields: includes Setup Future Usage, Error On Requires Action, Mandate, Mandate Data, Off Session, Payment Method Data, Payment Method Options, Radar Options, Return URL, and Use Stripe SDK. | |
| Capture Method | Controls when the funds will be captured from the customer's account. | |
| Payment Intent ID | The unique identifier for the Payment Intent. | pi_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Payment Method | ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Receipt Email | The email address that the receipt for the charge will be sent to. Updating this field triggers a new email receipt to the updated address. | customer@example.com |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Confirm Payment Intent⤓
Create Card
Create a new card for a customer. | key: createCard
| Input | Notes | Example |
|---|---|---|
| Billing Address | Billing street, city, state, postal code, and country. | |
| Card Number | The full credit or debit card number, with no spaces or dashes. | 4242424242424242 |
| Name & Contact Information | Full name, email, and phone contact details. | |
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| CVC | The card security code printed on the back of the card. | 123 |
| Expiration Month | The two-digit expiration month of the card (01-12). | 12 |
| Expiration Year | The four-digit expiration year of the card. | 2026 |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Create Card⤓
Create Checkout Session
Create a new Stripe Checkout session. | key: createCheckoutSession
| Input | Notes | Example |
|---|---|---|
| Body Params | More parameters to pass to the request. | |
| Cancel URL | The URL the customer will be directed to if they decide to cancel payment. | https://example.com/cancel |
| Client Reference ID | A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with internal systems. | order_12345 |
The email of the customer to create the checkout session for. | customer@example.com | |
| Customer ID | The ID of the customer to create the checkout session for. | cus_1234567890abcdef |
| Line Items | JSON array of line items to be purchased. | |
| Mode | The behavior of the Checkout Session: | payment |
| Connection | The Stripe connection to use. | |
| Success URL | The URL the customer will be directed to after the payment is successful. | https://example.com/success |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Create Checkout Session⤓
Create Customer
Create a new customer. | key: createCustomer
| Input | Notes | Example |
|---|---|---|
| Address | Street, city, state, postal code, and country. | |
| Name & Contact Information | Full name, email, and phone contact details. | |
| Balance | The starting balance of the customer, as a whole number in the currency's smallest unit (5000 is $50.00 in USD, ¥5000 in JPY). | 5000 |
| Description | An arbitrary description of the customer for internal reference. | Premium customer account |
| Metadata | Set of key-value pairs that can be attached to the customer. This can be useful for storing additional information about the object in a structured format. | {"order_id": "6735"} |
| Default Payment Method ID | The unique identifier of the customer's default payment method. | pm_1JaiTbDtJQgcyrdS08EmyHHe |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Create Customer⤓
Create Invoice
Create a new invoice. | key: createInvoice
| Input | Notes | Example |
|---|---|---|
| Auto Advance | When true, Stripe will automatically attempt collection of the invoice. | false |
| Collection Method | The method used to collect payment for the invoice. | |
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Description | An arbitrary description for the object, displayed in the Stripe Dashboard. | Monthly subscription invoice |
| Due Date | The due date of the invoice as a Unix timestamp. | 1735689600 |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Subscription ID | The unique identifier for the subscription. | sub_1234567890abcdef |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Create Invoice⤓
Create Payment Intent
Create a new payment intent. | key: createPaymentIntent
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional optional fields: includes Setup Future Usage, Shipping, Statement Descriptor, Statement Descriptor Suffix, Capture Method, Confirmation Method, Error On Requires Action, Mandate, Mandate Data, Off Session, Payment Method Data, Payment Method Options, Radar Options, Return URL, and Use Stripe SDK. | |
| Amount | The amount intended to be collected, as a whole number in the currency's smallest unit (2000 is $20.00 in USD, ¥2000 in JPY). | 2000 |
| Automatic Payment Methods | When enabled, the PaymentIntent will accept payment methods enabled in the Stripe Dashboard that are compatible with the PaymentIntent's other parameters. | |
| Confirm | When true, attempts to confirm this PaymentIntent immediately. | false |
| Currency | The three-letter ISO currency code in lowercase (e.g., usd, eur, gbp). | usd |
| Customer ID | ID of the Customer this PaymentIntent belongs to, if one exists. | cus_1234567890abcdef |
| Description | An arbitrary string attached to the object. Often useful for displaying to users. | Monthly subscription invoice |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Method | ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Payment Method Types | The list of payment method types that this PaymentIntent is allowed to use. | card |
| Receipt Email | Email address that the receipt for the resulting payment will be sent to. | customer@example.com |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Transfer Options | Application fee, settlement account, transfer data, and transfer group for routing funds to connected accounts. |
Example Payload for Create Payment Intent⤓
Create Price
Create a new price. | key: createPrice
| Input | Notes | Example |
|---|---|---|
| Active | When true, the object is currently active and available on the platform. | false |
| Currency | The three-letter ISO currency code in lowercase (e.g., usd, eur, gbp). | usd |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Nickname | A brief description of the price, hidden from customers. | Pro plan monthly |
| Product ID | The unique identifier for the product. | prod_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Recurring Interval | The billing frequency for recurring charges. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Unit Price | The price per unit, as a whole number in the currency's smallest unit (2000 is $20.00 in USD, ¥2000 in JPY). | 2000 |
Example Payload for Create Price⤓
Create Product
Create a new product. | key: createProduct
| Input | Notes | Example |
|---|---|---|
| Active | When true, the object is currently active and available on the platform. | false |
| Description | An arbitrary description for the object, displayed in the Stripe Dashboard. | Monthly subscription invoice |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Product Images | For each list item, provide a URL for the image of the product. | https://example.com/images/product.jpg |
| Product Name | The display name shown to customers for the product. | Premium Subscription |
| Product Type | The category that classifies the product. | |
| Product URL | The URL of a publicly-accessible webpage for this product. May only be set if type=good. | https://example.com/products/premium |
| Shippable | When true, this product can be shipped (i.e., physical goods). | false |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Create Product⤓
Create Subscription
Create a new subscription. | key: createSubscription
| Input | Notes | Example |
|---|---|---|
| Cancel At | A Unix timestamp at which the subscription should cancel. If set before the current period ends, this may cause a proration if enabled. | 1735689600 |
| Collection Method | The method used to collect payment for the invoice. | |
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Days Until Due | The number of days until the payment is due. | 30 |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Price ID | The unique identifier for the price. | price_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Quantity | The number of units to include in the subscription. | 1 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Create Subscription⤓
Create Webhook
Create a new webhook endpoint. | key: createWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Webhook Events | For each item, provide a string value representing the event type to track. For more information, see Stripe event types. | payment_intent.created |
| Webhook URL | The URL where webhook events will be sent. | https://your-webhook-endpoint.com/webhook |
Example Payload for Create Webhook⤓
Delete All Instance Webhooks
Delete all webhook endpoints associated with each flow of the current instance. | key: deleteWebhooks
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Delete All Instance Webhooks⤓
Delete Customer
Permanently delete a customer and immediately cancel any active subscriptions on the customer. | key: deleteCustomer
| Input | Notes | Example |
|---|---|---|
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Delete Customer⤓
Delete Invoice
Delete an existing invoice. | key: deleteInvoice
| Input | Notes | Example |
|---|---|---|
| Invoice ID | The unique identifier for the invoice. | in_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Delete Invoice⤓
Delete Product
Delete an existing product by ID. | key: deleteProduct
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique identifier for the product. | prod_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Delete Product⤓
Delete Subscription
Cancel a subscription by ID. | key: deleteSubscription
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Subscription ID | The unique identifier for the subscription. | sub_1234567890abcdef |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Delete Subscription⤓
Delete Webhook
Delete a webhook endpoint by ID. | key: deleteWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Webhook ID | The ID of the webhook to delete | we_1JaOXaDtJQgcyrdSRnsI9KW5 |
Example Payload for Delete Webhook⤓
Detach Card
Detach a card from a customer. | key: detachCard
| Input | Notes | Example |
|---|---|---|
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Detach Card⤓
Expire Checkout Session
Expire a Stripe Checkout session. | key: expireCheckoutSession
| Input | Notes | Example |
|---|---|---|
| Session ID | The unique identifier for the Checkout Session. | cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Expire Checkout Session⤓
Get Balance Transaction
Retrieve a balance transaction by ID. | key: getBalanceTransaction
| Input | Notes | Example |
|---|---|---|
| Balance Transaction ID | The unique identifier for the balance transaction. | txn_1Jb9jvDtJQgcyrdS1Z9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Balance Transaction⤓
Get Card
Retrieve the information and metadata of a card by ID. | key: getCard
| Input | Notes | Example |
|---|---|---|
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Card⤓
Get Charge
Retrieve the details of a charge that has previously been created. | key: getCharge
| Input | Notes | Example |
|---|---|---|
| Charge ID | The unique identifier for the charge. | ch_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Charge⤓
Get Checkout Session
Retrieve a Stripe Checkout session by ID. | key: getCheckoutSession
| Input | Notes | Example |
|---|---|---|
| Session ID | The unique identifier for the Checkout Session. | cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Checkout Session⤓
Get Customer
Retrieve the information and metadata of a customer by ID. | key: getCustomer
| Input | Notes | Example |
|---|---|---|
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Customer⤓
Get Dispute
Retrieve a dispute by ID. | key: getDispute
| Input | Notes | Example |
|---|---|---|
| Dispute ID | The unique identifier for the dispute. | dp_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Dispute⤓
Get Invoice
Retrieve the information and metadata of an invoice by ID. | key: getInvoice
| Input | Notes | Example |
|---|---|---|
| Invoice ID | The unique identifier for the invoice. | in_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Invoice⤓
Get Payment Intent
Retrieve the details of a payment intent that has previously been created. | key: getPaymentIntent
| Input | Notes | Example |
|---|---|---|
| Client Secret | The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. | pi_1JaOXaDtJQgcyrdSRnsI9KW5_secret_XXXXXXXXXXXX |
| Payment Intent ID | The ID of the PaymentIntent to retrieve. | pi_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Payment Intent⤓
Get Price
Retrieve the information and metadata of a price by ID. | key: getPrice
| Input | Notes | Example |
|---|---|---|
| Price ID | The unique identifier for the price. | price_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Price⤓
Get Product
Retrieve the information and metadata of a product by ID. | key: getProduct
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique identifier for the product. | prod_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Product⤓
Get Subscription
Retrieve the information and metadata of a subscription by ID. | key: getSubscription
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Subscription ID | The unique identifier for the subscription. | sub_1234567890abcdef |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Get Subscription⤓
Get Webhook
Retrieve a webhook endpoint by ID. | key: getWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Webhook ID | The unique identifier for the webhook. | we_1JaOXaDtJQgcyrdSRnsI9KW5 |
Example Payload for Get Webhook⤓
List Accounts
Return a list of accounts connected to the platform. | key: listAccounts
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Accounts⤓
List Balance Transactions
Return a list of transactions that have contributed to the Stripe account balance (such as charges, transfers, and so forth). | key: listBalanceTransactions
| Input | Notes | Example |
|---|---|---|
| Created | A filter on the list based on the object created field. | |
| Currency | Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency. | usd |
| Pagination | Cursor and page-size controls for paging through results. | |
| Source | Filters results to only include transactions originating from the specified Stripe source ID (e.g., a charge or payout ID). | ch_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Balance Transactions⤓
List Cards
Return a list of cards for a customer. | key: listCards
| Input | Notes | Example |
|---|---|---|
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Cards⤓
List Charges
Return a list of all charges. | key: listCharges
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Charges⤓
List Checkout Session Line Items
Return a list of line items for a Stripe Checkout session. | key: listCheckoutSessionLineItems
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Session ID | The unique identifier for the Checkout Session. | cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Checkout Session Line Items⤓
List Checkout Sessions
Return a list of Stripe Checkout sessions. | key: listCheckoutSessions
| Input | Notes | Example |
|---|---|---|
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Checkout Sessions⤓
List Customers
Return a list of customers. | key: listCustomers
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Customers⤓
List Disputes
Return a list of disputes. | key: listDisputes
| Input | Notes | Example |
|---|---|---|
| Charge ID | Only return disputes associated to the charge specified by this charge ID. | ch_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Created | A filter on the list based on the object created field. | |
| Pagination | Cursor and page-size controls for paging through results. | |
| Payment Intent | Filters results to only charges created by the specified Payment Intent. Provide the Payment Intent ID to scope the query. | pi_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Disputes⤓
List Invoices
Return a list of invoices. | key: listInvoices
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Invoices⤓
List Payment Intents
Return a list of payment intents. | key: listPaymentIntents
| Input | Notes | Example |
|---|---|---|
| Created | A filter on the list based on the object created field. | |
| Customer ID | Only return PaymentIntents for the customer specified by this customer ID. | cus_1234567890abcdef |
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Payment Intents⤓
List Prices
Return a list of all available prices. | key: listPrices
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Prices⤓
List Products
Return a list of products. | key: listProducts
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Products⤓
List Subscriptions
Return a list of subscriptions. | key: listSubscriptions
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Subscriptions⤓
List Webhooks
Return a list of all webhook endpoints. | key: listWebhooks
| Input | Notes | Example |
|---|---|---|
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Pagination | Cursor and page-size controls for paging through results. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for List Webhooks⤓
Raw Request
Send a raw HTTP request to the Stripe API. | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/products), The base URL is already included (https://api.stripe.com/v1). For example, to connect to https://api.stripe.com/v1/products, only /products is entered in this field. | /products |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Example Payload for Raw Request⤓
Search Charges
Search for charges previously created using Stripe's Search Query Language. | key: searchCharges
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Query | The search query string used to filter results. Supports Stripe's search query language with field-based filters and operators. | email:'jenny@example.com' |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Search Charges⤓
Search Payment Intents
Search for payment intents previously created using Stripe's Search Query Language. | key: searchPaymentIntent
| Input | Notes | Example |
|---|---|---|
| Pagination | Cursor and page-size controls for paging through results. | |
| Query | The search query string used to filter results. Supports Stripe's search query language with field-based filters and operators. | email:'jenny@example.com' |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Search Payment Intents⤓
Update Card
Update an existing card by ID. | key: updateCard
| Input | Notes | Example |
|---|---|---|
| Billing Address | Billing street, city, state, postal code, and country. | |
| Name & Contact Information | Full name, email, and phone contact details. | |
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Expiration Month | The two-digit expiration month of the card (01-12). | 12 |
| Expiration Year | The four-digit expiration year of the card. | 2026 |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Update Card⤓
Update Charge
Update a specified charge by setting the values of the parameters passed. | key: updateCharge
| Input | Notes | Example |
|---|---|---|
| Charge ID | The unique identifier for the charge. | ch_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Customer ID | The ID of an existing customer that will be associated with this request. | cus_1234567890abcdef |
| Description | An arbitrary string that can be attached to a charge object. It is displayed in the web interface alongside the charge. | Monthly subscription invoice |
| Fraud Details | A set of key-value pairs that can be attached to a charge giving information about its riskiness. | |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Receipt Email | The email address that the receipt for the charge will be sent to. Updating this field triggers a new email receipt to the updated address. | customer@example.com |
| Shipping | Shipping information for the charge. Helps prevent fraud on charges for physical goods. | |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Transfer Group | A string that identifies this transaction as part of a group. Used with Stripe Connect to associate related charges, transfers, and refunds. | ORDER_95 |
Example Payload for Update Charge⤓
Update Checkout Session
Update an existing Stripe Checkout session. | key: updateCheckoutSession
| Input | Notes | Example |
|---|---|---|
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Session ID | The unique identifier for the Checkout Session. | cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Update Checkout Session⤓
Update Customer
Update an existing customer. | key: updateCustomer
| Input | Notes | Example |
|---|---|---|
| Address | Street, city, state, postal code, and country. | |
| Name & Contact Information | Full name, email, and phone contact details. | |
| Balance | The starting balance of the customer, as a whole number in the currency's smallest unit (5000 is $50.00 in USD, ¥5000 in JPY). | 5000 |
| Description | An arbitrary description of the customer for internal reference. | Premium customer account |
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Metadata | Set of key-value pairs that can be attached to the customer. This can be useful for storing additional information about the object in a structured format. | {"order_id": "6735"} |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Update Customer⤓
Update Dispute
Update a dispute by submitting evidence or metadata. Use this action to provide evidence that helps Stripe resolve the dispute in the merchant's favor. | key: updateDispute
| Input | Notes | Example |
|---|---|---|
| Dispute ID | The unique identifier for the dispute. | dp_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Evidence | Evidence to upload to respond to a dispute. | |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Connection | The Stripe connection to use. | |
| Submit | Whether to immediately submit evidence to the bank. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Update Dispute⤓
Update Invoice
Update an existing invoice. | key: updateInvoice
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional optional fields: includes Auto Advance, Application Fee Amount, Coupon, and Discount. | |
| Collection Method | The method used to collect payment for the invoice. | |
| Customer ID | The unique identifier for the customer. | cus_1234567890abcdef |
| Description | An arbitrary description for the object, displayed in the Stripe Dashboard. | Monthly subscription invoice |
| Due Date | The due date of the invoice as a Unix timestamp. | 1735689600 |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Invoice ID | The unique identifier for the invoice. | in_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Update Invoice⤓
Update Payment Intent
Update properties on a payment intent without confirming. | key: updatePaymentIntent
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional optional fields: includes Setup Future Usage, Shipping, Statement Descriptor, Statement Descriptor Suffix, Capture Method, Payment Method Data, and Payment Method Options. | |
| Amount | The amount intended to be collected, as a whole number in the currency's smallest unit (2000 is $20.00 in USD, ¥2000 in JPY). | 2000 |
| Currency | The three-letter ISO currency code in lowercase (e.g., usd, eur, gbp). | usd |
| Customer ID | ID of the Customer this PaymentIntent belongs to, if one exists. | cus_1234567890abcdef |
| Description | An arbitrary string attached to the object. Often useful for displaying to users. | Monthly subscription invoice |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Intent ID | The unique identifier for the Payment Intent. | pi_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Payment Method | ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Payment Method Types | The list of payment method types that this PaymentIntent is allowed to use. | card |
| Receipt Email | Email address that the receipt for the resulting payment will be sent to. | customer@example.com |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Transfer Options | Application fee, transfer data, and transfer group for routing funds to connected accounts. |
Example Payload for Update Payment Intent⤓
Update Price
Update an existing price by ID. | key: updatePrice
| Input | Notes | Example |
|---|---|---|
| Active | When true, the object is currently active and available on the platform. | false |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Nickname | A brief description of the price, hidden from customers. | Pro plan monthly |
| Price ID | The unique identifier for the price. | price_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Update Price⤓
Update Product
Update an existing product. | key: updateProduct
| Input | Notes | Example |
|---|---|---|
| Active | When true, the object is currently active and available on the platform. | false |
| Description | An arbitrary description for the object, displayed in the Stripe Dashboard. | Monthly subscription invoice |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Product ID | The unique identifier for the product. | prod_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Product Images | For each list item, provide a URL for the image of the product. | https://example.com/images/product.jpg |
| Product URL | The URL of a publicly-accessible webpage for this product. May only be set if type=good. | https://example.com/products/premium |
| Shippable | When true, this product can be shipped (i.e., physical goods). | false |
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Product Name | The display name shown to customers for the product. | Premium Subscription |
Example Payload for Update Product⤓
Update Subscription
Update an existing subscription. | key: updateSubscription
| Input | Notes | Example |
|---|---|---|
| Cancel At | A Unix timestamp at which the subscription should cancel. If set before the current period ends, this may cause a proration if enabled. | 1735689600 |
| Collection Method | The method used to collect payment for the invoice. | |
| Values | The names of optional fields and their values to use when creating/updating a record. For example, if a custom configured field is not represented as an input, here its key can be specified along with an assigned value. | {"footer": "Thank you for your business"} |
| Metadata | Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | {"order_id": "6735"} |
| Payment Method ID | The unique identifier for the payment method. | pm_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Quantity | The number of units to include in the subscription. | 1 |
| Connection | The Stripe connection to use. | |
| Subscription ID | The unique identifier for the subscription. | sub_1234567890abcdef |
| Price ID | The unique identifier for the price. | price_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
Example Payload for Update Subscription⤓
Update Webhook
Update an existing webhook endpoint by ID. | key: updateWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The Stripe connection to use. | |
| Timeout | The maximum time a client will await a response (in milliseconds). | 60000 |
| Webhook Events | The events the webhook will listen for | payment_intent.created |
| Webhook ID | The ID of the webhook to update | we_1JaOXaDtJQgcyrdSRnsI9KW5 |
| Webhook URL | The URL the webhook will send requests to | https://your-webhook-endpoint.com/webhook |
Example Payload for Update Webhook⤓
Changelog
2026-08-31
- Added output schemas to 61 actions for improved field mapping during configuration
- Added inline action calling support across all actions for improved example output during configuration
- Added a Select Card dropdown to Payment Method ID on Attach Card, Detach Card, Get Card, Update Card, Create Invoice, Update Invoice, and Create Subscription, listing the cards saved against the selected Customer ID instead of requiring the ID to be typed
- Added the Webhook Secret input to the Webhook Events trigger as a masked field, so signature validation can be configured when a deployment reused a pre-existing Stripe endpoint; Stripe returns a signing secret only when an endpoint is created, so none is stored in that case
Updated actions and trigger functionality:
- Amount on Create Payment Intent and Update Payment Intent now reports a fractional value as an error naming the field, instead of truncating it and charging the smaller whole number: an entered 44.55 was charged as 44 in the smallest currency unit. Amount is required, so every configuration of these two actions supplies it
- Balance on Create Customer and Update Customer and Unit Price on Create Price are now sent as entered instead of multiplied by 100, matching Stripe's smallest currency unit convention
- Added the Payment Method ID input that Update Card and Update Subscription both send but never collected
- Create Checkout Session now sends the Customer Email, Customer ID, and Client Reference ID it collects
- Create Card now attaches the created card to the customer identified by Customer ID
- Reconfiguring the Webhook Events trigger's selected events now updates its managed Stripe endpoint in place and preserves the endpoint's signing secret, instead of adding a second endpoint at the same flow URL that delivered every overlapping event twice
- Fixed the Webhook Events trigger lifecycle so the managed endpoint is matched by the flow's URL and removed when the instance is torn down even if its events were reconfigured after deployment, leaving no orphaned endpoints in the Stripe account, and so testing the trigger no longer fails on the absent signature header
- Delete All Instance Webhooks now returns only the endpoints it deleted, instead of padding the returned list with a blank entry for every other webhook endpoint in the Stripe account
- New and Updated Records now holds its polling cursor when a recurrence returns more events than it can fetch, instead of advancing past the events it left behind
- An explicit
falseor0now reaches Stripe, so Update Price can deactivate a price, Create Product and Update Product can clear Shippable, Create Invoice and Update Invoice can turn off Auto Advance, Update Customer can clear a Balance, Create Price can set a free Unit Price, Create Subscription and Update Subscription can set a Quantity of zero, and Create Subscription can set Days Until Due to zero for an invoice due on receipt - A
0referenced from an earlier step now survives on Application Fee Amount and Amount to Capture instead of being discarded as blank, so it no longer silently becomes a full capture; an omitted Amount to Capture tells Stripe to capture the whole authorized amount (a0typed directly into the field was already sent correctly) - Limit, Application Fee Amount, Amount to Capture, Unit Price on Create Price, and Balance on Create Customer and Update Customer accept whole numbers only, and now report a fractional value as an error naming the field instead of rounding it down or forwarding it for Stripe to reject
- Leaving Payment Method Types on Create Payment Intent and Update Payment Intent, or Event Types on New and Updated Records, blank no longer fails the step
- Leaving Webhook Events blank on Update Webhook now leaves the endpoint's stored events alone instead of failing the step, matching how a blank Webhook URL already behaved
- Charge ID left blank on List Disputes is now omitted rather than sent as an empty charge ID
- A blank Timeout now falls back to the Stripe client default instead of configuring the client with no timeout at all
- Optional fields left blank are now omitted instead of sent as an empty string, covering Currency on Update Payment Intent, Type on Create Product, Name on Create Customer, and State/Province on Create Card
- Customer ID left blank on Create Invoice and List Cards is now omitted rather than sent as an empty customer ID that Stripe rejects; the field is optional in both of those Stripe endpoints
- Update Customer now reports a blank Customer ID as an error naming the field, instead of requesting an empty customer record from Stripe
- Select Charge and Select Balance Transaction labels now show amounts in the smallest currency unit, correcting zero decimal currencies such as JPY and three decimal currencies such as KWD
- Removed Card Number and CVC from Update Card, Product Caption from Create Product and Update Product, and Coupon from Create Subscription and Update Subscription, none of which were sent to Stripe
Reconfiguration notice: monetary inputs now take the smallest currency unit exactly as entered. Re-enter a fractional Amount on Create Payment Intent or Update Payment Intent as a whole number, and re-enter Balance on Create Customer or Update Customer and Unit Price on Create Price in the smallest currency unit, since these are no longer multiplied by 100.
Restructured action inputs into structured objects for an improved user experience.
- Every list and search action groups Limit, Starting After, Ending Before, and Page into Pagination, with Fetch All left as a top level toggle on List Checkout Sessions and List Webhooks
- Create Card and Update Card group their cardholder inputs into Billing Address and Name & Contact Information, and Create Customer and Update Customer group theirs into Address and Name & Contact Information
- Create Payment Intent and Update Payment Intent group their optional inputs into Transfer Options and Additional Fields, and Confirm Payment Intent, Capture Payment Intent, and Update Invoice group theirs into Additional Fields
2026-05-28
Added New and Updated Records polling trigger that polls Stripe's /v1/events API for change events on a configured schedule. Events are partitioned by type — *.created events go to the created bucket and all other event types go to the updated bucket. The trigger is a drop-in alternative to the existing webhook trigger for environments without a publicly reachable webhook endpoint
2026-04-30
Various modernizations and documentation updates
2026-03-31
Various modernizations and documentation updates
2026-03-27
Added Customer ID input to card retrieval, card update, and create invoice actions to support inline datasource dependencies
2026-03-05
Added inline data sources for balance transactions and cards to enable dynamic dropdown selection
2026-02-26
Added inline data sources for charges, disputes, and checkout sessions to enable dynamic dropdown selection
2025-10-17
Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup
2025-10-13
Added inline data sources for customers, invoices, payment intents, prices, products, and subscriptions to enhance data selection capabilities
2025-08-12
Made webhook creation process idempotent to prevent duplication
2025-06-18
Added webhook validation toggle option for flexible webhook processing