---
title: "Get payment failed email"
description: "Read the preorder payment-failed notification's email copy (it has no SMS). ?locale= picks the language (omit it for the shop default)."
url: https://docs.stoqapp.com/v2-reference/preorders-templates/get-payment-failed-email/
api: "API v2 reference"
method: GET
path: "/preorders/templates/payment_failed"
---

# Get payment failed email

`GET https://app.stoqapp.com/api/v2/external/preorders/templates/payment_failed`

Read the preorder payment-failed notification's email copy (it has no SMS). ?locale= picks the language (omit it for the shop default).

**Note:** Change the copy with [`PATCH /preorders/templates/payment_failed`](https://docs.stoqapp.com/v2-reference/preorders-templates/update-payment-failed-email/). STOQ sends it when it can't charge the remaining balance of a partially paid preorder; the button opens Shopify's payment page for the order, and no email goes out when Shopify gives no such page. There is no shop-wide switch to turn it off. A language with no translation of a field returns the shop default's text for it.

## Query parameters

- `locale` (string): Language of the copy, such as fr or pt-BR. Omit for the shop's default language.

## Returns

- `key` (string): e.g. `string`
- `locale` (string): e.g. `string`
- `email` (object)
  - `subject` (string): e.g. `string`
  - `heading` (string): e.g. `string`
  - `body` (string): e.g. `string`
  - `button_text` (string): e.g. `string`
  - `klaviyo_flow_name` (null)
  - `klaviyo_flow_verified` (boolean): e.g. `true`
  - `integration` (null)

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Examples

### Get payment failed email

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/templates/payment_failed" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Get payment failed email filtered by locale

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/templates/payment_failed?locale=fr" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "key": "string",
  "locale": "string",
  "email": {
    "subject": "string",
    "heading": "string",
    "body": "string",
    "button_text": "string",
    "klaviyo_flow_name": null,
    "klaviyo_flow_verified": true,
    "integration": null
  }
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

