Stripe Component

Manage objects connected to your Stripe platform

Component key: stripe · Changelog ↓

Description

The Stripe component provides functionality for interacting with the Stripe API.

API Documentation

This component was built using the Stripe REST API Reference

Connections

API Key

key: apiKey

The Stripe component uses API keys to authenticate requests. You can view and manage your API keys in the Stripe Dashboard. For information on obtaining an API key from Stripe, refer to the docs

Input	Notes	Example
API Key	Stripe API Key from the Stripe Dashboard. Use a test key (sk_test_...) for development and a live key (sk_live_...) for production. Find at https://dashboard.stripe.com/apikeys	sk_live_51JaOXaDtJQgcyrdS

Triggers

Instance Webhooks

Automatically manages Stripe webhook subscriptions for your instance. On instance deploy, this trigger creates a webhook endpoint in Stripe (or reuses an existing one with matching URL and events). On instance deletion, it removes the webhook. The trigger validates incoming webhook signatures and handles all webhook lifecycle management automatically. Note: Webhooks are created/updated each time an instance is deployed or reconfigured. | key: instanceDeployWebhook

Input	Notes	Example
Connection
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 that represents which event you want to track. For more information, see https://docs.stripe.com/api/events/types.	payment_intent.created

The Instance Webhooks trigger can manage the Stripe webhook subscriptions for your instance. Unlike traditional webhook setups that require manual configuration in the Stripe dashboard, this trigger handles the entire webhook lifecycle.

When the trigger is used in a flow:

• On Instance Deploy: The trigger automatically creates a webhook endpoint in your Stripe account pointing to your instance's unique webhook URL. If a webhook with the same URL and events already exists, it uses the existing webhook to prevent duplication.
• On Instance Deletion: The trigger automatically removes the webhook endpoint from your Stripe account.

---

Webhook (Deprecated)

Receive and validate webhook requests from Stripe for webhooks you configure. | key: webhook

---

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

{
  "result": [
    {
      "label": "Payment for order #1234 - 50 USD",
      "key": "txn_1Jb9jvDtJQgcyrdS1Z9KW5"
    }
  ]
}

---

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 of the customer.	cus_1234567890abcdef
Connection

{
  "result": [
    {
      "label": "VISA ****4242 (12/2026)",
      "key": "pm_1JaOXaDtJQgcyrdSRnsI9KW5"
    }
  ]
}

---

Select Charge

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

Input	Notes	Example
Connection

{
  "result": [
    {
      "label": "Payment for order #1234 - 50 USD",
      "key": "ch_1JaOXaDtJQgcyrdSRnsI9KW5"
    }
  ]
}

---

Select Checkout Session

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

Input	Notes	Example
Connection

{
  "result": [
    {
      "label": "cs_test_a1b2c3d4 - complete (paid)",
      "key": "cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
    }
  ]
}

---

Select Customer

Select a customer from a dropdown menu | key: selectCustomer | type: picklist

Input	Notes	Example
Connection

---

Select Dispute

Select a dispute from a list of disputes in your Stripe account. | key: selectDispute | type: picklist

Input	Notes	Example
Connection

{
  "result": [
    {
      "label": "dp_1JaOXaDtJQgcyrdS - fraudulent (needs_response)",
      "key": "dp_1JaOXaDtJQgcyrdSRnsI9KW5"
    }
  ]
}

---

Select Invoice

Select an invoice from a list of invoices | key: selectInvoice | type: picklist

Input	Notes	Example
Connection

---

Select Payment Intent

Select a payment intent from a list of payment intents | 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 your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection

---

Select Price

Select a price from a list of prices | key: selectPrice | type: picklist

Input	Notes	Example
Connection

---

Select Product

Select a product from a list of products | key: selectProduct | type: picklist

Input	Notes	Example
Connection

---

Select Subscription

Select a subscription from a list of subscriptions | key: selectSubscription | type: picklist

Input	Notes	Example
Connection

---

Actions

Attach Card

Attach a card to a customer | key: attachCard

Input	Notes	Example
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Payment Method Id	The unique identifier of the payment method.	pm_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Cancel Payment Intent

