Stripe Component

Manage payments, customers, subscriptions, and other objects in your Stripe account.

Component key: stripe · Source ·

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: apiKey

To 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
Click Reveal test key (or create a new restricted key as needed) and copy the key value

Security Note

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`, `invoice.paid`). Leave empty to include all event types. See Stripe event types.	customer.created
Show New Records	When enabled, events with type ending in `.created` are emitted in the `created` bucket of the payload.	true
Show Updated Records	When enabled, all other change events (e.g., `.updated`, `.deleted`, `.succeeded`) are emitted in the `updated` bucket of the payload.	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/events with a created[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 type field:
- Event types ending in .created are appended to the created array
- All other event types are appended to the updated array
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, Stripe orders events newest-first, which truncates the older end of the change window. The cursor instead advances to the created timestamp of the oldest fetched event, so the next poll resumes from the gap. This yields at-least-once semantics: older events may be re-emitted as duplicates after truncation, but none are silently lost
A warning is logged whenever truncation occurs, including the cursor value used for the next poll

Configuration

Configure the following inputs:

Connection: The Stripe connection used to authenticate API requests
Event Types: Optional list of Stripe event types to poll for (e.g., customer.created, invoice.paid). Leave empty to include all event types. See Stripe event types
Show New Records: When enabled, events with a type ending in .created are emitted in the created bucket of the payload. Defaults to true
Show Updated Records: When enabled, all other change events (e.g., .updated, .deleted, .succeeded) are emitted in the updated bucket of the payload. Defaults to true

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
      }
    ]
  }
}

Notes

At-least-once semantics: When truncation occurs at the page cap, the cursor advances to the oldest fetched event's created timestamp so the next poll resumes from the gap. This guarantees no events are silently lost, but older events may be re-emitted as duplicates. Downstream flows should be idempotent on Stripe event id
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⤓

Loading…

Webhook (Deprecated)

Receive and validate webhook requests from Stripe for webhooks you configure. | 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

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.

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.
On Instance Deletion: The trigger automatically removes the webhook endpoint from the connected Stripe account.
On Event Receipt: The trigger validates the Stripe-Signature header 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.

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.
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 your Stripe account. | key: selectBalanceTransaction | type: picklist

Input	Notes	Example
Connection	The Stripe connection to use.

Example Payload for Select Balance Transaction⤓

Loading…

Select Card

Select a card payment method for the selected customer in your 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⤓

Loading…

Select Charge

Select a charge from a list of charges in your Stripe account. | key: selectCharge | type: picklist

Input	Notes	Example
Connection	The Stripe connection to use.

Example Payload for Select Charge⤓

Loading…

Select Checkout Session

Select a checkout session from a list of sessions in your Stripe account. | key: selectCheckoutSession | type: picklist

Input	Notes	Example
Connection	The Stripe connection to use.

Example Payload for Select Checkout Session⤓

Loading…

Select Customer

A picklist of customers in your 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 your Stripe account. | key: selectDispute | type: picklist

Input	Notes	Example
Connection	The Stripe connection to use.

Example Payload for Select Dispute⤓

Loading…

Select Invoice

A picklist of invoices in your Stripe account. | key: selectInvoice | type: picklist

Input	Notes	Example
Connection	The Stripe connection to use.

Select Payment Intent

A picklist of payment intents in your Stripe account. | key: selectPaymentIntent | type: picklist

Input	Notes	Example
Customer	Only return PaymentIntents for the customer specified by this customer ID.	cus_1234567890abcdef
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.

Select Price

A picklist of prices in your Stripe account. | key: selectPrice | type: picklist

Input	Notes	Example
Connection	The Stripe connection to use.

Select Product

A picklist of products in your Stripe account. | key: selectProduct | type: picklist

Input	Notes	Example
Connection	The Stripe connection to use.

Select Subscription

A picklist of subscriptions in your 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⤓

Loading…

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⤓

Loading…

Capture Payment Intent

Capture the funds of an existing uncaptured payment intent when its status is requires_capture. | key: capturePaymentIntent

Input	Notes	Example
Amount to Capture	The amount to capture from the PaymentIntent, which must be less than or equal to the original amount.
Application Fee Amount	The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account.	500
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.
Payment Intent ID	The unique identifier for the Payment Intent.	pi_1JaOXaDtJQgcyrdSRnsI9KW5
Statement Descriptor	For non-card charges, the complete description that appears on customer statements. Must be 5-22 characters and cannot use special characters `<`, `>`, `\`, `'`, `"`.	ACME ORDER 95
Statement Descriptor Suffix	Information about a card payment that customers see on their statements, concatenated with the prefix (the account name) to form the full statement descriptor.	ORDER 95
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Transfer Data	The parameters used to automatically create a Transfer when the payment is captured.	`{"amount":1000}`

