Skip to main content

Stripe Connector

Stripe Manage objects connected to your Stripe platform

Connections

Stripe Connection

Authenticate requests to Stripe using an API Key

InputCommentsDefault
API KeyProvide 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.

InputCommentsDefault
Webhook EventsFor 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.
Connection
Disable Webhook ValidationWhen set to true, webhook signature validation will be skipped. This is useful for manually testing the trigger without needing a signed request.false

Webhook (Deprecated)

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

Actions

Attach Card

Attach a card to a customer

InputCommentsDefault
Payment Method IdProvide a value for the unique identifier of the payment.
Customer IdProvide a string value for unique identifier of the customer.
TimeoutThe maximum time a client will await a response.
Connection

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.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Payment Intent IDThe ID of the Payment Intent.
Cancellation ReasonThe reason for cancelling the Payment Intent.

Capture Payment Intent

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Payment Intent IDThe ID of the Payment Intent.
Amount to CaptureThe amount to capture from the PaymentIntent, which must be less than or equal to the original amount.
MetadataSet 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.
Application Fee AmountThe 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.
Statement DescriptorFor non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor SuffixProvides information about a card payment that customers see on their statements.
Transfer DataThe 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.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Dispute IDThe ID of the dispute.

Confirm Payment Intent

Confirm that your customer intends to pay with current or provided payment method.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Payment Intent IDThe ID of the Payment Intent.
Payment MethodID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
Receipt EmailThis 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.
Setup Future UsageIndicates that you intend to make future payments with this PaymentIntent’s payment method.
Capture MethodControls when the funds will be captured from the customer’s account.
Error On Requires ActionSet to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
MandateID of the mandate to be used for this payment.
Mandate DataThis hash contains details about the Mandate to create.
Off SessionSet to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.
Payment Method DataIf provided, this hash will be used to create a PaymentMethod.
Payment Method OptionsPayment-method-specific configuration for this PaymentIntent.
Radar OptionsOptions to configure Radar.
Return UrlThe URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site.
Use Stripe SDKSet 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

InputCommentsDefault
Customer IdProvide a string value for unique identifier of the customer.
Card NumberProvide a value for the number of the card.
Expiration MonthProvide a value for the expiration month of the card.
Expiration YearProvide a value for the expiration year of the card.
CVCProvide a value for the CVC on the back of the card.
Billing Street AddressProvide a value for the street address of the billing information
Billing Address 2Provide a value for the optional second address field of the billing information
Billing CityProvide a value for the city of the billing information
Billing CountryProvide a value for the country of the billing information
Billing Postal CodeProvide a value for the postal code of the billing information
Billing StateProvide a value for the state of the billing information
Billing StateProvide a value for the email of the billing information
Full NameProvide a value for the name of the billing information
Billing StateProvide a value for the phone of the billing information
MetadataSet 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.
TimeoutThe maximum time a client will await a response.
Connection

Create Checkout Session

Create a new Stripe Checkout Session

InputCommentsDefault
ModeThe mode of the Checkout Sessionpayment
Line ItemsJSON array of line items to be purchased.
EmailThe email of the customer to create the checkout session for.
Customer IdThe ID of the customer to create the checkout session for.
Client Reference IDA 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.
Success URLThe URL the customer will be directed to after the payment is successful
Cancel URLThe URL the customer will be directed to if they decide to cancel payment
Body ParamsMore parameters to pass to the request.
TimeoutThe maximum time a client will await a response.
Connection

Create Customer

Create a new customer object

InputCommentsDefault
Nameprovide a string value for the name of the customer.
PhoneThe maximum time a client will await a response.
Address Line 1Provide a string value for street address of the customer.
Address Line 2Provide a string value for street address of the customer.
CityProvide a string value for city of the customer.
CountryProvide a string value for country of the customer.
Postal CodeProvide a string value for postal code of the customer.
StateProvide a string value for state of the customer.
BalanceProvide a number value for balance of the customer.
Default Payment Method IdProvide the unique identifier of the customer's default payment method.
DescriptionProvide a string value for description of the customer.
EmailProvide a string value for email of the customer.
MetadataSet 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.
TimeoutThe maximum time a client will await a response.
Connection