A PaymentIntent object 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 ID of the Payment Intent.
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Capture Payment Intent

Capture the funds of an existing uncaptured PaymentIntent 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 you can attach 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 ID of the Payment Intent.
Statement Descriptor	For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor Suffix	Provides information about a card payment that customers see on their statements.
Connection
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.

---

Close Dispute

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost. | key: closeDispute

Input	Notes	Example
Dispute ID	The unique identifier of the dispute.	dp_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Confirm Payment Intent

Confirm that your customer intends to pay with 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.
Off Session	Set to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.
Payment Intent ID	The ID of the Payment Intent.
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.
Payment Method Options	Payment-method-specific configuration for this PaymentIntent.
Radar Options	Options to configure Radar.
Receipt Email	This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
Return Url	The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site.
Setup Future Usage	Indicates that you intend to make future payments with this PaymentIntent’s payment method.
Connection
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.

---

Create Card

Create a new card | 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 country for the billing address (two-letter ISO country code).	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 card number.	4242424242424242
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
CVC	The CVC security code on the back of the card.	123
Expiration Month	The expiration month of the card.	12
Expiration Year	The expiration year of the card.	2026
Metadata	Set of key-value pairs that you can attach 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 for the billing address.	CA
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

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 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.
Mode	The mode of the Checkout Session.	payment
Connection
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

{
  "data": {
    "id": "cs_test_123",
    "object": "checkout.session",
    "amount_subtotal": 2000,
    "amount_total": 2000,
    "currency": "usd",
    "customer": null,
    "mode": "payment",
    "payment_status": "unpaid",
    "status": "open",
    "url": "https://checkout.stripe.com/c/pay/cs_test_123"
  }
}

---

Create Customer

Create a new customer object | key: createCustomer

Input	Notes	Example
Address Line 1	The street address of the customer.	123 Main Street
Address Line 2	Additional address information for the customer (optional).	Suite 3
Balance	The balance of the customer in cents (e.g., 5000 = $50.00).	5000
City	The city of the customer.	San Francisco
Country	The country of the customer (two-letter ISO country code).	US
Description	A description of the customer.	Premium customer account
Email	The email address of the customer.	customer@example.com
Metadata	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Name	The name of the customer.	John Doe
Default Payment Method Id	The unique identifier of the customer's default payment method.	pm_1JaiTbDtJQgcyrdS08EmyHHe
Phone	The phone number of the customer.	18005554545
Postal Code	The postal code of the customer.	94105
State	The state of the customer.	CA
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

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 collection method for the invoice.
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Description	A description of the invoice.	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 you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Metadata	Set of key-value pairs that you can attach 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 of the payment method.	pm_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Subscription Id	The unique identifier of the subscription.	sub_1234567890abcdef
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Create Payment Intent

Creates a PaymentIntent object. | 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, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent’s other parameters.
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
Currency	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.
Metadata	Set of key-value pairs that you can attach 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 your checkout flow during this payment attempt, and therefore is 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.
Payment Method Options	Payment-method-specific configuration for this PaymentIntent.
Payment Method Types	The list of payment method types that this PaymentIntent is allowed to use.
Radar Options	Options to configure Radar.
Receipt Email	Email address that the receipt for the resulting payment will be sent to.
Return Url	The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site.
Setup Future Usage	Indicates that you intend to make future payments with this PaymentIntent’s payment method.
Shipping	Shipping information for this PaymentIntent.
Statement Descriptor	For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor Suffix	Provides information about a card payment that customers see on their statements.
Connection
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.
Transfer Group	A string that identifies the resulting payment as part of a group.
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.

---

Create Price

Create a new price | key: createPrice

Input	Notes	Example
Active	When true, the object is currently active in your platform.	false
Currency	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 you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Metadata	Set of key-value pairs that you can attach 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.
Product Id	The unique identifier of the product.	prod_1JaOXaDtJQgcyrdSRnsI9KW5
RecurringInterval	The billing frequency for recurring charges.
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Unit Price	The price per unit in cents.	2000

---

Create Product

Create a new product | key: createProduct