Example Payload for Capture Payment Intent⤓

Loading…

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⤓

Loading…

Confirm Payment Intent

Confirm that the customer intends to pay with the current or provided payment method. | key: confirmPaymentIntent

Input	Notes	Example
Capture Method	Controls when the funds will be captured from the customer's account.
Error On Requires Action	Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
Mandate	ID of the mandate to be used for this payment.
Mandate Data	This hash contains details about the Mandate to create.	`{"customer_acceptance":{"type":"online"}}`
Off Session	Set to true to indicate that the customer is not in the checkout flow during this payment attempt and is therefore unable to authenticate.
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.
Payment Method Data	If provided, this hash will be used to create a PaymentMethod.	`{"type":"card"}`
Payment Method Options	Payment-method-specific configuration for this PaymentIntent.	`{"card":{"request_three_d_secure":"any"}}`
Radar Options	Options to configure Radar.	`{"session":"123456"}`
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
Return URL	The URL to redirect the customer back to after authenticating or cancelling payment on the payment method's app or site.	https://example.com/return
Setup Future Usage	Indicates the intent to make future payments with this PaymentIntent's payment method. Use `on_session` if the customer is present during the future payment, or `off_session` if not.
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Use Stripe SDK	Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

Example Payload for Confirm Payment Intent⤓

Loading…

Create Card

Create a new card for a customer. | key: createCard

Input	Notes	Example
Billing Street Address	The street address for the billing information.	123 Main Street
Billing Address 2	Additional address information for the billing address (optional).	Suite 100
Billing City	The city for the billing address.	San Francisco
Billing Country	The two-letter ISO country code for the billing address.	US
Billing Email	The email address for the billing contact.	billing@example.com
Full Name	The full name for the billing contact.	John Doe
Card Number	The full credit or debit card number, with no spaces or dashes.	4242424242424242
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.
Billing Phone	The phone number for the billing contact.	18005551234
Billing Postal Code	The postal code for the billing address.	94105
Billing State	The state or province code for the billing address.	CA
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for Create Card⤓

Loading…

Create Checkout Session

Create a new Stripe Checkout session. | key: createCheckoutSession

Input	Notes	Example
Body Params	More parameters to pass to the request.	`{ "customer": "cus_123456" }`
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 your internal systems.	order_12345
Email	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.	`[{"price":"price_H5ggYwtDq4fbrJ","quantity":2}]`
Mode	The behavior of the Checkout Session: `payment` for one-time charges, `setup` to collect a payment method for future use, or `subscription` for recurring billing.	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⤓

Loading…

Create Customer

Create a new customer. | key: createCustomer

