> For the complete documentation index, see [llms.txt](https://docs.umbcheckout.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbcheckout.net/v17/payment-providers/payment-providers/stripe/configuration.md).

# Configuration

Configuring Stripe Payment Provider

You will need to add your Stripe Secret API key to the site's configuration, as below. Keep the keys out of committed settings files: use [user secrets](https://learn.microsoft.com/aspnet/core/security/app-secrets) in development and environment variables or your host's secret store elsewhere (for example `UmbCheckout__Stripe__Live__ApiKey`).

```json
  "UmbCheckout": {
    "Stripe": {
      "Test": {
        "ApiKey": "TEST STRIPE SECRET API KEY"
      },
      "Live": {
        "ApiKey": "LIVE STRIPE SECRET API KEY"
      }
    }
  }
```

You can find your Stripe Secret API key [within your account](https://dashboard.stripe.com/apikeys) by heading to `Developers -> API keys`

If the key for the active mode is missing, checkout and the Stripe screens show "No Stripe API key is configured for test mode. Set UmbCheckout:Stripe:Test:ApiKey." (or live) instead of an error page.

You also need the [Stripe Webhook](/v17/payment-providers/payment-providers/stripe/services/stripe-webhook-api.md): it records payments, so a paid Basket is cleared even if the customer doesn't return to the success page. Add its signing secret in the same way:

```json
  "UmbCheckout": {
    "Stripe": {
      "Test": {
        "WebHookSecret": "STRIPE TEST WEBHOOK SECRET"
      },
      "Live": {
        "WebHookSecret": "LIVE STRIPE WEBHOOK SECRET"
      }
    }
  }
```

You can create your WebHook Secret [within your account](https://dashboard.stripe.com/webhooks) by heading to `Developers -> Webhooks`

You will also need to ensure your Webhooks are configured for the [Stripe API ](https://dashboard.stripe.com/developers)version used by the Stripe.net package UmbCheckout is built with. UmbCheckout 17 uses Stripe.net 50.x, which uses API version:

```
2026-01-28.clover
```

The test keys are used unless **Use live API details** is ticked in the Stripe settings (see below).

### Stripe Settings

The Stripe settings are found in the backoffice here:

Settings -> UmbCheckout -> Stripe -> Settings

| Name                                       | Use                                                                                                                                                                                   |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Use live API details                       | Use the `Live` API key and webhook secret. When unticked, the `Test` ones are used                                                                                                    |
| Allowed Shipping Countries                 | The countries Stripe Checkout accepts shipping addresses for, as 2-letter ISO codes separated by commas (e.g. `GB,IE`). Used only when **Enable Shipping** is on in the configuration |
| Collect Phone Number                       | Stripe Checkout asks the customer for a phone number                                                                                                                                  |
| Collect Promotional Emails Consent         | Stripe Checkout asks the customer for consent to promotional emails (Stripe offers this for US customers)                                                                             |
| Allow Promotional Codes                    | Stripe Checkout accepts promotion codes created in Stripe                                                                                                                             |
| Enable Abandoned Cart Recovery             | Stripe can email customers who leave the checkout a link to recover it. Used only when **Collect Promotional Emails Consent** is on                                                   |
| Allow Promotional Codes On Recovered Carts | Recovered checkouts accept promotion codes. Used only with **Enable Abandoned Cart Recovery**                                                                                         |

Only users with access to the Settings section can see or change the Stripe settings. Saving them writes the uSync file when [uSync Stripe](/v17/payment-providers/payment-providers/stripe/usync.md) is installed.

### Product properties

Your product can have the following optional properties

| Alias               | Property Type                                                                                                     |
| ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| umbCheckoutMetaData | [Meta Data](/v17/core-services/property-editors/metadata-property-editor.md)                                      |
| umbCheckoutTaxRates | [Tax Rates](/v17/payment-providers/payment-providers/stripe/addons/property-editors/tax-rates-property-editor.md) |


---

# 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.umbcheckout.net/v17/payment-providers/payment-providers/stripe/configuration.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.