Input	Notes	Example
Active	When true, the object is currently active in your platform.	false
Description	A description of the invoice.	Monthly subscription invoice
Values	The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Metadata	Set of key-value pairs that you can attach 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 name of the product.	Premium Subscription
Product Type	The type of the product.
Product URL	A URL of a publicly-accessible webpage for this product. May only be set if type=good.
Shippable	When true, this product can be shipped (i.e., physical goods).	false
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

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 collection method for the invoice.
Coupon	(DEPRECATED) The unique identifier of the coupon to apply to the invoice.	SUMMER2025
Customer Id	The unique identifier of 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 you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Metadata	Set of key-value pairs that you can attach 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 of the payment method.	pm_1JaOXaDtJQgcyrdSRnsI9KW5
Price Id	The unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Quantity	The quantity of items in the subscription.	1
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Create Webhook

Create a new webhook | key: createWebhook

Input	Notes	Example
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Webhook Events	For each item, provide a string value that represents which event you want to track. For more information, see https://docs.stripe.com/api/events/types.	payment_intent.created
Webhook URL	The URL where webhook events will be sent.	https://your-webhook-endpoint.com/webhook

{
  "data": {
    "id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
    "object": "webhook_endpoint",
    "api_version": null,
    "application": null,
    "created": 1680122196,
    "description": null,
    "enabled_events": [
      "charge.succeeded",
      "charge.failed"
    ],
    "livemode": false,
    "metadata": {},
    "status": "enabled",
    "url": "https://example.com/my/webhook/endpoint"
  }
}

---

Delete All Instanced Webhooks

Delete all the webhooks associated to each flow of the instance. | key: deleteWebhooks

Input	Notes	Example
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": [
    {
      "id": "we_1R4SQ1PReauCNCFGKkIBX5LR",
      "object": "webhook_endpoint",
      "deleted": true
    },
    {
      "id": "we_1R4SPzPReauCNCFGhGcd9yT2",
      "object": "webhook_endpoint",
      "deleted": true
    },
    {
      "id": "we_1R4NtSPReauCNCFGJPT9mffI",
      "object": "webhook_endpoint",
      "deleted": true
    }
  ]
}

---

Delete Customer

Permanently deletes a customer, Also immediately cancels any active subscriptions on the customer. | key: deleteCustomer

Input	Notes	Example
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "id": "cus_123",
    "object": "customer",
    "deleted": true
  }
}

---

Delete Invoice

Delete an existing invoice | key: deleteInvoice

Input	Notes	Example
Invoice ID	The unique identifier of the invoice.	in_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Delete Product

Delete an existing product by Id | key: deleteProduct

Input	Notes	Example
Product Id	The unique identifier of the product.	prod_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Delete Subscription

Delete a subscription by Id | key: deleteSubscription

Input	Notes	Example
Connection
Subscription Id	The unique identifier of the subscription.	sub_1234567890abcdef
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Delete Webhook

Deletes a webhook by ID | key: deleteWebhook

Input	Notes	Example
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Webhook ID	The ID of the webhook to delete	we_1JaOXaDtJQgcyrdSRnsI9KW5

{
  "data": {
    "id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
    "object": "webhook_endpoint",
    "deleted": true
  }
}

---

Detach Card

Detach a card from a customer | key: detachCard

Input	Notes	Example
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Payment Method Id	The unique identifier of the payment method.	pm_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Expire Checkout Session

Expire a Stripe Checkout Session | key: expireCheckoutSession

Input	Notes	Example
Session ID	The ID of the checkout session to expire.	cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "id": "cs_test_123",
    "object": "checkout.session",
    "amount_subtotal": 2000,
    "amount_total": 2000,
    "currency": "usd",
    "customer": null,
    "mode": "payment",
    "payment_status": "unpaid",
    "status": "open",
    "url": "https://checkout.stripe.com/c/pay/cs_test_123"
  }
}

---

Get Balance Transaction

Retrieves the balance transaction with the given ID. | key: getBalanceTransaction

Input	Notes	Example
Balance Transaction ID	The unique identifier of the balance transaction.	txn_1Jb9jvDtJQgcyrdS1Z9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Card

Get the information and metadata of a card by Id | key: getCard