Input	Notes	Example
Address Line 1	The first line of the customer's billing address, typically the street number and name.	123 Main Street
Address Line 2	The second line of the customer's billing address, used for apartment, suite, or unit numbers.	Suite 3
Balance	The starting balance of the customer in cents (e.g., 5000 = $50.00).	5000
City	The city portion of the customer's billing address.	San Francisco
Country	The two-letter ISO 3166-1 alpha-2 country code for the customer's billing address.	US
Description	An arbitrary description of the customer for internal reference.	Premium customer account
Email	The customer's email address. Used for receipts, invoices, and other Stripe communications.	customer@example.com
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.
Name	The customer's full name, displayed in the Stripe Dashboard and on receipts.	John Doe
Default Payment Method ID	The unique identifier of the customer's default payment method.	pm_1JaiTbDtJQgcyrdS08EmyHHe
Phone	The customer's phone number in E.164 format. Used for SMS receipts and Strong Customer Authentication.	18005554545
Postal Code	The postal or ZIP code portion of the customer's billing address.	94105
State	The state, province, or region code for the customer's billing address (e.g., `CA` for California).	CA
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for Create Customer⤓

Loading…

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.
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.
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⤓

Loading…

Create Payment Intent

Create a new payment intent. | key: createPaymentIntent

Input	Notes	Example
Amount	Amount intended to be collected in cents (e.g., 2000 = $20.00).	2000
Application Fee Amount	The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account.	500
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.	`{"enabled":true}`
Capture Method	Controls when the funds will be captured from the customer's account.
Confirm	When true, attempts to confirm this PaymentIntent immediately.	false
Confirmation Method	Controls how the PaymentIntent is confirmed: `automatic` confirms on the server immediately, `manual` requires explicit client-side confirmation.
Currency	The three-letter ISO currency code in lowercase (e.g., usd, eur, gbp).	usd
Customer	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
Error On Requires Action	Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
Mandate	ID of the mandate to be used for this payment.
Mandate Data	This hash contains details about the Mandate to create.	`{"customer_acceptance":{"type":"online"}}`
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.
Off Session	Set to true to indicate that the customer is not in the checkout flow during this payment attempt and is therefore unable to authenticate.
On Behalf Of	The Stripe account ID for which these funds are intended.
Payment Method	ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
Payment Method Data	If provided, this hash will be used to create a PaymentMethod.	`{"type":"card"}`
Payment Method Options	Payment-method-specific configuration for this PaymentIntent.	`{"card":{"request_three_d_secure":"any"}}`
Payment Method Types	The list of payment method types that this PaymentIntent is allowed to use.
Radar Options	Options to configure Radar.	`{"session":"123456"}`
Receipt Email	Email address that the receipt for the resulting payment will be sent to.	customer@example.com
Return URL	The URL to redirect the customer back to after authenticating or cancelling payment on the payment method's app or site.	https://example.com/return
Setup Future Usage	Indicates the intent to make future payments with this PaymentIntent's payment method. Use `on_session` if the customer is present during the future payment, or `off_session` if not.
Shipping	Shipping information for this PaymentIntent.	`{"address":{"city":"San Francisco","country":"US","line1":"1234 Main Street","line2":"Apt. 123","postal_code":"94111","state":"CA"},"name":"John Doe"}`
Statement Descriptor	For non-card charges, the complete description that appears on customer statements. Must be 5-22 characters and cannot use special characters `<`, `>`, `\`, `'`, `"`.	ACME ORDER 95
Statement Descriptor Suffix	Information about a card payment that customers see on their statements, concatenated with the prefix (the account name) to form the full statement descriptor.	ORDER 95
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Transfer Data	The parameters used to automatically create a Transfer when the payment succeeds.	`{"destination":"acct_1F5yQhFjP0puYwXh"}`
Transfer Group	A string that identifies the resulting payment as part of a group.	ORDER_95
Use Stripe SDK	Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

Example Payload for Create Payment Intent⤓

Loading…

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.
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.
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 in cents.	2000

Example Payload for Create Price⤓

Loading…

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.
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.
Product Caption	(DEPRECATED) A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.	Premium quality product
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⤓

Loading…

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.
Coupon	(DEPRECATED) The unique identifier of the coupon to apply to the invoice.	SUMMER2025
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.
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.
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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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.
Payment 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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

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⤓

Loading…

List Accounts

