---
title: "Get report settings"
description: "The merchant's preorder report preferences (Settings > Reports): whether STOQ emails the merchant each time the remaining balance of a partially paid preorder is collected."
url: https://docs.stoqapp.com/v2-reference/preorders-settings/get-report-settings/
api: "API v2 reference"
method: GET
path: "/preorders/settings/reports"
---

# Get report settings

`GET https://app.stoqapp.com/api/v2/external/preorders/settings/reports`

The merchant's preorder report preferences (Settings &gt; Reports): whether STOQ emails the merchant each time the remaining balance of a partially paid preorder is collected.

**Note:** Change it with [`PATCH /preorders/settings/reports`](https://docs.stoqapp.com/v2-reference/preorders-settings/update-report-settings/). The email goes to the report address, scheduled_reports.email on [`GET /back_in_stock/settings/alerts`](https://docs.stoqapp.com/v2-reference/back-in-stock-settings/get-alert-settings/). It is off on a new shop. A failed collection always emails the merchant, whatever this says.

## Returns

- `notify_payment_collection_enabled` (boolean): e.g. `true`

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

## Example request

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

## 200

Success: the requested resource.

```json
{
  "notify_payment_collection_enabled": true
}
```

## 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
    }
  ]
}
```