Input	Notes	Example
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Payment Method Id	The unique identifier of the payment method.	pm_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Charge

Retrieves the details of a charge that has previously been created. | key: getCharge

Input	Notes	Example
Charge ID	The unique identifier of the charge.	ch_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Checkout Session

Retrieve a Stripe Checkout Session | key: getCheckoutSession

Input	Notes	Example
Session ID	The ID of the checkout session to expire.	cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "id": "cs_test_123",
    "object": "checkout.session",
    "amount_subtotal": 2000,
    "amount_total": 2000,
    "currency": "usd",
    "customer": null,
    "mode": "payment",
    "payment_status": "unpaid",
    "status": "open",
    "url": "https://checkout.stripe.com/c/pay/cs_test_123"
  }
}

---

Get Customer

Retrieve the information and metadata of a customer by Id | key: getCustomer

Input	Notes	Example
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "id": "94304",
    "object": "customer",
    "deleted": true
  }
}

---

Get Dispute

Retrieves the dispute with the given ID. | key: getDispute

Input	Notes	Example
Dispute ID	The unique identifier of the dispute.	dp_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Invoice

Get the information and metadata of an invoice by Id | key: getInvoice

Input	Notes	Example
Invoice ID	The unique identifier of the invoice.	in_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Payment Intent

Retrieves the details of a PaymentIntent 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.
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Price

Get the information and metadata of a price by Id | key: getPrice

Input	Notes	Example
Price Id	The unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Product

Get the information and metadata of a product by Id | key: getProduct

Input	Notes	Example
Product Id	The unique identifier of the product.	prod_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Subscriptions

Get the information and metadata of a subscription by Id | key: getSubscription

Input	Notes	Example
Connection
Subscription Id	The unique identifier of the subscription.	sub_1234567890abcdef
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Get Webhook

Retrieves a webhook by ID | key: getWebhook

Input	Notes	Example
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Webhook ID	The unique identifier of the webhook.	we_1JaOXaDtJQgcyrdSRnsI9KW5

{
  "data": {
    "id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
    "object": "webhook_endpoint",
    "api_version": null,
    "application": null,
    "created": 1680122196,
    "description": null,
    "enabled_events": [
      "charge.succeeded",
      "charge.failed"
    ],
    "livemode": false,
    "metadata": {},
    "status": "enabled",
    "url": "https://example.com/my/webhook/endpoint"
  }
}

---

List Accounts

Returns 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Balance Transactions

Returns a list of transactions that have contributed to the Stripe account balance (e.g., 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
Ending Before	A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Source	Only returns the original transaction.
Starting After	A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Cards

Returns a list of cards connected to your platform | key: listCards

Input	Notes	Example
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Ending Before	A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Charges

Returns 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Checkout Session Line Items

List all Stripe Checkout Session Line Items | key: listCheckoutSessionLineItems

Input	Notes	Example
Ending Before	A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Session ID	The ID of the checkout session to expire.	cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Starting After	A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "object": "list",
    "data": [
      {
        "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
        "object": "checkout.session",
        "after_expiration": null,
        "allow_promotion_codes": null,
        "amount_subtotal": 2198,
        "amount_total": 2198,
        "automatic_tax": {
          "enabled": false,
          "liability": null,
          "status": null
        },
        "billing_address_collection": null,
        "cancel_url": null,
        "client_reference_id": null,
        "consent": null,
        "consent_collection": null,
        "created": 1679600215,
        "currency": "usd",
        "custom_fields": [],
        "custom_text": {
          "shipping_address": null,
          "submit": null
        },
        "customer": null,
        "customer_creation": "if_required",
        "customer_details": null,
        "customer_email": null,
        "expires_at": 1679686615,
        "invoice": null,
        "invoice_creation": {
          "enabled": false,
          "invoice_data": {
            "account_tax_ids": null,
            "custom_fields": null,
            "description": null,
            "footer": null,
            "issuer": null,
            "metadata": {},
            "rendering_options": null
          }
        },
        "livemode": false,
        "locale": null,
        "metadata": {},
        "mode": "payment",
        "payment_intent": null,
        "payment_link": null,
        "payment_method_collection": "always",
        "payment_method_options": {},
        "payment_method_types": [
          "card"
        ],
        "payment_status": "unpaid",
        "phone_number_collection": {
          "enabled": false
        },
        "recovered_from": null,
        "setup_intent": null,
        "shipping_address_collection": null,
        "shipping_cost": null,
        "shipping_details": null,
        "shipping_options": [],
        "status": "open",
        "submit_type": null,
        "subscription": null,
        "success_url": "https://example.com/success",
        "total_details": {
          "amount_discount": 0,
          "amount_shipping": 0,
          "amount_tax": 0
        },
        "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u#fidkdWxOYHwnPyd1blpxYHZxWjA0SDdPUW5JbmFMck1wMmx9N2BLZjFEfGRUNWhqTmJ%2FM2F8bUA2SDRySkFdUV81T1BSV0YxcWJcTUJcYW5rSzN3dzBLPUE0TzRKTTxzNFBjPWZEX1NKSkxpNTVjRjN8VHE0YicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
      }
    ],
    "has_more": false,
    "url": "/v1/checkout/sessions/cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr/line_items"
  }
}