Create Invoice

Create a new invoice

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Customer IdProvide a string value for unique identifier of the customer.
Collection MethodProvide a value for the collection method of the invoice.
Payment Method IdProvide a value for the unique identifier of the payment.
Auto AdvanceControls whether Stripe will perform automatic collection of the invoice.false
ValuesThe 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.
Subscription IdProvide a string value for unique identifier of the subscription.
DescriptionProvide a value for the description of the invoice.
MetadataSet 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.
Due DateProvide a unix timestamp value for the due date of the invoice.
Connection

Create Payment Intent

Creates a PaymentIntent object.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
AmountAmount intended to be collected by this PaymentIntent.
CurrencyThree-letter ISO currency code, in lowercase. Must be a supported currency.
Automatic Payment MethodsWhen enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent’s other parameters.
ConfirmSet to true to attempt to confirm this PaymentIntent immediately.false
CustomerID of the Customer this PaymentIntent belongs to, if one exists.
DescriptionAn arbitrary string attached to the object. Often useful for displaying to users.
MetadataSet 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 SessionSet to true to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate.
Payment MethodID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
Receipt EmailEmail address that the receipt for the resulting payment will be sent to.
Setup Future UsageIndicates that you intend to make future payments with this PaymentIntent’s payment method.
ShippingShipping information for this PaymentIntent.
Statement DescriptorFor non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor SuffixProvides information about a card payment that customers see on their statements.
Application Fee AmountThe 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.
Capture MethodControls when the funds will be captured from the customer’s account.
Confirmation Method
Error On Requires ActionSet to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
MandateID of the mandate to be used for this payment.
Mandate DataThis hash contains details about the Mandate to create.
On Behalf OfThe Stripe account ID for which these funds are intended
Payment Method DataIf provided, this hash will be used to create a PaymentMethod.
Payment Method OptionsPayment-method-specific configuration for this PaymentIntent.
Payment Method TypesThe list of payment method types that this PaymentIntent is allowed to use.
Radar OptionsOptions to configure Radar.
Return UrlThe URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site.
Transfer DataThe parameters used to automatically create a Transfer when the payment succeeds
Transfer GroupA string that identifies the resulting payment as part of a group.
Use Stripe SDKSet 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

InputCommentsDefault
Product IdProvide a string value for the unique identifier of the product
CurrencyThree-letter ISO currency code, in lowercase. Must be a supported currency.
Unit PriceProvide a value for the price per unit.
ActiveThis flag will specify if the object is currently active in your platform.false
NicknameA brief description of the price, hidden from customers.
RecurringIntervalProvide a value that specifies billing frequency.
ValuesThe 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.
MetadataSet 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.
TimeoutThe maximum time a client will await a response.
Connection

Create Product

Create a new product

InputCommentsDefault
Product NameProvide a string value for the name of the product
Product TypeProvide a string value for the type of the product
Product URLA URL of a publicly-accessible webpage for this product. May only be set if type=good.
ShippableWhether this product is able to be shipped (i.e., physical goods).false
ActiveThis flag will specify if the object is currently active in your platform.false
DescriptionProvide a value for the description of the invoice.
Product ImagesFor each list item, provide a URL for the image of the product
MetadataSet 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.
ValuesThe 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.
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.
TimeoutThe maximum time a client will await a response.
Connection

Create Subscription

Create a new subscription

InputCommentsDefault
Customer IdProvide a string value for unique identifier of the customer.
Price IdProvide a value for the unique identifier of the price.
Collection MethodProvide a value for the collection method of the invoice.
QuantityProvide a string value for quantity of the items in the subscription.
Payment Method IdProvide a value for the unique identifier of the payment.
Cancel AtA 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.
Days Until DueProvide a value for the days until the payment is due
ValuesThe 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.
MetadataSet 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.
Coupon(DEPRECATED) Provide a value for the unique identifier of the coupon for the invoice.
TimeoutThe maximum time a client will await a response.
Connection

Create Webhook

Create a new webhook

