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

# Stripe integration

[Back to list of enterprise systems](https://koreai.mintlify.site/agent-platform/integrations/enterprise-systems.md)

Use the Stripe integration to manage customers, invoices, subscriptions, products, prices, payments, refunds, and payment links through Action Tools. It also provides triggers for payment, customer, subscription, invoice, refund, dispute, and checkout events.

| Authentication | Actions | Triggers |
| - | - | - |
| OAuth 2.0 or API Key | ([19](https://koreai.mintlify.site/agent-platform/integrations/enterprise-systems/stripe#supported-actions)) | ([13](https://koreai.mintlify.site/agent-platform/integrations/enterprise-systems/stripe#triggers)) |

## Supported actions

| Action | Use it to |
| - | - |
| [Create Customer](#create-customer) | Create a Stripe customer. |
| [Create Invoice](#create-invoice) | Create an invoice. |
| [Search Customer](#search-customer) | Search for a customer by email. |
| [Search Subscriptions](#search-subscriptions) | Search subscriptions by price, status, customer, and other filters. |
| [Retrieve Customer](#retrieve-customer) | Retrieve a customer by ID. |
| [Update Customer](#update-customer) | Update a customer. |
| [Create Payment (Payment Intent)](#create-payment-payment-intent) | Create a Payment Intent to start a payment flow. |
| [Create Product](#create-product) | Create a product. |
| [Create Price](#create-price) | Create a one-time or recurring price for a product. |
| [Create Subscription](#create-subscription) | Create a subscription for a customer. |
| [Cancel Subscription](#cancel-subscription) | Cancel a subscription immediately or at the end of its current billing period. |
| [Retrieve an Invoice](#retrieve-an-invoice) | Retrieve an invoice by ID. |
| [Retrieve a Payout](#retrieve-a-payout) | Retrieve a payout by ID. |
| [Create a Refund](#create-a-refund) | Create a full or partial refund. |
| [Create Payment Link](#create-payment-link) | Create a Stripe-hosted payment link. |
| [Deactivate Payment Link](#deactivate-payment-link) | Disable a payment link. |
| [Find Payment (by Payment Intent ID)](#find-payment-by-payment-intent-id) | Retrieve a payment by Payment Intent ID. |
| [Find Invoice](#find-invoice) | Find an invoice by ID. |
| [Custom API Call](#custom-api-call) | Call a Stripe API endpoint. |

## Triggers

| Trigger | Fires when |
| - | - |
| New Payment | A payment is made. |
| New Customer | A customer is created. |
| Payment Failed | A payment fails. |
| New Subscription | A subscription is created. |
| New Charge | A charge is successfully completed. |
| New Invoice | An invoice is created, optionally filtered by status, customer, or subscription. |
| Invoice Payment Failed | A payment against an invoice fails, optionally filtered by customer. |
| Canceled Subscription | A subscription is canceled, optionally filtered by customer. |
| New Refund | A charge is refunded, optionally filtered by charge or Payment Intent. |
| New Dispute | A customer disputes a charge, optionally filtered by charge or Payment Intent. |
| New Payment Link | A payment link is created. |
| Updated Subscription | A subscription changes, optionally filtered by status or customer. |
| Checkout Session Completed | A Stripe Checkout Session is successfully completed, optionally filtered by customer. |

## Prerequisites

* A Stripe account with access to the customers, products, payments, and other resources your tools will use.
* A Stripe secret API key, or a Stripe account and OAuth app for OAuth 2.0 authorization.
* The account or API key must have the permissions required for the selected actions and triggers.

## Set up the integration

**1. Create a Stripe auth profile**

In **Tools**, select **New Tool** > **Action** > **Stripe** > **Continue**, then select **Manage profiles**. In **Project Auth Profiles**, select **New Profile** > **Integration Profile** > **Stripe** > **Continue**. Choose **OAuth 2.0** or **API Key**. For OAuth 2.0, enter the client ID and secret and add the callback URL shown in Studio to your Stripe OAuth app. For API Key, enter the Stripe secret key. Save the profile and authorize it when using OAuth 2.0.

**2. Create the action tool**

In **Tools**, select **New Tool** > **Action** > **Stripe** > **Continue**. Select the **Action** and **Auth Profile**, configure the inputs, and select **Create Tool**. Then [assign the tool to an agent](https://koreai.mintlify.site/agent-platform/tools/actions.md#assign-an-action-to-an-agent).

## Action reference

The parameters below are the required inputs listed for each action in the connector catalog. Studio may also show optional settings for the selected action; configure those in the tool builder as needed.

> [accordion] Create Customer
>
> | Required parameter | Description |
> | - | - |
> | `email` | Customer email address. |
> | `name` | Customer name. |

> [accordion] Create Invoice
>
> | Required parameter | Description |
> | - | - |
> | `customer_id` | ID of the customer to invoice. |
> | `currency` | Currency for the invoice. |

> [accordion] Search Customer
>
> | Required parameter | Description |
> | - | - |
> | `email` | Email address to search for. |

> [accordion] Search Subscriptions
>
> No required parameters are listed in the connector catalog. Studio provides optional search filters, including price, status, and customer details.

> [accordion] Retrieve Customer
>
> | Required parameter | Description |
> | - | - |
> | `id` | ID of the customer to retrieve. |

> [accordion] Update Customer
>
> | Required parameter | Description |
> | - | - |
> | `customer` | Customer ID and updated details. |

> [accordion] Create Payment (Payment Intent)
>
> | Required parameter | Description |
> | - | - |
> | `amount` | Payment amount. |
> | `currency` | Payment currency. |
> | `customer` | ID of the customer. |

> [accordion] Create Product
>
> | Required parameter | Description |
> | - | - |
> | `name` | Product name. |

> [accordion] Create Price
>
> | Required parameter | Description |
> | - | - |
> | `product` | Product ID. |
> | `unit_amount` | Price amount per unit. |
> | `currency` | Price currency. |
> | `recurring_interval` | Interval for recurring prices. |

> [accordion] Create Subscription
>
> | Required parameter | Description |
> | - | - |
> | `customer` | Customer ID. |
> | `items` | Subscription items and prices. |

> [accordion] Cancel Subscription
>
> | Required parameter | Description |
> | - | - |
> | `subscription` | Subscription ID. |

> [accordion] Retrieve an Invoice
>
> | Required parameter | Description |
> | - | - |
> | `invoice_id` | ID of the invoice to retrieve. |

> [accordion] Retrieve a Payout
>
> | Required parameter | Description |
> | - | - |
> | `payout_id` | ID of the payout to retrieve. |

> [accordion] Create a Refund
>
> | Required parameter | Description |
> | - | - |
> | `payment_intent` | Payment Intent ID to refund. |

> [accordion] Create Payment Link
>
> | Required parameter | Description |
> | - | - |
> | `line_items` | Products and prices to include in the payment link. |

> [accordion] Deactivate Payment Link
>
> | Required parameter | Description |
> | - | - |
> | `payment_link_id` | ID of the payment link to deactivate. |

> [accordion] Find Payment (by Payment Intent ID)
>
> | Required parameter | Description |
> | - | - |
> | `payment_intent_id` | Payment Intent ID. |

> [accordion] Find Invoice
>
> | Required parameter | Description |
> | - | - |
> | `invoice_id` | Invoice ID. |

> [accordion] Custom API Call
>
> | Required parameter | Description |
> | - | - |
> | `url` | Stripe API endpoint URL. |
> | `method` | HTTP method for the request. |
> | `headers` | Request headers. |
> | `queryParams` | Query string parameters. |

## Trigger reference

> [accordion] New Payment
>
> No input parameters.

> [accordion] New Customer
>
> No input parameters.

> [accordion] Payment Failed
>
> No input parameters.

> [accordion] New Subscription
>
> No input parameters.

> [accordion] New Charge
>
> No input parameters.

> [accordion] New Invoice
>
> | Parameter | Required | Description |
> | - | - | - |
> | `status` | No | Filter by **Draft**, **Open**, **Paid**, **Uncollectible**, or **Void**. |
> | `customer` | No | Filter by customer ID. |
> | `subscription` | No | Filter by subscription ID. |

> [accordion] Invoice Payment Failed
>
> | Parameter | Required | Description |
> | - | - | - |
> | `customer` | No | Filter by customer ID. |

> [accordion] Canceled Subscription
>
> | Parameter | Required | Description |
> | - | - | - |
> | `customer` | No | Filter by customer ID. |

> [accordion] New Refund
>
> | Parameter | Required | Description |
> | - | - | - |
> | `charge` | No | Filter by charge ID. |
> | `payment_intent` | No | Filter by Payment Intent ID. |

> [accordion] New Dispute
>
> | Parameter | Required | Description |
> | - | - | - |
> | `charge` | No | Filter by charge ID. |
> | `payment_intent` | No | Filter by Payment Intent ID. |

> [accordion] New Payment Link
>
> No input parameters.

> [accordion] Updated Subscription
>
> | Parameter | Required | Description |
> | - | - | - |
> | `status` | No | Filter by **Incomplete**, **Incomplete - Expired**, **Trialing**, **Active**, **Past Due**, **Canceled**, **Unpaid**, or **Paused**. |
> | `customer` | No | Filter by customer ID. |

> [accordion] Checkout Session Completed
>
> | Parameter | Required | Description |
> | - | - | - |
> | `customer` | No | Filter by customer ID. |

## Troubleshoot common issues

| Issue | Resolution |
| - | - |
| Authentication fails | Check the Stripe API key or OAuth client credentials and confirm the profile has access to the account and operations used by the tool. |
| An action can't find a customer, invoice, or subscription | Verify the Stripe object ID and confirm the authorized account can access it. |
| An action is missing required permissions | Check the API key permissions or OAuth authorization for the selected Stripe operation. |
| A trigger doesn't return expected events | Check the event type and optional status, customer, subscription, charge, or Payment Intent filters. |

## Related articles

* [Auth profiles](https://koreai.mintlify.site/agent-platform/administration/integrations-settings.md#auth-profiles)
* [Action Tools](https://koreai.mintlify.site/agent-platform/tools/actions.md)
* [Stripe developer documentation](https://docs.stripe.com/)


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