> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Stripe

> How to set up the Stripe connector, plus the actions and events that are available.

![Stripe](https://stackone-logos.com/api/stripe/filled/svg)

v1.1.2[See changelog](https://docs.stackone.com/connectors/stripe/changelog.md)

[138 actions](#actions) · [49 events](#events) · 1 auth method

Payments
Billing
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/stripe/guides/connector-profile/api-key.md)
>
> Use your Stripe Secret API Key or Restricted API Key for authentication. Find these in your Stripe Dashboard under Devel...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/stripe/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

138 actions

ActionDescription

List Application Fees`stripe_list_application_fees`

List all application fees collected on your platform

Get Application Fee`stripe_get_application_fee`

Retrieve an application fee by ID

Get Balance`stripe_get_balance`

Retrieve the current account balance showing available and pending amounts by currency for the authenticated Stripe acco...

List Balance Transactions`stripe_list_balance_transactions`

List all balance transactions that have affected the Stripe account balance, including charges, refunds, transfers, payo...

Get Balance Transaction`stripe_get_balance_transaction`

Retrieve detailed information about a specific balance transaction by its unique identifier, including amount, fee break...

List Charges`stripe_list_charges`

Retrieve a paginated list of all charge objects, sorted by creation date with advanced filtering options for customer, p...

Get Charge`stripe_get_charge`

Retrieve complete details of a specific charge object by its unique identifier, including payment status, amount, custom...

Update Charge`stripe_update_charge`

Update mutable properties of an existing charge including customer association, description, metadata, receipt email, sh...

Capture Charge`stripe_capture_charge`

Capture the funds of an existing uncaptured charge with optional partial amount capture, statement descriptors, and tran...

Search Charges`stripe_search_charges`

Perform advanced search across charge objects using Stripe's powerful query language with support for complex filters on...

Create Checkout Session`stripe_create_checkout_session`

Create a Stripe Checkout Session via POST /v1/checkout/sessions to initiate a payment, subscription, or setup flow with...

List Checkout Sessions`stripe_list_checkout_sessions`

List all Checkout Sessions with optional filters

Get Checkout Session`stripe_get_checkout_session`

Retrieve a Checkout Session by ID

Expire Checkout Session`stripe_expire_checkout_session`

Expire an open Checkout Session to cancel the payment process

List Checkout Session Line Items`stripe_list_checkout_session_line_items`

List line items for a Checkout Session

Create Coupon`stripe_create_coupon`

Create a discount coupon for use on subscriptions and invoices

List Coupons`stripe_list_coupons`

List all coupons with optional filters

Get Coupon`stripe_get_coupon`

Retrieve a coupon by ID

Update Coupon`stripe_update_coupon`

Update a coupon's metadata or name

Delete Coupon`stripe_delete_coupon`

Delete a coupon permanently

List Credit Notes`stripe_list_credit_notes`

List all credit notes for invoice adjustments and refunds

Get Credit Note`stripe_get_credit_note`

Retrieve a credit note by ID

List Customers`stripe_list_customers`

Retrieve a paginated list of all customers in your Stripe account, sorted by creation date with the most recent customer...

Get Customer`stripe_get_customer`

Retrieve complete details for a specific customer by their unique Stripe customer ID

Create Customer`stripe_create_customer`

Create a new customer record in Stripe with optional payment methods, billing information, and tax settings

Update Customer`stripe_update_customer`

Update an existing customer's information, payment settings, or metadata while preserving unchanged fields

Delete Customer`stripe_delete_customer`

Permanently delete a customer record and immediately cancel all active subscriptions (irreversible operation)

Search Customers`stripe_search_customers`

Search for customers using Stripe's powerful query syntax supporting filters on email, name, phone, metadata, and creati...

List Disputes`stripe_list_disputes`

List all disputes with optional filters for monitoring chargebacks and fraud

Get Dispute`stripe_get_dispute`

Retrieve a dispute by ID

Update Dispute`stripe_update_dispute`

Update a dispute with evidence or metadata

Close Dispute`stripe_close_dispute`

Close a dispute to accept the chargeback

List Events`stripe_list_events`

List all events for audit trail of account changes

Get Event`stripe_get_event`

Retrieve an event by ID

List Files`stripe_list_files`

List all files uploaded to Stripe

Get File`stripe_get_file`

Retrieve a file by ID

Get Unified Credentials`stripe_unified_get_me`

Get the current Stripe connection's unified credentials and identity.

List Unified Groups`stripe_unified_list_groups`

List unified groups in the connected Stripe account or organization.

Get Unified Group`stripe_unified_get_group`

Get a unified Stripe group by ID.

List Unified Users`stripe_unified_list_users`

List unified users in the connected Stripe account or organization.

Get Unified User`stripe_unified_get_user`

Get a unified Stripe user by ID.

List Invoices`stripe_list_invoices`

Retrieve a paginated list of all invoices with optional filtering by customer, subscription, status, and collection meth...

Get Invoice`stripe_get_invoice`

Retrieve complete details of a specific invoice including line items, payment status, customer information, and billing...

Create Invoice`stripe_create_invoice`

Creates a draft invoice in Stripe via POST /v1/invoices (form-encoded), returning a fully modifiable invoice object that...

Update Invoice`stripe_update_invoice`

Modify an existing draft invoice by updating collection method, payment terms, tax settings, custom fields, or metadata

Delete Invoice`stripe_delete_invoice`

Permanently delete a draft invoice including subscription-generated invoices, with no possibility of recovery

Finalize Invoice`stripe_finalize_invoice`

Convert a draft invoice to finalized status, making it ready for payment collection, email delivery, or programmatic pro...

Pay Invoice`stripe_pay_invoice`

Programmatically charge an invoice using the customer's default payment source or a specified payment method with suppor...

Send Invoice`stripe_send_invoice`

Email a finalized invoice to the customer with a secure payment link and PDF attachment for manual payment collection

Void Invoice`stripe_void_invoice`

Cancel an open or uncollectible invoice permanently, preventing any future payment collection while maintaining historic...

Mark Invoice Uncollectible`stripe_mark_invoice_uncollectible`

Mark an open invoice as uncollectible to stop payment collection attempts while preserving the invoice for bad debt trac...

Search Invoices`stripe_search_invoices`

Execute complex invoice searches using Stripe's query language to filter by customer, status, metadata, amounts, dates,...

Attach Payment To Invoice`stripe_attach_payment`

Link an existing PaymentIntent or out-of-band payment record to an invoice, automatically crediting payments when they s...

Create Invoice Item`stripe_create_invoice_item`

Create an invoice item (line item) via POST /v1/invoiceitems to add a charge or credit to a specific draft invoice or qu...

List Invoice Items`stripe_list_invoice_items`

List all invoice items with optional filters for customer, invoice, or pending status

Get Upcoming Invoice`stripe_get_upcoming_invoice`

Preview the next invoice before billing

List Payment Intents`stripe_list_payment_intents`

Retrieve a paginated list of all payment intents for your account, with optional filters for customer, creation date, an...

Get Payment Intent`stripe_get_payment_intent`

Retrieve complete details of a specific payment intent by ID, including status, amount, payment method, and all associat...

Create Payment Intent`stripe_create_payment_intent`

Create a new payment intent to collect payment from a customer, supporting multiple payment methods, automatic confirmat...

Update Payment Intent`stripe_update_payment_intent`

Modify properties of an existing unconfirmed payment intent such as amount, payment method, customer, or metadata withou...

Confirm Payment Intent`stripe_confirm_payment_intent`

Confirm customer intent to pay with the specified payment method, initiating payment processing and triggering authentic...

Capture Payment Intent`stripe_capture_payment_intent`

Capture authorized funds from a PaymentIntent in requires\_capture status (created with capture\_method=manual), supportin...

Cancel Payment Intent`stripe_cancel_payment_intent`

Cancel a payment intent that has not yet been captured, releasing any authorized funds and preventing further payment at...

Search Payment Intents`stripe_search_payment_intents`

Search payment intents using Stripe's powerful query language to filter by customer, status, amount, metadata, and times...

Increment Authorization`stripe_increment_authorization`

Increase the authorized amount on an uncaptured payment intent, useful for scenarios where final charges exceed initial...

Apply Customer Balance`stripe_apply_customer_balance`

Apply funds from a customer's cash balance to reconcile a payment intent, enabling wallet-based or prepaid payment scena...

Verify Microdeposits`stripe_verify_microdeposits`

Verify bank account ownership by confirming microdeposit amounts or descriptor codes, completing the ACH or bank transfe...

List Payment Intent Line Items`stripe_list_payment_intent_line_items`

Retrieve itemized breakdown of products, quantities, and amounts for a payment intent, providing transaction-level detai...

List Payment Links`stripe_list_payment_links`

List all payment links for no-code payment pages

Get Payment Link`stripe_get_payment_link`

Retrieve a payment link by ID

List Payment Link Line Items`stripe_list_payment_link_line_items`

List line items for a payment link

List Payment Methods`stripe_list_payment_methods`

Retrieve all payment methods associated with a specific customer account

Get Payment Method`stripe_get_payment_method`

Retrieve detailed information about a specific payment method using its unique identifier

Create Payment Method`stripe_create_payment_method`

Create a new payment method object for future use with customers and transactions

Update Payment Method`stripe_update_payment_method`

Modify billing details, metadata, and limited card information for an existing payment method

Attach Payment Method`stripe_attach_payment_method`

Link a payment method to a customer account for reuse in future transactions

Detach Payment Method`stripe_detach_payment_method`

Remove the association between a payment method and its customer account

List Payouts`stripe_list_payouts`

List all payouts with optional filters for tracking bank transfers

Get Payout`stripe_get_payout`

Retrieve a payout by ID

List Prices`stripe_list_prices`

Retrieve a paginated list of all prices in your Stripe account with flexible filtering options

Get Price`stripe_get_price`

Fetch detailed information about a specific price using its unique identifier

Create Price`stripe_create_price`

Create a new one-time or recurring price with advanced configuration including tiered pricing, metered billing, and mult...

Update Price`stripe_update_price`

Update mutable properties of an existing price including active status, metadata, nickname, and tax behavior

Search Prices`stripe_search_prices`

Perform advanced full-text search across prices using Stripe's powerful search query syntax for complex filtering requir...

List Products`stripe_list_products`

Retrieve a paginated list of all products in your Stripe account with flexible filtering options including active status...

Get Product`stripe_get_product`

Fetch complete details of a single product using its unique identifier, including pricing information, images, metadata,...

Create Product`stripe_create_product`

Create a new product in your Stripe catalog with comprehensive configuration including pricing, images, shipping details...

Update Product`stripe_update_product`

Modify an existing product's properties including name, description, images, pricing, active status, and shipping config...

Delete Product`stripe_delete_product`

Permanently remove a product from your Stripe catalog, only allowed for products with no associated prices (consider dea...

Search Products`stripe_search_products`

Perform advanced product searches using Stripe's powerful query language with support for field-specific queries, fuzzy...

Create Promotion Code`stripe_create_promotion_code`

Create a customer-facing promotion code linked to a coupon

List Promotion Codes`stripe_list_promotion_codes`

Retrieve a paginated list of all promotion codes with optional filtering by coupon, customer, active status, code, and c...

Get Promotion Code`stripe_get_promotion_code`

Retrieve a promotion code by ID

List Radar Value Lists`stripe_list_radar_value_lists`

List all Radar value lists for fraud prevention

Get Radar Value List`stripe_get_radar_value_list`

Retrieve a Radar value list by ID

Create Radar Value List`stripe_create_radar_value_list`

Create a new Radar value list for fraud prevention

Update Radar Value List`stripe_update_radar_value_list`

Update a Radar value list

Delete Radar Value List`stripe_delete_radar_value_list`

Delete a Radar value list

List Refunds`stripe_list_refunds`

Retrieve a paginated list of all refunds with optional filtering by charge, payment intent, or creation date

Get Refund`stripe_get_refund`

Retrieve complete details of a specific refund including status, amount, reason, and associated charge or payment intent...

Create Refund`stripe_create_refund`

Issue a full or partial refund for a charge or payment intent with optional reason tracking and metadata

Update Refund`stripe_update_refund`

Update the metadata of an existing refund for internal tracking and organizational purposes

Cancel Refund`stripe_cancel_refund`

Cancel a pending refund that requires customer action before completion, preventing the refund from being processed

Create Setup Intent`stripe_create_setup_intent`

Create a SetupIntent to save a payment method for future payments without charging the customer

List Setup Intents`stripe_list_setup_intents`

List all SetupIntents with optional filters

Get Setup Intent`stripe_get_setup_intent`

Retrieve a SetupIntent by ID

Cancel Setup Intent`stripe_cancel_setup_intent`

Cancel a SetupIntent that is not yet confirmed

List Shipping Rates`stripe_list_shipping_rates`

List all shipping rates configured for checkout

Get Shipping Rate`stripe_get_shipping_rate`

Retrieve a shipping rate by ID

Create Shipping Rate`stripe_create_shipping_rate`

Create a new shipping rate for checkout

Update Shipping Rate`stripe_update_shipping_rate`

Update a shipping rate

List Subscriptions`stripe_list_subscriptions`

Retrieve a paginated list of all customer subscriptions with optional filtering by status, customer, price, and billing...

Get Subscription`stripe_get_subscription`

Retrieve complete details of a specific subscription including pricing, billing cycle, payment status, and customer info...

Create Subscription`stripe_create_subscription`

Creates a recurring subscription for a customer via POST /v1/subscriptions (form-encoded), supporting multi-item pricing...

Update Subscription`stripe_update_subscription`

Modify an existing subscription's pricing, payment method, billing configuration, or subscription items with optional pr...

Cancel Subscription`stripe_cancel_subscription`

Immediately terminate a subscription, stop all future billing, and optionally generate a final prorated invoice for the...

Resume Subscription`stripe_resume_subscription`

Reactivate a paused subscription that was paused through a subscription schedule, restoring billing and transitioning st...

Migrate Subscription`stripe_migrate_subscription`

Performs a one-way migration of a subscription from classic billing mode to flexible billing mode, enabling advanced pro...

Search Subscriptions`stripe_search_subscriptions`

Perform advanced full-text search across subscriptions using Stripe's query language to find subscriptions by status, me...

List Subscription Items`stripe_list_subscription_items`

List individual line items within a subscription

Get Subscription Item`stripe_get_subscription_item`

Retrieve a subscription item by ID

Create Tax Rate`stripe_create_tax_rate`

Create a tax rate for subscriptions and invoices

List Tax Rates`stripe_list_tax_rates`

List all tax rates with optional filters

Get Tax Rate`stripe_get_tax_rate`

Retrieve a tax rate by ID

Update Tax Rate`stripe_update_tax_rate`

Update a tax rate's properties

Create Test Clock`stripe_create_test_clock`

Create a test clock for subscription time simulation

List Test Clocks`stripe_list_test_clocks`

List all test clocks

Get Test Clock`stripe_get_test_clock`

Retrieve a test clock by ID

Advance Test Clock`stripe_advance_test_clock`

Advance a test clock to a new frozen time

Delete Test Clock`stripe_delete_test_clock`

Delete a test clock

List Transfers`stripe_list_transfers`

List all transfers to connected accounts

Get Transfer`stripe_get_transfer`

Retrieve a transfer by ID

Create Transfer`stripe_create_transfer`

Create a transfer to a connected account

Update Transfer`stripe_update_transfer`

Update a transfer's metadata or description

Create Webhook Endpoint`stripe_create_webhook_endpoint`

Create a webhook endpoint to receive event notifications

List Webhook Endpoints`stripe_list_webhook_endpoints`

List all webhook endpoints

Get Webhook Endpoint`stripe_get_webhook_endpoint`

Retrieve a webhook endpoint by ID

Delete Webhook Endpoint`stripe_delete_webhook_endpoint`

Delete a webhook endpoint

## Events

Tags

Select all
|
Clear

Charges

Checkout Sessions

Customers

Disputes

Invoices

Payment Intents

Payment Methods

Prices

Products

Refunds

Setup Intents

Subscriptions

Webhooks

No tags found

49 events

EventDescriptionTags

Payment Intent Created`stripe_webhook_payment_intent_created`

Fired when a PaymentIntent is created.

Payment IntentsWebhooks

Payment Intent Succeeded`stripe_webhook_payment_intent_succeeded`

Fired when a PaymentIntent successfully completes payment.

Payment IntentsWebhooks

Payment Intent Payment Failed`stripe_webhook_payment_intent_payment_failed`

Fired when a PaymentIntent fails its payment attempt.

Payment IntentsWebhooks

Payment Intent Canceled`stripe_webhook_payment_intent_canceled`

Fired when a PaymentIntent is canceled.

Payment IntentsWebhooks

Payment Intent Requires Action`stripe_webhook_payment_intent_requires_action`

Fired when a PaymentIntent requires customer action (e.g. 3DS authentication).

Payment IntentsWebhooks

Payment Intent Processing`stripe_webhook_payment_intent_processing`

Fired when a PaymentIntent transitions to processing (e.g. bank debits).

Payment IntentsWebhooks

Payment Intent Amount Capturable Updated`stripe_webhook_payment_intent_amount_capturable_updated`

Fired when the amount\_capturable on a PaymentIntent changes.

Payment IntentsWebhooks

Charge Succeeded`stripe_webhook_charge_succeeded`

Fired when a charge succeeds.

ChargesWebhooks

Charge Failed`stripe_webhook_charge_failed`

Fired when a charge attempt fails.

ChargesWebhooks

Charge Captured`stripe_webhook_charge_captured`

Fired when a previously uncaptured charge is captured.

ChargesWebhooks

Charge Refunded`stripe_webhook_charge_refunded`

Fired when a charge is refunded (fully or partially).

ChargesWebhooks

Charge Updated`stripe_webhook_charge_updated`

Fired when properties of a charge are updated.

ChargesWebhooks

Dispute Created`stripe_webhook_charge_dispute_created`

Fired when a customer disputes a charge (chargeback opened).

DisputesWebhooks

Dispute Updated`stripe_webhook_charge_dispute_updated`

Fired when a dispute is updated (evidence submitted or status changed).

DisputesWebhooks

Dispute Closed`stripe_webhook_charge_dispute_closed`

Fired when a dispute is closed (won, lost, or withdrawn).

DisputesWebhooks

Dispute Funds Withdrawn`stripe_webhook_charge_dispute_funds_withdrawn`

Fired when funds are withdrawn from your Stripe account due to a dispute.

DisputesWebhooks

Refund Created`stripe_webhook_refund_created`

Fired when a refund is created.

RefundsWebhooks

Refund Updated`stripe_webhook_refund_updated`

Fired when a refund is updated (e.g. status change).

RefundsWebhooks

Refund Failed`stripe_webhook_refund_failed`

Fired when a refund fails.

RefundsWebhooks

Customer Created`stripe_webhook_customer_created`

Fired when a new customer is created.

CustomersWebhooks

Customer Updated`stripe_webhook_customer_updated`

Fired when a customer's properties are updated.

CustomersWebhooks

Customer Deleted`stripe_webhook_customer_deleted`

Fired when a customer is deleted.

CustomersWebhooks

Subscription Created`stripe_webhook_customer_subscription_created`

Fired when a customer subscription is created.

SubscriptionsWebhooks

Subscription Updated`stripe_webhook_customer_subscription_updated`

Fired when a customer subscription is updated (plan change, quantity, etc.).

SubscriptionsWebhooks

Subscription Deleted`stripe_webhook_customer_subscription_deleted`

Fired when a customer subscription is canceled and reaches the end of its period.

SubscriptionsWebhooks

Subscription Paused`stripe_webhook_customer_subscription_paused`

Fired when a customer subscription is paused.

SubscriptionsWebhooks

Subscription Resumed`stripe_webhook_customer_subscription_resumed`

Fired when a paused customer subscription is resumed.

SubscriptionsWebhooks

Subscription Trial Will End`stripe_webhook_customer_subscription_trial_will_end`

Fired three days before a subscription trial ends.

SubscriptionsWebhooks

Invoice Created`stripe_webhook_invoice_created`

Fired when a new invoice is created.

InvoicesWebhooks

Invoice Finalized`stripe_webhook_invoice_finalized`

Fired when an invoice is finalized and ready for payment.

InvoicesWebhooks

Invoice Paid`stripe_webhook_invoice_paid`

Fired when an invoice is successfully paid.

InvoicesWebhooks

Invoice Payment Succeeded`stripe_webhook_invoice_payment_succeeded`

Fired when payment for an invoice succeeds.

InvoicesWebhooks

Invoice Payment Failed`stripe_webhook_invoice_payment_failed`

Fired when payment for an invoice fails.

InvoicesWebhooks

Invoice Payment Action Required`stripe_webhook_invoice_payment_action_required`

Fired when an invoice payment requires customer action (e.g. 3DS).

InvoicesWebhooks

Invoice Voided`stripe_webhook_invoice_voided`

Fired when an invoice is voided.

InvoicesWebhooks

Invoice Marked Uncollectible`stripe_webhook_invoice_marked_uncollectible`

Fired when an invoice is marked as uncollectible.

InvoicesWebhooks

Checkout Session Expired`stripe_webhook_checkout_session_expired`

Fired when a checkout session expires without completion.

Checkout SessionsWebhooks

Setup Intent Created`stripe_webhook_setup_intent_created`

Fired when a SetupIntent is created.

Setup IntentsWebhooks

Setup Intent Succeeded`stripe_webhook_setup_intent_succeeded`

Fired when a SetupIntent confirms successfully and saves the payment method.

Setup IntentsWebhooks

Setup Intent Canceled`stripe_webhook_setup_intent_canceled`

Fired when a SetupIntent is canceled.

Setup IntentsWebhooks

Setup Intent Setup Failed`stripe_webhook_setup_intent_setup_failed`

Fired when a SetupIntent fails to set up the payment method.

Setup IntentsWebhooks

Payment Method Attached`stripe_webhook_payment_method_attached`

Fired when a payment method is attached to a customer.

Payment MethodsWebhooks

Payment Method Detached`stripe_webhook_payment_method_detached`

Fired when a payment method is detached from a customer.

Payment MethodsWebhooks

Payment Method Updated`stripe_webhook_payment_method_updated`

Fired when a payment method is updated.

Payment MethodsWebhooks

Product Created`stripe_webhook_product_created`

Fired when a product is created.

ProductsWebhooks

Product Updated`stripe_webhook_product_updated`

Fired when a product is updated.

ProductsWebhooks

Product Deleted`stripe_webhook_product_deleted`

Fired when a product is deleted.

ProductsWebhooks

Price Created`stripe_webhook_price_created`

Fired when a price is created.

PricesWebhooks

Price Updated`stripe_webhook_price_updated`

Fired when a price is updated.

PricesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.