Stripe Component

Manage objects connected to your Stripe platform

Component key: stripe

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

Stripe Connection

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
API Key string / Required apiKey	Provide a string value for the API Key.

Triggers

Instance Webhooks

Receive and validate webhook requests from Stripe for webhooks you configure. Config this trigger to create or delete webhook event listeners. | key: instanceDeployWebhook

Input	Notes	Example
Connection connection / Required connection
Webhook Events string / Required Value List webhookEvents	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

You can configure a Stripe event notification webhook to send information to a flow's webhook URL under certain conditions (a "Product" is created, a "Order" is updated, etc.).

Additionally, you can reference a trigger's results.webhookUrls to create a webhook in a deploy-triggered flow. That'll configure webhooks to point to an instance when that instance is deployed to a customer.

Webhook (Deprecated)

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

Actions

Attach Card

Attach a card to a customer | key: attachCard

Input	Notes	Example
Customer Id string customerId	Provide a string value for unique identifier of the customer.
Payment Method Id string paymentId	Provide a value for the unique identifier of the payment.	pm_003494
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

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 string cancellationReason	The reason for cancelling the Payment Intent.
Payment Intent ID string / Required paymentIntentId	The ID of the Payment Intent.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

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 string amountToCapture	The amount to capture from the PaymentIntent, which must be less than or equal to the original amount.
Application Fee Amount string applicationFeeAmount	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 string Key Value List 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 string / Required paymentIntentId	The ID of the Payment Intent.
Statement Descriptor string statementDescriptor	For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor Suffix string statementDescriptorSuffix	Provides information about a card payment that customers see on their statements.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Transfer Data code transferData	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 string / Required disputeId	The ID of the dispute.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Confirm Payment Intent

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

Input	Notes	Example
Capture Method string captureMethod	Controls when the funds will be captured from the customer’s account.
Error On Requires Action string errorOnRequiresAction	Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
Mandate string mandate	ID of the mandate to be used for this payment.
Mandate Data code mandateData	This hash contains details about the Mandate to create.
Off Session string offSession	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 string / Required paymentIntentId	The ID of the Payment Intent.
Payment Method string paymentMethod	ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
Payment Method Data code paymentMethodData	If provided, this hash will be used to create a PaymentMethod.
Payment Method Options code paymentMethodOptions	Payment-method-specific configuration for this PaymentIntent.
Radar Options code radarOptions	Options to configure Radar.
Receipt Email string receiptEmail	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 string returnUrl	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 string setupFutureUsage	Indicates that you intend to make future payments with this PaymentIntent’s payment method.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Use Stripe SDK string useStripeSdk	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 string billingAddress1	Provide a value for the street address of the billing information	4 Private Drive
Billing Address 2 string billingAddress2	Provide a value for the optional second address field of the billing information	Suite 3
Billing City string billingCity	Provide a value for the city of the billing information	Los Angeles
Billing Country string billingCountry	Provide a value for the country of the billing information	United States
Billing State string billingEmail	Provide a value for the email of the billing information	someone@example.com
Full Name string billingName	Provide a value for the name of the billing information	John Doe
Card Number string / Required cardNumber	Provide a value for the number of the card.	48594932905594544
Customer Id string customerId	Provide a string value for unique identifier of the customer.
CVC string / Required cvc	Provide a value for the CVC on the back of the card.	937
Expiration Month string / Required expMonth	Provide a value for the expiration month of the card.	09
Expiration Year string / Required expYear	Provide a value for the expiration year of the card.	2021
Metadata string Key Value List 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 State string phone	Provide a value for the phone of the billing information	18005554545
Billing Postal Code string postalCode	Provide a value for the postal code of the billing information	90432
Billing State string state	Provide a value for the state of the billing information	California
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Create Checkout Session

Create a new Stripe Checkout Session | key: createCheckoutSession

Input	Default	Notes	Example
Body Params code bodyParams		More parameters to pass to the request.
Cancel URL string cancelUrl		The URL the customer will be directed to if they decide to cancel payment	https://example.com/cancel
Client Reference ID string clientReferenceId		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.	123456
Email string customerEmail		The email of the customer to create the checkout session for.	someone@example.com
Customer Id string customerId		The ID of the customer to create the checkout session for.
Line Items code / Required lineItems		JSON array of line items to be purchased.
Mode string / Required mode	payment	The mode of the Checkout Session
Connection connection / Required stripeConnection
Success URL string successUrl		The URL the customer will be directed to after the payment is successful	https://example.com/success
Timeout string timeout		The maximum time a client will await a response.	2000