InputCommentsDefault
Webhook URLProvide a valid URL representing where the request will be sent.
Webhook EventsFor 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.
TimeoutThe maximum time a client will await a response.
Connection

Delete All Instanced Webhooks

Delete all the webhooks associated to each flow of the instance.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection

Delete Customer

Permanently deletes a customer, Also immediately cancels any active subscriptions on the customer.

InputCommentsDefault
Customer IdProvide a string value for unique identifier of the customer.
TimeoutThe maximum time a client will await a response.
Connection

Delete Invoice

Delete an existing invoice

InputCommentsDefault
invoiceIdProvide a value for the unique identifier of the invoice.
TimeoutThe maximum time a client will await a response.
Connection

Delete Product

Delete an existing product by Id

InputCommentsDefault
Product IdProvide a string value for the unique identifier of the product
TimeoutThe maximum time a client will await a response.
Connection

Delete Subscription

Delete a subscription by Id

InputCommentsDefault
Subscription IdProvide a string value for unique identifier of the subscription.
TimeoutThe maximum time a client will await a response.
Connection

Delete Webhook

Deletes a webhook by ID

InputCommentsDefault
Webhook IDThe ID of the webhook to delete
TimeoutThe maximum time a client will await a response.
Connection

Detach Card

Detach a card from a customer

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Payment Method IdProvide a value for the unique identifier of the payment.
Connection

Expire Checkout Session

Expire a Stripe Checkout Session

InputCommentsDefault
Session IDThe ID of the checkout session to expire
TimeoutThe maximum time a client will await a response.
Connection

Get Balance Transaction

Retrieves the balance transaction with the given ID.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Balance Transaction IDProvide a value for the unique identifier of the balance transaction.

Get Card

Get the information and metadata of a card by Id

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Payment Method IdProvide a value for the unique identifier of the payment.
Connection

Get Charge

Retrieves the details of a charge that has previously been created.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Charge ID

Get Checkout Session

Retrieve a Stripe Checkout Session

InputCommentsDefault
Session IDThe ID of the checkout session to expire
TimeoutThe maximum time a client will await a response.
Connection

Get Customer

Retrieve the information and metadata of a customer by Id

InputCommentsDefault
Customer IdProvide a string value for unique identifier of the customer.
TimeoutThe maximum time a client will await a response.
Connection

Get Dispute

Retrieves the dispute with the given ID.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Dispute IDThe ID of the dispute.

Get Invoice

Get the information and metadata of an invoice by Id

InputCommentsDefault
invoiceIdProvide a value for the unique identifier of the invoice.
TimeoutThe maximum time a client will await a response.
Connection

Get Payment Intent

Retrieves the details of a PaymentIntent that has previously been created.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Payment IDThe ID of the PaymentIntent to retrieve.
Client SecretThe client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source.

Get Price

Get the information and metadata of a price by Id

InputCommentsDefault
Price IdProvide a value for the unique identifier of the price.
TimeoutThe maximum time a client will await a response.
Connection

Get Product

Get the information and metadata of a product by Id

InputCommentsDefault
Product IdProvide a string value for the unique identifier of the product
TimeoutThe maximum time a client will await a response.
Connection

Get Subscriptions

Get the information and metadata of a subscription by Id

InputCommentsDefault
Subscription IdProvide a string value for unique identifier of the subscription.
TimeoutThe maximum time a client will await a response.
Connection

Get Webhook

Retrieves a webhook by ID

InputCommentsDefault
Webhook IDThe ID of the webhook.
TimeoutThe maximum time a client will await a response.
Connection

List Accounts

Returns a list of accounts connected to your platform

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Connection

List Balance Transactions

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth).

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
CreatedA filter on the list based on the object created field.
CurrencyOnly return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
Ending BeforeA 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.
LimitProvide an integer value for the maximum amount of results that will be returned.
SourceOnly returns the original transaction.
Starting AfterA 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.
Connection

List Cards

Returns a list of cards connected to your platform

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Customer IdProvide a string value for unique identifier of the customer.
Starting AfterA 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.
LimitProvide an integer value for the maximum amount of results that will be returned.
Ending BeforeA 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.
Connection

List Charges

Returns a list of all charges

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Connection

