---
title: "Retrieve automation settings"
description: "What the store automates: whether invoices are emailed automatically, after what delay and on which order condition (any order, a payment status, a fulfillment status or a shipment status, narrowed by customer and order "
url: https://docs.invoicefalcon.com/v3-reference/account/retrieve-automation-settings/
api: "API v3 reference"
method: GET
path: "/account/automation"
---

# Retrieve automation settings

`GET https://app.invoicefalcon.com/api/v3/external/account/automation`

What the store automates: whether invoices are emailed automatically, after what delay and on which order condition (any order, a payment status, a fulfillment status or a shipment status, narrowed by customer and order tags and by sales channel); automatic credit notes on refunds; the pay-now button in emails; and payment reminders (due days, interval, before/after, extra recipients). Read-only.

`automatic_invoices.when.payment_status` values: `paid` (Paid), `pending` (Pending), `refunded` (Refunded), `partially_paid` (Partially paid), `authorized` (Authorized), `voided` (Voided).

`automatic_invoices.when.fulfillment_status` values: `shipped` (Fulfilled), `unshipped` (Unfulfilled), `partial` (Partially fulfilled), `in_progress` (In progress), `on_hold` (On hold).

`automatic_invoices.when.shipment_status` values: `shipped` (Shipped), `delivered` (Delivered), `in_transit` (In transit).

`payment_reminders.send` values: `after` (After the due date), `before` (Before the due date), `both` (Before and after the due date).

## Returns

- `automatic_invoices` (object)
  - `enabled` (boolean): e.g. `true`
  - `delay_minutes` (integer, nullable)
  - `when` (object)
    - `payment_status` (string): e.g. `paid`
    - `fulfillment_status` (string, nullable)
    - `shipment_status` (string, nullable)
    - `trigger` (string): e.g. `payment_status`
  - `only_customer_tags` (string, nullable)
  - `except_customer_tags` (string, nullable)
  - `only_order_tags` (string, nullable)
  - `except_order_tags` (string, nullable)
- `automatic_credit_notes` (object)
  - `enabled` (boolean): e.g. `false`
  - `email_customer` (boolean): e.g. `false`
- `pay_now_button` (object)
  - `enabled` (boolean): e.g. `false`
- `payment_reminders` (object)
  - `enabled` (boolean): e.g. `true`
  - `automatic` (boolean): e.g. `true`
  - `due_after_days` (integer, nullable)
  - `every_days` (integer): e.g. `5`
  - `send` (string): e.g. `after`
  - `also_send_to` (string)
  - `only_to_these_addresses` (boolean): e.g. `false`
  - `include_payment_link` (boolean): e.g. `false`
  - `active` (boolean): e.g. `true`
  - `also_send_to_addresses` (array of anys)
- `paid_features_available` (boolean): e.g. `true`

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

## Example request

```sh
curl "https://app.invoicefalcon.com/api/v3/external/account/automation" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
```

## 200

The requested resource.

```json
{
  "automatic_invoices": {
    "enabled": true,
    "delay_minutes": null,
    "when": {
      "payment_status": "paid",
      "fulfillment_status": null,
      "shipment_status": null,
      "trigger": "payment_status"
    },
    "only_customer_tags": null,
    "except_customer_tags": null,
    "only_order_tags": null,
    "except_order_tags": null
  },
  "automatic_credit_notes": {
    "enabled": false,
    "email_customer": false
  },
  "pay_now_button": {
    "enabled": false
  },
  "payment_reminders": {
    "enabled": true,
    "automatic": true,
    "due_after_days": null,
    "every_days": 5,
    "send": "after",
    "also_send_to": "",
    "only_to_these_addresses": false,
    "include_payment_link": false,
    "active": true,
    "also_send_to_addresses": []
  },
  "paid_features_available": true
}
```

## 401

Missing or unknown `X-Auth-Token`, or the shop uninstalled the app.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "unauthorized"
}
```

## 403

`v3_required`: the shop still runs the previous dashboard. `paid_plan_required`: API access needs a paid plan.

```json
{
  "errors": [
    "API access requires a paid plan"
  ],
  "code": "paid_plan_required"
}
```

## 422

The request failed validation. Nothing was saved.

```json
{
  "errors": [
    "id is missing"
  ]
}
```

## 429

Rate limited: cost-weighted per key (reads cost less than writes). Wait `Retry-After` seconds; see `X-RateLimit-*` headers.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited"
}
```