---

List Checkout Sessions

List all Stripe Checkout Sessions | key: listCheckoutSessions

Input	Notes	Example
Ending Before	A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.	cus_1234567890abcdef
Fetch All	When true, will retrieve all results.	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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "object": "list",
    "data": [
      {
        "id": "cs_test_123",
        "object": "checkout.session",
        "amount_subtotal": 2000,
        "amount_total": 2000,
        "currency": "usd",
        "customer": null,
        "mode": "payment",
        "payment_status": "unpaid",
        "status": "open",
        "url": "https://checkout.stripe.com/c/pay/cs_test_123"
      }
    ]
  }
}

---

List Customers

Returns 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Disputes

Returns a list of your 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.
Ending Before	A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.	cus_1234567890abcdef
Limit	The maximum number of results to return.	100
Payment Intent	Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
Starting After	A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Invoices

Returns a list of invoices connected to your platform | 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Payment Intents

Returns a list of PaymentIntents. | key: listPaymentIntents

Input	Notes	Example
Created	A filter on the list based on the object created field.
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 your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Prices

Returns 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Products

Returns a list of products connected to your platform | 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Subscriptions

Returns 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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

List Webhooks

List all webhooks | key: listWebhooks

Input	Notes	Example
Ending Before	A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.	cus_1234567890abcdef
Fetch All	When true, will retrieve all results.	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 your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	cus_1234567890abcdef
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "data": [
      {
        "id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
        "object": "webhook_endpoint",
        "api_version": null,
        "application": null,
        "created": 1680122196,
        "description": null,
        "enabled_events": [
          "charge.succeeded",
          "charge.failed"
        ],
        "livemode": false,
        "metadata": {},
        "status": "enabled",
        "url": "https://example.com/my/webhook/endpoint"
      }
    ],
    "has_more": false,
    "url": "/v1/webhook_endpoints",
    "object": "list"
  }
}

---

Raw Request

Send raw HTTP request to Stripe | key: rawRequest

Input	Notes	Example
Connection
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

---

Search Charges

Search for charges you've 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. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
Query	The search query string.
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Search Payment Intent

Search for PaymentIntents you’ve 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. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
Query	The search query string.
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Update Card

Create a new 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 country for the billing address (two-letter ISO country code).	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 card number.	4242424242424242
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
CVC	The CVC security code on the back of the card.	123
Expiration Month	The expiration month of the card.	12
Expiration Year	The expiration year of the card.	2026
Metadata	Set of key-value pairs that you can attach 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 for the billing address.	CA
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Update Charge

Updates the specified charge by setting the values of the parameters passed. | key: updateCharge

Input	Notes	Example
Charge ID	The unique identifier of 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.
Metadata	Set of key-value pairs that you can attach 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	This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
Shipping	Shipping information for the charge. Helps prevent fraud on charges for physical goods.
Connection
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.

---

Update Checkout Session

Update a Stripe Checkout Session | key: updateCheckoutSession