Return a list of accounts connected to your platform. | key: listAccounts

Input	Notes	Example
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Accounts⤓

Loading…

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.	`{"gt":1620000000}`
Currency	Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.	usd
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Source	Filters results to only include transactions originating from the specified Stripe source ID (e.g., a charge or payout ID).
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
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⤓

Loading…

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
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Cards⤓

Loading…

List Charges

Return a list of all charges. | key: listCharges

Input	Notes	Example
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Charges⤓

Loading…

List Checkout Session Line Items

Return a list of line items for a Stripe Checkout session. | key: listCheckoutSessionLineItems

Input	Notes	Example
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Session ID	The unique identifier for the Checkout Session.	cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
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⤓

Loading…

List Checkout Sessions

Return a list of Stripe Checkout sessions. | key: listCheckoutSessions

Input	Notes	Example
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Fetch All	When true, automatically fetches all pages of results using pagination.	false
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
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⤓

Loading…

List Customers

Return a list of customers. | key: listCustomers

Input	Notes	Example
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Customers⤓

Loading…

List Disputes

Return a list of disputes. | key: listDisputes

Input	Notes	Example
Charge	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.	`{"gt":1620000000}`
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Payment Intent	Filters results to only charges created by the specified Payment Intent. Provide the Payment Intent ID to scope the query.	pi_1JaOXaDtJQgcyrdSRnsI9KW5
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Disputes⤓

Loading…

List Invoices

Return a list of invoices. | key: listInvoices

Input	Notes	Example
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Invoices⤓

Loading…

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.	`{"gt":1620000000}`
Customer	Only return PaymentIntents for the customer specified by this customer ID.	cus_1234567890abcdef
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
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⤓

Loading…

List Prices

Return a list of all available prices. | key: listPrices

Input	Notes	Example
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Prices⤓

Loading…

List Products

Return a list of products. | key: listProducts

Input	Notes	Example
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Products⤓

Loading…

List Subscriptions

Return a list of subscriptions. | key: listSubscriptions

Input	Notes	Example
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Subscriptions⤓

Loading…

List Webhooks

Return a list of all webhook endpoints. | key: listWebhooks

Input	Notes	Example
Ending Before	A cursor for use in pagination. `ending_before` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects starting with `obj_bar`, the next call can include `ending_before=obj_bar` to fetch the previous page of the list.	cus_1234567890abcdef
Fetch All	When true, automatically fetches all pages of results using pagination.	false
Limit	The maximum number of results to return.	100
Starting After	A cursor for use in pagination. `starting_after` is an object ID that defines the place in the list. For instance, if a list request returns 100 objects ending with `obj_foo`, the next call can include `starting_after=obj_foo` to fetch the next page of the list.	cus_1234567890abcdef
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for List Webhooks⤓

Loading…

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⤓

Loading…

Search Charges

Search for charges previously created using Stripe's Search Query Language. | key: searchCharges

Input	Notes	Example
Limit	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.	100
Page	A cursor for pagination across multiple pages of results. Leave empty on the first call. Use the `next_page` value returned in a previous response to request subsequent 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⤓

Loading…

Search Payment Intents

Search for payment intents previously created using Stripe's Search Query Language. | key: searchPaymentIntent

Input	Notes	Example
Limit	The maximum number of results to return.	100
Page	A cursor for pagination across multiple pages of results. Leave empty on the first call. Use the `next_page` value returned in a previous response to request subsequent 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⤓

Loading…

Update Card

Update an existing card by ID. | key: updateCard

Input	Notes	Example
Billing Street Address	The street address for the billing information.	123 Main Street
Billing Address 2	Additional address information for the billing address (optional).	Suite 100
Billing City	The city for the billing address.	San Francisco
Billing Country	The two-letter ISO country code for the billing address.	US
Billing Email	The email address for the billing contact.	billing@example.com
Full Name	The full name for the billing contact.	John Doe
Card Number	The full credit or debit card number, with no spaces or dashes.	4242424242424242
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.
Billing Phone	The phone number for the billing contact.	18005551234
Billing Postal Code	The postal code for the billing address.	94105
Billing State	The state or province code for the billing address.	CA
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for Update Card⤓

