> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/stripe.md).

# Stripe

Stripe is a payment processing platform that allows you to accept payments from customers.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Stripe    | API Key        |

### Stripe

Connect to Stripe payment processing platform to manage financials. Supports creating customers, processing payments, and managing refunds.

#### Set up in Stripe

1. Sign in to the Stripe Dashboard.
2. Open Developers then API keys (dashboard.stripe.com/apikeys), and reveal your Secret key (use a test-mode key for testing).
3. Copy the secret key; treat it like a password since it can move money on your account.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Stripe**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                        |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Stripe API secret key from the Stripe Dashboard. [Provider instructions](https://dashboard.stripe.com/apikeys). |

**Provider documentation:** [Setup reference](https://docs.stripe.com/keys).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Stripe** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create Customer

Create a customer in Stripe

#### Inputs

| Field          | Type   | Required | Description                          |
| -------------- | ------ | -------- | ------------------------------------ |
| Customer Name  | string | Yes      | The name of the customer to create.  |
| Customer Email | string | Yes      | The email of the customer to create. |

#### Outputs

| Field               | Type   | Description                        |
| ------------------- | ------ | ---------------------------------- |
| Customer ID         | string | The ID of the customer created.    |
| Customer Name       | string | The name of the customer created.  |
| Customer Email      | string | The email of the customer created. |
| Customer Created At | number | The creation date of the customer. |

### Create Payment

Create a payment for a customer

#### Inputs

| Field          | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| -------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Payment Amount | integer         | Yes      | The amount to charge the customer. Minimum: 0.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Customer Email | string          | Yes      | The email of the customer for which the payment is being created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Currency Type  | select (string) | No       | The type of currency for which the payment will be created. Available values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SLE, SOS, SRD, STD, SVC, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW. Default: USD. |

#### Outputs

| Field               | Type   | Description                                                    |
| ------------------- | ------ | -------------------------------------------------------------- |
| Payment ID          | string | The ID of the payment created.                                 |
| Payment Status      | string | The status of the payment created.                             |
| Payment Amount      | number | The amount of the payment created.                             |
| Payment Currency    | string | The currency used for the creation of the payment.             |
| Payment Customer ID | string | The ID of the customer for which the payment is being created. |

### List Charges

A tool for listing charges of a given customer.

#### Inputs

| Field          | Type     | Required | Description                                                                                                                            |
| -------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Customer Email | string   | Yes      | The email of the customer you want to list charges for.                                                                                |
| Created After  | datetime | No       | Only return charges created on or after this date.                                                                                     |
| Created Before | datetime | No       | Only return charges created on or before this date.                                                                                    |
| Auto Paginate  | boolean  | No       | Whether to automatically fetch additional pages until Max Results is reached. When off, only a single page is returned. Default: true. |
| Max Results    | integer  | No       | The maximum number of charges to return (1-1000, default 100). Minimum: 1. Maximum: 1000.                                              |

#### Outputs

| Field    | Type          | Description                                                           |
| -------- | ------------- | --------------------------------------------------------------------- |
| Charges  | object\_array | The list of charges of the customer.                                  |
| Has More | boolean       | Stripe's flag indicating whether more charges exist beyond this page. |

### List Subscriptions

A tool for listing subscriptions of a given customer.

#### Inputs

| Field          | Type     | Required | Description                                                                                                                                 |
| -------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Customer Email | string   | Yes      | The email of the customer you want to list subscriptions for.                                                                               |
| Status Filter  | string   | No       | Filter by subscription status (e.g. active, past\_due, canceled, all). Defaults to all so canceled and past-due subscriptions are included. |
| Created After  | datetime | No       | Only return subscriptions created on or after this date.                                                                                    |
| Created Before | datetime | No       | Only return subscriptions created on or before this date.                                                                                   |
| Renews After   | datetime | No       | Only return subscriptions whose current period ends (renews) on or after this date.                                                         |
| Renews Before  | datetime | No       | Only return subscriptions whose current period ends (renews) on or before this date.                                                        |
| Auto Paginate  | boolean  | No       | Whether to automatically fetch additional pages until Max Results is reached. When off, only a single page is returned. Default: true.      |
| Max Results    | integer  | No       | The maximum number of subscriptions to return (1-1000, default 100). Minimum: 1. Maximum: 1000.                                             |

#### Outputs

| Field         | Type          | Description                                                                 |
| ------------- | ------------- | --------------------------------------------------------------------------- |
| Subscriptions | object\_array | The list of subscriptions of the customer.                                  |
| Has More      | boolean       | Stripe's flag indicating whether more subscriptions exist beyond this page. |

### Search Customer

A tool for searching customers.

#### Inputs

| Field          | Type    | Required | Description                                                                                                                                                                                                                                                                                                       |
| -------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email          | string  | Yes      | The email of the customer to search for.                                                                                                                                                                                                                                                                          |
| Limit          | integer | No       | The maximum number of customers to return. Limit can range between 1 and 100, and the default is 10.                                                                                                                                                                                                              |
| Starting After | string  | No       | 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.   |
| Ending Before  | string  | No       | 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. |

#### Outputs

| Field     | Type          | Description                        |
| --------- | ------------- | ---------------------------------- |
| Customers | object\_array | The customers found in the search. |

### Send Refund

Use this tool to send a refund to a customer given a Charge ID.

#### Inputs

| Field     | Type   | Required | Description                                 |
| --------- | ------ | -------- | ------------------------------------------- |
| Charge ID | string | Yes      | The Charge ID of the charge to be refunded. |

#### Outputs

| Field     | Type   | Description                 |
| --------- | ------ | --------------------------- |
| Refund ID | string | The ID of the refund.       |
| Amount    | number | The amount of the refund.   |
| Currency  | string | The currency of the refund. |
| Status    | string | The status of the refund.   |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### On Customer Created

Trigger a workflow execution every time a new customer is created in Stripe.

#### Event inputs

| Field          | Type     | Required | Description                                  |
| -------------- | -------- | -------- | -------------------------------------------- |
| Customer ID    | string   | Yes      | The ID of the customer created in Stripe.    |
| Customer Email | string   | No       | The email of the customer created in Stripe. |
| Customer Name  | string   | No       | The name of the customer created in Stripe.  |
| Customer Data  | textarea | Yes      | JSON string representing the customer data.  |

#### Outputs

| Field          | Type     | Description                                  |
| -------------- | -------- | -------------------------------------------- |
| Customer ID    | string   | The ID of the customer created in Stripe.    |
| Customer Email | string   | The email of the customer created in Stripe. |
| Customer Name  | string   | The name of the customer created in Stripe.  |
| Customer Data  | textarea | JSON string representing the customer data.  |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/stripe.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
