Retrieve automation settings
/account/automationCosts 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_invoicesobjectShow 7 child attributesHide child attributes
enabledbooleanExample:truedelay_minutesinteger, nullablewhenobjectShow 4 child attributesHide child attributes
payment_statusstringExample:paidfulfillment_statusstring, nullableshipment_statusstring, nullabletriggerstringExample:payment_status
only_customer_tagsstring, nullableexcept_customer_tagsstring, nullableonly_order_tagsstring, nullableexcept_order_tagsstring, nullable
automatic_credit_notesobjectShow 2 child attributesHide child attributes
enabledbooleanExample:falseemail_customerbooleanExample:false
pay_now_buttonobjectShow 1 child attributeHide child attributes
enabledbooleanExample:false
payment_remindersobjectShow 10 child attributesHide child attributes
enabledbooleanExample:trueautomaticbooleanExample:truedue_after_daysinteger, nullableevery_daysintegerExample:5sendstringExample:afteralso_send_tostringonly_to_these_addressesbooleanExample:falseinclude_payment_linkbooleanExample:falseactivebooleanExample:truealso_send_to_addressesarray of anys
paid_features_availablebooleanExample:true
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
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.
curl "https://app.invoicefalcon.com/api/v3/external/account/automation" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/automation", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/account/automation",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/automation")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}