# Stripe (alpha)
URL: https://docs.awellhealth.com/docs/marketplace/stripe

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



<img src="/marketplace/stripe.png" width="48" height="48" />

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

Category: Billing. Adds 3 actions to a care flow.

## What to configure [#what-to-configure]

Set these once, on the extension in Awell Studio. An action fails at run time if a
required setting is missing.

| Setting                           | Required | Notes                                                                                                            |
| --------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| Hosted Pages environment variable | Yes      | This will be removed once the extension is out of alpha mode. This needs to be configured by an Awell developer. |
| Live mode publishable key         | Yes      | This key is used for testing Embedded checkout in Awell Hosted Pages                                             |
| Live mode secret key              | Yes      | This key is used to authenticate requests on your server when in live mode Stored as a secret.                   |
| Mode                              | Yes      | "Test" or "Live", defaults to "Test". Make sure to have a secret key set for live mode when enabling it.         |
| Test mode publishable key         | Yes      | This key is used for testing Embedded checkout in Awell Hosted Pages                                             |
| Test mode secret key              | Yes      | This key is used to authenticate requests on your server when in test mode Stored as a secret.                   |

## Actions [#actions]

Stripe (alpha) adds these 3 actions to a care flow. Add one to a step, then fill in its inputs.

### Create customer [#create-customer]

Create a customer in Stripe

This action can be previewed in Studio before you publish.

| Input | Type     | Required | Description                                                                                                                     |
| ----- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Email | `string` | No       | Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. |
| Name  | `string` | No       | The customer’s full name or business name.                                                                                      |

Returns:

| Data point   | Type     |
| ------------ | -------- |
| `customerId` | `string` |

### Create subscription [#create-subscription]

Create a subscription in Stripe

| Input    | Type     | Required | Description                                 |
| -------- | -------- | -------- | ------------------------------------------- |
| Customer | `string` | Yes      | The identifier of the customer to subscribe |
| Item     | `string` | Yes      | The ID of the price object                  |

Returns:

| Data point       | Type     |
| ---------------- | -------- |
| `subscriptionId` | `string` |

### Embedded checkout [#embedded-checkout]

Embedded checkout in Awell Hosted Pages

| Input | Type     | Required | Description                                                                                                                |
| ----- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| Mode  | `string` | Yes      | The mode of the checkout session which can be 'payment', 'setup', and 'subscription' One of: Payment, Setup, Subscription. |
| Item  | `string` | Yes      | The id of the item (price ID) the customer is purchasing                                                                   |

Returns:

| Data point | Type      |
| ---------- | --------- |
| `success`  | `boolean` |

## Setup and notes [#setup-and-notes]

### Stripe [#stripe]

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

### Extension settings [#extension-settings]

For the extension to function correctly, you must configure the following settings:

* Secret key (test and live mode)
* Publishable key (test and live mode)
* Mode ("Test" or "Live")

## Changelog [#changelog]

## Stripe changelog [#stripe-changelog]

## Where this page comes from [#where-this-page-comes-from]

The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the
platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action.
Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).