Loading…

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	The ID of an existing customer that will be associated with this request.	cus_1234567890abcdef
Description	An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge	Monthly subscription invoice
Fraud Details	A set of key-value pairs you can attach to a charge giving information about its riskiness.	`{"user_report":"safe"}`
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.
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.	`{"address":{"city":"San Francisco","country":"US","line1":"1234 Main Street","line2":"Apt. 123","postal_code":"94111","state":"CA"},"name":"John Doe"}`
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⤓

Loading…

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.
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⤓

Loading…

Update Customer

Update an existing customer. | key: updateCustomer

Input	Notes	Example
Address Line 1	The first line of the customer's billing address, typically the street number and name.	123 Main Street
Address Line 2	The second line of the customer's billing address, used for apartment, suite, or unit numbers.	Suite 3
Balance	The starting balance of the customer in cents (e.g., 5000 = $50.00).	5000
City	The city portion of the customer's billing address.	San Francisco
Country	The two-letter ISO 3166-1 alpha-2 country code for the customer's billing address.	US
Description	An arbitrary description of the customer for internal reference.	Premium customer account
Email	The customer's email address. Used for receipts, invoices, and other Stripe communications.	customer@example.com
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.
Name	The customer's full name, displayed in the Stripe Dashboard and on receipts.	John Doe
Phone	The customer's phone number in E.164 format. Used for SMS receipts and Strong Customer Authentication.	18005554545
Postal Code	The postal or ZIP code portion of the customer's billing address.	94105
State	The state, province, or region code for the customer's billing address (e.g., `CA` for California).	CA
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.
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

Example Payload for Update Customer⤓

Loading…

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.	`{"cancellation_policy":"policy_123456"}`
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.
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⤓

Loading…

Update Invoice

Update an existing invoice. | key: updateInvoice

Input	Notes	Example
Application Fee Amount	The application fee amount in cents. Only applicable when collection method is 'Charge Automatically'.	500
Auto Advance	When true, Stripe will automatically attempt collection of the invoice.	false
Collection Method	The method used to collect payment for the invoice.
Coupon	The unique identifier of the coupon to apply to the invoice.	SUMMER2025
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
Discount	The discount ID to apply to the invoice.	di_1JaOXaDtJQgcyrdSRnsI9KW5
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.
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.
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⤓

Loading…

Update Payment Intent

Update properties on a payment intent without confirming. | key: updatePaymentIntent

Input	Notes	Example
Amount	Amount intended to be collected in cents (e.g., 2000 = $20.00).	2000
Application Fee Amount	The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account.	500
Capture Method	Controls when the funds will be captured from the customer's account.
Currency	The three-letter ISO currency code in lowercase (e.g., usd, eur, gbp).	usd
Customer	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.
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.
Payment Method Data	If provided, this hash will be used to create a PaymentMethod.	`{"type":"card"}`
Payment Method Options	Payment-method-specific configuration for this PaymentIntent.	`{"card":{"request_three_d_secure":"any"}}`
Payment Method Types	The list of payment method types that this PaymentIntent is allowed to use.
Receipt Email	Email address that the receipt for the resulting payment will be sent to.	customer@example.com
Setup Future Usage	Indicates the intent to make future payments with this PaymentIntent's payment method. Use `on_session` if the customer is present during the future payment, or `off_session` if not.
Shipping	Shipping information for this PaymentIntent.	`{"address":{"city":"San Francisco","country":"US","line1":"1234 Main Street","line2":"Apt. 123","postal_code":"94111","state":"CA"},"name":"John Doe"}`
Statement Descriptor	For non-card charges, the complete description that appears on customer statements. Must be 5-22 characters and cannot use special characters `<`, `>`, `\`, `'`, `"`.	ACME ORDER 95
Statement Descriptor Suffix	Information about a card payment that customers see on their statements, concatenated with the prefix (the account name) to form the full statement descriptor.	ORDER 95
Connection	The Stripe connection to use.
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Transfer Data	The parameters used to automatically create a Transfer when the payment succeeds.	`{"destination":"acct_1F5yQhFjP0puYwXh"}`
Transfer Group	A string that identifies the resulting payment as part of a group.	ORDER_95