List Checkout Session Line Items

List all Stripe Checkout Session Line Items

InputCommentsDefault
Session IDThe ID of the checkout session to expire
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Ending BeforeA 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.
TimeoutThe maximum time a client will await a response.
Connection

List Checkout Sessions

List all Stripe Checkout Sessions

InputCommentsDefault
Fetch AllWhen true, will retrieve all results.false
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Ending BeforeA 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.
TimeoutThe maximum time a client will await a response.
Connection

List Customers

Returns a list of customers

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Connection

List Disputes

Returns a list of your disputes.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
ChargeOnly return disputes associated to the charge specified by this charge ID.
Payment IntentOnly return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
CreatedA filter on the list based on the object created field.
Ending BeforeA 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.

List Invoices

Returns a list of invoices connected to your platform

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Connection

List Payment Intents

Returns a list of PaymentIntents.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
CustomerOnly return PaymentIntents for the customer specified by this customer ID.
CreatedA filter on the list based on the object created field.
Ending BeforeA 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.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.

List Prices

Returns a list of all available prices

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Connection

List Products

Returns a list of products connected to your platform

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Connection

List Subscriptions

Returns a list of subscriptions

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Connection

List Webhooks

List all webhooks

InputCommentsDefault
Fetch AllWhen true, will retrieve all results.false
LimitProvide an integer value for the maximum amount of results that will be returned.
Starting AfterA 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.
Ending BeforeA 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.
TimeoutThe maximum time a client will await a response.
Connection

Raw Request

Send raw HTTP request to Stripe

InputCommentsDefault
Connection
URLInput 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.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA 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.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf 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
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies 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.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
QueryThe search query string.
LimitA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
PageA 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.

Search Payment Intent

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
QueryThe search query string.
LimitProvide an integer value for the maximum amount of results that will be returned.
PageA 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.

Update Card

Create a new card by Id

InputCommentsDefault
Customer IdProvide a string value for unique identifier of the customer.
Card NumberProvide a value for the number of the card.
Expiration MonthProvide a value for the expiration month of the card.
Expiration YearProvide a value for the expiration year of the card.
CVCProvide a value for the CVC on the back of the card.
Billing Street AddressProvide a value for the street address of the billing information
Billing Address 2Provide a value for the optional second address field of the billing information
Billing CityProvide a value for the city of the billing information
Billing CountryProvide a value for the country of the billing information
Billing Postal CodeProvide a value for the postal code of the billing information
Billing StateProvide a value for the state of the billing information
Billing StateProvide a value for the email of the billing information
Full NameProvide a value for the name of the billing information
Billing StateProvide a value for the phone of the billing information
MetadataSet 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
TimeoutThe maximum time a client will await a response.

Update Charge

Updates the specified charge by setting the values of the parameters passed.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Charge ID
CustomerThe ID of an existing customer that will be associated with this request.
DescriptionAn arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge
MetadataSet 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 EmailThis 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.
ShippingShipping information for the charge. Helps prevent fraud on charges for physical goods.
Fraud DetailsA set of key-value pairs you can attach to a charge giving information about its riskiness.
Transfer GroupA string that identifies this transaction as part of a group.

Update Checkout Session

Update a Stripe Checkout Session

InputCommentsDefault
Session IDThe ID of the checkout session to expire
MetadataSet 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.
TimeoutThe maximum time a client will await a response.
Connection

Update Customer

Create a new customer object

InputCommentsDefault
Customer IdProvide a string value for unique identifier of the customer.
Nameprovide a string value for the name of the customer.
PhoneThe maximum time a client will await a response.
Address Line 1Provide a string value for street address of the customer.
Address Line 2Provide a string value for street address of the customer.
CityProvide a string value for city of the customer.
CountryProvide a string value for country of the customer.
Postal CodeProvide a string value for postal code of the customer.
StateProvide a string value for state of the customer.
BalanceProvide a number value for balance of the customer.
DescriptionProvide a string value for description of the customer.
EmailProvide a string value for email of the customer.
ValuesThe 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.
MetadataSet 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.
TimeoutThe maximum time a client will await a response.
Connection

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.

