Skip to content

Retrieve automation settings

GET/account/automation

Costs 1 rate-limit point · Rate limits

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).

Also searched asautomatic invoicing settingsare invoices sent automaticallywhen do invoices go outpayment reminder settingsautomatic credit notespay now buttonautomation rules

Returns

  • automatic_invoicesobject
    Show 7 child attributesHide child attributes
    • enabledboolean
      Example: true
    • delay_minutesinteger, nullable
    • whenobject
      Show 4 child attributesHide child attributes
      • payment_statusstring
        Example: paid
      • fulfillment_statusstring, nullable
      • shipment_statusstring, nullable
      • triggerstring
        Example: payment_status
    • only_customer_tagsstring, nullable
    • except_customer_tagsstring, nullable
    • only_order_tagsstring, nullable
    • except_order_tagsstring, nullable
  • automatic_credit_notesobject
    Show 2 child attributesHide child attributes
    • enabledboolean
      Example: false
    • email_customerboolean
      Example: false
  • pay_now_buttonobject
    Show 1 child attributeHide child attributes
    • enabledboolean
      Example: false
  • payment_remindersobject
    Show 10 child attributesHide child attributes
    • enabledboolean
      Example: true
    • automaticboolean
      Example: true
    • due_after_daysinteger, nullable
    • every_daysinteger
      Example: 5
    • sendstring
      Example: after
    • also_send_tostring
    • only_to_these_addressesboolean
      Example: false
    • include_payment_linkboolean
      Example: false
    • activeboolean
      Example: true
    • also_send_to_addressesarray of anys
  • paid_features_availableboolean
    Example: true

Errors

401

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

403

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

422

The request failed validation. Nothing was saved.

429

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

Every error has the same shape: see Errors.

GET/account/automation
curl "https://app.invoicefalcon.com/api/v3/external/account/automation" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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
}