Example Payload for Update Payment Intent⤓

Loading…

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.
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.
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⤓

Loading…

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.
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.
Product Caption	(DEPRECATED) A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.	Premium quality product
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⤓

Loading…

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.
Coupon	(DEPRECATED) The unique identifier of the coupon to apply to the invoice.	SUMMER2025
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.
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.
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⤓

Loading…

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⤓

Loading…

Changelog

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

Manage payments, customers, subscriptions, and other objects in your Stripe account.

Description​

API Documentation​

Connections​

API Key​

Prerequisites​

Setup Steps​

Configure the Connection​

Verify Connection​

Triggers​

New and Updated Records​

How It Works​

Configuration​

Event Types​

Returned Data​

Notes​

Webhook (Deprecated)​

Webhook Events​

How It Works​

Configuration​

Event Types​

Returned Data​

Notes​

Data Sources​

Select Balance Transaction​

Select Card​

Select Charge​

Select Checkout Session​

Select Customer​

Select Dispute​

Select Invoice​

Select Payment Intent​

Select Price​

Select Product​

Select Subscription​

Actions​

Attach Card​

Cancel Payment Intent​

Capture Payment Intent​

Close Dispute​

Confirm Payment Intent​

Create Card​

Create Checkout Session​

Create Customer​

Create Invoice​

Create Payment Intent​

Create Price​

Create Product​

Create Subscription​

Create Webhook​

Delete All Instance Webhooks​

Delete Customer​

Delete Invoice​

Delete Product​

Delete Subscription​

Delete Webhook​

Detach Card​

Expire Checkout Session​

Get Balance Transaction​

Get Card​

Get Charge​

Get Checkout Session​

Get Customer​

Get Dispute​

Get Invoice​

Get Payment Intent​

Get Price​

Get Product​

Get Subscription​

Get Webhook​

List Accounts​

List Balance Transactions​

List Cards​

List Charges​

List Checkout Session Line Items​

List Checkout Sessions​

List Customers​

List Disputes​

List Invoices​

List Payment Intents​

Description

API Documentation

Connections

API Key

Prerequisites

Setup Steps

Configure the Connection

Verify Connection

Triggers

New and Updated Records

How It Works

Configuration

Event Types

Returned Data

Notes

Webhook (Deprecated)

Webhook Events

How It Works

Configuration

Event Types

Returned Data

Notes

Data Sources

Select Balance Transaction

Select Card

Select Charge

Select Checkout Session

Select Customer

Select Dispute

Select Invoice

Select Payment Intent

Select Price

Select Product

Select Subscription

Actions

Attach Card

Cancel Payment Intent

Capture Payment Intent

Close Dispute

Confirm Payment Intent

Create Card

Create Checkout Session

Create Customer

Create Invoice

Create Payment Intent

Create Price

Create Product

Create Subscription

Create Webhook

Delete All Instance Webhooks

Delete Customer

Delete Invoice

Delete Product

Delete Subscription

Delete Webhook

Detach Card

Expire Checkout Session

Get Balance Transaction

Get Card

Get Charge

Get Checkout Session

Get Customer

Get Dispute

Get Invoice

Get Payment Intent

Get Price

Get Product

Get Subscription

Get Webhook

List Accounts

List Balance Transactions

List Cards

List Charges

List Checkout Session Line Items

List Checkout Sessions

List Customers

List Disputes

List Invoices

List Payment Intents

List Prices