InputCommentsDefault
TimeoutThe maximum time a client will await a response.
Connection
Dispute IDThe ID of the dispute.
EvidenceEvidence to upload to respond to a dispute.
MetadataSet 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.
SubmitWhether to immediately submit evidence to the bank.

Update Invoice

Update an existing invoice

InputCommentsDefault
invoiceIdProvide a value for the unique identifier of the invoice.
Payment Method IdProvide a value for the unique identifier of the payment.
Auto AdvanceControls whether Stripe will perform automatic collection of the invoice.false
Application Fee AmountProvide 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.
Collection MethodProvide a value for the collection method of the invoice.
CouponProvide a value for the unique identifier of the coupon for the invoice.
DiscountProvide a value for the discount of the invoice.
DescriptionProvide a value for the description of the invoice.
Due DateProvide a unix timestamp value for the due date of the invoice.
ValuesThe 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.
MetadataSet 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.
TimeoutThe maximum time a client will await a response.
Connection

Update Payment Intent

Updates properties on a PaymentIntent object without confirming.

InputCommentsDefault
Payment Intent IDThe ID of the Payment Intent.
TimeoutThe maximum time a client will await a response.
Connection
AmountAmount intended to be collected by this PaymentIntent.
CurrencyThree-letter ISO currency code, in lowercase. Must be a supported currency.
CustomerID of the Customer this PaymentIntent belongs to, if one exists.
DescriptionAn arbitrary string attached to the object. Often useful for displaying to users.
MetadataSet 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 MethodID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
Receipt EmailEmail address that the receipt for the resulting payment will be sent to.
Setup Future UsageIndicates that you intend to make future payments with this PaymentIntent’s payment method.
ShippingShipping information for this PaymentIntent.
Statement DescriptorFor non-card charges, you can use this value as the complete description that appears on your customers’ statements.
Statement Descriptor SuffixProvides information about a card payment that customers see on their statements.
Application Fee AmountThe 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.
Capture MethodControls when the funds will be captured from the customer’s account.
Payment Method DataIf provided, this hash will be used to create a PaymentMethod.
Payment Method OptionsPayment-method-specific configuration for this PaymentIntent.
Payment Method TypesThe list of payment method types that this PaymentIntent is allowed to use.
Transfer DataThe parameters used to automatically create a Transfer when the payment succeeds
Transfer GroupA string that identifies the resulting payment as part of a group.

Update Price

Update an existing price by Id

InputCommentsDefault
Price IdProvide a value for the unique identifier of the price.
ActiveThis flag will specify if the object is currently active in your platform.false
NicknameA brief description of the price, hidden from customers.
ValuesThe 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.
MetadataSet 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.
TimeoutThe maximum time a client will await a response.
Connection

Update Product

Update an existing product

InputCommentsDefault
Product IdProvide a string value for the unique identifier of the product
Product NameProvide a string value for the name of the product
Product URLA URL of a publicly-accessible webpage for this product. May only be set if type=good.
ShippableWhether this product is able to be shipped (i.e., physical goods).false
ActiveThis flag will specify if the object is currently active in your platform.false
DescriptionProvide a value for the description of the invoice.
Product ImagesFor each list item, provide a URL for the image of the product
MetadataSet 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.
ValuesThe 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.
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.
TimeoutThe maximum time a client will await a response.
Connection

Update Subscription

Update an existing subscription

InputCommentsDefault
Subscription IdProvide a string value for unique identifier of the subscription.
Price IdProvide a value for the unique identifier of the price.
QuantityProvide a string value for quantity of the items in the subscription.
Collection MethodProvide a value for the collection method of the invoice.
Cancel AtA 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.
ValuesThe 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.
MetadataSet 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.
Coupon(DEPRECATED) Provide a value for the unique identifier of the coupon for the invoice.
TimeoutThe maximum time a client will await a response.
Connection

Update Webhook

Update a webhook by ID

InputCommentsDefault
Webhook IDThe ID of the webhook to update
Webhook URLThe URL the webhook will send requests to
Webhook EventsThe events the webhook will listen for
TimeoutThe maximum time a client will await a response.
Connection