Input	Notes	Example
Metadata	Set of key-value pairs that you can attach 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 ID of the checkout session to expire.	cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

{
  "data": {
    "id": "cs_test_123",
    "object": "checkout.session",
    "amount_subtotal": 2000,
    "amount_total": 2000,
    "currency": "usd",
    "customer": null,
    "mode": "payment",
    "payment_status": "unpaid",
    "status": "open",
    "url": "https://checkout.stripe.com/c/pay/cs_test_123"
  }
}

---

Update Customer

Create a new customer object | key: updateCustomer

Input	Notes	Example
Address Line 1	The street address of the customer.	123 Main Street
Address Line 2	Additional address information for the customer (optional).	Suite 3
Balance	The balance of the customer in cents (e.g., 5000 = $50.00).	5000
City	The city of the customer.	San Francisco
Country	The country of the customer (two-letter ISO country code).	US
Description	A description of the customer.	Premium customer account
Email	The email address of the customer.	customer@example.com
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Metadata	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Name	The name of the customer.	John Doe
Phone	The phone number of the customer.	18005554545
Postal Code	The postal code of the customer.	94105
State	The state of the customer.	CA
Values	The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Update Dispute

When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. | key: updateDispute

Input	Notes	Example
Dispute ID	The unique identifier of the dispute.	dp_1JaOXaDtJQgcyrdSRnsI9KW5
Evidence	Evidence to upload to respond to a dispute.
Metadata	Set of key-value pairs that you can attach 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
Submit	Whether to immediately submit evidence to the bank.
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

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 collection method for the invoice.
Coupon	The unique identifier of the coupon to apply to the invoice.	SUMMER2025
Customer Id	The unique identifier of the customer.	cus_1234567890abcdef
Description	A description of the invoice.	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 you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Invoice ID	The unique identifier of the invoice.	in_1JaOXaDtJQgcyrdSRnsI9KW5
Metadata	Set of key-value pairs that you can attach 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 of the payment method.	pm_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Update Payment Intent

Updates properties on a PaymentIntent object 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	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 you can attach 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 ID of the Payment Intent.
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.
Payment Method Options	Payment-method-specific configuration for this PaymentIntent.
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.
Setup Future Usage	Indicates that you intend to make future payments with this PaymentIntent’s payment method.
Shipping	Shipping information for this PaymentIntent.
Statement Descriptor	For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor Suffix	Provides information about a card payment that customers see on their statements.
Connection
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.
Transfer Group	A string that identifies the resulting payment as part of a group.

---

Update Price

Update an existing price by Id | key: updatePrice

Input	Notes	Example
Active	When true, the object is currently active in your platform.	false
Values	The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Metadata	Set of key-value pairs that you can attach 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.
Price Id	The unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Update Product

Update an existing product | key: updateProduct

Input	Notes	Example
Active	When true, the object is currently active in your platform.	false
Description	A description of the invoice.	Monthly subscription invoice
Values	The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Metadata	Set of key-value pairs that you can attach 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 of 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	A URL of a publicly-accessible webpage for this product. May only be set if type=good.
Shippable	When true, this product can be shipped (i.e., physical goods).	false
Connection
Timeout	The maximum time a client will await a response (in milliseconds).	60000
Product Name	The name of the product.	Premium Subscription

---

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 collection method 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 you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value.
Metadata	Set of key-value pairs that you can attach 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 quantity of items in the subscription.	1
Connection
Subscription Id	The unique identifier of the subscription.	sub_1234567890abcdef
Price Id	The unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Timeout	The maximum time a client will await a response (in milliseconds).	60000

---

Update Webhook

Update a webhook by ID | key: updateWebhook

Input	Notes	Example
Connection
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

{
  "data": {
    "id": "we_1Mr5jULkdIwHu7ix1ibLTM0x",
    "object": "webhook_endpoint",
    "api_version": null,
    "application": null,
    "created": 1680122196,
    "description": null,
    "enabled_events": [
      "charge.succeeded",
      "charge.failed"
    ],
    "livemode": false,
    "metadata": {},
    "status": "enabled",
    "url": "https://example.com/my/webhook/endpoint"
  }
}

---

Changelog

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