Skip to main content

Stripe Component

Manage objects connected to your Stripe platform

Component key: stripe


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


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



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

You can configure a Stripe event notification webhook to send information to a Prismatic 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.

Output Example Payload

"payload": {
"headers": {
"accept": "*/*",
"Content-Type": "application/json; charset=UTF-8",
"Stripe-Signature": "Example-Stripe-Signature",
"User-Agent": "Stripe/1.0 (+",
"Host": ""
"body": {
"data": {
"id": "evt_example302r",
"object": "event",
"api_version": "2020-08-27",
"created": "103920",
"data": {
"id": "example_prod_39u42432",
"object": "Product",
"active": "true",
"created": "123320112",
"description": "Ths is an example Product Description.",
"livemode": true,
"name": "Example Product Name",
"type": "service"
"contentType": "application/json; charset=UTF-8"
"rawBody": {
"data": {
"type": "Buffer",
"data": [69, 120, 97, 109, 112, 108, 101]
"queryParameters": {
"user_id": "ExampleUserId",
"user_key": "ExampleUserKey"
"webhookUrls": {
"Flow 1": ""
"webhookApiKeys": {
"Flow 1": ["abc-123"]
"customer": {
"externalId": "customer-example-external-id",
"name": "John Doe"


Attach Card

Attach a card to a customer | key: attachCard

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

Capture Payment Intent

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

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

Confirm Payment Intent

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

Create Card

Create a new card | key: createCard

Create Customer

Create a new customer object | key: createCustomer

Create Invoice

Create a new invoice | key: createInvoice

Create Payment Intent

Creates a PaymentIntent object. | key: createPaymentIntent

Create Price

Create a new price | key: createPrice

Create Product

Create a new product | key: createProduct

Create Subscription

Create a new subscription | key: createSubscription

Delete Customer

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

Output Example Payload

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

Delete Invoice

Delete an existing invoice | key: deleteInvoice

Delete Product

Delete an existing product by Id | key: deleteProduct

Delete Subscription

Delete a subscription by Id | key: deleteSubscription

Detach Card

Detach a card from a customer | key: detachCard

Get Balance Transaction

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

Get Card

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

Get Charge

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

Get Customer

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

Output Example Payload

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

Get Dispute

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

Get Invoice

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

Get Payment Intent

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

Get Price

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

Get Product

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

Get Subscriptions

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

List Accounts

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

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

List Cards

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

List Charges

Returns a list of all charges | key: listCharges

List Customers

Returns a list of customers | key: listCustomers

List Disputes

Returns a list of your disputes. | key: listDisputes

List Invoices

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

List Payment Intents

Returns a list of PaymentIntents. | key: listPaymentIntents

List Prices

Returns a list of all available prices | key: listPrices

List Products

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

List Subscriptions

Returns a list of subscriptions | key: listSubscriptions

Raw Request

Send raw HTTP request to Stripe | key: rawRequest

Search Charges

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

Search Payment Intent

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

Update Card

Create a new card by Id | key: updateCard

Update Charge

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

Update Customer

Create a new customer object | key: updateCustomer

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

Update Invoice

Update an existing invoice | key: updateInvoice

Update Payment Intent

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

Update Price

Update an existing price by Id | key: updatePrice

Update Product

Update an existing product | key: updateProduct

Update Subscription

Update an existing subscription | key: updateSubscription