{
  "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 string customerAddress1	Provide a string value for street address of the customer.	4, Privet Drive
Address Line 2 string customerAddress2	Provide a string value for street address of the customer.	Suite 3
Balance string customerBalance	Provide a number value for balance of the customer.	5000
City string customerCity	Provide a string value for city of the customer.	Buffalo
Country string customerCountry	Provide a string value for country of the customer.	United States
Description string customerDescription	Provide a string value for description of the customer.	Descriptive text
Email string customerEmail	Provide a string value for email of the customer.	someone@example.com
Metadata string Key Value List customerMetadata	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 string customerName	provide a string value for the name of the customer.	John Doe
Default Payment Method Id string customerPaymentId	Provide the unique identifier of the customer's default payment method.	pm_1JaiTbDtJQgcyrdS08EmyHHe
Phone string customerPhone	The maximum time a client will await a response.	18005554545
Postal Code string customerPostal	Provide a string value for postal code of the customer.	90410
State string customerState	Provide a string value for state of the customer.	New York
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Create Invoice

Create a new invoice | key: createInvoice

Input	Default	Notes	Example
Auto Advance boolean autoAdvance	false	Controls whether Stripe will perform automatic collection of the invoice.
Collection Method string collectionMethod		Provide a value for the collection method of the invoice.
Customer Id string customerId		Provide a string value for unique identifier of the customer.
Description string description		Provide a value for the description of the invoice.	Descriptive text
Due Date string dueDate		Provide a unix timestamp value for the due date of the invoice.	1631824986
Values string Key Value List fieldValues		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 string Key Value List 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 string paymentId		Provide a value for the unique identifier of the payment.	pm_003494
Connection connection / Required stripeConnection
Subscription Id string subscriptionId		Provide a string value for unique identifier of the subscription.
Timeout string timeout		The maximum time a client will await a response.	2000

Create Payment Intent

Creates a PaymentIntent object. | key: createPaymentIntent

Input	Default	Notes	Example
Amount string / Required amount		Amount intended to be collected by this PaymentIntent.
Application Fee Amount string applicationFeeAmount		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 code automaticPaymentMethods		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 string captureMethod		Controls when the funds will be captured from the customer’s account.
Confirm boolean confirm	false	Set to true to attempt to confirm this PaymentIntent immediately.
Confirmation Method string confirmationMethod
Currency string / Required currency		Three-letter ISO currency code, in lowercase. Must be a supported currency.	usd
Customer string customerId		ID of the Customer this PaymentIntent belongs to, if one exists.
Description string description		An arbitrary string attached to the object. Often useful for displaying to users.	Descriptive text
Error On Requires Action string errorOnRequiresAction		Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
Mandate string mandate		ID of the mandate to be used for this payment.
Mandate Data code mandateData		This hash contains details about the Mandate to create.
Metadata string Key Value List 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 string offSession		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 string onBehalfOf		The Stripe account ID for which these funds are intended
Payment Method string paymentMethod		ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
Payment Method Data code paymentMethodData		If provided, this hash will be used to create a PaymentMethod.
Payment Method Options code paymentMethodOptions		Payment-method-specific configuration for this PaymentIntent.
Payment Method Types string Value List paymentMethodTypes		The list of payment method types that this PaymentIntent is allowed to use.
Radar Options code radarOptions		Options to configure Radar.
Receipt Email string receiptEmail		Email address that the receipt for the resulting payment will be sent to.
Return Url string returnUrl		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 string setupFutureUsage		Indicates that you intend to make future payments with this PaymentIntent’s payment method.
Shipping code shipping		Shipping information for this PaymentIntent.
Statement Descriptor string statementDescriptor		For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor Suffix string statementDescriptorSuffix		Provides information about a card payment that customers see on their statements.
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000
Transfer Data code transferData		The parameters used to automatically create a Transfer when the payment succeeds
Transfer Group string transferGroup		A string that identifies the resulting payment as part of a group.
Use Stripe SDK string useStripeSdk		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	Default	Notes	Example
Active boolean / Required active	false	This flag will specify if the object is currently active in your platform.
Currency string currency		Three-letter ISO currency code, in lowercase. Must be a supported currency.	usd
Values string Key Value List fieldValues		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 string Key Value List 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 string nickname		A brief description of the price, hidden from customers.
Product Id string / Required productId		Provide a string value for the unique identifier of the product	prod_KEomQOHnUBtMNr
RecurringInterval string recurringInterval		Provide a value that specifies billing frequency.
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000
Unit Price string unitPrice		Provide a value for the price per unit.

Create Product

Create a new product | key: createProduct

Input	Default	Notes	Example
Active boolean / Required active	false	This flag will specify if the object is currently active in your platform.
Description string description		Provide a value for the description of the invoice.	Descriptive text
Values string Key Value List fieldValues		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 string Key Value List 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 string productCaption		(DEPRECATED) A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.	This is an example caption.
Product Images string Value List productImages		For each list item, provide a URL for the image of the product	www.exampleImageURL.com/product1
Product Name string / Required productName		Provide a string value for the name of the product	myProduct
Product Type string productType		Provide a string value for the type of the product	Service
Product URL string productUrl		A URL of a publicly-accessible webpage for this product. May only be set if type=good.
Shippable boolean shippable	false	Whether this product is able to be shipped (i.e., physical goods).
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000

Create Subscription

Create a new subscription | key: createSubscription

Input	Notes	Example
Cancel At string cancelAt	A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.	0208302
Collection Method string collectionMethod	Provide a value for the collection method of the invoice.
Coupon string coupon	(DEPRECATED) Provide a value for the unique identifier of the coupon for the invoice.	Z4OV52SU
Customer Id string customerId	Provide a string value for unique identifier of the customer.
Days Until Due string daysUntilDue	Provide a value for the days until the payment is due	23
Values string Key Value List fieldValues	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 string Key Value List 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 string paymentId	Provide a value for the unique identifier of the payment.	pm_003494
Price Id string / Required priceId	Provide a value for the unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Quantity string quantity	Provide a string value for quantity of the items in the subscription.	30
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Create Webhook

Create a new webhook | key: createWebhook

Input	Notes	Example
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Webhook Events string / Required Value List webhookEvents	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 string / Required webhookUrl	Provide a valid URL representing where the request will be sent.	https://hooks.example.com/EXAMPLE

{
  "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 connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

{
  "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 string customerId	Provide a string value for unique identifier of the customer.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

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

Delete Invoice

Delete an existing invoice | key: deleteInvoice

Input	Notes	Example
invoiceId string / Required invoiceId	Provide a value for the unique identifier of the invoice.	849305
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Delete Product

Delete an existing product by Id | key: deleteProduct

Input	Notes	Example
Product Id string / Required productId	Provide a string value for the unique identifier of the product	prod_KEomQOHnUBtMNr
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Delete Subscription

Delete a subscription by Id | key: deleteSubscription

Input	Notes	Example
Connection connection / Required stripeConnection
Subscription Id string subscriptionId	Provide a string value for unique identifier of the subscription.
Timeout string timeout	The maximum time a client will await a response.	2000

Delete Webhook

Deletes a webhook by ID | key: deleteWebhook

Input	Notes	Example
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Webhook ID string / Required webhookId	The ID of the webhook to delete	we_1Mr5jULkdIwHu7ix1ibLTM0x

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

Detach Card

Detach a card from a customer | key: detachCard

Input	Notes	Example
Payment Method Id string paymentId	Provide a value for the unique identifier of the payment.	pm_003494
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Expire Checkout Session

Expire a Stripe Checkout Session | key: expireCheckoutSession

Input	Notes	Example
Session ID string / Required sessionId	The ID of the checkout session to expire	cs_test_123
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

{
  "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 string / Required balanceTransactionId	Provide a value for the unique identifier of the balance transaction.	txn_1Jb9jvDtJQgcyrdS1Z9KW5
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Card

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

Input	Notes	Example
Payment Method Id string paymentId	Provide a value for the unique identifier of the payment.	pm_003494
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Charge

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

Input	Notes	Example
Charge ID string / Required chargeId
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Checkout Session

Retrieve a Stripe Checkout Session | key: getCheckoutSession

Input	Notes	Example
Session ID string / Required sessionId	The ID of the checkout session to expire	cs_test_123
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

{
  "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 string customerId	Provide a string value for unique identifier of the customer.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

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

Get Dispute

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

Input	Notes	Example
Dispute ID string / Required disputeId	The ID of the dispute.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Invoice

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

Input	Notes	Example
invoiceId string / Required invoiceId	Provide a value for the unique identifier of the invoice.	849305
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Payment Intent

Retrieves the details of a PaymentIntent that has previously been created. | key: getPaymentIntent

Input	Notes	Example
Client Secret string clientSecret	The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source.
Payment ID string / Required paymentIntent	The ID of the PaymentIntent to retrieve.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Price

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

Input	Notes	Example
Price Id string / Required priceId	Provide a value for the unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Product

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

Input	Notes	Example
Product Id string / Required productId	Provide a string value for the unique identifier of the product	prod_KEomQOHnUBtMNr
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Get Subscriptions

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

Input	Notes	Example
Connection connection / Required stripeConnection
Subscription Id string subscriptionId	Provide a string value for unique identifier of the subscription.
Timeout string timeout	The maximum time a client will await a response.	2000

Get Webhook

Retrieves a webhook by ID | key: getWebhook

Input	Notes	Example
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Webhook ID string / Required webhookId	The ID of the webhook.	we_1Mr5jULkdIwHu7ix1ibLTM0x

{
  "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 string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

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 code created	A filter on the list based on the object created field.
Currency string currency	Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.	usd
Ending Before string endingBefore	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.	obj903234
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Source string source	Only returns the original transaction.
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Cards

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

Input	Notes	Example
Customer Id string customerId	Provide a string value for unique identifier of the customer.
Ending Before string endingBefore	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.	obj903234
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Charges

Returns a list of all charges | key: listCharges

Input	Notes	Example
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Checkout Session Line Items

List all Stripe Checkout Session Line Items | key: listCheckoutSessionLineItems

Input	Notes	Example
Ending Before string endingBefore	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.	obj903234
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Session ID string / Required sessionId	The ID of the checkout session to expire	cs_test_123
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

{
  "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	Default	Notes	Example
Ending Before string endingBefore		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.	obj903234
Fetch All boolean fetchAll	false	When true, will retrieve all results.
Limit string limit		Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter		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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000

{
  "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 string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Disputes

Returns a list of your disputes. | key: listDisputes

Input	Notes	Example
Charge string chargeId	Only return disputes associated to the charge specified by this charge ID.
Created code created	A filter on the list based on the object created field.
Ending Before string endingBefore	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.	obj903234
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Payment Intent string paymentIntent	Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Invoices

Returns a list of invoices connected to your platform | key: listInvoices

Input	Notes	Example
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Payment Intents

Returns a list of PaymentIntents. | key: listPaymentIntents

Input	Notes	Example
Created code created	A filter on the list based on the object created field.
Customer string customerId	Only return PaymentIntents for the customer specified by this customer ID.
Ending Before string endingBefore	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.	obj903234
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Prices

Returns a list of all available prices | key: listPrices

Input	Notes	Example
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Products

Returns a list of products connected to your platform | key: listProducts

Input	Notes	Example
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Subscriptions

Returns a list of subscriptions | key: listSubscriptions

Input	Notes	Example
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter	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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

List Webhooks

List all webhooks | key: listWebhooks

Input	Default	Notes	Example
Ending Before string endingBefore		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.	obj903234
Fetch All boolean fetchAll	false	When true, will retrieve all results.
Limit string limit		Provide an integer value for the maximum amount of results that will be returned.	100
Starting After string startingAfter		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.	obj903234
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000

{
  "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	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	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.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Search Charges

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

Input	Notes	Example
Limit string 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 string 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 string / Required query	The search query string.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Search Payment Intent

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. | key: searchPaymentIntent

Input	Notes	Example
Limit string limit	Provide an integer value for the maximum amount of results that will be returned.	100
Page string 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 string / Required query	The search query string.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Update Card

Create a new card by Id | key: updateCard

Input	Notes	Example
Billing Street Address string billingAddress1	Provide a value for the street address of the billing information	4 Private Drive
Billing Address 2 string billingAddress2	Provide a value for the optional second address field of the billing information	Suite 3
Billing City string billingCity	Provide a value for the city of the billing information	Los Angeles
Billing Country string billingCountry	Provide a value for the country of the billing information	United States
Billing State string billingEmail	Provide a value for the email of the billing information	someone@example.com
Full Name string billingName	Provide a value for the name of the billing information	John Doe
Card Number string / Required cardNumber	Provide a value for the number of the card.	48594932905594544
Customer Id string customerId	Provide a string value for unique identifier of the customer.
CVC string / Required cvc	Provide a value for the CVC on the back of the card.	937
Expiration Month string / Required expMonth	Provide a value for the expiration month of the card.	09
Expiration Year string / Required expYear	Provide a value for the expiration year of the card.	2021
Metadata string Key Value List 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 State string phone	Provide a value for the phone of the billing information	18005554545
Billing Postal Code string postalCode	Provide a value for the postal code of the billing information	90432
Billing State string state	Provide a value for the state of the billing information	California
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

Update Charge

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

Input	Notes	Example
Charge ID string / Required chargeId
Customer string customerId	The ID of an existing customer that will be associated with this request.
Description string description	An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge	Descriptive text
Fraud Details code fraudDetails	A set of key-value pairs you can attach to a charge giving information about its riskiness.
Metadata string Key Value List 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 string receiptEmail	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 code shipping	Shipping information for the charge. Helps prevent fraud on charges for physical goods.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Transfer Group string transferGroup	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 string Key Value List 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 string / Required sessionId	The ID of the checkout session to expire	cs_test_123
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

{
  "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 string customerAddress1	Provide a string value for street address of the customer.	4, Privet Drive
Address Line 2 string customerAddress2	Provide a string value for street address of the customer.	Suite 3
Balance string customerBalance	Provide a number value for balance of the customer.	5000
City string customerCity	Provide a string value for city of the customer.	Buffalo
Country string customerCountry	Provide a string value for country of the customer.	United States
Description string customerDescription	Provide a string value for description of the customer.	Descriptive text
Email string customerEmail	Provide a string value for email of the customer.	someone@example.com
Customer Id string customerId	Provide a string value for unique identifier of the customer.
Metadata string Key Value List customerMetadata	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 string customerName	provide a string value for the name of the customer.	John Doe
Phone string customerPhone	The maximum time a client will await a response.	18005554545
Postal Code string customerPostal	Provide a string value for postal code of the customer.	90410
State string customerState	Provide a string value for state of the customer.	New York
Values string Key Value List fieldValues	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 connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000

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 string / Required disputeId	The ID of the dispute.
Evidence code evidence	Evidence to upload to respond to a dispute.
Metadata string Key Value List 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 connection / Required stripeConnection
Submit string submit	Whether to immediately submit evidence to the bank.
Timeout string timeout	The maximum time a client will await a response.	2000

Update Invoice

Update an existing invoice | key: updateInvoice

Input	Default	Notes	Example
Application Fee Amount string applicationFeeAmount		Provide a value for the application fee of the invoice. You should only provide this value if you selected 'Charge Automatically' in the collection method input.	500
Auto Advance boolean autoAdvance	false	Controls whether Stripe will perform automatic collection of the invoice.
Collection Method string collectionMethod		Provide a value for the collection method of the invoice.
Coupon string coupon		Provide a value for the unique identifier of the coupon for the invoice.	Z4OV52SU
Description string description		Provide a value for the description of the invoice.	Descriptive text
Discount string discount		Provide a value for the discount of the invoice.	78983
Due Date string dueDate		Provide a unix timestamp value for the due date of the invoice.	1631824986
Values string Key Value List fieldValues		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.
invoiceId string / Required invoiceId		Provide a value for the unique identifier of the invoice.	849305
Metadata string Key Value List 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 string paymentId		Provide a value for the unique identifier of the payment.	pm_003494
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000

Update Payment Intent

Updates properties on a PaymentIntent object without confirming. | key: updatePaymentIntent

Input	Notes	Example
Amount string / Required amount	Amount intended to be collected by this PaymentIntent.
Application Fee Amount string applicationFeeAmount	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 string captureMethod	Controls when the funds will be captured from the customer’s account.
Currency string currency	Three-letter ISO currency code, in lowercase. Must be a supported currency.	usd
Customer string customerId	ID of the Customer this PaymentIntent belongs to, if one exists.
Description string description	An arbitrary string attached to the object. Often useful for displaying to users.	Descriptive text
Metadata string Key Value List 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 string / Required paymentIntentId	The ID of the Payment Intent.
Payment Method string paymentMethod	ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
Payment Method Data code paymentMethodData	If provided, this hash will be used to create a PaymentMethod.
Payment Method Options code paymentMethodOptions	Payment-method-specific configuration for this PaymentIntent.
Payment Method Types string Value List paymentMethodTypes	The list of payment method types that this PaymentIntent is allowed to use.
Receipt Email string receiptEmail	Email address that the receipt for the resulting payment will be sent to.
Setup Future Usage string setupFutureUsage	Indicates that you intend to make future payments with this PaymentIntent’s payment method.
Shipping code shipping	Shipping information for this PaymentIntent.
Statement Descriptor string statementDescriptor	For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor Suffix string statementDescriptorSuffix	Provides information about a card payment that customers see on their statements.
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Transfer Data code transferData	The parameters used to automatically create a Transfer when the payment succeeds
Transfer Group string transferGroup	A string that identifies the resulting payment as part of a group.

Update Price

Update an existing price by Id | key: updatePrice

Input	Default	Notes	Example
Active boolean / Required active	false	This flag will specify if the object is currently active in your platform.
Values string Key Value List fieldValues		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 string Key Value List 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 string nickname		A brief description of the price, hidden from customers.
Price Id string / Required priceId		Provide a value for the unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000

Update Product

Update an existing product | key: updateProduct

Input	Default	Notes	Example
Active boolean / Required active	false	This flag will specify if the object is currently active in your platform.
Description string description		Provide a value for the description of the invoice.	Descriptive text
Values string Key Value List fieldValues		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 string Key Value List 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 string productCaption		(DEPRECATED) A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.	This is an example caption.
Product Id string / Required productId		Provide a string value for the unique identifier of the product	prod_KEomQOHnUBtMNr
Product Images string Value List productImages		For each list item, provide a URL for the image of the product	www.exampleImageURL.com/product1
Product URL string productUrl		A URL of a publicly-accessible webpage for this product. May only be set if type=good.
Shippable boolean shippable	false	Whether this product is able to be shipped (i.e., physical goods).
Connection connection / Required stripeConnection
Timeout string timeout		The maximum time a client will await a response.	2000
Product Name string updateProductName		Provide a string value for the name of the product	myProduct

Update Subscription

Update an existing subscription | key: updateSubscription

Input	Notes	Example
Cancel At string cancelAt	A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.	0208302
Collection Method string collectionMethod	Provide a value for the collection method of the invoice.
Coupon string coupon	(DEPRECATED) Provide a value for the unique identifier of the coupon for the invoice.	Z4OV52SU
Values string Key Value List fieldValues	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 string Key Value List 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 string quantity	Provide a string value for quantity of the items in the subscription.	30
Connection connection / Required stripeConnection
Subscription Id string subscriptionId	Provide a string value for unique identifier of the subscription.
Price Id string subscriptionPriceId	Provide a value for the unique identifier of the price.	price_1JaOXaDtJQgcyrdSRnsI9KW5
Timeout string timeout	The maximum time a client will await a response.	2000

Update Webhook

Update a webhook by ID | key: updateWebhook

Input	Notes	Example
Connection connection / Required stripeConnection
Timeout string timeout	The maximum time a client will await a response.	2000
Webhook Events string Value List webhookEvents	The events the webhook will listen for	payment_intent.created
Webhook ID string / Required webhookId	The ID of the webhook to update	we_1Mr5jULkdIwHu7ix1ibLTM0x
Webhook URL string webhookUrl	The URL the webhook will send requests to	https://hooks.example.com/EXAMPLE

{
  "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"
  }
}

Manage objects connected to your Stripe platform

Description​

API Documentation​

Connections​

Stripe Connection​

Triggers​

Instance Webhooks​

Webhook (Deprecated)​

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 Instanced 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 Subscriptions​

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​

List Products​

List Subscriptions​

List Webhooks​

Raw Request​

Search Charges​

Search Payment Intent​

Update Card​

Update Charge​

Update Checkout Session​

Update Customer​

Update Dispute​

Update Invoice​

Update Payment Intent​

Update Price​

Update Product​

Update Subscription​

Update Webhook​